Iciql 技术文档

本文档旨在帮助用户详细理解并使用 Iciql 项目。以下内容将涵盖安装指南、项目使用说明以及项目 API 使用文档。

1. 安装指南

Iciql 项目可以通过 Maven Central 进行安装。确保你的开发环境已经配置了 Maven。以下是如何在 Maven 项目中添加 Iciql 依赖的示例：

<dependencies>
    <dependency>
        <groupId>com.gitblit.iciql</groupId>
        <artifactId>iciql</artifactId>
        <version>2.2.0</version>
    </dependency>
</dependencies>

如果你需要使用较老的版本，可以从 Iciql Maven Repository 获取。

2. 项目的使用说明

Iciql 是一个基于模型的 JDBC 数据库访问包装器，适用于简单的数据库模式。以下是使用 Iciql 的一些基本步骤：

• 定义模型类：根据你的数据库表创建对应的模型类。
• 连接数据库：使用 Iciql.connect 方法连接到你的数据库。
• 执行查询：使用 Iciql 提供的 fluent API 执行查询。

定义模型类

public class User {
    public Integer id;
    public String name;
    public String email;

    // 省略构造函数、getter 和 setter 方法
}

连接数据库

Iciql.connect("jdbc:mysql://localhost:3306/mydb", "username", "password");

执行查询

List<User> users = Iciql.select().from(User.class).fetch();

3. 项目 API 使用文档

Iciql 提供了一套丰富的 API，用于数据库操作。以下是部分常用 API 的说明：

连接数据库

Iciql.connect(String url, String user, String password);

• url：数据库连接 URL。
• user：数据库用户名。
• password：数据库密码。

查询

List<T> fetch();

• 执行查询并返回结果列表。

插入

int insert(T object);

• 插入一个对象到数据库。

更新

int update(T object);

• 更新数据库中的一个对象。

删除

int delete(T object);

• 删除数据库中的一个对象。

4. 项目安装方式

除了通过 Maven 中心仓库安装外，你还可以使用以下方式安装 Iciql：

使用 Maven 命令行

mvn clean package

• 清理并打包项目。

mvn clean test

• 在默认数据库上运行测试套件。

mvn clean test-compile exec:exec

• 在所有测试数据库上运行测试套件。

通过上述文档，用户应能够顺利安装和使用 Iciql 项目。如需进一步帮助，请访问 iciql 网站 或在 GitHub 上提出问题。