| Tip |
|---|
该功能特性从 |
基本介绍
设计背景
在业务项目实践中，业务逻辑封装往往是最复杂的部分，同时，业务模块之间的依赖十分复杂、边界模糊，无法采用Golang包管理的形式。如何有效管理项目中的业务逻辑封装部分，对于每个采用Golang开发的项目都是必定会遇到的难题。
设计目标
- 增加
logic分类目录，将所有业务逻辑代码迁移到logic分类目录下，采用包管理形式来管理业务模块。 - 业务模块之间的依赖通过接口化解耦，将原有的
service分类调整为接口目录。这样每个业务模块将会各自维护、更加灵活。 - 可以按照一定的项目规范，从
logic业务逻辑代码生成service接口定义代码。同时，也允许人工维护这部分service接口。
命令使用
该命令通过分析给定的logic业务逻辑模块目录下的代码，自动生成service目录接口代码。
| Note |
|---|
需要注意：
|
手动模式
如果是手动执行命令行，直接在项目根目录下执行 gf gen service 即可。
| Code Block | ||
|---|---|---|
| ||
$ gf gen service -h
USAGE
gf gen service [OPTION]
OPTION
-s, --srcFolder source folder path to be parsed. default: internal/logic
-d, --dstFolder destination folder path storing automatically generated go files. default: internal/service
-f, --dstFileNameCase destination file name storing automatically generated go files, cases are as follows:
| Case | Example |
|---------------- |--------------------|
| Lower | anykindofstring |
| Camel | AnyKindOfString |
| CamelLower | anyKindOfString |
| Snake | any_kind_of_string | default
| SnakeScreaming | ANY_KIND_OF_STRING |
| SnakeFirstUpper | rgb_code_md5 |
| Kebab | any-kind-of-string |
| KebabScreaming | ANY-KIND-OF-STRING |
-w, --watchFile used in file watcher, it re-generates all service go files only if given file is under
srcFolder
-a, --stPattern regular expression matching struct name for generating service. default: ^s([A-Z]\\w+)$
-p, --packages produce go files only for given source packages
-i, --importPrefix custom import prefix to calculate import path for generated importing go file of logic
-l, --clear delete all generated go files that are not used any further
-h, --help more information about this command
EXAMPLE
gf gen service
gf gen service -f Snake |
| Tip |
|---|
如果使用框架推荐的项目工程脚手架，并且系统安装了 |
参数说明：
| 名称 | 必须 | 默认值 | 含义 | ||||||
|---|---|---|---|---|---|---|---|---|---|
srcFolder | 是 | internal/logic | 指向logic代码目录地址 | ||||||
dstFolder | 是 | internal/service | 指向生成的接口文件存放目录 | ||||||
dstFileNameCase | 否 | Snake | 生成的文件名名称格式 | ||||||
stPattern | 否 | s([A-A]\w+) | 使用正则指定业务模块结构体定义格式，便于解析业务接口定义名称。在默认的正则下，所有小写
| ||||||
watchFile | 用在代码文件监听中，代表当前改变的代码文件路径 | ||||||||
packages | 仅生成指定包名的接口文件，给定字符串数组，通过命令行传参则给定JSON字符串，命令行组件自动转换数据类型 | ||||||||
importPrefix | 指定生成业务引用文件中的引用包名前缀 | ||||||||
overwrite | true | 生成代码文件时是否覆盖已有文件 | |||||||
clear | false | 自动删除logic中不存在的接口文件（仅删除自动维护的文件） |
自动模式（Visual Studio Code）
如果您是使用的Visual Studio Code，那么可以使用我们提供的配置文件：watchers.xml 自动监听代码文件修改时自动生成接口文件。使用方式，如下图：，那么可以安装插件 RunOnSave 随后配置插件：
| Code Block | ||
|---|---|---|
| ||
"emeraldwalk.runonsave": {
"commands": [
{
"match": ".*logic.*go",
"isAsync": true,
"cmd": "gf gen service -s app/logic -d app/service"
}
]
} |
自动模式（Goland/Idea）
如果您是使用的GolandIDE，那么可以使用我们提供的配置文件：watchers.xml 自动监听代码文件修改时自动生成接口文件。使用方式，如下图：
具体使用手摸手
Step1：引入我们提供的配置
我们建议您在使用Goland IDE时，使用我们提供的配置文件：watchers.xml
Step2：编写您的业务逻辑代码
Step3：生成接口及服务注册文件
如果您已经按照Step1做好了配置，那么这一步可以忽略。因为在您编写代码的时候，service便同时生成了接口定义文件。
否则，每一次在您开发/更新完成logic业务模块后，您需要手动执行一下 gf gen service 命令。
Step4：注意服务的实现注入部分（仅一次）
只有在生成完成接口文件后，您才能在每个业务模块中加上接口的具体实现注入。该方法每个业务模块加一次即可。
Step5：在启动文件中引用接口实现注册（仅一次）
可以发现，该命令除了生成接口文件之外，还生成了一个接口实现注册文件。该文件用于在程序启动时，将接口的具体实现在启动时执行注册。
该文件的引入需要在main包的最顶部引入，需要注意import的顺序，放到最顶部，后面加一个空行。如果同时存在packed包的引入，那么放到packed包后面。像这样：
Step6：Start&Enjoy
启动main.go即可。
常见问题FAQ
快速定位接口的具体实现
项目业务模块采用接口化解耦后体验非常棒！但是我在开发和调试过程中，想要快速找到指定接口的具体实现有点困难，能给点指导思路吗？
> 这里我推荐使用Goland IDE，有个很棒的接口实现定位功能，具体如图。找到接口定义后，点击左边的小图标可快速定位具体的实现。如果Goland不显示小图标，可以尝试升级使用最新版本的Goland哈。
或者在左侧没有小图标的时候，可以右键选择 Go To → Implementation(s)
| Panel | ||
|---|---|---|
| ||
|