无恒实验室联合GORM推出安全好用的ORM框架-GEN

更详细的配置示例可以参照:最佳实践 DEMO(https://github.com/idersec/gendemo)

执行以下方法后即可在指定目录生成对应代码:

import (

“gorm.io/gen”

)

func main() {

// 指定生成代码的具体(相对)目录,默认为:./query

// 默认情况下需要使用WithContext之后才可以查询,但可以通过设置gen.WithoutContext避免这个操作

g := gen.NewGenerator(gen.Config{

// 最终package不能设置为model,在有数据库表同步的情况下会产生冲突,若一定要使用可以单独指定model package的新名字

OutPath: “…/dal/query”,

ModelPkgPath: “…/dal/model”, // 默认情况下会跟随OutPath参数,在同目录下生成model目录

/* Mode: gen.WithoutContext,*/

})

// 复用工程原本使用的SQL连接配置db(*gorm.DB)

// 非必需,但如果需要复用连接时的gorm.Config或需要连接数据库同步表信息则必须设置

g.UseDB(db)

peopleTbl := g.GenerateModelAs(“people”, “People”) // 指定对应表格的结构体名称

// 为指定的结构体或表格生成基础CRUD查询方法,ApplyInterface生成效果的子集

g.ApplyBasic(

model.User{},

peopleTbl,

)

// 为指定的数据库表实现除基础方法外的相关方法, 同时也会生成ApplyBasic对应的基础方法

// 可以认为ApplyInterface方法是ApplyBasic的扩展版

g.ApplyInterface(func(model.SearchByTenantMethod,model.UpdateByTenantMethod) {}, // 指定方法interface,可指定多个

model.Order{},

g.GenerateModel(“Company”), // 在这里调用也会生成ApplyBasic对应的基础方法

)

// 执行并生成代码

g.Execute()

}

3. 基础查询

执行生成代码后,GEN 会帮助生成基础的查询方法,并且绑定到结构体上,可以直接调用函数查询获取查询结果,不需要提前定义变量,参数和结构体字段类型绑定,防止研发过程中误用。

u := query.Use(db).User

u.WithContext(ctx).Select(u.Name, u.Age).Create(&user)

// INSERT INTO users (name,age) VALUES (“modi”, 18)

user, err := u.WithContext(ctx).Where(u.Name.Eq(“iDer”),u.Age.Gte(18)).First()

// SELECT * FROM users WHERE name = “iDer” and age>=18;

_, err := u.WithContext(ctx).Where(u.ID.Eq(12)).Update(u.Name, “jinzhu”)

// UPDATE users SET name=“jinzhu”, updated_at=‘2013-11-17 21:34:10’ WHERE id=12;

e.WithContext(ctx).Where(u.ID.Eq(10)).Delete()

// DELETE from users where id = 10;

orders, err := o.WithContext(ctx).Where(u.Columns(o.Amount).Gt(o.Select(u.Amount.Avg())).Find()

// SELECT * FROM “orders” WHERE amount > (SELECT AVG(amount) FROM “orders”);

GEN 满足了基本上所有的日常使用的查询方法,包括事务、关联关系等高级用法,更多案例请参考:https://github.com/go-gorm/gen#readme

4. 自定义 SQL 查询

自定 SQL 的安全性是所有 ORM 最难解决的问题,GEN 使用模板注释的方法完美解决了这个问题,只需要将 SQL 注释到 interface 的方法上。SQL 支持简单的 where 查询和完整 SQL 查询,条件用Where()语法包住。Raw SQL 用sql()包住,也可省略直接写。

占位符

  • gen.T 用于返回数据的结构体,会根据生成结构体或者数据库表结构自动生成

  • gen.M 表示map[string]interface{},用于返回数据

  • gen.RowsAffected 用于执行 SQL 进行更新或删除时候,用于返回影响行数

  • @@table 查询的表名,如果没有传参,会根据结构体或者表名自动生成

  • @@<name> 当表名或者字段名可控时候,用@@占位,name 为可变参数名,需要函数传入。

  • @<name> 当数据可控时候,用@占位,name 为可变参数名,需要函数传入

子句

目前支持 if 、where 、set 子句,子句需要用{{}}括起来,并且需要用{{end}} 结束子句。where 和 set 子句会帮助做连接词补全和开头连接词删除。各个子句支持嵌套使用。

type Method interface {

// Where(“name=@name and age=@age”)

SimpleFindByNameAndAge(name string, age int) (gen.T, error)

// select * from users where id=@id

FindUserToMap(id int) (gen.M, error)

// sql(insert into @@table (name,age) values (@name,@age) )

InsertValue(age int, name string) error

// select name from @@table where id=@id

FindNameById(id int) string

// select * from @@table

//  {{where}}

//      id>0

//      {{if cond}}id=@id {{end}}

//      {{if key!=“” && value != “”}} or @@key=@value{{end}}

//  {{end}}

FindByIDOrCustom(cond bool, id int, key, value string) ([]gen.T, error)

// update @@table

//  {{set}}

//      update_time=now()

//      {{if name != “”}}

//          name=@name

//      {{end}}

//  {{end}}

//  {{where}}

//      id=@id

//  {{end}}

UpdateName(name string, id int) (gen.RowsAffected,error)

}

GEN 会自动生成安全的实现代码,并且和结构体绑定。使用时候直接调用对应的函数即可。

user,err := u.SimpleFindByNameAndAge(“zhangqiang”,18)

resultMap,err:= u.FindUserToMap(2)

name := u.FindNameById(5)

users,err := u.FindByIDOrCustom(true, 10, “name”, “modi”)

rows,err := UpdateName(“jinzhu”, 12)

5. 最佳实践目录推荐

demo

├── cmd

│   └── generate

│       └── generate.go # 包含main函数,执行其即可完成生成代码步骤

├── dal

│   ├── dal.go # 实现具体的数据库连接等操作

│   └── model

│   │   ├── method.go # 指定所有自定义查询方法

│   │   └── model.go  # 描述与数据库表对应的数据结构(体)

│   └── query  # 生成的代码存放目录, 在执行代码生成操作后自动创建

│       └── gen.go # 生成的通用查询代码

│       └── tablename.gen.go # 生成的单个表字段和相关的查询代码

├── biz

│   └── query.go # 实现业务逻辑,调用生成的代码查询数据库

├── config

│   └── config.go # 存储相关的数据库DSN

├── generate.sh # 调用generate中main函数生成代码的脚本(推荐使用)

├── go.mod

├── go.sum

└── main.go

GEN 项目地址

Android高级架构师

由于篇幅问题,我呢也将自己当前所在技术领域的各项知识点、工具、框架等汇总成一份技术路线图,还有一些架构进阶视频、全套学习PDF文件、面试文档、源码笔记。

  • 330页PDF Android学习核心笔记(内含上面8大板块)

  • Android学习的系统对应视频

  • Android进阶的系统对应学习资料

  • Android BAT部分大厂面试题(有解析)

好了,以上便是今天的分享,希望为各位朋友后续的学习提供方便。觉得内容不错,也欢迎多多分享给身边的朋友哈。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》点击传送门,即可获取!
zYy8-1715328389457)]

  • Android学习的系统对应视频

  • Android进阶的系统对应学习资料

[外链图片转存中…(img-vsn7nmAF-1715328389457)]

  • Android BAT部分大厂面试题(有解析)

[外链图片转存中…(img-DtlCweep-1715328389458)]

好了,以上便是今天的分享,希望为各位朋友后续的学习提供方便。觉得内容不错,也欢迎多多分享给身边的朋友哈。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》点击传送门,即可获取!

  • 25
    点赞
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值