16 Star 71 Fork 17

coderjn / sqlhelper

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

License

Build Status Codacy Badge

JDK

MyBatis MyBatis jFinal jFinal EBean Mango Commons-DBUtils Solon

Spring-Jdbc Spring-Jdbc Spring-Jdbc Spring-Jdbc

SpringBoot SpringBoot

maven

GitHub地址

Gitee地址

教程

sqlhelper

SQL Tools ( Dialect, Pagination, DDL Dump, UrlParser, SqlStatementParser, WallFilter, BatchExecutor for Test) based Java

modules

module sqlhelper version JDK framework version Description
sqlhelper-dialect 1.0+ 1.6+ the core (绝大部分功能都离不开它)
sqlhelper-cli 2.0+ 1.8+ CLI 命令行工具
sqlhelper-cli-assembly 2.0+ 1.8+ 为 CLI 命令行工具 提供打包功能
sqlhelper-mybatis 1.0+ 1.6+ 提供对MyBatis的支持 (主要包括:通用分页、通用批量操作、多数据源)
sqlhelper-mybatis-spring-boot 1.0+ 1.6+ 为MyBatis + SqlHelper 提供了Spring Boot 快速启动
sqlhelper-mybatis-over-pagehelper 1.0+ 1.6+ 引入它就可以无缝的从 mybatis-pagehelper 迁移到 SqlHelper
sqlhelper-jfinal 1.2+ 1.6+ 4.3+ 对国产框架jfinal支持 (主要包括:通用分页)
sqlhelper-ebean 1.2+ 1.6+ 对 ebean 支持(主要包括:通用分页)
sqlhelper-hibernate 1.2+ 1.6+ 对 hibernate 支持(主要包括:通用分页)
sqlhelper-mango 1.2+ 1.6+ 对 mango 支持 支持(主要包括:通用分页)
sqlhelper-batchinsert 1.2+ 1.6+ 为了 性能测试 提供的批量入库工具
sqlhelper-springjdbc 2.0.2+ 1.6+ spring 4.0+ 对 spring-jdbc 支持 (主要包括:通用分页)
sqlhelper-springjdbc-spring-booter 2.0.2+ 1.8+ 对 spring-jdbc 应用提供了 Spring Boot 快速启动
sqlhelper-mybatisplus-3 2.0.7+ 1.8+ mybatis-plus 3.2.0+ 对 mybatis-plus 支持
sqlhelper-mybatisplus-spring-boot-starter 2.0.7+ 1.8+ mybatis-plus 3.1.2+ 对 mybatis-plus 应用提供了 Spring Boot 快速启动
sqlhelper-mybatisplus-2 3.3.0+ 1.6+ mybatis-plus 3.2.0+ 对 mybatis-plus 支持
sqlhelper-mybatisplus_2x-spring-boot-starter 2.0.7+ 1.6+ mybatis-plus 3.1.2+ 对 mybatis-plus 应用提供了 Spring Boot 快速启动
sqlhelper-tkmapper-spring-boot-starterer 3.1.0+ 1.8+ 对 tk.mybatis Mapper 应用提供了 Spring Boot 快速启动
sqlhelper-dbutils 2.2.0 1.6+ 对 Apache Commons-DBUtils 支持 (主要包括:通用分页)
sqlhelper-jsqlparser 3.0.3 1.6+ 对于要基于SQL Parser接口来完成的功能 由jsqlparser 这个库来实现
sqlhelper-mybatis-solon-plugin 3.2.0 1.8+ 支持solon 框架
sqlhelper-datasource 3.4.0 1.6+ 提供通用的多数据源配置、解析、路由框架
sqlhelper-mybatis-spring-common 3.4.0 1.6+ 提供mybatis + spring 环境下,通用的代码
sqlhelper-examples 1.0+ 1.8+ 为这些工具提供 测试用例

tools usage

关键特性

  1. 支持 MyBatis, MyBatis-Plus, Tk.Mapper, SpringJdbc, Apache Commons-DBUtils, JFinal, EBean, Mango, Hibernate 等众多对数据库操作的框架
  2. 支持 130+ 数据库(所有功能均支持,不限于分页功能), 支持的数据库列表参考: here. 如果你想了解这些数据库的排名,可以参考这里:DB Engines.下面是所有支持的国产数据库:
  • AliSQL (阿里 MySQL)
  • AntDB (亚信)
  • CirroDB (东方国信 行云)
  • CynosDB (腾讯云数据库)
  • Doris (Apache Doris,百度研发)
  • DM (达梦)
  • EsgynDB (易鲸捷)
  • GaussDB (华为 高斯)
  • GBase (南大通用)
  • GoldenDB (中兴)
  • HHDB (恒辉数据库)
  • HighGo (瀚高)
  • HybridDB (阿里巴巴 分布式PostgreSQL)
  • K-DB (浪潮)
  • KingBase (金仓)
  • MaxCompute (阿里巴巴)
  • OBase (上海丛云信息科技)
  • OceanBase (阿里巴巴/蚂蚁金服 兼容mysql)
  • OSCAR (神州通用)
  • OpenBase (东软)
  • RadonDB (青云)
  • SequoiaDB (巨杉)
  • SinoDB (星瑞格)
  • TDSQL (腾讯 分布式MySQL)
  • TiDB (北京平凯星辰科技))
  • Trafodion (易鲸捷 EsgynDB的开源版)
  • UxDB (优炫数据库)
  1. 支持多个数据库在同一个应用中并存,且不需要做任何的区分,就能自动识别
  2. 支持自动获取数据库 dialect (方言),也可以指定
  3. 性能要比Mybatis-PageHelper更高, 因为SQL中的 limit、offset 会以占位符 '?'的形式存在,支持缓存等,总之PageHelper支持的这里都支持,PageHelper不支持的这里也支持。
  4. 对于 select count语句,会自动的排除掉 order by 子句,以提升查询效率
  5. 可以基于 Java SPI 规范来自定义Dialect,以此来扩展数据库
  6. 分页功能支持子查询:mybatis, mybatis-plus, spring-jdbc, apache commons-dbutils
  7. 支持 spring boot 1.x , 2.x
  8. 支持 JDK6+
  9. 支持 Memory Pagination
  10. 支持 SqlSymbolMapper, 可以使用它来自动映射数据库字段、表名等
  11. 支持 Dump DDL
  12. 支持 like parameter escape [%] : mybatis, mybatis-plus, tk.mapper 下使用
  13. 动态数据源 Dynamic DataSource,目前支持在 mybatis, mybatis-plus, tk.mapper 下使用

sqlhelper vs mybatis-pagehelper

metric mybatis-pagehelper sqlhelper
databases 13 100+
multiple databases in runtime
auto detect dialect
plugin
PrepareStatement with '?' X
mybatis 3.x 3.x
spring boot 1.x, 2.x 1.x, 2.x
JDK 1.6+ 1.6+
jFinal X
Mango X
EBean X
国产数据库 X √ (参见上述列表)
Spring JDBC X √ 2.x,3.x,4.x,5.x
SqlSymbol Mapping X
MyBatis-Plus X
tk.mapper
Apache Commons-DBUtils X
Subquery pagination X
solon X
多数据源 X

分页工具使用说明

更多说明,参见教程:

1. https://fangjinuo.gitee.io/docs/index.html
2. https://fangjinuo.github.io

Dynamic DataSource

目前针对动态(多)数据源这块,提供了方便的,易扩展的框架,可以基于此多数据源框架与各种ORM框架结合。 此外目前内置对 MyBatis 系框架( mybatis, mybatis-plus(2.x, 3.x), tk.mapper 等)做了内置的支持。提供了便利的 spring boot starter。

usage

sqlhelper:
  dynamic-datasource:
    enabled: true
    datasources:
      - group: A
        name: master
        url: jdbc:h2:file:${user.dir}/sqlhelper-examples/sqlhelper-examples-db/src/main/resources/test
        driver-class-name: org.h2.Driver
        username: sa
        password: 123456
      - group: A
        name: slave-1
        url: jdbc:h2:file:${user.dir}/sqlhelper-examples/sqlhelper-examples-db/src/main/resources/test
        driver-class-name: org.h2.Driver
        username: sa
        password: 123456
      - group: A
        name: slave-2
        url: jdbc:h2:file:${user.dir}/sqlhelper-examples/sqlhelper-examples-db/src/main/resources/test
        driver-class-name: org.h2.Driver
        username: sa
        password: 123456
      - group: B
        name: mysql
        url: jdbc:h2:file:${user.dir}/sqlhelper-examples/sqlhelper-examples-db/src/main/resources/test
        driver-class-name: org.h2.Driver
        username: sa
        password: 123456
      - group: C
        name: oracle
        url: jdbc:h2:file:${user.dir}/sqlhelper-examples/sqlhelper-examples-db/src/main/resources/test
        driver-class-name: org.h2.Driver
        username: sa
        password: 123456
      - group: C
        name: xxxx
        url: jdbc:h2:file:${user.dir}/sqlhelper-examples/sqlhelper-examples-db/src/main/resources/test
        driver-class-name: org.h2.Driver
        username: sa
        password: 123456

事务控制:

目前做法:
    针对每一个数据源,都添加一个 TransactionManager。各自控制自己的。

Dynamic DataSource - 开发计划

  • 通用框架
    • 连接池实现
      • 支持常见连接池:HikariCP, Alibaba Druid, tomcat-jdbc, dbcp2, c3p0
      • 支持在配置中使用哪个连接池实现
      • 支持所用连接池实现的特有配置项
    • DataSource 配置
      • 支持分组配置,通常一个业务群一个分组,或者一个数据库集群用一个分组
      • 兼容 SpringBoot 默认 DataSource 配置
      • 支持多种异构数据源
    • DataSource 识别
      • 提供 @DataSource 注解,可以在 method, class 级别使用
      • 支持 自定义注解。
      • 支持多层级 注解配置。筛选时,安装最近优先原则
      • 支持自定义识别算法。例如可以基于此自行实现负载均衡,读写分离,随机等众多识别算法。
      • 支持多层嵌套。
      • 可自定义AOP拦截位置。
    • Router
      • master, slave 识别
        • 基于 readonly 确定是否必定为slave
        • 基于 primary 判断
        • 如果没有primary属性则 基于 name 判断
      • master 路由算法
        • first,即只取第一个
      • slave 路由算法
        • 随机路由
        • 读写分离路由
        • 负载均衡路由
      • 故障转移
  • 框架支持
    • mybatis & spring boot 应用
    • mybatis 2.x, 3x & spring boot 应用
    • tk.mapper & spring boot 应用
    • spring jdbc
    • apache DBUtils
    • jfinal

UrlParser

Parse jdbc url.

usage:

String url = "jdbc:mysql://${localhost}:${port}....";
DatabaseInfo dbinfo = new JdbcUrlParser().parse(url)
...

Batch Insert Tool

如果你想要进行业务SQL性能优化,又苦于数据库里没有太多数据,可以使用它来进行批量插入数据,大大的节省你造数据的时间。具体参加sqlhelper-batchinsert模块。

FAQ

这里提供了一些常见问题,对于刚使用SQLHelper时,可能对你很有帮助

Contact

QQ 交流群: 750929088
QQ Group

推广

  • langx 系列
    • langx-js:TypeScript, JavaScript tools
    • langx-java: Java tools ,可以替换guava, apache commons-lang,io, hu-tool等
  • easyjson: 一个通用的JSON库门面,可以无缝的在各个JSON库之间切换,就像slf4j那样。
  • sqlhelper: SQL工具套件(通用分页、DDL Dump、SQLParser、URL Parser、批量操作工具等)。
  • esmvc: ElasticSearch 通用客户端,就像MyBatis Mapper那样顺滑
  • agileway: 提供大量的框架扩展,方便日常开发
  • audit:通用的Java应用审计框架

鸣谢

最后,感谢 Jetbrains 提供免费License,方便了开源项目的发展。

Jetbrains

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.

About

SQL开发、测试工具套件(分页、动态数据源、批处理、DDL等)其中分页支持MyBatis,SpringJDBC,commons-dbutils, jfinal, ebean, mango等 expand collapse
Java and 3 more languages
Apache-2.0
Cancel

Releases (1)

All

Contributors

All

Activities

Load More
can not load any more
Java
1
https://gitee.com/coderjn/sqlhelper.git
git@gitee.com:coderjn/sqlhelper.git
coderjn
sqlhelper
sqlhelper
master

Search