# Android Jetpack Room

[TOC]

## Room 優點

**優勢**
1. 簡化資料庫操作：Room提供抽象層來降低SQL的複雜性，使用簡單化。
2. 提升應用程式可靠性：Room提供Annotation自動產生SQL語法但Query仍需要一些SQL語法，所以在compile time時檢查 SQL Query 語法，避免在run time時發生閃退，提高穩定可靠性。
3. 確保資料一致性：確保資料庫和資料物件之間是互應的。
4. 提升開發效率：因簡化操作，加快開發流程
5. 易維護：Room使用方式與程式結構清晰，降低維護成本
6. 安全性：常見的資安漏洞 SQL injection，[OWASP 的十大](https://owasp.org/www-community/attacks/SQL_Injection)網路安全漏洞之一，攻擊手法是嘗試性的在輸入欄位輸入SQL語法取得暴露的私人資料或損混毀資料庫，[SQL injection攻擊原理](https://www.tsg.com.tw/blog-detail10-215-0-sql-2.htm)。

**其他**
* 可支持測試和IDE Debug
* JUnit test 可跑在 Android device測試實際狀況
* IDE Debug可在Android Studio 4.1 以上版本中，Database Inspector
* Room 資料庫版本間遷移作業測試
* 很適合運用jetpack提供library一起構建[Reactive programming](https://zh.wikipedia.org/zh-tw/%E5%93%8D%E5%BA%94%E5%BC%8F%E7%BC%96%E7%A8%8B)，例如:viewModel、lineData、Paging等

## Room 的三個主要元件

### 資料表 Entity
代表應用程式資料庫中的資料表。包含資料庫中對應資料表內每個資料欄的欄位，簡單的實體範例，能夠定義內含 ID、其他資料欄的產品資料表。

**Annotations**:
1. 資料表名稱(`@Entity`)
- 預設會使用class name做為名稱，@Entity(tableName = "product") 自訂義名稱使用
2. 資料表ID(`@PrimaryKey`)
- 可設定自動產生不重複的 id (autoGenerate = true)
3. 資料表名稱欄位名稱(`@ColumnInfo`)
---

### 資料存取物件 Data Access Object(DAO)
- class需為interface、abstract
- Room.databaseBuild().build()時預設跑IOThread
- DAO查詢時避免main Thread運行會導致畫面卡住，需寫非同步的查詢
- compile time時，Room自動產生定義的 DAO，和檢查您的SQL是否有語法錯誤
- Room 透過定義DAO介面，使用Annotations，如 @Insert、@Delete、@Update，自動產生對應的SQL語句Annotations，Query可運用SQL語法進行

1. **Annotations**:
- 插入(`@Insert`)
- 刪除(`@Delete`)
- 更新(`@Update`)
- 查詢(`@Query`)


2.1 非同步查詢-Coroutine +flow
- Room 2.1 and higher : [Coroutine](https://developer.android.com/kotlin/coroutines) suspend實作DAO非同步查詢
- Room 2.2 and higher: Kotlin[Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/) observable 查詢.

---

### 資料庫類別 Dataase
建立資料庫基礎連線的主要存取點，

@Database(entities = [Word::class], version = 1)
abstract class WordRoomDataBase : RoomDatabase() {
    abstract fun wordDao(): WordDao

    companion object {
        @Volatile
        private var INSTANCE: WordRoomDataBase? = null
        fun getDatabaseInstance(context: Context): WordRoomDataBase {
            return INSTANCE ?: synchronized(this) {
                val instance = Room.databaseBuilder(
                    context = context.applicationContext,
                    klass = WordRoomDataBase::class.java,
                    name = "word_database"
                ).build()

                INSTANCE = instance
                instance
            }
        }
    }
}

## 進階的使用操作
### 支援全文搜尋功能
- Room 2.1.0 以上版本的功能
- 特定實體中新增 @Fts3 或 @Fts4的[SQLite 擴充功能模組](https://www.sqlite.org/fts3.html)

### 索引專用的資料欄
- 在 @Entity 註解中加入 indices 屬性，並列出要加入索引或複合式索引的資料欄名稱

## Room是關聯式資料庫
> Room 是[關聯式資料庫](https://zh.wikipedia.org/zh-tw/%E5%85%B3%E7%B3%BB%E6%95%B0%E6%8D%AE%E5%BA%93) **RDBMS**(Relational Database Management System)的資料庫，建立在[關聯式模型](https://zh.wikipedia.org/wiki/%E5%85%B3%E7%B3%BB%E6%A8%A1%E5%9E%8B)，由資料結構、操作集合、完整性約束三部分組合，使用標準資料查詢語言[SQL](https://zh.wikipedia.org/wiki/SQL)就是一種基於關聯式資料庫的語言，語言執行對關聯式資料庫的檢索和操作。
### 1.何謂關聯式資料庫(RDBMS)
使用多個表格(table)組成，並且可以將資料表關聯起來，連結多個資料表之間關係。
#### 關聯式資料庫的特點
* **table**組成包含**row**代表一筆資料、**column**代表欄位名稱
* **Schema**必須先定義好，並只接受同樣格式的資料插入與修改。但往後需要調整Schema必須對已存在的資料作相對應處理會很麻煩。
* 可以使用 **JOIN** 來連結多個資料表，做較複雜的查詢
* 具備[ACID 特性](https://www.explainthis.io/zh-hant/swe/acid-intro)
* 使用 **SQL**(Structured Querying Language)來管理及查詢資料

### 2.為何 Android Jetpack Room 是關聯式資料庫?
> Room之所以是關聯式資料庫，因為它使用表格儲存數據，每個table都需要定義@PrimaryKey，透過使用SQL進行操作和查詢管理，依靠底層SQLite處理這些操作，使得Room使用起來簡單且高效。
> [Room禁止資料表物件互相參照](https://developer.android.com/training/data-storage/room/referencing-data?hl=zh-tw#understand-no-object-references)，須明確要求應用程式所需的資料

# GitHub 使用範例
https://github.com/Quuanna/Jetpack-Room-Exercise/tree/master

# 延伸議題
1. 非關聯型的[NOSQL](https://zh.wikipedia.org/wiki/NoSQL#)，強調Key-value儲存和文件導向資料庫的優點
2. [RDBMS vs NOSQL](https://medium.com/@eric248655665/rdbms-vs-nosql-%E9%97%9C%E8%81%AF%E5%BC%8F%E8%B3%87%E6%96%99%E5%BA%AB-vs-%E9%9D%9E%E9%97%9C%E8%81%AF%E5%BC%8F%E8%B3%87%E6%96%99%E5%BA%AB-1423c9fbb91a)

# Room 遷移至 Kotlin Multiplaform
> [Room 實作遷移至使用 Kotlin Multiplatform (KMP) 的實作](https://developer.android.com/training/data-storage/room/room-kmp-migration?hl=zh-tw)

# 參考資料來源
1. [Define data using Room entities](https://developer.android.com/training/data-storage/room/defining-data)
3. [Accessing data using Room DAOs](https://developer.android.com/training/data-storage/room/accessing-data)
4. [Define relationships between objects](https://developer.android.com/training/data-storage/room/relationships)
5. [Write asynchronous DAO queries](https://developer.android.com/training/data-storage/room/async-queries)
6. [Create views into a database](https://developer.android.com/training/data-storage/room/creating-views)
7. [CodeLab Android Room with a View - Kotlin](https://developer.android.com/codelabs/android-room-with-a-view-kotlin#0)
8. [SQL injection](https://developer.android.com/privacy-and-security/risks/sql-injection?hl=zh-tw#use_room_library)