一个有意思的命令行代码生成器
- 常用模版
- 任务依赖+引用
- 字符串转换指令
- 类型转换指令
- 日期指令
- 导入上下文
go build -o cg main.go
mv ./cg ~/bin/cg # 改成你的path路径
cg version # 测试并查看版本在需要生成代码的项目根目录里使用 cg init 命令，会在项目根目录生成 .cg 文件夹，用于存放模板文件、配置文件以及输出的文件。
cd <your_project_directory>
cg init.cg文件夹结构如下：
.cg
├── config.yaml
├── out
│ ├── User.java
│ ├── UserController.java
│ ├── UserMapper.java
│ ├── UserMapper.xml
│ ├── UserService.java
│ └── UserServiceImpl.java
└── templates
├── java_controller.tpl
├── java_entity.tpl
├── java_mapper.tpl
├── java_mapper_xml.tpl
├── java_service.tpl
└── java_service_impl.tpl
init命令会默认生成常用模版文件，可以根据不同的项目需求，在 .cg/templates 文件夹下创建或者修改模板文件
例如初始化命令自动生成的java_entity.tpl 文件，可用于生成java entity类
package {{package "."}};
{{""}}
{{- range imports}}
{{.}}
{{end -}}
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.*;
/**
* {{table "comment"}} 实体类
*
* @Author {{config "author"}}
* @Date {{now}}
*/
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
@TableName("{{table "name"}}")
@ApiModel(value="{{table "comment"}}实体类", description="{{table "comment"}}实体类")
public class {{className "."}} {
{{- range columns}}
@ApiModelProperty(value = "{{.comment}}")
@TableField("{{.name}}")
private {{dbToJava .type}} {{camelCase .name}}{{";"}}
{{end -}}
}
在 .cg/config.yaml 文件中配置task，例如生成entity文件的任务。
mysql:
username: root
password: root
host: 127.0.0.1
port: 3306
database: test
table: user
author: melon
base-package: com.example
module: cg
tasks:
# 生成java实体类
- name: entity
template: java_entity.tpl
prefix: ""
postfix: ""
file-type: .java
properties:
sub-package: dao.entity
enable: true
# 生成java mapper接口
- name: mapper
template: java_mapper.tpl
prefix: ""
postfix: Mapper
file-type: .java
properties:
sub-package: dao.mapper
enable: true
# 生成java mybatis 的xml文件
- name: xml
template: java_mapper_xml.tpl
prefix: ""
postfix: Mapper
file-type: .xml
enable: true
# 生成java service接口
- name: service
template: java_service.tpl
prefix: ""
postfix: Service
file-type: .java
properties:
sub-package: service
enable: true
# 生成java services实现类
- name: serviceImpl
template: java_service_impl.tpl
prefix: ""
postfix: ServiceImpl
file-type: .java
properties:
sub-package: service.impl
enable: true
# 生成java controller类
- name: controller
template: java_controller.tpl
prefix: ""
postfix: Controller
file-type: .java
properties:
sub-package: controller
enable: true在需要生成代码的项目的根目录下执行 cg run 命令，会根据配置文件生成代码到.cg/out目录。
cg run