1 Star 1 Fork 2

不爱那么多I只爱一点点 / agile-jpa

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

agile-jpa : spring-data-jpa扩展

spring-data-jpa maven

它有什么作用

  • 持久层工具合并 使用该组件后,全局仅需要注入唯一的Dao工具,无需再声明其他Dao/Repository,一个工具搞定所有Dao,极大简化持久层代码量。

  • 原生动态sql解析支持 依靠agile-sql(动态sql解析器)实现jpa中对sql语法段的动态解析,弥补其在动态sql解析方面的短板。面对复杂查询语句将不再是难点。

  • 内置slq分页与jpa分页 JPA风格的Do类对象操作形式分页与原生SQL形式分页均返回统一的分页数据格式,且提供total总条数结果

  • 内置字典翻译 依靠agile-dictionary组件,查询过程中会识别@Dictionary注解,如果不需要字典翻译时可以将该组件于pom中直接移除


快速入门

开始你的第一个项目是非常容易的。

步骤 1: 下载包

您可以从[最新稳定版本]下载包(https://github.com/mydeathtrial/agile-jpa/releases). 该包已上传至maven中央仓库,可在pom中直接声明引用

以版本agile-jpa-2.1.0.M5.jar为例。

步骤 2: 添加maven依赖

<!--声明中央仓库-->
<repositories>
    <repository>
        <id>cent</id>
        <url>https://repo1.maven.org/maven2/</url>
    </repository>
</repositories>
        <!--声明依赖-->
<dependency>
<groupId>cloud.agileframework</groupId>
<artifactId>agile-jpa</artifactId>
<version>2.1.0.M5</version>
</dependency>

步骤 3: 开箱即用,由于API众多,本文只介绍常用方法,更多方法请查看javadoc

  • 新增
/**
 * 功能:延迟保存
 * 特点:无回参,flush后产生ID,事务提交后保存
 */
dao.save(new SysUsersEntity());
/**
 * 功能:立即保存
 * 特点:有回参,立即产生ID,事务提交后保存,不立即调用flush
 */
SysUsersEntity entity = dao.saveAndReturn(new SysUsersEntity());
/**
 * 功能:立即保存
 * 特点:有回参,立即产生ID,事务提交后保存,立即调用flush
 */
SysUsersEntity entity = dao.saveAndReturn(new SysUsersEntity(),true);
/**
 * 功能:批量立即保存
 * 特点:有回参,立即产生ID,事务提交后保存,不立即调用flush
 */
List<SysUsersEntity> list = new ArrayList<>(2);
list.add(new SysUsersEntity());
list.add(new SysUsersEntity());
boolean isSuccess = dao.save(list);

  • 删除
/**
 * 功能:批量模糊删除数据
 * 特点:无回参,先根据入参对象进行查询,再批量删除结果集
 * 例子:该例子中会删除SysUsersEntity对应表中Name字段为Tom的所有数据
 */
SysUsersEntity entity = new SysUsersEntity();
entity.setName("Tom");
dao.delete(entity);
/**
 * 功能:删除对应表指定ID的数据
 * 特点:无回参,删除单条数据
 * 例子:该例子中会删除SysUsersEntity对应表中主键字段为123的有数据
 */
dao.deleteById(SysUsersEntity.class,"123");
/**
 * 功能:清空全表
 * 特点:无回参,一条一条删除
 * 例子:该例子中会删除SysUsersEntity对应表所有数据
 */
dao.deleteAll(SysUsersEntity.class);
/**
 * 功能:清空全表
 * 特点:无回参,一次性清空
 * 例子:该例子中会删除SysUsersEntity对应表所有数据
 */
dao.deleteAllInBatch(SysUsersEntity.class);
/**
 * 功能:批量删除指定表指定主键的数据
 * 特点:无回参,一次性清空
 * 例子:该例子中会删除SysUsersEntity对应表主键为1111、2222的数据
 */
dao.deleteInBatch(SysUsersEntity.class,new Object[]{"1111","2222"});
/**
 * 功能:批量删除指定表指定的数据集
 * 特点:无回参,一次性清空
 * 例子:该例子中会删除SysUsersEntity对应表指定两条数据
 */
List<SysUsersEntity> list = new ArrayList<>(2);
list.add(new SysUsersEntity());
list.add(new SysUsersEntity());
dao.deleteInBatch(list);
/**
 * 功能:sql方式批量删除
 * 特点:有回参,一次性清空
 * 例子:该例子中会删除SysUsersEntity对应表主键为1111、2222的数据
 */
String sql = "delete from sys_suers where name  in {names}";
Map<String,Object> params = new HashMap<>(1);
params.put("names",new String[]{"1111","2222"});
int total = dao.updateBySQL(sql, params);

  • 修改
/**
 * 功能:更新数据
 * 特点:有回参,null字段会被清空
 */
SysUsersEntity newEntity = ...
dao.update(newEntity);
/**
 * 功能:更新非空字段数据
 * 特点:有回参,null字段不更新
 */
SysUsersEntity newEntity = ...
dao.updateOfNotNull(newEntity);
/**
 * 功能:sql方式更新数据
 * 特点:有回参,null字段不更新
 * 例子:该例子中会更新SysUsersEntity对应表主键为1111的数据,name为Tom
 */
String sql = "update sys_suers set name = ? where id = ? ";
int total = dao.updateBySQL(sql,"Tom","1111");

  • 查询 查询方法多而杂,本文只例举常用例子,具体用发参照java doc 只有select支持 {id} 方式传参。如果该key值没有传参数,则会去掉该条件

1、只有select支持 {id} 方式传参。如果该key值没有传参数,则会去掉该条件 2、 当 ? 参数没有值时候条件不会去掉。例如:selec * from person where name=? 没有传参时则条件不会去掉

/**
 * 功能:根据ID查询单条
 * 特点:无
 * 例子:该例子中会查询SysUsersEntity对应表主键为1111的数据
 */
SysUsersEntity entity = dao.findOne(SysUsersEntity.class,"1111");
/**
 * 功能:根据例子查询单条
 * 特点:如果查询结果超过一条,则抛出异常
 * 例子:该例子中会查询SysUsersEntity对应表中一条name为Tom的数据
 */
SysUsersEntity entity = new SysUsersEntity();
entity.setName("Tom");
SysUsersEntity entity = dao.findOne(entity);
/**
 * 功能:根据sql语句查询单条
 * 特点:查询结果会映射为你提供的参数类型(第二个参数),如果查询结果超过一条,则抛出异常
 * 例子:该例子中会查询SysUsersEntity对应表中一条id为1111的数据
 */
String sql = "select * from sys_users where id = ?";
SysUsersEntity entity = dao.findOne(sql,SysUsersEntity.class,"1111");
/**
 * 功能:根据sql语句查询单条
 * 特点:查询结果会映射为你提供的参数类型(第二个参数);提供动态sql语句服务,根据参数有无动态踢除sql语法段;如果查询结果超过一条,则抛出异常
 * 例子:该例子中会查询SysUsersEntity对应表中一条id为1111的数据
 */
String sql = "select * from sys_users where id = {id1} or id = {id2}";
Map<String,Object> params = new HashMap<>(1);
params.put("id1","1111");
SysUsersEntity entity = dao.findOne(sql,SysUsersEntity.class,params);
/**
 * 功能:根据例子查询数据集
 * 特点:无
 * 例子:该例子中会查询SysUsersEntity对应表name字段值为Tom的所有数据
 */
SysUsersEntity entity = new SysUsersEntity();
entity.setName("Tom");
SysUsersEntity entity = dao.findAll(entity);
/**
 * 功能:根据例子与排序信息Sort查询数据集并排序
 * 特点:提供排序
 * 例子:该例子中会查询SysUsersEntity对应表name字段值为Tom的所有数据,且根据name与code字段做降序排序
 */
Sort sort = new Sort(Sort.Direction.DESC,"name","code");
SysUsersEntity entity = new SysUsersEntity();
entity.setName("Tom");
SysUsersEntity entity = dao.findAll(entity,sort);
/**
 * 功能:根据sql查询数据集
 * 特点:提供动态sql服务,结果为List<T>
 * 例子:该例子中会查询SysUsersEntity对应表id字段值为1111的所有数据
 */
String sql = "select * from sys_users where id = {id1} or id = {id2}";
Map<String,Object> params = new HashMap<>(1);
params.put("id1","1111");
List<SysUsersEntity> entity = dao.findAll(sql,SysUsersEntity.class,params);
/**
 * 功能:根据实体类型查询全表数据
 * 特点:无
 * 例子:该例子中会查询SysUsersEntity对应表全部数据
 */
List<SysUsersEntity> list = dao.findAll(SysUsersEntity.class);
/**
 * 功能:根据sql查询一条数据的一个字段值
 * 特点:提供动态sql服务,结果为Object
 * 例子:该例子中会查询SysUsersEntity对应表id字段值为1111的name字段数据
 * 参数:第二个参数可以为对象数组或Iterable类型
 */
List<SysUsersEntity> list = dao.findAllById(SysUsersEntity.class,new String[]{"1111","2222"});
/**
 * 功能:根据sql查询数据集
 * 特点:提供动态sql服务,结果为List<Map>
 * 例子:该例子中会查询SysUsersEntity对应表id字段值为1111的所有数据
 */
String sql = "select * from sys_users where id = {id1} or id = {id2}";
Map<String,Object> params = new HashMap<>(1);
params.put("id1","1111");
List<Map<String, Object>> entity = dao.findAllBySQL(sql,params);
/**
 * 功能:根据sql查询一条数据的一个字段值
 * 特点:提供动态sql服务,结果为Object
 * 例子:该例子中会查询SysUsersEntity对应表id字段值为1111的name字段数据
 */
String sql = "select name from sys_users where id = {id1}";
Map<String,Object> params = new HashMap<>(1);
params.put("id1","1111");
Object entity = dao.findParameter(sql,params);

  • 分页 查询方法多而杂,本文只例举常用例子,具体用发参照java doc
/**
 * 功能:按照例子查询 + 分页
 * 特点:首页从1计算
 * 例子:该例子中会查询SysUsersEntity对应表首页,10条数据
 */
 int pageSize = 10;
 int pageNum = 1;
SysUsersEntity entity = new SysUsersEntity();
entity.setName("Tom");
Page page = dao.findAll(entity,pageNum,pageSize);
/**
 * 功能:按照例子查询 + 分页 + 排序
 * 特点:首页从1计算
 * 例子:该例子中会查询SysUsersEntity对应表首页,10条数据,且排序
 */
 int pageSize = 10;
 int pageNum = 1;
Sort sort = new Sort(Sort.Direction.DESC,"code");
SysUsersEntity entity = new SysUsersEntity();
entity.setName("Tom");
Page page = dao.findAll(entity,pageNum,pageSize,sort);
/**
 * 功能:按照sql查询 + 分页
 * 特点:首页从1计算
 * 例子:该例子中会查询SysUsersEntity对应表首页,10条数据,且排序
 * 提示:复杂sql建议使用MyBatis进行查询操作
 */
 int pageSize = 10;
 int pageNum = 1;
String sql = "select name from sys_users where id = {id1}";
Map<String,Object> params = new HashMap<>(1);
params.put("id1","1111");
Page page = dao.findPageBySQL(sql,pageNum,pageSize,params);
  • like查询
String sql= "select * from sys_role where name like '%{name}%'";
Page<ParamRoleEntity> page = dao.findPageBySQL(sql, getInParam("pageNum", Integer.class), getInParam("pageSize", Integer.class), ParamRoleEntity.class, getInParam());
  • 批量删除或者更新
// 主键集合,支持Collection类型及数组类型
List<String> ids = getInParamOfArray("ids");
dao.updateBySQL("update sys_users set dele_flag = 1 where sys_users_id in ({ids})", getInParam());
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.

简介

spring-data-jpa扩展 持久层工具合并 使用该组件后,全局仅需要注入唯一的Dao工具,无需再声明其他Dao/Repository,一个工具搞定所有Dao,极大简化持久层代码量。 原生动态sql解析支持 依靠agile-sql(动态sql解析器)实现jpa中对sql语法段的动态解析,弥补其在动态sql解析方面的短板。面对复杂查询语句将不再是难点。 内置slq分页与jpa分页 JPA风格的Do类对象操作形式分页与原生SQL形式分页均返回统一的分页数据格式,且提供total总条数结果 内置字典翻译 依靠agile-dictionary组件,查询过程中会识别@Dictionary注解,如果不需要字典翻译时可以将该组件于pom中直接移除 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/agile-framework/agile-jpa.git
git@gitee.com:agile-framework/agile-jpa.git
agile-framework
agile-jpa
agile-jpa
master

搜索帮助