【Springboot】整合mybatis

准备数据库表

CREATE TABLE `t_user` (
  `id` int NOT NULL AUTO_INCREMENT COMMENT '主键',
  `name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL COMMENT '姓名',
  `age` int DEFAULT NULL COMMENT '年龄',
  `gender` varchar(255) DEFAULT NULL COMMENT '性别',
  `createTime` datetime DEFAULT NULL COMMENT '创建时间',
  `updateTime` datetime DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=12 DEFAULT CHARSET=utf8mb3;

新建Springboot项目

• pom文件导入依赖

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>SpringBoot</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>springboot-mybatis</artifactId>
    <dependencies>
        <!--web依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--mysql依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--mybatis整合springboot框架依赖-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.0</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--测试依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <!--打包xml文件-->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
        <!--打包插件-->
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

• 配置文件配置数据库连接

server:
  port: 8080
spring:
  datasource:
    #数据库连接驱动
    driver-class-name: com.mysql.cj.jdbc.Driver
    #数据库地址
    url: jdbc:mysql://localhost:3306/springboot?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    #数据库账号
    username: root
    #数据库密码
    password: root
mybatis:
  #实体类别名,mybatis的配置文件中的resultType写类名即可，不用再写类的全限定类名
  #type-aliases-package: com.example.mybatis.entity
  configuration:
    #打开mybatis的SQL在控制台输出
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    #开启驼峰映射
    map-underscore-to-camel-case: true

• 创建数据表对应的实体类

@Data
public class UserEntity {
    private Integer id;
    private String name;
    private Integer age;
    private String gender;
    private Date createTime;
    private Date updateTime;
}

• 创建mapper接口和映射文件

public interface UserMapper {
    //查询用户列表
    List<UserEntity> queryUserList();
}

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.mybatis.mapper.UserMapper">
    <select id="queryUserList" resultType="com.example.mybatis.entity.UserEntity">
        select * from t_user
    </select>
</mapper>

• 控制层代码

@RestController
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @GetMapping(value = "queryUserList")
    public List<UserEntity> queryUserList(){
        return userMapper.queryUserList();
    }
}

• 项目启动类上添加扫描mapper文件注解

@SpringBootApplication
@MapperScan(basePackages = "com.example.mybatis.mapper")
public class MybatisApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisApplication.class, args);
    }
}

• 启动项目，访问控制层路径 localhost:8080/queryUserList
  

上面mapper接口和映射文件是在src/main/java相同目录下面，在pom.xml文件中配置了下面配置，启动项目打包的时候就会将xml文件打包进去。

 <!--打包xml文件-->
 <resources>
     <resource>
         <directory>src/main/java</directory>
         <includes>
             <include>**/*.xml</include>
         </includes>
         <filtering>false</filtering>
     </resource>
 </resources>

除了这种写法之外，还有另外一个常见的写法，将映射文件放到类路径下的resource目录下面，如果是这种写法就要在yaml核心配置文件中配置如下配置，告诉mapper映射文件的位置。

mybatis:
  mapper-locations: classpath:mapper/*.xml #配置MyBatis的xml配置文件路径