1# restool工具
2
3
4## 简介
5
6restool是一种应用工程资源编译工具，通过编译资源文件创建资源索引、解析资源，开发者可以调用[资源管理接口](../reference/apis-localization-kit/js-apis-resource-manager.md)获取到对应资源。restool工具保存在sdk安装目录下的toolchains子目录。
7
8## 参数说明
9
10restool当前支持以下命令选项:
11
12| 选项 | 是否可缺省 | 是否存在入参 | 描述 |
13| -------- | -------- | -------- | -------- |
14| -i | 不可缺省 | 带参数 | 指定需要构建的资源目录或者需要构建的资源中间件。同一个命令可以多次指定。<br>具体可参考如下[编译资源命令](#编译资源)。 |
15| -j | 不可缺省 | 带参数 | 指定config.json或者module.json文件路径。 |
16| -o | 不可缺省 | 带参数 | 指定已编译资源的输出路径。 |
17| -p | 不可缺省 | 带参数 | 指定编译资源的bundle名称。 |
18| -r | 不可缺省 | 带参数 | 指定资源的头文件路径，有三种格式：“.txt”、“.js”、“.h”。 |
19| -e | 可缺省 | 带参数 | 指定生成资源的起始ID值，例如：0x01000000,范围[0x01000000, 0x06FFFFFF),[0x08000000, 0x41FFFFFF) |
20| -f | 可缺省 | 不带参数 | 如果输出路径已经存在。强制删除，重新生成。 |
21| -h | 可缺省 | 不带参数 | 查看工具帮助信息。 |
22| -m | 可缺省 | 带参数 | 多模块联合编译时，指定多个模块名。用“，”连接。 |
23| -x | 可缺省 | 带参数 | 指定生成中间文件的资源目录或单个资源路径。同一个命令可以多次指定。 |
24| -z | 可缺省 | 不带参数 | 针对资源中间文件目录，生成编译结果。 |
25| -v | 可缺省 | 不带参数 | 查看工具版本号。 |
26| --ids | 可缺省 | 带参数 | 指定生成id_defined.json的输出目录。 |
27| --defined-ids | 可缺省 | 带参数 | 指定id_defined.json文件路径，一般都是通过--ids生成。<br>id_defined.json包含资源类型、名称及其ID的列表。<br>开发者可以自定义id_defined.json中的资源ID。 |
28| --icon-check | 可缺省 | 不带参数 | 开启icon和startWindowIcon的PNG图片校验功能。 |
29| --target-config | 可缺省 | 带参数 | 与“-i”命令同时使用，支持选择编译。<br>[参数说明](#target-config参数说明)：指定要包含的配置。|
30
31### target-config参数说明
32
33支持参数配置类型：MccMnc、Locale、Orientation、Device、ColorMode、Density。
34
35参数格式说明：配置之间用“;”分割，配置中的值用“[]”封装，并使用“,”分割。
36
37MccMnc匹配规则：Mcc（国家码）必须相同；Mnc（网络码）不存在时默认匹配，否则Mnc须相同才匹配。
38
39Locale匹配规则：Locale匹配需满足以下三条规则。
40
411、语言须相同。
42
432、脚本（文字）不存在时默认匹配，否则必须相同。
44
453、国家或地区不存在时默认匹配，否则必须相同。
46
47参数举例说明：Locale[zh_CN,en_US];Device[phone]，该参数过滤其他语言，保留能匹配上zh_CN和en_US的语言；过滤其他设备，保留phone；其他参数（如MccMnc、Orientation等）配置不过滤均保留。
48
49## 使用实例
50
51例如：entry目录结构如下
52```
53entry/src/main
54|    |----resource
55|    |    |----base
56|    |    |    |----element
57|    |    |    |----media
58|    |    |    |----profile
59|    |    |----rawfile
60|    |    |----resfile
61|    |----config.json/module.json
62```
63
64### 编译资源
65
66编译资源的方式有两种，分别是全量资源编译和增量资源编译。
67
681、全量资源编译，命令如下：
69
70```
71restool -i entry/src/main -j entry/src/main/module.json -p com.ohos.demo -o out -r out/ResourceTable.txt -f
72```
73
742、增量资源编译，具体步骤如下：
75
76步骤一：生成资源中间件，命令如下:
77
78```
79restool -x entry/src/main/resource -o out
80```
81步骤二：编译资源中间件，命令如下:
82
83```
84restool -i out1 -i out2 -o out -p com.ohos.demo -r out/ResourceTable.txt -j entry/src/main/module.json -f -z
85```
86
87### 固定资源ID
88
89固定资源ID，具体步骤如下：
90
91步骤一：创建id_defined.json文件。创建方式有两种，分别是通过命令行和自定义。
92
93+ 方式一：通过命令行生成此文件，命令如下：
94
95```
96restool -i entry/src/main -j entry/src/main/module.json -p com.ohos.demo -o out -r out/ResourceTable.txt --ids out -f
97```
98
99+ 方式二：自定义文件，文件名必须是id_defined.json，文件内容如下：
100
101```
102{
103    "record" :
104    [
105        {
106            "id" : "0x01000000", // 资源需要固定的ID值
107            "name" : "app_name", // 资源名称
108            "type" : "string" // 资源类型
109        }
110    ]
111}
112```
113
114步骤二：完成资源ID固定。完成固定的方式有两种，通过命令一完成固定或者将自定义的id_definded.json放在resource/base/element/目录下后通过命令二完成固定。
115
116+ 命令一：
117```
118restool -i entry/src/main -j entry/src/main/module.json -p com.ohos.demo -o out1 -r out1/ResourceTable.txt --defined-ids out/id_defined.json -f
119```
120
121+ 命令二：
122```
123restool -i entry/src/main -j entry/src/main/module.json -p com.ohos.demo -o out1 -r out1/ResourceTable.txt  -f
124```