MyBatis之通用Mapper

电玩女神 2023-10-11 17:40 1阅读 0赞

MyBatis通用Mapper是一款MyBatis增强插件，可以根据数据库表快速生成实体Entity、数据访问对象模型DAO，数据库映射文件Mapper。

一、整合通用Mapper  
1、在项目pom.xml中添加依赖（文章最后面提供完整pom.xml）

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.8</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper-spring-boot-starter</artifactId>
        <version>2.1.5</version>
    </dependency>
     由于通用mapper集成了MyBatis，所以这里我们需要将下方MyBatista的依赖删除掉
    
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.1</version>
    </dependency>

2、使新导入的依赖生效  
导入依赖之后，打开IDEA终端窗口使用maven命令：mvn clean install保证依赖成功加入（使依赖生效）

3、在pom.xml中添加插件  
继续添加依赖，整合通用代码生成器（文章最后面提供完整pom.xml）

<plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.6</version>
        <configuration>
            <configurationFile>
                ${basedir}/src/main/resources/generator/generatorConfig.xml
            </configurationFile>
            <overwrite>true</overwrite>
            <verbose>true</verbose>
        </configuration>
        <dependencies>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.16</version>
            </dependency>
            <dependency>
                <groupId>tk.mybatis</groupId>
                <artifactId>mapper</artifactId>
                <version>4.1.5</version>
            </dependency>
        </dependencies>
    </plugin>

4、在application.yml中添加数据库配置属性

server:
      port: 8082
    spring:
      datasource:
        url: jdbc:mysql://localhost:3306/user_center?serverTimezone=UTC
        username: root
        password: Aa123123.
        #    driver-class-name: com.mysql.cj.jdbc.Driver
        driver-class-name: com.mysql.jdbc.Driver

二、 配置通用mapper  
在resource中创建文件夹generator及配置文件config.properties和generatorConfig.xml（文章最后面提供完整文件）

1、配置config.properties

#jdbc.driverClass=com.mysql.cj.jdbc.Driver
    jdbc.driverClass=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/user_center?serverTimezone=UTC
    jdbc.user=root
    jdbc.password=Aa123123.
     
    # 模块名
    moduleName=user
    # 表名
    tableName=user

2、配置generatorConfig.xml

<!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="generator/config.properties"/>
     
        <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
            <property name="beginningDelimiter" value="`"/>
            <property name="endingDelimiter" value="`"/>
     
            <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
                <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
                <property name="caseSensitive" value="true"/>
                <property name="lombok" value="Getter,Setter,ToString"/>
            </plugin>
     
            <jdbcConnection driverClass="${jdbc.driverClass}"
                            connectionURL="${jdbc.url}"
                            userId="${jdbc.user}"
                            password="${jdbc.password}">
            </jdbcConnection>
     
            
            <javaModelGenerator targetPackage="personal.qin.usercenter.domain.entity.${moduleName}"
                                targetProject="src/main/java"/>
     
            
            <sqlMapGenerator targetPackage="personal.qin.usercenter.dao.${moduleName}"
                             targetProject="src/main/resources"/>
     
            
            <javaClientGenerator targetPackage="personal.qin.usercenter.dao.${moduleName}"
                                 targetProject="src/main/java"
                                 type="XMLMAPPER"/>
     
            
            <table tableName="${tableName}">
                <generatedKey column="id" sqlStatement="JDBC"/>
            </table>
        </context>
    </generatorConfiguration>

3、通过mybatis-generator生成代码  
代码生成器的使用方式：可以自动生成实体、dao和mapper.xml

在项目目录中可以看到已经生成的DAO、Mapper、Entity

三、测试  
1、新建TestController测试

package personal.qin.usercenter;
     
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    import personal.qin.usercenter.dao.user.UserMapper;
    import personal.qin.usercenter.domain.entity.user.User;
     
    import java.util.List;
     
    @RestController
    public class TestController {
        @Autowired(required = false)
        private UserMapper userMapper;
        @GetMapping("/test")
        public List<User> getAllUser(){
            List<User> users = userMapper.selectAll();
            return users;
        }
    }

2、在BootApplication中添加@MapperScan注解扫描dao  
注意：导入的MapperScan是tk包下的

package personal.qin.usercenter;
     
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import tk.mybatis.spring.annotation.MapperScan;
     
    @MapperScan("personal.qin.usercenter.dao")
    @SpringBootApplication
    public class UserCenterApplication {
     
        public static void main(String[] args) {
            SpringApplication.run(UserCenterApplication.class, args);
        }
     
    }

3、测试  
http://localhost:8082/test

四、完整pom.xml及源代码

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.5.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>personal.qin</groupId>
        <artifactId>user-center</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>user-center</name>
        <description>user-center</description>
        <properties>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>tk.mybatis</groupId>
                <artifactId>mapper-spring-boot-starter</artifactId>
                <version>2.1.5</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.8</version>
                <scope>provided</scope>
            </dependency>
     
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-api</artifactId>
                <version>5.5.0</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
        <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.6</version>
                    <configuration>
                        <configurationFile>
                            ${basedir}/src/main/resources/generator/generatorConfig.xml
                        </configurationFile>
                        <overwrite>true</overwrite>
                        <verbose>true</verbose>
                    </configuration>
                    <dependencies>
                        <dependency>
                            <groupId>mysql</groupId>
                            <artifactId>mysql-connector-java</artifactId>
                            <version>8.0.16</version>
                        </dependency>
                        <dependency>
                            <groupId>tk.mybatis</groupId>
                            <artifactId>mapper</artifactId>
                            <version>4.1.5</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>
    </project>

到此，我们的mapper就配置好啦，也可以成功的运行，接下来就可以进入IDEA的世界了。