mybatisgen(代码生成)使用笔记 mysql

用过几种mybatisgen工具，总是随用随仍，没有积累到什么。这次心想与其用别人的，不如自己弄个项目，好理解也有心得。

集成过程

pom.xml中引入

<dependency>
	<groupId>org.mybatis.spring.boot</groupId>
	<artifactId>mybatis-spring-boot-starter</artifactId>
	<version>1.3.2</version>
</dependency>
<!-- spring-boot-maven-plugin 是常规要引入的，在这我就不省略他了 -->
<build>
	<plugins>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
		</plugin>
		<plugin>
			<groupId>org.mybatis.generator</groupId>
			<artifactId>mybatis-generator-maven-plugin</artifactId>
			<configuration>
				<verbose>true</verbose>
				<overwrite>true</overwrite>
			</configuration>
		</plugin>
	</plugins>
</build>

配置generatorConfig.xml

这是主配置文件，很重要。
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>

    <!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
    <classPathEntry location="D:\maven repository\mysql\mysql-connector-java\5.1.16\mysql-connector-java-5.1.16.jar"/>

    <!-- 一个数据库一个context,defaultModelType="flat" 大数据字段，不分表 -->
    <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">

        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 -->
        <property name="autoDelimitKeywords" value="true"/>

        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="utf-8"/>

        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>

        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>

        <!-- 注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/><!-- 是否取消注释 -->
            <property name="suppressDate" value="false"/> <!-- 是否生成注释代时间戳-->
        </commentGenerator>

        <!-- jdbc连接-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test?serverTimezone=UTC" userId="root"
                        password="1234"/>

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

        <!-- 生成实体类地址 -->
        <javaModelGenerator targetPackage="com.example.entity" targetProject="src/main/java">
            <!-- 是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 从数据库返回的值去掉前后空格 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成map.xml文件存放地址 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 生成接口dao -->
        <javaClientGenerator targetPackage="com.example.dao" targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- table可以有多个,每个数据库中的表都可以写一个table，tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 enableSelectByPrimaryKey相应的配置表示是否生成相应的接口 -->
        <table tableName="t_librarian" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"
               enableSelectByPrimaryKey="true" enableUpdateByPrimaryKey="true"
               enableDeleteByPrimaryKey="true">
            <property name="useActualColumnNames" value="true"/>
        </table>
    </context>
</generatorConfiguration>

配置要素说明

要调整的内容有6个(其他默认就可以)：
mysql-connector-java驱动包地址
jdbc连接配置(url、帐号、密码)
实体类地址
接口地址
Mapper.xml地址
要生成哪些表

<!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
<classPathEntry location="D:\mysql-connector-java-5.1.16.jar"/>

<!-- jdbc连接-->
<jdbcConnection 
	driverClass="com.mysql.jdbc.Driver"
	connectionURL="jdbc:mysql://localhost:3306/test?serverTimezone=UTC" 
	userId="root"
	password="1234"/>
	
<!-- 生成实体类地址 -->
<javaModelGenerator targetPackage="com.example.entity" >

<!-- 生成map.xml文件存放地址 -->
<sqlMapGenerator targetPackage="mapper" >

<!-- 生成接口dao -->
<javaClientGenerator targetPackage="com.example.dao" >

 <!-- 要生成的table,可以用%表示所有表 -->
<table tableName="t_librarian" >

运行生成代码

以下2种方式都可以。

mvn命令行方式

打开一个terminal，执行如下命令：

mvn mybatis-generator:generate -e # 这就是生成的命令

Edit Configurations添加运行项

进入Edit Configurations | 点 + 号，找到maven并新建 ,填入内容：
Name 填写 mybatis-generator (名字随意)
Command line 填写 mybatis-generator:generate -e

保存，然后点击运行即可。

资源

git项目地址

我实测的项目，因为是在其他boot项目上直接加的genCode功能，其他代码不要理会即可，git地址如下：
https://github.com/1054294965/mybatisgen.git

其他

generatorConfig.xml报错URI is not registered

http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd 这句配置报红,提示信息为：
URI is not registered (Settings | Languages & Frameworks | Schemas and DTDs)

idea配置一下即可解决：
File | Settings | Languages & Frameworks | Schemas and DTDs | 点击右面的 + 号，url输入 http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd (报红的地址) 即可。