diff --git a/Issues.md b/Issues.md index c49864e..5804667 100644 --- a/Issues.md +++ b/Issues.md @@ -124,7 +124,7 @@ The dependencies of some of the beans in the application context form a cycle: ↓ productService (field private cn.com.hellowood.dynamicdatasource.mapper.ProductDao cn.com.hellowood.dynamicdatasource.service.ProductService.productDao) ↓ - productDao defined in file [/Users/hellowoodes/Downloads/Dev/SpringBoot/DynamicDataSource/out/production/classes/cn/com/hellowood/dynamicdatasource/mapper/ProductDao.class] + productDao defined in file [/Users/hehuimin/Downloads/Dev/SpringBoot/DynamicDataSource/out/production/classes/cn/com/hellowood/dynamicdatasource/mapper/ProductDao.class] ↓ sqlSessionFactoryBean defined in class path resource [cn/com/hellowood/dynamicdatasource/configuration/DataSourceConfigurer.class] ┌─────┐ diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, 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.apache.org/licenses/LICENSE-2.0 - - 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. diff --git a/README.md b/README.md index 87f48a5..d3a0102 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ # Spring Boot 和 MyBatis 实现多数据源、动态数据源切换 +> 本项目使用 Spring Boot 和 MyBatis 实现多数据源,动态数据源的切换;有多种不同的实现方式,在学习的过程中发现没有文章将这些方式和常见的问题集中处理,所以将常用的方式和常见的问题都写在了在本项目的不同分支上: + +- [master](https://github.com/helloworlde/SpringBoot-DynamicDataSource): 使用了多数据源的 RESTful API 接口,使用 Druid 实现了 DAO 层数据源动态切换和只读数据源负载均衡 +- [dev](https://github.com/helloworlde/SpringBoot-DynamicDataSource/tree/dev): 最简单的切面和注解方式实现的动态数据源切换 +- [druid](https://github.com/helloworlde/SpringBoot-DynamicDataSource/tree/druid): 通过切面和注解方式实现的使用 Druid 连接池的动态数据源切换 +- [aspect_dao](https://github.com/helloworlde/SpringBoot-DynamicDataSource/tree/aspect_dao): 通过切面实现的 DAO 层的动态数据源切换 +- [roundrobin](https://github.com/helloworlde/SpringBoot-DynamicDataSource/tree/roundrobin): 通过切面使用轮询方式实现的只读数据源负载均衡 +- [hikari](https://github.com/helloworlde/SpringBoot-DynamicDataSource/tree/hikari): 升级到SpringBoot 2.0版本 数据源使用 Hikari - **[多数据源分布式事务](https://github.com/helloworlde/spring-cloud-alibaba-component/tree/master/cloud-seata-multi-datasource): 使用 [Seata](https://github.com/seata/seata) 实现的多数据源事务** + +> 以上分支都是基于 dev 分支修改或扩充而来,基本涵盖了常用的多数据源动态切换的方式,基本的原理都一样,都是通过切面根据不同的条件在执行数据库操作前切换数据源 + ### 在使用的过程中基本踩遍了所有动态数据源切换的坑,将常见的一些坑和解决方法写在了 [Issues](https://github.com/helloworlde/SpringBoot-DynamicDataSource/blob/master/Issues.md) 里面 diff --git a/build.gradle b/build.gradle index 62f7cc5..e56b5f4 100644 --- a/build.gradle +++ b/build.gradle @@ -31,7 +31,8 @@ dependencies { compile('org.mybatis.spring.boot:mybatis-spring-boot-starter:1.3.2') compile('org.springframework.boot:spring-boot-starter-web') compile('org.springframework.boot:spring-boot-starter-aop') - compile('com.alibaba:druid-spring-boot-starter:1.1.6') + compile('org.projectlombok:lombok:1.18.16') + compile('com.alibaba:druid-spring-boot-starter:1.1.10') compile 'com.alibaba:fastjson:1.2.55' runtime('mysql:mysql-connector-java') testCompile('org.springframework.boot:spring-boot-starter-test') diff --git a/src/main/java/cn/com/hellowood/dynamicdatasource/configuration/DynamicDataSourceAspect.java b/src/main/java/cn/com/hellowood/dynamicdatasource/configuration/DynamicDataSourceAspect.java index 401f27d..6e9c331 100644 --- a/src/main/java/cn/com/hellowood/dynamicdatasource/configuration/DynamicDataSourceAspect.java +++ b/src/main/java/cn/com/hellowood/dynamicdatasource/configuration/DynamicDataSourceAspect.java @@ -1,5 +1,6 @@ package cn.com.hellowood.dynamicdatasource.configuration; +import lombok.extern.slf4j.Slf4j; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.After; import org.aspectj.lang.annotation.Aspect; @@ -18,9 +19,14 @@ */ @Aspect @Component +@Slf4j(topic = "webparams") public class DynamicDataSourceAspect { + /** + * @Slf4j(topic = "webparams") 表示默认日志对象是 log + */ private static final Logger logger = LoggerFactory.getLogger(DynamicDataSourceAspect.class); + private final String[] QUERY_PREFIX = {"get"}; /** @@ -40,6 +46,9 @@ public void switchDataSource(JoinPoint point) { Boolean isQueryMethod = isQueryMethod(point.getSignature().getName()); if (isQueryMethod) { DynamicDataSourceContextHolder.useSlaveDataSource(); + logger.info("Switch DataSource to [{}] in Method [{}]", + DynamicDataSourceContextHolder.getDataSourceKey(), point.getSignature()); + //自定义的日志对象 logger.debug("Switch DataSource to [{}] in Method [{}]", DynamicDataSourceContextHolder.getDataSourceKey(), point.getSignature()); } @@ -47,7 +56,7 @@ public void switchDataSource(JoinPoint point) { /** * Restore DataSource - * + * 使用后需要清楚当前使用的数据源(todo 原因:当方法执行完成或异常时,需要从ThreadLocal中移除切换记录,否则可能会影响别的不显示声明切换数据源的地方获取到错误的数据源,并且我们也需要保证ThreadLocal的remove方法被调用,这在多次切换数据源的情况下就会出问题。 ) * @param point the point */ @After("daoAspect()") diff --git a/src/main/java/cn/com/hellowood/dynamicdatasource/configuration/DynamicRoutingDataSource.java b/src/main/java/cn/com/hellowood/dynamicdatasource/configuration/DynamicRoutingDataSource.java index cbfbc5c..d64324c 100644 --- a/src/main/java/cn/com/hellowood/dynamicdatasource/configuration/DynamicRoutingDataSource.java +++ b/src/main/java/cn/com/hellowood/dynamicdatasource/configuration/DynamicRoutingDataSource.java @@ -23,7 +23,7 @@ public class DynamicRoutingDataSource extends AbstractRoutingDataSource { */ @Override protected Object determineCurrentLookupKey() { - logger.debug("Current DataSource is [{}]", DynamicDataSourceContextHolder.getDataSourceKey()); + logger.info("Current DataSource is [{}]", DynamicDataSourceContextHolder.getDataSourceKey()); return DynamicDataSourceContextHolder.getDataSourceKey(); } } diff --git a/src/main/java/cn/com/hellowood/dynamicdatasource/service/ProductService.java b/src/main/java/cn/com/hellowood/dynamicdatasource/service/ProductService.java index c758fd7..39d5da9 100644 --- a/src/main/java/cn/com/hellowood/dynamicdatasource/service/ProductService.java +++ b/src/main/java/cn/com/hellowood/dynamicdatasource/service/ProductService.java @@ -92,7 +92,7 @@ public boolean delete(long productId) throws ServiceException { /** * Get all product - * + * todo 在该应用中因为使用了 DAO 层的切面切换数据源,所以 @Transactional 注解不能加在类上,只能用于方法;有 @Trasactional注解的方法无法切换数据源 * @return */ public List getAllProduct() { diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index 058a8ce..43fe09d 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -5,7 +5,7 @@ spring.datasource.hikari.master.driver-class-name=com.mysql.jdbc.Driver spring.datasource.hikari.master.jdbc-url=jdbc:mysql://localhost/product_master?useSSL=false spring.datasource.hikari.master.port=3306 spring.datasource.hikari.master.username=root -spring.datasource.hikari.master.password=123456 +spring.datasource.hikari.master.password=yuantu123 # SlaveAlpha datasource config spring.datasource.hikari.slave-alpha.name=SlaveAlpha @@ -13,7 +13,7 @@ spring.datasource.hikari.slave-alpha.driver-class-name=com.mysql.jdbc.Driver spring.datasource.hikari.slave-alpha.jdbc-url=jdbc:mysql://localhost/product_slave_alpha?useSSL=false spring.datasource.hikari.slave-alpha.port=3306 spring.datasource.hikari.slave-alpha.username=root -spring.datasource.hikari.slave-alpha.password=123456 +spring.datasource.hikari.slave-alpha.password=yuantu123 # SlaveBeta datasource config spring.datasource.hikari.slave-beta.name=SlaveBeta @@ -21,7 +21,7 @@ spring.datasource.hikari.slave-beta.driver-class-name=com.mysql.jdbc.Driver spring.datasource.hikari.slave-beta.jdbc-url=jdbc:mysql://localhost/product_slave_beta?useSSL=false spring.datasource.hikari.slave-beta.port=3306 spring.datasource.hikari.slave-beta.username=root -spring.datasource.hikari.slave-beta.password=123456 +spring.datasource.hikari.slave-beta.password=yuantu123 # SlaveGamma datasource config spring.datasource.hikari.slave-gamma.name=SlaveGamma @@ -29,14 +29,19 @@ spring.datasource.hikari.slave-gamma.driver-class-name=com.mysql.jdbc.Driver spring.datasource.hikari.slave-gamma.jdbc-url=jdbc:mysql://localhost/product_slave_gamma?useSSL=false spring.datasource.hikari.slave-gamma.port=3306 spring.datasource.hikari.slave-gamma.username=root -spring.datasource.hikari.slave-gamma.password=123456 +spring.datasource.hikari.slave-gamma.password=yuantu123 spring.aop.proxy-target-class=true # MyBatis config mybatis.type-aliases-package=cn.com.hellowood.dynamicdatasource.mapper -mybatis.mapper-locations=mappers/**Mapper.xml +#mybatis.mapper-locations=classpath:/mappers/**Mapper.xml +mybatis-plus.mapper-locations: classpath*:/mappers/**Mapper.xml server.port=9999 spring.mvc.throw-exception-if-no-handler-found=true +# log日志 +logging.config: classpath:logback.xml + + diff --git a/src/main/resources/logback.xml b/src/main/resources/logback.xml new file mode 100644 index 0000000..4a0dc1b --- /dev/null +++ b/src/main/resources/logback.xml @@ -0,0 +1,305 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/gateway.log + + + ${log_home}/%d{yyyy-MM,aux}/gateway.log.%d{yyyy-MM-dd}-%i + + ${log_file_history} + + ${log_file_size} + true + + 70GB + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/all.log + + + ${log_home}/%d{yyyy-MM,aux}/all.log.%d{yyyy-MM-dd}-%i + + ${log_file_history} + true + + ${log_file_size} + + 10GB + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/webparam.log + + + ${log_home}/%d{yyyy-MM,aux}/webparam.log.%d{yyyy-MM-dd}-%i + + ${log_file_history} + true + + ${log_file_size} + + 70GB + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/biz.log + + + ${log_home}/%d{yyyy-MM,aux}/biz.log.%d{yyyy-MM-dd}-%i + + 60 + true + + ${log_file_size} + + 5GB + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/large.log + + + ${log_home}/%d{yyyy-MM,aux}/large.log.%d{yyyy-MM-dd}-%i + + 7 + + ${log_file_size} + true + + 5GB + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/sql.log + + + ${log_home}/%d{yyyy-MM,aux}/sql.log.%d{yyyy-MM-dd}-%i + + 30 + + ${log_file_size} + true + + 5GB + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/bus.log + + + ${log_home}/%d{yyyy-MM,aux}/bus.log.%d{yyyy-MM-dd}-%i + + 15 + + ${log_file_size} + true + + 5GB + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/job.log + + + ${log_home}/%d{yyyy-MM,aux}/job.log.%d{yyyy-MM-dd}-%i + + 30 + + ${log_file_size} + true + + 5GB + + + + ${log_pattern} + + UTF-8 + + + + + + + ${log_home}/sea.log + + + ${log_home}/%d{yyyy-MM,aux}/sea.log.%d{yyyy-MM-dd}-%i + + 3 + + ${log_file_size} + true + + 5GB + + + + ${log_pattern} + + UTF-8 + + + + + + ${log_home}/planJob.log + + + ${log_home}/%d{yyyy-MM,aux}/planJob.log.%d{yyyy-MM-dd}-%i + + 1 + + ${log_file_size} + true + + + + + + ${log_pattern} + + UTF-8 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

AltStyle によって変換されたページ (->オリジナル) /