Fields/FieldsEx字段过滤

  1. Fields 用于指定需要操作的表字段,包括查询字段、写入字段、更新字段等过滤;
  2. FieldsEx 用于例外的字段指定,可用于查询字段、写入字段、更新字段等过滤;
  1. 假如user表有4个字段uid, nickname, passport, password
  2. 写入字段过滤

    1. m := g.Map{
    2. "uid" : 10000,
    3. "nickname" : "John Guo",
    4. "passport" : "john",
    5. "password" : "123456",
    6. }
    7. g.Model(table).Fields("nickname,passport,password").Data(m).Insert()
    8. // INSERT INTO `user`(`nickname`,`passport`,`password`) VALUES('John Guo','john','123456')
  1. 假如user表有4个字段uid, nickname, passport, password
  2. 查询字段排除

    1. // SELECT `uid`,`nickname` FROM `user`
    2. g.Model("user").FieldsEx("passport, password").All()
  3. 写入字段排除

    1. m := g.Map{
    2. "uid" : 10000,
    3. "passport" : "john",
    4. "password" : "123456",
    5. }
    6. g.Model(table).FieldsEx("uid").Data(m).Insert()
    7. // INSERT INTO `user`(`nickname`,`passport`,`password`) VALUES('John Guo','john','123456')

OmitEmpty空值过滤

map/struct 中存在空值如 nil,"",0 时,默认情况下,gdb将会将其当做正常的输入参数,因此这些参数也会被更新到数据表。OmitEmpty特性可以在将数据写入到数据库之前过滤空值数据的字段。

相关方法:

OmitEmpty方法会同时过滤WhereData中的空值数据,而通过OmitEmptyWhere/OmitEmptyData方法可以执行特定的字段过滤。

  1. // UPDATE `user` SET `name`='john',update_time=null WHERE `id`=1
  2. g.Model("user").Data(g.Map{
  3. "name" : "john",
  4. "update_time" : nil,
  5. }).Where("id", 1).Update()

针对空值情况,我们可以通过OmitEmpty方法来过滤掉这些空值。例如,以上示例可以修改为:

  1. // UPDATE `user` SET `name`='john' WHERE `id`=1
  2. g.Model("user").OmitEmpty().Data(g.Map{
  3. "name" : "john",
  4. "update_time" : nil,
  5. }).Where("id", 1).Update()

对于struct数据参数,我们也可以进行空值过滤。操作示例:

  1. type User struct {
  2. Id int `orm:"id"`
  3. Passport string `orm:"passport"`
  4. Password string `orm:"password"`
  5. NickName string `orm:"nickname"`
  6. CreateTime string `orm:"create_time"`
  7. UpdateTime string `orm:"update_time"`
  8. }
  9. user := User{
  10. Id : 1,
  11. NickName : "john",
  12. UpdateTime: gtime.Now().String(),
  13. g.Model("user").OmitEmpty().Data(user).Insert()
  14. // INSERT INTO `user`(`id`,`nickname`,`update_time`) VALUES(1,'john','2019-10-01 12:00:00')

注意哟,批量写入/更新操作中OmitEmpty方法将会失效,因为在批量操作中,必须保证每个写入记录的字段是统一的。

关于omitempty标签与OmitEmpty方法:

  1. 针对于struct的空值过滤大家会想到omitempty的标签。该标签常用于json转换的空值过滤,也在某一些第三方的ORM库中用作struct到数据表字段的空值过滤,即当属性为空值时不做转换。
  2. omitempty标签与OmitEmpty方法所达到的效果是一样的。在ORM操作中,我们不建议对struct使用omitempty的标签来控制字段的空值过滤,而建议使用OmitEmpty方法来做控制。因为该标签一旦加上之后便绑定到了struct上,没有办法做灵活控制;而通过OmitEmpty方法使得开发者可以选择性地、根据业务场景对struct做空值过滤,操作更加灵活。

空值也会影响数据查询操作,主要是影响where条件参数。我们可以通过OmitEmpty方法过滤条件参数中的空值。

使用示例:

  1. type User struct {
  2. Passport string `orm:"passport"`
  3. Password string `orm:"password"`
  4. NickName string `orm:"nickname"`
  5. CreateTime string `orm:"create_time"`
  6. UpdateTime string `orm:"update_time"`
  7. }
  8. user := User{
  9. Passport : "john",
  10. }
  11. r, err := g.Model("user").OmitEmpty().Where(user).One()
  12. // SELECT * FROM `user` WHERE `passport`='john' LIMIT 1

OmitNil空值过滤

相关方法:

  1. func (m *Model) OmitNil() *Model
  2. func (m *Model) OmitNilWhere() *Model
  3. func (m *Model) OmitNilData() *Model

OmitEmpty方法会同时过滤WhereData中的空值数据,而通过OmitEmptyWhere/OmitEmptyData方法可以执行特定的字段过滤。

Filter字段过滤(已内置)

gdb可以自动同步数据表结构到程序缓存中(缓存不过期,直至程序重启/重新部署),并且可以过滤提交参数中不符合表结构的数据项,该特性可以使用Filter方法实现。常用于新增/删除操作中输入map/struct/[]map/[]string参数类型的场景。

使用示例,假如user表有4个字段uid, nickname, passport, password

  1. r, err := g.Model("user").Filter().Data(g.Map{
  2. "id" : 1,
  3. "uid" : 1,
  4. "passport" : "john",
  5. "password" : "123456",
  6. }).Insert()
  7. // INSERT INTO user(uid,passport,password) VALUES(1, "john", "123456")

其中id为不存在的字段,在写入数据时将会被过滤掉,不至于被构造成写入SQL中产生执行错误。

数据库没有设计为Data方法做自动过滤,而是需要开发者调用Filter方法来手动指定过滤,目的是友好地提醒开发者可能误写/传递错误了字段名称。如果强制性的自动过滤可能会引起难以预料的业务逻辑异常,例如,由于字段名称拼写错误导致自动过滤了本来需要输入的字段,导致写入数据库的数据不完整。