輕量級存儲

輕量級存儲為應用提供key-value鍵值型的文件數據處理能力，支持應用對數據進行輕量級存儲及查詢。數據存儲形式為鍵值對，鍵的類型為字符串型，值的存儲數據類型包括數字型、字符型、布爾型。

說明：
開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

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

導入模塊

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

常量

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

data_storage.getStorageSync

getStorageSync(path: string): Storage

讀取指定文件，將數據加載到Storage實例，用于數據操作。

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

參數：

返回值：

示例：

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

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

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

參數：

示例：

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

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

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

參數：

返回值：

示例：

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

從內存中移除指定文件對應的Storage單實例，并刪除指定文件及其備份文件、損壞文件。刪除指定文件時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題。

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

參數：

示例：

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

data_storage.deleteStorage

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

從內存中移除指定文件對應的Storage單實例，并刪除指定文件及其備份文件、損壞文件。刪除指定文件時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題，使用callback方式返回結果，此方法為異步方法。

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

參數：

示例：

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

從內存中移除指定文件對應的Storage單實例，并刪除指定文件及其備份文件、損壞文件。刪除指定文件時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題，使用promise方式返回結果，此方法為異步方法。

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

參數：

返回值：

示例：

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

從內存中移除指定文件對應的Storage單實例。移除Storage單實例時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題。

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

參數：

示例：

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

data_storage.removeStorageFromCache

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

從內存中移除指定文件對應的Storage單實例。移除Storage單實例時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題。使用callback方式返回結果，此方法為異步方法。

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

參數：

示例：

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

從內存中移除指定文件對應的Storage單實例。移除Storage單實例時，應用不允許再使用該實例進行數據操作，否則會出現數據一致性問題。使用Promise方式返回結果，此方法為異步方法。

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

參數：

返回值：

示例：

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

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

getSync

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

獲取鍵對應的值，如果值為null或者非默認值類型，返回默認數據。

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

參數：

返回值：

示例：

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

get

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

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

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

參數：

示例：

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

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

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

參數：

返回值：

示例：

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

首先獲取指定文件對應的Storage實例，然后借助Storage API將數據寫入Storage實例，通過flush或者flushSync將Storage實例持久化。

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

參數：

示例：

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

put

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

首先獲取指定文件對應的Storage實例，然后借助Storage API將數據寫入Storage實例，通過flush或者flushSync將Storage實例持久化。使用callback方式返回結果，此方法為異步方法。

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

參數：

示例：

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

首先獲取指定文件對應的Storage實例，然后借助Storage API將數據寫入Storage實例，通過flush或者flushSync將Storage實例持久化。使用Promise方式返回結果，此方法為異步方法。

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

參數：

返回值：

示例：

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

檢查存儲對象是否包含名為給定key的存儲。

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

參數：

返回值：

示例：

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

has

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

檢查存儲對象是否包含名為給定key的存儲。使用callback方式返回結果，此方法為異步方法。

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

參數：

返回值：

示例：

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

檢查存儲對象是否包含名為給定key的存儲。使用Promise方式返回結果，此方法為異步方法。

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

參數：

返回值：

示例：

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

從存儲對象中刪除名為給定key的存儲。

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

參數：

示例：

storage.deleteSync('startup')

delete

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

從存儲對象中刪除名為給定key的存儲。使用callback方式返回結果，此方法為異步方法。

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

參數：

示例：

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

從存儲對象刪除名為給定key的存儲。使用Promise方式返回結果，此方法為異步方法。

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

參數：

返回值：

示例：

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

將當前storage對象中的修改保存到當前的storage，并同步存儲到文件中。

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

示例：

storage.flushSync()

flush

flush(callback: AsyncCallback): void

將當前storage對象中的修改保存到當前的storage，并異步存儲到文件中。使用callback方式返回結果，此方法為異步方法。

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

參數：

示例：

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

將當前storage對象中的修改保存到當前的storage，并異步存儲到文件中。使用Promise方式返回結果，此方法為異步方法。

系統能力： 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

清除此存儲對象中的所有存儲。

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

示例：

storage.clearSync()

clear

clear(callback: AsyncCallback): void

清除此存儲對象中的所有存儲。使用callback方式返回結果，此方法為異步方法。

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

參數：

示例：

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

清除此存儲對象中的所有存儲。使用Promise方式返回結果，此方法為異步方法。

系統能力： 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

訂閱數據變更者類需要實現StorageObserver接口，訂閱的key的值發生變更后，在執行flush/flushSync方法后，callback方法會被回調。

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

參數：

示例：

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

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

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

參數：

示例：

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

StorageObserver

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

ValueType

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

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

審核編輯 黃宇