mybatis 插件生成 java 代码和 xml

水深无声 2022-04-16 02:28 253阅读 0赞

使用 mybatis 插件生成 javaBean 和 mapper.xml 文件，在开发中非常方便，可以节省很多人力

### 1、eclipse 下载 mybatis-generator 插件 ###

在 eclipse 的 Eclipse Marketplace 搜索 mybatis，并安装

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70][]

上图已经安装完 mybatis-generator 插件

### 2、创建 generatorConfig 的工程目录 ###

在 demo 项目的 resources 目录下创建如下图目录结构

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 1][]

### 3、创建 generatorConfig.xml 文件 ###

数据库中需要生成代码的表格如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 3][]

表格名 a\_user

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>
        <context id="MysqlTables" targetRuntime="MyBatis3">
     
            <commentGenerator>
                <property name="suppressDate" value="true"/>
                
                <property name="suppressAllComments" value="true"/>
            </commentGenerator>
     
            
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="jdbc:mysql://localhost:3306/orcl?useUnicode=true&characterEncoding=utf8"
                            userId="root" password="123456">
            </jdbcConnection>
     
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
     
            
            <javaModelGenerator targetPackage="com.che.open.entity"
                                targetProject="demo/src/main/java">
                <property name="enableSubPackages" value="true"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
     
            
             
             
            <sqlMapGenerator targetPackage="com.che.open.mapper"
                             targetProject="demo/src/main/java">
                <property name="enableSubPackages" value="true"/>
            </sqlMapGenerator>
     
            
            <javaClientGenerator type="XMLMAPPER"
                                 targetPackage="com.che.open.mapper"
                                 targetProject="demo/src/main/java">
                <property name="enableSubPackages" value="true"/>
            </javaClientGenerator>
     
            
            <table tableName="a_user" domainObjectName="AUserPO"
                   enableSelectByPrimaryKey="true"
                   enableCountByExample="false" enableUpdateByExample="false"
                   enableDeleteByExample="false" enableSelectByExample="false"
                   selectByExampleQueryId="false">
                
                <property name="useActualColumnNames" value="false"/>
                
                <generatedKey column="id" sqlStatement="MySql" identity="true"/>
            </table>
     
        </context>
    </generatorConfiguration>

generatorConfig.xml 相关配置的说明已写在代码中

在 pom.xml 文件中添加 mysql 驱动依赖

<dependency>
    	<groupId>mysql</groupId>
    	<artifactId>mysql-connector-java</artifactId>
    	<version>5.1.46</version>
    </dependency>

### 4、运行 generatorConfig.xml 文件生成 javaBean 和 mapper.xml 文件 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 4][]

### 5、效果如下 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 5][]

### 6、扩展 ###

上述配置完成了代码生成，但每次生成代码都需要修改xml文件，相对麻烦，而且看起来有些乱，好的办法是将配置项提取出来单独进行配置，修改后如下

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="config/mybatis/generatorConfig.properties" />
        <context id="MysqlTables" targetRuntime="MyBatis3">
     
            <commentGenerator>
                <property name="suppressDate" value="true"/>
                
                <property name="suppressAllComments" value="true"/>
            </commentGenerator>
     
            
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="${jdbc.url}"
                            userId="${jdbc.user}" password="${jdbc.password}">
            </jdbcConnection>
     
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
     
            
            <javaModelGenerator targetPackage="${bean}"
                                targetProject="${target_project}">
                <property name="enableSubPackages" value="true"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
     
             
             
            <sqlMapGenerator targetPackage="${mapper_xml}"
                             targetProject="${target_project_xml}">
                <property name="enableSubPackages" value="true"/>
            </sqlMapGenerator>
     
            
            <javaClientGenerator type="XMLMAPPER"
                                 targetPackage="${mapper}"
                                 targetProject="${target_project}">
                <property name="enableSubPackages" value="true"/>
            </javaClientGenerator>
     
            
            <table tableName="${table_name}" domainObjectName="${bean_name}"
                   enableSelectByPrimaryKey="true"
                   enableCountByExample="false" enableUpdateByExample="false"
                   enableDeleteByExample="false" enableSelectByExample="false"
                   selectByExampleQueryId="false">
                
                <property name="useActualColumnNames" value="false"/>
                
                <generatedKey column="id" sqlStatement="MySql" identity="true"/>
            </table>
     
        </context>
    </generatorConfiguration>

新增 generatorConfig.properties 文件，其内容如下

jdbc.url=jdbc:mysql://192.168.0.110:3306/manager?useUnicode=true&characterEncoding=utf-8&useSSL=false
    jdbc.user=root
    jdbc.password=123456
    
    target_project=gmybatis/src/main/java
    target_project_xml=gmybatis/src/main/resources
    mapper_xml=mapper
    
    
    bean=com.fin.sys.bean
    mapper=com.fin.sys.mapper
    table_name=m_userinfo
    bean_name=Userinfo

项目结构如下

![20190820145928952.PNG][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70]: /images/20220416/8f0b8c7de61f439c94c91455c12ca036.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 1]: /images/20220416/934626f5f9154933bc0d2a469eab530c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 2]: /images/20220416/04ce1e82478b4236b9fcf33677929b94.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 3]: /images/20220416/3881e7cb73b343d6a7bc1d7e584e361d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 4]: /images/20220416/c9b8dd32514a453998b6d2dcd1805901.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dzanp6Y2Jx_size_16_color_FFFFFF_t_70 5]: /images/20220416/15bf442c76ae49daa9d6cf20a5e44aad.png
[20190820145928952.PNG]: /images/20220416/b17485f08bc74ba788eedde0f6a930b8.png