通过Spring整合MyBatis实现持久层操作

IT_陈寒

发布于 2023-12-14 11:09:54

1720

发布于 2023-12-14 11:09:54

文章被收录于专栏：开发经验

🎉通过Spring整合MyBatis实现持久层操作

☆* o(≧▽≦)o *☆嗨~我是IT·陈寒🍹
✨博客主页：IT·陈寒的博客
🎈该系列文章专栏：架构设计
📜其他专栏：Java学习路线 Java面试技巧 Java实战项目 AIGC人工智能数据结构学习
🍹文章作者技术和水平有限，如果文中出现错误，希望大家能指正🙏
📜 欢迎大家关注！ ❤️

Spring和MyBatis是Java开发中两个非常重要的框架，它们分别负责实现轻量级的控制反转（IoC）和面向切面（AOP）的Spring，以及数据持久化的MyBatis。通过整合Spring和MyBatis，我们可以充分发挥它们的优势，实现更加灵活和高效的应用程序。本文将介绍如何通过Spring整合MyBatis，以及在整合过程中常见的配置和使用方法。

为什么要整合Spring和MyBatis？

在传统的Java EE开发中，数据访问层和业务逻辑层往往需要通过独立的框架进行处理。Spring框架提供了IoC容器和AOP机制，使得应用程序更加模块化和可维护。而MyBatis是一个优秀的持久化框架，通过SQL映射文件将Java对象映射到数据库表，提供了便捷的数据库访问方式。整合Spring和MyBatis可以充分利用两者的优势，提高开发效率，降低维护成本。

步骤一：添加依赖

首先，我们需要在项目中添加Spring和MyBatis的相关依赖。如果使用Maven进行项目管理，可以在pom.xml文件中添加如下依赖：

<!-- Spring -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>5.3.10.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>5.3.10.RELEASE</version>
</dependency>

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

这里使用了Spring 5.3.10版本和MyBatis Spring Boot Starter 2.2.0版本，你可以根据需要选择合适的版本。

步骤二：配置数据源

在Spring整合MyBatis时，我们需要配置数据源。可以使用Spring提供的DataSource接口，也可以使用第三方库（如Druid）提供的数据源。以下是一个使用Spring Boot配置数据源的例子：

@Configuration
public class DataSourceConfig {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource")
    public DataSource dataSource() {
        return DataSourceBuilder.create().build();
    }
}

这里使用了@ConfigurationProperties注解，将spring.datasource前缀的配置属性注入到DataSource中，实现了数据源的配置。

步骤三：配置MyBatis

在整合过程中，我们还需要配置MyBatis的SqlSessionFactory和SqlSessionTemplate。SqlSessionFactory是MyBatis的核心接口，负责创建SqlSession对象；SqlSessionTemplate是MyBatis-Spring的核心类，提供了SqlSession的模板化方法。

@Configuration
@MapperScan(basePackages = "com.example.mapper", sqlSessionFactoryRef = "sqlSessionFactory")
public class MyBatisConfig {

    @Autowired
    private DataSource dataSource;

    @Bean
    public SqlSessionFactory sqlSessionFactory() throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        return factoryBean.getObject();
    }

    @Bean
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

在这里，使用@MapperScan注解指定了MyBatis的Mapper接口扫描路径，并注入了DataSource，配置了SqlSessionFactory和SqlSessionTemplate。

步骤四：创建Mapper接口和XML文件

在整合Spring和MyBatis后，我们可以创建Mapper接口和对应的XML文件，定义SQL语句和数据库操作。以下是一个简单的例子：

// Mapper接口
public interface UserMapper {

    User getUserById(int userId);
}

<!-- UserMapper.xml -->
<mapper namespace="com.example.mapper.UserMapper">

    <resultMap id="BaseResultMap" type="com.example.entity.User">
        <id column="id" property="id" jdbcType="INTEGER"/>
        <result column="username" property="username" jdbcType="VARCHAR"/>
        <result column="password" property="password" jdbcType="VARCHAR"/>
    </resultMap>

    <select id="getUserById" resultMap="BaseResultMap">
        SELECT * FROM user WHERE id = #{userId}
    </select>
</mapper>

步骤五：使用Mapper接口

最后，在Service或Controller中注入Mapper接口，并调用其中的方法：

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public User getUserById(int userId) {
        return userMapper.getUserById(userId);
    }
}

通过以上步骤，我们完成了Spring和MyBatis的整合。在实际开发中，可以根据项目的需求进行更灵活的配置和扩展。

拓展：事务管理

在实际项目中，为了保证数据的一致性和完整性，通常会涉及到事务管理。Spring提供了声明式事务管理的方式，通过@Transactional注解可以实现方法级别的事务控制。在整合Spring和MyBatis时，我们可以借助Spring的事务管理，确保数据库操作的原子性。

@Service
@Transactional
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public User getUserById(int userId) {
        return userMapper.getUserById(userId);
    }

    @Transactional(rollbackFor = Exception.class)
    public void updateUser(User user) {
        // 更新用户信息
        userMapper.updateUser(user);

        // 模拟异常，触发事务回滚
        if (user.getUsername().equals("rollback")) {
            throw new RuntimeException("Rollback!");
        }
    }
}

在上面的例子中，通过@Transactional注解修饰Service类，表示该类的所有方法都将启用事务管理。在updateUser方法中，通过@Transactional(rollbackFor = Exception.class)注解指定了异常回滚的条件，当用户名为"rollback"时，会触发事务回滚。