造轮子目的

使用yml配置来简化MyBatis Generator默认使用的xml配置
支持注释生成、lombok、swagger等常用插件的方便配置
介绍使用某种配置或插件的好处
试图寻找针对不同情景的最优配置

内容

环境要求
如何使用
插件介绍
待完善
Contributing

环境要求

安装好Java8和一个IDE
项目中使用了maven
项目中使用了Mybatis3

如何使用

Step 1: 确保您的工程是maven工程，在您的maven pom.xml文件中添加mybatis-generator-yml-maven-plugin插件：

<plugin>
    <groupId>io.github.javthon</groupId>
    <artifactId>mybatis-generator-yml-maven-plugin</artifactId>
    <version>0.0.1</version>
    <configuration>
        <configurationFile>src/main/resources/generatorConfig.yml</configurationFile>
    </configuration>
</plugin>

Step 2: 在resources目录下新建generatorConfig.yml，并将下方完整配置样例中的代码粘贴进去，按您对源码中配置的理解修改配置或根据GitHub代码地址的配置说明修改配置

Step 3: 确保配置信息无误后运行mvn mybatis-generator-yml:generate，在Intellij IDEA中的maven窗口的plugins下可以找到这个命令，双击就能运行

配置

完整配置样例

mybatisGenerator:
    datasource:
        type: mysql
        address: localhost:3306
        db: test
        username: root
        password: root

    targetPackage:
        model: com.example.domain
        mapper: com.example.dao
        javaXmlFilesSamePackage: true

    targetRuntime: MyBatis3
    mapperSuffixName: mapper
    java8: false
    disableExample: true

    plugins:
        comment: true
        lombok: false
        swagger: false
        mapperAnnotation: false
        serializable: false

    tables:
        - user
        - role

插件介绍

未使用任何插件前代码

import java.util.Date;

public class Role {
    private Long id;

    private String name;

    private String remark;

    private Date createTime;

    private Date updateTime;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getRemark() {
        return remark;
    }

    public void setRemark(String remark) {
        this.remark = remark;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Date getUpdateTime() {
        return updateTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }
}

注释插件

使用后在每个字段上方生成数据库中对应字段的注释：

import java.util.Date;

public class Role {
    /**
     * id
     */
    private Long id;

    /**
     * 角色名称
     */
    private String name;

    /**
     * 角色备注
     */
    private String remark;

    /**
     * 创建时间
     */
    private Date createTime;

    /**
     * 更新时间
     */
    private Date updateTime;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getRemark() {
        return remark;
    }

    public void setRemark(String remark) {
        this.remark = remark;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Date getUpdateTime() {
        return updateTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }
}

lombok插件

使用本插件需要加入lombok的依赖，并且要安装开发工具对lombok支持的插件。使用本插件后没有setter和getter，大大简化了代码：

import java.util.Date;
import lombok.Data;

/**
 * role
 * @author Tensorflow
 * @date 2020-09-08 22:24:45
 */
@Data
public class Role {
    private Long id;

    private String name;

    private String remark;

    private Date createTime;

    private Date updateTime;
}

swagger插件

使用本插件需要加入swagger2的依赖，项目中使用swagger2作为接口测试框架的可以使用此插件：

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.Date;

@ApiModel(value="com.example.domain.Role")
public class Role {
    @ApiModelProperty(value="id")
    private Long id;

    @ApiModelProperty(value="角色名称")
    private String name;

    @ApiModelProperty(value="角色备注")
    private String remark;

    @ApiModelProperty(value="创建时间")
    private Date createTime;

    @ApiModelProperty(value="更新时间")
    private Date updateTime;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getRemark() {
        return remark;
    }

    public void setRemark(String remark) {
        this.remark = remark;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Date getUpdateTime() {
        return updateTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }
}

mapperAnnotation插件

在java mapper接口上添加了@Mapper注解

serializable插件

model实现了Serializable接口

待完善

支持更多数据库
支持更多实用的插件
探索MyBatis3DynamicSql和MyBatis3的优劣

Contributing

如不支持您用的数据库，或不符合您的数据库版本，请new issues或者加入此项目的开发中来
如您发现本项目的错误或有好的意见也欢迎加入
Your contributions are always welcome!

mybatis-generator-yml-maven-plugin

MyBatis Generator yml configuration, lombok plugin, swagger plugin support