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

时间:2024-10-30 07:17:12

OutPath: “…/dal/query”,

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

/* Mode: ,*/

})

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

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

(db)

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

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

(

{},

peopleTbl,

)

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

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

(func(,) {}, // 指定方法interface,可指定多个

{},

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

)

// 执行并生成代码

()

}

3. 基础查询

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

u := (db).User

(ctx).Select(, ).Create(&user)

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

user, err := (ctx).Where((“iDer”),(18)).First()

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

_, err := (ctx).Where((12)).Update(, “jinzhu”)

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

(ctx).Where((10)).Delete()

// DELETE from users where id = 10;

orders, err := (ctx).Where(().Gt((())).Find()

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

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

4. 自定义 SQL 查询

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

占位符

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

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

  • 用于执行 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) (, error)

// select * from users where id=@id

FindUserToMap(id int) (, 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) ([], error)

// update @@table

//  {{set}}

//      update_time=now()

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

//          name=@name

//      {{end}}

//  {{end}}

//  {{where}}

//      id=@id

//  {{end}}

UpdateName(name string, id int) (,error)

}

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

user,err := (“zhangqiang”,18)

resultMap,err:= (2)

name := (5)

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

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

5. 最佳实践目录推荐

demo

├── cmd

│   └── generate

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

├── dal

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

│   └── model

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

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

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

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

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

├── biz

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

├── config

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

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

├── 

├── 

└── 

GEN 项目地址

  • /go-gorm/gen

写在最后


  • GEN 是一个从开始研发就立足安全角度的项目,在项目过程中充分考虑业务使用的需求,特别是很多 GORM 的功能,GORM 项目已经维护发展了 8 年,集成了很多业务使用的需求。GEN 对 GORM 完全兼容,将 GORM 的所有功能实现到 GEN 工具中。在安全上,采用了类型安全限制和充分的安全检查,完全避免了出现 SQL 注入问题,在用户体验上,增加了自动同步表结构体功能和一键所有查询相关代码生成功能,开发体验拉满,快来在你的项目上试试吧???? 。
    自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则近万的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

img

img

img

img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)

自学编程路线、面试题集合/面经、及系列技术文章等,资源持续更新中…

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门即可获取!

截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!**

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)

自学编程路线、面试题集合/面经、及系列技术文章等,资源持续更新中…

[外链图片转存中…(img-woWC819r-1712426857874)]

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门即可获取!