使用mybatis-generator自动生成MyBatis代码

在mysql数据库中创建user表，包含id(BIGINT)、name(VARCHAR)、age(INT)字段。

配置

• 配置数据源,以及mybatis配置文件路径和xml路径

spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

mybatis.configLocation=classpath:MybatisConfig.xml
mybatis.mapperLocations=classpath:mapping/*.xml

• 在pom文件中加入依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.1</version>
    </dependency>
    
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

• 配置自动扫描

@SpringBootApplication
@MapperScan("com.learn.dao")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

• 在pom文件中加入插件

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.6</version>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
        </dependency>
    </dependencies>
    <configuration>
        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
    </configuration>
</plugin>

configurationFile可指定配置文件路径

刷新maven，可以看到maven/Plugins里面出现了mybatis-generator

配置generatorConfig.xml

• 新增generatorConfig.properties

#Mybatis Generator configuration
jdbc_driver=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/test?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
jdbc_user=root
jdbc_password=root

• 新增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="generatorConfig.properties"/>

    <!-- 一个数据库一个context -->
    <context id="context">
        <!-- 注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="false"/><!-- 是否取消注释 -->
            <property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳-->
        </commentGenerator>

        <!-- jdbc连接 -->
        <jdbcConnection driverClass="${jdbc_driver}"
                        connectionURL="${jdbc_url}"
                        userId="${jdbc_user}"
                        password="${jdbc_password}" />

        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成实体类地址 -->
        <javaModelGenerator targetPackage="com.learn.model"
                            targetProject="src/main/java" >
            <!-- 是否在当前路径下新加一层schema,eg：false路径com.learn.model， true:com.learn.model.[schemaName] -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否针对string类型的字段在set的时候进行trim调用 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成mapxml文件 -->
        <sqlMapGenerator targetPackage="mapping"
                         targetProject="src/main/resources" >
            <!-- 是否在当前路径下新加一层schema,eg：false路径src/main/resources/mapping， true:src/main/resources/mapping/[schemaName] -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>

        <!-- 生成mapxml对应client，也就是接口dao -->
        <javaClientGenerator targetPackage="com.learn.dao"
                             targetProject="src/main/java" type="XMLMAPPER" >
            <!-- 是否在当前路径下新加一层schema,eg：false路径com.learn.dao， true:com.learn.dao.[schemaName] -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <!-- 配置表信息 -->
        <table tableName="user"
               domainObjectName="User" enableCountByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               enableUpdateByExample="false">
            <!-- schema即为数据库名 tableName为对应的数据库表 domainObjectName是要生成的实体类 enable*ByExample
                是否生成 example类   -->

            <!-- 忽略列，不生成bean 字段 -->
            <!--<ignoreColumn column="id" />-->
            <!-- 指定列的java数据类型 -->
            <!--<columnOverride column="age" jdbcType="VARCHAR" />-->
        </table>

    </context>
</generatorConfiguration>

运行插件生成代码

• 找到maven/Plugins里面的mybatis-generator
• 双击运行mybatis-generator:generate
  可以看到com.learn.dao中生成了接口文件，com.learn.model生成了bean对象，resources/mapping中生成了xml映射文件。

新增测试用例

@RunWith(SpringRunner.class)
@SpringBootTest
@Transactional
public class ApplicationTests {

    @Resource
    private UserMapper userMapper;

    @Test
    @Rollback
    public void findByName() throws Exception {
        User user = new User();
        user.setId(1L);
        user.setAge(22);
        user.setName("张三");
        userMapper.insert(user);
        Assert.assertEquals(22, userMapper.selectByPrimaryKey(1L).getAge().intValue());
    }

}

项目地址