Go框架三件套Gorm、Kitex、Hertz怎么使用

其他教程   发布日期:2023年06月10日   浏览次数:523

本篇内容介绍了“Go框架三件套Gorm、Kitex、Hertz怎么使用”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!

三件套介绍

Gorm、Kitex、Hertz的基本用法与常见的API讲解

Gorm

gorm是Golang语言中一个已经迭代数十年且功能强大、性能极好的ORM框架

ORM:Object Relational Mapping(对象关系映射),其主要作用是在编程中,把面向对象的概念跟数据库中表的概念对应起来,

简单来说,在golang中,自定义的一个结构体对应着一张表,结构体的实例则对应着表中的一条记录。

Kitex

Kitex是字节内部Golang微服务RPC框架 具有高性能、强可扩展的主要特点 支持多协议并且拥有丰富的开源扩展

Hertz

Hertz是字节内部的Http框架 参考了其他开源框架的优势 结合字节跳动内部的需求 具有高可用、高性能、高扩展性的特点

三件套使用

Gorm

该部分笔记主要参考:gorm.io/zh_CN/docs

声明模型

模型定义

模型是标准的 struct,由 Go 的基本数据类型、实现了 Scanner 和 Valuer 接口的自定义类型及其指针或别名组成

  1. type User struct {
  2. ID uint
  3. Name string
  4. Email *string
  5. Age uint8
  6. Birthday *time.Time
  7. MemberNumber sql.NullString
  8. ActivatedAt sql.NullTime
  9. CreatedAt time.Time
  10. UpdatedAt time.Time
  11. }

约定

GORM 倾向于约定优于配置

默认情况下,GORM 使用 ID 作为主键,使用结构体名的 蛇形复数 作为表名,字段名的 蛇形 作为列名,并使用 CreatedAtUpdatedAt 字段追踪创建、更新时间

gorm.Model

GORM 定义一个 gorm.Model 结构体,其包括字段 IDCreatedAtUpdatedAtDeletedAt

  1. // gorm.Model 的定义
  2. type Model struct {
  3. ID uint `gorm:"primaryKey"`
  4. CreatedAt time.Time
  5. UpdatedAt time.Time
  6. DeletedAt gorm.DeletedAt `gorm:"index"`
  7. }

还可以将它嵌入到结构体中,以包含这几个字段,例如:

  1. type User struct {
  2. gorm.Model
  3. Name string
  4. }
  5. // 等效于
  6. type User struct {
  7. ID uint `gorm:"primaryKey"`
  8. CreatedAt time.Time
  9. UpdatedAt time.Time
  10. DeletedAt gorm.DeletedAt `gorm:"index"`
  11. Name string
  12. }

连接到数据库

GORM 官方支持的数据库类型有: MySQL, PostgreSQL, SQlite, SQL Server

MySQL

  1. import (
  2. "gorm.io/driver/mysql"
  3. "gorm.io/gorm"
  4. )
  5. func main() {
  6. // 参考 https://github.com/go-sql-driver/mysql#dsn-data-source-name 获取详情
  7. dsn := "user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
  8. db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
  9. }

注意: 想要正确的处理 time.Time ,您需要带上 parseTime 参数, 要支持完整的 UTF-8 编码,您需要将 charset=utf8 更改为 charset=utf8mb4

使用现有数据库连接

GORM 允许通过一个现有的数据库连接来初始化 *gorm.DB

  1. import (
  2. "database/sql"
  3. "gorm.io/driver/mysql"
  4. "gorm.io/gorm"
  5. )
  6. sqlDB, err := sql.Open("mysql", "mydb_dsn")
  7. gormDB, err := gorm.Open(mysql.New(mysql.Config{
  8. Conn: sqlDB,
  9. }), &gorm.Config{})

CRUD接口

创建记录
  1. user := User{Name: "Jinzhu", Age: 18, Birthday: time.Now()}
  2. result := db.Create(&user) // 通过数据的指针来创建
  3. user.ID             // 返回插入数据的主键
  4. result.Error        // 返回 error
  5. result.RowsAffected // 返回插入记录的条数
批量插入

将切片数据传递给 Create 方法,GORM 将生成一个单一的 SQL 语句来插入所有数据,并回填主键的值,钩子方法也会被调用。

  1. var users = []User{{Name: "jinzhu1"}, {Name: "jinzhu2"}, {Name: "jinzhu3"}}
  2. DB.Create(&users)
  3. for _, user := range users {
  4.  user.ID // 1,2,3
  5. }
通过Map数据类型创建记录

GORM 支持根据 map[string]interface{}[]map[string]interface{}{} 创建记录

  1. DB.Model(&User{}).Create(map[string]interface{}{
  2.  "Name": "jinzhu", "Age": 18,
  3. })
  4. // 根据 `[]map[string]interface{}{}` 批量插入
  5. DB.Model(&User{}).Create([]map[string]interface{}{
  6. {"Name": "jinzhu_1", "Age": 18},
  7. {"Name": "jinzhu_2", "Age": 20},
  8. })

查询

检索单个对象

GORM 提供了 FirstTakeLast 方法,以便从数据库中检索单个对象。当查询数据库时它添加了 LIMIT 1 条件,且没有找到记录时,它会返回 ErrRecordNotFound 错误

  1. // 获取第一条记录(主键升序)
  2. db.First(&user)
  3. // SELECT * FROM users ORDER BY id LIMIT 1;
  4. // 获取一条记录,没有指定排序字段
  5. db.Take(&user)
  6. // SELECT * FROM users LIMIT 1;
  7. // 获取最后一条记录(主键降序)
  8. db.Last(&user)
  9. // SELECT * FROM users ORDER BY id DESC LIMIT 1;
  10. result := db.First(&user)
  11. result.RowsAffected // 返回找到的记录数
  12. result.Error        // returns error
  13. // 检查 ErrRecordNotFound 错误
  14. errors.Is(result.Error, gorm.ErrRecordNotFound)

FirstLast 方法会根据主键查找到第一个、最后一个记录, 它仅在通过 struct 或提供 model 值进行查询时才起作用。如果 model 类型没有定义主键,则按第一个字段排序

  1. var user User
  2. // 可以
  3. DB.First(&user)
  4. // SELECT * FROM `users` ORDER BY `users`.`id` LIMIT 1
  5. // 可以
  6. result := map[string]interface{}{}
  7. DB.Model(&User{}).First(&result)
  8. // SELECT * FROM `users` ORDER BY `users`.`id` LIMIT 1
  9. // 不行
  10. result := map[string]interface{}{}
  11. DB.Table("users").First(&result)
  12. // 但可以配合 Take 使用
  13. result := map[string]interface{}{}
  14. DB.Table("users").Take(&result)
  15. // 根据第一个字段排序
  16. type Language struct {
  17.  Code string
  18.  Name string
  19. }
  20. DB.First(&Language{})
  21. // SELECT * FROM `languages` ORDER BY `languages`.`code` LIMIT 1
检索对象
  1. // 获取全部记录
  2. result := db.Find(&users)
  3. // SELECT * FROM users;
  4. result.RowsAffected // 返回找到的记录数,相当于 `len(users)`
  5. result.Error        // returns error
条件查询

String条件

  1. // 获取第一条匹配的记录
  2. db.Where("name = ?", "jinzhu").First(&user)
  3. // SELECT * FROM users WHERE name = 'jinzhu' ORDER BY id LIMIT 1;
  4. // 获取全部匹配的记录
  5. db.Where("name <> ?", "jinzhu").Find(&users)
  6. // SELECT * FROM users WHERE name <> 'jinzhu';
  7. // IN
  8. db.Where("name IN ?", []string{"jinzhu", "jinzhu 2"}).Find(&users)
  9. // SELECT * FROM users WHERE name IN ('jinzhu','jinzhu 2');
  10. // LIKE
  11. db.Where("name LIKE ?", "%jin%").Find(&users)
  12. // SELECT * FROM users WHERE name LIKE '%jin%';
  13. // AND
  14. db.Where("name = ? AND age >= ?", "jinzhu", "22").Find(&users)
  15. // SELECT * FROM users WHERE name = 'jinzhu' AND age >= 22;
  16. // Time
  17. db.Where("updated_at > ?", lastWeek).Find(&users)
  18. // SELECT * FROM users WHERE updated_at > '2000-01-01 00:00:00';
  19. // BETWEEN
  20. db.Where("created_at BETWEEN ? AND ?", lastWeek, today).Find(&users)
  21. // SELECT * FROM users WHERE created_at BETWEEN '2000-01-01 00:00:00' AND '2000-01-08 00:00:00';

Struct & Map 条件

  1. // Struct
  2. db.Where(&User{Name: "jinzhu", Age: 20}).First(&user)
  3. // SELECT * FROM users WHERE name = "jinzhu" AND age = 20 ORDER BY id LIMIT 1;
  4. // Map
  5. db.Where(map[string]interface{}{"name": "jinzhu", "age": 20}).Find(&users)
  6. // SELECT * FROM users WHERE name = "jinzhu" AND age = 20;
  7. // 主键切片条件
  8. db.Where([]int64{20, 21, 22}).Find(&users)
  9. // SELECT * FROM users WHERE id IN (20, 21, 22);

注意 当使用结构作为条件查询时,GORM 只会查询非零值字段。这意味着如果您的字段值为 0''false 或其他 零值,该字段不会被用于构建查询条件

Not 条件

构建NOT条件,用法与 Where 类似

  1. db.Not("name = ?", "jinzhu").First(&user)
  2. // SELECT * FROM users WHERE NOT name = "jinzhu" ORDER BY id LIMIT 1;
  3. // Not In
  4. db.Not(map[string]interface{}{"name": []string{"jinzhu", "jinzhu 2"}}).Find(&users)
  5. // SELECT * FROM users WHERE name NOT IN ("jinzhu", "jinzhu 2");
  6. // Struct
  7. db.Not(User{Name: "jinzhu", Age: 18}).First(&user)
  8. // SELECT * FROM users WHERE name <> "jinzhu" AND age <> 18 ORDER BY id LIMIT 1;
  9. // 不在主键切片中的记录
  10. db.Not([]int64{1,2,3}).First(&user)
  11. // SELECT * FROM users WHERE id NOT IN (1,2,3) ORDER BY id LIMIT 1;

Or条件

  1. db.Where("role = ?", "admin").Or("role = ?", "super_admin").Find(&users)
  2. // SELECT * FROM users WHERE role = 'admin' OR role = 'super_admin';
  3. // Struct
  4. db.Where("name = 'jinzhu'").Or(User{Name: "jinzhu 2", Age: 18}).Find(&users)
  5. // SELECT * FROM users WHERE name = 'jinzhu' OR (name = 'jinzhu 2' AND age = 18);
  6. // Map
  7. db.Where("name = 'jinzhu'").Or(map[string]interface{}{"name": "jinzhu 2", "age": 18}).Find(&users)
  8. // SELECT * FROM users WHERE name = 'jinzhu' OR (name = 'jinzhu 2' AND age = 18);

选择特定字段

选择想从数据库中检索的字段,默认情况下会选择全部字段

  1. db.Select("name", "age").Find(&users)
  2. // SELECT name, age FROM users;
  3. db.Select([]string{"name", "age"}).Find(&users)
  4. // SELECT name, age FROM users;
  5. db.Table("users").Select("COALESCE(age,?)", 42).Rows()
  6. // SELECT COALESCE(age,'42') FROM users;

Order查询

指定从数据库检索记录时的排序方式

  1. db.Order("age desc, name").Find(&users)
  2. // SELECT * FROM users ORDER BY age desc, name;
  3. // Multiple orders
  4. db.Order("age desc").Order("name").Find(&users)
  5. // SELECT * FROM users ORDER BY age desc, name;

Limit & Offset查询

Limit 指定获取记录的最大数量 Offset 指定在开始返回记录之前要跳过的记录数量

  1. db.Limit(3).Find(&users)
  2. // SELECT * FROM users LIMIT 3;
  3. // 通过 -1 消除 Limit 条件
  4. db.Limit(10).Find(&users1).Limit(-1).Find(&users2)
  5. // SELECT * FROM users LIMIT 10; (users1)
  6. // SELECT * FROM users; (users2)
  7. db.Offset(3).Find(&users)
  8. // SELECT * FROM users OFFSET 3;
  9. db.Limit(10).Offset(5).Find(&users)
  10. // SELECT * FROM users OFFSET 5 LIMIT 10;
  11. // 通过 -1 消除 Offset 条件
  12. db.Offset(10).Find(&users1).Offset(-1).Find(&users2)
  13. // SELECT * FROM users OFFSET 10; (users1)
  14. // SELECT * FROM users; (users2)

Group & Having查询

  1. type result struct {
  2. Date time.Time
  3. Total int
  4. }
  5. db.Model(&User{}).Select("name, sum(age) as total").Where("name LIKE ?", "group%").Group("name").First(&result)
  6. // SELECT name, sum(age) as total FROM `users` WHERE name LIKE "group%" GROUP BY `name`
  7. db.Model(&User{}).Select("name, sum(age) as total").Group("name").Having("name = ?", "group").Find(&result)
  8. // SELECT name, sum(age) as total FROM `users` GROUP BY `name` HAVING name = "group"
  9. rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Rows()
  10. for rows.Next() {
  11. ...
  12. }
  13. rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Rows()
  14. for rows.Next() {
  15. ...
  16. }
  17. type Result struct {
  18. Date time.Time
  19. Total int64
  20. }
  21. db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Scan(&results)

Distinct查询

从模型中选择不相同的值

  1. db.Distinct("name", "age").Order("name, age desc").Find(&results)

高级查询

智能选择字段

GORM 允许通过 Select 方法选择特定的字段,如果您在应用程序中经常使用此功能,你也可以定义一个较小的结构体,以实现调用 API 时自动选择特定的字段

  1. type User struct {
  2. ID uint
  3. Name string
  4. Age int
  5. Gender string
  6. // 假设后面还有几百个字段...
  7. }
  8. type APIUser struct {
  9. ID uint
  10. Name string
  11. }
  12. // 查询时会自动选择 `id`, `name` 字段
  13. db.Model(&User{}).Limit(10).Find(&APIUser{})
  14. // SELECT `id`, `name` FROM `users` LIMIT 10

子查询

子查询可以嵌套在查询中,GORM 允许在使用 *gorm.DB 对象作为参数时生成子查询

  1. db.Where("amount > (?)", db.Table("orders").Select("AVG(amount)")).Find(&orders)
  2. // SELECT * FROM "orders" WHERE amount > (SELECT AVG(amount) FROM "orders");
  3. subQuery := db.Select("AVG(age)").Where("name LIKE ?", "name%").Table("users")
  4. db.Select("AVG(age) as avgage").Group("name").Having("AVG(age) > (?)", subQuery).Find(&results)
  5. // SELECT AVG(age) as avgage FROM `users` GROUP BY `name` HAVING AVG(age) > (SELECT AVG(age) FROM `users` WHERE name LIKE "name%")

From子查询

GORM 允许您在 Table 方法中通过 FROM 子句使用子查询

  1. db.Table("(?) as u", db.Model(&User{}).Select("name", "age")).Where("age = ?", 18).Find(&User{})
  2. // SELECT * FROM (SELECT `name`,`age` FROM `users`) as u WHERE `age` = 18
  3. subQuery1 := db.Model(&User{}).Select("name")
  4. subQuery2 := db.Model(&Pet{}).Select("name")
  5. db.Table("(?) as u, (?) as p", subQuery1, subQuery2).Find(&User{})
  6. // SELECT * FROM (SELECT `name` FROM `users`) as u, (SELECT `name` FROM `pets`) as p

Group条件

使用 Group 条件可以更轻松的编写复杂 SQL

  1. db.Where(
  2. db.Where("pizza = ?", "pepperoni").Where(db.Where("size = ?", "small").Or("size = ?", "medium")),
  3. ).Or(
  4. db.Where("pizza = ?", "hawaiian").Where("size = ?", "xlarge"),
  5. ).Find(&Pizza{}).Statement
  6. // SELECT * FROM `pizzas` WHERE (pizza = "pepperoni" AND (size = "small" OR size = "medium")) OR (pizza = "hawaiian" AND size = "xlarge")

更新

保存所有字段

Save 会保存所有的字段,即使字段是零值

  1. db.First(&user)
  2. user.Name = "jinzhu 2"
  3. user.Age = 100
  4. db.Save(&user)
  5. // UPDATE users SET name='jinzhu 2', age=100, birthday='2016-01-01', updated_at = '2013-11-17 21:34:10' WHERE id=111;
更新单个列

当使用 Update 更新单列时,需要有一些条件,否则将会引起错误 ErrMissingWhereClause 。当使用 Model 方法,并且值中有主键值时,主键将会被用于构建条件

  1. // 条件更新
  2. db.Model(&User{}).Where("active = ?", true).Update("name", "hello")
  3. // UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE active=true;
  4. // User 的 ID 是 `111`
  5. db.Model(&user).Update("name", "hello")
  6. // UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111;
  7. // 根据条件和 model 的值进行更新
  8. db.Model(&user).Where("active = ?", true).Update("name", "hello")
  9. // UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111 AND active=true;
更新多列

Updates 方法支持 structmap[string]interface{} 参数。当使用 struct 更新时,默认情况下,GORM 只会更新非零值的字段

  1. // 根据 `struct` 更新属性,只会更新非零值的字段
  2. db.Model(&user).Updates(User{Name: "hello", Age: 18, Active: false})
  3. // UPDATE users SET name='hello', age=18, updated_at = '2013-11-17 21:34:10' WHERE id = 111;
  4. // 根据 `map` 更新属性
  5. db.Model(&user).Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false})
  6. // UPDATE users SET name='hello', age=18, active=false, updated_at='2013-11-17 21:34:10' WHERE id=111;
更新选定字段

如果想要在更新时选定、忽略某些字段,您可以使用 SelectOmit

  1. // Select with Map
  2. // User's ID is `111`:
  3. db.Model(&user).Select("name").Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false})
  4. // UPDATE users SET name='hello' WHERE id=111;
  5. db.Model(&user).Omit("name").Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false})
  6. // UPDATE users SET age=18, active=false, updated_at='2013-11-17 21:34:10' WHERE id=111;
  7. // Select with Struct (select zero value fields)
  8. db.Model(&user).Select("Name", "Age").Updates(User{Name: "new_name", Age: 0})
  9. // UPDATE users SET name='new_name', age=0 WHERE id=111;
  10. // Select all fields (select all fields include zero value fields)
  11. db.Model(&user).Select("*").Updates(User{Name: "jinzhu", Role: "admin", Age: 0})
  12. // Select all fields but omit Role (select all fields include zero value fields)
  13. db.Model(&user).Select("*").Omit("Role").Updates(User{Name: "jinzhu", Role: "admin", Age: 0})

批量更新

如果尚未通过 Model 指定记录的主键,则 GORM 会执行批量更新

  1. // 根据 struct 更新
  2. db.Model(User{}).Where("role = ?", "admin").Updates(User{Name: "hello", Age: 18})
  3. // UPDATE users SET name='hello', age=18 WHERE role = 'admin';
  4. // 根据 map 更新
  5. db.Table("users").Where("id IN ?", []int{10, 11}).Updates(map[string]interface{}{"name": "hello", "age": 18})
  6. // UPDATE users SET name='hello', age=18 WHERE id IN (10, 11);

获取更新的记录数

  1. // 通过 `RowsAffected` 得到更新的记录数
  2. result := db.Model(User{}).Where("role = ?", "admin").Updates(User{Name: "hello", Age: 18})
  3. // UPDATE users SET name='hello', age=18 WHERE role = 'admin';
  4. result.RowsAffected // 更新的记录数
  5. result.Error // 更新的错误

删除

删除一条记录

删除一条记录时,删除对象需要指定主键,否则会触发 批量 Delete

  1. // Email 的 ID 是 `10`
  2. db.Delete(&email)
  3. // DELETE from emails where id = 10;
  4. // 带额外条件的删除
  5. db.Where("name = ?", "jinzhu").Delete(&email)
  6. // DELETE from emails where id = 10 AND name = "jinzhu";
根据主键删除

GORM 允许通过主键(可以是复合主键)和内联条件来删除对象,它可以使用数字(如以下例子。也可以使用字符串——译者注)

  1. db.Delete(&User{}, 10)
  2. // DELETE FROM users WHERE id = 10;
  3. db.Delete(&User{}, "10")
  4. // DELETE FROM users WHERE id = 10;
  5. db.Delete(&users, []int{1,2,3})
  6. // DELETE FROM users WHERE id IN (1,2,3);
批量删除

如果指定的值不包括主属性,那么 GORM 会执行批量删除,它将删除所有匹配的记录

  1. db.Where("email LIKE ?", "%jinzhu%").Delete(&Email{})
  2. // DELETE from emails where email LIKE "%jinzhu%";
  3. db.Delete(&Email{}, "email LIKE ?", "%jinzhu%")
  4. // DELETE from emails where email LIKE "%jinzhu%";
返回删除行的数据
  1. // 返回所有列
  2. var users []User
  3. DB.Clauses(clause.Returning{}).Where("role = ?", "admin").Delete(&users)
  4. // DELETE FROM `users` WHERE role = "admin" RETURNING *
  5. // users => []User{{ID: 1, Name: "jinzhu", Role: "admin", Salary: 100}, {ID: 2, Name: "jinzhu.2", Role: "admin", Salary: 1000}}
  6. // 返回指定的列
  7. DB.Clauses(clause.Returning{Columns: []clause.Column{{Name: "name"}, {Name: "salary"}}}).Where("role = ?", "admin").Delete(&users)
  8. // DELETE FROM `users` WHERE role = "admin" RETURNING `name`, `salary`
  9. // users => []User{{ID: 0, Name: "jinzhu", Role: "", Salary: 100}, {ID: 0, Name: "jinzhu.2", Role: "", Salary: 1000}}
软删除

如果模型包含了一个 gorm.deletedat 字段(gorm.Model 已经包含了该字段),它将自动获得软删除的能力!

拥有软删除能力的模型调用 Delete 时,记录不会从数据库中被真正删除。但 GORM 会将 DeletedAt 置为当前时间, 并且你不能再通过普通的查询方法找到该记录。

  1. // user 的 ID 是 `111`
  2. db.Delete(&user)
  3. // UPDATE users SET deleted_at="2013-10-29 10:23" WHERE id = 111;
  4. // 批量删除
  5. db.Where("age = ?", 20).Delete(&User{})
  6. // UPDATE users SET deleted_at="2013-10-29 10:23" WHERE age = 20;
  7. // 在查询时会忽略被软删除的记录
  8. db.Where("age = 20").Find(&user)
  9. // SELECT * FROM users WHERE age = 20 AND deleted_at IS NULL;

查询被软删除的记录

可以使用 Unscoped 找到被软删除的记录

  1. db.Unscoped().Where("age = 20").Find(&users)
  2. // SELECT * FROM users WHERE age = 20;

事务

禁用默认事务

为了确保数据一致性,GORM 会在事务里执行写入操作(创建、更新、删除)。如果没有这方面的要求,可以在初始化时禁用它,这将获得大约 30%+ 性能提升。

  1. // 全局禁用
  2. db, err := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{
  3. SkipDefaultTransaction: true,
  4. })
  5. // 持续会话模式
  6. tx := db.Session(&Session{SkipDefaultTransaction: true})
  7. tx.First(&user, 1)
  8. tx.Find(&users)
  9. tx.Model(&user).Update("Age", 18)
事务开启

要在事务中执行一系列操作,一般流程如下

  1. db.Transaction(func(tx *gorm.DB) error {
  2. // 在事务中执行一些 db 操作(从这里开始,您应该使用 'tx' 而不是 'db')
  3. if err := tx.Create(&Animal{Name: "Giraffe"}).Error; err != nil {
  4. // 返回任何错误都会回滚事务
  5. return err
  6. }
  7. if err := tx.Create(&Animal{Name: "Lion"}).Error; err != nil {
  8. return err
  9. }
  10. // 返回 nil 提交事务
  11. return nil
  12. })
嵌套事务

GORM 支持嵌套事务,您可以回滚较大事务内执行的一部分操作

  1. db.Transaction(func(tx *gorm.DB) error {
  2. tx.Create(&user1)
  3. tx.Transaction(func(tx2 *gorm.DB) error {
  4. tx2.Create(&user2)
  5. return errors.New("rollback user2") // Rollback user2
  6. })
  7. tx.Transaction(func(tx2 *gorm.DB) error {
  8. tx2.Create(&user3)
  9. return nil
  10. })
  11. return nil
  12. })
手动事务

Gorm 支持直接调用事务控制方法(commit、rollback)

  1. // 开始事务
  2. tx := db.Begin()
  3. // 在事务中执行一些 db 操作(从这里开始,您应该使用 'tx' 而不是 'db')
  4. tx.Create(...)
  5. // ...
  6. // 遇到错误时回滚事务
  7. tx.Rollback()
  8. // 否则,提交事务
  9. tx.Commit()

Gorm性能提高

使用PrepareStmt缓存预编译语句可以提高后续调用的速度,提高大约35%左右。

  1. db , err := gorm.Open(mysql.Open("username:password@tcp(localhost:9910)/database?charset=utf8"),&gorm.Config{
  2. PrepareStmt: true}

Kitex

安装

Kitex目前对Windows的支持不完善,建议使用虚拟机或WSL2

安装代码生成工具

  1. go install github.com/cloudwego/tool/cmd/kitex@latest
  2. go install github.com/cloudwego/thriftgo@latest

使用

kitex 是 Kitex 框架提供的用于生成代码的一个命令行工具。目前,kitex 支持 thrift 和 protobuf 的 IDL,并支持生成一个服务端项目的骨架。

编写IDL

IDL是什么:IDL 全称是 Interface Definition Language,接口定义语言

为什么使用IDL:要进行 RPC,就需要知道对方的接口是什么,需要传什么参数,同时也需要知道返回值是什么样的,就好比两个人之间交流,需要保证在说的是同一个语言、同一件事。 这时候,就需要通过 IDL 来约定双方的协议,就像在写代码的时候需要调用某个函数,我们需要知道函数签名一样。

首先我们需要编写一个 IDL,这里以 thrift IDL 为例。

首先创建一个名为 echo.thrift 的 thrift IDL 文件。

然后在里面定义我们的服务

  1. namespace go api
  2. struct Request {
  3. 1: string message
  4. }
  5. struct Response {
  6. 1: string message
  7. }
  8. service Echo {
  9. Response echo(1: Request req)
  10. }

生成echo服务代码

有了 IDL 以后我们便可以通过 kitex 工具生成项目代码了,执行如下命令:

  1. example 为该服务的名字。最后一个参数则为该服务的 IDL 文件。

    生成后的项目结构如下:

    .
  2. |-- build.sh
  3. |-- echo.thrift
  4. |-- handler.go
  5. |-- kitex_gen
  6. |   `-- api
  7. |       |-- echo
  8. |       |   |-- client.go
  9. |       |   |-- echo.go
  10. |       |   |-- invoker.go
  11. |       |   `-- server.go
  12. |       |-- echo.go
  13. |       `-- k-echo.go
  14. |-- main.go
  15. `-- script
  16.     |-- bootstrap.sh
  17.     `-- settings.py

    编写echo服务逻辑

    需要编写的服务端逻辑都在 handler.go 这个文件中

    package main
  18. import (
  19.   "context"
  20.   "example/kitex_gen/api"
  21. )
  22. // EchoImpl implements the last service interface defined in the IDL.
  23. type EchoImpl struct{}
  24. // Echo implements the EchoImpl interface.
  25. func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Response, err error) {
  26.   // TODO: Your code here...
  27.   return
  28. }

    这里的 Echo 函数就对应了我们之前在 IDL 中定义的 echo 方法。

    现在让我们修改一下服务端逻辑,让 Echo 服务起到作用。

    func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Response, err error) {
  29.   return &api.Response{Message: req.Message}, nil
  30. }

    编译运行

    kitex 工具已经帮我们生成好了编译和运行所需的脚本:

    编译:

    client
    import "example/kitex_gen/api/echo"
  31. import "github.com/cloudwego/kitex/client"
  32. ...
  33. c, err := echo.NewClient("example", client.WithHostPorts("0.0.0.0:8888"))
  34. if err != nil {
  35.   log.Fatal(err)
  36. }

    上述代码中,echo.NewClient 用于创建 client,其第一个参数为调用的 服务名(用于微服务中的服务发现),第二个参数为 options,用于传入参数, 此处的 client.WithHostPorts 用于指定服务端的地址。

    发起调用

    import "example/kitex_gen/api"
  37. ...
  38. req := &api.Request{Message: "my request"}
  39. resp, err := c.Echo(context.Background(), req, callopt.WithRPCTimeout(3*time.Second))
  40. if err != nil {
  41.   log.Fatal(err)
  42. }
  43. log.Println(resp)

    上述代码中,我们首先创建了一个请求 req , 然后通过 c.Echo 发起了调用。

    其第一个参数为 context.Context,通过通常用其传递信息或者控制本次调用的一些行为,你可以在后续章节中找到如何使用它。

    其第二个参数为本次调用的请求。

    其第三个参数为本次调用的 options ,Kitex 提供了一种 callopt 机制,顾名思义——调用参数 ,有别于创建 client 时传入的参数,这里传入的参数仅对此次生效。 此处的 callopt.WithRPCTimeout 用于指定此次调用的超时(通常不需要指定,此处仅作演示之用)。

    在编写完一个简单的客户端后,我们终于可以发起调用了。

    可以通过下述命令来完成这一步骤:

    $GOPATH/src下创建额外目录,进入该目录后再获取代码:
      $ mkdir -p $(go env GOPATH)/src/github.com/cloudwego
  44.   $ cd $(go env GOPATH)/src/github.com/cloudwego
  • 若将代码放置于 GOPATH 之外,可直接获取

编写示例代码

  • 在当前目录下创建 hertz_demo 文件夹,进入该目录中

  • 创建 main.go 文件

  • main.go 文件中添加以下代码

  1. package main
  2. import (
  3. "context"
  4. "github.com/cloudwego/hertz/pkg/app"
  5. "github.com/cloudwego/hertz/pkg/app/server"
  6. "github.com/cloudwego/hertz/pkg/common/utils"
  7. "github.com/cloudwego/hertz/pkg/protocol/consts"
  8. )
  9. func main() {
  10. h := server.Default()
  11. h.GET("/ping", func(c context.Context, ctx *app.RequestContext) {
  12. ctx.JSON(consts.StatusOK, utils.H{"message": "pong"})
  13. })
  14. h.Spin()
  15. }

生成go.mod 文件

  1. .Next,如图中的中间件 C

    实现一个中间件

    // 方式一
  2. func MyMiddleware() app.HandlerFunc {
  3.   return func(ctx context.Context, c *app.RequestContext) {
  4.     // pre-handle
  5.     // ...
  6.     c.Next(ctx)
  7.   }
  8. }
  9. // 方式二
  10. func MyMiddleware() app.HandlerFunc {
  11.   return func(ctx context.Context, c *app.RequestContext) {
  12.     c.Next(ctx) // call the next middleware(handler)
  13.     // post-handle
  14.     // ...
  15.   }
  16. }

    中间件会按定义的先后顺序依次执行,如果想快速终止中间件调用,可以使用以下方法,注意当前中间件仍将执行

以上就是Go框架三件套Gorm、Kitex、Hertz怎么使用的详细内容,更多关于Go框架三件套Gorm、Kitex、Hertz怎么使用的资料请关注九品源码其它相关文章!