如何将Room Database导出为.CSV文件并保存至设备存储

一、前置准备：权限处理 #

• Android 10（API 29）及以上：优先用MediaStore写入公共目录，无需申请WRITE_EXTERNAL_STORAGE；如果要写入应用专属外部存储，直接操作即可，不需要任何权限。
• Android 9（API 28）及以下：需要动态申请WRITE_EXTERNAL_STORAGE权限，否则无法写入公共存储目录。

二、核心实现步骤 #

1. 获取Room数据库数据 #

先通过你的Dao接口查询需要导出的表数据，以User实体为例：

// 假设你的Dao有查询全量数据的方法
val userList = userDao.getAllUsers() // 建议在协程/后台线程执行

2. 生成标准CSV内容 #

手动拼接CSV（避免依赖第三方库），注意处理特殊字符（逗号、双引号、换行符）：

fun generateCsvContent(users: List<User>): String {
    val csvBuilder = StringBuilder()
    // 写入表头，和实体字段对应
    csvBuilder.append("ID,姓名,邮箱\n")
    
    users.forEach { user ->
        // 特殊字符处理：用双引号包裹字段，内部双引号替换为两个双引号
        val safeName = "\"${user.name.replace("\"", "\"\"")}\""
        val safeEmail = "\"${user.email.replace("\"", "\"\"")}\""
        csvBuilder.append("${user.id},$safeName,$safeEmail\n")
    }
    return csvBuilder.toString()
}

3. 保存CSV到设备存储 #

方案A：保存到应用专属外部存储（无需权限）

文件仅你的应用可见，卸载后会被删除：

fun saveToAppPrivateDir(context: Context, csvContent: String) {
    // 创建存储目录：外部存储/Android/data/[你的包名]/documents/RoomExports
    val exportDir = File(context.getExternalFilesDir(Environment.DIRECTORY_DOCUMENTS), "RoomExports")
    if (!exportDir.exists()) exportDir.mkdirs()
    
    val csvFile = File(exportDir, "room_export_${System.currentTimeMillis()}.csv")
    csvFile.writeText(csvContent, Charsets.UTF_8)
    
    // 提示用户保存路径
    Toast.makeText(context, "CSV已保存至：${csvFile.absolutePath}", Toast.LENGTH_LONG).show()
}

方案B：保存到公共下载目录（用户易找到）

用MediaStore实现，Android 10+无需额外权限：

fun saveToPublicDownloads(context: Context, csvContent: String) {
    val contentResolver = context.contentResolver
    val contentValues = ContentValues().apply {
        put(MediaStore.MediaColumns.DISPLAY_NAME, "room_export_${System.currentTimeMillis()}.csv")
        put(MediaStore.MediaColumns.MIME_TYPE, "text/csv")
        // 指定保存路径：下载目录/RoomExports
        put(MediaStore.MediaColumns.RELATIVE_PATH, "${Environment.DIRECTORY_DOWNLOADS}/RoomExports")
    }

    // 插入文件到MediaStore
    val uri = contentResolver.insert(MediaStore.Downloads.EXTERNAL_CONTENT_URI, contentValues)
    uri?.let {
        try {
            contentResolver.openOutputStream(it).use { outputStream ->
                outputStream?.write(csvContent.toByteArray(Charsets.UTF_8))
                Toast.makeText(context, "CSV已保存到下载目录/RoomExports", Toast.LENGTH_SHORT).show()
            }
        } catch (e: IOException) {
            e.printStackTrace()
            Toast.makeText(context, "保存失败", Toast.LENGTH_SHORT).show()
        }
    }
}

三、完整调用示例（Kotlin协程） #

// 在ViewModel或Repository中执行导出逻辑
viewModelScope.launch {
    try {
        val userList = appDatabase.userDao().getAllUsers()
        val csvContent = generateCsvContent(userList)
        saveToPublicDownloads(context, csvContent)
    } catch (e: Exception) {
        e.printStackTrace()
        Toast.makeText(context, "导出失败：${e.message}", Toast.LENGTH_SHORT).show()
    }
}

四、关键注意事项 #

• 所有IO操作（数据库查询、文件写入）必须放在后台线程，避免阻塞主线程导致ANR。
• 如果导出大表数据，建议分批读取生成CSV，避免内存溢出。
• 测试时注意不同Android版本的存储行为差异，尤其是Android 10的分区存储规则。

内容的提问来源于stack exchange，提问作者Faris Rizvanović