20 Star 39 Fork 12

佲日 / Nway-JDBC

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

简单、易用、易扩展、性能不输给mybatis、明显高于mybatis-plus

    支持新增、修改时自动填充数据,支持单字段多值时自动保存、查询(如多选字典项),支持数据权限的管控、逻辑删除等。 使用时只需要给主类SqlExecutor配置好数据源,不需要继承某个类,也不需要实现哪个接口,工具类式使用。

基本使用方法

maven

<dependency>
	<groupId>com.github.zdtjss</groupId>
	<artifactId>nway-jdbc</artifactId>
	<version>1.7.6</version>
</dependency>

基于xml配置的bean:

<bean id="sqlExecutor" class="com.nway.spring.jdbc.SqlExecutor">
    <property name="dataSource" ref="dataSource"/>
</bean>

Spring Boot:

@Autowired
private DataSource dataSource;

@Bean
public SqlExecutor createSqlExecutor() {
	return new SqlExecutor(dataSource);
}

增、改、删:

QueryBuilder builder = SQL.insert(Class beanClass);
DeleteBuilder builder = SQL.delete(Class beanClass);
UpdateBuilder builder = SQL.update(Class beanClass);

int effectCount = sqlExecutor.update(builder);

查询条件自动判空,省去不必要的判断代码,如:

if(StringUtils.isNotBlank(user.getName)) {
    sqlBuilder.like(User::getName, user.getName());
}

上述代码可直接写成:

sqlBuilder.ignoreInvalidDeep(true)
    .like(User::getName, user.getName()); 

工具内部会判断user.getName()的传值是否有效,只有有效时才会作为查询条件,null、空集合、空字符串均为无效值。基本类型的默认值是有效值
(如果只需要忽略null或集合可以使用方法ignoreInvalid(true))。
您当然可以忽略自动判断。只需调用sqlBuilder.ignoreInvalidDeep(false),同样的调用sqlBuilder.ignoreInvalidDeep(true)即恢复自动判断。
只应在传值为空时不做为条件的情况下使用ignoreInvalidDeep(true),否则将数据越权,默认为false。
注意,and(Consumer<X> whereBuilder)或or(Consumer<X> whereBuilder)中使用此特性时,要明确指定,
如:and((sql) -> sql.ignoreInvalidDeep(true).like(User::getName, user.getName()))

单对象查询:

QueryBuilder builder = SQL.query(User.class).eq(usrQuery::getStatus).like(usrQuery::getName);
User user = sqlExecutor.queryBean(builder);
User user = sqlExecutor.queryById(100, User.class);

or

User usr = sqlExecutor.queryForBean("select * from t_user where user_name like ? and status = ?", User.class, "abc", 1);

对象集查询:

QueryBuilder builder = SQL.query(User.class).eq(usrQuery::getStatus).like(usrQuery::getName);
List<User> users = sqlExecutor.queryList(builder);
List<User> users = sqlExecutor.queryList(Arrays.asList(100), User.class);
Map<String, User> userMap = queryListMap(builder, User::getId)
Map<String, User> userMap = queryListMap(Arrays.asList(100), User.class, User::getId)

or

List<User> users = sqlExecutor.queryList("select * from t_user where user_name like ? and status = ?", User.class, 10000);

分页对象集查询:

QueryBuilder builder = SQL.query(User.class).eq(usrQuery::getStatus).like(usrQuery::getName).orderBy(usrQuery::getId);
Page<User> users = sqlExecutor.queryPage(builder, 1, 10);

or

Page<User> users = sqlExecutor.queryPage("select * from t_user where user_name like ? and status = ? order by id", new Object[]{ "abc", 1 }, 1, 10, User.class);

//页面数据 List<T>
users.getPageData();
//页面数据条数
users.getPageSize();
//总数据条数
users.getTotalCount()
//页面大小
users.getPageSize();
//页数
users.getPageCount();
//当前页码
users.getCurrentPage();

Map对象集分页:

Page<Map<String, Object>> users = sqlExecutor.queryPage("select * from user_name where id <> ? order by id", new Object[]{ "abc", 1 }, 1, 10);
分页默认支持Oracle、Mysql、MariaDB,关于其他数据库的分页可以实现com.nway.spring.jdbc.pagination.PaginationSupport接口,通过com.nway.spring.jdbc.SqlExecutor.setPaginationSupport方法引入。

自动填充数据和数据权限支持

应用场景: 
	1、数据权限可用于数据查询时自动限制可返回的数据
	2、自动填充功能可应用于统一处理数据的“创建人”、“修改人”、“创建时间”、“修改时间“等
使用办法:
	查询对象对应属性加入注解 @Column(fillStrategy = TestFillStrategy.class, permissionStrategy = TestPermissionStrategy.class) 

LogicFieldStrategy:基于fillStrategy、permissionStrategy实现的软删除。这两个属性有很大的想象空间。LogicFieldIntStrategy是int标记类型的实现。

关于深度自定义

1、如果需要对执行SQL和参数深度干预,可以集成Spring的JdbcTemplate覆盖相关方法,然后通过SqlExecutor.setJdbcTemplate替换默认值。
2、默认表字段和类属性的映射是通过反射完成,但提供了ASM的实现(AsmBeanProcessor),如果有更好的实现方案,可以实现接口BeanProcessor,然后通过SqlExecutor.setBeanProcessor替换默认值。
注:理论上ASM性能应高于反射,但自测结果显示,差距并不明显,具体原因需要进一步定位。

数据库表与Java类的映射规则

表名: @Table("t_user") 默认表名和类名的对应规则是首字母小写,其余大小字母变小写,前面加下划线。如UserRole默认对应的表名为user_role。

字段: 类属性和表列默认的对应规则是:删除下划线后首字符大写。表字段user_name对应属性userName,会通过类中setUserName方法赋值。 也可以通过com.nway.spring.jdbc.annotation.Column修改默认规则。 例:

  import com.nway.spring.jdbc.annotation.Table;
  import com.nway.spring.jdbc.annotation.Column;
  
  @Table("t_user")
  public class User {
     @Column(type = ColumnType.ID)
     private Integer id;
  	 @Column("user_name")
  	 private String name;
  	 private int status;
     @Column(name = "power", sub = @MultiColumn(XXX))
     private List<String> powerList;
  }

对于ColumnType.MULTI_VALUE类型的字段,程序自动从所属类表名加当前字段名命名的表里读写,上述powerList数据对应的表为t_user_power,其表结构为

CREATE TABLE `t_computer_user` (
    `id` bigint NOT NULL,               --固定字段,主键
    `fk` int DEFAULT NULL,              --固定字段,主表主键 类型可根据主表主键类型定义
    `power` varchar(255) DEFAULT NULL,  --固定字段,@Column配置的字段名(遵从默认下划线命名规则)
    `idx` int DEFAULT NULL,             --固定字段,排序用
    PRIMARY KEY (`id`)
);

使用注解@MultiColumn可以自定义字段名

#对于JdbcTemplate.handleWarnings(),当日志级别为debug或trace时比较耗时(这是比较早的测试数据,默认可以忽略,发现性能较差时,可以考虑此问题是否存在)。

查询不到数据时

  • query返回null
  • queryList返回值size() == 0
  • queryPage返回值getTotal() == 0

    域对象不建议使用基本类型,因为新增或修改数据时通常是根据属性是否为null判断是否需要保存的

性能测试

各种情况下的性能均不输给当前主流的其他工具

OrderPerformanceTest 单线程顺序执行时的性能测试类
ConcurrentPerformanceTest   多线程并发模式下的性能测试类

性能对比(测试代码为vs-java项目,测试工具JMeter)

rsp-page.png

tps-page.png 上图为分页查询性能对比,本工具TPS比mybatis-plus高出约1倍,比mybatis高出约20%多。

rsp-list.png

tps-list.png 上图为列表查询性能对比,本工具TPS比mybatis-plus高出约60%,比mybatis高出约40%。

    测试数据可能因环境而异,但从多台机器不同版本jdk的测试情况看,性能明显优于同类型的MyBatis-Plus。

    本工具与mybatis定位不同,本不应对比,之所以列出,一是想说明本单表操作后复合对象,其性能不比基于mybatis的外连接查询性能差。 关于MyBatis-Plus性能问题,我已两次向MyBatis-Plus社区提出,均未收到积极解决的态度,相反其创建者认可当前性能表现,所以,希望使用高性能的单表操作,可以考虑本工具。

    本项目专注于单表操作,对于多表的情况可以考虑使用视图,也可用使用MyBatis等其他擅长多表操作的工具。 对于有嵌套对象的情况,根据测试数据,使用本工具进行多次单表查询后复合对象,性能优于直接使用外连接由MyBatis自动组合嵌套对象的方式。

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.

简介

简单易用、性能更优的单表操作工具包,无需继承或实现任何类或接口,拿来就能用,支持对自动填充和数据权限的管控。支持JDK17 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/nway/Nway-JDBC.git
git@gitee.com:nway/Nway-JDBC.git
nway
Nway-JDBC
Nway-JDBC
dev

搜索帮助