# tysqlite-android-sdk

**Repository Path**: gdty/tysqlite-android-sdk

## Basic Information

- **Project Name**: tysqlite-android-sdk
- **Description**: 一个轻量级的 Android SQLite 数据库管理工具包，适用于需要便捷操作 SQLite 的 Android 项目。
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-27
- **Last Updated**: 2025-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Gitea

## README

# tysqlite-android-sdk

一个轻量级的 Android SQLite 数据库管理工具包，适用于需要便捷操作 SQLite 的 Android 项目。

---

## 📦 引入 SDK

在您的项目的 `build.gradle` 文件中添加以下依赖：

```gradle
repositories {
    maven { url 'https://maven.cnb.cool/gdteyu/gradle/-/packages/' }
}

dependencies {
    implementation 'com.gdty.sqlite:tysqlite-android-sdk:1.0.1'
}
```

---

## 🚀 使用方法

### 初始化数据库

使用 `DbManger` 类来管理数据库的初始化和操作。构造函数需要传入上下文、数据库路径、版本号和 `SQLVo` 对象。

```java
SQLVo sqlVo = new SQLVo();
sqlVo.setInitSql("CREATE TABLE IF NOT EXISTS user (id INTEGER PRIMARY KEY, name TEXT);");

DbManger dbManager = new DbManger(context, "/data/data/your.package/databases/test.db", 1, sqlVo);
```

### 获取数据库实例

```java
SQLiteDatabase db = dbManager.getWritableDatabase(); // 或 getReadableDatabase();
```

### 执行 SQL 语句

```java
dbManager.execSQL("INSERT INTO user (name) VALUES ('张三')");
```

### 查询数据

```java
List<Map<String, Object>> result = dbManager.query("user", null, null, null);
```

### 执行多条 SQL 语句

```java
String[] sqls = {
    "INSERT INTO user (name) VALUES ('李四')",
    "INSERT INTO user (name) VALUES ('王五')"
};
dbManager.execMoreSQL(sqls);
```

---

## 📁 数据库升级

通过 `SQLVo` 添加升级脚本，当数据库版本变更时自动执行升级语句。

```java
List<UpdateVo> updateList = new ArrayList<>();
UpdateVo updateVo = new UpdateVo();
updateVo.setVersion(2);
updateVo.setSql("ALTER TABLE user ADD COLUMN age INTEGER");
updateList.add(updateVo);

sqlVo.setUpdateSql(updateList);
```

---

## 📄 JSON 工具类

使用 `JsonUtils` 快速序列化和反序列化 Java 对象。

```java
User user = new User("张三", 25);
String json = JsonUtils.serialize(user);
User parsedUser = JsonUtils.deserialize(json, User.class);
```

---

## 🧪 单元测试

查看 `ExampleInstrumentedTest.java` 和 `ExampleUnitTest.java` 获取完整的测试用例。

---

## 📚 项目结构说明

- `DbManger`: 数据库管理类，提供增删改查接口。
- `DBHelper`: 继承自 `SQLiteOpenHelper`，负责数据库创建与升级。
- `SQLVo` / `UpdateVo`: 数据库初始化和升级脚本的封装类。
- `JsonUtils`: 提供基于 Gson 的 JSON 序列化与反序列化工具。

---

## 📝 许可证

本项目遵循开源许可协议，请参考项目中的 LICENSE 文件获取详细信息。