002_手把手教程_mybatis-generator自动生成代

写在前面的话

当你开发时间长了，你会发现在ORM这一层其实有很多代码都不用写，可以交给一些插件代为生成。这样当你设计完表结构后就可以直接使用这些插件生成ORM层大大简化开发人员的代码量。

现在我们使用mybatis generator来帮我们生成DAO层的代码。go

1.首先在数据库中创建一个表

我使用mysql作为我开发使用的数据库。创建一个user_info_t表。建表sql如下：

CREATE TABLE `user_info_t` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `user_name` varchar(50) DEFAULT NULL,
  `user_password` varchar(50) DEFAULT NULL,
  `user_email` varchar(100) DEFAULT NULL,
  `user_phone_number` varchar(13) DEFAULT NULL,
  `user_key` varchar(20) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

继续使用上一节我们创建好的spring boot样例代码，在这个基础上生成ORM层。后期会慢慢在这个项目上面添加更多的功能。

2.添加mybatis generator需要的maven插件

在这里推荐使用maven插件作为mybatis generator的工具，你可以可以使用eclipse插件（可以自己在网上查找相关插件如何使用），打开pom文件，将插件粘贴其中

<!-- mybatis自动生成代码插件  开始 -->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.2</version>
            <configuration>
                <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                <verbose>true</verbose>
                <overwrite>true</overwrite>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-core</artifactId>
                    <version>1.3.2</version>
                </dependency>
            </dependencies>
        </plugin>
        <!-- mybatis自动生成代码插件  结束 -->

在插件中需要读取配置文件“generatorConfig.xml”这个文件随意取，只要读到这个文件即可。

3.导入mysql驱动和mybatis需要的jar包

因为我们使用mysql库，使用mybatis作为ORM层，所以我们需要在POM中导入相关的坐标。spring boot没有自动集成这些东西。

<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.3.0</version>
    </dependency>

4.编写mybatis genertor需要的配置文件

<?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>
    <classPathEntry location="/Users/zhuchao/.m2/repository/mysql/mysql-connector-java/5.1.38/mysql-connector-java-5.1.38.jar"/>
    <context id="my" targetRuntime="MyBatis3">
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <commentGenerator>
            <property name="suppressDate" value="false"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/passwordDB?useUnicode=true&characterEncoding=UTF-8" 
                        userId="root"
                        password=""/>

        <javaModelGenerator targetPackage="com.user.entity"
                            targetProject="/Users/zhuchao/helpme/maven-springboot-test/src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="com.user.mapper"
                         targetProject="/Users/zhuchao/helpme/maven-springboot-test/src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <javaClientGenerator targetPackage="com.user.mapper"
                             targetProject="/Users/zhuchao/helpme/maven-springboot-test/src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <table tableName="user_info_t" domainObjectName="UserInfo"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>

    </context>
</generatorConfiguration>

上面的配置相信大家多少可以读懂一些。简单介绍几个主要的配置：

1. javaModelGenerator:表示需要生成的实体类
2. sqlMapGenerator:表示生成的mapper.xml
3. javaClientGenerator:表示生成的接口类。需要注意的是type属性，主要有三种type。分别为：
   1.ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML；
   2.MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中；
   3.XMLMAPPER：会生成Mapper接口，接口完全依赖XML；
   一般我使用XMLMAPPER

5.启动代码生成器

打开maven配置：输入mybatis-generator:generate 点击run即可生成代码

QQ20170831-0@2x.png