springboot基于java文件怎么配置SqlSessionFactoryBean

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，并為您的開發工作提供參考。