GitHub地址

Gitee地址

教程

sqlhelper

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

modules

tools usage

关键特性

1. 支持 MyBatis, MyBatis-Plus, Tk.Mapper, SpringJdbc, Apache Commons-DBUtils, JFinal, EBean, Mango, Hibernate 等众多对数据库操作的框架
2. 支持 110+ 数据库（所有功能均支持，不限于分页功能）, 支持的数据库列表参考： ***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 (优炫数据库)

3. 支持多个数据库在同一个应用中并存，且不需要做任何的区分，就能自动识别
4. 支持自动获取数据库 dialect （方言），也可以指定
5. 性能要比Mybatis-PageHelper更高, 因为SQL中的 limit、offset 会以占位符 '?'的形式存在，支持缓存等，总之PageHelper支持的这里都支持，PageHelper不支持的这里也支持。
6. 对于 select count语句，会自动的排除掉 order by 子句，以提升查询效率
7. 可以基于 Java SPI 规范来自定义Dialect，以此来扩展数据库
8. 分页功能支持子查询：mybatis, mybatis-plus, spring-jdbc, apache commons-dbutils
9. 支持 spring boot 1.x , 2.x
10. 支持 JDK6+
11. 支持 Memory Pagination
12. 支持 SqlSymbolMapper, 可以使用它来自动映射数据库字段、表名等
13. 支持 Dump DDL
14. 支持 like parameter escape [%] : mybatis, mybatis-plus, tk.mapper 下使用
15. 动态数据源 Dynamic DataSource，目前支持在 mybatis, mybatis-plus, tk.mapper 下使用

sqlhelper vs mybatis-pagehelper

分页工具使用说明

• Quick Start
  • MyBatis application
    • Installation
    • How To
    • Migrate from mybatis-pagehelper application
  • SpringJDBC application
    • Installation
    • How To
  • jFinal application
    • Installation
    • How To
  • MyBatis-Plus application
  • EBean application
• Advanced Usage

更多说明，参见教程：

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 - 开发计划

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

推广

• 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，方便了开源项目的发展。