1 Star 0 Fork 17

luchao111 / mybatis-kits

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

MyBatis-Kits

MyBatis 增强工具包,实现了便捷的单表 CRUD,各种自定义条件查询,以及物理分页查询,单表查询甚至可以做到无 XML,像使用 PHP 操作数据库一样简单。


仓库地址

Note: 会优先在码云更新,GitHub 只有发布版本的时候才会更新

为什么使用 Mybatis-Kits?

  1. 无侵入:Mybatis-Kits 在 Mybatis 的基础上进行扩展,只是内置了简单的CRUD, 并增强了查询功能,并未修改原生 API,支持所有 Mybatis 原生的特性,不会影响项目现有的 Mybatis 架构。
  2. 功能精简:简单到只有你需要的功能,又强大到刚好能满足你的绝大多数业务需求。她不像其他 Mybatis 中间件那么强大,每种功能都提供了各种实现 API,她每种功能都只提供了一种(最优)实现,让你不用还去考虑使用哪个 API 来实现当前的功能,体验不用选择的幸福。如果你刚好像我一样也有选择困难症的话,那她简直是为你量身订做。
  3. 内置分页插件:基于Mybatis物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于写基本List查询
  4. 接入简单:内置提供了 spring-boot-starter,让你 1 分钟接入 SpringBoot 项目。

最新版本

<dependency>
  <groupId>org.rockyang</groupId>
  <artifactId>mybatis-kits-core</artifactId>
  <version>1.5.1</version>
</dependency>

SpringBoot 项目接入方式

<dependency>
  <groupId>org.rockyang</groupId>
  <artifactId>mybatis-kits-spring-boot-starter</artifactId>
  <version>1.5.1</version>
</dependency>

Note: SpringBoot 项目不需要再引入 mybatis-kits-core 了,只导入 mybatis-kits-spring-boot-starter 一个构件就 OK 了。

小试牛刀

假设我们已存在一张 User 表,且已有对应的实体类 User,实现 User 表的 CRUD 操作我们只需创建一个对应的 Mapper 接口就行了。

public interface UserMapper extends BaseMapper<User> { }

基本 CRUD 操作

// 影响行数
int affactRows = 0;
// 初始化 User 实体对象, 如果是非自增ID需要初始化ID
// 系统有内置的分布式 ID 生成工具
User user = new User(IdUtil.getNewId());

// 插入 User (如果是自增ID的话,插入成功会自动回写ID到实体类)
user.setName("Rock");
affactRows = userMapper.add(user);

// 更新 User
user.setAge(18);
affactRows = userMapper.update(user);
// 你也可以这样
affactRows = userMapper.updateAll(user);
/*
   注意:update() 方法只更新 User 实体的非 null 字段,是增量更新
   而 updateAll() 会更新所有字段,包括值为 null 的字段
   
   应用需求:比如你知道用户ID,只想更新 Name 字段,常规方法是下面这样的 
 */
String userId = "abc";
User user = userMapper.get(userId);
user.setName("New name");
userMapper.updateAll(user);
// 或则你也可以这样实现
User user = new User(userId);
user.setName("New name");
userMapper.update(user); // 这样可以少一次查询
// 所以如果你就是要把某个字段更新成 null, 请使用 updateAll()

// 查询 User
User userItem = userMapper.get(user.getId());
// 查询ID > 100 所有用户列表
List<User> userList = userMapper.searchByConditions(
        new Conditions.gt("id", 100)
);
// 如果只想取列表中的一条
User u = userMapper.getByCondition(new Conditions.gt("id", 100));

// 删除 User
affactRows = userMapper.delete(user.getId());
// 删除 id > 100 and id < 200 的所有用户
Conditions condi = new Conditions();
condi.gt("id", 100).lt("id", 200);
affactRows = UserMapper.deleteByConditions(condi);

分页查询(所有分页均为物理分页)

// 查询所有记录并分页
Page<User> page = new Page<>();
page.setPageSize(10);
page = userMapper.search(page);

for (User user : page.getResults()) {
	logger.info("结果:{}",user);
}

// 按照条件查询分页
Conditions condi = new Conditions();
condi.eq("name", "Rock");
Page<User> page = new Page<>();
page.setPageSize(10);
page = userMapper.searchByConditions(page, condi);

for (User user : page.getResults()) {
	logger.info("结果:{}",user);
}

条件组合

MyBatis-Kits 的 Conditions 查询异常强大,几乎可以满足你单表查询的所有需求。

先来个简单的:

Conditions conditions = new Conditions();
conditions.eq("name", "Rock")
    .ge("age", 18)
    .lt("age", 30)
    .ne("address", "Addres_A");
// output: name='Rock' AND age > 18 AND age < 30 AND address != 'Addres_A'

再来个稍微复杂一点的:

Conditions conditions = new Conditions();
conditions.add(Restrictions.and(Restrictions.eq("age",18),Restrictions.eq("name","zhangsan")));
conditions.add(Restrictions.or(Restrictions.eq("count",18),Restrictions.eq("count",29)));
// output: ((age=18 AND name='zhangsan') AND (count=18 OR count=29))

更多复杂条件查询请参考单元测试 org.rockyang.mybatis.boot.demo.test.plus.ConditionTest

上面的所有功能都是不需要创建 Mapper.xml 文档就可以轻松实现的,如果你需要增加联合查询功能,只需增加相应的 UserMapper.xml,在里面实现就好了。 完全兼容原生 MyBatis 的所有功能。

文档

文档正在编写中,尚未完善,本项目里面有 demo 项目,以及大量的单元测试,能够很快上手。

文档项目地址:https://gitee.com/blackfox/mybatis-kits-doc

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.

简介

MyBatis 增强工具包,实现了便捷的单表 CRUD,各种自定义条件查询,以及物理分页查询,像使用 PHP 操作数据库一样简单。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/luchao111/mybatis-kits.git
git@gitee.com:luchao111/mybatis-kits.git
luchao111
mybatis-kits
mybatis-kits
master

搜索帮助