Yank 技术文档

Yank 是一个轻量级的 JDBC 持久层框架，旨在简化 JDBC 数据库操作。以下是 Yank 的安装指南、使用说明以及 API 使用文档。

1. 安装指南

要使用 Yank，首先需要确保你的环境中已经安装了 JDBC 驱动。以下是安装 Yank 的步骤：

• 将 Yank 的 JAR 文件添加到项目的类路径中。
• 如果需要，将 HikariCP 连接池的 JAR 文件也添加到类路径中。
• 确保你的项目依赖于 Apache DBUtils。

2. 项目使用说明

Yank 的使用非常简单，以下是基本的使用步骤：

1. 配置连接池。
2. 使用 Yank 提供的方法执行 SQL 语句。
3. 释放连接池。

配置连接池

Properties dbProps = new Properties();
dbProps.setProperty("jdbcUrl", "jdbc:mysql://localhost:3306/YourDatabase");
dbProps.setProperty("username", "yourUsername");
dbProps.setProperty("password", "yourPassword");
Yank.setupDefaultConnectionPool(dbProps);

执行 SQL 语句

String sql = "SELECT * FROM Books WHERE title = ?";
Object[] params = new Object[] { "YourBookTitle" };
Book book = Yank.queryBean(sql, Book.class, params);

释放连接池

Yank.releaseDefaultConnectionPool();

3. 项目 API 使用文档

以下是 Yank 的一些常用 API 方法：

• queryBean: 执行 SELECT 语句并返回单个 POJO。
• queryBeanList: 执行 SELECT 语句并返回 POJO 列表。
• execute: 执行 INSERT、UPDATE、DELETE 等语句。
• insert: 执行 INSERT 语句并返回自增主键 ID。
• queryColumnList: 查询某一列并返回数据列表。
• querySingleScalar: 查询单个标量值。

4. 项目安装方式

Yank 可以通过以下方式添加到你的项目中：

• 手动下载 Yank 的 JAR 文件并将其添加到项目的类路径中。
• 使用 Maven 或 Gradle 等构建工具添加依赖项。

Maven 依赖

<dependency>
    <groupId>org.knowm.yank</groupId>
    <artifactId>yank</artifactId>
    <version>最新版本</version>
</dependency>

Gradle 依赖

dependencies {
    implementation 'org.knowm.yank:yank:最新版本'
}

确保替换 "最新版本" 为当前最新的 Yank 版本。

通过上述步骤，你可以轻松地将 Yank 集成到你的 Java 项目中，并开始享受其提供的便捷性。