Spring Boot + MyBatis-Plus实现数据库读写分离

IT_陈寒

发布于 2023-12-14 11:30:49

7880

发布于 2023-12-14 11:30:49

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

🎉Spring Boot + MyBatis-Plus实现数据库读写分离

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

1. 引言

在当今互联网应用中，数据库读写分离是提高系统性能和稳定性的重要手段之一。通过将读操作和写操作分别路由到不同的数据库节点，可以有效减轻数据库服务器的负担，提升系统的整体性能。本文将介绍如何利用Spring Boot和MyBatis-Plus框架实现数据库读写分离，并通过简单易懂的代码示例来详细说明每个步骤。

2. MyBatis-Plus简介

MyBatis-Plus是MyBatis的增强工具，提供了许多实用的功能，包括但不限于代码生成器、通用Mapper、分页插件等。在本文中，我们将专注于使用MyBatis-Plus实现数据库读写分离。

3. 准备工作

在开始之前，确保你的开发环境中已经安装了以下软件：

JDK（推荐使用JDK 8及以上版本）
Maven
IntelliJ IDEA或Eclipse（可选）

在项目的pom.xml文件中添加MyBatis-Plus和数据库驱动的依赖：

<!-- MyBatis-Plus -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3.2</version>
</dependency>

<!-- MySQL驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.26</version>
</dependency>

4. 配置数据源

在application.properties（或application.yml）中配置主库和从库的数据源：

# 主库数据源配置
spring.datasource.master.url=jdbc:mysql://localhost:3306/masterdb?useSSL=false&serverTimezone=UTC
spring.datasource.master.username=root
spring.datasource.master.password=root
spring.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driver

# 从库数据源配置
spring.datasource.slave.url=jdbc:mysql://localhost:3307/slavedb?useSSL=false&serverTimezone=UTC
spring.datasource.slave.username=root
spring.datasource.slave.password=root
spring.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driver

5. 配置MyBatis-Plus

创建一个配置类，用于配置MyBatis-Plus的分页插件和动态数据源：

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;

import javax.sql.DataSource;

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

    @Bean(name = "sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier("dataSource") DataSource dataSource) throws Exception {
        MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        return sqlSessionFactoryBean.getObject();
    }

    @Bean(name = "transactionManager")
    public PlatformTransactionManager transactionManager(@Qualifier("dataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

6. 创建实体类和Mapper接口

创建一个简单的实体类和对应的Mapper接口：

// User.java
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("user")
public class User {

    @TableId
    private Long id;
    private String username;
    private String password;
}

// UserMapper.java
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

7. 编写Service

创建Service层，调用Mapper接口完成数据操作：

// UserService.java
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

@Service
public class UserService extends ServiceImpl<UserMapper, User> {
}

8. 控制器层

编写Controller层，暴露接口供前端调用：

// UserController.java
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/users")
public class UserController {

    private final UserService userService;

    @Autowired
    public UserController(UserService userService) {
        this.userService = userService;
    }

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        return userService.getById(id);
    }

    @PostMapping
    public boolean createUser(@RequestBody User user) {
        return userService.save(user);
    }

    @PutMapping
    public boolean updateUser(@RequestBody User user) {
        return userService.updateById(user);
    }

    @DeleteMapping("/{id}")
    public boolean deleteUser(@PathVariable Long id) {
        return userService.removeById(id);
    }
}

9. 测试

启动Spring Boot应用程序，访问相应的接口进行测试。通过日志可以看到，MyBatis-Plus会在执行查询时根据一定的规则选择主库或从库。

10. 数据库读写分离的原理

数据库读写分离的实现原理主要通过在MyBatis-Plus中使用@DataSource注解，根据不同的操作选择不同的数据源。这里简要说明一下原理：

创建多个数据源： 配置文件中定义了主库和从库两个数据源。
配置动态数据源： 在MybatisPlusConfig配置类中，使用DynamicDataSource类包装主库和从库的数据源，通过@Primary注解标识主库。
自定义注解： 创建@DataSource注解，用于标识Mapper方法应该使用哪个数据源。
AOP切面： 利用AOP，在Mapper方法执行前根据@DataSource注解的值动态切换数据源。