该功能特性从v2.4版本开始提供。

基本介绍

该命令用于读取配置的数据库，根据数据表生成对应的proto数据结构文件。

命令使用

  1. $ gf gen pbentity -h
  2. USAGE
  3.     gf gen pbentity [OPTION]
  5. OPTION
  6.     -p, --path                 directory path for generated files storing
  7.     -k, --package              package path for all entity proto files
  8.     -l, --link                 database configuration, the same as the ORM configuration of GoFrame
  9.     -t, --tables               generate models only for given tables, multiple table names separated with ','
  10.     -f, --prefix               add specified prefix for all entity names and entity proto files
  11.     -r, --removePrefix         remove specified prefix of the table, multiple prefix separated with ','
  12.     -rf, --removeFieldPrefix   remove specified prefix of the field, multiple prefix separated with ','
  13.     -n, --nameCase             case for message attribute names, default is "Camel":
  14.                                | Case            | Example            |
  15.                                |---------------- |--------------------|
  16.                                | Camel           | AnyKindOfString    |
  17.                                | CamelLower      | anyKindOfString    | default
  18.                                | Snake           | any_kind_of_string |
  19.                                | SnakeScreaming  | ANY_KIND_OF_STRING |
  20.                                | SnakeFirstUpper | rgb_code_md5       |
  21.                                | Kebab           | any-kind-of-string |
  22.                                | KebabScreaming  | ANY-KIND-OF-STRING |
  23.     -j, --jsonCase             case for message json tag, cases are the same as "nameCase", default "CamelLower".
  24.                                set it to "none" to ignore json tag generating.
  25.     -o, --option               extra protobuf options
  26.     -h, --help                 more information about this command
  28. EXAMPLE
  29.     gf gen pbentity
  30.     gf gen pbentity -l "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  31.     gf gen pbentity -p ./protocol/demos/entity -t user,user_detail,user_login
  32.     gf gen pbentity -r user_ -k github.com/gogf/gf/example/protobuf
  33.     gf gen pbentity -r user_
  35. CONFIGURATION SUPPORT
  36.     Options are also supported by configuration file.
  37.     It's suggested using configuration file instead of command line arguments making producing. 
  38.     The configuration node name is "gf.gen.pbentity", which also supports multiple databases, for example(config.yaml):
  39.     gfcli:
  40.       gen:
  41.       - pbentity:
  42.             link:    "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  43.             path:    "protocol/demos/entity"
  44.             tables:  "order,products"
  45.             package: "demos"
  46.       - pbentity:
  47.             link:    "mysql:root:12345678@tcp(127.0.0.1:3306)/primary"
  48.             path:    "protocol/demos/entity"
  49.             prefix:  "primary_"
  50.             tables:  "user, userDetail"
  51.             package: "demos"
  52.             option:  |
  53.               option go_package    = "protobuf/demos";
  54.               option java_package  = "protobuf/demos";
  55.               option php_namespace = "protobuf/demos";

如果使用框架推荐的项目工程脚手架，并且系统安装了make工具，也可以使用make pbentity快捷指令。

参数说明：

名称默认值含义示例
gfcli.gen.pbentity
代码生成配置项，可以有多个配置项构成数组，支持多个数据库生成。不同的数据库可以设置不同的生成规则，例如可以生成到不同的位置或者文件。-
pathmanifest/protobuf/pbentity

生成proto文件的存储目录地址。

protobuf/pbentity
package自动识别go.mod生成的proto文件中的gopackage路径，并自动识别package名称-
link
分为两部分，第一部分表示你连接的数据库类型mysql, postgresql等, 第二部分就是连接数据库的dsn信息。具体请参考 ORM使用配置 章节。

-

prefix
生成数据库对象及文件的前缀，以便区分不同数据库或者不同数据库中的相同表名，防止数据表同名覆盖。

order

user

removePrefix
删除数据表的指定前缀名称。多个前缀以,号分隔。gf
removeFieldPrefix
删除字段名称的指定前缀名称。多个前缀以,号分隔。f_
tables
指定当前数据库中需要执行代码生成的数据表。如果为空，表示数据库的所有表都会生成。user, user_detail
nameCaseCamelLower生成的message属性字段名称格式。参数可选为：Camel、CamelLower、Snake、SnakeScreaming、SnakeFirstUpper、Kebab、KebabScreaming。具体介绍请参考命名行帮助示例。Snake
option
额外的proto option配置列表

与gen dao中的entity差别

相同之处

  • 两者生成的内容都是entity内容，即从数据集合（数据库表）中生成对应的Golang实体对象供程序方便使用。并且都是单向生成，即只能从数据集合生成实体对象代码，以保证实体对象数据结构的同步。
  • gen dao生成的entity数据实体对象是对于Golang语言来说是通用的，但目前主要为HTTP协议服务。在HTTP服务中，gen dao中生成的entity虽然是在internal目录下，但最终也会作为HTTP API返回的一部分服务客户端。

不同之处

  • 在GRPC服务中，gen dao生成的entity数据结构无法提供给GRPC接口使用，因为GRPC的数据结构需要使用proto文件来定义。因此，在GRPC服务中就需要使用到gen pbentity中生成的pbentity proto文件。同时，在GRPC微服务开发中，gen dao生成的entity已经没有具体作用。
  • 取名pbentity而不是entity的名称，是为了防止和gen dao中的entity含义冲突。