首選項

首選項為應用提供key-value鍵值型的數據處理能力，支持應用持久化輕量級數據，并對其修改和查詢。數據存儲形式為鍵值對，鍵的類型為字符串型，值的存儲數據類型包括數字型、字符型、布爾型。

說明： 本模塊首批接口從API version 9開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導入模塊

import data_preferences from '@ohos.data.preferences';

常量

系統能力： 以下各項對應的系統能力均為SystemCapability.DistributedDataManager.Preferences.Core

data_preferences.getPreferences

getPreferences(context: Context, name: string, callback: AsyncCallback): void

讀取指定首選項持久化文件，將數據加載到Preferences實例，用于數據操作，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
    if (err) {
        console.info("Get preferences failed.")
        return;
    }
    console.info("Get preferences successfully.")
})

data_preferences.getPreferences

getPreferences(context: Context, name: string): Promise

讀取指定首選項持久化文件，將數據加載到Preferences實例，用于數據操作，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

返回值：

示例：

let promise = data_preferences.getPreferences(this.context, 'mystore')
promise.then((preferences) = > {
    console.info("Get preferences successfully.")
}).catch((err) = > {
    console.info("Get preferences failed.")
})

data_preferences.deletePreferences

deletePreferences(context: Context, name: string, callback: AsyncCallback): void

從內存中移除指定首選項持久化文件對應的Preferences單實例，并刪除指定文件及其備份文件和損壞文件。 刪除指定首選項持久化文件時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

data_preferences.deletePreferences(this.context, 'mystore', function (err) {
    if (err) {
        console.info("Deleted preferences failed, err: " + err)
        return
    }
    console.info("Deleted preferences successfully.")
})

data_preferences.deletePreferences

deletePreferences(context: Context, name: string): Promise

從內存中移除指定首選項持久化文件對應的Preferences單實例，并刪除指定文件及其備份文件和損壞文件。 刪除指定首選項持久化文件時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

返回值：

示例：

let promise = data_preferences.deletePreferences(this.context, 'mystore')
promise.then(() = > {
    console.info("Deleted preferences successfully.")
}).catch((err) = > {
    console.info("Deleted preferences failed, err: " + err)
})

data_preferences.removePreferencesFromCache

removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback): void

從內存中移除指定首選項持久化文件對應的Preferences單實例。

移除Preferences單實例時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

data_preferences.removePreferencesFromCache(this.context, 'mystore', function (err) {
    if (err) {
        console.info("Removed preferences from cache failed, err: " + err)
        return
    }
    console.info("Removed preferences from cache successfully.")
})

data_preferences.removePreferencesFromCache

removePreferencesFromCache(context: Context, name: string): Promise

從內存中移除指定首選項持久化文件對應的Preferences單實例。

移除Preferences單實例時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

返回值：

示例：

let promise = data_preferences.removePreferencesFromCache(this.context, 'mystore')
promise.then(() = > {
    console.info("Removed preferences from cache successfully.")
}).catch((err) = > {
    console.info("Removed preferences from cache failed, err: " + err)
})

Preferences

提供獲取和修改存儲數據的接口。

get

get(key: string, defValue: ValueType, callback: AsyncCallback): void

獲取鍵對應的值，如果值為null或者非默認值類型，返回默認數據，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

preferences.get('startup', 'default', function(err, value) {
    if (err) {
        console.info("Get value of startup failed, err: " + err)
        return
    }
    console.info("Get value of startup is " + value)
})

get

get(key: string, defValue: ValueType): Promise

獲取鍵對應的值，如果值為null或者非默認值類型，返回默認數據，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

• 參數：

  參數名	類型	必填	說明
  key	string	是	要獲取的存儲key名稱，不能為空。
  defValue	[ValueType]	是	默認返回值。支持number、string、boolean。

返回值：

示例：

let promise = preferences.get('startup', 'default')
promise.then((value) = > {
    console.info("Get value of startup is " + value)
}).catch((err) = > {
    console.info("Get value of startup failed, err: " + err)
})

getAll

getAll(callback: AsyncCallback ): void;

返回含有所有鍵值的Object對象。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

preferences.getAll(function (err, value) {
    if (err) {
        console.info("getAll failed, err: " + err)
        return
    }
    let keys = Object.keys(value)
    console.info('getAll keys = ' + keys)
    console.info("getAll object = " + JSON.stringify(value))
});

getAll

getAll(): Promise

返回含有所有鍵值的Object對象。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

返回值：

示例：

let promise = preferences.getAll()
promise.then((value) = > {
    let keys = Object.keys(value)
    console.info('getAll keys = ' + keys)
    console.info("getAll object = " + JSON.stringify(value))
}).catch((err) = > {
    console.info("getAll failed, err: " + err)
})

put

put(key: string, value: ValueType, callback: AsyncCallback): void

首先獲取指定首選項持久化文件對應的Preferences實例，然后借助Preferences API將數據寫入Preferences實例，通過flush或者flushSync將Preferences實例持久化，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

preferences.put('startup', 'auto', function (err) {
    if (err) {
        console.info("Put value of startup failed, err: " + err)
        return
    }
    console.info("Put value of startup successfully.")
})

put

put(key: string, value: ValueType): Promise

首先獲取指定首選項持久化文件對應的Preferences實例，然后借助Preferences API將數據寫入Preferences實例，通過flush或者flushSync將Preferences實例持久化，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

返回值：

示例：

let promise = preferences.put('startup', 'auto')
promise.then(() = > {
    console.info("Put value of startup successfully.")
}).catch((err) = > {
    console.info("Put value of startup failed, err: " + err)
})

has

has(key: string, callback: AsyncCallback): void

檢查存儲對象是否包含名為給定key的存儲鍵值對，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

preferences.has('startup', function (err, isExist) {
    if (err) {
        console.info("Check the key of startup failed, err: " + err)
        return
    }
    if (isExist) {
        console.info("The key of startup is contained.")
    } else {
        console.info("The key of startup dose not contain.")
    }
})

has

has(key: string): Promise

檢查存儲對象是否包含名為給定key的存儲鍵值對，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

返回值：

示例：

let promise = preferences.has('startup')
promise.then((isExist) = > {
    if (isExist) {
        console.info("The key of startup is contained.")
    } else {
        console.info("The key of startup dose not contain.")
    }
}).catch((err) = > {
    console.info("Check the key of startup failed, err: " + err)
})

delete

delete(key: string, callback: AsyncCallback): void

從存儲對象中刪除名為給定key的存儲鍵值對，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

preferences.delete('startup', function (err) {
    if (err) {
        console.info("Delete startup key failed, err: " + err)
        return
    }
    console.info("Deleted startup key successfully.")
})

delete

delete(key: string): Promise

從存儲對象刪除名為給定key的存儲鍵值對，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

返回值：

示例：

let promise = preferences.delete('startup')
promise.then(() = > {
    console.info("Deleted startup key successfully.")
}).catch((err) = > {
    console.info("Delete startup key failed, err: " + err)
})

flush

flush(callback: AsyncCallback): void

將當前preferences對象中的修改保存到當前的preferences，并異步存儲到首選項持久化文件中，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

preferences.flush(function (err) {
    if (err) {
        console.info("Flush to file failed, err: " + err)
        return
    }
    console.info("Flushed to file successfully.")
})

flush

flush(): Promise

將當前preferences對象中的修改保存到當前的preferences，并異步存儲到首選項持久化文件中，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

返回值：

示例：

let promise = preferences.flush()
promise.then(() = > {
    console.info("Flushed to file successfully.")
}).catch((err) = > {
    console.info("Flush to file failed, err: " + err)
})

clear

clear(callback: AsyncCallback): void

清除此存儲對象中的所有存儲，該方法使用callback方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

preferences.clear(function (err) {
    if (err) {
        console.info("Clear to file failed, err: " + err)
        return
    }
    console.info("Cleared to file successfully.")
})

clear

clear(): Promise

清除此存儲對象中的所有存儲，該方法使用Promise方式作為異步方法。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

返回值：

示例：

let promise = preferences.clear()
promise.then(() = > {
    console.info("Cleared to file successfully.")
}).catch((err) = > {
    console.info("Clear to file failed, err: " + err)
})

on('change')

on(type: 'change', callback: Callback<{ key : string }>): void

訂閱數據變更者類，訂閱的key的值發生變更后，在執行flush方法后，callback方法會被回調。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
    if (err) {
        console.info("Get preferences failed.")
        return;
    }
    var observer = function (key) {
        console.info("The key of " + key + " changed.")
    }
    preferences.on('change', observer)
    preferences.put('startup', 'auto', function (err) {
        if (err) {
            console.info("Put the value of startup failed, err: " + err)
            return
        }
        console.info("Put the value of startup successfully.")

        preferences.flush(function (err) {
            if (err) {
                console.info("Flush to file failed, err: " + err)
                return
            }
            console.info("Flushed to file successfully.") // observer will be called.
        })
    })
})

off('change')

off(type: 'change', callback?: Callback<{ key : string }>): void

當不再進行訂閱數據變更時，使用此接口取消訂閱。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

參數：

示例：

data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
    if (err) {
        console.info("Get preferences failed.")
        return;
    }
    var observer = function (key) {
        console.info("The key of " + key + " changed.")
    }
    preferences.on('change', observer)
    preferences.put('startup', 'auto', function (err) {
        if (err) {
            console.info("Put the value of startup failed, err: " + err)
            return
        }
        console.info("Put the value of startup successfully.")

        preferences.flush(function (err) {
            if (err) {
                console.info("Flush to file failed, err: " + err)
                return
            }
            console.info("Flushed to file successfully.") // observer will be called.
        })
        preferences.off('change', observer)
    })
})

ValueType

用于表示允許的數據字段類型。

系統能力： SystemCapability.DistributedDataManager.Preferences.Core

審核編輯 黃宇