Jetpack下的Room简单使用

概述

Room持久性库在SQLite的基础上提供了一个抽象层,让用户能够在充分利用SQLite的强大功能的同时,获享更强健的数据库访问机制。

添加依赖

在app的build.gradle中添加如下依赖:


def room_version ="2.2.6"

implementation"androidx.room:room-runtime:$room_version"

annotationProcessor"androidx.room:room-compiler:$room_version" // For Kotlin use kapt instead of annotationProcessor

// Test helpers

testImplementation"androidx.room:room-testing:$room_version"

在app的build.gradle文件中,配置schemaLocation选项为app/schemas,方便我们查看数据库架构信息。


defaultConfig{

...

    //指定room.schemaLocation生成的文件路径

    javaCompileOptions{

        annotationProcessorOptions{

            arguments =["room.schemaLocation":"$projectDir/schemas".toString()]

}

}

}

等我们创建好表和数据库等信息的时候,编译一下,会在app/schemas目录下生成这样的Json文件。


QQ20210715-103958@2x.png

创建一个实体类,对应数据库中的一张表


@Entity(tableName ="User" ,indices ={@Index(value ={"user_name"}, unique =true)})//数据库实体

public class User {

    @PrimaryKey(autoGenerate =true)

    private long id;

@ColumnInfo(name ="user_name")

    private String name;

@ColumnInfo(name ="user_gender")

    private String gender;

private int age;

private int type;

public User() {

}

    public User(long id,String name,String gender,int age,int type) {

        this.id = id;

this.name = name;

this.gender = gender;

this.age = age;

this.type = type;

}

    public User(String name,String gender,int age,int type) {

        this.name = name;

this.gender = gender;

this.age = age;

this.type = type;

}

  • @Entity:注解的类对应数据库中的一张表,我们可以指定表名,如果不指定的话,默认是类的名字。

  • @PrimaryKey:每一个表都需要一个主键,这点需要注意,Room就是根据主键是否相同来判断是否是同一个对象。

  • @ColumnInfo:指定类的属性在表中列的名字,如果不指定,默认就是属性名。

  • 注意,存储在数据库中的类属性可见性必须是public的。

创建DAO(data access object)

DAO必须是接口或者抽象类,Room使用注解帮我们生成访问数据库的代码,感觉和Retrofit有类似之处。接下来我们创建一个DAO类,具有简单的增删改查的功能。


@Dao //Database access object 数据库访问接口 所有增删改查等操作都在此声明

public interface UserDao {

    // long 表示插入数据后返回的id

    @Insert(onConflict =OnConflictStrategy.REPLACE)

    void insertUser(User... user);

// int 影响的行数

    @Update

    int updateUser(User... user);

@Delete

    int deleteUser(User... user);

@Query("DELETE FROM USER")

    void deleteUser();

@Query("SELECT * FROM USER ORDER BY ID DESC")

    List<User> getAllUser();

@Query("SELECT * FROM USER ORDER BY ID DESC")

    LiveData<List<User>> getAllUserLive();

}

添加Room数据库


//exportSchema = false 是不会导出 schemas json 结构

@Database(entities ={User.class}, version =2, exportSchema =true)

public abstract class UserDatabase extends RoomDatabase {

    public abstract UserDao getUserDao();

private static UserDatabase userDatabase;

synchronized public static UserDatabase getUserDatabase(Context context) {

        if (null ==userDatabase) {

            userDatabase =Room.databaseBuilder(context.getApplicationContext(),UserDatabase.class,"android_room_dev.db")

                    .allowMainThreadQueries()

                    .addMigrations(migration) //保留原有数据

                    .build();

}

        return userDatabase;

}

    static final Migration migration =new Migration(1,2) {

        @Override

        public void migrate(@NonNull SupportSQLiteDatabase database) {

            database.execSQL("ALTER TABLE user ADD COLUMN type INTEGER NOT NULL DEFAULT 1");

//sqlLet没有删除字段语句,只能创建新的数据库定义需要的字段,将原有数据库数据复制过去,删除旧数据库后再将新数据库重命名

        }

    };

}

Room数据库必须是一个继承自RoomDatabase的抽象类。通常情况下应用内应该只有一个Room数据库实例。

在demo中的简单使用


public class MainActivity extends AppCompatActivity {

    TextView tvAdd;

TextView tvUpdate;

TextView tvDelete;

TextView tvQuery;

TextView tvQueryAll;

TextView tvContent;

UserDatabase userDatabase;

@Override

    protected void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);

userDatabase =UserDatabase.getUserDatabase(this);

setContentView(R.layout.activity_main);

tvAdd = findViewById(R.id.tv_add);

tvUpdate = findViewById(R.id.tv_update);

tvDelete = findViewById(R.id.tv_delete);

tvQuery = findViewById(R.id.tv_query);

tvQueryAll = findViewById(R.id.tv_queryAll);

tvContent = findViewById(R.id.tv_content);

UserDao userDao =userDatabase.getUserDao();

LiveData<List<User>> listLiveData =userDao.getAllUserLive();

listLiveData.observe(this,new Observer<List<User>>() {

            @Override

            public void onChanged(List<User> users) {

                String s ="";

for (int i =0; i < users.size(); i++) {

                    User user = users.get(i);

s +="姓名:" +user.getName() +"性别:" +user.getGender() +"年龄:" +user.getAge() +"类型:" +user.getType() +"\n";

}

                tvContent.setText(s);

}

        });

tvAdd.setOnClickListener(new View.OnClickListener() {

            @Override

            public void onClick(View view) {

                User user =new User();

user.setName("张三" +new Random().nextInt(100));

user.setAge(new Random().nextInt(100));

user.setGender(new Random().nextInt(1) +"");

user.setType(new Random().nextInt(9));

userDao.insertUser(user);

}

        });

tvUpdate.setOnClickListener(new View.OnClickListener() {

            @Override

            public void onClick(View view) {

                List<User> users =userDao.getAllUser();

User user =users.get(0);

user.setName("玛丽哈利");

userDao.updateUser(user);

}

        });

tvDelete.setOnClickListener(new View.OnClickListener() {

            @Override

            public void onClick(View view) {

                List<User> users =userDao.getAllUser();

if(users!=null &&users.size()>0){

                    User user =users.get(0);

userDao.deleteUser(user);

}

}

        });

tvQuery.setOnClickListener(new View.OnClickListener() {

            @Override

            public void onClick(View view) {

                List<User> users =userDao.getAllUser();

String s ="";

for (int i =0; I

                    User user =users.get(i);

s +="姓名:" +user.getName() +"性别:" +user.getGender() +"年龄:" +user.getAge() +"类型:" +user.getType() +"\n";

}

                Toast.makeText(MainActivity.this,s,Toast.LENGTH_LONG).show();

}

        });

tvQueryAll.setOnClickListener(new View.OnClickListener() {

            @Override

            public void onClick(View view) {

}

        });

}

}

```**概述**

Room持久性库在SQLite的基础上提供了一个抽象层,让用户能够在充分利用SQLite的强大功能的同时,获享更强健的数据库访问机制。

**添加依赖**

在app的build.gradle中添加如下依赖:

def room_version ="2.2.6"

implementation"androidx.room:room-runtime:$room_version"

annotationProcessor"androidx.room:room-compiler:$room_version" // For Kotlin use kapt instead of annotationProcessor

// Test helpers

testImplementation"androidx.room:room-testing:$room_version"


**在app的build.gradle文件中,配置schemaLocation选项为app/schemas,方便我们查看数据库架构信息。**

defaultConfig{

...

//指定room.schemaLocation生成的文件路径

javaCompileOptions{

    annotationProcessorOptions{

        arguments =["room.schemaLocation":"$projectDir/schemas".toString()]

}

}

}


等我们创建好表和数据库等信息的时候,编译一下,会在app/schemas目录下生成这样的Json文件。

【 ! + [图片名称] + (https://upload-images.jianshu.io/upload_images/7182690-7cae1e445eb5801c.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1200) 】

**创建一个实体类,对应数据库中的一张表**

@Entity(tableName ="User" ,indices ={@Index(value ={"user_name"}, unique =true)})//数据库实体

public class User {

@PrimaryKey(autoGenerate =true)

private long id;

@ColumnInfo(name ="user_name")

private String name;

@ColumnInfo(name ="user_gender")

private String gender;

private int age;

private int type;

public User() {

}

public User(long id,String name,String gender,int age,int type) {

    this.id = id;

this.name = name;

this.gender = gender;

this.age = age;

this.type = type;

}

public User(String name,String gender,int age,int type) {

    this.name = name;

this.gender = gender;

this.age = age;

this.type = type;

}


+  @Entity:注解的类对应数据库中的一张表,我们可以指定表名,如果不指定的话,默认是类的名字。

+  @PrimaryKey:每一个表都需要一个主键,这点需要注意,Room就是根据主键是否相同来判断是否是同一个对象。

+  @ColumnInfo:指定类的属性在表中列的名字,如果不指定,默认就是属性名。

+  注意,存储在数据库中的类属性可见性必须是public的。

**创建DAO(data access object)**

DAO必须是接口或者抽象类,Room使用注解帮我们生成访问数据库的代码,感觉和Retrofit有类似之处。接下来我们创建一个DAO类,具有简单的增删改查的功能。

@Dao //Database access object 数据库访问接口 所有增删改查等操作都在此声明

public interface UserDao {

// long 表示插入数据后返回的id

@Insert(onConflict =OnConflictStrategy.REPLACE)

void insertUser(User... user);

// int 影响的行数

@Update

int updateUser(User... user);

@Delete

int deleteUser(User... user);

@Query("DELETE FROM USER")

void deleteUser();

@Query("SELECT * FROM USER ORDER BY ID DESC")

List<User> getAllUser();

@Query("SELECT * FROM USER ORDER BY ID DESC")

LiveData<List<User>> getAllUserLive();

}


**添加Room数据库**

//exportSchema = false 是不会导出 schemas json 结构

@Database(entities ={User.class}, version =2, exportSchema =true)

public abstract class UserDatabase extends RoomDatabase {

public abstract UserDao getUserDao();

private static UserDatabase userDatabase;

synchronized public static UserDatabase getUserDatabase(Context context) {

    if (null ==userDatabase) {

        userDatabase =Room.databaseBuilder(context.getApplicationContext(),UserDatabase.class,"android_room_dev.db")

                .allowMainThreadQueries()

                .addMigrations(migration) //保留原有数据

                .build();

}

    return userDatabase;

}

static final Migration migration =new Migration(1,2) {

    @Override

    public void migrate(@NonNull SupportSQLiteDatabase database) {

        database.execSQL("ALTER TABLE user ADD COLUMN type INTEGER NOT NULL DEFAULT 1");

//sqlLet没有删除字段语句,只能创建新的数据库定义需要的字段,将原有数据库数据复制过去,删除旧数据库后再将新数据库重命名

    }

};

}


Room数据库必须是一个继承自RoomDatabase的抽象类。通常情况下应用内应该只有一个Room数据库实例。

**在demo中的简单使用**

public class MainActivity extends AppCompatActivity {

TextView tvAdd;

TextView tvUpdate;

TextView tvDelete;

TextView tvQuery;

TextView tvQueryAll;

TextView tvContent;

UserDatabase userDatabase;

@Override

protected void onCreate(Bundle savedInstanceState) {

    super.onCreate(savedInstanceState);

userDatabase =UserDatabase.getUserDatabase(this);

setContentView(R.layout.activity_main);

tvAdd = findViewById(R.id.tv_add);

tvUpdate = findViewById(R.id.tv_update);

tvDelete = findViewById(R.id.tv_delete);

tvQuery = findViewById(R.id.tv_query);

tvQueryAll = findViewById(R.id.tv_queryAll);

tvContent = findViewById(R.id.tv_content);

UserDao userDao =userDatabase.getUserDao();

LiveData<List<User>> listLiveData =userDao.getAllUserLive();

listLiveData.observe(this,new Observer<List<User>>() {

        @Override

        public void onChanged(List<User> users) {

            String s ="";

for (int i =0; i < users.size(); i++) {

                User user = users.get(i);

s +="姓名:" +user.getName() +"性别:" +user.getGender() +"年龄:" +user.getAge() +"类型:" +user.getType() +"\n";

}

            tvContent.setText(s);

}

    });

tvAdd.setOnClickListener(new View.OnClickListener() {

        @Override

        public void onClick(View view) {

            User user =new User();

user.setName("张三" +new Random().nextInt(100));

user.setAge(new Random().nextInt(100));

user.setGender(new Random().nextInt(1) +"");

user.setType(new Random().nextInt(9));

userDao.insertUser(user);

}

    });

tvUpdate.setOnClickListener(new View.OnClickListener() {

        @Override

        public void onClick(View view) {

            List<User> users =userDao.getAllUser();

User user =users.get(0);

user.setName("玛丽哈利");

userDao.updateUser(user);

}

    });

tvDelete.setOnClickListener(new View.OnClickListener() {

        @Override

        public void onClick(View view) {

            List<User> users =userDao.getAllUser();

if(users!=null &&users.size()>0){

                User user =users.get(0);

userDao.deleteUser(user);

}

}

    });

tvQuery.setOnClickListener(new View.OnClickListener() {

        @Override

        public void onClick(View view) {

            List<User> users =userDao.getAllUser();

String s ="";

for (int i =0; I

                User user =users.get(i);

s +="姓名:" +user.getName() +"性别:" +user.getGender() +"年龄:" +user.getAge() +"类型:" +user.getType() +"\n";

}

            Toast.makeText(MainActivity.this,s,Toast.LENGTH_LONG).show();

}

    });

tvQueryAll.setOnClickListener(new View.OnClickListener() {

        @Override

        public void onClick(View view) {

}

    });

}

}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,874评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,102评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,676评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,911评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,937评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,935评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,860评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,660评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,113评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,363评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,506评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,238评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,861评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,486评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,674评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,513评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,426评论 2 352

推荐阅读更多精彩内容