26 Star 89 Fork 23

t0mZ / xatomic

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Getting Started

说明

适用环境:SpringBoot / MyBatis / Atomickos
特性:

  1. 多数据源,动态切换
  2. 多数据源,XA分布式事务支持(需引入Atomickos)

仅支持Mybatis,采用AbstractRoutingDataSource实现数据源动态切换。 引入Atomickos分布式事务,可支持多数据源动态切换分布式事务。

使用方法

引入jar包依赖 maven:

      <dependency>
        <groupId>com.tomz</groupId>
        <artifactId>xatomic</artifactId>
        <version>1.0.0</version>
      </dependency>

gradle:

implementation 'com.tomz:xatomic:1.0.0'

使用注解切换数据源@DynamicDataSource,可以放在类或者方法上。

  • 多数据源功能
    配置文件示例:对于name属性,当数据源集合中存在name=default的数据源时,该数据源作为默认数据源 ,不加@DynamicDataSource默认使用该数据源,否则取集合中的第一个数据源作为默认数据源

      spring:
          datasources:
            - name: ds1
              type: com.zaxxer.hikari.HikariDataSource
              username: root
              password:
              driver-class-name: com.mysql.cj.jdbc.Driver
              jdbcUrl: jdbc:mysql://localhost:3306/test01?useUnicode=true&characterEncoding=utf-8&useSSL=false&autoReconnect=true&allowMultiQueries=true&&serverTimezone=GMT%2B8
            - name: ds2
              type: com.zaxxer.hikari.HikariDataSource
              username: root
              password:
              driver-class-name: com.mysql.cj.jdbc.Driver
              jdbcUrl: jdbc:mysql://localhost:3306/test02?useUnicode=true&characterEncoding=utf-8&useSSL=false&autoReconnect=true&allowMultiQueries=true&&serverTimezone=GMT%2B8
  • 多数据源XA分布式事务支持
    引入: implementation 'org.springframework.boot:spring-boot-starter-jta-atomikos' 配置文件与多数据源配置文件相似,但是数据源类型type需要改为支持XA的数据源对象, 如:MysqlXADataSource,DruidXADataSource。 需要注意的是,对于DruidXADataSource,支持的MySql驱动类型当前只到8.0.11版本。

     spring:
         datasources:
           - name: ds1
             type: com.mysql.cj.jdbc.MysqlXADataSource
             databaseName: test01
             hostName: localhost
             user: root
             password:
             port: 3306
             url: jdbc:mysql://localhost:3306/test01?useUnicode=true&characterEncoding=utf-8&useSSL=false&autoReconnect=true&allowMultiQueries=true&&serverTimezone=GMT%2B8
           - name: ds2
             type: com.mysql.cj.jdbc.MysqlXADataSource
             databaseName: test01
             hostName: localhost
             user: root
             password:
             port: 3306
             url: jdbc:mysql://localhost:3306/test02?useUnicode=true&characterEncoding=utf-8&useSSL=false&autoReconnect=true&allowMultiQueries=true&&serverTimezone=GMT%2B8

    此外还可以对Atomickos做配置

     # JtaProperties
     spring.jta:
     #  logDir:
       transactionManagerId: myTxMgrId
       # AtomikosProperties
     #  atomikos:
     #    properties:
       # org.springframework.boot.jta.atomikos.AtomikosDataSourceBean 数据源连接池配置
       atomikos:
         datasource:
           poolSize: 5
           minPoolSize: 3
           maxPoolSize: 20
           borrowConnectionTimeout: 60
           reapTimeout: 300
           maxIdleTime: 60
           maintenanceInterval: 60
           loginTimeout: 60
           testQuery: select 1

    最后,需要在Configuration类上面使用MapperScan注解,如下:

     //factoryBean替换掉默认的MapperFactoryBean,实现Mapper映射到每个数据源。仅使用xa分布式事务支持才需要添加该注解,否则只用多数据源功能可以不加
     @MapperScan(factoryBean = XaDynamicMapperFactoryBean.class, basePackages = {"com.test.mapper"}) 
     @SpringBootApplication 
     class ApplicationDemo { 
        public static void main(String[] args) {
        		SpringApplication.run(ApplicationDemo.class, args);
        	}   
     }
     //mapper类
     @Mapper
     public interface TestMapper {  
         @DynamicDataSource("ds1")
         @Insert("insert into test(name) values ('a')")
         long insertA();
     
         @DynamicDataSource("ds2")
         @Insert("insert into test(name) values ('b')")
         long insertB();
     }
     //service类
     @Service
     class ServiceA {
           @Autowired
           private TestMapper mapper;
           @Transactional(rollbackFor = Exception.class)
           public void insertAB() {
               this.mapper.insertA();
               this.mapper.insertB();
               //throw new IllegalArgumentException("test xa-rollback");
           }
     }
     //测试类
     @RunWith(SpringRunner.class)
     @SpringBootTest
     public class ServiceTest {
     
         @Autowired
         private ServiceA service;
     
         @Test
         public void testXa() {
             this.service.insertAB();
         }
     
     }

    禁用分布式事务数据源:spring.jta.enabled=false
    禁用动态多数据源:spring.dynamic.datasource.enabled=false

    备注:该项目需要自己下载到本地,执行install安装到本地才能引用。🤣

        $ git clone https://gitee.com/t0mZ/xatomic.git
        Initialized empty Git repository in D:/java/xatomic/.git/
        remote: Enumerating objects: 69, done.
        remote: Counting objects: 100% (69/69), done.
        remote: Compressing objects: 100% (56/56), done.
        remote: Total 69 (delta 19), reused 0 (delta 0)
        Unpacking objects: 100% (69/69), done.
        $ cd xatomic
        $ ./gradlew install
        Downloading https://services.gradle.org/distributions/gradle-4.10.3-all.zip
        ................................................................................................................
        Unzipping /home/.gradle/wrapper/dists/gradle
        ...省略....
        > Task :compileJava
        Note: Some input files use unchecked or unsafe operations.
        Note: Recompile with -Xlint:unchecked for details.
        
        BUILD SUCCESSFUL in 2m 15s
        4 actionable tasks: 4 executed

    默认安装在:${user.dir}/.m2/repository/com/tomz/xatomic/

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.

简介

多数据源、多数据源事务支持集成工具,简单易上手。当前仅支持SpringBoot中项目集成MyBatis, 分布式事务需集成Atomickos。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/t0mZ/xatomic.git
git@gitee.com:t0mZ/xatomic.git
t0mZ
xatomic
xatomic
master

搜索帮助