2. 程式人生 > >Spring AOP實現多資料來源切換

Spring AOP實現多資料來源切換

阿新 • • 發佈：2018-12-27

有時候我們會遇到這樣的場景：一個應用系統中存在多個數據源，需要根據不同業務場景進行臨時切換。比如讀寫分離（也可以考慮使用Mycat等資料庫中介軟體）等。

Spring提供了動態資料來源的功能，可以讓我們實現在對資料庫操作前進行切換。

下面我們演示怎麼在專案中配置多資料來源並根據不用業務場景進行切換（本文涉及到Spring Boot和Spring Data Jpa，相關內容及配置不做詳解）。

1、在MySQL上面建立兩個資料庫（實際中可能在不同伺服器），並建立相同的一張表student。

 附上建表SQL：

DROP TABLE IF EXISTS `student`;
CREATE TABLE `student` (
  `id` bigint(11) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `name` varchar(255) DEFAULT NULL COMMENT '姓名',
  `sex` tinyint(1) DEFAULT NULL COMMENT '性別：1男2女',
  `age` tinyint(3) DEFAULT NULL COMMENT '年齡',
  `birthday` datetime DEFAULT NULL COMMENT '生日',
  `address` varchar(255) DEFAULT NULL COMMENT '住址',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=9 DEFAULT CHARSET=latin1;

2、建立對應的學生實體類。

/**
 * 學生實體類
 * @author z_hh  
 * @date 2018年11月30日
 */
@Getter
@Setter
@Builder
@ToString
@Entity
public class Student implements Serializable {

	private static final long serialVersionUID = -5636317592972887581L;

	/** 主鍵 */
	@Id
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	private Long id;
	
	/** 姓名 */
	private String name;
	
	/** 性別 */
	private Integer sex;
	
	/** 年齡 */
	private Integer age;
	
	/** 生日 */
	private Date birthday;
	
	/** 地址 */
	private String address;
	
	public Student() {
	}

	public Student(Long id, String name, Integer sex, Integer age, Date birthday, String address) {
		super();
		this.id = id;
		this.name = name;
		this.sex = sex;
		this.age = age;
		this.birthday = birthday;
		this.address = address;
	}
	
}

3、配置兩個不同資料來源的連線資訊。

4、自定義動態資料來源（關鍵）。 

這裡定義一個動態資料來源類，繼承自AbstractRoutingDataSource並重寫determineCurrentLookupKey方法，將資料來源的切換粒度設定為執行緒。定義兩個泛型（因為系統使用兩個資料來源）以表示資料來源的型別，並提供執行緒可見變數CONTEX_THOLDER的獲取和修改方法。

/**
 * 動態資料來源
 * @author z_hh  
 * @date 2018年11月30日
 */
public class DynamicDataSource extends AbstractRoutingDataSource {
	
	/**
	 * 本地執行緒可見變數，儲存當前執行緒使用了哪一種資料來源，初始設為Master
	 */
	private static final ThreadLocal<DatabaseType> CONTEX_THOLDER = new ThreadLocal<DatabaseType>() {
		protected DatabaseType initialValue() {
			return DatabaseType.MASTER;
		};
	};

	/**
	 * 重寫AbstractRoutingDataSource方法，Spring從這裡獲取當前執行緒的資料來源型別
	 */
	@Override
	protected Object determineCurrentLookupKey() {
		return CONTEX_THOLDER.get();
	}

	/**
	 * 資料來源型別列舉類：Master主庫，Slave從庫
	 * @author z_hh  
	 * @date 2018年11月30日
	 */
	public static enum DatabaseType {
		MASTER, SLAVE
	}

	/**
	 * 將當前執行緒資料來源型別設為Master
	 */
	public static void master() {
		CONTEX_THOLDER.set(DatabaseType.MASTER);
	}

	/**
	 * 將當前執行緒資料來源型別設為Slave
	 */
	public static void slave() {
		CONTEX_THOLDER.set(DatabaseType.SLAVE);
	}

	/**
	 * 設定當前執行緒資料來源型別
	 */
	public static void setDatabaseType(DatabaseType type) {
		CONTEX_THOLDER.set(type);
	}

	/**
	 * 獲取當前執行緒資料來源型別
	 */
	public static DatabaseType getType() {
		return CONTEX_THOLDER.get();
	}
}

5、資料來源配置（關鍵）。

這裡建立動態資料來源物件，並建立兩個型別的資料來源作為其目標資料來源，將其預設資料來源設定為Master。最後交由Spring IOC容器管理。

/**
 * DataResource配置類
 * @author z_hh  
 * @date 2018年11月30日
 */
@Configuration
public class DataSourceConf {
	
	/**
	 * 將動態資料來源注入Spring IOC容器
	 * @return
	 */
	@Bean
	public DataSource dynamicDataSource() {
		DataSource master = master();
		DataSource slave = slave();
		Map<Object, Object> targetDataSources = new HashMap<Object, Object>();
		targetDataSources.put(DynamicDataSource.DatabaseType.MASTER, master);
		targetDataSources.put(DynamicDataSource.DatabaseType.SLAVE, slave);
		DynamicDataSource dataSource = new DynamicDataSource();
		dataSource.setTargetDataSources(targetDataSources);// 該方法是AbstractRoutingDataSource的方法
		dataSource.setDefaultTargetDataSource(master);
		return dataSource;
	}

	/**
	 * 建立Master資料來源物件
	 * @return
	 */
	public DataSource master() {
		HikariDataSource ds = new HikariDataSource();
        ds.setJdbcUrl(env.getProperty("master.datasource.url"));
        ds.setUsername(env.getProperty("master.datasource.username"));
        ds.setPassword(env.getProperty("master.datasource.password"));
        ds.setDriverClassName(env.getProperty("master.datasource.driver-class-name"));
		return ds;
	}

	/**
	 * 建立Slave資料來源物件
	 * @return
	 */
	public DataSource slave() {
		HikariDataSource ds = new HikariDataSource();
        ds.setJdbcUrl(env.getProperty("slave.datasource.url"));
        ds.setUsername(env.getProperty("slave.datasource.username"));
        ds.setPassword(env.getProperty("slave.datasource.password"));
        ds.setDriverClassName(env.getProperty("slave.datasource.driver-class-name"));
		return ds;
	}

	@Autowired
	private Environment env;

}

6、定義兩個註解，分別用於使用不同型別資料來源的方法上面。

/**
 * 使用主庫的註解
 * @author z_hh  
 * @date 2018年11月30日
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Master {
}
/**
 * 使用從庫的註解
 * @author z_hh  
 * @date 2018年11月30日
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Slave {
}

7、定義Aspect切面（非常重要）。

關鍵點1：類上面使用了@Order註解，這是因為目標方法的@Transactional開啟了事務也是一個AOP切面，需要通過Order屬性去定義AOP切面的先後執行順序。 order越小，在AOP的chain中越靠前，越先執行（chain模式）。而事務切面的優先順序是預設最小的，所以我們需要將切換資料來源的操作放在事務前面。

關鍵點2：切面使用@Around註解而不是@Before註解，這是因為我們在目標方法執行前進行了資料來源切換，需要等目標方法執行完之後將其還原，恢復到之前的資料來源（具體看業務場景吧）。

/**
 * 資料來源的切入面
 * @author z_hh  
 * @date 2018年11月30日
 */
@Aspect
@Component
@Order(Ordered.LOWEST_PRECEDENCE - 1)
@Slf4j
public class DataSourceAOP {

	/**
	 * Master註解
	 * @param pjp
	 * @throws Throwable
	 */
	@Around("@annotation(cn.zhh.db.rw_separate.annotation.Master)")
	public Object setWriteDataSourceType(ProceedingJoinPoint pjp) throws Throwable {
		// 1、當前資料來源型別
		DatabaseType currentType = DynamicDataSource.getType();
		try {
			// 2、如果當前是Slave，就切換到Master
			if (Objects.equals(currentType, DatabaseType.SLAVE)) {
				DynamicDataSource.master();
				log.info("dataSource切換到：master");
			}
			// 3、執行目標方法
			return pjp.proceed();
		} catch (Throwable t) {
			log.error("切換資料來源異常！", t);
			throw t;
		} finally {
			// 4、需要將資料來源還原
			DynamicDataSource.setDatabaseType(currentType);
		}
	}

	/**
	 * Slave註解
	 * @param pjp
	 * @throws Throwable
	 */
	@Around("@annotation(cn.zhh.db.rw_separate.annotation.Slave) && [email protected](cn.zhh.db.rw_separate.annotation.Master)")
	public Object setReadDataSourceType(ProceedingJoinPoint pjp) throws Throwable {
		// 1、當前資料來源型別
		DatabaseType currentType = DynamicDataSource.getType();
		try {
			// 2、如果當前是Master，就切換到Slave
			if (Objects.equals(currentType, DatabaseType.MASTER)) {
				DynamicDataSource.slave();
				log.info("dataSource切換到：slave");
			}
			// 3、執行目標方法
			return pjp.proceed();
		} catch (Throwable t) {
			log.error("切換資料來源異常！", t);
			throw t;
		} finally {
			// 4、需要將資料來源還原
			DynamicDataSource.setDatabaseType(currentType);
		}
	}

}

8、在業務程式碼裡面使用自定義註解。

我們在寫方法save使用了@Master註解，在讀方法findById使用了@Slave方法。

/**
 * Student業務邏輯層
 * @author z_hh  
 * @date 2018年11月30日
 */
@Service
@Transactional
public class StudentServiceImpl implements StudentService {
	
	@Autowired
	private StudentDao dao;

	@Master
	@Override
	public Student save(Student student) {
		return dao.save(student);
	}

	@Override
	public void delete(Long id) {
		dao.deleteById(id);
	}

	@Slave
	@Override
	public Student findById(Long id) {
		return dao.findById(id).orElse(null);
	}

}

9、編寫Junit測試程式碼。

測試前我們確認了兩個資料庫id為1的兩條記錄的name屬性是不一樣的，所以測試通過的話說明我們的通過AOP切換資料來源功能生效了。

**
 * 測試類
 * @author z_hh  
 * @date 2018年11月30日
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class CommonTest {

	@Autowired
	private StudentService service;
	
	@Test
	public void test1() {
		// 儲存student1到Master庫，id=1，name=zhou
		Student student1 = Student.builder()
				.id(1L)
				.name("zhou")
				.sex(1)
				.age(24)
				.birthday(new Date())
				.build();
		assertNotNull(service.save(student1));
		
		// 從Slave庫獲取id=1的student2
		Student student2 = service.findById(1L);
		assertNotNull(student2);
		
		// 比較student1和student2的name，兩個庫裡面是不相等的
		assertNotEquals(student1.getName(), student2.getName());
	}
}

10、我們也可以通過打印出來的日誌證明。

可以優化的地方：

（1）可以僅用一個自定義註解，定義一個屬性用於設定需要使用的資料來源，對應的切面邏輯也要修改。

（2）@Around註解可以改用@Before和@After註解。@Before裡設定動態資料來源本地執行緒共享物件裡的值為想切換到的資料來源的邏輯名稱；@After裡將動態資料來源本地執行緒共享物件裡的值移除掉，即可恢復到之前的資料來源。

本文內容到此結束了，有什麼問題或者建議，歡迎在評論區進行探討！

相關推薦

Spring AOP實現多資料來源切換

有時候我們會遇到這樣的場景：一個應用系統中存在多個數據源，需要根據不同業務場景進行臨時切換。比如讀寫分離（也可以考慮使用Mycat等資料庫中介軟體）等。 Spring提供了動態資料來源的功能，可以讓我們實現在對資料庫操作前進行切換。 下面我們演示怎麼在專案中配置多資料來源並根據不用業務場

SpringBoot31 整合SpringJDBC、整合MyBatis、利用AOP實現多資料來源切換

  一、整合SpringJDBC 1  JDBC 　　JDBC（Java Data Base Connectivity，Java 資料庫連線）是一種用於執行 SQL 語句的 Java API，可以為多種關係資料庫提供統一訪問，它由一組用 Java 語言編寫的類和介面組成。JDBC 提

利用AbstractRoutingDataSource+AOP實現多資料來源切換

實現功能 實現基於springmvc+mybatis框架動態切換不同的資料來源。 基礎框架springmvc4+mybatis3 實現原理 主要利用了spring aop以及spring的AbstractRoutingDataSource類。

Spring中AOP方式實現多資料來源切換

spring動態配置多資料來源，即在大型應用中對資料進行切分，並且採用多個資料庫例項進行管理，這樣可以有效提高系統的水平伸縮性。而這樣的方案就會不同於常見的單一資料例項的方案，這就要程式在執行時根據當時的請求及系統狀態來動態的決定將資料儲存在哪個資料庫例項中，以及從

Spring使用Spring的AbstractRoutingDataSource實現多資料來源切換

最近因為專案需要在做兩個專案間資料同步的需求，具體是專案1的資料通過訊息佇列同步到專案2中，因為這個更新操作還涉及到更新多個庫的資料，所以就需要多資料來源切換的操作。下面就講講在Spring中如何進行資料來源切換。這裡是使用AbstractRoutingDataSource類

spring 整合mybatis——多資料來源切換（附帶定時器的配置，儲存過程連線，資料多於50條，分批進行操作）

新建com.millery.utils包在其下新建DataSourceContextHolder類 package com.millery.utils; public class DataSourceContextHolder { private

AbstractRoutingDataSource動態資料來源切換，AOP實現動態資料來源切換

AbstractRoutingDataSource動態資料來源切換 上週末，室友通宵達旦的敲程式碼處理他的多資料來源的問題，搞的非常的緊張，也和我聊了聊天，大概的瞭解了他的業務的需求。一般的情況下我們都是使用SSH或者SSM框架進行處理我們的資料來源的資

Spring(AbstractRoutingDataSource)實現動態資料來源切換

         單個數據源繫結給sessi

原理解密 → Spring AOP 實現動態資料來源（讀寫分離），底層原理是什麼

開心一刻 　　女孩睡醒玩手機，收到男孩發來一條資訊：我要去跟我喜歡的人表白了！　　女孩的心猛的一痛，回了條資訊：去吧，祝你好運！　　男孩回了句：但是我沒有勇氣說不來，怕被打！　　女孩：沒事的，我相信你！此時女孩已經傷心的流淚了　　男孩：我已經到她家門口了，不敢敲門！　　女孩擦了擦眼淚：不用怕，你是個好人，會有

ssm中多資料來源通過Spring aop 實現資料來源的動態切換

【具體步驟】1、編寫動態資料來源相關程式碼。 (1) 編寫DynamicDataSource類。 DynamicDataSource的主要作用是以Map的形式，來儲存多個數據源。 因為該類繼承了父類AbstractRoutingDataSource，在父類中，多資料來源的例項是被存放在一個名為“ta

【十七】Spring Boot 之 多資料來源（擴充套件AbstractRoutingDataSource類，實現動態資料來源。使用AOP註解動態切換資料來源）

在一個專案中操作多個不同的資料來源時，需要用到多資料來源的配置。 pom.xml <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0

Spring AOP實現註解式的Mybatis多資料來源切換

一、為什麼要使用多資料來源切換？ 多資料來源切換是為了滿足什麼業務場景？正常情況下，一個微服務或者說一個WEB專案，在使用Mybatis作為資料庫連結和操作框架的情況下通常只需要構建一個系統庫，在該系統庫建立業務表來滿足需求，當然也有分為測試庫和正式庫dev/prod,不過這倆庫的切換是使用配置

MySQL多資料來源 二(基於spring+aop實現讀寫分離)

一，為什麼要進行讀寫分離呢？ 　　因為資料庫的“寫操作”操作是比較耗時的（寫上萬條條資料到Mysql的可能要1分鐘分鐘）。但是資料庫的“讀操作”卻比“寫操作”耗時要少的多（從Mysql的讀幾萬條資料條資料可能只要十秒鐘），而我們在開發過程中大多數也是查詢操作比較多。所以讀寫分離解決的是，資料庫的

基於spring實現多資料來源通過註解切換

主要使用spring的AbstractRoutingDataSource實現，先簡單瞭解下AbstractRoutingDataSource 我們配置的多個數據源會放在AbstractRoutin

Spring Boot配置多資料來源並實現Druid自動切換

SpringBoot多資料來源切換,先上配置檔案: 1.pom: <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0"

Spring AOP實現Mysql資料庫主從切換（一主多從）

設定資料庫主從切換的原因：資料庫中經常發生的是“讀多寫少”，這樣讀操作對資料庫壓力比較大，通過採用資料庫叢集方案，  一個數據庫是主庫，負責寫；其他為從庫，負責讀，從而實現讀寫分離增大資料庫的容錯率。  那麼，對資料庫的要求是：  1. 讀庫和寫庫的資料一致；  2. 寫資料

基於Mybatis+Spring+SpringAOP實現Mybatis多資料來源切換

package com.hoo.framework.spring.interceptor; import java.lang.reflect.Proxy; import org.aopalliance.intercept.MethodInterceptor; import org.aopalliance.

MySQL多資料來源 二(基於spring+aop實現讀寫分離)

一、為什麼要進行讀寫分離呢？ 因為資料庫的“寫操作”操作是比較耗時的（寫上萬條條資料到Mysql可能要1分鐘分鐘）。但是資料庫的“讀操作”卻比“寫操作”耗時要少的多（從Mysql讀幾萬條資料條資料可能只要十秒鐘）,而我們在開發過程中大多數也是查詢操作比較多。所以讀寫分離解決

Spring Boot + Mybatis 多資料來源配置實現讀寫分離

本文來自網易雲社群作者：王超應用場景：專案中有一些報表統計與查詢功能，對資料實時性要求不高，因此考慮對報表的統計與查詢去操作slave db，減少對master的壓力。根據網上多份資料測試發現總是使用master資料來源，無法切換到slave，經過多次除錯修改現已完美通過，現

Spring實現多資料來源配置

一、前言        對於小型專案，伺服器與資料庫是可以在同一臺機子上的，但隨著業務的龐大與負責，資料庫和伺服器就會分離開來。同時隨著資料量的增大，資料庫也要分開部署到多臺機子上。 二、Spring配置檔案修改        在理論學習與實踐的差距：框架開源與不可