https://github.com/yiding-he/hydrogen-dao
A Lightweight JDBC Access Framework
https://github.com/yiding-he/hydrogen-dao
dao java jdbc
Last synced: about 1 year ago
JSON representation
A Lightweight JDBC Access Framework
- Host: GitHub
- URL: https://github.com/yiding-he/hydrogen-dao
- Owner: yiding-he
- License: apache-2.0
- Created: 2018-08-16T11:36:38.000Z (almost 8 years ago)
- Default Branch: 6.0.0-jdk17
- Last Pushed: 2025-04-18T02:48:39.000Z (about 1 year ago)
- Last Synced: 2025-04-18T15:29:23.622Z (about 1 year ago)
- Topics: dao, java, jdbc
- Language: Java
- Homepage:
- Size: 5.18 MB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
-blue.svg)
# hydrogen-dao
hydrogen-dao 是一个 Java 的轻量级的数据库访问库，依赖标准的 JDBC 接口。主要功能有：
* 执行带参数的查询和更新；
* 查询结果自动转为 Java Bean；
* 根据参数值来动态组装 SQL 语句；
* 简化数据库事务；
* 简化分页查询和批处理；
* 连接池管理，状态查看。
使用方法参考源码下的 `docs` 目录。
分支版本：
- `6.X` 基于 Java 17 开发，ArtifactId 为 `hydrogen-dao-j17`；
- `4.X` 基于 Java 11 开发；
- `3.X` 及以下版本基于 Java 8 开发。
同一个项目中只能使用一个版本，不能多版本同时存在。
## 添加依赖关系
请在 pom.xml 的 `` 元素当中添加下面的内容：
```xml
com.github.yiding-he
hydrogen-dao-j17
${hydrogen-dao.version}
```
## 示例
### 初始化
```java
// 初始化 DataSource 对象
DataSource dataSource = ...
// 将 DataSource 对象注册到 DataSources
com.hyd.dao.DataSources.getInstance().setDataSource("default", dataSource);
// 获得针对某个数据源的 DAO 对象
DAO dao = new DAO("default");
```
### Spring Boot 自动初始化
如果你的项目是基于 Spring Boot，那么可以简化上面的过程。首先添加下面的依赖关系：
```xml
com.github.yiding-he
spring-boot-starter-hydrogen-dao
${hydrogen-dao.version}
```
然后在 `application.properties` 中配置数据源：
```properties
spring.datasource.url = [JDBC URL]
spring.datasource.driver-class-name = [JDBC Driver]
spring.datasource.username = [USERNAME]
spring.datasource.password = [PASSWORD]
```
这样就可以在代码中直接获取 DAO 对象了，例如：
```java
@Controller
public class HomeController {
@Autowired
private DAO dao; // 直接获取 DAO 对象
}
```
### 查询记录
```Java
List userList = dao.query(
User.class, // 包装类（可选）
"select * from USER where NAME like ? and ROLE=?", // 语句
"admin%", 3); // 参数（可选）
userList.forEach(user -> {
System.out.println("user name: " + user.getName());
});
```
### 执行带参数名的 SQL
```Java
MappedCommand cmd =
new MappedCommand("update USERS set ROLE=#role# where ID in(#userid#)")
.setParam("role", "admin")
.setParam("userid", 1, 2, 3, 4); // 数组或 List 都可以
dao.execute(cmd);
```
> `MappedCommand` 并非用字符串替换来生成最终 SQL，而仍然使用 PreparedStatement 并设置每个参数，以保证安全性。
### 构造动态查询条件
```Java
dao.query(SQL
.Select("ID", "NAME", "DESCRIPTION")
.From("USERS")
.Where("ID in ?", 10, 22, 135) // 会自动扩展为 "ID in (?,?,?)"。也可以用 List 作为参数
.And(disabled != null, "DISABLED=?", disabled) // 仅当变量 disabled 值不为 null 时才会加入该查询条件
.AndIfNotEmpty("DISABLED=?", disabled) // 效果同上
);
```
### 执行事务
```Java
final DAO dao = getDAO();
DAO.runTransaction(() -> { // 所有事务都以 Runnable 的方式执行，简单明了
dao.execute("insert into USER(id,name) values(?,?)", 1, "user1");
throw new RuntimeException(); // 之前的 insert 将会回滚，同时抛出该异常
});
```
## 更新
#### 2022-06-12
* 版本号更新到 6.0.0，要求 JDK 版本 17
* artifact-id 改为 hydrogen-dao-j17
#### 2021-10-19
* 版本号更新到 4.0.2 并正式发布到 Maven
* 修复若干BUG
#### 2021-10-09
* 版本号更新到 4.0.0 并正式发布到 Maven
* 修复自 4.0.0-SNAPSHOT 以来的一些小问题
#### 2020-10-31
* 版本号更新到 4.0.0-SNAPSHOT；
* Page 类不再继承 ArrayList，因为序列化出来的 JSON 内容缺少分页属性；
* DataSources 类现在是单例模式，节省其在 Spring 或其他 IoC 容器中初始化的步骤；
* SQL 类支持 Join 语法。
#### 2020-07-25
* 版本号更新到 3.5.1；
* 删除对 fastjson 的依赖；
* 修复若干 BUG。
#### 2019-10-11
* 版本号更新到 3.5.0；
* 用 Swing 重写代码生成工具；
* 删除之前的基于 JavaFX 的代码生成工具；
#### 2019-10-02
* 将 Spring Boot 自动初始化移到单独的模块独立发布
#### 2019-10-01
* hydrogen-dao 版本 3.3.0 发布到了 Maven 中心库。
#### 2019-08-12
* Spring Boot 自动配置现在只支持单数据源，因为 Spring JDBC 本身只支持这么做。
#### 2019-03-11
* 版本号升级到 3.3.0-SNAPSHOT
* 允许自定义数据库字段名和类属性名之间的映射规则，参见 `DataSources.setColumnNameConverter()`
#### 2019-01-17
* 修改 Spring Boot 自动配置部分的[相关文档](docs/09-spring-boot-autoconfig.md)
#### 2018-07-09
* 实现基于 JavaFX 的代码生成工具，在 Maven 目录结构下生成 Pojo、Repository
及对应的单元测试代码。[视频演示](https://www.bilibili.com/video/av22590671/)
* 修复若干 BUG，详见日志
#### 2018-04-21
* 删除对 Apache commons-lang3 的依赖关系
* 修复 Spring Boot Auto Configuration 的问题
* 自动配置时根据 JDBC URL 来猜测 Driver 类，无需手动指定
* 自动配置当没有找到可用的连接池时，使用 com.hyd.dao.database.NonPooledDataSource
#### 2018-04-07
* 版本号升级到 3.0.0 开发版
* 添加 Spring Boot Auto Configuration，使用 spring.datasource 配置来自动创建 DAO 对象
#### 2017-12-22:
* 修复了 insert 对象的时候无法正确映射父类成员的问题。
#### 2017-12-20:
* 版本号升级到 2.6.0-SNAPSHOT
* Java 依赖版本更新到 8.0
* RowIterator 新增 setRowPreProcessor() 方法，用于返回 Row 对象前进行预处理。
* DAO.queryIterator() 方法新增 Consumer 类型的参数。
#### 2017-04-12:
* 修复了 MySQL 下插入对象时表的字段名如果是 MySQL 保留关键字的话会执行失败的问题
#### 2017-01-01:
* commons-lang 依赖关系升级到 commons-lang3
* commons-dbcp 依赖关系升级到 commons-dbcp2
* Java 最低要求升级到 1.7
* 版本号升级到 2.5.0-SNAPSHOT
#### 2016-10-19:
* 添加对 H2 数据库的支持
#### 2015-12-27:
* 修复 Page 类计算总页数不正确的 BUG
#### 2015-05-28:
* 修复了一个对 SQL.Generatable 对象调用多次 toCommand() 方法返回的内容不一致的 BUG
#### 2015-03-22:
* 将数据库差异集中到 CommandBuilderHelper 的子类中去，去掉 DefaultExecutor 的子类。
* 添加对 HSQLDB 分页查询的支持
#### 2015-03-20:
* 以自适应的方式支持 logback/log4j/log4j2 三种日志输出框架。使用 hydrogen-dao 的项目可以自行选择。
* 版本升级到 2.3.0-SNAPSHOT。
## 文档
具体的文档都在源代码 docs 目录下。