MyBatis学习笔记-2-代码生成器

代码生成器：

1.建立generator.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>

    <!-- 本地数据库驱动程序jar包的全路径 -->
    <classPathEntry location="C:\Users\caih\.m2\repository\mysql\mysql-connector-java\8.0.11\mysql-connector-java-8.0.11.jar"/>
    <context id="context" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="false"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <!-- 数据库的相关配置 -->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/mybatis"
                userId="root"
                password="jim777"/>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 实体类生成的位置 -->
        <javaModelGenerator
                targetPackage="com.homejim.mybatis.entity"
                targetProject=".\src\main\java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- *Mapper.xml 文件的位置  sqlMapGenerator-->
        <sqlMapGenerator
                targetPackage="mybatis/mapper"
                targetProject=".\src\main\resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- Mapper 接口文件的位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.homejim.mybatis.mapper"
                             targetProject=".\src\main\java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 相关表的配置 -->

        <table tableName="blog" />
        <!-- 列出要生成代码的所有表，这里配置的是不生成Example文件 -->
            <!-- schema即为数据库名 tableName为对应的数据库表 domainObjectName是要生成的实体类 enable*ByExample   
                       是否生成 example类   -->  
            <table tableName="${gererator.tableName}" domainObjectName="${gererator.objectName}"
                schema="${gererator.schema}"
                enableCountByExample="false" enableUpdateByExample="false"
                enableDeleteByExample="false" enableSelectByExample="false"
                selectByExampleQueryId="false">
                <!-- 忽略列，不生成bean 字段 
                <ignoreColumn column="FRED" />-->   
                <!-- 指定列的java数据类型  
                <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />  -->
                <!-- 用于指定生成实体类时是否使用实际的列名作为实体类的属性名。false是 Camel Case风格-->
                <property name="useActualColumnNames" value="false" />
            </table>

    </context>
</generatorConfiguration>

需要改一些内容：

本地数据库驱动程序jar包的全路径（必须要改）。
数据库的相关配置（必须要改）
相关表的配置（必须要改）
实体类生成存放的位置。
MapperXML 生成文件存放的位置。
Mapper 接口存放的位置。

2.编写pom.xml

<build>
        <finalName>mybatis-generator</finalName>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                   <!--此处需要注意， 文件与上面的文件匹配-->
                   <configurationFile>src/main/resources/generator.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.7</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

XML 配置详解

中文翻译版官方文档：翻译版网站

有关此文件的重要说明如下：

该文件指定将使用旧的DB2 CLI驱动程序连接到数据库，还指定可以在何处找到驱动程序。
Java类型解析器不应强制使用BigDecimal字段 - 这意味着如果可能，将替换整数类型（Short，Integer，Long等）。此功能旨在使数据库DECIMAL和NUMERIC列更易于处理。
Java模型生成器应该使用子包。这意味着在这种情况下，生成的模型对象将放在名为test.model.db2admin的包中（因为该表位于DB2ADMIN模式中）。如果enableSubPackages属性设置为 false，则包将为test.model。Java模型生成器还应修剪字符串。这意味着任何String属性的setter都将调用trim 函数 - 如果数据库可能在字符列的末尾返回空白字符，这将非常有用。
SQL Map生成器应该使用子包。这意味着在这种情况下，生成的XML文件将放在名为test.xml.db2admin的包中（因为该表位于DB2ADMIN模式中）。如果enableSubPackages属性设置为false，则包将是test.xml。
DAO生成器应该使用子包。这意味着在这种情况下，生成的DAO类将放在名为test.dao.db2admin的包中（因为该表位于DB2ADMIN模式中）。如果enableSubPackages属性设置为false，那么包将是test.dao。DAO生成器应生成映射器接口，该接口引用MyBatis的XML配置。
该文件仅指定一个表将被内省，但可以指定更多表。有关指定表的重要说明包括：
- 生成的对象将基于名称Customer（CustomerKey， Customer， CustomerMapper等） - 而不是基于表名。
- 实际列名称将用作属性。如果此属性设置为 false（或未指定），则MBG将尝试使用列名称来查看。在任何一种情况下，<columnOverride> 元素都可以覆盖名称
- 该列具有生成的密钥，它是标识列，数据库类型是DB2。这将导致MBG 在生成的<insert> 语句中生成正确的 <selectKey>元素，以便可以返回新生成的密钥（使用DB2特定的SQL）。
- DATE_FIELD列将映射到名为startDate的属性。这将覆盖默认属性，在这种情况下为DATE_FIELD，如果useActualColumnNames属性设置为 false，则覆盖 dateField。
- FRED列将被忽略。没有SQL会列出该字段，也不会生成任何Java属性。
- 无论实际数据类型如何，LONG_VARCHAR_FIELD列都将被视为 VARCHAR字段。

2.2 官网没有的

2.2.1 property 标签

该标签在官网中只是说用来指定元素的属性，至于怎么用没有详细的讲解。

2.2.1.1 分隔符相关

<property name="autoDelimitKeywords" value="true"/>
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

以上的配置对应的是 mysql， 当数据库中的字段和数据库的关键字一样时，就会使用分隔符。

比如我们的数据列是 delete, 按以上的配置后，在它出现的地方，就变成 `delete`。

2.2.1.2 编码

默认是使用当前的系统环境的编码，可以配置为 GBK 或 UTF-8。

<property name="javaFileEncoding" value="UTF-8"/>

我想项目为 UTF-8，如果指定生成 GBK，则自动生成的中文就是乱码。

2.2.1.3 格式化

<!--格式化生成的 Java 代码-->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!--格式化生成的 XML-->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

这些显然都是可以自定义实现的的。

2.2.2 plugins 标签

plugins 标签用来扩展或修改代码生成器生成的代码。

在生成的 XML 中，是没有 <cache> 这个标签的。该标签是配置缓存的。

如果我们想生成这个标签，那么可以 plugins 中进行配置。

<plugin type="org.mybatis.generator.plugins.CachePlugin" >
            <property name="cache_eviction" value="LRU"/>
</plugin>

cache

比如你想生成的 JavaBean 中自行实现 Serializable 接口。

<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

序列化接口实现

还能自定义插件。

2.2.3 commentGenerator 标签

看名称，就知道是用来生成注释用的。

默认配置：

    <commentGenerator >
        <property name="suppressAllComments" value="false"/>
        <property name="suppressDate" value="false"/>
        <property name="addRemarkComments" value="false"/>
    </commentGenerator>

suppressAllComments：阻止生成注释，默认值是false。

suppressDate: 阻止生成的注释包含时间戳，默认为false。

addRemarkComments: 注释中添加数据库的注释，默认为 false。

还有一个就是我们可以通过 type 属性指定我们自定义的注解实现类，生成我们自己想要的注解。自定义的实现类需要实现 org.mybatis.generator.api.CommentGenerator。

MyBatis学习笔记-2-代码生成器

猜你喜欢