复活吧!我的爱人!——HarmonyOS数据持久化

        前言

        隐墨的手机震动了,她猛然从卧榻处翻起,手有些颤抖,我爱人的消息来了,他来了,他来了,他来了,呼吸声变的颤抖,面红耳赤,他会不会出去雨中散步啊,可我还没收拾,我要穿昨天母亲买的漂亮裙子,手机屏幕亮起,窗外雨声依旧,红色的罂粟遍地生长,荆棘困住天使,蝴蝶依旧,风声依旧,拼多多也是如此。

        他猛然清醒,我的爱人已经离我而去啊,时间过的好快啊,突然他目光光速扫视一周,无人,再书架上拿出《HarmonyOS》大喊:复活吧!我的爱人!

        沉沦着终将沉沦!


        一:数据持久化的形式

        应用数据持久化,是指应用将内存中的数据通过文件或数据库的形式保存到设备上。内存中的数据形态通常是任意的数据结构或数据对象,存储介质上的数据形态可能是文本、数据库、二进制文件等。

        可以根据如下功能介绍,选择合适的数据形态以满足自己应用数据的持久化需要。

  • 用户首选项(Preferences):通常用于保存应用的配置信息。数据通过文本的形式保存在设备中,应用使用过程中会将文本中的数据全量加载到内存中,所以访问速度快、效率高,但不适合需要存储大量数据的场景。

  • 键值型数据库(KV-Store):一种非关系型数据库,其数据以“键值”对的形式进行组织、索引和存储,其中“键”作为唯一标识符。适合很少数据关系和业务关系的业务数据存储,同时因其在分布式场景中降低了解决数据库版本兼容问题的复杂度,和数据同步过程中冲突解决的复杂度而被广泛使用。相比于关系型数据库,更容易做到跨设备跨版本兼容。

  • 关系型数据库(RelationalStore):一种关系型数据库,以行和列的形式存储数据,广泛用于应用中的关系型数据的处理,包括一系列的增、删、改、查等接口,开发者也可以运行自己定义的SQL语句来满足复杂业务场景的需要。


        二:  用户首选项

        2.1 运作机制

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

        应用首选项的持久化文件保存在应用沙箱内部,可以通过context获取其路径

        相关的约束:

        ① Key键为string类型,要求非空且长度不超过80个字节。

        ② Value可以是string、number、boolean及以上类型数组,大小不超过8192字节

        ③ 数据量建议不超过一万条

               2.2 接口说明

// 获取Preferences实例。该接口存在异步接口。
getPreferencesSync(context: Context, options: Options): Preferences

// 将数据写入Preferences实例,可通过flush将Preferences实例持久化。该接口存在异步接口。
putSync(key: string, value: ValueType): void

// 检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。
hasSync(key: string): void

// 获取键对应的值,如果值为null或者非默认值类型,返回默认数据defValue。该接口存在异步接口。
getSync(key: string, defValue: ValueType): void

// 从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。
deleteSync(key: string): void

// 将当前Preferences实例的数据异步存储到用户首选项持久化文件中。
flush(callback: AsyncCallback<void>): void

// 订阅数据变更,订阅的数据发生变更后,在执行flush方法后,触发callback回调。
on(type: 'change', callback: Callback<string>): void

// 取消订阅数据变更。
off(type: 'change', callback?: Callback<string>): void

// 从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件,则同时删除其持久化文件。
deletePreferences(context: Context, options: Options, callback: AsyncCallback<void>): void

         能明显的感受到运用的特点:就是对于数据的增删改查

         进行简单的举例说明(这更是一种工具类,可以放到工具包下)

//用户首选项

import preferences from '@ohos.data.preferences';
import { JSON } from '@kit.ArkTS';

class PreferencesUtil {
  //避免有多个Preference实例引起的覆盖问题,string设置键值
  preferenceMap: Map<string, preferences.Preferences> = new Map()

  // 加载preferences
  async loadPreferences(context, name: string) {
    try {
      //去加载该名下的preference对象
      let preference = await preferences.getPreferences(context, name)

      //你可以在后续的代码中通过键 name 来访问对应的偏好设置对象
      this.preferenceMap.set(name, preference)
      console.log('testTag', `加载Preferences[${name}]成功`)
    } catch (e) {
      //加载失败打印相应的失败信息
      console.log('testTag', `加载Preferences[${name}]失败`, JSON.stringify(e))
    }
  }

  //添加preference
  async putPreferenceValue(name: string, key: string, value: preferences.ValueType) {

    //判断里面是否存有数据
    if (!this.preferenceMap.has(name)) {
      console.log('testTag', `Preferences[${name}]尚未初始化!`)
      return
    }

    try {
      //得到相应的preference
      let preference=this.preferenceMap.get(name)
      //写入数据
      await preference?.put(key,value)
      //刷盘,存储到用户首选项的持久化文件中
      await preference?.flush()
      console.log('testTag', `保存Preferences[${name}.${key} = ${value}]成功`)
    } catch (e) {
      console.log('testTag', `保存Preferences[${name}.${key} = ${value}]失败`, JSON.stringify(e))
    }
  }

  async getPreferenceValue(name: string, key: string, defaultValue: preferences.ValueType){
    if (!this.preferenceMap.has(name)) {
      console.log('testTag', `Preferences[${name}]尚未初始化!`)
      return
    }
    try {
      let pref = this.preferenceMap.get(name)
      // 读数据
      let value = await pref.get(key, defaultValue)
      console.log('testTag', `读取Preferences[${name}.${key} = ${value}]成功`)
      return value
    } catch (e) {
      console.log('testTag', `读取Preferences[${name}.${key} ]失败`, JSON.stringify(e))
    }

  }
}

const preferenceUtil= new PreferencesUtil()
export default preferenceUtil as PreferencesUtil
  • 写入数据:使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后,如有需要,可使用flush()方法将Preferences实例的数据存储到持久化文件。当对应的键已经存在时,putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。

  • 读取数据:使用getSync()方法获取数据,即指定键对应的值。如果值为null或者非默认值类型,则返回默认数据。

  • 删除数据:使用deleteSync()方法删除指定键值对

  • 删除指定文件:使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例,包括内存中的数据。若该Preference存在对应的持久化文件,则同时删除该持久化文件,包括指定文件及其备份文件、损坏文件。

        2.3 示例讲解

        隐墨进入了她的思念笔记的列表,点击右上角的他所戴的手表,底部会弹出字体修改面板,字体有4个不同的大小,当点击滑动条可以修改思念程度,目前更改了滑动条的字体大小数据是保存在内存的,关闭页面后再进来数据显示默认大小,现在是隐墨想通过首选项实现数据持久化,持久化保存设置的字体大小。

interface FontSizeLabel {
  '10': string;
  '20': string;
  '30': string;
  '40': string;
}

@Entry
@Component
struct Preference_test {
  @State message: string = '页面列表'
  @State showPanel: boolean = false
  @Provide fontSize: number = 16

  async aboutToAppear() {
    this.fontSize=await PreferencesUtil.getPreferenceValue('MyPreferences','IndexFotSize',16) as number
  }

  build() {
    Column() {
      // 顶部标题
      this.Title()
      // 导航列表
      this.RouterList()
      // 字体修改面板
      if (this.showPanel) {
        IndexFontSizePanel()
          .transition({
            translate: { y: 115 }
          })
      }
    }
    .width('100%')
    .height('100%')
  }

  @Builder
  Title() {
    Row() {
      Text(this.message)
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
        .height(80)
      Image($r('app.media.watchGT4'))
        .width(30)
        .onClick(() => {
          animateTo({ duration: 1000, curve: Curve.EaseOut }, () => this.showPanel = !this.showPanel)
        })
    }
    .justifyContent(FlexAlign.SpaceAround)
    .width('100%')
  }

  @Builder
  RouterList() {
    List({ space: 15 }) {
      ForEach(['我想他', '我很想他', '我非常想他', '我超级想他', '想要他回来'], (item: string, index: number) => {
        ListItem() {
          Row() {
            Text((index + 1) + '.')
              .fontSize(this.fontSize)
              .fontColor(Color.White)
            Blank()
            Text(item)
              .fontSize(this.fontSize)
              .fontColor(Color.White)
          }
          .width('90%')
          .padding(12)
          .backgroundColor('#38f')
          .borderRadius(20)
          .shadow({
            radius: 6,
            color: '#4F000000',
            offsetX: 2,
            offsetY: 4
          })
        }
      })

    }
    .layoutWeight(1)
    .alignListItem(ListItemAlign.Center)
    .width('100%')
    .height('100%')
  }
}


@Component
struct IndexFontSizePanel {
  @Consume fontSize: number
  fontSizeLabel: FontSizeLabel = {
    '10': 'min',
    '20': 'mid',
    '30': 'max',
    '40': 'superbMax',
  }

  build() {
    Column() {
      Text('字体大小').fontSize(20)
      Row({ space: 5 }) {
        Text('A').fontSize(14).fontWeight(FontWeight.Bold)
        Slider({
          min: 10,
          max: 40,
          step: 10,
          value: this.fontSize
        })
          .showSteps(true)
          .trackThickness(6)
          .layoutWeight(1)
          .onChange(val => {
            // 修改字体大小
            this.fontSize = val
            PreferencesUtil.putPreferenceValue('MyPreferences','IndexFotSize',val)
          })
        Text('A').fontSize(20).fontWeight(FontWeight.Bold)
      }.width('100%')
    }
    .width('100%')
    .padding(15)
    .backgroundColor('#fff1f0f0')
    .borderRadius(20)
  }
}

        将上面那串代码运行后,隐墨惊讶的发现,她竟然忘不了他了,他和她永远在一起了(效果需要在模拟器上运行,当你修改字体后,退出应用,重新的进入,你会发现上次设置的字体大小会进行保留)


        三:  键值型数据库

        3.1 运作机制

        键值型数据库存储键值对形式的数据,当需要存储的数据没有复杂的关系模型,比如存储商品名称及对应价格、员工工号及今日是否已出勤等,由于数据复杂度低,更容易兼容不同数据库版本和设备类型,因此推荐使用键值型数据库持久化此类数据。

        约束限制:

  • 设备协同数据库,针对每条记录,Key的长度≤896 Byte,Value的长度<4 MB

  • 单版本数据库,针对每条记录,Key的长度≤1 KB,Value的长度<4 MB。

  • 每个应用程序最多支持同时打开16个键值型分布式数据库

  • 键值型数据库事件回调方法中不允许进行阻塞操作,例如修改UI组件。

        3.2 接口说明

// 创建一个KVManager对象实例,用于管理数据库对象
createKVManager(config: KVManagerConfig): KVManager

// 指定Options和storeId,创建并得到指定类型的KVStore数据库
getKVStore<T>(storeId: string, options: Options, callback: AsyncCallback<T>): void

// 添加指定类型的键值对到数据库
put(key: string, value: Uint8Array|string|number|boolean, callback: AsyncCallback<void>): void

// 获取指定键的值
get(key: string, callback: AsyncCallback<Uint8Array|string|boolean|number>): void

// 从数据库中删除指定键值的数据
delete(key: string, callback: AsyncCallback<void>): void

        后续进行分布式键值数据库学习进行具体的说明


        四:关系型数据库

        4.1 运作机制

        关系型数据库基于SQLite组件,适用于存储包含复杂关系数据的场景,比如一个班级的学生信息,需要包括姓名、学号、各科成绩等,又或者公司的雇员信息,需要包括姓名、工号、职位等,由于数据之间有较强的对应关系,复杂程度比键值型数据更高,此时需要使用关系型数据库来持久化保存数据。

         4.2 接口说明

        关系型数据库持久化功能的相关接口,大部分为异步接口。异步接口均有callback和Promise两种返回形式。

// 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作
getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback<RdbStore>): void     

// 执行包含指定参数但不返回值的SQL语句
executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<void>):void 

// 向目标表中插入一行数据
insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void       

// 根据RdbPredicates的指定实例对象更新数据库中的数据
update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback<number>):void                                                |

// 根据RdbPredicates的指定实例对象从数据库中删除数据
delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void                 

// 根据指定条件查询数据库中的数据
query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>):void 

// 删除数据库
deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void   

        自己所构建的关系型数据库如下

import { relationalStore } from '@kit.ArkData'
import CommonConstants from '../constants/CommonConstants'
import Logger from '../utils/Logger'
import { data } from '@kit.TelephonyKit'


export default class Rdb {
  //创建表
  private rdbStore?: relationalStore.RdbStore
  private tableName?: string
  private sqlCreatTable?: string
  private columns?: Array<string>

  constructor(tableName: string, sqlCreatTable: string, columns: Array<string>) {
    this.tableName = tableName
    this.sqlCreatTable = sqlCreatTable
    this.columns = columns
  }

  //获取一个RdbStore来操作关系型数据库
  //可选的回调函数参数,用于在 RDBStore 实例获取或初始化完成后执行。
  //默认情况下,如果未提供回调函数,将使用一个空的函数,以确保代码的健壮性和默认行为的一致性。
  getRdbStore(callback: Function = () => {
  }) {
    //typeof 是一个运算符,用于返回变量的数据类型作为字符串,确保了 callback 的存在
    if (!callback || typeof callback === 'undefined' || callback === undefined) {
      //也可以直接的日志输出
      Logger.info(CommonConstants.RDB_TAG, 'getRdbStore() has no callback!')
      return;
    }

    //确保了 rdbStore 的可用性
    if (this.rdbStore !== null) {
      Logger.info(CommonConstants.RDB_TAG, 'The rdbStore exists.')
      callback();
      return;
    }

    //getContext(this)函数可能是用来获取当前上下文对象的
    let context: Context = getContext(this) as Context

    relationalStore.getRdbStore(context, CommonConstants.STORE_CONFIG, (err, rdb) => {
      if (err) {
        Logger.error(CommonConstants.RDB_TAG, `gerRdbStore() failed, err: ${err}`);
        return;
      }
       获取到RdbStore后,需使用executeSql接口初始化数据库表结构和相关数据
      this.rdbStore = rdb
      this.rdbStore.executeSql(this.sqlCreatTable)
      Logger.info(CommonConstants.RDB_TAG, 'getRdbStore() finished.');
      callback()
    })
  }

  //数据的插入
  insertData(data: relationalStore.ValuesBucket, callback: Function = () => {
  }) {
    if (!callback || typeof callback === 'undefined' || callback === undefined) {
      Logger.info(CommonConstants.RDB_TAG, 'insertData() has no callback!');
      return;
    }
    let resFlag: boolean = false;
     存储键值对的类型,表示要插入到表中的数据行
    const valueBucket: relationalStore.ValuesBucket = data;
    if (this.rdbStore) {
      this.rdbStore.insert(this.tableName, valueBucket, (err, ret) => { // 存储键值对的类型,表示要插入到表中的
        if (err) {
          Logger.error(CommonConstants.RDB_TAG, `insertData() failed, err: ${err}`);
          callback(resFlag);
          return;
        }
        Logger.info(CommonConstants.RDB_TAG, `insertData() finished: ${ret}`);
        callback(ret);
      });
    }
  }


  deleteData(predicates: relationalStore.RdbPredicates, callback: Function = () => {
  }) {
    if (!callback || typeof callback === 'undefined' || callback === undefined) {
      Logger.info(CommonConstants.RDB_TAG, 'deleteData() has no callback!');
      return;
    }
    let resFlag: boolean = false
    if (this.rdbStore) {
      this.rdbStore.delete(predicates, (err, ret) => {
        if (err) {
          Logger.error(CommonConstants.RDB_TAG, `deleteData() failed, err: ${err}`)
          callback(resFlag)
          return
        }
        Logger.info(CommonConstants.RDB_TAG, `deleteData() finished: ${ret}`)
        callback(!resFlag)
      })
    }
  }

  updateData(predicates: relationalStore.RdbPredicates, data: relationalStore.ValuesBucket, callback: Function = () => {
  }) {
    if (!callback || typeof callback === 'undefined' || callback === undefined) {
      Logger.info(CommonConstants.RDB_TAG, 'deleteData() has no callback!');
      return;
    }
    let resFlag: boolean = false
    const valueBucket: relationalStore.ValuesBucket = data
    if (this.rdbStore) {
      this.rdbStore.update(valueBucket, predicates, (err, ret) => {
        if (err) {
          Logger.error(CommonConstants.RDB_TAG, `updateData() failed, err: ${err}`);
          callback(resFlag);
          return;
        }
        Logger.info(CommonConstants.RDB_TAG, `updateData() finished: ${ret}`);
        callback(!resFlag);
      })
    }
  }


  query(predicates: relationalStore.RdbPredicates, callback: Function = () => {
  }) {
    if (!callback || typeof callback === 'undefined' || callback === undefined) {
      Logger.info(CommonConstants.RDB_TAG, 'query() has no callback!');
      return;
    }
    if(this.rdbStore) {   columns表示要查询的列,如果为空则表示查询所有列
      this.rdbStore.query(predicates,this.columns,(err,ret)=>{
        if (err) {
          Logger.error(CommonConstants.RDB_TAG, `query() failed, err:  ${err}`);
          return;
        }
        Logger.info(CommonConstants.RDB_TAG, 'query() finished.');
        callback(ret);  // // 如果查找成功则返回resultSet结果集
        ret.close();    // 操作完成后关闭结果集
      })
    }
  }
}

         相应的流程: 

  • 要使用关系型数据库存储用户数据,首先要进行数据库的创建,并提供基本的增删改查接口

  • 首先要获取一个RdbStore来操作关系型数据库。

  • 为了对数据进行增、删、改、查操作,我们要封装对应接口。关系型数据库接口提供的增、删、改、查方法均有callback和Promise两种异步回调方式。


        结语

        隐墨终于累了,她发现想法终究是幻想,实践是检验理论的唯一标准,下期隐墨终于好和他的心上人表白了,期待一下吧嘿嘿嘿!

  • 28
    点赞
  • 23
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值