บันทึกข้อมูลในฐานข้อมูลภายในเครื่องโดยใช้ห้อง เป็นส่วนหนึ่งของ Android Jetpack

แอปที่จัดการข้อมูลที่มีโครงสร้างจำนวนมหาศาลจะให้ประโยชน์อย่างมากจาก เก็บข้อมูลนั้นไว้ภายในเครื่อง Use Case ที่พบบ่อยที่สุดคือแคชที่เกี่ยวข้อง เพื่อที่ว่าเมื่ออุปกรณ์ไม่สามารถเข้าถึงเครือข่าย ยังคงเรียกดูเนื้อหานั้นขณะที่ออฟไลน์ได้

ไลบรารีการคงอยู่ของห้องจะมีเลเยอร์ Abstraction เหนือ SQLite เพื่อให้ เข้าถึงฐานข้อมูลได้อย่างคล่องแคล่ว และใช้ประโยชน์จาก SQLite อย่างเต็มที่ โดยเฉพาะอย่างยิ่ง ห้องพักมีสิทธิประโยชน์ต่อไปนี้

  • การยืนยันเวลาคอมไพล์ของการค้นหา SQL
  • คําอธิบายประกอบตามความสะดวกเพื่อลดต้นแบบที่ซ้ำกันและมีโอกาสเกิดข้อผิดพลาดได้ง่าย โค้ด
  • เส้นทางการย้ายข้อมูลฐานข้อมูลที่คล่องตัว

เราขอแนะนำให้คุณใช้ "ห้องแชท" แทน เนื่องจากข้อควรพิจารณาเหล่านี้ การใช้ SQLite API โดยตรง

ตั้งค่า

หากต้องการใช้ Room ในแอป ให้เพิ่มทรัพยากร Dependency ต่อไปนี้ลงใน build.gradle ไฟล์:

ดึงดูด

dependencies {
    def room_version = "2.6.1"

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

    // To use Kotlin annotation processing tool (kapt)
    kapt "androidx.room:room-compiler:$room_version"
    // To use Kotlin Symbol Processing (KSP)
    ksp "androidx.room:room-compiler:$room_version"

    // optional - RxJava2 support for Room
    implementation "androidx.room:room-rxjava2:$room_version"

    // optional - RxJava3 support for Room
    implementation "androidx.room:room-rxjava3:$room_version"

    // optional - Guava support for Room, including Optional and ListenableFuture
    implementation "androidx.room:room-guava:$room_version"

    // optional - Test helpers
    testImplementation "androidx.room:room-testing:$room_version"

    // optional - Paging 3 Integration
    implementation "androidx.room:room-paging:$room_version"
}

Kotlin

dependencies {
    val room_version = "2.6.1"

    implementation("androidx.room:room-runtime:$room_version")
    annotationProcessor("androidx.room:room-compiler:$room_version")

    // To use Kotlin annotation processing tool (kapt)
    kapt("androidx.room:room-compiler:$room_version")
    // To use Kotlin Symbol Processing (KSP)
    ksp("androidx.room:room-compiler:$room_version")

    // optional - Kotlin Extensions and Coroutines support for Room
    implementation("androidx.room:room-ktx:$room_version")

    // optional - RxJava2 support for Room
    implementation("androidx.room:room-rxjava2:$room_version")

    // optional - RxJava3 support for Room
    implementation("androidx.room:room-rxjava3:$room_version")

    // optional - Guava support for Room, including Optional and ListenableFuture
    implementation("androidx.room:room-guava:$room_version")

    // optional - Test helpers
    testImplementation("androidx.room:room-testing:$room_version")

    // optional - Paging 3 Integration
    implementation("androidx.room:room-paging:$room_version")
}

คอมโพเนนต์หลัก

มีองค์ประกอบหลัก 3 อย่างในห้องแชท ดังนี้

คลาสฐานข้อมูลจะให้แอปของคุณพร้อมด้วยอินสแตนซ์ของ DAO ที่เชื่อมโยงกับ ฐานข้อมูลนั้น ในทางกลับกัน แอปสามารถใช้ DAO เพื่อดึงข้อมูลจาก ฐานข้อมูลเป็นอินสแตนซ์ของออบเจ็กต์เอนทิตีข้อมูลที่เกี่ยวข้อง แอปยังสามารถ ใช้เอนทิตีข้อมูลที่กำหนดไว้เพื่ออัปเดตแถวจากตารางที่เกี่ยวข้อง หรือ เพื่อสร้างแถวใหม่สำหรับการแทรก รูปที่ 1 แสดงความสัมพันธ์ระหว่าง ส่วนประกอบต่างๆ ของ Room

วันที่
รูปที่ 1 แผนภาพสถาปัตยกรรมคลังห้องพัก

ตัวอย่างการใช้งาน

ส่วนนี้จะแสดงตัวอย่างการใช้งานฐานข้อมูลห้องที่มี และ DAO รายการเดียว

เอนทิตีข้อมูล

โค้ดต่อไปนี้กำหนดเอนทิตีข้อมูล User อินสแตนซ์แต่ละรายการของ User หมายถึงแถวในตาราง user ในฐานข้อมูลของแอป

Kotlin

@Entity
data class User(
    @PrimaryKey val uid: Int,
    @ColumnInfo(name = "first_name") val firstName: String?,
    @ColumnInfo(name = "last_name") val lastName: String?
)

Java

@Entity
public class User {
    @PrimaryKey
    public int uid;

    @ColumnInfo(name = "first_name")
    public String firstName;

    @ColumnInfo(name = "last_name")
    public String lastName;
}

ดูข้อมูลเพิ่มเติมเกี่ยวกับเอนทิตีข้อมูลในห้องแชทได้ที่การกําหนดข้อมูลโดยใช้ห้องแชท เอนทิตี

ออบเจ็กต์การเข้าถึงข้อมูล (DAO)

โค้ดต่อไปนี้ระบุ DAO ที่เรียกว่า UserDao UserDao จะมี ที่ส่วนที่เหลือของแอปใช้เพื่อโต้ตอบกับข้อมูลในตาราง user

Kotlin

@Dao
interface UserDao {
    @Query("SELECT * FROM user")
    fun getAll(): List<User>

    @Query("SELECT * FROM user WHERE uid IN (:userIds)")
    fun loadAllByIds(userIds: IntArray): List<User>

    @Query("SELECT * FROM user WHERE first_name LIKE :first AND " +
           "last_name LIKE :last LIMIT 1")
    fun findByName(first: String, last: String): User

    @Insert
    fun insertAll(vararg users: User)

    @Delete
    fun delete(user: User)
}

Java

@Dao
public interface UserDao {
    @Query("SELECT * FROM user")
    List<User> getAll();

    @Query("SELECT * FROM user WHERE uid IN (:userIds)")
    List<User> loadAllByIds(int[] userIds);

    @Query("SELECT * FROM user WHERE first_name LIKE :first AND " +
           "last_name LIKE :last LIMIT 1")
    User findByName(String first, String last);

    @Insert
    void insertAll(User... users);

    @Delete
    void delete(User user);
}

ดูข้อมูลเพิ่มเติมเกี่ยวกับ DAO ได้ที่การเข้าถึงข้อมูลโดยใช้ห้องแชท DAO

ฐานข้อมูล

รหัสต่อไปนี้กำหนดคลาส AppDatabase ที่จะใช้เก็บฐานข้อมูล AppDatabase กำหนดการกำหนดค่าฐานข้อมูลและทำหน้าที่เป็นหน้าหลักของแอป ข้อมูลที่เก็บไว้ คลาสฐานข้อมูลต้องเป็นไปตาม เงื่อนไขต่อไปนี้

  • ชั้นเรียนจะต้องมีคำอธิบายประกอบ @Database คำอธิบายประกอบที่ มี entities อาร์เรย์ที่แสดงเอนทิตีข้อมูลทั้งหมดที่เชื่อมโยงกับฐานข้อมูล
  • ชั้นเรียนนี้ต้องเป็นคลาสนามธรรมที่ขยาย RoomDatabase
  • สำหรับคลาส DAO แต่ละรายการที่เชื่อมโยงกับฐานข้อมูล คลาสฐานข้อมูล ต้องกำหนดเมธอดนามธรรมที่มีอาร์กิวเมนต์เป็นศูนย์และแสดงอินสแตนซ์ ของคลาส DAO

Kotlin

@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

Java

@Database(entities = {User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
    public abstract UserDao userDao();
}

หมายเหตุ: หากแอปทำงานในกระบวนการเดียว คุณควรปฏิบัติตาม รูปแบบการออกแบบ Singleton เมื่อสร้างอินสแตนซ์ AppDatabase ออบเจ็กต์ อินสแตนซ์ RoomDatabase แต่ละรายการมีราคาค่อนข้างแพง และคุณ แทบไม่จำเป็นต้องเข้าถึงอินสแตนซ์หลายรายการภายในกระบวนการเดียว

หากแอปทำงานในหลายกระบวนการ ให้ใส่ enableMultiInstanceInvalidation() ในเครื่องมือสร้างฐานข้อมูล คำขอ ด้วยวิธีนี้ เมื่อคุณมีอินสแตนซ์ AppDatabase ในแต่ละกระบวนการ คุณสามารถเอาไฟล์ฐานข้อมูลที่แชร์ ออกในกระบวนการเดียว และการทำให้เป็นโมฆะนี้ จะเผยแพร่ไปยังอินสแตนซ์ของ AppDatabase ภายในกระบวนการอื่นๆ

การใช้งาน

หลังจากคุณกำหนดเอนทิตีข้อมูล, DAO และออบเจ็กต์ฐานข้อมูลแล้ว คุณจะ สามารถใช้โค้ดต่อไปนี้เพื่อสร้างอินสแตนซ์ของฐานข้อมูล

Kotlin

val db = Room.databaseBuilder(
            applicationContext,
            AppDatabase::class.java, "database-name"
        ).build()

Java

AppDatabase db = Room.databaseBuilder(getApplicationContext(),
        AppDatabase.class, "database-name").build();

จากนั้นคุณสามารถใช้เมธอด Abstract จาก AppDatabase เพื่อรับอินสแตนซ์ ของ DAO ในทางกลับกัน คุณสามารถใช้เมธอดจากอินสแตนซ์ DAO เพื่อโต้ตอบ ด้วยฐานข้อมูล:

Kotlin

val userDao = db.userDao()
val users: List<User> = userDao.getAll()

Java

UserDao userDao = db.userDao();
List<User> users = userDao.getAll();

แหล่งข้อมูลเพิ่มเติม

ดูข้อมูลเพิ่มเติมเกี่ยวกับห้องแชทได้ที่แหล่งข้อมูลเพิ่มเติมต่อไปนี้

ตัวอย่าง

Codelab

  • ห้อง Android ที่มีมุมมอง (Java) (Kotlin)

บล็อก