輕量級(jí)存儲(chǔ)

輕量級(jí)存儲(chǔ)為應(yīng)用提供key-value鍵值型的文件數(shù)據(jù)處理能力，支持應(yīng)用對(duì)數(shù)據(jù)進(jìn)行輕量級(jí)存儲(chǔ)及查詢(xún)。數(shù)據(jù)存儲(chǔ)形式為鍵值對(duì)，鍵的類(lèi)型為字符串型，值的存儲(chǔ)數(shù)據(jù)類(lèi)型包括數(shù)字型、字符型、布爾型。

說(shuō)明：
開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

• 本模塊首批接口從API version 6開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。
• 從API Version 9開(kāi)始，該接口不再維護(hù)，推薦使用新接口[@ohos.data.preferences]。

導(dǎo)入模塊

import data_storage from '@ohos.data.storage';

常量

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.DistributedDataManager.Preferences.Core

data_storage.getStorageSync

getStorageSync(path: string): Storage

讀取指定文件，將數(shù)據(jù)加載到Storage實(shí)例，用于數(shù)據(jù)操作。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

import data_storage from '@ohos.data.storage'

let path = '/data/storage/el2/database'
let storage = data_storage.getStorageSync(path + '/mystore')
storage.putSync('startup', 'auto')
storage.flushSync()

data_storage.getStorage

getStorage(path: string, callback: AsyncCallback): void

讀取指定文件，將數(shù)據(jù)加載到Storage實(shí)例，用于數(shù)據(jù)操作，使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

import data_storage from '@ohos.data.storage'

let path = '/data/storage/el2/database'
data_storage.getStorage(path + '/mystore', function (err, storage) {
    if (err) {
        console.info("Get the storage failed, path: " + path + '/mystore')
        return;
    }
    storage.putSync('startup', 'auto')
    storage.flushSync()
})

data_storage.getStorage

getStorage(path: string): Promise

讀取指定文件，將數(shù)據(jù)加載到Storage實(shí)例，用于數(shù)據(jù)操作，使用Promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

import data_storage from '@ohos.data.storage'

let path = '/data/storage/el2/database'

let getPromise = data_storage.getStorage(path + '/mystore')
getPromise.then((storage) = > {
    storage.putSync('startup', 'auto')
    storage.flushSync()
}).catch((err) = > {
    console.info("Get the storage failed, path: " + path + '/mystore')
})

data_storage.deleteStorageSync

deleteStorageSync(path: string): void

從內(nèi)存中移除指定文件對(duì)應(yīng)的Storage單實(shí)例，并刪除指定文件及其備份文件、損壞文件。刪除指定文件時(shí)，應(yīng)用不允許再使用該實(shí)例進(jìn)行數(shù)據(jù)操作，否則會(huì)出現(xiàn)數(shù)據(jù)一致性問(wèn)題。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

let path = '/data/storage/el2/database'
data_storage.deleteStorageSync(path + '/mystore')

data_storage.deleteStorage

deleteStorage(path: string, callback: AsyncCallback): void

從內(nèi)存中移除指定文件對(duì)應(yīng)的Storage單實(shí)例，并刪除指定文件及其備份文件、損壞文件。刪除指定文件時(shí)，應(yīng)用不允許再使用該實(shí)例進(jìn)行數(shù)據(jù)操作，否則會(huì)出現(xiàn)數(shù)據(jù)一致性問(wèn)題，使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

let path = '/data/storage/el2/database'
data_storage.deleteStorage(path + '/mystore', function (err) {
    if (err) {
        console.info("Deleted failed with err: " + err)
        return
    }
    console.info("Deleted successfully.")
})

data_storage.deleteStorage

deleteStorage(path: string): Promise

從內(nèi)存中移除指定文件對(duì)應(yīng)的Storage單實(shí)例，并刪除指定文件及其備份文件、損壞文件。刪除指定文件時(shí)，應(yīng)用不允許再使用該實(shí)例進(jìn)行數(shù)據(jù)操作，否則會(huì)出現(xiàn)數(shù)據(jù)一致性問(wèn)題，使用promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

let path = '/data/storage/el2/database'
let promisedelSt = data_storage.deleteStorage(path + '/mystore')
promisedelSt.then(() = > {
    console.info("Deleted successfully.")
}).catch((err) = > {
    console.info("Deleted failed with err: " + err)
})

data_storage.removeStorageFromCacheSync

removeStorageFromCacheSync(path: string): void

從內(nèi)存中移除指定文件對(duì)應(yīng)的Storage單實(shí)例。移除Storage單實(shí)例時(shí)，應(yīng)用不允許再使用該實(shí)例進(jìn)行數(shù)據(jù)操作，否則會(huì)出現(xiàn)數(shù)據(jù)一致性問(wèn)題。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

let path = '/data/storage/el2/database'
data_storage.removeStorageFromCacheSync(path + '/mystore')

data_storage.removeStorageFromCache

removeStorageFromCache(path: string, callback: AsyncCallback): void

從內(nèi)存中移除指定文件對(duì)應(yīng)的Storage單實(shí)例。移除Storage單實(shí)例時(shí)，應(yīng)用不允許再使用該實(shí)例進(jìn)行數(shù)據(jù)操作，否則會(huì)出現(xiàn)數(shù)據(jù)一致性問(wèn)題。使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

let path = '/data/storage/el2/database'
data_storage.removeStorageFromCache(path + '/mystore', function (err) {
    if (err) {
        console.info("Removed storage from cache failed with err: " + err)
        return
    }
    console.info("Removed storage from cache successfully.")
})

data_storage.removeStorageFromCache

removeStorageFromCache(path: string): Promise

從內(nèi)存中移除指定文件對(duì)應(yīng)的Storage單實(shí)例。移除Storage單實(shí)例時(shí)，應(yīng)用不允許再使用該實(shí)例進(jìn)行數(shù)據(jù)操作，否則會(huì)出現(xiàn)數(shù)據(jù)一致性問(wèn)題。使用Promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

let path = '/data/storage/el2/database'
let promiserevSt = data_storage.removeStorageFromCache(path + '/mystore')
promiserevSt.then(() = > {
    console.info("Removed storage from cache successfully.")
}).catch((err) = > {
    console.info("Removed storage from cache failed with err: " + err)
})

Storage

提供獲取和修改存儲(chǔ)數(shù)據(jù)的接口。

getSync

getSync(key: string, defValue: ValueType): ValueType

獲取鍵對(duì)應(yīng)的值，如果值為null或者非默認(rèn)值類(lèi)型，返回默認(rèn)數(shù)據(jù)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

let value = storage.getSync('startup', 'default')
console.info("The value of startup is " + value)

get

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

獲取鍵對(duì)應(yīng)的值，如果值為null或者非默認(rèn)值類(lèi)型，返回默認(rèn)數(shù)據(jù)。使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

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

get

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

獲取鍵對(duì)應(yīng)的值，如果值為null或者非默認(rèn)值類(lèi)型，返默認(rèn)數(shù)據(jù)。使用Promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

let promiseget = storage.get('startup', 'default')
promiseget.then((value) = > {
    console.info("The value of startup is " + value)
}).catch((err) = > {
    console.info("Get the value of startup failed with err: " + err)
})

putSync

putSync(key: string, value: ValueType): void

首先獲取指定文件對(duì)應(yīng)的Storage實(shí)例，然后借助Storage API將數(shù)據(jù)寫(xiě)入Storage實(shí)例，通過(guò)flush或者flushSync將Storage實(shí)例持久化。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

storage.putSync('startup', 'auto')

put

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

首先獲取指定文件對(duì)應(yīng)的Storage實(shí)例，然后借助Storage API將數(shù)據(jù)寫(xiě)入Storage實(shí)例，通過(guò)flush或者flushSync將Storage實(shí)例持久化。使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

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

put

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

首先獲取指定文件對(duì)應(yīng)的Storage實(shí)例，然后借助Storage API將數(shù)據(jù)寫(xiě)入Storage實(shí)例，通過(guò)flush或者flushSync將Storage實(shí)例持久化。使用Promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

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

hasSync

hasSync(key: string): boolean

檢查存儲(chǔ)對(duì)象是否包含名為給定key的存儲(chǔ)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

let isExist = storage.hasSync('startup')
if (isExist) {
    console.info("The key of startup is contained.")
}

has

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

檢查存儲(chǔ)對(duì)象是否包含名為給定key的存儲(chǔ)。使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

storage.has('startup', function (err, isExist) {
    if (err) {
        console.info("Check the key of startup failed with err: " + err)
        return
    }
    if (isExist) {
        console.info("The key of startup is contained.")
    }
})

has

has(key: string): Promise

檢查存儲(chǔ)對(duì)象是否包含名為給定key的存儲(chǔ)。使用Promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

let promisehas = storage.has('startup')
promisehas.then((isExist) = > {
    if (isExist) {
        console.info("The key of startup is contained.")
    }
}).catch((err) = > {
    console.info("Check the key of startup failed with err: " + err)
})

deleteSync

deleteSync(key: string): void

從存儲(chǔ)對(duì)象中刪除名為給定key的存儲(chǔ)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

storage.deleteSync('startup')

delete

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

從存儲(chǔ)對(duì)象中刪除名為給定key的存儲(chǔ)。使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

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

delete

delete(key: string): Promise

從存儲(chǔ)對(duì)象刪除名為給定key的存儲(chǔ)。使用Promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

返回值：

示例：

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

flushSync

flushSync(): void

將當(dāng)前storage對(duì)象中的修改保存到當(dāng)前的storage，并同步存儲(chǔ)到文件中。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

示例：

storage.flushSync()

flush

flush(callback: AsyncCallback): void

將當(dāng)前storage對(duì)象中的修改保存到當(dāng)前的storage，并異步存儲(chǔ)到文件中。使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

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

flush

flush(): Promise

將當(dāng)前storage對(duì)象中的修改保存到當(dāng)前的storage，并異步存儲(chǔ)到文件中。使用Promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

返回值：

示例：

let promiseflush = storage.flush()
promiseflush.then(() = > {
    console.info("Flushed to file successfully.")
}).catch((err) = > {
    console.info("Flush to file failed with err: " + err)
})

clearSync

clearSync(): void

清除此存儲(chǔ)對(duì)象中的所有存儲(chǔ)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

示例：

storage.clearSync()

clear

clear(callback: AsyncCallback): void

清除此存儲(chǔ)對(duì)象中的所有存儲(chǔ)。使用callback方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

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

clear

clear(): Promise

清除此存儲(chǔ)對(duì)象中的所有存儲(chǔ)。使用Promise方式返回結(jié)果，此方法為異步方法。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

返回值：

示例：

let promiseclear = storage.clear()
promiseclear.then(() = > {
    console.info("Cleared to file successfully.")
}).catch((err) = > {
    console.info("Clear to file failed with err: " + err)
})

on('change')

on(type: 'change', callback: Callback): void

訂閱數(shù)據(jù)變更者類(lèi)需要實(shí)現(xiàn)StorageObserver接口，訂閱的key的值發(fā)生變更后，在執(zhí)行flush/flushSync方法后，callback方法會(huì)被回調(diào)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

var observer = function (key) {
    console.info("The key of " + key + " changed.")
}
storage.on('change', observer)
storage.putSync('startup', 'auto')
storage.flushSync()  // observer will be called.

off('change')

off(type: 'change', callback: Callback): void

當(dāng)不再進(jìn)行訂閱數(shù)據(jù)變更時(shí)，使用此接口取消訂閱。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

參數(shù)：

示例：

var observer = function (key) {
    console.info("The key of " + key + " changed.")
}
storage.off('change', observer)

StorageObserver

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.DistributedDataManager.Preferences.Core

ValueType

用于表示允許的數(shù)據(jù)字段類(lèi)型。

系統(tǒng)能力： SystemCapability.DistributedDataManager.Preferences.Core

審核編輯 黃宇