google room 框架简单使用

以下是我个人对room简单使用的记录,介绍不够详细深入,如果需要了解更详细的信息,请参考http://www.jianshu.com/p/ef7cbf7c12b1

1、项目引入room

首先在项目的build.gradle中加入

allprojects {
    repositories {
        jcenter()
        maven { url 'https://maven.google.com' }//所要添加的语句
    }
}

然后在app的build.gradle的dependencies中加入以下代码,版本号可以根据官网的最新版本号进行修改。

compile "android.arch.persistence.room:runtime:1.0.0-alpha1"
annotationProcessor "android.arch.persistence.room:compiler:1.0.0-alpha1"

2、在项目中使用room

在代码中我们需要一个Entity、一个Dao和一个DataBase。

Test.java

package com.example.room.entity;

import android.arch.persistence.room.ColumnInfo;
import android.arch.persistence.room.Entity;
import android.arch.persistence.room.PrimaryKey;

@Entity(tableName = "test")
public class Test {
    @PrimaryKey(autoGenerate = true)
    private int id;
    @ColumnInfo(name = "message")
    private String message;

    public void setMessage(String message){
        this.message = message;
    }

    public int getId() {
        return id;
    }

    public String getMessage() {
        return message;
    }

    public void setId(int id) {
        this.id = id;
    }
}

TestDao.java

package com.example.room.dao;

import android.arch.persistence.room.Dao;
import android.arch.persistence.room.Delete;
import android.arch.persistence.room.Insert;
import android.arch.persistence.room.Query;

import com.example.room.entity.Test;

import java.util.List;

@Dao
public interface TestDao {
    @Query("SELECT * FROM test")
    List<Test> getAll();
    @Query("SELECT * FROM test WHERE id IN (:testIds)")
    List<Test> loadAllByIds(int[] testIds);

    @Query("SELECT * FROM test WHERE message LIKE :message")
    Test findByMessage(String message);

    @Insert
    void insertAll(Test... tests);

    @Delete
    void delete(Test test);
}

TestDataBase.java

package com.example.room.db;

import android.arch.persistence.room.Database;
import android.arch.persistence.room.RoomDatabase;

import com.example.room.dao.TestDao;
import com.example.room.entity.Test;

@Database(entities = {Test.class}, version = 1)
public abstract class TestDataBase extends RoomDatabase {
    public abstract TestDao userDao();
}

以上三个文件都写好之后就可以进行数据的保存和查询等等操作了。
要对数据库进行操作就必须要获取到一个数据库的对象,这里我们可以通过Room框架提供的方法进行创建并返回数据库的一个实例。

TestDataBase dataBase = Room.databaseBuilder(context, TestDataBase.class, "test.db").build();

然后可以使用数据库实例获取到Dao实例,最后调用Dao实例的方法进行操作(将所有的数据库操作方法都在Dao接口中定义)

TestDao testDao = dataBase.testDao();
testDao.getAll();
testDao.insertAll(new Test());
testDao.delete(new Test());
testDao.findByMessage("test");
testDao.loadAllByIds(new int[]{0,1,2});

顺便记录下使用过程中遇到的问题

1、room框架不允许在UI线程进行增删查改的操作,通过SQLiteOpenHelper实现的数据库没有这个限制。
2、编译时抛出:Error:(11, 17) 警告: Schema export directory is not provided to the annotation processor so we cannot export the schema. You can either provide room.schemaLocation annotation processor argument OR set exportSchema to false.
这个有两种解决方式:
1、添加exportedSchema = false

@Database(entities = {Test.class}, version = 1, exportedSchema = false)
public abstract class TestDataBase extends RoomDatabase {
    public abstract TestDao userDao();
}

2、在app的build.gradle中添加如下内容

android {

    // ... (compileSdkVersion, buildToolsVersion, etc)

    defaultConfig {

        // ... (applicationId, miSdkVersion, etc)

        //要添加的内容
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = ["room.schemaLocation": "$projectDir/schemas".toString()]
            }
        }
    }

    // ... (buildTypes, compileOptions, etc)

}

两种方式不同点:两种都会消除上面的警告,但是第二种方式会在app/schemas文件夹下生成一个.json的文件,如下:

{
  "formatVersion": 1,
  "database": {
    "version": 1,
    "identityHash": "79b8c0e278c94931b1a6b6fdb4d510bf",
    "entities": [
      {
        "tableName": "Test",
        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT, `message` TEXT)",
        "fields": [
          {
            "fieldPath": "id",
            "columnName": "id",
            "affinity": "INTEGER"
          },
          {
            "fieldPath": "message",
            "columnName": "message",
            "affinity": "TEXT"
          }
        ],
        "primaryKey": {
          "columnNames": [
            "id"
          ],
          "autoGenerate": true
        },
        "indices": [],
        "foreignKeys": []
      }
    ],
    "setupQueries": [
      "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, \"79b8c0e278c94931b1a6b6fdb4d510bf\")"
    ]
  }
}

每次数据库版本更新都能得到.json文件,通过.json文件的内容可以更好的跟踪数据库版本更新的历史。

    原文作者:风雪守候
    原文地址: https://www.jianshu.com/p/5ba249216e83
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞