Jetpack Room学习

Jetpack Room

Room是什么？

持久性库在SQLite基础上提供抽象层，充分利用SQLite强大功能，更强的数据库访问机制。Room是基于SQLite封装的一个框架。

引入

添加依赖

dependencies {
   ...
    implementation 'androidx.room:room-runtime:2.2.5'
    annotationProcessor 'androidx.room:room-compiler:2.2.5'
    // For Kotlin use kapt instead of annotationProcessor (注意这个注释)
}

如果项目是使用Kotlin语言来开发的，在添加room-compiler的时候使用kapt关键字，java语言开发的就使用annotationProcessor关键。否则会导致访问出错。

重要概念

• Entity：实体类，对应的是数据库的一张表结构。需要使用注解 @Entity 标记。
• Dao：包含访问一系列访问数据库的方法。需要使用注解 @Dao 标记。
• Database：数据库持有者，作为与应用持久化相关数据的底层连接的主要接入点。需要使用注解 @Database 标记。

使用@Database注解需满足以下条件：

• 定义的类必须是一个继承于RoomDatabase的抽象类。
• 在注解中需要定义与数据库相关联的实体类列表。
• 包含一个没有参数的抽象方法并且返回一个带有注解的 @Dao。

三者之间和应用的对应关系如下图：

Entity

// @Entity 标识这个类用于建表，表名(默认不写，则用类名小写作为表名)
@Entity(tableName = "student")
public class Student {
    // 主键，是否自增长
    @PrimaryKey(autoGenerate = true)
    public int id;
    // 表中字段，表中字段名
    @ColumnInfo(name = "name")
    public String name;
    // 表中字段，默认使用下面字段名age
    @ColumnInfo
    public int age;

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

Dao

@Dao
public interface StudentDao {
    @Insert(onConflict = OnConflictStrategy.REPLACE)
    void insert(Student... students);

    @Delete
    void delete(Student student);

    @Update
    void update(Student student);

    @Query("SELECT * FROM student")
    List<Student> getAll();

    @Query("SELECT * FROM student WHERE name = :name")
    List<Student> findByName(String name);

    @Query("SELECT * FROM student WHERE id in (:ids)")
    List<Student> findByIds(int[] ids);
}

DataBase

@Database(entities = {Student.class},version = 1)
public abstract class DataBase extends RoomDatabase {
    public abstract StudentDao studentDao();
}

使用方法

public class RoomActivity extends AppCompatActivity {
    private static final String TAG = "Room-";
    private StudentDao dao;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_room);
        DataBase dataBase = Room.databaseBuilder(getApplicationContext(), DataBase.class,
                "room").allowMainThreadQueries().build();
        dao = dataBase.studentDao();
        String[] permissions = {Manifest.permission.WRITE_EXTERNAL_STORAGE};
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
            requestPermissions(permissions, 1);
        }
    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        if (requestCode == 1) {
            Log.d(TAG, "onRequestPermissionsResult: " + requestCode);
            for (int i = 0; i < grantResults.length; i++) {
                if (grantResults[i] != PackageManager.PERMISSION_GRANTED) {
                    Log.d(TAG, "onRequestPermissionsResult-需要开启存储权限");
                }
            }
        }
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
    }

    /**
     * 在Activity中所有对数据库的操作(增、删、改、查)都不可以在主线程中进行,除非在数据库的Builder上调用了allowMainThreadQueries(),
     * 或者所有的操作都在子线程中完成,否则程序会崩溃报以下错误
     * Cannot access database on the main thread since it may potentially lock the UI for a long period of time.
     *
     * @param view
     */
    public void queryAll(View view) {
        List<Student> students = dao.getAll();
        Log.d(TAG, "queryAll: " + students);
    }

    public void insert(View view) {
        Student student = new Student();
        student.age = 18;
        student.name = "小明";
        dao.insert(student);
        Log.d(TAG, "insert:" + student.toString());
    }

    /**
     * 删除必须指定id，否则删除不成功(id不存在也是删除不成功的)
     *
     * @param view
     */
    public void delete(View view) {
        Student student = new Student();
        student.age = 18;
        student.name = "小明";
        student.id = 1;
        dao.delete(student);
        Log.d(TAG, "insert:" + student.toString());
    }

    /**
     * 更新必须指定id，否则不成功(id不存在也是更新不成功的)
     *
     * @param view
     */
    public void update(View view) {
        Student student = new Student();
        student.age = 18;
        student.name = "小明-1";
        student.id = 1;
        dao.update(student);
        Log.d(TAG, "insert:" + student.toString());
    }

    public void queryByName(View view) {
        Log.d(TAG, "queryByName: " + dao.findByName("小明"));
    }

    public void queryByIds(View view) {
        Log.d(TAG, "queryByName: " + dao.findByIds(new int[]{1, 2, 3}));
    }
}

转载于 https://www.jianshu.com/p/02a0c9a66119
https://blog.csdn.net/singwhatiwanna/article/details/104890202