如何借助工具快速生成代码?新手容易踩的这些坑一定要避开

开发 项目管理
在业务项目实践中,业务逻辑封装往往是最复杂的部分,同时,业务模块之间的依赖十分复杂、边界模糊,无法采用Golang包管理的形式。

​使用 gen service 自动生成代码

注意:该功能特性从goframe v2.1版本开始提供。

基本介绍

设计背景

在业务项目实践中,业务逻辑封装往往是最复杂的部分,同时,业务模块之间的依赖十分复杂、边界模糊,无法采用Golang包管理的形式。

如何有效管理项目中的业务逻辑封装部分呢?对于每个采用Golang开发的项目都是必定会遇到的难题。

设计目标

增加logic分类目录,将所有业务逻辑代码迁移到logic分类目录下,采用包管理形式来管理业务模块。

业务模块之间的依赖通过接口化解耦,将原有的service分类调整为接口目录。这样每个业务模块将会各自维护、更加灵活。

可以按照一定的项目规范,从logic业务逻辑代码生成service接口定义代码。

同时,也允许人工维护这部分service接口。

命令使用

gf gen service命令通过分析给定的logic业务逻辑模块目录下的代码,自动生成service目录接口代码。

需要注意:

  • 由于该命令是根据业务模块生成service接口,因此只会解析二级目录下的go代码文件,并不会无限递归分析代码文件。以logic目录为例,该命令只会解析logic/xxx/*.go文件。因此,需要logic层代码结构满足一定规范。
  • 不同业务模块中定义的结构体名称在生成的service接口名称时可能会重复覆盖,因此需要在设计业务模块时保证名称不能冲突。手动模式

手动执行(不建议)

如果是手动执行命令行,直接在项目根目录下执行 gf gen service 即可。

$ 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

参数说明:

图片

自动模式(强烈建议)

如果你是使用的GolandIDE,那么可以使用官方提供的配置文件:watchers.xml 

图片

自动模式配置教程

1. 引入官方提供的配置文件

建议在使用Goland IDE时,使用官方提供的配置文件:watchers.xml

watchers.xml下载地址:https://goframe.org/pages/viewpage.action?pageId=49770772&preview=/49770772/49770777/watchers.xml

2. 编写业务逻辑代码

图片

3. 生成接口及服务注册文件

如果你已经按照步骤1做好了watchers.xml的配置,那么这一步可以忽略。因为在我们编写代码的时候,service便同时生成了接口定义文件。

如果没有配置,我们每次编写logic业务模块后,都需要手动执行一下 gf gen service 命令。

所以,我强烈建议你按照教程配置watchers.xml

不管用哪种方式,生成的service目录,效果如下:

图片

注意:下面就是我说的初学者容易踩的坑

4. 注意服务的实现注入部分(仅一次)

只有在生成接口文件后,才能在每个业务模块中加上接口的具体实现注入。该方法每个业务模块加一次就可以。

比如这种:

图片

5. 在启动文件中引用接口实现注册(仅一次)

注意:gf gen service命令除了生成接口文件之外,还生成了一个接口实现注册文件。

这个文件用于程序启动时,将接口的具体实现执行注册。

图片

该文件的引入需要在main包的最顶部引入,需要注意import的顺序,放到最顶部,后面加一个空行。如果同时存在packed包的引入,那么放到packed包后面。像这样:

图片

6. 搞定

完成上面的5步操作,我们就搞定了初学者容易踩坑的:通过编写logic层业务逻辑,自动生成service层代码部分

跑通业务功能

上面介绍了 gf gen service 的使用,是本期的重点。

本文转载自微信公众号「 程序员升级打怪之旅」,作者「王中阳Go」,可以通过以下二维码关注。

转载本文请联系「 程序员升级打怪之旅」公众号。

责任编辑:武晓燕 来源: 程序员升级打怪之旅
相关推荐

2019-08-21 19:49:21

机器学习人工智能

2019-08-07 06:16:28

物联网IOT技术

2023-09-26 07:43:22

工具骨架屏页面

2022-11-04 08:38:57

索引数据分库

2018-10-26 14:32:46

2014-10-29 14:52:13

程序员

2017-06-08 09:19:35

2024-05-30 19:01:53

AI技术大会

2020-12-03 10:17:25

Kubernetes架构微服务

2018-08-15 13:25:18

Java开源工具

2020-08-19 10:11:36

SQLMySQL数据库

2021-09-22 13:08:06

开发技能SQL

2021-09-07 14:35:48

DevSecOps开源项目

2021-03-15 12:00:19

Kubernetes微服务架构

2018-09-04 15:10:40

2024-03-04 08:19:11

SpringURLHeader

2018-02-25 04:57:01

物联网网络技术v

2010-09-25 08:44:34

捆绑后门

2024-03-11 18:17:18

Python字符串分隔符

2022-04-27 07:21:06

HTTPAPI系统
点赞
收藏

51CTO技术栈公众号