集成ApiBoot DataSource Switch 多数据源切换

Author: hengboy

api-boot-project/api-boot-plugins/api-boot-plugin-datasource-switch/pom.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>api-boot-plugins</artifactId>
+        <groupId>org.minbox.framework</groupId>
+        <version>1.0.3.RELEASE</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>api-boot-plugin-datasource-switch</artifactId>
+    <properties>
+        <main.basedir>${basedir}/../../..</main.basedir>
+    </properties>
+    <description>
+        ApiBoot DataSource Switch
+        数据源切换：
+        1. 多数据源配置
+        2. 数据源路由器实现
+        3. 配置使用指定数据源
+        4. 动态使用指定数据源
+        5. 动态创建数据源
+    </description>
+    <dependencies>
+        <!--ApiBoot Plugin-->
+        <dependency>
+            <groupId>org.minbox.framework</groupId>
+            <artifactId>api-boot-plugin</artifactId>
+        </dependency>
+        <!--HikariCP DataSource-->
+        <dependency>
+            <groupId>com.zaxxer</groupId>
+            <artifactId>HikariCP</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <!--Druid DataSource-->
+        <dependency>
+            <groupId>com.alibaba</groupId>
+            <artifactId>druid</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <!--SpringBoot Jdbc-->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-jdbc</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+    </dependencies>
+</project>

api-boot-project/api-boot-plugins/api-boot-plugin-datasource-switch/src/main/java/org/minbox/framework/api/boot/plugin/datasource/ApiBootDataSource.java

@@ -0,0 +1,26 @@
+package org.minbox.framework.api.boot.plugin.datasource;
+
+import org.minbox.framework.api.boot.common.exception.ApiBootException;
+
+import javax.sql.DataSource;
+
+/**
+ * Api Boot DataSource 接口定义
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-04-01 14:55
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+public interface ApiBootDataSource extends DataSource {
+    /**
+     * Create new data source Instance
+     *
+     * @return DataSource
+     * @throws ApiBootException 异常信息
+     */
+    DataSource build() throws ApiBootException;
+}

api-boot-project/api-boot-plugins/api-boot-plugin-datasource-switch/src/main/java/org/minbox/framework/api/boot/plugin/datasource/ApiBootDataSourceFactoryBean.java

@@ -0,0 +1,76 @@
+package org.minbox.framework.api.boot.plugin.datasource;
+
+import org.minbox.framework.api.boot.plugin.datasource.config.DataSourceConfig;
+import org.minbox.framework.api.boot.plugin.datasource.config.DataSourceDruidConfig;
+import org.minbox.framework.api.boot.plugin.datasource.config.DataSourceHikariConfig;
+import org.minbox.framework.api.boot.plugin.datasource.support.ApiBootBasicDataSource;
+import org.minbox.framework.api.boot.plugin.datasource.support.ApiBootDruidDataSource;
+import org.minbox.framework.api.boot.plugin.datasource.support.ApiBootHikariDataSource;
+
+import javax.sql.DataSource;
+
+/**
+ * ApiBoot DataSource Switch
+ * data source factory
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-04-01 11:32
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+public class ApiBootDataSourceFactoryBean {
+    /**
+     * create new dataSource instance
+     *
+     * @param config dataSource config
+     * @return dataSource Instance
+     */
+    public DataSource newDataSource(DataSourceConfig config) {
+        DataSource dataSource = null;
+        // not setting data source type class name
+        if (config.getDataSourceType() == null) {
+            // use druid data source
+            if (checkUseAppointDataSource(DataSourceTypeNames.DRUID)) {
+                dataSource = new ApiBootDruidDataSource((DataSourceDruidConfig) config);
+            }
+            // use Hikari data source
+            else if (checkUseAppointDataSource(DataSourceTypeNames.HIKARI)) {
+                dataSource = new ApiBootHikariDataSource((DataSourceHikariConfig) config);
+            }
+        }
+        // setting data source type class name
+        else {
+            // druid data source
+            if (DataSourceTypeNames.DRUID.equals(config.getDataSourceType().getName())) {
+                dataSource = new ApiBootDruidDataSource((DataSourceDruidConfig) config);
+            }
+            // Hikari data source
+            else if (DataSourceTypeNames.HIKARI.equals(config.getDataSourceType().getName())) {
+                dataSource = new ApiBootHikariDataSource((DataSourceHikariConfig) config);
+            }
+        }
+        // use default basic data source
+        if (dataSource == null) {
+            dataSource = new ApiBootBasicDataSource(config);
+        }
+        return dataSource;
+    }
+
+    /**
+     * check project is use appoint data source
+     *
+     * @return true/false
+     */
+    private boolean checkUseAppointDataSource(String dataSourceTypeName) {
+        boolean isUseCheck = true;
+        try {
+            Class.forName(dataSourceTypeName);
+        } catch (ClassNotFoundException e) {
+            isUseCheck = false;
+        }
+        return isUseCheck;
+    }
+}

api-boot-project/api-boot-plugins/api-boot-plugin-datasource-switch/src/main/java/org/minbox/framework/api/boot/plugin/datasource/DataSourceTypeNames.java

@@ -0,0 +1,23 @@
+package org.minbox.framework.api.boot.plugin.datasource;
+
+/**
+ * ApiBoot DataSource Switch 所支持的数据源类型限定名
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-04-01 11:33
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+public interface DataSourceTypeNames {
+    /**
+     * Druid 数据源类全限定路径
+     */
+    String DRUID = "com.alibaba.druid.pool.DruidDataSource";
+    /**
+     * Hikari 数据源全限定路径
+     */
+    String HIKARI = "com.zaxxer.hikari.HikariDataSource";
+}

api-boot-project/api-boot-plugins/api-boot-plugin-datasource-switch/src/main/java/org/minbox/framework/api/boot/plugin/datasource/annotation/DataSourceSwitch.java

@@ -0,0 +1,26 @@
+package org.minbox.framework.api.boot.plugin.datasource.annotation;
+
+import java.lang.annotation.*;
+
+/**
+ * data source switch annotation
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-04-01 16:23
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.TYPE, ElementType.METHOD})
+@Documented
+public @interface DataSourceSwitch {
+    /**
+     * data source pool name
+     *
+     * @return pool name
+     */
+    String value();
+}

api-boot-project/api-boot-plugins/api-boot-plugin-datasource-switch/src/main/java/org/minbox/framework/api/boot/plugin/datasource/aop/advistor/ApiBootDataSourceSwitchAdvisor.java

@@ -0,0 +1,76 @@
+package org.minbox.framework.api.boot.plugin.datasource.aop.advistor;
+
+import org.aopalliance.aop.Advice;
+import org.minbox.framework.api.boot.plugin.datasource.annotation.DataSourceSwitch;
+import org.minbox.framework.api.boot.plugin.datasource.aop.interceptor.ApiBootDataSourceSwitchAnnotationInterceptor;
+import org.springframework.aop.Pointcut;
+import org.springframework.aop.support.AbstractPointcutAdvisor;
+import org.springframework.aop.support.ComposablePointcut;
+import org.springframework.aop.support.annotation.AnnotationMatchingPointcut;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.BeanFactory;
+import org.springframework.beans.factory.BeanFactoryAware;
+import org.springframework.util.Assert;
+
+/**
+ * ApiBoot DataSource Switch
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-04-01 16:29
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+public class ApiBootDataSourceSwitchAdvisor extends AbstractPointcutAdvisor implements BeanFactoryAware {
+
+    private Advice advice;
+    private Pointcut pointcut;
+    private BeanFactory beanFactory;
+
+    /**
+     * init config
+     */
+    public ApiBootDataSourceSwitchAdvisor(ApiBootDataSourceSwitchAnnotationInterceptor apiBootDataSourceSwitchAnnotationInterceptor) {
+        // build pointcut instance
+        this.pointcut = buildPointcut();
+        // build advice instance
+        this.advice = apiBootDataSourceSwitchAnnotationInterceptor;
+        if (this.advice instanceof BeanFactoryAware) {
+            ((BeanFactoryAware) this.advice).setBeanFactory(beanFactory);
+        }
+    }
+
+    @Override
+    public Pointcut getPointcut() {
+        Assert.notNull(this.pointcut, "pointcut is required.");
+        return this.pointcut;
+    }
+
+    @Override
+    public Advice getAdvice() {
+        Assert.notNull(this.advice, "advice is required.");
+        return this.advice;
+    }
+
+    @Override
+    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
+        this.beanFactory = beanFactory;
+    }
+
+    /**
+     * build pointcut instance
+     */
+    private Pointcut buildPointcut() {
+        // class
+        Pointcut cpc = new AnnotationMatchingPointcut(DataSourceSwitch.class, true);
+        // method
+        Pointcut mpc = AnnotationMatchingPointcut.forMethodAnnotation(DataSourceSwitch.class);
+
+        //union
+        ComposablePointcut pointcut = new ComposablePointcut(cpc);
+        return pointcut.union(mpc);
+    }
+
+}

api-boot-project/api-boot-plugins/api-boot-plugin-datasource-switch/src/main/java/org/minbox/framework/api/boot/plugin/datasource/aop/interceptor/ApiBootDataSourceSwitchAnnotationInterceptor.java

@@ -0,0 +1,50 @@
+package org.minbox.framework.api.boot.plugin.datasource.aop.interceptor;
+
+import org.aopalliance.intercept.MethodInterceptor;
+import org.aopalliance.intercept.MethodInvocation;
+import org.minbox.framework.api.boot.plugin.datasource.annotation.DataSourceSwitch;
+import org.minbox.framework.api.boot.plugin.datasource.routing.DataSourceContextHolder;
+import org.springframework.aop.support.AopUtils;
+import org.springframework.core.BridgeMethodResolver;
+import org.springframework.util.ClassUtils;
+
+import java.lang.reflect.Method;
+
+/**
+ * ApiBoot DataSource Advice
+ * use spring aop
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-04-01 16:44
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+public class ApiBootDataSourceSwitchAnnotationInterceptor implements MethodInterceptor {
+
+    @Override
+    public Object invoke(MethodInvocation invocation) throws Throwable {
+        try {
+            Class<?> targetClass = (invocation.getThis() != null ? AopUtils.getTargetClass(invocation.getThis()) : null);
+            Method specificMethod = ClassUtils.getMostSpecificMethod(invocation.getMethod(), targetClass);
+            Method userDeclaredMethod = BridgeMethodResolver.findBridgedMethod(specificMethod);
+            // get class declared DataSourceSwitch annotation
+            DataSourceSwitch dataSourceSwitch = targetClass.getDeclaredAnnotation(DataSourceSwitch.class);
+            if (dataSourceSwitch == null) {
+                // get declared DataSourceSwitch annotation
+                dataSourceSwitch = userDeclaredMethod.getDeclaredAnnotation(DataSourceSwitch.class);
+            }
+            if (dataSourceSwitch != null) {
+                // setting current thread use data source pool name
+                DataSourceContextHolder.set(dataSourceSwitch.value());
+            }
+            return invocation.proceed();
+        } finally {
+            // remove current thread use datasource pool name
+            DataSourceContextHolder.remove();
+        }
+
+    }
+}

api-boot-project/api-boot-plugins/api-boot-plugin-datasource-switch/src/main/java/org/minbox/framework/api/boot/plugin/datasource/config/DataSourceConfig.java

@@ -0,0 +1,51 @@
+package org.minbox.framework.api.boot.plugin.datasource.config;
+
+import lombok.Data;
+
+import javax.sql.DataSource;
+
+/**
+ * data source basic config parameter
+ * for example：
+ * username、url、password
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-04-01 11:41
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+@Data
+public class DataSourceConfig {
+    /**
+     * data source pool name
+     */
+    private String poolName = "master";
+    /**
+     * data source type
+     *
+     * @see org.minbox.framework.api.boot.plugin.datasource.DataSourceTypeNames
+     */
+    private Class<? extends DataSource> dataSourceType;
+    /**
+     * driver class name
+     * if don't config will use default values
+     * MySQL8.0+ -> com.mysql.cj.jdbc.Driver（SpringBoot2.x recommended use）
+     * MySQL8.0- -> com.mysql.jdbc.Driver
+     */
+    private String driverClassName = "com.mysql.cj.jdbc.Driver";
+    /**
+     * database connection url
+     */
+    private String url;
+    /**
+     * database connection username
+     */
+    private String username;
+    /**
+     * database connection password
+     */
+    private String password;
+}