Next版本——鸿蒙数据长期化之首选项

熊熊出没  论坛元老 | 2025-3-30 09:03:53 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 1763|帖子 1763|积分 5289

场景介绍

用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用长期化轻量级数据，并对其修改和查询。当用户希望有一个全局唯一存储的地方，可以采用用户首选项来举行存储。Preferences会将该数据缓存在内存中，当用户读取的时候，能够快速从内存中获取数据，当必要长期化时可以使用flush接口将内存中的数据写入长期化文件中。Preferences会随着存放的数据量越多而导致应用占用的内存越大，因此，Preferences不适合存放过多的数据，也不支持通过配置加密，适用的场景一样平常为应用保存用户的个性化设置（字体大小，是否开启夜间模式）等。
运作机制

如图所示，用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项长期化文件的内容加载到Preferences实例，每个文件唯一对应到一个Preferences实例，系统会通过静态容器将该实例存储在内存中，直到自动从内存中移除该实例大概删除该文件。
应用首选项的长期化文件保存在应用沙箱内部，可以通过context获取其路径。具体可见获取应用文件路径。
图1 用户首选项运作机制


束缚限定



  • 首选项无法保证进程并发安全，会有文件损坏和数据丢失的风险，不支持在多进程场景下使用。
  • Key键为string类型，要求非空且长度不超过1024个字节。
  • 如果Value值为string类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过16 * 1024 * 1024个字节。
  • 内存会随着存储数据量的增大而增大，以是存储的数据量应该是轻量级的，发起存储的数据不超过一万条，否则会在内存方面产生较大的开销。
接口说明

以下是用户首选项长期化功能的相干接口，更多接口及使用方式请见用户首选项。
接口名称描述getPreferencesSync(context: Context, options: Options): Preferences获取Preferences实例。该接口存在异步接口。putSync(key: string, value: ValueType): void将数据写入Preferences实例，可通过flush将Preferences实例长期化。该接口存在异步接口。hasSync(key: string): boolean检查Preferences实例是否包罗名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。getSync(key: string, defValue: ValueType): ValueType获取键对应的值，如果值为null大概非默认值类型，返回默认数据defValue。该接口存在异步接口。deleteSync(key: string): void从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。flush(callback: AsyncCallback<void>): void将当前Preferences实例的数据异步存储到用户首选项长期化文件中。on(type: 'change', callback: Callback<string>): void订阅数据变动，订阅的数据发生变动后，在执行flush方法后，触发callback回调。off(type: 'change', callback?: Callback<string>): void取消订阅数据变动。deletePreferences(context: Context, options: Options, callback: AsyncCallback<void>): void从内存中移除指定的Preferences实例。若Preferences实例有对应的长期化文件，则同时删除其长期化文件。 开发步调

新增/修改数据



  1. ​
复制代码
  1. import { preferences } from '@kit.ArkData'
  2. ​
  3. @Entry
  4. @Component
  5. struct Index {
  6.   build() {
  7.    Row() {
  8.      Column() {
  9.        // 1.0 利用首选项api对store这个文件做一个新增数据：["鸿蒙","HTML5"]
  10.        Button('新增/修改数据').onClick(() => {
  11.          //   1.0 获取store文件的操作对象
  12.          const pre = preferences.getPreferencesSync(getContext(), { name: 'store' })
  13. ​
  14.          //   2.0 调用操作对象上的putSync方法完成数据的新增 (这是将数据保存到内存中)
  15.          pre.putSync('keyword', ["鸿蒙Next", "huawei"])
  16.          pre.putSync('keyword2', ["HTML5", "JavaScript"])
  17. ​
  18.          pre.flush() //将内存数据写入到磁盘
  19. ​
  20.          AlertDialog.show({ message: '首选项数据写入成功' })
  21.        })
  22.      }
  23.      .width('100%')
  24.    }
  25. ​
  26.   }
  27. }
复制代码


结果查询：

修改数据就还是用key值把之前数据修改成必要的就行
查询数据



代码：

  1. Button('获取数据').onClick(() => {
  2.  const pre = preferences.getPreferencesSync(getContext(), { name: 'store' })
  3.  AlertDialog.show({ message: JSON.stringify(pre.getAllSync()) })
  4. })
复制代码

删除数据



  1. Button('删除数据').onClick(() => {
  2.          const pre = preferences.getPreferencesSync(getContext(), { name: 'store' })
  3.          pre.deleteSync('keyword')
  4.          pre.flush()
  5.          AlertDialog.show({ message: '首选项数据删除成功' })
  6.        })
复制代码


实例

通过一个搜刮框实例举行系统组合起来
静态结构
  1. @Entry
  2. @Component
  3. struct SearchPage {
  4.   @State keyword: string = ''
  5.   @State isdel: boolean = false
  6.   aboutToAppear(): void {
  7. ​
  8.   }
  9. ​
  10.   @Builder
  11.   itemBuilder(text: string) {
  12.    Row({ space: 20 }) {
  13.      Text(text)
  14.      if (this.isdel) {
  15.        Text('x')
  16.          .height(30)
  17.          .onClick(() => {
  18.            AlertDialog.show({ message: '删除' + text })
  19.          })
  20.      }
  21.    }
  22.    .margin({ right: 10, top: 10 })
  23.    .padding({
  24.      left: 15,
  25.      right: 15,
  26.      top: 5,
  27.      bottom: 5
  28.    })
  29.    .backgroundColor('rgba(0,0,0,0.05)')
  30.    .borderRadius(20)
  31.   }
  32. ​
  33.   build() {
  34.    Navigation() {
  35.      Column({ space: 15 }) {
  36.        // 1. 搜索关键字
  37.        TextInput({ placeholder: '输入回车保存数据', text: $$this.keyword })
  38.          .onSubmit(() => {
  39.            AlertDialog.show({ message: this.keyword })
  40.          })
  41. ​
  42.        // 2. 关键字列表
  43.        Row() {
  44.          Text('搜索记录').fontSize(20).fontWeight(800)
  45. ​
  46.          Row() {
  47.            if (this.isdel) {
  48.              Text('全部删除')
  49.                .onClick(()=>{
  50.                  AlertDialog.show({ message: '补上全部删除逻辑' })
  51.                })
  52.              Text(' | ')
  53.              Text('取消删除')
  54.                .onClick(()=>{
  55.                  this.isdel = false
  56.                })
  57.            } else {
  58.              Text('X')
  59.                .height(28)
  60.                .onClick(()=>{
  61.                  this.isdel = true
  62.                })
  63.            }
  64.          }
  65.        }
  66.        .width('100%')
  67.        .justifyContent(FlexAlign.SpaceBetween)
  68. ​
  69.        //   3. 关键字列表
  70.        Flex({ wrap: FlexWrap.Wrap }) {
  71.          ForEach([1, 2, 3, 4], (item: number) => {
  72.            this.itemBuilder('文本' + item)
  73.          })
  74.        }
  75.      }
  76.      .padding(15)
  77.    }
  78.    .padding({ top: 20 })
  79.    .titleMode(NavigationTitleMode.Mini)
  80.    .title('搜索页面')
  81.   }
  82. }<img alt=""  src="https://i-blog.csdnimg.cn/direct/c701d153f1a74d8dba60902e304c9fce.png"  />
复制代码
实现历史搜刮记录

保存关键字数组

  1. import { preferences } from '@kit.ArkData'
  2. ​
  3. @Entry
  4. @Component
  5. struct SearchPage {
  6.  @State keyword: string = ''
  7.  @State isdel: boolean = false
  8.  @State keywords: string[] = []
  9.  aboutToAppear(): void {
  10.    this.getData()
  11.   }
  12.  // 1.0 新增方法
  13.  async saveData(text: string) {
  14.    // 非空验证
  15.    if(!text){
  16.      return
  17.    }
  18.    // 1.0 获取首选项对象实例
  19.    const pre = preferences.getPreferencesSync(getContext(), { name: 'store1' })
  20.    // 2.0 调用putsync方法保存数组
  21.    // 2.0.1 先从首选项中获取老数据
  22.    let dataArr = pre.getSync('keyword', []) as string[]
  23.    // 判断如果首选项中已经有了该关键词，不再保存
  24.    if(dataArr.includes(text)){
  25.      // 该关键字已经存在了，不保存
  26.      return
  27.    }
  28. ​
  29.    dataArr.push(text)
  30.    // 2.0.2 存数据
  31.    pre.putSync('keyword', dataArr)
  32. ​
  33.    // 3.0 调用flush写入到磁盘
  34.    await pre.flush()
  35.   }
  36.  // 2.0 获取首选项数据
  37.  async getData() {
  38.    const pre = preferences.getPreferencesSync(getContext(), { name: 'store1' })
  39.    this.keywords = pre.getSync('keyword', []) as string[]
  40.   }
  41. ​
  42. ​
  43.  @Builder
  44.  itemBuilder(text: string) {
  45.    Row({ space: 20 }) {
  46.      Text(text)
  47.      if (this.isdel) {
  48.        Text('x')
  49.          .height(30)
  50.          .onClick(() => {
  51.            AlertDialog.show({ message: '删除' + text })
  52.          })
  53.      }
  54.    }
  55.    .margin({ right: 10, top: 10 })
  56.    .padding({
  57.      left: 15,
  58.      right: 15,
  59.      top: 5,
  60.      bottom: 5
  61.    })
  62.    .backgroundColor('rgba(0,0,0,0.05)')
  63.    .borderRadius(20)
  64.   }
  65. ​
  66.  build() {
  67.    Navigation() {
  68.      Column({ space: 15 }) {
  69.        // 1. 搜索关键字
  70.        TextInput({ placeholder: '输入回车保存数据', text: $$this.keyword })
  71.          .onSubmit(async () => {
  72. ​
  73.            AlertDialog.show({ message: this.keyword })
  74.            //   将关键词数据保存到首选项中
  75.            await  this.saveData(this.keyword)
  76.            await this.getData()
  77.          })
  78. ​
  79.        // 2. 关键字列表
  80.        Row() {
  81.          Text('搜索记录').fontSize(20).fontWeight(800)
  82. ​
  83.          Row() {
  84.            if (this.isdel) {
  85.              Text('全部删除')
  86.                .onClick(()=>{
  87.                  AlertDialog.show({ message: '补上全部删除逻辑' })
  88.                })
  89.              Text(' | ')
  90.              Text('取消删除')
  91.                .onClick(()=>{
  92.                  this.isdel = false
  93.                })
  94.            } else {
  95.              Text('X')
  96.                .height(28)
  97.                .onClick(()=>{
  98.                  this.isdel = true
  99.                })
  100.            }
  101.          }
  102.        }
  103.        .width('100%')
  104.        .justifyContent(FlexAlign.SpaceBetween)
  105. ​
  106.        //   3. 关键字列表
  107.        Flex({ wrap: FlexWrap.Wrap }) {
  108.          ForEach(this.keywords, (item: string) => {
  109.            this.itemBuilder(item)
  110.          })
  111.        }
  112.      }
  113.      .padding(15)
  114.    }
  115.    .padding({ top: 20 })
  116.    .titleMode(NavigationTitleMode.Mini)
  117.    .title('搜索页面')
  118.   }
  119. }
复制代码

删除指定关键字/全部关键字

  1.   async delData(text?: string) {
  2.    const pre = preferences.getPreferencesSync(getContext(), { name: 'store1' })
  3.    //   1.0 删除全部关键
  4.    if (!text) {
  5.      pre.deleteSync('keyword')
  6.    } else {
  7.      // 2.0 删除指定关键字  获取 -> 删除内存数组的关键字 -> 写回
  8.      let datas = pre.getSync('keyword', []) as string[]
  9.      let cindex = datas.findIndex(item => item === text)
  10.      // 当关键字索引为-1的时候，表示没有找到
  11.      if (cindex < 0) {
  12.        return
  13.      }
  14.      // 如果有删除
  15.      datas.splice(cindex, 1) // 返回值表示删除的元素
  16.      //   保存回去
  17.      pre.putSync('keyword', datas)
  18.    }
  19.    // 写回磁盘
  20.    pre.flush()
  21.   }
复制代码
  1.          //  删除指定关键字
  2.          await this.delData(text)
  3.          await this.getData()
  4.        })
复制代码
  1.               // 删除全局数据
  2.               await this.delData()
  3.               await this.getData()
  4.             })
复制代码

完整代码
  1. import { preferences } from '@kit.ArkData'
  3. @Entry
  4. @Component
  5. struct SearchPage {
  6.   @State keyword: string = ''
  7.   @State isdel: boolean = false
  8.   @State keywords: string[] = []
  9.   aboutToAppear(): void {
  10.     this.getData()
  11.   }
  12.   // 1.0 新增方法
  13.   async saveData(text: string) {
  14.     // 非空验证
  15.     if(!text){
  16.       return
  17.     }
  18.     // 1.0 获取首选项对象实例
  19.     const pre = preferences.getPreferencesSync(getContext(), { name: 'store1' })
  20.     // 2.0 调用putsync方法保存数组
  21.     // 2.0.1 先从首选项中获取老数据
  22.     let dataArr = pre.getSync('keyword', []) as string[]
  23.     // 判断如果首选项中已经有了该关键词，不再保存
  24.     if(dataArr.includes(text)){
  25.       // 该关键字已经存在了，不保存
  26.       return
  27.     }
  29.     dataArr.push(text)
  30.     // 2.0.2 存数据
  31.     pre.putSync('keyword', dataArr)
  33.     // 3.0 调用flush写入到磁盘
  34.     await pre.flush()
  35.   }
  36.   // 2.0 获取首选项数据
  37.   async getData() {
  38.     const pre = preferences.getPreferencesSync(getContext(), { name: 'store1' })
  39.     this.keywords = pre.getSync('keyword', []) as string[]
  40.   }
  41.   // 3.0 删除指定关键字和全部关键字
  42.   async delData(text?: string) {
  43.     const pre = preferences.getPreferencesSync(getContext(), { name: 'store1' })
  44.     //   1.0 删除全部关键
  45.     if (!text) {
  46.       pre.deleteSync('keyword')
  47.     } else {
  48.       // 2.0 删除指定关键字  获取 -> 删除内存数组的关键字 -> 写回
  49.       let datas = pre.getSync('keyword', []) as string[]
  50.       let cindex = datas.findIndex(item => item === text)
  51.       // 当关键字索引为-1的时候，表示没有找到
  52.       if (cindex < 0) {
  53.         return
  54.       }
  55.       // 如果有删除
  56.       datas.splice(cindex, 1) // 返回值表示删除的元素
  57.       //   保存回去
  58.       pre.putSync('keyword', datas)
  59.     }
  60.     // 写回磁盘
  61.     pre.flush()
  62.   }
  65.   @Builder
  66.   itemBuilder(text: string) {
  67.     Row({ space: 20 }) {
  68.       Text(text)
  69.       if (this.isdel) {
  70.         Text('x')
  71.           .height(30)
  72.           .onClick(async () => {
  73.             //  删除指定关键字
  74.             await this.delData(text)
  75.             await this.getData()
  76.             AlertDialog.show({ message: '删除' + text })
  77.           })
  78.       }
  79.     }
  80.     .margin({ right: 10, top: 10 })
  81.     .padding({
  82.       left: 15,
  83.       right: 15,
  84.       top: 5,
  85.       bottom: 5
  86.     })
  87.     .backgroundColor('rgba(0,0,0,0.05)')
  88.     .borderRadius(20)
  89.   }
  91.   build() {
  92.     Navigation() {
  93.       Column({ space: 15 }) {
  94.         // 1. 搜索关键字
  95.         TextInput({ placeholder: '输入回车保存数据', text: $$this.keyword })
  96.           .onSubmit(async () => {
  98.             AlertDialog.show({ message: this.keyword })
  99.             //   将关键词数据保存到首选项中
  100.             await  this.saveData(this.keyword)
  101.             await this.getData()
  102.           })
  104.         // 2. 关键字列表
  105.         Row() {
  106.           Text('搜索记录').fontSize(20).fontWeight(800)
  108.           Row() {
  109.             if (this.isdel) {
  110.               Text('全部删除')
  111.                 .onClick(async ()=>{
  112.                   // 删除全局数据
  113.                   await this.delData()
  114.                   await this.getData()
  115.                 })
  116.               Text(' | ')
  117.               Text('取消删除')
  118.                 .onClick(()=>{
  119.                   this.isdel = false
  120.                 })
  121.             } else {
  122.               Text('X')
  123.                 .height(28)
  124.                 .onClick(()=>{
  125.                   this.isdel = true
  126.                 })
  127.             }
  128.           }
  129.         }
  130.         .width('100%')
  131.         .justifyContent(FlexAlign.SpaceBetween)
  133.         //   3. 关键字列表
  134.         Flex({ wrap: FlexWrap.Wrap }) {
  135.           ForEach(this.keywords, (item: string) => {
  136.             this.itemBuilder(item)
  137.           })
  138.         }
  139.       }
  140.       .padding(15)
  141.     }
  142.     .padding({ top: 20 })
  143.     .titleMode(NavigationTitleMode.Mini)
  144.     .title('搜索页面')
  145.   }
  146. }
复制代码
总结



  • 该文档介绍了用户首选项数据长期化的概念、束缚和接口，并通过一个搜刮页面的实例展示了怎样使用用户首选项存储、查询、修改和删除数据。
  • 开发者在使用时需注意数据量的控制和进程安全问题，公道利用接口实现数据的长期化操作，确保应用的正常运行和数据的一致性。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

熊熊出没

论坛元老
这个人很懒什么都没写!

楼主热帖

标签云

AI 运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表