多数据源
回顾
通过前面文章的介绍，目前已经支持主流数据库，包括 MySql，PostgreSql，Oracle，Microsoft SQL Server 等，通过配置零代码实现了 CRUD 增删改查 RESTful API。采用抽象工厂设计模式，可以无缝切换不同类型的数据库。但是如果需要同时支持不同类型的数据库，如何通过配置进行管理呢？这时候引入多数据源功能就很有必要了。
简介
利用 spring boot 多数据源功能，可以同时支持不同类型数据库 mysql，oracle，postsql，sql server 等，以及相同类型数据库不同的 schema。零代码同时生成不同类型数据库增删改查 RESTful api，且支持同一接口中跨库数据访问二次开发。
UI 界面
配置一个数据源，多个从数据源，每一个数据源相互独立配置和访问。
核心原理
配置数据库连接串
配置 application.properties，spring.datasource 为默认主数据源，spring.datasource.hikari.data-sources[]数组为从数据源
#primaryspring.datasource.driverClassName=com.mysql.cj.jdbc.Driverspring.datasource.url=jdbc:mysql://localhost:3306/crudapi?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false&allowPublicKeyRetrieval=truespring.datasource.username=rootspring.datasource.password=root
#postgresqlspring.datasource.hikari.data-sources[0].postgresql.driverClassName=org.postgresql.Driverspring.datasource.hikari.data-sources[0].postgresql.url=jdbc:postgresql://localhost:5432/crudapispring.datasource.hikari.data-sources[0].postgresql.username=postgresspring.datasource.hikari.data-sources[0].postgresql.password=postgres
#sqlserverspring.datasource.hikari.data-sources[1].sqlserver.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriverspring.datasource.hikari.data-sources[1].sqlserver.url=jdbc:sqlserver://localhost:1433;SelectMethod=cursor;DatabaseName=crudapispring.datasource.hikari.data-sources[1].sqlserver.username=saspring.datasource.hikari.data-sources[1].sqlserver.password=Mssql1433
#oraclespring.datasource.hikari.data-sources[2].oracle.url=jdbc:oracle:thin:@//localhost:1521/XEPDB1spring.datasource.hikari.data-sources[2].oracle.driverClassName=oracle.jdbc.OracleDriverspring.datasource.hikari.data-sources[2].oracle.username=crudapispring.datasource.hikari.data-sources[2].oracle.password=crudapi
#mysqlspring.datasource.hikari.data-sources[3].mysql.driverClassName=com.mysql.cj.jdbc.Driverspring.datasource.hikari.data-sources[3].mysql.url=jdbc:mysql://localhost:3306/crudapi2?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false&allowPublicKeyRetrieval=truespring.datasource.hikari.data-sources[3].mysql.username=rootspring.datasource.hikari.data-sources[3].mysql.password=root
复制代码
动态数据源——DynamicDataSource
Spring boot 提供了抽象类 AbstractRoutingDataSource，复写接口 determineCurrentLookupKey， 可以在执行查询之前，设置使用的数据源，从而实现动态切换数据源。
public class DynamicDataSource extends AbstractRoutingDataSource { @Override protected Object determineCurrentLookupKey() { return DataSourceContextHolder.getDataSource(); }}
复制代码
数据源 Context——DataSourceContextHolder
默认主数据源名称为 datasource，从数据源名称保存在 ThreadLocal 变量 CONTEXT_HOLDER 里面，ThreadLocal 叫做线程变量, 意思是 ThreadLocal 中填充的变量属于当前线程, 该变量对其他线程而言是隔离的, 也就是说该变量是当前线程独有的变量。
在 RestController 里面根据需要提前设置好当前需要访问的数据源 key，即调用 setDataSource 方法，访问数据的时候调用 getDataSource 方法获取到数据源 key，最终传递给 DynamicDataSource。
public class DataSourceContextHolder { //默认数据源primary=dataSource private static final String DEFAULT_DATASOURCE = "dataSource";
//保存线程连接的数据源 private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();
private static final ThreadLocal<String> HEADER_HOLDER = new ThreadLocal<>();
public static String getDataSource() { String dataSoure = CONTEXT_HOLDER.get(); if (dataSoure != null) { return dataSoure; } else { return DEFAULT_DATASOURCE; } }
public static void setDataSource(String key) { if ("primary".equals(key)) { key = DEFAULT_DATASOURCE; } CONTEXT_HOLDER.set(key); }
public static void cleanDataSource() { CONTEXT_HOLDER.remove(); }
public static void setHeaderDataSource(String key) { HEADER_HOLDER.set(key); }
public static String getHeaderDataSource() { String dataSoure = HEADER_HOLDER.get(); if (dataSoure != null) { return dataSoure; } else { return DEFAULT_DATASOURCE; } }}
复制代码
动态数据库提供者——DynamicDataSourceProvider
程序启动时候，读取配置文件 application.properties 中数据源信息，构建 DataSource 并通过接口 setTargetDataSources 设置从数据源。数据源的 key 和 DataSourceContextHolder 中 key 一一对应
@Component@EnableConfigurationProperties(DataSourceProperties.class)@ConfigurationProperties(prefix = "spring.datasource.hikari")public class DynamicDataSourceProvider implements DataSourceProvider { @Autowired private DynamicDataSource dynamicDataSource;
private List<Map<String, DataSourceProperties>> dataSources;
private Map<Object,Object> targetDataSourcesMap;
@Resource private DataSourceProperties dataSourceProperties;
private DataSource buildDataSource(DataSourceProperties prop) { DataSourceBuilder<?> builder = DataSourceBuilder.create(); builder.driverClassName(prop.getDriverClassName()); builder.username(prop.getUsername()); builder.password(prop.getPassword()); builder.url(prop.getUrl()); return builder.build(); }
@Override public List<DataSource> provide() { Map<Object,Object> targetDataSourcesMap = new HashMap<>(); List<DataSource> res = new ArrayList<>(); if (dataSources != null) { dataSources.forEach(map -> { Set<String> keys = map.keySet(); keys.forEach(key -> { DataSourceProperties properties = map.get(key); DataSource dataSource = buildDataSource(properties); targetDataSourcesMap.put(key, dataSource);
}); });
//更新dynamicDataSource this.targetDataSourcesMap = targetDataSourcesMap; dynamicDataSource.setTargetDataSources(targetDataSourcesMap); dynamicDataSource.afterPropertiesSet(); }
return res; }
@PostConstruct public void init() { provide(); }
public List<Map<String, DataSourceProperties>> getDataSources() { return dataSources; }
public void setDataSources(List<Map<String, DataSourceProperties>> dataSources) { this.dataSources = dataSources; }
public List<Map<String, String>> getDataSourceNames() { List<Map<String, String>> dataSourceNames = new ArrayList<Map<String, String>>(); Map<String, String> dataSourceNameMap = new HashMap<String, String>(); dataSourceNameMap.put("name", "primary"); dataSourceNameMap.put("caption", "主数据源"); dataSourceNameMap.put("database", parseDatabaseName(dataSourceProperties)); dataSourceNames.add(dataSourceNameMap);
if (dataSources != null) { dataSources.forEach(map -> { Set<Map.Entry<String, DataSourceProperties>> entrySet = map.entrySet(); for (Map.Entry<String, DataSourceProperties> entry : entrySet) { Map<String, String> t = new HashMap<String, String>(); t.put("name", entry.getKey()); t.put("caption", entry.getKey()); DataSourceProperties p = entry.getValue(); t.put("database", parseDatabaseName(p));
dataSourceNames.add(t); } }); }
return dataSourceNames; }
public String getDatabaseName() { List<Map<String, String>> dataSourceNames = this.getDataSourceNames(); String dataSource = DataSourceContextHolder.getDataSource();
Optional<Map<String, String>> op = dataSourceNames.stream() .filter(t -> t.get("name").toString().equals(dataSource)) .findFirst(); if (op.isPresent()) { return op.get().get("database"); } else { return dataSourceNames.stream() .filter(t -> t.get("name").toString().equals("primary")) .findFirst().get().get("database"); } }
private String parseDatabaseName(DataSourceProperties p) { String url = p.getUrl(); String databaseName = ""; if (url.toLowerCase().indexOf("databasename") >= 0) { String[] urlArr = p.getUrl().split(";"); for (String u : urlArr) { if (u.toLowerCase().indexOf("databasename") >= 0) { String[] uArr = u.split("="); databaseName = uArr[uArr.length - 1]; } } } else { String[] urlArr = p.getUrl().split("\\?")[0].split("/"); databaseName = urlArr[urlArr.length - 1]; }
return databaseName; }
public Map<Object,Object> getTargetDataSourcesMap() { return targetDataSourcesMap; }}
复制代码
动态数据源配置——DynamicDataSourceConfig
首先取消系统自动数据库配置，设置 exclude = { DataSourceAutoConfiguration.class }
@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class })public class ServiceApplication { public static void main(String[] args) { SpringApplication.run(ServiceApplication.class, args); }}
复制代码
然后自定义 Bean，分别定义主数据源 dataSource 和动态数据源 dynamicDataSource，并且注入到 JdbcTemplate，NamedParameterJdbcTemplate，和 DataSourceTransactionManager 中，在访问数据时候自动识别对应的数据源。
//数据源配置类@Configuration@EnableConfigurationProperties(DataSourceProperties.class)public class DynamicDataSourceConfig { private static final Logger log = LoggerFactory.getLogger(DynamicDataSourceConfig.class);
@Resource private DataSourceProperties dataSourceProperties;
@Bean(name = "dataSource") public DataSource getDataSource(){ DataSourceBuilder<?> builder = DataSourceBuilder.create(); builder.driverClassName(dataSourceProperties.getDriverClassName()); builder.username(dataSourceProperties.getUsername()); builder.password(dataSourceProperties.getPassword()); builder.url(dataSourceProperties.getUrl()); return builder.build(); }
@Primary //当相同类型的实现类存在时，选择该注解标记的类 @Bean("dynamicDataSource") public DynamicDataSource dynamicDataSource(){ DynamicDataSource dynamicDataSource = new DynamicDataSource(); //默认数据源 dynamicDataSource.setDefaultTargetDataSource(getDataSource());
Map<Object,Object> targetDataSourcesMap = new HashMap<>(); dynamicDataSource.setTargetDataSources(targetDataSourcesMap); return dynamicDataSource; }
//事务管理器DataSourceTransactionManager构造参数需要DataSource //这里可以看到我们给的是dynamicDS这个bean @Bean public PlatformTransactionManager transactionManager(){ return new DataSourceTransactionManager(dynamicDataSource()); }
//这里的JdbcTemplate构造参数同样需要一个DataSource,为了实现数据源切换查询， //这里使用的也是dynamicDS这个bean @Bean(name = "jdbcTemplate") public JdbcTemplate getJdbc(){ return new JdbcTemplate(dynamicDataSource()); }
//这里的JdbcTemplate构造参数同样需要一个DataSource,为了实现数据源切换查询， //这里使用的也是dynamicDS这个bean @Bean(name = "namedParameterJdbcTemplate") public NamedParameterJdbcTemplate getNamedJdbc(){ return new NamedParameterJdbcTemplate(dynamicDataSource()); }}
复制代码
请求头过滤器——HeadFilter
拦截所有 http 请求，从 header 里面解析出当前需要访问的数据源，然后设置到线程变量 HEADER_HOLDER 中。
@WebFilter(filterName = "headFilter", urlPatterns = "/*")public class HeadFilter extends OncePerRequestFilter { private static final Logger log = LoggerFactory.getLogger(HeadFilter.class);
@Override protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException { if (!"/api/auth/login".equals(request.getRequestURI()) && !"/api/auth/jwt/login".equals(request.getRequestURI()) && !"/api/auth/logout".equals(request.getRequestURI()) && !"/api/metadata/dataSources".equals(request.getRequestURI())) { String dataSource = request.getParameter("dataSource"); HeadRequestWrapper headRequestWrapper = new HeadRequestWrapper(request); if (StringUtils.isEmpty(dataSource)) { dataSource = headRequestWrapper.getHeader("dataSource"); if (StringUtils.isEmpty(dataSource)) { dataSource = "primary"; headRequestWrapper.addHead("dataSource", dataSource); } }
DataSourceContextHolder.setHeaderDataSource(dataSource);
// finish filterChain.doFilter(headRequestWrapper, response); } else { filterChain.doFilter(request, response); } }}
复制代码
实际应用
前面动态数据源配置准备工作已经完成，最后我们定义切面 DataSourceAspect
@Aspectpublic class DataSourceAspect { private static final Logger log = LoggerFactory.getLogger(DataSourceAspect.class);
@Pointcut("within(cn.crudapi.api.controller..*)") public void applicationPackagePointcut() { }
@Around("applicationPackagePointcut()") public Object dataSourceAround(ProceedingJoinPoint joinPoint) throws Throwable { String dataSource = DataSourceContextHolder.getHeaderDataSource(); DataSourceContextHolder.setDataSource(dataSource); try { return joinPoint.proceed(); } finally { DataSourceContextHolder.cleanDataSource(); } }}
复制代码
在 API 对应的 controller 中拦截，获取当前的请求头数据源 key，然后执行 joinPoint.proceed()，最后再恢复数据源。当然在 service 内部还可以多次切换数据源，只需要调用 DataSourceContextHolder.setDataSource()即可。比如可以从 mysql 数据库读取数据，然后保存到 oracle 数据库中。
前端集成
在请求头里面设置 dataSource 为对应的数据源，比如 primary 表示主数据源，postgresql 表示从数据源 postgresql，具体可以名称和 application.properties 配置保持一致。
首先调用的地方配置 dataSource
const table = { list: function(dataSource, tableName, page, rowsPerPage, search, query, filter) { return axiosInstance.get("/api/business/" + tableName, { params: { offset: (page - 1) * rowsPerPage, limit: rowsPerPage, search: search, ...query, filter: filter }, dataSource: dataSource } ); },}
复制代码
然后在 axios 里面统一拦截配置
axiosInstance.interceptors.request.use( function(config) { if (config.dataSource) { console.log("config.dataSource = " + config.dataSource); config.headers["dataSource"] = config.dataSource; }
return config; }, function(error) { return Promise.reject(error); });
复制代码
效果如下
小结
本文主要介绍了多数据源功能，在同一个 Java 程序中，通过多数据源功能，不需要一行代码，我们就可以得到不同数据库的基本 crud 功能，包括 API 和 UI。
crudapi 简介
crudapi 是 crud+api 组合，表示增删改查接口，是一款零代码可配置的产品。使用 crudapi 可以告别枯燥无味的增删改查代码，让您更加专注业务，节约大量成本，从而提高工作效率。crudapi 的目标是让处理数据变得更简单，所有人都可以免费使用！无需编程，通过配置自动生成 crud 增删改查 RESTful API，提供后台 UI 管理业务数据。基于主流的开源框架，拥有自主知识产权，支持二次开发。
demo 演示
crudapi 属于产品级的零代码平台，不同于自动代码生成器，不需要生成 Controller、Service、Repository、Entity 等业务代码，程序运行起来就可以使用，真正 0 代码，可以覆盖基本的和业务无关的 CRUD RESTful API。
官网地址：https://crudapi.cn
测试地址：https://demo.crudapi.cn/crudapi/login
附源码地址
GitHub 地址
https://github.com/crudapi/crudapi-admin-web
Gitee 地址
https://gitee.com/crudapi/crudapi-admin-web
由于网络原因，GitHub 可能速度慢，改成访问 Gitee 即可，代码同步更新。
评论