前言

入職新公司到現(xiàn)在也有一個(gè)月了，完成了手頭的工作，前幾天終于有時(shí)間研究下公司舊項(xiàng)目的代碼。在研究代碼的過(guò)程中，發(fā)現(xiàn)項(xiàng)目里用到了Spring Aop來(lái)實(shí)現(xiàn)數(shù)據(jù)庫(kù)的讀寫(xiě)分離，本著自己愛(ài)學(xué)習(xí)(我自己都不信…)的性格，決定寫(xiě)個(gè)實(shí)例工程來(lái)實(shí)現(xiàn)spring aop讀寫(xiě)分離的效果。

環(huán)境部署

數(shù)據(jù)庫(kù)：MySql庫(kù)數(shù)量：2個(gè)，一主一從關(guān)于mysql的主從環(huán)境部署，可以參考：https://www.jb51.net/article/184698.htm

開(kāi)始項(xiàng)目

首先，毫無(wú)疑問(wèn)，先開(kāi)始搭建一個(gè)SpringBoot工程，然后在pom文件中引入如下依賴(lài)：

<dependencies> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.1.10</version> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.3.2</version> </dependency> <dependency> <groupId>tk.mybatis</groupId> <artifactId>mapper-spring-boot-starter</artifactId> <version>2.1.5</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.16</version> </dependency> <!-- 動(dòng)態(tài)數(shù)據(jù)源 所需依賴(lài) ### start--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> <scope>provided</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> <scope>provided</scope> </dependency> <!-- 動(dòng)態(tài)數(shù)據(jù)源 所需依賴(lài) ### end--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.4</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> </dependencies>

目錄結(jié)構(gòu)

引入基本的依賴(lài)后，整理一下目錄結(jié)構(gòu)，完成后的項(xiàng)目骨架大致如下：

建表

創(chuàng)建一張表user，在主庫(kù)執(zhí)行sql語(yǔ)句同時(shí)在從庫(kù)生成對(duì)應(yīng)的表數(shù)據(jù)

DROP TABLE IF EXISTS `user`;CREATE TABLE `user` ( `user_id` bigint(20) NOT NULL COMMENT ’用戶(hù)id’, `user_name` varchar(255) DEFAULT ’’ COMMENT ’用戶(hù)名稱(chēng)’, `user_phone` varchar(50) DEFAULT ’’ COMMENT ’用戶(hù)手機(jī)’, `address` varchar(255) DEFAULT ’’ COMMENT ’住址’, `weight` int(3) NOT NULL DEFAULT ’1’ COMMENT ’權(quán)重，大者優(yōu)先’, `created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT ’創(chuàng)建時(shí)間’, `updated_at` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT ’更新時(shí)間’, PRIMARY KEY (`user_id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8;INSERT INTO `user` VALUES (’1196978513958141952’, ’測(cè)試1’, ’18826334748’, ’廣州市海珠區(qū)’, ’1’, ’2019-11-20 10:28:51’, ’2019-11-22 14:28:26’);INSERT INTO `user` VALUES (’1196978513958141953’, ’測(cè)試2’, ’18826274230’, ’廣州市天河區(qū)’, ’2’, ’2019-11-20 10:29:37’, ’2019-11-22 14:28:14’);INSERT INTO `user` VALUES (’1196978513958141954’, ’測(cè)試3’, ’18826273900’, ’廣州市天河區(qū)’, ’1’, ’2019-11-20 10:30:19’, ’2019-11-22 14:28:30’);

主從數(shù)據(jù)源配置

application.yml，主要信息是主從庫(kù)的數(shù)據(jù)源配置

server: port: 8001spring: jackson: date-format: yyyy-MM-dd HH:mm:ss time-zone: GMT+8 datasource: type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.cj.jdbc.Driver master: url: jdbc:mysql://127.0.0.1:3307/user?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&failOverReadOnly=false&useSSL=false&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true username: root password: slave: url: jdbc:mysql://127.0.0.1:3308/user?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&failOverReadOnly=false&useSSL=false&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true username: root password:

因?yàn)橛幸恢饕粡膬蓚€(gè)數(shù)據(jù)源，我們用枚舉類(lèi)來(lái)代替，方便我們使用時(shí)能對(duì)應(yīng)

@Getterpublic enum DynamicDataSourceEnum { MASTER('master'), SLAVE('slave'); private String dataSourceName; DynamicDataSourceEnum(String dataSourceName) { this.dataSourceName = dataSourceName; }}

數(shù)據(jù)源配置信息類(lèi) DataSourceConfig，這里配置了兩個(gè)數(shù)據(jù)源，masterDb和slaveDb

@Configuration@MapperScan(basePackages = 'com.xjt.proxy.mapper', sqlSessionTemplateRef = 'sqlTemplate')public class DataSourceConfig { // 主庫(kù) @Bean @ConfigurationProperties(prefix = 'spring.datasource.master') public DataSource masterDb() { return DruidDataSourceBuilder.create().build(); } /** * 從庫(kù) */ @Bean @ConditionalOnProperty(prefix = 'spring.datasource', name = 'slave', matchIfMissing = true) @ConfigurationProperties(prefix = 'spring.datasource.slave') public DataSource slaveDb() { return DruidDataSourceBuilder.create().build(); }

/** * 主從動(dòng)態(tài)配置 */ @Bean public DynamicDataSource dynamicDb(@Qualifier('masterDb') DataSource masterDataSource, @Autowired(required = false) @Qualifier('slaveDb') DataSource slaveDataSource) { DynamicDataSource dynamicDataSource = new DynamicDataSource(); Map<Object, Object> targetDataSources = new HashMap<>(); targetDataSources.put(DynamicDataSourceEnum.MASTER.getDataSourceName(), masterDataSource); if (slaveDataSource != null) { targetDataSources.put(DynamicDataSourceEnum.SLAVE.getDataSourceName(), slaveDataSource); } dynamicDataSource.setTargetDataSources(targetDataSources); dynamicDataSource.setDefaultTargetDataSource(masterDataSource); return dynamicDataSource; } @Bean public SqlSessionFactory sessionFactory(@Qualifier('dynamicDb') DataSource dynamicDataSource) throws Exception { SqlSessionFactoryBean bean = new SqlSessionFactoryBean(); bean.setMapperLocations( new PathMatchingResourcePatternResolver().getResources('classpath*:mapper/*Mapper.xml')); bean.setDataSource(dynamicDataSource); return bean.getObject(); } @Bean public SqlSessionTemplate sqlTemplate(@Qualifier('sessionFactory') SqlSessionFactory sqlSessionFactory) { return new SqlSessionTemplate(sqlSessionFactory); } @Bean(name = 'dataSourceTx') public DataSourceTransactionManager dataSourceTx(@Qualifier('dynamicDb') DataSource dynamicDataSource) { DataSourceTransactionManager dataSourceTransactionManager = new DataSourceTransactionManager(); dataSourceTransactionManager.setDataSource(dynamicDataSource); return dataSourceTransactionManager; }}

設(shè)置路由

設(shè)置路由的目的為了方便查找對(duì)應(yīng)的數(shù)據(jù)源，我們可以用ThreadLocal保存數(shù)據(jù)源的信息到每個(gè)線程中，方便我們需要時(shí)獲取

public class DataSourceContextHolder { private static final ThreadLocal<String> DYNAMIC_DATASOURCE_CONTEXT = new ThreadLocal<>(); public static void set(String datasourceType) { DYNAMIC_DATASOURCE_CONTEXT.set(datasourceType); } public static String get() { return DYNAMIC_DATASOURCE_CONTEXT.get(); } public static void clear() { DYNAMIC_DATASOURCE_CONTEXT.remove(); }}

獲取路由

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

AbstractRoutingDataSource的作用是基于查找key路由到對(duì)應(yīng)的數(shù)據(jù)源，它內(nèi)部維護(hù)了一組目標(biāo)數(shù)據(jù)源，并且做了路由key與目標(biāo)數(shù)據(jù)源之間的映射，提供基于key查找數(shù)據(jù)源的方法。數(shù)據(jù)源的注解

為了可以方便切換數(shù)據(jù)源，我們可以寫(xiě)一個(gè)注解，注解中包含數(shù)據(jù)源對(duì)應(yīng)的枚舉值，默認(rèn)是主庫(kù)，

@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)@Documentedpublic @interface DataSourceSelector { DynamicDataSourceEnum value() default DynamicDataSourceEnum.MASTER; boolean clear() default true;}

aop切換數(shù)據(jù)源

到這里，aop終于可以現(xiàn)身出場(chǎng)了，這里我們定義一個(gè)aop類(lèi)，對(duì)有注解的方法做切換數(shù)據(jù)源的操作，具體代碼如下：

@Slf4j@Aspect@Order(value = 1)@Componentpublic class DataSourceContextAop { @Around('@annotation(com.xjt.proxy.dynamicdatasource.DataSourceSelector)') public Object setDynamicDataSource(ProceedingJoinPoint pjp) throws Throwable { boolean clear = true; try { Method method = this.getMethod(pjp); DataSourceSelector dataSourceImport = method.getAnnotation(DataSourceSelector.class); clear = dataSourceImport.clear(); DataSourceContextHolder.set(dataSourceImport.value().getDataSourceName()); log.info('========數(shù)據(jù)源切換至：{}', dataSourceImport.value().getDataSourceName()); return pjp.proceed(); } finally { if (clear) { DataSourceContextHolder.clear(); } } } private Method getMethod(JoinPoint pjp) { MethodSignature signature = (MethodSignature)pjp.getSignature(); return signature.getMethod(); }}

到這一步，我們的準(zhǔn)備配置工作就完成了，下面開(kāi)始測(cè)試效果。更多springboot文章，查看往期：SpringBoot內(nèi)容聚合先寫(xiě)好Service文件，包含讀取和更新兩個(gè)方法，

@Servicepublic class UserService { @Autowired private UserMapper userMapper; @DataSourceSelector(value = DynamicDataSourceEnum.SLAVE) public List<User> listUser() { List<User> users = userMapper.selectAll(); return users; } @DataSourceSelector(value = DynamicDataSourceEnum.MASTER) public int update() { User user = new User(); user.setUserId(Long.parseLong('1196978513958141952')); user.setUserName('修改后的名字2'); return userMapper.updateByPrimaryKeySelective(user); } @DataSourceSelector(value = DynamicDataSourceEnum.SLAVE) public User find() { User user = new User(); user.setUserId(Long.parseLong('1196978513958141952')); return userMapper.selectByPrimaryKey(user); }}

根據(jù)方法上的注解可以看出，讀的方法走從庫(kù)，更新的方法走主庫(kù)，更新的對(duì)象是userId為1196978513958141953 的數(shù)據(jù)，然后我們寫(xiě)個(gè)測(cè)試類(lèi)測(cè)試下是否能達(dá)到效果，

@RunWith(SpringRunner.class)@SpringBootTestclass UserServiceTest { @Autowired UserService userService; @Test void listUser() { List<User> users = userService.listUser(); for (User user : users) { System.out.println(user.getUserId()); System.out.println(user.getUserName()); System.out.println(user.getUserPhone()); } } @Test void update() { userService.update(); User user = userService.find(); System.out.println(user.getUserName()); }}

測(cè)試結(jié)果：1、讀取方法

2、更新方法

執(zhí)行之后，比對(duì)數(shù)據(jù)庫(kù)就可以發(fā)現(xiàn)主從庫(kù)都修改了數(shù)據(jù)，說(shuō)明我們的讀寫(xiě)分離是成功的。當(dāng)然，更新方法可以指向從庫(kù)，這樣一來(lái)就只會(huì)修改到從庫(kù)的數(shù)據(jù)，而不會(huì)涉及到主庫(kù)。

注意

上面測(cè)試的例子雖然比較最后發(fā)一下項(xiàng)目的github地址，有興趣的同學(xué)可以看下：https://github.com/Taoxj/mysql-proxy簡(jiǎn)單，但也符合常規(guī)的讀寫(xiě)分離配置。值得說(shuō)明的是，讀寫(xiě)分離的作用是為了緩解寫(xiě)庫(kù)，也就是主庫(kù)的壓力，但一定要基于數(shù)據(jù)一致性的原則，就是保證主從庫(kù)之間的數(shù)據(jù)一定要一致。如果一個(gè)方法涉及到寫(xiě)的邏輯，那么該方法里所有的數(shù)據(jù)庫(kù)操作都要走主庫(kù)。假設(shè)寫(xiě)的操作執(zhí)行完后數(shù)據(jù)有可能還沒(méi)同步到從庫(kù)，然后讀的操作也開(kāi)始執(zhí)行了，如果這個(gè)讀取的程序走的依然是從庫(kù)的話，那么就會(huì)出現(xiàn)數(shù)據(jù)不一致的現(xiàn)象了，這是我們不允許的。

以上就是Spring Boot 結(jié)合 aop 實(shí)現(xiàn)讀寫(xiě)分離的詳細(xì)內(nèi)容，更多關(guān)于Spring Boot 實(shí)現(xiàn)讀寫(xiě)分離的資料請(qǐng)關(guān)注好吧啦網(wǎng)其它相關(guān)文章！