【电商实战02】如何借助工具快速生成代码？初学者容易踩的坑有哪些？

站长

2022年12月08日 16:18 · 阅读数 20

上期回顾

上一篇内容分享了【电商实战01】如何快速编写api层和model层？这篇内容继续分享重点内容：如何借助工具快速生成代码？初学者容易踩的坑有哪些？

如果你第一次看我【电商实战】系列的文章，建议先看【电商实战系列】先看这里：适合人群&课程大纲&开源地址&视频合集&一起学习

看过的朋友请忽略，继续往下看

本期重点

使用 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