Spring Boot整合MyBatis Plus集成多数据源轻松实现数据读写分离

简介: Spring Boot整合MyBatis Plus集成多数据源轻松实现数据读写分离

1、前言

在实际项目中,数据库是至关重要的组成部分。为了提高性能和可用性,常见的数据库优化策略之一是将数据库读和写操作分离,以降低数据库服务器的负载。

MyBatis Plus是一个流行的Java持久化框架,它提供了读写分离的支持,结合Spring Boot 集成多数据源的特性可以帮助你轻松地实现读写分离策略。

Springboot项目中操作数据库,使用MP方便快捷;如何使用MP实现读写分离,以提高你的应用程序性能和可用性。我们将分为以下几个步骤来介绍这一过程。

2、配置多数据源

在 Spring Boot 配置文件中配置多个数据源,通常至少包括一个主数据库(写库)和一个或多个从数据库(读库)。以下是一个示例的配置:

spring.datasource.write.url=jdbc:mysql://write-server:3306/write_db
spring.datasource.write.username=root
spring.datasource.write.password=root
spring.datasource.read.url=jdbc:mysql://read1-server:3306/read1_db
spring.datasource.read.username=root
spring.datasource.read.password=root

上面配置中,write 数据源代表主数据库,read 数据源代表从数据库。你可以根据项目需求配置更多的从数据库。

3、创建数据源和数据库连接池 Bean

在 Spring Boot 配置中,为每个数据源创建一个数据源和数据库连接池 Bean。

@Bean(name = "writeDataSource")
@ConfigurationProperties(prefix = "spring.datasource.write")
public DataSource writeDataSource() {
     return DataSourceBuilder.create().build();
}
@Bean(name = "readDataSource")
@ConfigurationProperties(prefix = "spring.datasource.read")
public DataSource readDataSource() {
   return DataSourceBuilder.create().build();
}

4、配置 MyBatis Plus数据源

配置 MyBatis Plus 的数据源和 SqlSessionFactoryBean,分别指向主数据源和从数据源。

@Bean(name = "writeSqlSessionFactory")
public SqlSessionFactory writeSqlSessionFactory(@Qualifier("writeDataSource") DataSource writeDataSource) throws Exception {
    MybatisSqlSessionFactoryBean sessionFactoryBean = new MybatisSqlSessionFactoryBean();
   sessionFactoryBean.setDataSource(writeDataSource);
      // 配置 MyBatis Plus的一些参数
     return sessionFactoryBean.getObject();
}
@Bean(name = "readSqlSessionFactory")
public SqlSessionFactory readSqlSessionFactory(@Qualifier("readDataSource") DataSource read1DataSource) throws Exception {
   MybatisSqlSessionFactoryBean sessionFactoryBean = new MybatisSqlSessionFactoryBean();
   sessionFactoryBean.setDataSource(readDataSource);
  // 配置 MyBatis Plus的一些参数
   return sessionFactoryBean.getObject();
}

5、配置动态数据源路由

创建一个动态数据源路由,用于根据操作类型(读操作或写操作)选择主数据源或从数据源。

public class DynamicDataSource extends AbstractRoutingDataSource {
   @Override
   protected Object determineCurrentLookupKey() {
       return DataSourceContextHolder.getDataSource();
   }
}

6、配置数据源切换注解

创建自定义注解(如 @ReadDataSource@WriteDataSource),并创建拦截器,根据注解来选择数据源。

首先,创建 @ReadDataSource 注解:

import java.lang.annotation.*;
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ReadDataSource {
}

接下来,创建 @WriteDataSource 注解:

import java.lang.annotation.*;
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WriteDataSource {
}

然后,创建数据源切换拦截器,该拦截器将根据注解选择数据源:

import org.aspectj.lang.JoinPoint;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Before;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.stereotype.Component;
 
 @Aspect
 @Component
 public class DataSourceSwitchAspect {
    @Before("execution(* com.example.service.*.*(..))")
    public void switchDataSource(JoinPoint joinPoint) {
        Class<?> targetClass = joinPoint.getTarget().getClass();
        // 检查方法上是否有数据源注解
        ReadDataSource readDataSource = AnnotationUtils.findAnnotation(targetClass, ReadDataSource.class);
        WriteDataSource writeDataSource = AnnotationUtils.findAnnotation(targetClass, WriteDataSource.class);
        if (readDataSource != null) {
            DataSourceContextHolder.setDataSource(DataSourceType.READ);
        } else if (writeDataSource != null) {
            DataSourceContextHolder.setDataSource(DataSourceType.WRITE);
        } else {
            // 没有注解,默认使用写数据源
            DataSourceContextHolder.setDataSource(DataSourceType.WRITE);
        }
    }
}

这个拦截器会在方法执行前根据注解来选择数据源,如果方法上有 @ReadDataSource 注解,则选择读数据源,如果方法上有 @WriteDataSource 注解,则选择写数据源,否则默认使用写数据源。

最后,创建一个数据源上下文持有器 DataSourceContextHolder,用于存储当前选择的数据源:

public class DataSourceContextHolder {
  private static final ThreadLocal<DataSourceType> contextHolder = new ThreadLocal<>();
  public static void setDataSource(DataSourceType dataSourceType) {
    contextHolder.set(dataSourceType);
  }
  public static DataSourceType getDataSource() {
    return contextHolder.get();
  }
  public static void clearDataSource() {
    contextHolder.remove();
  }
}

DataSourceType 是一个自定义的枚举,用于表示数据源类型(读或写):

public enum DataSourceType {
    READ, WRITE
}

通过以上配置,你可以在 Service 层的方法上使用 @ReadDataSource@WriteDataSource 注解来标识读操作和写操作,拦截器会根据注解选择相应的数据源。

7、编写 Service 层代码

在 Service 层的方法中,根据操作类型(读操作或写操作),选择数据源。可以使用自定义注解或其他方式标识读操作和写操作的方法。

@Service
public class UserService {
  @Autowired
  private UserService userService; // MyBatis Plus 提供的 Service
  @ReadDataSource // 自定义的注解,用于标识读操作
  public User getUserById(Long id) {
    return userService.getById(id); // 直接使用 MyBatis Plus 提供的查询方法
  }
  @WriteDataSource // 自定义的注解,用于标识写操作
  public void createUser(User user) {
    userService.save(user); // 直接使用 MyBatis Plus 提供的插入方法
  }
}

8、总结

MyBatis Plus的读写分离功能使数据库优化变得轻而易举。通过将读和写操作分离到不同的数据源中,你可以降低数据库负载,提高应用程序性能和可用性。需要注意的是,具体的实现方式和注解可以根据项目需求和业务逻辑进行调整和扩展。


已经是最低谷了,怎么走都是向上,所以,你怕什么。

目录
相关文章
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于 xml 的整合
本教程介绍了基于XML的MyBatis整合方式。首先在`application.yml`中配置XML路径,如`classpath:mapper/*.xml`,然后创建`UserMapper.xml`文件定义SQL映射,包括`resultMap`和查询语句。通过设置`namespace`关联Mapper接口,实现如`getUserByName`的方法。Controller层调用Service完成测试,访问`/getUserByName/{name}`即可返回用户信息。为简化Mapper扫描,推荐在Spring Boot启动类用`@MapperScan`注解指定包路径避免逐个添加`@Mapper`
1082 0
|
JSON Java 数据格式
微服务——SpringBoot使用归纳——Spring Boot返回Json数据及数据封装——封装统一返回的数据结构
本文介绍了在Spring Boot中封装统一返回的数据结构的方法。通过定义一个泛型类`JsonResult&lt;T&gt;`,包含数据、状态码和提示信息三个属性,满足不同场景下的JSON返回需求。例如,无数据返回时可设置默认状态码&quot;0&quot;和消息&quot;操作成功!&quot;,有数据返回时也可自定义状态码和消息。同时,文章展示了如何在Controller中使用该结构,通过具体示例(如用户信息、列表和Map)说明其灵活性与便捷性。最后总结了Spring Boot中JSON数据返回的配置与实际项目中的应用技巧。
1053 0
|
JSON Java fastjson
微服务——SpringBoot使用归纳——Spring Boot返回Json数据及数据封装——使用 fastJson 处理 null
本文介绍如何使用 fastJson 处理 null 值。与 Jackson 不同,fastJson 需要通过继承 `WebMvcConfigurationSupport` 类并覆盖 `configureMessageConverters` 方法来配置 null 值的处理方式。例如,可将 String 类型的 null 转为 &quot;&quot;,Number 类型的 null 转为 0,避免循环引用等。代码示例展示了具体实现步骤,包括引入相关依赖、设置序列化特性及解决中文乱码问题。
718 0
|
JSON Java fastjson
微服务——SpringBoot使用归纳——Spring Boot返回Json数据及数据封装——Spring Boot 默认对Json的处理
本文介绍了在Spring Boot中返回Json数据的方法及数据封装技巧。通过使用`@RestController`注解,可以轻松实现接口返回Json格式的数据,默认使用的Json解析框架是Jackson。文章详细讲解了如何处理不同数据类型(如类对象、List、Map)的Json转换,并提供了自定义配置以应对null值问题。此外,还对比了Jackson与阿里巴巴FastJson的特点,以及如何在项目中引入和配置FastJson,解决null值转换和中文乱码等问题。
1835 0
|
Java 数据库连接 数据库
Spring boot 使用mybatis generator 自动生成代码插件
本文介绍了在Spring Boot项目中使用MyBatis Generator插件自动生成代码的详细步骤。首先创建一个新的Spring Boot项目,接着引入MyBatis Generator插件并配置`pom.xml`文件。然后删除默认的`application.properties`文件,创建`application.yml`进行相关配置,如设置Mapper路径和实体类包名。重点在于配置`generatorConfig.xml`文件,包括数据库驱动、连接信息、生成模型、映射文件及DAO的包名和位置。最后通过IDE配置运行插件生成代码,并在主类添加`@MapperScan`注解完成整合
1678 1
Spring boot 使用mybatis generator 自动生成代码插件
|
12月前
|
JSON Java 数据格式
Spring Boot返回Json数据及数据封装
在Spring Boot中,接口间及前后端的数据传输通常使用JSON格式。通过@RestController注解,可轻松实现Controller返回JSON数据。该注解是Spring Boot新增的组合注解,结合了@Controller和@ResponseBody的功能,默认将返回值转换为JSON格式。Spring Boot底层默认采用Jackson作为JSON解析框架,并通过spring-boot-starter-json依赖集成了相关库,包括jackson-databind、jackson-datatype-jdk8等常用模块,简化了开发者对依赖的手动管理。
881 3
|
SQL Java 数据库
解决Java Spring Boot应用中MyBatis-Plus查询问题的策略。
保持技能更新是侦探的重要素质。定期回顾最佳实践和新技术。比如,定期查看MyBatis-Plus的更新和社区的最佳做法,这样才能不断提升查询效率和性能。
781 1
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于注解的整合
本文介绍了Spring Boot集成MyBatis的两种方式:基于XML和注解的形式。重点讲解了注解方式,包括@Select、@Insert、@Update、@Delete等常用注解的使用方法,以及多参数时@Param注解的应用。同时,针对字段映射不一致的问题,提供了@Results和@ResultMap的解决方案。文章还提到实际项目中常结合XML与注解的优点,灵活使用两者以提高开发效率,并附带课程源码供下载学习。
1175 0
|
Java 数据库连接 数据库
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——MyBatis 介绍和配置
本文介绍了Spring Boot集成MyBatis的方法,重点讲解基于注解的方式。首先简述MyBatis作为持久层框架的特点,接着说明集成时的依赖导入,包括`mybatis-spring-boot-starter`和MySQL连接器。随后详细展示了`properties.yml`配置文件的内容,涵盖数据库连接、驼峰命名规范及Mapper文件路径等关键设置,帮助开发者快速上手Spring Boot与MyBatis的整合开发。
1939 0
|
Java Maven Docker
gitlab-ci 集成 k3s 部署spring boot 应用
gitlab-ci 集成 k3s 部署spring boot 应用