1 Star 1 Fork 1

Stronger / tiny-jdbc-boot-starter

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

tiny-jdbc-boot-starter

star

1、介绍

tiny-jdbc-boot-starter是一个基于Spring JdbcTemplate 开发的轻量级数据库ORM工具包,同时支持sql操作、实体类映射操作,让操作数据库这件事变得更加简单!

2、使用

2.1、引入依赖

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    <dependency>
        <groupId>org.tinycloud</groupId>
        <artifactId>tiny-jdbc-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>

2.2、配置项

2.2.1 全局配置

tiny-jdbc:
  # 数据库分页类型,目前支持三种(mysql,oracle,db2)
  db-type: mysql

2.2.2 注解说明

@Table
  • 描述:表名注解,标识实体类对应的表
  • 使用位置:实体类
@Table("b_upload_file")
public class UploadFile implements Serializable {
    private static final long serialVersionUID = -1L;
    
    ...
}
@Column
  • 描述:字段注解
  • 使用位置:实体类
@Table("b_upload_file")
public class UploadFile implements Serializable {
    private static final long serialVersionUID = -1L;

    /**
     * 主键,三种主键策略互斥,只能选择其中一种
     * 注意,如果设置为自增主键的话,则此字段必须为Long
     * 如果设置为assignUuid的话,则此字段必须为String
     * 如果设置为assignId的话,则此字段必须为String或者Long
     */
    @Column(value = "id", primaryKey = true, assignId = true)
    private Long id;
    
    @Column("file_id")
    private String fileId;
    
    @Column("file_name_old")
    private String fileNameOld;
}
属性 类型 必须指定 默认值 描述
value String "" 对应数据库字段名
primaryKey boolean false 是否为主键
autoIncrement boolean false 主键策略:自增主键,三种主键策略互斥,只能选择其一
assignId boolean false 主键策略:雪花ID,三种主键策略互斥,只能选择其一
assignUuid boolean false 主键策略:UUID,三种主键策略互斥,只能选择其一

2.3、使用说明

2.3.1、注入BaseDao

    @Autowired
    private BaseDao baseDao;

2.3.2、查询操作

方法 说明
<T> List<T> select(String sql, Class<T> classz, Object... params); 根据给定的sql和实体类型和参数,查询数据库并返回实体类对象列表
List<Map<String, Object>> select(String sql, Object... params); 根据给定的sql和参数,查询数据库并返回Map<String, Object>列表
List<Map<String, Object>> select(String sql); 根据给定的sql,,查询数据库并返回Map<String, Object>列表
<T> T selectOne(String sql, Class<T> classz, Object... params); 根据给定的sql和实体类型和参数,查询数据并返回一个实体类对象
Map<String, Object> selectOne(String sql, Object... params); 根据给定的sql和参数,查询数据并返回一个Map<String, Object>对象
Map<String, Object> selectOne(String sql); 根据给定的sql,,查询数据库并返回一个Map<String, Object>对象
<T> T selectOneColumn(String sql, Class<T> clazz, Object... params); 根据给定的sql和实体类型和参数,查询数据并返回一个值(常用于查count)
<T> Page<T> paginate(String sql, Class<T> clazz, Integer pageNumber, Integer pageSize); 执行分页查询,返回Page对象
<T> Page<T> paginate(String sql, Class<T> clazz, Integer pageNumber, Integer pageSize, Object... params); 执行分页查询,返回Page对象
<T> T selectById(Object id, Class<T> classz); 根据主键ID值,查询数据并返回一个实体类对象
<T> List<T> select(T entity); 实体类里面非null的属性作为查询条件,查询数据库并返回实体类对象列表
<T> Page<T> paginate(T entity, Integer pageNumber, Integer pageSize); 实体类里面非null的属性作为查询条件,执行分页查询
<T> T selectOne(T entity); 实体类里面非null的属性作为查询条件,查询数据并返回一个实体类对象

2.3.3、插入操作

方法 说明
int insert(String sql, final Object... params); 根据提供的SQL语句和提供的参数,执行插入
<T> int insert(T entity); 插入entity里的数据,将忽略entity里属性值为null的属性,如果主键策略为assignId或assignUuid,那将在entity里返回生成的主键值
<T> int insert(T entity, boolean ignoreNulls); 插入entity里的数据,可选择是否忽略entity里属性值为null的属性,如果主键策略为assignId或assignUuid,那将在entity里返回生成的主键值
<T> Long insertReturnAutoIncrement(T entity); 插入entity里的数据,将忽略entity里属性值为null的属性,并且返回自增的主键

2.3.4、修改操作

方法 说明
int update(String sql, final Object... params); 根据提供的SQL语句和提供的参数,执行修改
<T> int updateById(T entity); 根据主键值更新数据,将忽略entity里属性值为null的属性
<T> int updateById(T entity, boolean ignoreNulls); 根据主键值更新数据,可选择是否忽略entity里属性值为null的属性

2.3.5、删除操作

方法 说明
int delete(String sql, final Object... params); 根据提供的SQL语句和提供的参数,执行删除
<T> int deleteById(Object id, Class<T> clazz); 根据主键ID进行删除
<T> int delete(T entity); 根据entity里的属性值进行删除,entity里不为null的属性,将作为参数

3、示例

  1. 查询操作
@Autowired
private BaseDao baseDao;

// 查询所以的项目,返回列表
List<Project> projectList = baseDao.select("select * from t_project_info order by created_at desc", Project.class);

// 查询所以的项目,返回Map列表
List<Map<String, Object>> projectList = baseDao.select("select * from t_project_info order by created_at desc");

// 查询id=1的项目,返回列表
List<Project> projectList = baseDao.select("select * from t_project_info where id = ? ", Project.class, 1);

// 模糊查询项目,返回列表
List<Project> projectList =  baseDao.select("select * from t_project_info where project_name like CONCAT('%', ?, '%')",  Project.class, "测试项目");

// 查询id=1的项目,返回对象
Project project = baseDao.selectOne("select * from t_project_info where id = ? ", Project.class, 1);

// 查询记录数
Integer count = baseDao.selectOneColumn("select count(*) from t_project_info order by created_at desc", Integer.class));

// 分页查询id>100的记录,第一页,每页10个
Page<Project> page = baseDao.paginate("select * from t_project_info order by created_at desc where id > ?", Project.class, 1, 10, 100));

// 查询id=3的项目信息列表
Project project = new Project();
project.setId(3L);
List<Project> projectList = baseDao.select(project)

// 查询id=3的项目信息
Project project = new Project();
project.setId(3L);
Project project = baseDao.selectOne(project);

// 查询id=3的项目信息
Project project = baseDao.selectById(3L, Project.class);

// 分页查询id=3的项目信息,第一页,每页10个
Project project = new Project();
project.setId(3L);
Page<Project> page = baseDao.paginate(project, 1, 10)
  1. 新增操作
@Autowired
private BaseDao baseDao;

// 使用sql插入一条数据
int result = baseDao.insert("insert t_into project_info(project_name, del_flag, remark) values (?,?,?)", "测试项目", 1, "XXXXXXX");

Project project = new Project();
project.setProjectName("xxxx");
project.setDelFlag(1);
project.setCreatedBy("admin");
project.setRemark("XXXX");
// 使用实体类插入一条数据,默认忽略null
int result = baseDao.insert(project);

// 使用实体类插入一条数据,不忽略null
int result = baseDao.insert(project, false);
  1. 更新操作

  2. 删除操作

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.

简介

tiny-jdbc-boot-starter是一个基于Spring JdbcTemplate 开发的轻量级数据库ORM工具包,同时支持sql操作、实体类映射操作,让操作数据库这件事变得更加简单! 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/StrongerAnna/tiny-jdbc-boot-starter.git
git@gitee.com:StrongerAnna/tiny-jdbc-boot-starter.git
StrongerAnna
tiny-jdbc-boot-starter
tiny-jdbc-boot-starter
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891