Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/javthon/mybatis-generator-yml-maven-plugin

MyBatis Generator yml configuration, lombok plugin, swagger plugin support
https://github.com/javthon/mybatis-generator-yml-maven-plugin

java8 lombok mybatis mybatis-generator mybatis-plugin mysql swagger2

Last synced: 3 months ago
JSON representation

MyBatis Generator yml configuration, lombok plugin, swagger plugin support

Host: GitHub
URL: https://github.com/javthon/mybatis-generator-yml-maven-plugin
Owner: javthon
License: mit
Created: 2020-09-06T12:37:54.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-06-14T22:36:12.000Z (over 1 year ago)
Last Synced: 2024-09-30T13:42:41.726Z (3 months ago)
Topics: java8, lombok, mybatis, mybatis-generator, mybatis-plugin, mysql, swagger2
Language: Java
Homepage:
Size: 62.5 KB
Stars: 121
Watchers: 6
Forks: 11
Open Issues: 3
Metadata Files:
- Readme: Readme-CN.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        
[English](https://github.com/javthon/mybatis-generator-bestpractice) | 简体中文


![license](https://img.shields.io/badge/license-MIT-blue.svg)

![jdk](https://img.shields.io/badge/jdk-1.8%2B-blue.svg)

![language](https://img.shields.io/badge/language-java-yellow.svg)

## 在线工具

http://xxf.cool

## 造轮子目的

- 使用yml配置来简化MyBatis Generator默认使用的xml配置

- 支持注释生成、lombok、swagger等常用插件的方便配置

- 介绍使用某种配置或插件的好处

- 试图寻找针对不同情景的最优配置

## 内容

- [环境要求](#环境要求)

- [如何使用](#如何使用)

- [配置](#配置)

- [插件介绍](#插件介绍)

- [待完善](#待完善)

- [Contributing](#contributing)

## 环境要求

- 安装好Java8和一个IDE 

- 项目中使用了maven

- 项目中使用了Mybatis3  

## 如何使用

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

```

    io.github.javthon

    mybatis-generator-yml-maven-plugin

    0.0.1

    

        src/main/resources/generatorConfig.yml

    

```

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


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

```

### 配置概览

属性 | 类型 | 默认值 | 是否必须 | 描述

--- | --- | --- | --- |--- 

datasource | Map |  | 是 | 数据库的连接信息, 见下方的"数据源配置"

targetPackage| Map| | 是| 生成代码的包路径，见下方targetPackage配置

targetRuntime| String| MyBatis3|是|mybatis generator生产代码的格式,见下方targetRuntime可选项

mapperSuffixName|String|mapper|否|mapper类或xml文件的后缀名,如果将此属性设置为dao，并且表名是user，它将生成UserDao.java和UserDao.xml，如果targetRuntime设置为MyBatis3DynamicSql，则此属性将不起作用

java8|Boolean|false|否|如果为true，则生成模型日期字段将使用Java8的LocalDateTime或LocalDate，否则使用Date

disableExample|Boolean|true|否|此属性仅在targetRuntime为MyBatis3生效，为true时mapper不生成"by example"代码

plugins|Map||否| 配置是否开启注释, lombok, swagger, mapperAnnotation, serializable等插件, 详情见下方插件配置

tables|List||是|多个表格名，配置方式见generatorConfig.yml样例

#### 数据源配置

属性 | 类型 | 是否必须 | 描述

--- | --- | --- |--- 

type|String|是|数据库类型, 当前可选值为mysql, sqlserver，如果您使用的数据库不在其中，请new issues

address|String|是|IP和端口号，如：192.168.1.1:3306

db|String|是|数据库名

username|String|是|数据库用户名

password|String|是|数据库密码

#### targetPackage配置

属性 | 类型 | 是否必须 | 描述   

--- | --- | --- |--- 

model|String|否|生成模型的包路径, 如：com.example.domain

mapper|String|否|生成的java接口和xml mapper的包路径, 如:com.example.mapper

javaXmlFilesSamePackage|Boolean|否|如果是true，java接口和xml mapper会生成在一个包下，如果是false，xml mapper代码将生成至resources目录下，该属性仅在targetRuntime为MyBatis3Simple或MyBatis3时可用

#### 插件配置

属性 | 类型 | 是否必须 | 描述   

--- | --- | --- |--- 

comment|Boolean|否|是否开启model的注释

lombok|Boolean|否|是否使用lombok，不生成setter和getter

swagger|Boolean|否|是否使用swagger2注解

mapperAnnotation|Boolean|否|是否在mapper类上加@Mapper注解

serializable|Boolean|否|是否实现Serializable接口

#### targetRuntime的可选值

值|描述

--- | ---

MyBatis3DynamicSql|生成的代码依赖于MyBatis动态SQL库。 生成的代码为查询构造提供了极大的灵活性。 不生成XML。mybatis generator 1.4.0官方推荐此方式

MyBatis3|生成mapper java接口和xml配置文件。有"by example" 或者 "selective" 方法，代码比较啰嗦

MyBatis3Simple|生成mapper java接口和xml配置文件。没有"by example" 或者"selective"方法，代码较简洁

## 插件介绍

#### 未使用任何插件前代码

```

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!