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

「應用程式自動備份」功能會自動針對在 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。如果您的應用程式可能透過其他機制重新建立狀態,或是應用程式會處理 Android 不應備份的機密資訊,則建議您這麼做。

納入並排除檔案

根據預設,系統會備份絕大多數的應用程式資料。詳情請參閱會進行備份的檔案一節。本節將說明如何定義自訂 XML 規則來控管備份的內容。如果您的應用程式指定 Android 12 (API 級別 31) 或以上的版本,則您必須指定其他 XML 備份規則,以支援備份還原變更而搭載 Android 12 或以上版本的裝置。

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

請按照本節的步驟,納入或排除在搭載 Android 11 (API 級別 30) 或更低儲存空間的裝置上備份的檔案。

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

    <application ...
     android:fullBackupContent="@xml/backup_rules">
    </application>
    
  2. res/xml/ 目錄中建立一個名為 backup_rules.xml 的 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"] path="string"
    requireFlags=["clientSideEncryption" | "deviceToDeviceTransfer"] />
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                     "root"] path="string" />
</full-backup-content>

搭載 Android 12 或以上版本

如果您的應用程式指定 Android 12 (API 級別 31) 或以上的版本,請針對搭載 Android 12 或以上版本的裝置控制設定檔,並使用以下 XML 語法。

<data-extraction-rules>
  <cloud-backup [disableIfNoEncryptionCapabilities="true|false"]>
    ...
    <include domain=["file" | "database" | "sharedpref" | "external" |
                        "root"] path="string"/>
    ...
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                        "root"] path="string"/>
    ...
  </cloud-backup>
  <device-transfer>
    ...
    <include domain=["file" | "database" | "sharedpref" | "external" |
                        "root"] path="string"/>
    ...
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                        "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 屬性,定義備份的條件要求一節會詳細說明實作方式。

提示:如要備份使用者憑證和驗證權杖,請勿將憑證儲存在共用偏好設定或檔案中。請改用 Block Store API 來儲存和管理憑證。這樣做可以確保安全儲存,而且可以與其他應用程式資料進行備份和還原。

<exclude>

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

  • 含有裝置專屬 ID 的檔案 (由伺服器核發或在裝置上產生)。舉例來說,每當使用者在新裝置上安裝應用程式時,Firebase 雲端通訊 (FCM) 都必須產生註冊權杖。如果還原舊的註冊權杖,應用程式可能會發生非預期的行為。

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

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

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

domain

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

  • root 這是儲存這個應用程式的所有私人檔案的檔案系統。
  • filegetFilesDir() 傳回的目錄。
  • databasegetDatabasePath() 傳回的目錄。使用 SQLiteOpenHelper 建立的資料庫會儲存在這裡。
  • sharedpref 儲存 SharedPreferences 的目錄。
  • externalgetExternalFilesDir() 傳回的目錄。
path

指定要納入或排除備份中的檔案或資料夾。請注意以下事項:

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

實作 BackupAgent

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

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

  • 您無法透過 XML 規則明確呈現您要備份的一組檔案。在這種極少數的情況下,您可以實作 BackupAgent 以覆寫 onFullBackup(FullBackupDataOutput) 來儲存所需資料。如要保留系統的預設實作方式,請使用 super.onFullBackup() 對父類別呼叫相應的方法。

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

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

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

詳情請參閱延長 AgentAgent