使用自動備份功能備份使用者資料

如果應用程式指定 Android 6.0 (API 級別 23) 以上版本並在其中執行,「應用程式自動備份」功能會自動備份應用程式內的使用者資料。Android 會將應用程式資料上傳到使用者的 Google 雲端硬碟,並透過使用者的 Google 帳戶憑證妥善保護。在搭載 Android 9 以上版本的裝置上,系統會使用裝置的 PIN 碼、解鎖圖案或密碼,對備份進行端對端加密處理。每個應用程式最多可為每位應用程式使用者分配 25 MB 的備份資料。 儲存備份資料不必付費。您的應用程式可以自訂備份程序,或透過停用備份功能來選擇退出。

概略瞭解 Android 備份選項,以及相關指引 備份與還原,請參閱資料備份總覽

備份的檔案

根據預設,自動備份功能會納入大部分目錄中的檔案,這些目錄是由系統指派給應用程式:

自動備份功能會排除以下項目所傳回目錄中的檔案:getCacheDir()getCodeCacheDir()getNoBackupFilesDir()。儲存在這些位置的檔案僅供暫時使用,因此備份作業會刻意排除這類檔案。

您可以設定應用程式,納入及排除特定檔案。詳情請參閱「納入及排除檔案」一節。

備份位置

備份資料會儲存在使用者 Google 雲端硬碟帳戶的私人資料夾,每個應用程式的資料量上限為 25 MB。儲存的資料不會計入使用者的個人 Google 雲端硬碟配額。系統只會保存最新的備份。進行備份時,會刪除任何先前的備份。使用者或裝置上的其他應用程式無法讀取備份資料。

使用者可以查看 Google 雲端硬碟已備份的應用程式清單 Android 應用程式。使用者可以在 Android 裝置上在雲端硬碟中找到這份清單 前往「設定」頁面設定應用程式導覽匣備份與重設

每個裝置設定生命週期的備份資料都會儲存在不同的資料集,如以下範例所述:

  • 如果使用者擁有兩部裝置,則每部裝置都會有備份資料集。

  • 如果使用者將裝置恢復原廠設定,然後透過 系統會將備份儲存在新的資料集中。過時資料集會在閒置一段時間後自動刪除。

備份時間表

系統會在符合下列所有條件時自動執行備份:

  • 使用者在裝置上啟用備份功能。在 Android 9 中,這項設定位於「設定」>「系統」>「備份」
  • 從上次備份到現在已經過了 24 小時。
  • 裝置處於閒置狀態。
  • 裝置已連上 Wi-Fi 網路 (如果裝置使用者尚未選擇) 開啟這項功能。

在實際運作時,這些情況大致每晚都會發生,但裝置可能會 永不備份 (例如從未連上網路的情況)。為了節省費用 網路頻寬,只有在應用程式資料有所變更時,才會執行上傳作業。

在自動備份期間,系統會關閉應用程式,確保應用程式已不再適用 將資料寫入檔案系統根據預設,備份系統會忽略在前景執行的應用程式,避免使用者體驗不佳。您可以覆寫 預設行為,方法是將 android:backupInForeground 屬性設為 true。

為簡化測試流程,Android 提供手動備份應用程式的工具。詳情請參閱「測試備份與還原」的相關說明。

還原時間表

無論是透過 Play 商店、在裝置設定期間 (系統安裝先前安裝過的應用程式) 或執行 adb 安裝,每次安裝應用程式都會還原資料。還原作業會在 APK 安裝完成後進行 但使用者必須先啟動應用程式

在初始裝置設定精靈中,系統會向使用者顯示可用的備份資料集清單,並詢問要從哪個資料集還原資料。只要選取任何備份資料集,就會成為該裝置的祖系資料集。裝置可以 從本身的備份或祖系資料集還原如果同時提供這兩個來源的備份資料,裝置會優先採用自身的備份。如果使用者未通過裝置設定精靈,則只能從自身備份還原。

為簡化測試流程,Android 提供手動還原應用程式的工具。詳情請參閱「測試備份與還原」的相關說明。

啟用及停用備份

以 Android 6.0 (API 級別 23) 或以上版本為目標的應用程式會自動加入「自動備份」功能。在應用程式資訊清單檔案中,將布林值 android:allowBackup 設為啟用或停用備份。預設值為 true,但建議您在資訊清單中明確設定這項屬性,如以下範例所示:

<manifest ... >
    ...
    <application android:allowBackup="true" ... >
        ...
    </application>
</manifest>

如要停用備份功能,請將 android:allowBackup 設為 false。如果應用程式可以透過其他機制重新建立狀態,或者應用程式會處理敏感資訊,則建議停用備份功能。

納入並排除檔案

根據預設,系統會備份絕大多數的應用程式資料。詳情請參閱「備份的檔案」一節。

本節說明如何定義自訂 XML 規則,控管要支援哪些項目 上。如果應用程式指定 Android 12 (API 級別 31) 以上版本,則必須按照本節說明另外指定一組 XML 備份規則,支援為搭載這些 Android 版本的裝置導入的備份與還原相關異動

在 Android 11 以下版本中控管備份功能

請按照本節所述步驟,決定要將哪些檔案備份至裝置上 搭載 Android 11 (API 級別 30) 以下版本。

  1. AndroidManifest.xml 檔案中,將 android:fullBackupContent 屬性加入 <application> 元素中,如以下範例所示。這個屬性指向 包含備份規則

    <application ...
     android:fullBackupContent="@xml/backup_rules">
    </application>
  2. res/xml/ 目錄中建立名為 @xml/backup_rules 的 XML 檔案。在這個檔案中,新增包含 <include><exclude> 元素的規則。以下範例會備份 device.xml 以外的所有共用偏好設定:

    <?xml version="1.0" encoding="utf-8"?>
    <full-backup-content>
     <include domain="sharedpref" path="."/>
     <exclude domain="sharedpref" path="device.xml"/>
    </full-backup-content>

定義備份所需的裝置條件

如果應用程式會將私密資訊儲存在裝置中,您可以指定在使用者資料備份中納入資料的條件。你可以 在 Android 9 (API 級別 28) 以上版本中新增以下條件:

如果您已將開發裝置升級至 Android 9,則需要在升級後停用資料備份功能,再重新啟用此功能。這是因為 Android 只有在透過「設定」或「設定精靈」通知使用者後,才會使用用戶端密鑰加密備份。

如要宣告納入條件,請將 requireFlags 屬性設為備份規則集內 <include> 元素中所選值:

backup_rules.xml

<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
    <!-- App data isn't included in user's backup
         unless client-side encryption is enabled. -->
    <include domain="file" path="."
             requireFlags="clientSideEncryption" />
</full-backup-content>

如果您的應用程式實作鍵/值備份系統,或是您自行實作 BackupAgent,也可以在BackupDataOutput 物件的傳輸標記集合與自訂備份代理程式的 FLAG_CLIENT_SIDE_ENCRYPTION_ENABLEDFLAG_DEVICE_TO_DEVICE_TRANSFER 標記之間執行位元比較,將這些條件規定套用至備份邏輯。

下列程式碼片段提供這個方法的使用範例:

Kotlin

class CustomBackupAgent : BackupAgent() {
    override fun onBackup(oldState: ParcelFileDescriptor?,
            data: BackupDataOutput?, newState: ParcelFileDescriptor?) {
        if (data != null) {
            if ((data.transportFlags and
                    FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED) != 0) {
                // Client-side backup encryption is enabled.
            }

            if ((data.transportFlags and FLAG_DEVICE_TO_DEVICE_TRANSFER) != 0) {
                // Local device-to-device transfer is enabled.
            }
        }
    }

    // Implementation of onRestore() here.
}

Java

public class CustomBackupAgent extends BackupAgent {
    @Override
    public void onBackup(ParcelFileDescriptor oldState, BackupDataOutput data,
            ParcelFileDescriptor newState) throws IOException {
        if ((data.getTransportFlags() &
                FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED) != 0) {
            // Client-side backup encryption is enabled.
        }

        if ((data.getTransportFlags() &
                FLAG_DEVICE_TO_DEVICE_TRANSFER) != 0) {
            // Local device-to-device transfer is enabled.
        }
    }

    // Implementation of onRestore() here.
}

在 Android 12 以上版本中控管備份功能

如果應用程式指定 Android 12 (API 級別 31) 以上版本,請按照本節所述步驟,控管要在搭載 Android 12 以上版本的裝置上備份哪些檔案。

  1. AndroidManifest.xml 檔案中,將 android:dataExtractionRules 屬性加入 <application> 元素中,如以下範例所示。這個屬性指向 XML 匯出內含備份規則的檔案

    <application ...
     android:dataExtractionRules="backup_rules.xml">
    </application>
  2. res/xml/ 目錄中建立名為 backup_rules.xml 的 XML 檔案。在這個檔案中,新增包含 <include><exclude> 元素的規則。以下範例會備份 device.xml 以外的所有共用偏好設定:

    <?xml version="1.0" encoding="utf-8"?>
    <data-extraction-rules>
     <cloud-backup [disableIfNoEncryptionCapabilities="true|false"]>
       <include domain="sharedpref" path="."/>
       <exclude domain="sharedpref" path="device.xml"/>
     </cloud-backup>
    </data-extraction-rules>

XML 設定語法

設定檔的 XML 語法取決於應用程式指定及運作於哪個 Android 版本。

Android 11 以下版本

針對搭載 Android 11 或以下版本的裝置控管備份作業的設定檔,使用以下 XML 語法。

<full-backup-content>
    <include domain=["file" | "database" | "sharedpref" | "external" |
                     "root" | "device_file" | "device_database" |
                     "device_sharedpref" | "device_root" ] path="string"
    requireFlags=["clientSideEncryption" | "deviceToDeviceTransfer"] />
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                     "root" | "device_file" | "device_database" |
                     "device_sharedpref" | "device_root" ] path="string" />
</full-backup-content>

搭載 Android 12 或以上版本

如果應用程式指定 Android 12 (API 級別 31) 以上的版本,請使用以下 XML 語法製作設定檔,為搭載 Android 12 以上版本的裝置控管備份

<data-extraction-rules>
  <cloud-backup [disableIfNoEncryptionCapabilities="true|false"]>
    ...
    <include domain=["file" | "database" | "sharedpref" | "external" |
                     "root" | "device_file" | "device_database" |
                     "device_sharedpref" | "device_root" ] path="string"/>
    ...
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                     "root" | "device_file" | "device_database" |
                     "device_sharedpref" | "device_root" ] path="string"/>
    ...
  </cloud-backup>
  <device-transfer>
    ...
    <include domain=["file" | "database" | "sharedpref" | "external" |
                     "root" | "device_file" | "device_database" |
                     "device_sharedpref" | "device_root" ] path="string"/>
    ...
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                     "root" | "device_file" | "device_database" |
                     "device_sharedpref" | "device_root" ] path="string"/>
    ...
  </device-transfer>
</data-extraction-rules>

設定的各區段 (<cloud-backup><device-transfer>) 都包含僅適用於該轉移類型的規則。舉例來說,您可以使用這個區隔方式,從 Google 雲端硬碟備份中排除某個檔案或目錄,但仍可在執行裝置間 (D2D) 轉移作業時轉移該檔案或目錄。如果您的情況 你的檔案過大,無法備份到雲端,但可以轉移 。

如果特定備份模式沒有規則 (例如 缺少「<device-transfer>」部分,已全面啟用該模式 但 no-backupcache 目錄除外,詳情請參閱 已備份的檔案專區。

應用程式可在 <cloud-backup> 區段中設定 disableIfNoEncryptionCapabilities 標記,確保在備份時處於可加密狀態 (例如在使用者設有螢幕鎖定時)。設定這項限制 如果使用者的裝置不支援,停止將備份資料傳送至雲端 加密,不過由於 D2D 傳輸作業不會傳送至伺服器,因此會繼續 可在不支援加密功能的裝置上運作

包含和排除元素的語法

<full-backup-content><cloud-backup><device-transfer>內部 標記 (視裝置的 Android 版本和應用程式的 targetSDKVersion),您可以定義 <include><exclude> 元素:

<include>

指定要備份的檔案或資料夾。根據預設,自動備份功能涵蓋幾乎所有的應用程式檔案。如果指定 <include> 元素, 系統不再預設納入任何檔案,而是只備份 。如要納入多個檔案,請使用多個 <include> 元素。

Android 11 以下版本中,這個元素也可以包含 requireFlags 屬性,定義方式 備份的條件需求詳細說明。

getCacheDir()getCodeCacheDir() 或 即使您納入了 getNoBackupFilesDir(),系統一律會予以排除。

<exclude>

指定要在備份期間排除的檔案或資料夾。以下列舉一些常見的備份檔案:

  • 含有裝置專屬 ID 的檔案 (由伺服器核發) 或裝置上產生的圖片例如 Firebase 雲端通訊 (FCM) 每次使用者都必須產生註冊權杖 在新裝置上安裝您的應用程式。如果舊的註冊權杖是 應用程式可能會無法正常運作。

  • 與應用程式偵錯相關的檔案。

  • 導致應用程式超過 25 MB 備份配額的大型檔案。

每個 <include><exclude> 元素都必須包含下列兩個屬性:

domain

指定資源的所在位置。這個屬性的有效值 包括:

  • root:存放所有私人檔案的檔案系統目錄 。
  • file:由 getFilesDir() 傳回的目錄。
  • database:由 getDatabasePath() 傳回的目錄。資料庫數 使用 SQLiteOpenHelper 建立的圖片會儲存在這裡。
  • sharedpref:儲存 SharedPreferences 的目錄。
  • externalgetExternalFilesDir() 傳回的目錄。
  • device_root:類似 root,但適用於受裝置保護的儲存空間。
  • device_file:類似 file,但適用於受裝置保護的儲存空間。
  • device_database:類似 database,但適用於受裝置保護的儲存空間。
  • device_sharedpref:類似 sharedpref,但適用於受裝置保護的儲存空間。
path

指定要在備份中納入或排除的檔案或資料夾。注意事項 包括:

  • 這個屬性不支援萬用字元或規則運算式語法。
  • 您可以使用 ./ 參照目前的目錄,但基於安全考量,您無法使用 .. 等符號參照父項目錄。
  • 如果您指定目錄,規則就會套用至該目錄和遞迴子目錄中的所有檔案。

實作 BackupAgent

實作自動備份功能的應用程式不需要實作 BackupAgent。不過,您也可以選擇實作自訂 BackupAgent。一般來說,這樣做的原因有 2 種:

  • 您想收到備份事件的通知,例如 onRestoreFinished()onQuotaExceeded(long, long)。即使應用程式處於未執行狀態,這些回呼方法仍會執行。

  • 您無法使用 XML 規則明確表示要備份的檔案組合。如果發生這類罕見情況,您可以實作 BackupAgent 來覆寫 onFullBackup(FullBackupDataOutput),儲存所需資料。如要保留系統的預設實作方式,請使用 super.onFullBackup() 對父類別呼叫相應的方法。

在預設情況下,如果您實作 BackupAgent,系統會預期應用程式執行鍵/值備份與還原作業。如要改用以檔案為基礎的自動備份功能,請在應用程式資訊清單中將 android:fullBackupOnly 屬性設為 true

在自動備份和還原作業期間,系統會以受限模式啟動應用程式,防止應用程式存取可能導致衝突的檔案,並讓應用程式執行 BackupAgent 中的回呼方法。在這種受限模式下,應用程式的主要活動不會自動啟動,內容供應器未初始化,且建立的是基礎類別 Application 的例項,而非應用程式資訊清單中宣告的任何子類別。

您的 BackupAgent 必須實作抽象方法 onBackup()onRestore(),這兩種方法都用於鍵/值備份。如果不想執行鍵/值備份,只要將這些方法的實作內容留白即可。

詳情請參閱「延長 BackupAgent」。