Room使用

Android 应用数据存储简单来说有这么几种:

  • 文件存储
  • SharedPreference 存储
  • SQLite 数据库存储
  • 第三方的网上数据库存储

当需要本地存储大量数据的时候,文件存储频繁读取文件内容修改保存是很耗时,SharedPreference 无法支持大量数据。这时候本地原生的SQLite虽然符合,但是编程过程不太友好,所幸的是Google在其基础上的封装,就有了今天推荐的轻量级数据库——Room


导入依赖

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

创建数据库

在数据库中创建一张表,表中设计我们要操作的数据对象。在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的需求


使用数据库

最后给出使用Room数据库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() {
        ...
    }

    @Override
    public void onClick(View v) {
        ...
        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() {
        ...
        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() {
        ...
        long studentID = Long.parseLong(edt_query_num.getText().toString());
        StudentEntity studentEntity = studentDB.studentDao().queryStudent(studentID);
        tv_content.setText("查询数据:"+studentEntity.toString());
    }

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

    private void insertData() {
        ...
        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);
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容

  • Android 应用数据存储简单来说有这么几种:文件存储、SharedPreference 存储、SQLite 数...
    一个不爱敲代码的女孩阅读 1,318评论 0 1
  • WHAT 什么是数据存储? 缓存相关数据。当设备无法访问网络时,用户仍可在离线状态下浏览相应内容。设备重新连接到网...
    Method阅读 2,411评论 0 0
  • Android常用的SQLite框架 OrmLite:学习成本低,方便好用,底层通过反射机制实现,效率比Green...
    jianboo阅读 767评论 0 1
  • 一、前言: Room 是一个对象关系映射(ORM)库。可以很容易将 SQLite 表数据转换为 Java 对象。R...
    因为我的心阅读 7,741评论 0 7
  • 介绍 Room是Google提供的一个ORM库。Room提供了三个主要的组件: @Database:@Databa...
    Carve_Time阅读 61,528评论 11 106