All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.jn.sqlhelper.datasource.supports.spring.boot.DynamicDataSourcesAutoConfiguration Maven / Gradle / Ivy

There is a newer version: 3.6.16
Show newest version
/*
 * Copyright 2020 the original author or authors.
 *
 * Licensed under the Apache, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at  http://www.gnu.org/licenses/lgpl-2.0.html
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.jn.sqlhelper.datasource.supports.spring.boot;

import com.jn.langx.util.Emptys;
import com.jn.langx.util.Objs;
import com.jn.langx.util.Strings;
import com.jn.langx.util.collection.Collects;
import com.jn.langx.util.collection.Pipeline;
import com.jn.langx.util.function.Consumer;
import com.jn.langx.util.function.Consumer2;
import com.jn.langx.util.function.Function;
import com.jn.langx.util.function.Predicate;
import com.jn.sqlhelper.common.security.DriverPropertiesCipher;
import com.jn.sqlhelper.datasource.*;
import com.jn.sqlhelper.datasource.config.DataSourceProperties;
import com.jn.sqlhelper.datasource.config.DynamicDataSourcesProperties;
import com.jn.sqlhelper.datasource.config.DynamicDataSourcesPropertiesCustomizer;
import com.jn.sqlhelper.datasource.factory.CentralizedDataSourceFactory;
import com.jn.sqlhelper.datasource.key.DataSourceKey;
import com.jn.sqlhelper.datasource.key.MethodDataSourceKeyRegistry;
import com.jn.sqlhelper.datasource.key.MethodInvocationDataSourceKeySelector;
import com.jn.sqlhelper.datasource.key.WriteOperationMethodMatcher;
import com.jn.sqlhelper.datasource.key.parser.DataSourceKeyAnnotationParser;
import com.jn.sqlhelper.datasource.key.router.DataSourceKeyRouter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.config.ListFactoryBean;
import org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

import javax.sql.DataSource;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;

/**
 * @since 3.4.0
 */
@Configuration
@Import({DynamicDataSourceInfrastructureConfiguration.class, DynamicDataSourceLoadBalanceAutoConfiguration.class})
@AutoConfigureAfter({DataSourceAutoConfiguration.class})
@ConditionalOnProperty(name = "sqlhelper.dynamic-datasource.enabled", havingValue = "true", matchIfMissing = false)
public class DynamicDataSourcesAutoConfiguration {
    private static final Logger logger = LoggerFactory.getLogger(DynamicDataSourcesAutoConfiguration.class);

    /**
     * @since 3.4.0
     */
    @Bean(name = "dataSourcesFactoryBean")
    public ListFactoryBean dataSourcesFactoryBean(
            // 这里不用,只是为了控制 该类要在 Spring 内置数据源初始化之前执行
            DriverPropertiesCipher cipherer,
            final CentralizedDataSourceFactory centralizedDataSourceFactory,
            final DynamicDataSourcesProperties dynamicDataSourcesProperties,
            final ObjectProvider> customizersObjectProvider,
            // 该参数只是为了兼容Spring Boot 默认的 DataSource配置而已
            ObjectProvider springBootOriginDataSourceProvider,
            ObjectProvider builtInDataSourceProperties,
            ObjectProvider dataSourceInitializerFactoryObjectProvider,
            final ApplicationContext applicationContext) {

        logger.info("===[SQLHelper & Dynamic DataSource]=== the dynamic datasource is enabled");

        final List dataSources = Collects.emptyArrayList();
        // 处理 Spring Boot 默认数据源
        DataSource springBootOriginDataSource = springBootOriginDataSourceProvider.getIfAvailable();
        boolean isTestDB = true;
        if (springBootOriginDataSource != null) {
            org.springframework.boot.autoconfigure.jdbc.DataSourceProperties properties = builtInDataSourceProperties.getObject();
            if (Objs.equals(properties.determineUrl(), properties.getUrl())) {
                isTestDB = false;
            }
        }

        // 自定义数据源配置  @since 3.4.6
        final List customizers = customizersObjectProvider.getIfAvailable();
        Collects.forEach(customizers, new Consumer() {
            @Override
            public void accept(DynamicDataSourcesPropertiesCustomizer customizer) {
                customizer.customize(dynamicDataSourcesProperties);
            }
        });

        // create datasource
        List dataSourcePropertiesList = dynamicDataSourcesProperties.getDatasources();
        // spring bean factory
        final AbstractAutowireCapableBeanFactory beanFactory = ((AbstractAutowireCapableBeanFactory) applicationContext.getAutowireCapableBeanFactory());
        Pipeline.of(dataSourcePropertiesList).forEach(new Consumer() {
            @Override
            public void accept(DataSourceProperties dataSourceProperties) {
                NamedDataSource namedDataSource = centralizedDataSourceFactory.get(dataSourceProperties);
                if (namedDataSource != null) {
                    // 注册 DataSource对象到 Spring 容器中
                    String beanName = namedDataSource.getDataSourceKey().getId();
                    beanFactory.registerSingleton(beanName, namedDataSource);
                    logger.info("===[SQLHelper & Dynamic DataSource]=== register jdbc datasource bean {} to spring bean factory", beanName);
                    dataSources.add(namedDataSource);
                }
            }
        });

        if (!isTestDB) {
            DataSourceProperties dataSourceProperties = SpringDataSourcePropertiesAdapter.adapt(builtInDataSourceProperties.getObject());
            NamedDataSource namedDataSource = DataSources.toNamedDataSource(springBootOriginDataSource, dataSourceProperties.getName(), dataSourceProperties);
            if (dataSources.isEmpty()) {
                namedDataSource.setName(DataSources.DATASOURCE_PRIMARY_NAME);
            }
            logger.info("===[SQLHelper & Dynamic DataSource]=== register spring boot datasource {} to datasource registry", namedDataSource.getDataSourceKey());
            centralizedDataSourceFactory.getRegistry().register(namedDataSource);
            dataSources.add(namedDataSource);
        }

        if (logger.isInfoEnabled() && !dataSources.isEmpty()) {
            StringBuilder log = new StringBuilder(256);
            log.append("===[SQLHelper & Dynamic DataSource]=== will load dataSources:\n\t");
            Collection keys = Collects.map(dataSources, new Function() {
                @Override
                public DataSourceKey apply(NamedDataSource namedDataSource) {
                    return namedDataSource.getDataSourceKey();
                }
            });
            log.append(Strings.join("\n\t", keys));
            logger.info(log.toString());
        }

        final DataSourceInitializerFactory initializerFactory = dataSourceInitializerFactoryObjectProvider.getIfAvailable();
        if (initializerFactory != null) {
            Collects.forEach(dataSources, new Consumer() {
                @Override
                public void accept(NamedDataSource dataSource) {
                    DataSourceInitializer initializer = initializerFactory.get(dataSource);
                    initializer.setDataSource(dataSource);
                    initializer.init();
                }
            });
        }

        ListFactoryBean dataSourcesFactoryBean = new ListFactoryBean();
        dataSourcesFactoryBean.setTargetListClass(ArrayList.class);
        dataSourcesFactoryBean.setSourceList(dataSources);
        return dataSourcesFactoryBean;
    }


    @Bean
    public MethodDataSourceKeyRegistry dataSourceKeyRegistry(ObjectProvider> dataSourceKeyAnnotationParsersProvider) {
        final MethodDataSourceKeyRegistry registry = new MethodDataSourceKeyRegistry();
        List parsers = dataSourceKeyAnnotationParsersProvider.getIfAvailable();
        Collects.forEach(parsers, new Consumer() {
            @Override
            public void accept(DataSourceKeyAnnotationParser dataSourceKeyAnnotationParser) {
                registry.registerDataSourceKeyParser(dataSourceKeyAnnotationParser);
            }
        });
        return registry;
    }

    @Bean
    public MethodInvocationDataSourceKeySelector dataSourceKeySelector(
            final DataSourceRegistry registry,
            MethodDataSourceKeyRegistry keyRegistry,
            ObjectProvider> routersProvider,
            DynamicDataSourcesProperties dataSourcesProperties,
            // 用于控制在 DataSource初始化之后来执行
            @Qualifier("dataSourcesFactoryBean")
                    ListFactoryBean dataSourcesFactoryBean) {

        final MethodInvocationDataSourceKeySelector selector = new MethodInvocationDataSourceKeySelector();

        selector.setDataSourceKeyRegistry(keyRegistry);
        selector.setDataSourceRegistry(registry);

        List routers = routersProvider.getIfAvailable();
        selector.registerRouters(routers);

        // 处理 default router
        final String defaultRouterName = dataSourcesProperties.getDefaultRouter();
        if (Emptys.isNotEmpty(defaultRouterName)) {
            DataSourceKeyRouter defaultRouter = Collects.findFirst(routers, new Predicate() {
                @Override
                public boolean test(DataSourceKeyRouter dataSourceKeyRouter) {
                    return defaultRouterName.equals(dataSourceKeyRouter.getName());
                }
            });
            if (defaultRouter != null) {
                selector.setDefaultRouter(defaultRouter);
            }
        }

        // 指定分配关系
        Map groupToRoutersMap = dataSourcesProperties.getGroupRouters();
        Collects.forEach(groupToRoutersMap, new Consumer2() {
            @Override
            public void accept(String group, String router) {
                selector.allocateRouter(group, router);
            }
        });

        final Map groupToWritePattern = dataSourcesProperties.getGroupWriterPatternMap();
        Collects.forEach(groupToWritePattern, new Consumer2() {
            @Override
            public void accept(String group, String writePattern) {
                WriteOperationMethodMatcher writeOperationMethodMatcher = new WriteOperationMethodMatcher(writePattern);
                selector.allocateWriteMatcher(group, writeOperationMethodMatcher);
            }
        });

        selector.init();

        return selector;
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy