使用规则

Thrift

支持的数据类型

mongodb 中的集合与 thrift 中的 struct 对应。

struct 字段支持 thrift 中的所有基本数据类型、容器类型（list、map、set）、binary、枚举类型（文件内引用和文件外引用均支持）、struct 类型（文件内引用和文件外引用均支持）及上述类型的合法组合。

支持的命名方式

struct 和各字段采用大驼峰命名方式或蛇形命名方式皆可。

Mongodb tag 添加

采用注解方式添加 tag。

格式：(go.tag="bson:\"{field_name}{,omitempty}(按需选择是否添加)\"")

例如 (go.tag="bson:\"id,omitempty\"") 或 (go.tag="bson:\"id\"")

Mongodb curd 函数添加

采用注解方式添加函数。

格式：mongo.{解析所用函数名} = "{实际使用的函数名}({入参...}) (返回值...)"

例如 mongo.InsertOne = "InsertUser(ctx context.Context, user *user.User) (interface{}, error)"

具体规则请参考函数定义规则。

Protobuf

支持的数据类型

mongodb 中的集合与 proto 中的 message 对应。

message 字段支持 proto 中的所有基本数据类型、repeated 等关键字、bytes、枚举类型（文件内引用和文件外引用均支持）、message 类型（文件内引用和文件外引用均支持）及上述类型的合法组合。

支持的命名方式

message 和各字段采用大驼峰命名方式或蛇形命名方式皆可。

Mongodb tag 添加

采用注释方式添加 tag。

格式：// go.tag=|bson:"{field_name}{,omitempty}(按需选择是否添加)"|

例如 // go.tag=|bson:"id,omitempty"| 或 // go.tag=|bson:"id"|

Mongodb curd 函数添加

采用注释方式添加函数。

格式：// mongo.{解析所用函数名} = |{实际使用的函数名}({入参...}) (返回值...)|

例如 // mongo.InsertOne = |InsertUser(ctx context.Context, user *user.User) (interface{}, error)|

具体规则请参考函数定义规则。

函数定义规则

函数名采用驼峰式命名，首字母大写，且第一个单词必须是如下之一：

• Insert
• Find
• Update
• Delete
• Count
• Bulk
• Transaction

把所有的操作总体分为两类：作用于单个文档，作用于多个文档，具体判定由传入参数和返回值共同决定。

Insert

Insert 操作只有插入单个文档和插入多个文档两种，由传入参数和返回值共同判定。

函数命名：首单词为 Insert 即可，后面的可任意定义。

入参：固定两个，(ctx(固定)，结构体指针或结构体指针切片)

返回值：固定两个，(interface{}或[]interface{}, error(固定))

Find

Find 操作包括单实体和多实体两种，由返回值决定，返回值为指针切片，即为单实体操作，否则为多实体操作。

函数命名：首单词为 Find，后面的遵循如下规则：Find{想获取的字段名，若没有则全部获取}{排序分页等操作，若没有则不加}By{查询条件}/All(无查询条件)

入参：第一个固定为 ctx，后面的参数参考比较条件按顺序传入。

返回值：固定两个，(结构体指针或结构体指针切片, error(固定))。

例：Find Name OrderbyNameSkipLimit By GenderEqualOrAgeGreaterThan

• 字段名：go 中对应的结构体字段名称

  若存在结构体嵌套情况，则字段名格式为：{子结构体在父结构体中的字段名}{子结构体中的具体字段名}，例如 User 嵌套 Video，想要查找 Video 的 Id 字段，则为：VideoId

• 排序分页等操作

格式	描述	示例
Orderby{thrift 字段名123…}	默认针对字段升序，若某个字段有降序的需求，在字段后加 Desc(只作用于单个字段，若有多个降序字段的需求，需要在每一个字段后面都跟 Desc)，例 OrderbyName(升) AgeDesc(降) 入参不传值	FindUsernameOrderbyIdUsernameSkipLimitAll（含两个字段 “id”，“Username”）
Skip	跳过文档数量 入参传整数	FindUsernameOrderbyIdUsernameSkipLimitAll（跳过文档）
Limit	限制查询文档数量 单实体操作不支持，入参传整数	FindUsernameOrderbyIdUsernameSkipLimitAll（限制查询文档数量）

• 查询条件

  以 By 或 All 开头, By 后面要跟具体的查询条件, All 后面不用跟条件

  By 后面必须要跟具体的字段以及比较条件，若有需要，以 And 或 Or 标识与或条件并连接各个字段及比较条件，在使用 And 或 Or 连接词时，若需要指示查询优先级，则以 Lb、Rb 标识子连接条件，例如：ByLbLbUsernameEqualOrUsernameEqualRbAndAgeGreaterThanRb == By((UsernameEqualOrUsernameEqual)AndAgeGreaterThan)

• 语法格式：By{字段名}{比较条件}{And/Or}{字段名}{比较条件}

• 比较条件：

关键词	含义	入参值
Equal	等于	该字段值
NotEqual	不等于	该字段值
LessThan	小于	该字段值
LessThanEqual	小于等于	该字段值
GreaterThan	大于	该字段值
GreaterThanEqual	大于等于	该字段值
Between	[a,b]	左右端点值
NotBetween	<a && >b	左右端点值
In	字段值在切片范围内	切片
NotIn	字段值不在切片范围内	切片
True	字段值是否为 true	-
False	字段值是否为 false	-
Exists	指定字段存在的文档	-
NotExists	指定字段不存在的文档	-

Update

Update 操作包括单实体和多实体两种，由返回值决定，返回值为 bool，即为单实体操作，表示单次更新操作是否成功；返回值为 int，为多实体操作，表示成功更新的个数。

Update 操作以更新对象的角度分为两种：

• 更新整个文档（Update 后面不加字段，需传入结构体指针）；

• 更新部分字段（Update 后面加字段名，需传入更新后的字段值）。

函数命名： 首单词为 Update，后面的遵循如下规则：

Update(Upsert){要更新的字段名，若没有则按整个结构体更新，需传入结构体指针}By{查询条件}/All(无查询条件) 查询条件与 Find 相同。

更新操作目前仅支持使用 $set。

入参：第一个固定为 ctx，后面的参数按照更新的字段名和比较条件按顺序传入。

返回值：固定两个，(bool 或 int, error(固定))

Delete

Delete 操作包括单实体和多实体两种，判定方式与 Update 相同。

函数命名：

DeleteBy{查询条件}/All(无查询条件) 查询条件与 Find 相同

入参：第一个固定为 ctx，后面的参数参考比较条件按顺序传入即可。

返回值：固定两个，(bool 或 int, error(固定))

Count

只有多实体操作。

函数命名：

CountBy{查询条件}/All(无查询条件) 查询条件与 Find 相同

入参：第一个固定为 ctx，后面的参数参考比较条件按顺序传入即可。

返回值：固定为 (int, error)

Bulk

Bulk 操作支持 Insert, Update, Delete 操作

其中，Insert 仅支持 InsertOne，其他两种操作 one 和 many 都支持。

Insert 固定写 InsertOne，Update, Delete 需指定是单实体操作还是多实体操作，需要在后面加 One 或 Many， 如 UpdateOne UpdateMany

函数命名：

Bulk{操作1, 如 InsertOne}{操作2, 如 DeleteOneAll}

入参：第一个固定为 ctx，后面的参数按各个操作传入参数的顺序传入。

返回值：固定为 (*mongo.BulkWriteResult, error)

Transaction

Transaction 支持 Insert, Update, Delete, Bulk 操作，并且支持针对多个集合的事务操作。

Insert, Update, Delete 均支持 One Many，需指定单实体操作还是多实体操作，如 InsertOne，InsertMany;Bulk 操作需要以 Lb 和 Rb 来标志开始和结束，例如：BulkLbInsertOneUpdateManyByIdEqualRb。

若使用其他集合的操作，需在 Insert, Update, Delete，Bulk 操作前面加上 Collection 关键字以及参数的驼峰命名首字母大写方式，并在 client 后面依次传入相应的 collection 参数（参数命名要求：驼峰命名方式，首字母小写）

例：CollectionUserCollectionInsertMany, 传入参数：userCollection *mongo.Collection；若使用的是本集合的操作，则无需加 Collection 及相关参数。

函数命名：

Transaction{操作1, 如 CollectionUserCollectionInsertMany}{操作2, 如 UpdateOneByAgeEqual}

入参：第一个固定为 ctx，第二个固定为 client，第三块固定为使用的其他集合，后面的参数按各个操作传入参数的顺序传入。

返回值：固定为 error

关键字

在命名结构体字段时，请勿包含如下关键字：

• Insert
• Find
• Update
• Delete
• Count
• Bulk
• Transaction
• Collection
• Lb
• Rb
• One
• Many
• By
• All
• Orderby
• Skip
• Limit
• Equal
• NotEqual
• LessThan
• LessThanEqual
• GreaterThan
• GreaterThanEqual
• Between
• NotBetween
• In
• NotIn
• True
• False
• Exists
• NotExists

更新

字段有更新或函数有更新时，工具的行为是：将读到的注解中的函数名与生成的代码文件中的函数名做对比，代码文件中有注解中没有的在文件后 append，其余不动。