文末送书Go语言自动生成项目与固定代码

Posted 2023-03-12 小生凡一

写在前面（文末送书！点赞或是评论本博客即可参与送书活动！）

最近在做毕设，前台做完了，现在要开始搭建后台系统了，而后台系统，又大多数是固定的模版。
所以为了方便摸鱼，顺便写一个可以 自动生成模版 的代码工具

开源地址：https://github.com/CocaineCong/fgen

1. 项目生成

1.1 项目结构

目前只支持生成单体式的项目结构目录，后续会更新微服务分布式的目录生成

效果如下

那么首先，我现阶段所了解的项目目录结构是一下结构：

demo/
├── api // 暴露出api接口，承接router转发的请求道service层
├── cmd // 项目启动
├── config // 配置文件存放
├── consts // 定义常量
├── loading // 加载配置
├── middleware // 中间件
├── repository //持久层
│  ├── db // 数据库
│  │  ├── dao // dao层
│  │  └── model // 一些定义的 struct 模型
│  └── redis // 缓存或是redis
├── test // test测试文件
├── pkg // 存放一些配置
│  ├── e 
│  └── util
├── router // 路由 
├── types // 类型转换
├── serializer // 一些序列化，将数据传送给前端
└── service // 服务层

1.2 生成目录

传入 project 的 path 以及 path 的 name ，用一个数组将这些目录存起来，因为对于一些特殊的目录，还要生成二级目录，或者是一些必备的文件，比如说 config 目录下的 .yaml 文件。

func GenProject(projectPath, projectName string) error 
	if projectPath == "" 
		projectPath = "./"
	

	if projectName == "" 
		// 外层能保证不为空
		projectName = "demo/"
	

	genApiPath := projectPath + projectName + "api/"
	genCmdPath := projectPath + projectName + "cmd/"
	genConfigPath := projectPath + projectName + "config/"
	genConstsPath := projectPath + projectName + "consts/"
	genLoadingPath := projectPath + projectName + "loading/"
	genMiddlewarePath := projectPath + projectName + "middleware/"
	genPkgPath := projectPath + projectName + "pkg/"
	genRepositoryPath := projectPath + projectName + "repository/"
	genRouterPath := projectPath + projectName + "router/"
	genSerializerPath := projectPath + projectName + "serializer/"
	genServicePath := projectPath + projectName + "service/"
	genTestPath := projectPath + projectName + "test/"
	genTypesPath := projectPath + projectName + "types/"
	genModsPath := projectPath + projectName + "go.mod"
	genPaths := []stringgenApiPath, genCmdPath, genConfigPath, genConstsPath, genLoadingPath, genMiddlewarePath, genPkgPath, genRepositoryPath, genRouterPath, genSerializerPath, genServicePath, genTestPath, genTypesPath, genModsPath

1.3 config 配置文件生成

我们逐个遍历上面的数组列表，会针对一些特定特殊的 path 进行操作。比如这个config，我们会生成对应的config.yaml 配置文件

case genConfigPath:
	if err := gfile.Mkdir(genConfigPath); err != nil 
		glog.Fatal("mkdir for generating path:%s failed: %v", genPath, err)
	
	if err := gfile.Mkdir(genConfigPath + "local/"); err != nil 
		glog.Fatal("mkdir for generating path:%s failed: %v", genPath, err)
	
	yamlPath := genConfigPath + "local/config.yaml"
	entityContent := gstr.ReplaceByMap(configYamlTemplate, g.MapStrStr
		"domain": projectName[:len(projectName)-1],
	)

	if err := writeFile(yamlPath, entityContent); err != nil 
		return err
	

	entityContent = strings.Replace(configGolangTemplate, "'", "`", -1)
	configGo := genConfigPath + "config.go"
	if err := writeFile(configGo, entityContent); err != nil 
		return err
	

以下就是yaml文件的生成代码文件模版，如果需要什么再往上面加就好了。

const configYamlTemplate = `
system:
  domain: domain
  version: 1.0
  appEnv: "test"
  HttpPort: ":4000"
  Host: "localhost"

mysql:
  default:
    dialect: "mysql"
    host: "127.0.0.1"
    port: "3306"
    dbName: "hello_story"
    user: "root"
    password: "root"
    charset: "utf8mb4"

redis:
  name: 1
  address: 127.0.0.1:6379
  password: 
`

如何代替这个 domain 呢？

可以使用以下方法，对模版内容进行填充。

entityContent := gstr.ReplaceByMap(configYamlTemplate, g.MapStrStr
		"domain": projectName[:len(projectName)-1],
	)

1.4 生成go mod文件

由于go mod 文件的特殊性，我们要先获取系统的go版本。

func getGolangVersion() (string, error) 
	ver := runtime.Version()
	if ver != "" 
		return ver[2:6], nil
	
	return "", errors.New("golang 环境不存在")

再进行填充模版，并且由于引入了其他的包文件，所以我们不得不 最后执行 go mod tidy 。

1.5 脚本执行

由于引入了第三方包，所以我们最终还是要 go mod tidy 一下。

先测试网络环境

pingCmd := exec.Command("ping", "-c 5 baidu.com")
_, err := pingCmd.CombinedOutput()
if err != nil 
	fmt.Println("err", err)
	return err

网络正常后，我们再生成一个 start.sh 文件
这个文件内容如下：

cd path
go env -w GOPROXY=https://goproxy.cn,direct
go mod tidy

先进入到这个项目的目录，然后再进行源的替换，后面再进行 go mod tidy 。就能让项目初始化完成，就能正常启动了。

下一步的话呢，打算把 model 也放进来，打通一下 model 层面的自动生成，curd的代码。

2. 文末送书

这周推荐了这两本书籍，一本是web攻防的书籍，另一本是关于元宇宙的书籍。

2.1 web安全攻防从入门到精通

本书从一开始便对Web开发基础和靶场搭建做了详细介绍，结合红日安全团队的漏洞挖掘和评估项目实战经验对各种实战技术进行分析，便于读者理解书中讲到的项目评估攻防案。

2.2 动漫元宇宙

看半小时漫画，通元宇宙未来100年，300幅手绘插图轻松读懂虚实共生的未来世界。剖析元宇宙三大定律、大统一方程、熵增定律、Web3.0、万亿元资产、元人与区块块链文明，构建元宇宙大楼。讲透元技术区块链、元宇宙基石Web3.0到穿越未来的技术大革命。厘清8大产业规律和11大投资方向，从元宇宙经济学到财富自由2.0，构建NO.1无限∞世界的数字空间，从元人到理想国。

点赞或是评论本博客即可参与送书活动！

每周都会送出书本的！当然没有中奖的同学也可以前往这里购买哈～

http://product.dangdang.com/29460729.html
http://product.dangdang.com/29513251.html