Android架构组件Room：如何替代ContentProvider实现跨应用数据库暴露？

Room本身是SQLite的轻量封装，并没有直接提供跨应用数据访问的能力，但我们可以通过结合ContentProvider的方式来实现需求——把ContentProvider作为跨应用交互的入口，内部用Room处理数据库操作，这样既保留了Room的便捷性，又能实现和传统ContentProvider一样的跨应用共享功能。下面是具体的实现步骤：

1. 先搭建好Room基础结构 #

首先还是按照常规方式创建你的Room数据库、实体类和DAO，这里给个简单示例：

实体类（User.kt） #

@Entity(tableName = "user")
data class User(
    @PrimaryKey(autoGenerate = true) val id: Int = 0,
    val name: String,
    val email: String
)

DAO（UserDao.kt） #

注意：因为ContentProvider需要返回Cursor，所以DAO的查询方法要改成返回Cursor类型：

@Dao
interface UserDao {
    @Query("SELECT * FROM user")
    fun getAllUsers(): Cursor

    @Insert
    fun insertUser(user: User): Long // 返回插入的id，方便生成URI

    // 按需添加更新、删除方法
}

Room数据库类（AppDatabase.kt） #

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

    companion object {
        @Volatile
        private var INSTANCE: AppDatabase? = null

        fun getInstance(context: Context): AppDatabase {
            return INSTANCE ?: synchronized(this) {
                val instance = Room.databaseBuilder(
                    context.applicationContext,
                    AppDatabase::class.java,
                    "shared_user_db"
                ).build()
                INSTANCE = instance
                instance
            }
        }
    }
}

2. 实现自定义ContentProvider #

接下来写一个继承自ContentProvider的类，把Room的操作封装进去，作为跨应用访问的入口：

自定义ContentProvider（SharedUserProvider.kt） #

class SharedUserProvider : ContentProvider() {
    private lateinit var userDao: UserDao

    // 定义URI和权限常量，其他应用需要用这些来访问
    companion object {
        // 授权者名称，必须和Manifest中注册的一致
        const val AUTHORITY = "com.yourpackage.shareduserprovider"
        const val PATH_USERS = "users"
        // 对外暴露的URI
        val CONTENT_URI = Uri.parse("content://$AUTHORITY/$PATH_USERS")

        // MIME类型，ContentResolver需要这个来识别数据类型
        const val CONTENT_TYPE = "vnd.android.cursor.dir/vnd.$AUTHORITY.user"
        const val CONTENT_ITEM_TYPE = "vnd.android.cursor.item/vnd.$AUTHORITY.user"
    }

    override fun onCreate(): Boolean {
        context?.let {
            val db = AppDatabase.getInstance(it)
            userDao = db.userDao()
        }
        return true
    }

    // 处理查询请求
    override fun query(
        uri: Uri,
        projection: Array<String>?,
        selection: String?,
        selectionArgs: Array<String>?,
        sortOrder: String?
    ): Cursor? {
        val cursor = when (uri.path) {
            "/$PATH_USERS" -> userDao.getAllUsers()
            else -> throw IllegalArgumentException("无法识别的URI: $uri")
        }
        // 设置通知URI，数据变化时通知监听者
        cursor.setNotificationUri(context?.contentResolver, uri)
        return cursor
    }

    // 处理插入请求
    override fun insert(uri: Uri, values: ContentValues?): Uri? {
        val insertId = when (uri.path) {
            "/$PATH_USERS" -> {
                values?.let {
                    val user = User(
                        name = it.getAsString("name") ?: "",
                        email = it.getAsString("email") ?: ""
                    )
                    userDao.insertUser(user)
                } ?: throw IllegalArgumentException("插入数据不能为空")
            }
            else -> throw IllegalArgumentException("无法识别的URI: $uri")
        }
        // 通知数据变化
        context?.contentResolver?.notifyChange(uri, null)
        // 返回插入数据的URI
        return ContentUris.withAppendedId(CONTENT_URI, insertId)
    }

    // 按需实现更新、删除方法
    override fun update(
        uri: Uri,
        values: ContentValues?,
        selection: String?,
        selectionArgs: Array<String>?
    ): Int {
        // 这里可以根据需求调用Room的更新方法
        context?.contentResolver?.notifyChange(uri, null)
        return 0
    }

    override fun delete(uri: Uri, selection: String?, selectionArgs: Array<String>?): Int {
        // 这里可以根据需求调用Room的删除方法
        context?.contentResolver?.notifyChange(uri, null)
        return 0
    }

    override fun getType(uri: Uri): String? {
        return when (uri.path) {
            "/$PATH_USERS" -> CONTENT_TYPE
            else -> CONTENT_ITEM_TYPE
        }
    }
}

3. 在Manifest中注册ContentProvider并配置权限 #

在你的应用的AndroidManifest.xml中注册这个ContentProvider，同时声明访问权限：

<!-- 声明自定义权限，其他应用必须申请这个权限才能访问 -->
<permission
    android:name="com.yourpackage.permission.ACCESS_SHARED_USER_DATA"
    android:protectionLevel="normal" /> <!-- 根据数据敏感程度选择normal/dangerous -->

<application ...>
    <provider
        android:name=".SharedUserProvider"
        android:authorities="com.yourpackage.shareduserprovider" <!-- 要和ContentProvider中的AUTHORITY一致 -->
        android:exported="true" <!-- 允许其他应用访问 -->
        android:permission="com.yourpackage.permission.ACCESS_SHARED_USER_DATA" /> <!-- 访问需要的权限 -->
</application>

4. 其他应用如何访问共享数据 #

其他应用要访问你的共享数据，需要先在它的AndroidManifest.xml中申请权限：

<uses-permission android:name="com.yourpackage.permission.ACCESS_SHARED_USER_DATA" />

然后通过ContentResolver来操作数据，比如：

查询数据 #

val sharedUri = Uri.parse("content://com.yourpackage.shareduserprovider/users")
context.contentResolver.query(sharedUri, null, null, null, null)?.use { cursor ->
    while (cursor.moveToNext()) {
        val name = cursor.getString(cursor.getColumnIndexOrThrow("name"))
        val email = cursor.getString(cursor.getColumnIndexOrThrow("email"))
        // 处理获取到的数据
    }
}

插入数据 #

val values = ContentValues().apply {
    put("name", "Alice")
    put("email", "alice@example.com")
}
context.contentResolver.insert(sharedUri, values)

几个关键注意事项 #

• 权限控制：一定要根据数据的敏感程度设置合适的protectionLevel，比如敏感数据用dangerous，需要用户授权；普通数据用normal即可。
• 数据变更通知：在增删改操作后调用notifyChange，这样其他应用可以通过ContentObserver监听数据变化。
• 数据库迁移：如果Room数据库版本升级，要做好迁移逻辑，避免影响其他应用的正常访问。
• Cursor生命周期：其他应用使用Cursor时，记得用use块或者手动关闭，避免内存泄漏。

内容的提问来源于stack exchange，提问作者Chait