欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Android Jetpack-Room注解详解

程序员文章站 2024-03-17 13:51:34
...

参考:
https://developer.android.google.cn/training/data-storage/room/index.html

https://www.jianshu.com/p/29e5e8c75450

https://www.jianshu.com/p/3e358eb9ac43

1 Room简单使用

@Entity
public class User {
    @PrimaryKey
    public int uid;

    @ColumnInfo(name = "first_name")
    public String firstName;

    @ColumnInfo(name = "last_name")
    public String lastName;
}
@Dao
public interface UserDao {
    @Query("SELECT * FROM user")
    List<User> getAll();

    @Query("SELECT * FROM user WHERE uid IN (:userIds)")
    List<User> loadAllByIds(int[] userIds);

    @Query("SELECT * FROM user WHERE first_name LIKE :first AND " +
            "last_name LIKE :last LIMIT 1")
    User findByName(String first, String last);

    @Insert
    void insertAll(User... users);

    @Delete
    void delete(User user);
}
@Database(entities = {User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
    public abstract UserDao userDao();
}

Make Project后生成如下代码:

Android Jetpack-Room注解详解

创建上述文件后,可以使用以下代码获取已创建的数据库的实例:

 AppDatabase db = Room.databaseBuilder(getApplicationContext(),
                    AppDatabase.class, "database-name").build();

2 Room所有注解

Android Jetpack-Room注解详解

Entity

当一个类被注解为@Entity并且引用到带有@Database 注解的entities属性,Room为这个数据库做的entity创建一个数据表。

  • tableName:设置表名字。默认是类的名字。
  • indices:设置索引。
  • inheritSuperIndices:父类的索引是否会自动被当前类继承。
  • primaryKeys:设置主键。
  • foreignKeys:设置外键。
  • ignoredColumns : 被忽略的字段。
@Entity
public class User {

@Database(entities = {User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {

默认情况下,Room为每个定义在entity中的字段创建一个列。如果一个entity的一些字段你不想持久化,你可以使用@Ignore注解它们,像如下展示的代码片段:

@Entity
public class User {
    @PrimaryKey
    public int uid;

    @ColumnInfo(name = "first_name")
    public String firstName;

    @ColumnInfo(name = "last_name")
    public String lastName;

    @Ignore
    Bitmap picture;
}

为了持久化一个字段,Room必须有它的入口。你可以使字段为public,或者你可以提供一个setter或者getter。如果你使用setter或者getter方法,记住在Room中他们遵守Java Beans的惯例。

tableName

设置表名,如果未设置,默认为类名

@Entity(tableName = "users")
class User {
    ...
}

indices

inheritSuperIndices

primaryKeys

foreignKeys

ignoredColumns


Primary Key(主键)

1 、如果要定义复合主键,则应使用primaryKeys()方法。
(如何表中每一个字段都可能重复,无法使用单一字段作为主键,这时我们可以将多个字段设置为复合主键,由复合主键标识唯一性)

@Entity(primaryKeys = {"firstName", "lastName"})
class User {
}

2、 每个{@Entity}必须声明一个主键,除非它的一个超类声明了主键。如果{@Entity}及其超类都定义了{@PrimaryKey},则子类的{@PrimaryKey}定义将覆盖父项的{@PrimaryKey}。

3、Embedded

参考:
https://blog.csdn.net/zhangphil/article/details/78621009


indices索引

数据库索引用于提高数据库表的数据访问速度的。数据库里面的索引有单列索引和组合索引。Room里面可以通过@Entity的indices属性来给表格添加索引。

@Entity(indices = {@Index("firstName"),
        @Index(value = {"last_name", "address"})})
public class User {
    @PrimaryKey
    public int id;

    public String firstName;
    public String address;

    @ColumnInfo(name = "last_name")
    public String lastName;

    @Ignore
    Bitmap picture;
}

索引也是分两种的唯一索引和非唯一索引。唯一索引就想主键一样重复会报错的。可以通过的@Index的unique数学来设置是否唯一索引。

@Entity(indices = {@Index(value = {"first_name", "last_name"},
        unique = true)})
public class User {
    @PrimaryKey
    public int id;

    @ColumnInfo(name = "first_name")
    public String firstName;

    @ColumnInfo(name = "last_name")
    public String lastName;

    @Ignore
    Bitmap picture;
}

foreignKeys外键

因为SQLite是关系形数据库,表和表之间是有关系的。这也就是我们数据库中常说的外键约束(FOREIGN KEY约束)。Room里面可以通过@Entity的foreignKeys属性来设置外键。我们用一个具体的例子来说明。

当父表中某条记录子表有依赖的时候父表这条记录是不能删除的,删除会报错。一般大型的项目很少会采用外键的形式。一般都会通过程序依赖业务逻辑来保证的。

通过foreignKeys之后Book表中的userId来源于User表中的id,如下:

@Entity(indices = {@Index(value = {"first_name", "last_name"},
        unique = true)})
public class User {
    @PrimaryKey
    public int id;

    @ColumnInfo(name = "first_name")
    public String firstName;

    @ColumnInfo(name = "last_name")
    public String lastName;

    @Ignore
    Bitmap picture;
}

@Entity(foreignKeys = @ForeignKey(entity = User.class,
                                  parentColumns = "id",
                                  childColumns = "user_id"))
public class Book {
    @PrimaryKey
    public int bookId;

    public String title;

    @ColumnInfo(name = "user_id")
    public int userId;
}

Embedded嵌套对象

有些情况下,你会需要将多个对象组合成一个对象。对象和对象之间是有嵌套关系的。Room中你就可以使用@Embedded注解来表示嵌入。然后,您可以像查看其他单个列一样查询嵌入字段。比如有一个这样的例子,User表包含的列有:id, firstName, street, state, city, and post_code。这个时候我们的嵌套关系可以用如下代码来表示。

public class Address {
    public String street;
    public String state;
    public String city;

    @ColumnInfo(name = "post_code")
    public int postCode;
}

@Entity
public class User {
    @PrimaryKey
    public int id;

    public String firstName;

    @Embedded
    public Address address;
}