Mybatis根据数据库表自动生成实体类和xml映射文件及dao

秒速五厘米 2022-02-24 14:38 579阅读 0赞

通常在开发过程中，大家都会使用mybatis操作数据库。

一般步骤都是先创建好数据库表，然后创建mybatis一套。

实体类、相应的dao和mybatis mapper文件，都相当麻烦。

mybatis提供了对应的插件工具，方便自动生成，不用手动敲代码了。

下面以maven、idea开发环境下的操作步骤为示例：

# 1. 配置pom文件 #

spring及mybatis依赖包：

<dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.2.1</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>1.2.0</version>
    </dependency>

plugin插件配置，在pom文件的build->plugins节点下需要添加：

<plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.2</version>
        <configuration>               
            <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
            <verbose>true</verbose>
            <overwrite>true</overwrite>
        </configuration>
        <executions>
            <execution>
                <id>Generate MyBatis Artifacts</id>
                <goals>
                    <goal>generate</goal>
                </goals>
                <phase>none</phase>
            </execution>
        </executions>
        <dependencies>
            <dependency>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-core</artifactId>
                <version>1.3.2</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.41</version>
            </dependency>
        </dependencies>
     </plugin>

# 2. mybatis-generator配置文件 #

根据上面的配置文件路径，创建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="mysql"  targetRuntime="MyBatis3">
    		
    		<property name="javaFileEncoding" value="UTF-8"/>
    		
    		<property name="beginningDelimiter" value="`"/>
    		<property name="endingDelimiter" value="`"/>
    
    		<commentGenerator>
    			
    			<property name="suppressAllComments" value="true"/>
    			<property name="suppressDate" value="true"/>
    		</commentGenerator>
    
    		
    		<jdbcConnection connectionURL="jdbc:mysql://xx.xx.xx.xx:3306/xx_xx" driverClass="com.mysql.jdbc.Driver" password="xxx" userId="xx" />
    		
    		<javaModelGenerator targetPackage="xx.xx.xx.xx.domain" targetProject="../xx-xx-xx/src/main/java">
    			
    			<property name="constructorBased" value="false"/>
    			
    			<property name="enableSubPackages" value="false"/>
    			
    			<property name="immutable" value="false"/>
    			<property name="trimStrings" value="false"/>
    		</javaModelGenerator>
    
    		<sqlMapGenerator targetPackage="mapper/xx" targetProject="../xx-xx-xx/src/main/resources" >
    			<property name="enableSubPackages" value="false"/>
    		</sqlMapGenerator>
    
    		
    		<javaClientGenerator targetPackage="xx.xx.xx.xx.dao"
    							 targetProject="../xx-xx-xx/src/main/java" type="XMLMAPPER">
    		</javaClientGenerator>
    
    		<table tableName="xx1"  enableSelectByExample="false" enableDeleteByPrimaryKey="false" enableDeleteByExample="false" enableCountByExample="false" enableUpdateByExample="false"/>
    		<table tableName="xx2"  enableSelectByExample="false" enableDeleteByPrimaryKey="false" enableDeleteByExample="false" enableCountByExample="false" enableUpdateByExample="false"/>
    		<table tableName="xx3"  enableSelectByExample="false" enableDeleteByPrimaryKey="false" enableDeleteByExample="false" enableCountByExample="false" enableUpdateByExample="false"/>
    	</context>
    </generatorConfiguration>

# 3. 通过插件生成 #

在idea中找到maven的mybatis-generator插件，然后双击生成即可生成相应的实体类、dao及mapper文件。

#  #

#  mybatis-generator配置文件详细说明 #

<?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="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
    
        
        <property name="autoDelimitKeywords" value="false"/>
        
        <property name="javaFileEncoding" value="UTF-8"/>
        
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
    
        
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
    
        
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
            
        </jdbcConnection>
    
        
        <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
            
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
    
    
        
        <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
            
            <property name="constructorBased" value="false"/>
    
            
            <property name="enableSubPackages" value="true"/>
    
            
            <property name="immutable" value="false"/>
    
            
            <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
    
            
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
    
    
        
        <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources">
            
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
    
    
        
        <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java">
            
            <property name="enableSubPackages" value="true"/>
    
            
        </javaClientGenerator>
    
        
        <table tableName="userinfo" >
    
            
            <property name="constructorBased" value="false"/>
    
            
            <property name="ignoreQualifiersAtRuntime" value="false"/>
    
            
            <property name="immutable" value="false"/>
    
            
            <property name="modelOnly" value="false"/>
    
            
    
            
    
            
    
            
    
            
    
            
            <property name="selectAllOrderByClause" value="age desc,username asc"/>
    
            
            <property name="useActualColumnNames" value="false"/>
    
    
            
    
            
    
    
             
             <columnOverride column="username">
                
                <property name="property" value="userName"/>
    
                
    
                
    
                
    
                
             </columnOverride>
    
             
        </table>
    
    </context>
    
    </generatorConfiguration>