Skip to content

Java|Kotlin 安装与兼容性

qiuwenchen edited this page May 7, 2024 · 3 revisions

Android 项目接入 WCDB,主要是通过 Maven 接入。

通过 Maven 接入

在 APP 模块的 build.gradle 下添加 WCDB 依赖即可

dependencies {
    // 以下示例修改"2.1.0"为最新版本号
    implementation 'com.tencent.wcdb:main:2.1.4' // WCDB主模块,包含所有类和接口
    implementation 'com.tencent.wcdb:annotation:2.1.4' // 包含用于ORM配置的注解
    
    // 下面两个配置选择配置一个,apt和ksp选用一个,不能同时配置
    annotationProcessor 'com.tencent.wcdb:compiler:2.1.4'
    // 如果要使用Kotlin的ORM则需要配置ksp,使用ksp还需要专门为ksp做一些环境配置,请自行了解
    ksp 'com.tencent.wcdb:compiler:2.1.4'
    
    // 如果要兼容使用WCDB 1.0版本或Android SDK SQLite的接口,则配置下面这个依赖
    implementation 'com.tencent.wcdb:compat:2.1.4' 
}

迁移到 WCDB 新版本

对于之前已经使用了WCDB 1.0版本或者 Android SDK SQLite 框架的开发者,如果不想改旧代码,需要做一些简单的配置来适配。

首先是如上添加com.tencent.wcdb:compat模块的依赖,这个模块包含了WCDB 1.0版本和 Android SDK SQLite 框架绝大部分接口,只需要将 import 里的 android.database.*com.tencent.wcdb.*改为com.tencent.wcdb.compat.*即可。而且旧逻辑中创建的SQLiteDatabase对象,可以通过其getInnerDB方法即可拿到新版接口的Database对象,这样就能将新旧逻辑写到一块使用。

关于WCDB新版本的使用,请继续按顺序看后续的文档。

Clone this wiki locally