<!-- MyBatis 生成器 -->
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>${mybatis-generator.version}</version>
</dependency>

<!-- SpringBoot整合MyBatis -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>${mybatis-starter.version}</version>
</dependency>
<!-- MyBatis分頁(yè)插件 -->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>${pagehelper-starter.version}</version>
</dependency>
<!-- 集成druid連接池 -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>${druid.version}</version>
</dependency>
<!-- Mysql數(shù)據(jù)庫(kù)驅(qū)動(dòng) -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>${mysql-connector.version}</version>
</dependency>

# 配置數(shù)據(jù)源
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/<database>?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
    username: <username>
    password: <password>
# Mybatis 相關(guān)配置
mybatis:
  # 配置映射文件路徑
  mapper-locations:
    - classpath:mapper/*.xml
    - classpath:mbg/mapper/*/*.xml

/**
 * MyBatis 配置類(lèi)(掃描 Mapper 接口)
 */
@MapperScan({"cn.javgo.learningmybatis.mapper","cn.javgo.learningmybatis.mbg.mapper"})
@SpringBootConfiguration
public class MyBatisConfig {
}

jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/<database>?useSSL=false&serverTimezone=UTC
jdbc.username=<username>
jdbc.password=<password>

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <!-- 導(dǎo)入屬性配置 -->
    <properties resource="generator.properties"/>
    <!-- MBG 上下文環(huán)境
        id：上下文環(huán)境唯一標(biāo)識(shí)，必須唯一
        targetRuntime：生成的目標(biāo)運(yùn)行環(huán)境
            MyBatis3：代表生成MyBatis3.x版本的代碼
            MyBatis3Simple：新版本的生成器
            MyBatis3DynamicSql：新版本的生成器
        defaultModelType：生成的默認(rèn)Model類(lèi)型
            flat：代表生成的Model都是一個(gè)個(gè)的獨(dú)立的類(lèi)，例如生成Dept類(lèi)（推薦）
            hierarchical：代表生成的Model類(lèi)會(huì)按照層級(jí)進(jìn)行組織，例如生成Dept、DeptMapper、DeptExample三個(gè)類(lèi)
     -->
    <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
        <!-- 配置SQL語(yǔ)句中的前置分隔符 -->
        <property name="beginningDelimiter" value="`"/>
        <!-- 配置SQL語(yǔ)句中的后置分隔符 -->
        <property name="endingDelimiter" value="`"/>
        <!-- 配置生成Java文件的編碼 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!--生成mapper.xml時(shí)覆蓋原文件-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin"/>
        <!-- 為模型生成序列化方法-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 為生成的Java模型創(chuàng)建一個(gè)toString方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!--可以自定義生成model的代碼注釋
            type：自定義注釋生成器的類(lèi)全限定名
        -->
        <commentGenerator type="cn.javgo.learningmybatis.mbg.CommentGenerator">
            <!-- 是否阻止生成的注釋 -->
            <property name="suppressAllComments" value="true"/>
            <!-- 是否阻止生成的注釋包含時(shí)間戳 -->
            <property name="suppressDate" value="true"/>
            <!-- 是否添加數(shù)據(jù)庫(kù)表的備注信息 -->
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>
        <!-- 配置數(shù)據(jù)庫(kù)連接 -->
        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.connectionURL}"
                        userId="${jdbc.username}"
                        password="${jdbc.password}">
            <!-- 配置數(shù)據(jù)庫(kù)連接的屬性信息
                autoReconnect：是否自動(dòng)重連
                allowMultiQueries：是否允許執(zhí)行多條SQL語(yǔ)句
                useUnicode：是否使用Unicode字符集
                characterEncoding：設(shè)置字符集編碼
                useSSL：是否使用SSL
                nullCatalogMeansCurrent：是否將null catalog看作當(dāng)前catalog（解決 MySql 8.0 以上版本不生成指定數(shù)據(jù)庫(kù)代碼的問(wèn)題）
             -->
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>
        <!-- 配置實(shí)體類(lèi)的包名和位置
            targetPackage：生成的實(shí)體類(lèi)存放的包名
            targetProject：生成的實(shí)體類(lèi)存放的位置
        -->
        <javaModelGenerator targetPackage="cn.javgo.learningmybatis.mbg.model" targetProject="src/main/java">
            <!-- 是否允許子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="true"/>
            <!-- 是否對(duì)model添加構(gòu)造函數(shù) -->
            <property name="constructorBased" value="true"/>
            <!-- 是否對(duì)類(lèi)CHAR類(lèi)型的列的數(shù)據(jù)進(jìn)行trim操作 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 配置SQL映射文件的包名和位置
            targetPackage：生成的SQL映射文件存放的包名
            targetProject：生成的SQL映射文件存放的位置
         -->
        <sqlMapGenerator targetPackage="cn.javgo.learningmybatis.mbg.mapper" targetProject="src/main/resources">
            <!-- 是否允許子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!-- 配置Mapper接口的包名和位置
            type：選擇怎么生成mapper接口（推薦使用XMLMAPPER）
                XMLMAPPER：生成XML對(duì)應(yīng)的Mapper接口
                ANNOTATEDMAPPER：生成基于注解的Mapper接口
                MIXEDMAPPER：生成XML對(duì)應(yīng)的Mapper接口，同時(shí)也生成基于注解的Mapper接口
            targetPackage：生成的Mapper接口存放的包名
            targetProject：生成的Mapper接口存放的位置
         -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="cn.javgo.learningmybatis.mbg.mapper"
                             targetProject="src/main/java">
            <!-- 是否允許子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 指定數(shù)據(jù)庫(kù)表
            tableName：數(shù)據(jù)庫(kù)表名
            domainObjectName：生成的實(shí)體類(lèi)名（默認(rèn)去掉下劃線，駝峰命名）
         -->
        <table tableName="student">
            <!-- 配置自增主鍵
                column：指定獲取自增主鍵的列
                sqlStatement：指定獲取自增主鍵的SQL語(yǔ)句
                identity：指定是否為自增主鍵
             -->
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

package cn.javgo.learningmybatis.mbg;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.CompilationUnit;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;
import java.util.Properties;
/**
 * 自定義注釋生成器
 */
public class CommentGenerator extends DefaultCommentGenerator {
    // 是否添加數(shù)據(jù)庫(kù)表的注釋
    private boolean addRemarkComments = false;
    // Example 類(lèi)名后綴
    private static final String EXAMPLE_SUFFIX = "Example";
    // Mapper 類(lèi)名后綴
    private static final String MAPPER_SUFFIX = "Mapper";
    // ApiModelProperty 注解類(lèi)的全限定名（Swagger）
    private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME = "io.swagger.annotations.ApiModelProperty";
    /**
     * 設(shè)置用戶配置的參數(shù)
     * @param properties 用戶配置的參數(shù)
     */
    @Override
    public void addConfigurationProperties(Properties properties) {
        // 調(diào)用父類(lèi)方法保證父類(lèi)方法可以正常使用
        super.addConfigurationProperties(properties);
        // 從 properties 中獲取 addRemarkComments 參數(shù)值來(lái)判斷是否添加數(shù)據(jù)庫(kù)表的注釋
        this.addRemarkComments = Boolean.parseBoolean(properties.getProperty("addRemarkComments"));
    }
    /**
     * 給字段添加注釋
     * @param field 字段
     * @param introspectedTable 數(shù)據(jù)庫(kù)表
     * @param introspectedColumn 數(shù)據(jù)庫(kù)表字段
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        // 獲取數(shù)據(jù)庫(kù)表字段的注釋
        String remarks = introspectedColumn.getRemarks();
        // 根據(jù)參數(shù)和備注信息判斷是否添加備注信息
        if (addRemarkComments && StringUtility.stringHasValue(remarks)) {
            // 如果存在特殊字符，需要轉(zhuǎn)義
            if (remarks.contains("\"")) {
                remarks = remarks.replace("\"", "'");
            }
            // 給 model 的字段添加 Swagger 注解
            field.addJavaDocLine("@ApiModelProperty(value = \"" + remarks + "\")");
        }
    }
    /**
     * 給 Java 文件添加注釋
     * @param compilationUnit Java 文件
     */
    @Override
    public void addJavaFileComment(CompilationUnit compilationUnit) {
        // 調(diào)用父類(lèi)方法保證父類(lèi)方法可以正常使用
        super.addJavaFileComment(compilationUnit);
        // 獲取 Java 文件的全限定名
        String fullyQualifiedName = compilationUnit.getType().getFullyQualifiedName();
        // 如果不是 Mapper 類(lèi)或者 Example 類(lèi)，就添加 Swagger 注解類(lèi)的導(dǎo)入(因?yàn)橹挥?model 類(lèi)需要添加 Swagger 注解)
        if (!fullyQualifiedName.contains(MAPPER_SUFFIX) && !fullyQualifiedName.contains(EXAMPLE_SUFFIX)) {
            // 添加 Swagger 注解類(lèi)的導(dǎo)入
            compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME));
        }
    }
}

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>${springfox-swagger.version}</version>
</dependency>

package cn.javgo.learningmybatis.mbg;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
/**
 * 通過(guò) Java API 的方式運(yùn)行 MyBatis Generator
 */
public class Generator {
    public static void main(String[] args) throws Exception {
        // 存儲(chǔ)運(yùn)行 MBG 時(shí)的警告信息
        List<String> warnings = new ArrayList<>();
        // 生成的代碼重復(fù)時(shí)，覆蓋原代碼
        boolean overwrite = true;
        // 讀取 MBG 配置文件 generatorConfig.xml
        InputStream inputStream = Generator.class.getResourceAsStream("/generatorConfig.xml");
        // 傳入警告信息創(chuàng)建配置解析器（用于解析 generatorConfig.xml 配置文件）
        ConfigurationParser cp = new ConfigurationParser(warnings);
        // 解析配置文件
        Configuration config = cp.parseConfiguration(inputStream);
        // 關(guān)閉輸入流
        assert inputStream != null;
        inputStream.close();
        // 創(chuàng)建 DefaultShellCallback 對(duì)象，用于解決重復(fù)文件覆蓋問(wèn)題
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        // 創(chuàng)建 MyBatisGenerator 對(duì)象，執(zhí)行生成代碼
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        // 執(zhí)行生成代碼
        myBatisGenerator.generate(null);
        // 輸出警告信息
        for (String warning : warnings) {
            System.out.println(warning);
        }
    }
}

<!-- MyBatis 生成器 -->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <!-- 基本信息配置 -->
    <configuration>
        <!-- MyBatis Generator 配置文件 -->
        <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
        <!-- 允許移動(dòng)生成的文件 -->
        <overwrite>true</overwrite>
        <!-- 是否自動(dòng)覆蓋 -->
        <verbose>true</verbose>
    </configuration>
</plugin>

$ mvn mybatis-generator:generate

$ java -jar mybatis-generator-core-x.x.x.jar -configfile generatorConfig.xml

/**
 * 學(xué)生業(yè)務(wù)實(shí)現(xiàn)類(lèi)
 */
@Service
public class StudentServiceImpl implements StudentService {
    @Autowired
    private StudentMapper studentMapper;
    @Override
    public void save(Student student) {
        studentMapper.insert(student);
    }
    @Override
    public void update(Student student) {
        studentMapper.updateByPrimaryKeySelective(student);
    }
    @Override
    public void delete(Long id) {
        studentMapper.deleteByPrimaryKey(id);
    }
    @Override
    public Student select(Long id) {
        return studentMapper.selectByPrimaryKey(id);
    }
    @Override
    public List<Student> selectAll(int pageNum, int pageSize) {
        PageHelper.startPage(pageNum, pageSize);
        return studentMapper.selectByExample(new StudentExample());
    }
}

@Override
public List<Student> selectByCondition() {
    // 構(gòu)建一個(gè) Example 對(duì)象
    StudentExample example = new StudentExample();
    // 添加條件
    example.createCriteria().andIdGreaterThan(10L);
    // 執(zhí)行查詢
    return studentMapper.selectByExample(example);
} 

@Override
public List<Student> selectByCondition() {
    // 構(gòu)建一個(gè) Example 對(duì)象
    StudentExample example = new StudentExample();
    // 添加條件
    example.or().andIdGreaterThan(10L);
    example.or().andNameEqualTo("john");
    // 執(zhí)行查詢
    return studentMapper.selectByExample(example);
}

@Override
public List<Student> selectByCondition() {
    // 構(gòu)建一個(gè) Example 對(duì)象
    StudentExample example = new StudentExample();
    // 添加條件(desc 降序, asc 升序)
    example.setOrderByClause("id asc");
    // 執(zhí)行查詢
    return studentMapper.selectByExample(example);
}

@Override
public void deleteByCondition() {
    // 構(gòu)建一個(gè) Example 對(duì)象
    StudentExample example = new StudentExample();
    // 添加條件
    example.createCriteria().andIdGreaterThan(10L);
    // 執(zhí)行刪除
    studentMapper.deleteByExample(example);
}