鸿蒙中 资源分类与访问

本文同步发表于微信公众号，微信搜索程语新视界即可关注，每个工作日都有文章更新

一、资源定义

• 应用开发中使用的字符串、颜色、字体、间距、图标等内容

• 不同设备或配置下，资源值可能不同

资源分类

系统资源获取渠道

二、资源目录结构

完整目录结构

resources/ ├── base/ # 默认存在的基础目录 │ ├── element/ # 元素资源（字符串、颜色等） │ │ └── string.json # 字符串资源文件 │ ├── media/ # 媒体资源 │ │ └── icon.png # 图片、视频等媒体文件 │ └── profile/ # 自定义配置文件 │ └── test_profile.json # 自定义profile文件 ├── en_GB-vertical-car-mdpi/ # 自定义限定词目录示例 │ ├── element/ │ │ └── string.json │ ├── media/ │ │ └── icon.png │ └── profile/ │ └── test_profile.json ├── rawfile/ # 原始文件目录（不编译） └── resfile/ # 原始文件目录（安装后解压）

1.资源目录说明

2.资源组目录说明

3.媒体资源格式

三、限定词目录

1.命名规则

• 组合顺序：移动国家码_移动网络码-语言_文字_国家或地区-横竖屏-设备类型-颜色模式-屏幕密度

• 连接方式：

  • 移动国家码和移动网络码：下划线_

  • 语言、文字、国家或地区：下划线_

  • 其他限定词：中划线-

• 示例：mcc460_mnc00-zh_Hant_CN、zh_CN-car-ldpi

2.限定词取值范围

四、资源文件示例

1.color.json

{ "color": [ { "name": "color_hello", "value": "#ffff0000" // 前两位透明度，后六位颜色值 }, { "name": "color_world", "value": "#ff0000ff" } ] }

2.float.json

{ "float": [ { "name": "font_hello", "value": "28.0fp" // 浮点型，单位fp }, { "name": "font_world", "value": "20.0fp" } ] }

3.string.json

{ "string": [ { "name": "string_hello", "value": "Hello" }, { "name": "string_world", "value": "World" }, { "name": "message_arrive", "value": "We will arrive at %1$s." // 占位符 }, { "name": "message_notification", "value": "Hello, %1$s!,You have %2$d new messages." } ] }

4.plural.json

{ "plural": [ { "name": "eat_apple", "value": [ { "quantity": "one", "value": "%d apple" // 单数 }, { "quantity": "other", "value": "%d apples" // 复数 } ] } ] }

五、资源可翻译特性

1.功能介绍

• 标记字符串是否需要翻译和翻译状态

• 仅适用于：base目录下的string、strarray、plural类型资源

• 默认：未配置attr属性时，需要翻译

2.attr支持属性

3.示例

{ "string": [ { "name": "string1", "value": "1", "attr": { "translatable": false // 不需要翻译 } }, { "name": "string2", "value": "Hello world!", "attr": { "translatable": true, "priority": "LT" // 翻译已验证 } } ] }

六、资源访问方式

1.单HAP包应用资源访问

(1) 编译型资源（base/限定词目录）

// 基础访问 $r('app.type.name') // app: resources目录定义，type: 资源类型，name: 资源名 // 实际使用 Text($r('app.string.string_hello')) .fontColor($r('app.color.color_emphasize')) .fontSize($r('app.float.text_size_headline1')) // 带占位符的字符串 Text($r('app.string.message_notification', 'LiHua', 2)) // 复数资源 Text($r('app.plural.eat_apple', 2, 2)) // 第一个参数控制单复数，第二个参数替代占位符

(2) 原始文件资源（rawfile目录）

// 访问方式 $rawfile('filename') // filename: 相对路径，包含后缀，不以"/"开头 // 示例：假设rawfile目录下有icon.png Image($rawfile('icon.png'))

(3) 编程式访问

// 获取ResourceManager const resMgr = getContext().resourceManager; // 获取字符串 resMgr.getStringByNameSync('test_string'); // 获取rawfile文件描述符 resMgr.getRawFd('rawfilepath'); // 返回{fd, offset, length}

2.跨HAP/HSP包应用资源访问

(1) bundle相同，跨module访问

// 1. 添加依赖（entry的oh-package.json5） "dependencies": { "library": "file:../library" } // 2. 访问资源 @Entry @Component struct Second { // 字面量方式 text: string = '[library].string.test_string'; // 变量方式 textVar: string = '[library].string.test_string'; build() { Column() { // 字面量访问 Text($r('[library].string.test_string')) // 变量访问 Text($r(this.text)) // rawfile访问（多层目录） Image($rawfile('[library].firstDir/secondDir/icon.png')) } } }

(2) 通过createModuleContext访问

// 创建其他module的上下文 const context = createModuleContext(this.context, 'moduleName'); const resMgr = context.resourceManager; resMgr.getStringByNameSync('resource_name');

3.系统资源访问

// 访问方式 $r('sys.type.name') // sys: 系统资源，type: 资源类型，name: 资源名称 // 实际使用 Text('Hello') .fontColor($r('sys.color.ohos_id_color_emphasize')) .fontSize($r('sys.float.ohos_id_text_size_headline1')) .fontFamily($r('sys.string.ohos_id_text_font_family_medium')) // Symbol图标资源 SymbolGlyph($r('sys.symbol.xxxx'))

七、资源匹配规则

1.匹配优先级

resources/ ├── 限定词目录（匹配设备状态）← 优先 └── base目录（默认）← 次优

2.限定词目录匹配顺序

优先级从高到低：

1. 移动国家码和移动网络码

2. 区域（语言、文字、国家或地区）

3. 横竖屏

4. 设备类型

5. 颜色模式

6. 屏幕密度

3.匹配规则细节

• 完全匹配：移动国家码、网络码、语言、文字、横竖屏、设备类型、颜色模式必须与设备状态完全一致

• 屏幕密度匹配：优先向上匹配最接近的，否则向下匹配最接近的

• rawfile/resfile：不参与设备状态匹配

4.AppScope合并规则

• stage模型多工程下，共有资源放到AppScope的resources目录

• 编译时AppScope资源合入模块资源

• 重名资源：只保留AppScope目录下的资源

八、获取指定配置的资源

1.接口说明

2.使用示例

// 获取非当前系统语言的资源 getString(): string { const resMgr = this.getUIContext().getHostContext()?.resourceManager; // 获取当前系统语言的资源 const resId = $r('app.string.greetings').id; const currentLanguageString = resMgr.getStringSync(resId); // 获取英文资源 let overrideConfig = resMgr.getOverrideConfiguration(); overrideConfig.locale = 'en_US'; // 指定语言为英语 let overrideResMgr = resMgr.getOverrideResourceManager(overrideConfig); this.englishString = overrideResMgr.getStringSync(resId); // 获取日文资源 overrideConfig.locale = 'ja_JP'; overrideResMgr.updateOverrideConfiguration(overrideConfig); this.japaneseString = overrideResMgr.getStringSync(resId); return currentLanguageString; }

九、Overlay机制

1.机制说明

• 资源替换机制，实现界面风格变换

• 不重新打包HAP，通过配置overlay资源包实现

• overlay资源包包含：资源文件、资源索引文件、配置文件

2.动态Overlay

// 添加overlay资源 const path = getContext().bundleCodeDir + "overlay资源包名称"; resourceManager.addResource(path); // 删除overlay resourceManager.removeResource(path);

3.静态Overlay配置

app.json5配置：

{ "app": { "bundleName": "com.example.myapplication.overlay", "vendor": "example", "versionCode": "1000000", "versionName": "1.0.0.1", "icon": "$media:app_icon", "label": "$string:app_name" } }

module.json5配置：

{ "module": { "name": "entry_overlay_module_name", "type": "shared", "description": "$string:entry_overlay_desc", "deviceTypes": ["default", "tablet"], "deliverywithInstall": true, "targetModuleName": "entry_module_name", // 指定目标module "targetPriority": 1 // overlay优先级 } }