第98节 使用首选项存储数据

在 HarmonyOS 中， ArkTS 语言提供了一种便捷的方式来管理应用的偏好设置（ preferences ），这些设置通常用于存储应用的配置信息、用户偏好等轻量级数据。 preferences.getPreferencesSync 是一个同步方法，用于从偏好设置中检索数据。下面，我将通过一个详细的示例来展示如何在ArkTS 中使用preferences.getPreferencesSync 方法。

示例背景

假设我们正在开发一个天气应用，该应用需要在用户的偏好设置中存储用户选择的城市名称，以便在下次启动时能够自动显示该城市的天气信息。

步骤 1：配置权限

首先，确保你的应用已经配置了访问偏好设置的权限。在 ArkTS 项目中，这通常是通过在 config.json文件中添加相应的权限声明来实现的。不过，需要注意的是，HarmonyOS 的权限管理可能因版本和具体设备而异，因此请查阅最新的HarmonyOS 开发文档以获取准确的权限配置信息。

步骤 2：使用 preferences.getPreferencesSync

接下来，我们将编写 ArkTS 代码来读取用户选择的城市名称。

import preferences from '@ohos.preferences' ;

@ Entry

@ Component

struct WeatherCard {

@ State private cityName : string = "" ;

@ OnInit

async init () {

try {

// 获取偏好设置的实例

const prefs = await preferences . getPreferencesSync ( 'com.example.weather' ,

{

create : true , // 如果偏好设置文件不存在，则创建它

});

// 从偏好设置中读取城市名称

const cityPref = prefs . getStringSync ( 'selectedCity' , '' );

// 更新组件状态

this . cityName = cityPref ;

console . log ( 'Selected city from preferences:' , this . cityName );

} catch ( error ) {

console . error ( 'Error reading preferences:' , error );

}

}

build () {

Column () {

Text ( `Current city: ${ this . cityName }` )

. fontSize ( 24 )

. textAlign ( TextAlign . Center );

// ... 其他 UI 组件，如按钮、输入框等，用于选择和设置城市

}. padding ( 20 );

}

}

解释

1. 导入模块：首先，我们从 @ohos.preferences 模块中导入 preferences 对象。
2. 组件定义：然后，我们定义了一个名为 WeatherCard 的组件，它使用ArkTS的装饰器语法来指定组件的入口点（ @Entry ）和组件类型（ @Component ）。
3. 状态管理：我们使用 @State 装饰器来定义一个名为 cityName 的状态变量，用于存储从偏好设置中读取的城市名称。
4. 初始化逻辑：在 @OnInit 生命周期钩子中，我们编写异步代码来初始化组件。首先，我们获取偏好设置的实例，指定偏好设置的文件名（如 'com.example.weather' ）和创建选项（如果文件不存在，则创建它）。然后，我们使用 getStringSync 方法从偏好设置中读取名为 'selectedCity' 的字符串值，如果未找到该值，则返回一个空字符串。最后，我们更新cityName 状态变量，并在控制台中打印读取到的城市名称。
5. UI构建：在 build 方法中，我们构建了一个简单的UI，包含一个显示当前城市的 Text 组件。你可以根据需要添加其他UI组件，如按钮和输入框，以允许用户选择和设置城市。

注意事项

• 偏好设置文件是与应用包名相关联的，因此请确保在调用 getPreferencesSync 时使用正确的文件名。
• getStringSync 方法会抛出异常，如果指定的键不存在或发生其他错误，因此建议使用 trycatch 语句来处理潜在的异常。
• 在实际应用中，你可能还需要实现将用户选择的城市名称保存到偏好设置的逻辑，这可以通过调用 putStringSync 方法来实现。

通过上述步骤，你可以在 HarmonyOS 的 ArkTS 项目中成功使用 preferences.getPreferencesSync 方法来读取和管理应用的偏好设置。