android jetpack room 数据库工具使用

一航jason2023-08-15 9:08

当您开始使用Android Room时，下面是一些使用步骤和示例代码供您参考：

添加依赖项：在您的项目的build.gradle文件中，添加以下依赖项以使用Android Room：

java 复制代码

// room
    def room_version = "2.5.0"
    api "androidx.room:room-runtime:$room_version"
    annotationProcessor "androidx.room:room-compiler:$room_version"

创建实体类：创建一个用@Entity注解的类来表示数据库中的表，其中每个字段都应该用@ColumnInfo注解进行注释。还可以使用@PrimaryKey和@ForeignKey等注解来定义主键和外键关系。

示例代码：

java 复制代码

@Entity(tableName = "users")
data class User(
    @PrimaryKey(autoGenerate = true) val id: Int?,
    @ColumnInfo(name = "name") val name: String,
    @ColumnInfo(name = "age") val age: Int
)

创建DAO接口：创建一个带有对数据库执行操作的接口。使用@Dao注解标记该接口，使用@Query、@Insert、@Update和@Delete等注解定义具体的操作。

示例代码：

kotlin 复制代码

@Dao
interface UserDao {
    @Query("SELECT * FROM users")
    fun getAllUsers(): List<User>

    @Query("SELECT * FROM users WHERE id = :userId")
    fun getUserById(userId: Int): User

    @Insert
    fun insertUser(user: User)

    @Update
    fun updateUser(user: User)

    @Delete
    fun deleteUser(user: User)
}

创建数据库：创建一个继承自RoomDatabase的抽象类，并在其中声明数据库的实例和具体的DAO接口。使用@Database注解标记该类，并在注解中指定数据库版本号和包含的实体类。

示例代码：

kotlin 复制代码

@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

初始化数据库：在您的应用程序中的某个地方，通过调用Room.databaseBuilder()方法来构建数据库的实例。

示例代码：

kotlin 复制代码

val db = Room.databaseBuilder(
    applicationContext,
    AppDatabase::class.java, "my-database"
).build()

执行操作：通过访问DAO接口的方法，在数据库上执行具体的操作。

kotlin 复制代码

val userDao = db.userDao()

val users = userDao.getAllUsers()
val user = userDao.getUserById(userId)

val newUser = User(null, "John Doe", 25)
userDao.insertUser(newUser)
userDao.updateUser(user)
userDao.deleteUser(user)

这只是Android Room的基本用法示例。您可以根据自己的需求添加更多操作和查询。