Spring Boot基于Java文件怎么配置SqlSessionFactoryBean

在Spring Boot项目中，SqlSessionFactoryBean是MyBatis框架中非常重要的一个类，它负责创建SqlSessionFactory实例，而SqlSessionFactory则是MyBatis的核心工厂类，用于创建SqlSession对象。SqlSession是MyBatis中用于执行SQL语句、获取映射器（Mapper）的主要接口。

本文将详细介绍如何在Spring Boot项目中基于Java文件配置SqlSessionFactoryBean，并逐步讲解如何通过Java配置类来替代传统的XML配置文件。

1. 引入依赖

首先，我们需要在pom.xml文件中引入Spring Boot和MyBatis的相关依赖。以下是一个基本的依赖配置：

<dependencies>
    <!-- Spring Boot Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>

    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- MyBatis Spring Boot Starter -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>

    <!-- MySQL Connector -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>

    <!-- Spring Boot Starter Test -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2. 配置数据源

在Spring Boot中，数据源的配置通常是通过application.properties或application.yml文件来完成的。以下是一个简单的数据源配置示例：

# application.properties
spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

3. 创建Java配置类

接下来，我们将创建一个Java配置类来配置SqlSessionFactoryBean。这个类需要被@Configuration注解标记，并且需要注入DataSource对象。

import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;

import javax.sql.DataSource;

@Configuration
@MapperScan("com.example.mapper") // 指定Mapper接口所在的包
public class MyBatisConfig {

    @Bean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);

        // 设置MyBatis配置文件路径
        sessionFactory.setConfigLocation(new PathMatchingResourcePatternResolver().getResource("classpath:mybatis-config.xml"));

        // 设置Mapper XML文件路径
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*.xml"));

        return sessionFactory.getObject();
    }
}

3.1 配置MyBatis配置文件

在上面的代码中，我们通过sessionFactory.setConfigLocation()方法指定了MyBatis的配置文件路径。通常情况下，MyBatis的配置文件名为mybatis-config.xml，内容如下：

<!-- mybatis-config.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
    <typeAliases>
        <package name="com.example.model"/>
    </typeAliases>
</configuration>

3.2 配置Mapper XML文件

sessionFactory.setMapperLocations()方法用于指定Mapper XML文件的位置。通常情况下，Mapper XML文件存放在src/main/resources/mapper目录下。例如，UserMapper.xml文件内容如下：

<!-- UserMapper.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="com.example.mapper.UserMapper">
    <select id="selectUserById" resultType="com.example.model.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

4. 创建Mapper接口

在MyBatis中，Mapper接口用于定义SQL操作。我们需要在com.example.mapper包下创建Mapper接口，并使用@Mapper注解标记。

package com.example.mapper;

import com.example.model.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper {
    User selectUserById(int id);
}

5. 创建实体类

实体类用于映射数据库中的表结构。我们需要在com.example.model包下创建实体类User。

package com.example.model;

public class User {
    private int id;
    private String name;
    private String email;

    // Getters and Setters
}

6. 测试配置

最后，我们可以编写一个简单的测试类来验证配置是否正确。

import com.example.mapper.UserMapper;
import com.example.model.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class MyBatisTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectUserById() {
        User user = userMapper.selectUserById(1);
        System.out.println(user);
    }
}

7. 总结

通过以上步骤，我们成功地在Spring Boot项目中基于Java文件配置了SqlSessionFactoryBean。与传统的XML配置相比，Java配置更加灵活，且易于维护。通过@Configuration注解和@Bean注解，我们可以轻松地将MyBatis集成到Spring Boot项目中，并通过@MapperScan注解自动扫描Mapper接口。

在实际开发中，我们可以根据项目需求进一步优化配置，例如使用@PropertySource注解加载外部配置文件，或者通过@Profile注解实现不同环境的配置切换。

希望本文能够帮助您更好地理解如何在Spring Boot项目中配置SqlSessionFactoryBean，并为您的开发工作提供参考。