mybatis-spring-starter 配置

数据源配置

首先需要安装数据库驱动

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>${mysql.version}</version>
</dependency>

然后再 application.yml 文件中配置数据源. 如果没有安装数据库驱动,那么 Intellij 在 driver-class-name 这一行会有报错提示.

# data source
spring:
  datasource:
    url: jdbc:mysql://localhost/LearnBatis
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver

MyBatis 依赖

mybatis-spring-boot-starter 官方文档: mybatis-spring-boot-autoconfigure – 简介

能够帮我们快速的基于 SpringBoot 构建 MyBaits 应用. 让我们可以编写更少的 XML 配置.

<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>${mybatis.version}</version>
 </dependency>

MyBatisConfig 类

编写下面的代码时,如果数据源配置相关操作没有完成 Intellij 会提示找不到 DataSource 实例

@Configuration
//@MapperScan("xxxx.xxxx.dao")
class MyBatisConfig {

	@Bean
	fun sqlSessionFactory(dataSource: DataSource):SqlSessionFactory{
 		val factoryBean = SqlSessionFactoryBean()
        factoryBean.setDataSource(dataSource)
    	return factoryBean.`object`
            ?: throw IllegalStateException("SqlSessionFactory creation failed")
	}
}

使用 Kotlin 编写时,注意一些 getXX() 方法在 Kotlin 中是不能够直接使用的.

这里还要注意,如果你把一些 Java 代码直接复制到 Kotlin 项目中, 让 Intellij 帮助你自动将其转换为 Kotlin 代码. 可能会出现一些 @Throws 标签. 这些标签是为了在 Kotlin 和 Java 互相调用时发挥作用,纯 Kotlin 项目不需要 @Throws

根据官方文档 mybatis-spring ,可以知道,这里的配置代码主要作用是提供一个 SqlSessionFactory 实例. 后续在各个业务请求中, MyBaits 会通过 SqlSessionFactory 来创建 SqlSession 对数据库进行操作. 各自的作用可以参考 MyBatis 作用域和生命周期¹

在 Config 类中配置 Mybatis 时, SqlSessionFactoryBean 对象唯一必须需要设置的属性是: ==DataSource 数据源==

其他常用的配置属性有:

configLocation: 它用来指定 MyBatis 的 XML 配置文件路径

mapperLocations 指定 MyBatis 的映射器 XML 配置文件的位置。属性的值是一个 Ant 风格的字符串，可以指定加载一个目录中的所有文件，或者从一个目录开始递归搜索所有目录

mapperLocations

当然也可以通过代码来对 映射器 XML 配置文件进行配置. 注意这里是 **getResources ** 而不是 getResource (这地方卡了我两三个小时)

val mapperLocations = "classpath*:mapper/**/*Mapper.xml"  
factoryBean.setMapperLocations(
	*PathMatchingResourcePatternResolver().getResources(mapperLocations)
)

这里的 * 是 Kotlin 中的展开操作符(spread operator) ,用于将数组展开作为可变数量参数³.

因为 setMapperLocations 中可以接收多个资源

public void setMapperLocations(Resource... mapperLocations) 

‍

编写 DAO 和 XML 映射器

@Mapper
interface DiaryTagDAO {
    @Select("SELECT TagID,TagName FROM Tags")
    fun getTagList():List<DiaryTag>

    @Select("SELECT TagID,TagName FROM Tags WHERE TagID=#{id}")
    fun getTagById(id:Long):DiaryTag

    fun selectTagByName(name:String):DiaryTag
}

这里注意, 如果我们在 DAO 中标注了 @Mapper 标签,那么我就可以不需要在 Config 类添加 @MapperScan 标签

<?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.crowds.learnMybatis.dao.DiaryTagDAO">
    <resultMap id="diaryTag" type="com.crowds.learnMybatis.domain.DiaryTag">
        <id property="tagID" column="TagID"/>
        <result property="tagName" column="TagName"/>
    </resultMap>
    <select id="selectTagByName" parameterType="String" resultMap="diaryTag">
        SELECT Tags.TagID , Tags.TagName FROM Tags
        WHERE Tags.TagName = #{name}
    </select>
</mapper>

这里需要注意,传入参数使用 #{para} 时,一定不要写成 '#{para}' 把他当成字符串.

‍

测试类

编写一个简单的测试类,测试一下是否运行正常

@SpringBootTest
class DiaryTagServiceImplTest {

    @Autowired
    private lateinit var diaryTagService: DiaryTagServiceImpl

    @Test
    fun getTagList() {
        val result = diaryTagService.getTagList()
        assert(result.size == 1)
    }

    @Test
    fun getTagById() {
        val result = diaryTagService.getTagById(1L)
        assert( result.tagID == 1L)
    }

    @Test
    fun getTagByName() {
        var result = diaryTagService.getTagByName("MyBaits")
        println("TagName: ${result.tagName}")
        assert(result.tagName == "MyBaits")
    }
}