欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

spring boot配置读写分离的完整实现步骤

程序员文章站 2024-02-24 14:57:10
前言 开发中常用到主从数据库来提高系统的性能。怎么样才能方便的实现主从读写分离呢?近日工作任务较轻,有空学习学习技术,遂来研究如果实现读写分离。这里用博客记录下过程,一方...

前言

开发中常用到主从数据库来提高系统的性能。怎么样才能方便的实现主从读写分离呢?近日工作任务较轻,有空学习学习技术,遂来研究如果实现读写分离。这里用博客记录下过程,一方面可备日后查看,同时也能分享给大家(网上的资料真的大都是抄来抄去,,还不带格式的,看的真心难受)。

下面话不多说了,来一起看看详细的介绍吧。

1、背景

一个项目中数据库最基础同时也是最主流的是单机数据库,读写都在一个库中。当用户逐渐增多,单机数据库无法满足性能要求时,就会进行读写分离改造(适用于读多写少),写操作一个库,读操作多个库,通常会做一个数据库集群,开启主从备份,一主多从,以提高读取性能。当用户更多读写分离也无法满足时,就需要分布式数据库了(可能以后会学习怎么弄)。

正常情况下读写分离的实现,首先要做一个一主多从的数据库集群,同时还需要进行数据同步。这一篇记录如何用mysql搭建一个一主多次的配置,下一篇记录代码层面如何实现读写分离。

2、搭建一主多从数据库集群

主从备份需要多台虚拟机,我是用wmware完整克隆多个实例,注意直接克隆的虚拟机会导致每个数据库的uuid相同,需要修改为不同的uuid。修改方法参考这个:。

主库配置

主数据库(master)中新建一个用户用于从数据库(slave)读取主数据库二进制日志,sql语句如下:

mysql> create user 'repl'@'%' identified by '123456';#创建用户
 mysql> grant replication slave on *.* to 'repl'@'%';#分配权限
 mysql>flush privileges; #刷新权限

同时修改mysql配置文件开启二进制日志,新增部分如下:

[mysqld]
server-id=1
log-bin=master-bin
log-bin-index=master-bin.index

然后重启数据库,使用show master status;语句查看主库状态,如下所示:

spring boot配置读写分离的完整实现步骤

从库配置

同样先新增几行配置:

[mysqld]
server-id=2
relay-log-index=slave-relay-bin.index
relay-log=slave-relay-bin

然后重启数据库,使用如下语句连接主库:

change master to
 master_host='192.168.226.5',
 master_user='root',
 master_password='123456',
 master_log_file='master-bin.000003',
 master_log_pos=154;

接着运行start slave;开启备份,正常情况如下图所示:slave_io_running和slave_sql_running都为yes。

spring boot配置读写分离的完整实现步骤

可以用这个步骤开启多个从库。

  默认情况下备份是主库的全部操作都会备份到从库,实际可能需要忽略某些库,可以在主库中增加如下配置:

# 不同步哪些数据库 
binlog-ignore-db = mysql 
binlog-ignore-db = test 
binlog-ignore-db = information_schema 
 
# 只同步哪些数据库,除此之外,其他不同步 
binlog-do-db = game 

3、代码层面进行读写分离

代码环境是springboot+mybatis+druib连接池。想要读写分离就需要配置多个数据源,在进行写操作是选择写的数据源,读操作时选择读的数据源。其中有两个关键点:

  1. 如何切换数据源
  2. 如何根据不同的方法选择正确的数据源

1)、如何切换数据源

通常用springboot时都是使用它的默认配置,只需要在配置文件中定义好连接属性就行了,但是现在我们需要自己来配置了,spring是支持多数据源的,多个datasource放在一个hashmaptargetdatasource中,通过derterminecurrentlookupkey获取key来觉定要使用哪个数据源。因此我们的目标就很明确了,建立多个datasource放到targetdatasource中,同时重写derterminecurrentlookupkey方法来决定使用哪个key。

2)、如何选择数据源

事务一般是注解在service层的,因此在开始这个service方法调用时要确定数据源,有什么通用方法能够在开始执行一个方法前做操作呢?相信你已经想到了那就是切面 。怎么切有两种办法:

  • 注解式,定义一个只读注解,被该数据标注的方法使用读库
  • 方法名,根据方法名写切点,比如getxxx用读库,setxxx用写库

3)、代码编写

a、编写配置文件,配置两个数据源信息

只有必填信息,其他都有默认设置

mysql:
 datasource:
 #读库数目
 num: 1
 type-aliases-package: com.example.dxfl.dao
 mapper-locations: classpath:/mapper/*.xml
 config-location: classpath:/mybatis-config.xml
 write:
 url: jdbc:mysql://192.168.226.5:3306/test?useunicode=true&characterencoding=utf-8&usessl=true
 username: root
 password: 123456
 driver-class-name: com.mysql.jdbc.driver
 read:
 url: jdbc:mysql://192.168.226.6:3306/test?useunicode=true&characterencoding=utf-8&usessl=true
 username: root
 password: 123456
 driver-class-name: com.mysql.jdbc.driver

b、编写dbcontextholder类

这个类用来设置数据库类别,其中有一个threadlocal用来保存每个线程的是使用读库,还是写库。代码如下:

/**
 * description 这里切换读/写模式
 * 原理是利用threadlocal保存当前线程是否处于读模式(通过开始read_only注解在开始操作前设置模式为读模式,
 * 操作结束后清除该数据,避免内存泄漏,同时也为了后续在该线程进行写操作时任然为读模式
 * @author fxb
 * @date 2018-08-31
 */
public class dbcontextholder {

 private static logger log = loggerfactory.getlogger(dbcontextholder.class);
 public static final string write = "write";
 public static final string read = "read";

 private static threadlocal<string> contextholder= new threadlocal<>();

 public static void setdbtype(string dbtype) {
 if (dbtype == null) {
 log.error("dbtype为空");
 throw new nullpointerexception();
 }
 log.info("设置dbtype为:{}",dbtype);
 contextholder.set(dbtype);
 }

 public static string getdbtype() {
 return contextholder.get() == null ? write : contextholder.get();
 }

 public static void cleardbtype() {
 contextholder.remove();
 }
}

c、重写determinecurrentlookupkey方法

spring在开始进行数据库操作时会通过这个方法来决定使用哪个数据库,因此我们在这里调用上面dbcontextholder类的getdbtype()方法获取当前操作类别,同时可进行读库的负载均衡,代码如下:

public class myabstractroutingdatasource extends abstractroutingdatasource {

 @value("${mysql.datasource.num}")
 private int num;

 private final logger log = loggerfactory.getlogger(this.getclass());

 @override
 protected object determinecurrentlookupkey() {
 string typekey = dbcontextholder.getdbtype();
 if (typekey == dbcontextholder.write) {
 log.info("使用了写库");
 return typekey;
 }
 //使用随机数决定使用哪个读库
 int sum = numberutil.getrandom(1, num);
 log.info("使用了读库{}", sum);
 return dbcontextholder.read + sum;
 }
}

d、编写配置类

由于要进行读写分离,不能再用springboot的默认配置,我们需要手动来进行配置。首先生成数据源,使用@configurproperties自动生成数据源:

 /**
 * 写数据源
 *
 * @primary 标志这个 bean 如果在多个同类 bean 候选时,该 bean 优先被考虑。
 * 多数据源配置的时候注意,必须要有一个主数据源,用 @primary 标志该 bean
 */
 @primary
 @bean
 @configurationproperties(prefix = "mysql.datasource.write")
 public datasource writedatasource() {
 return new druiddatasource();
 }

读数据源类似,注意有多少个读库就要设置多少个读数据源,bean名为read+序号。

然后设置数据源,使用的是我们之前写的myabstractroutingdatasource类

 /**
 * 设置数据源路由,通过该类中的determinecurrentlookupkey决定使用哪个数据源
 */
 @bean
 public abstractroutingdatasource routingdatasource() {
 myabstractroutingdatasource proxy = new myabstractroutingdatasource();
 map<object, object> targetdatasources = new hashmap<>(2);
 targetdatasources.put(dbcontextholder.write, writedatasource());
 targetdatasources.put(dbcontextholder.read+"1", read1());
 proxy.setdefaulttargetdatasource(writedatasource());
 proxy.settargetdatasources(targetdatasources);
 return proxy;
 }

接着需要设置sqlsessionfactory

 /**
 * 多数据源需要自己设置sqlsessionfactory
 */
 @bean
 public sqlsessionfactory sqlsessionfactory() throws exception {
 sqlsessionfactorybean bean = new sqlsessionfactorybean();
 bean.setdatasource(routingdatasource());
 resourcepatternresolver resolver = new pathmatchingresourcepatternresolver();
 // 实体类对应的位置
 bean.settypealiasespackage(typealiasespackage);
 // mybatis的xml的配置
 bean.setmapperlocations(resolver.getresources(mapperlocation));
 bean.setconfiglocation(resolver.getresource(configlocation));
 return bean.getobject();
 }

最后还得配置下事务,否则事务不生效

 /**
 * 设置事务,事务需要知道当前使用的是哪个数据源才能进行事务处理
 */
 @bean
 public datasourcetransactionmanager datasourcetransactionmanager() {
 return new datasourcetransactionmanager(routingdatasource());
 }

4)、选择数据源

多数据源配置好了,但是代码层面如何选择选择数据源呢?这里介绍两种办法:

a、注解式

首先定义一个只读注解,被这个注解方法使用读库,其他使用写库,如果项目是中途改造成读写分离可使用这个方法,无需修改业务代码,只要在只读的service方法上加一个注解即可。

@target({elementtype.method,elementtype.type})
@retention(retentionpolicy.runtime)
public @interface readonly {
}

然后写一个切面来切换数据使用哪种数据源,重写getorder保证本切面优先级高于事务切面优先级,在启动类加上@enabletransactionmanagement(order = 10),为了代码如下:

@aspect
@component
public class readonlyinterceptor implements ordered {
 private static final logger log= loggerfactory.getlogger(readonlyinterceptor.class);

 @around("@annotation(readonly)")
 public object setread(proceedingjoinpoint joinpoint,readonly readonly) throws throwable{
 try{
 dbcontextholder.setdbtype(dbcontextholder.read);
 return joinpoint.proceed();
 }finally {
 //清楚dbtype一方面为了避免内存泄漏,更重要的是避免对后续在本线程上执行的操作产生影响
 dbcontextholder.cleardbtype();
 log.info("清除threadlocal");
 }
 }

 @override
 public int getorder() {
 return 0;
 }
}

b、方法名式

这种方法不许要注解,但是需要事务名称按一定规则编写,然后通过切面来设置数据库类别,比如setxxx设置为写、getxxx设置为读,代码我就不写了,应该都知道怎么写。

4、测试

编写好代码来试试结果如何,下面是运行截图:

spring boot配置读写分离的完整实现步骤

断断续续写了好几天终于是写完了,,,如果有帮助到你,,欢迎star哦,,这里是完整代码地址:点击跳转

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。