MyBatis Generator

Why

生成pojo,mapper.java.mapper.xml文件（包含基础增删改查），提交工作效率，解决繁琐的消逝

使用方法

1. pom.xml导入插件

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
</dependency>
<!-- Mybatis Dynamic Sql 依赖，可以不添加 -->
<!-- <dependency>
    <groupId>org.mybatis.dynamic-sql</groupId>
    <artifactId>mybatis-dynamic-sql</artifactId>
    <version>1.1.4</version>
</dependency> -->

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <configuration>
        <!--配置文件的位置-->
        <configurationFile>src/main/resources/generatorConfig.xml
        </configurationFile>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>
    </dependencies>
</plugin>

1. 在resources目录下创建generatorConfig.xml文件

<?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>
    <!--导入属性配置-->
    <properties resource="datasource.properties"/>
    <!-- 指定数据库驱动的jdbc驱动jar包的位置 -->
    <!--    <classPathEntry location="${db.driverLocation}" />-->

    <!-- context 是逆向工程的主要配置信息 -->
    <!-- id：起个名字 -->
    <!-- targetRuntime：设置生成的文件适用于那个 mybatis 版本
    1.4.0默认使用MyBatis Dynamic SQL
     -->
    <context id="default" targetRuntime="mybatis3simple" >
        <!--optional,旨在创建class时，对注释进行控制-->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="false"/>
            <!-- 生成的Java文件的编码 -->
            <property name="javaFileEncoding" value="utf-8"/>
            <!-- 格式化java代码-->
            <property name="javaFormatter"
                      value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
            <!-- 格式化XML代码-->
            <property name="xmlFormatter"
                      value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        </commentGenerator>
        <!--jdbc的数据库连接-->
        <jdbcConnection
                driverClass="${jdbc.driverClass}"
                connectionURL="${jdbc.connectionURL}"
                userId="${jdbc.userId}"
                password="${jdbc.password}">
        </jdbcConnection>

        <!--非必须，类型处理器，在数据库类型和java类型之间的转换控制-->
        <javaTypeResolver>
            <!-- 默认情况下数据库中的 decimal，bigInt 在 Java 对应是 sql 下的 BigDecimal 类 -->
            <!-- 不是 double 和 long 类型 -->
            <!-- 使用常用的基本类型代替 sql 包下的引用类型 -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- targetPackage：生成的实体类所在的包 -->
        <!-- targetProject：生成的实体类所在的硬盘位置 -->
        <javaModelGenerator targetPackage="com.sx.sc.pojo"
                            targetProject="./src/main/java">
            <!-- 是否允许子包 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对modal添加构造函数 -->
            <property name="constructorBased" value="false"/>
            <!-- 是否清理从数据库中查询出的字符串左右两边的空白字符 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立modal对象是否不可改变 即生成的modal对象不会有setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!-- targetPackage 和 targetProject：生成的 mapper 文件的包和位置 -->
        <sqlMapGenerator targetPackage="mappers"
                         targetProject="./src/main/resources">
            <!-- 针对数据库的一个配置，是否把 schema 作为字包名 -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- targetPackage 和 targetProject：生成的 interface 文件的包和位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.sx.sc.mapper"
                             targetProject="./src/main/java">
            <!-- 针对 oracle 数据库的一个配置，是否把 schema 作为字包名 -->
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <table tableName="vip" domainObjectName="Vip">
            <!--下划线转驼峰,设置为true就使用原本字段名-->
            <property name="useActualColumnNames" value="false"/>
        </table>
    </context>
</generatorConfiguration>

3.生成datasource.properties文件

<!-- 8.0以上版本连接方法 -->
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mysql?serverTimezone=UTC
jdbc.userId=root
jdbc.password=123456

4.. 生成文件

5. Mybatis Dynamic SQL版本使用方法

MyBatis Dynamic SQL 是生成动态 SQL 语句的框架，可把它看作是一个类型安全的 SQL 模板库，另外还支持 MyBatis3 和 Spring JDBC 模板。

该库将生成格式化为由 MyBatis 或 Spring 使用的完整 DELETE，INSERT，SELECT 和 UPDATE 语句。

最常见的用例是生成语句和一组匹配的参数，这些参数可以被 MyBatis 直接使用。该库还将生成与 Spring JDBC 模板兼容的语句和参数对象。

该库通过实现一个类似 SQL 的 DSL 来创建一个对象，该对象包含完整的 SQL 语句以及该语句所需的任何参数。SQL 语句对象可以被 MyBatis 直接用作映射器方法的参数。

该模式下不再生成 XML，不再生成 Example 类。文档里也推荐：join 操作要用到的 resultMap 应该是 XML 文件中的唯一元素。

暂无-学习中

接口继承

在数据库更改字段后，如果使用MybatisGenerator生成文件，mapper文件会被覆盖，写过的方法需要重新编写。

解决方法

1. 在mapper中建立一个extend包，建立xxMapperExtends接口，在这个接口内书写自己的方法,最后xxMapper文件继承这个接口就可以实现分离，如：
   
2. resource目录结构如下
   
3. mybatis设置中的配置路径
   mybatis.mapper-locations=classpath:mybatis/*/*.xml