使用tk-mybatis generator 自动生成代码（集成统一mapper）

我不是女神ヾ 2022-02-01 11:51 239阅读 0赞

tk-mybatis 是mybatis的一个功能扩展，可以在原有方法的基础之上提供更多的功能可用，如一个基类Mapper, 继承他就相当于拥有了常用的增删改查等功能，无需再每个mapper文件中都写增删改查，非常方便。那么接下来我们来开始。

1. 引入依赖包，我们使用的是springboot 2.1.4 这个版本，再pom中先引入依赖

<dependency>
                <groupId>tk.mybatis</groupId>
                <artifactId>mapper-spring-boot-starter</artifactId>
                <version>2.1.0</version>
            </dependency>

2. 引入自动生成插件

<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>
                    <version>1.3.5</version>
                    <configuration>
                        <configurationFile>src/main/resources/generator.xml</configurationFile>
                        
                        <verbose>true</verbose>
                        <overwrite>true</overwrite>
                    </configuration>
                    <dependencies>
                        
                        <dependency>
                            <groupId>mysql</groupId>
                            <artifactId>mysql-connector-java</artifactId>
                            <version>5.1.46</version>
                        </dependency>
                        <dependency>
    		                <groupId>tk.mybatis</groupId>
    		                <artifactId>mapper-spring-boot-starter</artifactId>
    		                <version>2.1.0</version>
                		</dependency>
    
                        <dependency>
                            <groupId>tk.mybatis</groupId>
                            <artifactId>mapper</artifactId>
                            <version>3.4.5</version>
                        </dependency>
                    </dependencies>
                </plugin>
    		</plugins>
    	</build>

3. 再src/main/resources/ 下创建   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>
        
    
        <properties resource="application.properties" />
    
        
        <context id="MysqlContext" targetRuntime="MyBatis3Simple" >
    
            <property name="beginningDelimiter" value="`"/>
            <property name="endingDelimiter" value="`"/>
    
            
            <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
                <property name="mappers" value="${generator.mappers}"/>
            </plugin>
    
            
            <commentGenerator>
                <property name="suppressDate" value="true"/>
                
                <property name="suppressAllComments" value="true"/>
            </commentGenerator>
    
    
            
            <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                            connectionURL="${spring.datasource.url}"
                            userId="${spring.datasource.username}"
                            password="${spring.datasource.password}">
            </jdbcConnection>
    
            <javaTypeResolver>
                
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
    
            
            
            <javaModelGenerator targetPackage="${generator.javaModel-targetPackage}" targetProject="${generator.targetProject}">
                <property name="enableSubPackages" value="true"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="${generator.sqlMap-targetPackage}" targetProject="src/main/resources"/>
    
            
            <javaClientGenerator targetPackage="${generator.javaClient-targetPackage}" targetProject="${generator.targetProject}"
                                 type="XMLMAPPER"/>
    
    		
            <table tableName="cl_sku"></table>
    
        </context>
    </generatorConfiguration>

4. 在application.properties文件中引入数据库的配置和generator的配置

#datasource
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test?useSSL=false&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&serverTimezone=GMT%2B8
    spring.datasource.username=root
    spring.datasource.password=root
    
    # Generator
    generator.targetProject=src/main/java
    #mapper的父类
    generator.mappers=tk.mybatis.mapper.common.Mapper
    #pojo所在报名
    generator.javaModel-targetPackage=com.xxx.demo.pojo
    #mapper.xml位于resource文件夹下的哪个目录中
    generator.sqlMap-targetPackage=mapper
    #mapper包名
    generator.javaClient-targetPackage=com.xxx.demo.mapper

5. 运行插件： run-->configuration:    mybatis-generator:generate

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xzcWluZ2Zlbmc_size_16_color_FFFFFF_t_70][]

6. 刷新项目，出现对应文件。.

上述功能是使用sts（eclipse） 开发的，从功能的角度来讲，如果需要自动生成代码，还是推荐使用mybatis-plus  ，他不仅可以生成mapper,还能够生成service， 并且包含分页及封装非常好的查询功能。 所以如果有权利选择框架，还是推荐使用mybatis-plus.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xzcWluZ2Zlbmc_size_16_color_FFFFFF_t_70]: /images/20220201/fb893a9015664958815ac034ddfe6378.png