SpringBoot集成Mybatis

---

一、Maven引入

<!-- mysql -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.32</version>
    </dependency>
    <!-- mybatis -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.3.0</version>
    </dependency>
    <!-- 数据池 -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.2.1</version>
    </dependency>

二、Yml配置

spring:
  application:
    name: oauth
  # 设置数据库连接
  datasource:
    url: jdbc:mysql://localhost:3306/customer?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT #数据库地址
    username: root #数据库用户名
    password: 123123  #数据库密码
    driver-class-name: com.mysql.cj.jdbc.Driver #数据库驱动
    type: com.alibaba.druid.pool.DruidDataSource #数据库连接池
#设置日志信息
logging:
  level:
    org.springframework: DEBUG
    org.example.mapper: DEBUG #日志打印为xml命名空间
mybatis:
  mapper-locations: classpath:/mybatis/*.xml  #xml文件配置地址

org.example.mapper：为XML命名空间。如：namespace=“org.example.mapper.AuthUser” ，日志打印为"org.example.mapper或org.example 都可以。

classpath：表示当前文件在Resources目录下

三、Java代码

基于注解

启动类

需要再启动类中加入@MapperScan("org.example.mapper") ，用来扫描包下所有接口。
实现Bean的注入

package org.example;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
#Mapper扫描 包的位置
@MapperScan("org.example.mapper") 
public class OauthApplication {
    public static void main(String... args){
        new SpringApplication(OauthApplication.class).run(args);
    }
}

Mapper

注意这时候XML文件名就必须与mapper包保持一致
Mapper包位置如下图：

XML

XML文件位置如下图：

示例AuthUserMapper.xml
在XML文件中的 namespace="org.example.dao.AuthUserMapper" 必须是Mapper包中接口的限定名

<?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="org.example.dao.AuthUserMapper">
    <resultMap id="dbMap" type="org.example.entity.AuthUserEntity">
        <id column="id" property="id" javaType="String" jdbcType="VARCHAR"></id>
        <result column="access_key" property="accessKey" javaType="String" jdbcType="VARCHAR"></result>
        <result column="secret_key" property="secretKey" javaType="String" jdbcType="VARCHAR"></result>
    </resultMap>

    <select id="selectAll"  parameterType="org.example.entity.AuthUserEntity" resultMap="dbMap">
        select *
        from auth_user
        where 1 = 1
        <if test="accessKey != null and accessKey != ''">
            and access_key = #{accessKey}
        </if>
    </select>

</mapper>

基于SqlSessionTemplate实现

SqlSessionTemplate实现可以，XML文件名和类名不一致。也不用在启动类中加入注解。
可以基于SqlSessionTemplate实现分页功能。

Java代码实现

代码示例图如下：

代码示例
注意 private static final String DAO = "org.example.mapper.AuthUser." 中的org.example.mapper.AuthUser为XML文件中的namespace(命名空间);

package org.example.dao.impl;

import org.apache.ibatis.session.RowBounds;
import org.example.dao.IAuthUserDao;
import org.example.entity.AuthUserEntity;
import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class AuthUserDaoImpl  implements IAuthUserDao {
	#XML文件的命名空间
    private static final String DAO = "org.example.mapper.AuthUser.";
    @Autowired
    private SqlSessionTemplate template;

    @Override
    public List<AuthUserEntity> selectAll(AuthUserEntity entity){
        return template.selectList(DAO+"selectList",entity,new RowBounds(1,1));
    }
}

XML

<?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="org.example.mapper.AuthUser">
    <resultMap id="dbMap" type="org.example.entity.AuthUserEntity">
        <id column="id" property="id" javaType="String" jdbcType="VARCHAR"></id>
        <result column="access_key" property="accessKey" javaType="String" jdbcType="VARCHAR"></result>
        <result column="secret_key" property="secretKey" javaType="String" jdbcType="VARCHAR"></result>
    </resultMap>

    <select id="selectList"  parameterType="org.example.entity.AuthUserEntity" resultMap="dbMap">
        select id
        from auth_user
        where 1 = 1
        <if test="accessKey != null and accessKey != ''">
            and access_key = #{accessKey}
        </if>
    </select>

</mapper>

总结

MapperScan注解和SqlSessionTemplate是可以共同使用的

MapperScan注解

1. 采用注解扫描时需要注意XML文件名称要和Mapper中的文件名称保持一致。
2. XML文件中的命名空间是Mapper类中文件的限定名

SqlSessionTemplate

1. XML文件中的命名空间必须和类中使用的一致