Android Room的使用

Android 应用数据存储简单来说有这么几种：文件存储、SharedPreference 存储、SQLite 数据库存储，第三方的网上数据库存储。 当需要本地存储大量数据的时候，文件存储频繁读取文件内容修改保存是很耗时， SharedPreference 无法支持大量数据。 这时候本地原生的SQLite 虽然符合，但是编程过程不太友好，所幸的是Google 在其基础上的封装,就有了今天推荐的轻量级数据库----Room 。

先上图再说吧：

image
image
image
image

导入依赖 (最新版本请点击官网查询)


    implementation "android.arch.persistence.room:runtime:2.0.0"
    annotationProcessor "android.arch.persistence.room:compiler:2.0.0"

创建数据库

相信各位小伙伴都是有一定的SQL相关基础知识，我们首先是需要创建数据库，在数据库中创建一张表，表中设计我们要操作的数据对象。在Room中对应的注解如下

  • @Database数据库：必须是扩展 RoomDatabase 的抽象类
  • @Entity：表示数据库中的表
  • @DAO：数据操作对象

例子：创建一个学生数据库（StudentDB）, 这个数据库有一张 学生表（StudentEntity），StudentDao 用于提供对学生表的各种增删查改

StudentDB 代码如下

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

    public abstract StudentDao studentDao();

}

StudentEntity 代码如下

@Entity
public class StudentEntity {

    @PrimaryKey
    private long studentID;
    private String name;
    private int age;

    public StudentEntity() {
    }

    @Ignore
    public StudentEntity(long studentID,String name, int age) {
        this.studentID=studentID;
        this.name = name;
        this.age = age;
    }

    public long getStudentID() {
        return studentID;
    }

    public void setStudentID(long studentID) {
        this.studentID = studentID;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "StudentEntity{" +
                "studentID=" + studentID +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }

@PrimaryKey 是我们设置的主键，因为主键类型Long,INT，我们也可以写成@PrimaryKey(autoGenerate = true)，选择由数据库自动生成。

StudentDao 代码如下

@Dao
public interface StudentDao {

@Insert(onConflict = OnConflictStrategy.REPLACE)
void insert(StudentEntity studentEntity);

@Insert(onConflict = OnConflictStrategy.REPLACE)
void insertList(List<StudentEntity> studentEntities);

@Query("delete from StudentEntity where studentID=:studentID")
void deleteStudent(long studentID);

@Query("select * from StudentEntity")
List<StudentEntity> getAll();

@Query("select * from StudentEntity where studentID=:studentID")
StudentEntity queryStudent(long studentID);

@Update
void updateStudent(StudentEntity studentEntity);

}

操作对象StudentDao 的增删查改（数据可以批量也可单独操作，如插入这边写了批量和单独的操作，其它也是类似，故不多写）

如果是插入数据只需要标记上Insert注解，onConflict = OnConflictStrategy.REPLACE 表明插入一条数据如果主键已经存在，则可以直接替换旧的数据。

 @Insert(onConflict = OnConflictStrategy.REPLACE)
    void insert(StudentEntity studentEntity);

@Insert(onConflict = OnConflictStrategy.REPLACE)
void insertList(List<StudentEntity> studentEntities);

删除操作，可以执行我们写入的SQL语句

@Query("delete from StudentEntity where studentID=:studentID")
void deleteStudent(long studentID);

也可通过@Delete 传入对象删除

@Delete
void deleteStudent(StudentEntity studentEntity);

查询，通过注解@Query 执行SQL语句

@Query("select * from StudentEntity")
List<StudentEntity> getAll();

@Query("select * from StudentEntity where studentID=:studentID")
StudentEntity queryStudent(long studentID);

更改，通过注解 @Update 传入对象更新数据

@Update
void updateStudent(StudentEntity studentEntity);

然后在主界面创建本地持久化的数据库
第一个传入的是上下文，第二个是我们注解了的@Database 与扩展了RoomDatabase 的类，第三个是创建的数据库文件的名称，是个字符串。

方法一（对数据增删查改需要在后台操作）

StudentDB studentDB = Room.databaseBuilder(this, StudentDB.class,dataBaseName).build();

如果直接在UI线程操作，会报异常如下：

Cannot access database on the main thread since it may potentially   lock the UI for a long period of time.

我这边结合RxJava 写出个方法一的简单调用（小伙伴们也可通过线程编写，这边只是为了方便直接观看而使用）
首先引入RxJava 2.0 版本的依赖

implementation 'io.reactivex.rxjava2:rxjava:2.1.1'
implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'

我这边简单编写插入一条数据

    final StudentEntity studentEntity = new StudentEntity(1, "name", 18);


    Observable.create(new ObservableOnSubscribe<StudentEntity>() {

        @Override
        public void subscribe(ObservableEmitter<StudentEntity> e) throws Exception {
            studentDB.studentDao().insert(studentEntity);
          
            //将插入成功的学生id数据传到主线程
            e.onNext(studentDB.studentDao().queryStudent(studentEntity.getStudentID()));
        }
    }).observeOn(AndroidSchedulers.mainThread())
            .subscribeOn(Schedulers.io())
            .subscribe(new Consumer<StudentEntity>() {
                @Override
                public void accept(StudentEntity studentEntity) throws Exception {
                    //显示插入成功的数据
                    tv_content.setText("插入数据："+studentEntity.toString());
                }
            })
    ;

方法二（通过设置allowMainThreadQueries() 允许在主线程操作）

StudentDB  studentDB = Room.databaseBuilder(this, StudentDB.class, dataBaseName)
            .allowMainThreadQueries()
            .build();

可以直接调用增删查改
伪代码：

 studentDB.studentDao().insert(StudentEntity);
 studentDB.studentDao().deleteStudent(long studentID);

注意：由于数据库的操作是耗时的，画面在60fps则不会感觉到卡顿，假设大量数据的查询加绘制界面的时间超过16ms ，方法二会导致应用看起是卡顿，甚至ANR。
对于是否允许UI线程运行数据库操作，取决小伙伴们自身开发的APP的需求

最后给出MainActivity的代码和 xml布局 提供参考（允许UI线程操作查询的方法二）：

MainActivity 代码

public class MainActivity extends AppCompatActivity implements  View.OnClickListener {

private StudentDB studentDB;
private String dataBaseName = "StudentDB";
private TextView tv_content;
private Button btn_insert, btn_delete, btn_query, btn_update, btn_showAll;
private EditText edt_insert_num, edt_insert_name, edt_insert_age, edt_delete_num, edt_query_num,
        edt_update_num, edt_update_name, edt_update_age;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    initDataBase();
    initView();
}

private void initDataBase() {
    /**
     * 后台操作
     * */
    //studentDB = Room.databaseBuilder(this, StudentDB.class, dataBaseName).build();

    /**
     * 主线程操作
     * */
    studentDB = Room.databaseBuilder(this, StudentDB.class, dataBaseName)
            .allowMainThreadQueries()
            .build();
}

private void initView() {

    btn_insert = findViewById(R.id.btn_insert);
    btn_delete = findViewById(R.id.btn_delete);
    btn_query = findViewById(R.id.btn_query);
    btn_update = findViewById(R.id.btn_update);
    btn_showAll = findViewById(R.id.btn_showAll);
    btn_insert.setOnClickListener(this);
    btn_delete.setOnClickListener(this);
    btn_query.setOnClickListener(this);
    btn_update.setOnClickListener(this);
    btn_showAll.setOnClickListener(this);
    tv_content = findViewById(R.id.tv_content);
    edt_insert_num = findViewById(R.id.edt_insert_num);
    edt_insert_name = findViewById(R.id.edt_insert_name);
    edt_insert_age = findViewById(R.id.edt_insert_age);
    edt_delete_num = findViewById(R.id.edt_delete_num);
    edt_query_num = findViewById(R.id.edt_query_num);
    edt_update_num = findViewById(R.id.edt_update_num);
    edt_update_name = findViewById(R.id.edt_update_name);
    edt_update_age = findViewById(R.id.edt_update_age);
}

@Override
public void onClick(View v) {
    btn_insert.setOnClickListener(this);
    btn_delete.setOnClickListener(this);
    btn_query.setOnClickListener(this);
    btn_update.setOnClickListener(this);
    switch (v.getId()) {
        case R.id.btn_insert://

            insertData();

            break;
        case R.id.btn_delete:
            deleteData();
            break;
        case R.id.btn_query:
            queryData();
            break;
        case R.id.btn_update:
            updateData();
            break;
        case R.id.btn_showAll:
            showAll();

            break;


        default:
    }
}

private void showAll() {
    //在后台运行

            /*Observable.create(new       ObservableOnSubscribe<List<StudentEntity>>() {
        @Override
        public void subscribe(ObservableEmitter<List<StudentEntity>> emitter) throws Exception {
            emitter.onNext(studentDB.studentDao().getAll());
        }
    })
            .observeOn(AndroidSchedulers.mainThread())
            .subscribeOn(Schedulers.io())
            .subscribe(new Consumer<List<StudentEntity>>() {
                @Override
                public void accept(List<StudentEntity> data) throws Exception {

                    tv_content.setText(data.toString());
                }
            })
    ;*/


    //运行到主线程：
    tv_content.setText("展示所有数据："+ studentDB.studentDao().getAll().toString());
}

private void updateData() {
    if (TextUtils.isEmpty(edt_update_num.getText().toString())) {
        return;
    }
    if (TextUtils.isEmpty(edt_update_name.getText().toString())) {
        return;
    }
    if (TextUtils.isEmpty(edt_update_age.getText().toString())) {
        return;
    }
    long studentID = Long.parseLong(edt_update_num.getText().toString());
    String name = edt_update_name.getText().toString();
    int age = Integer.parseInt(edt_update_age.getText().toString());
    StudentEntity studentEntity = new StudentEntity(studentID, name, age);
    tv_content.setText("更新数据："+studentEntity.toString());
    studentDB.studentDao().updateStudent(studentEntity);

}

private void queryData() {
    if (TextUtils.isEmpty(edt_query_num.getText().toString())) {
        return;
    }
    long studentID = Long.parseLong(edt_query_num.getText().toString());
    StudentEntity studentEntity = studentDB.studentDao().queryStudent(studentID);

    tv_content.setText("查询数据："+studentEntity.toString());
}

private void deleteData() {
    if (TextUtils.isEmpty(edt_delete_num.getText().toString())) {
        return;
    }
    long studentID = Long.parseLong(edt_delete_num.getText().toString());
    tv_content.setText("删除数据："+studentDB.studentDao().queryStudent(studentID));
    studentDB.studentDao().deleteStudent(studentID);
}

private void insertData() {
    if (TextUtils.isEmpty(edt_insert_num.getText().toString())) {
        return;
    }
    if (TextUtils.isEmpty(edt_insert_name.getText().toString())) {
        return;
    }
    if (TextUtils.isEmpty(edt_insert_age.getText().toString())) {
        return;
    }
    long studentID = Long.parseLong(edt_insert_num.getText().toString());
    String name = edt_insert_name.getText().toString();
    int age = Integer.parseInt(edt_insert_age.getText().toString());
    //数据库插入操作--当学号一样则替换
    final StudentEntity studentEntity = new StudentEntity(studentID, name, age);
    //final StudentEntity studentEntity = new StudentEntity(1, "name", 18);



/*      Observable.create(new ObservableOnSubscribe<StudentEntity>() {

        @Override
        public void subscribe(ObservableEmitter<StudentEntity> e) throws Exception {
            studentDB.studentDao().insert(studentEntity);
            //studentDB.studentDao().queryStudent(studentEntity.getStudentID());
            e.onNext(studentDB.studentDao().queryStudent(studentEntity.getStudentID()));
        }
    }).observeOn(AndroidSchedulers.mainThread())
            .subscribeOn(Schedulers.io())
            .subscribe(new Consumer<StudentEntity>() {
                @Override
                public void accept(StudentEntity studentEntity) throws Exception {

                    tv_content.setText("插入数据：" + studentEntity.toString());
                }
            })
    ;*/

    tv_content.setText("插入数据：" + studentEntity.toString());
    studentDB.studentDao().insert(studentEntity);
}

}

xml 布局代码：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"
tools:context=".MainActivity">

<LinearLayout
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout_weight="1">

    <TextView
        android:id="@+id/tv_content"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:padding="15dp"
        android:text="数据库显示内容"
        android:textSize="16sp" />

</LinearLayout>

<LinearLayout
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="horizontal">

    <Button
        android:id="@+id/btn_insert"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:gravity="center"
        android:text="新增" />

    <EditText
        android:id="@+id/edt_insert_num"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:hint="学号"
        android:inputType="number" />

    <EditText
        android:id="@+id/edt_insert_name"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:hint="姓名" />

    <EditText
        android:id="@+id/edt_insert_age"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:hint="年龄"
        android:inputType="numberDecimal" />
</LinearLayout>

<LinearLayout
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="horizontal">

    <Button
        android:id="@+id/btn_delete"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:gravity="center"
        android:text="删除" />

    <EditText
        android:id="@+id/edt_delete_num"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:hint="输入要删除学生的学号"
        android:inputType="numberDecimal" />
</LinearLayout>

<LinearLayout
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="horizontal">

    <Button
        android:id="@+id/btn_query"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:gravity="center"
        android:text="查询" />

    <EditText
        android:id="@+id/edt_query_num"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:hint="输入学号，查询某个学生信息"
        android:inputType="numberDecimal" />
</LinearLayout>

<LinearLayout
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="horizontal">

    <Button
        android:id="@+id/btn_update"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:gravity="center"
        android:text="修改" />

    <EditText
        android:id="@+id/edt_update_num"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:hint="学号"
        android:inputType="number" />

    <EditText
        android:id="@+id/edt_update_name"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:hint="姓名" />

    <EditText
        android:id="@+id/edt_update_age"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:hint="年龄"
        android:inputType="numberDecimal" />
</LinearLayout>

<Button
    android:id="@+id/btn_showAll"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:gravity="center"
    android:text="显示表中所有数据" />
</LinearLayout>
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 213,992评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,212评论 3赞 388
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 159,535评论 0赞 349
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,197评论 1赞 287
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,310评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,383评论 1赞 292
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,409评论 3赞 412
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,191评论 0赞 269
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,621评论 1赞 306
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,910评论 2赞 328
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,084评论 1赞 342
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,763评论 4赞 337
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,403评论 3赞 322
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,083评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,318评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,946评论 2赞 365
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,967评论 2赞 351

推荐阅读更多精彩内容