1# 部件 2### 部件配置规则 3 4部件的bundle.json放在部件源码的根目录下。以泛sensor子系统的sensor服务部件为例，部件属性定义描述文件字段说明如下： 5 6```shell 7{ 8 "name": "@ohos/sensor_lite", # HPM部件英文名称，格式"@组织/部件名称" 9 "description": "Sensor services", # 部件功能一句话描述 10 "version": "3.1", # 版本号，版本号与OpenHarmony版本号一致 11 "license": "MIT", # 部件License 12 "publishAs": "code-segment", # HPM包的发布方式，当前默认都为code-segment 13 "segment": { 14 "destPath": "" 15 }, # 发布类型为code-segment时为必填项，定义发布类型code-segment的代码还原路径（源码路径） 16 "dirs": {"base/sensors/sensor_lite"}, # HPM包的目录结构，字段必填内容可以留空 17 "scripts": {}, # HPM包定义需要执行的脚本，字段必填，值非必填 18 "licensePath": "COPYING", 19 "readmePath": { 20 "en": "README.rst" 21 }, 22 "component": { # 部件属性 23 "name": "sensor_lite", # 部件名称 24 "subsystem": "", # 部件所属子系统 25 "syscap": [], # 部件为应用提供的系统能力 26 "features": [], # 部件对外的可配置特性列表，一般与build中的sub_component对应，可供产品配置 27 "adapted_system_type": [], # 轻量(mini)小型(small)和标准(standard)，可以是多个 28 "rom": "92KB", # 部件ROM值 29 "ram": "~200KB", # 部件RAM估值 30 "deps": { 31 "components": [ # 部件依赖的其他部件 32 "samgr_lite", 33 "ipc_lite" 34 ], 35 "third_party": [ # 部件依赖的三方开源软件 36 "bounds_checking_function" 37 ] 38 } 39 "build": { # 编译相关配置 40 "sub_component": [ 41 ""//base/sensors/sensor_lite/services:sensor_service"", # 部件编译入口 42 ], # 部件编译入口，模块在此处配置 43 "inner_kits": [], # 部件间接口 44 "test": [] # 部件测试用例编译入口 45 } 46 } 47 } 48``` 49 50> **注意**：lite上旧的部件在build/lite/components目录下对应子系统的json文件中，路径规则为：**{领域}/{子系统}/{部件}**，部件目录树规则如下： 51 52```shell 53component 54├── interfaces 55│ ├── innerkits # 系统内接口，部件间使用 56│ └── kits # 应用接口，应用开发者使用 57├── frameworks # framework实现 58├── services # service实现 59└── BUILD.gn # 部件编译脚本 60``` 61 62部件配置中需要配置部件的名称、源码路径、功能简介、是否必选、编译目标、RAM、ROM、编译输出、已适配的内核、可配置的特性和依赖等属性定义。 63 64新增部件时需要在对应子系统json文件中添加相应的部件定义。产品所配置的部件必须在某个子系统中被定义过，否则会校验失败。 65 66### 新增并编译部件 67 681. 添加部件。 本节以添加一个自定义的部件为例，描述如何编译部件，编译库、编译可执行文件等。 69 70 示例部件partA由feature1、feature2和feature3组成，feature1的编译目标为一个动态库，feature2的目标为一个可执行程序，feature3的目标为一个etc配置文件。 71 72 示例部件partA的配置需要添加到一个子系统中，本次示例将添加到subsystem_examples子系统中（subsystem_examples子系统定义在test/examples/目录）。 73 74 示例部件partA的完整目录结构如下： 75 76 ```shell 77 test/examples/partA 78 ├── feature1 79 │ ├── BUILD.gn 80 │ ├── include 81 │ │ └── helloworld1.h 82 │ └── src 83 │ └── helloworld1.cpp 84 ├── feature2 85 │ ├── BUILD.gn 86 │ ├── include 87 │ │ └── helloworld2.h 88 │ └── src 89 │ └── helloworld2.cpp 90 └── feature3 91 ├── BUILD.gn 92 └── src 93 └── config.conf 94 ``` 95 96 示例1：编写动态库gn脚本test/examples/partA/feature1/BUILD.gn，示例如下： 97 98 ```shell 99 config("helloworld_lib_config") { 100 include_dirs = [ "include" ] 101 } 102 103 ohos_shared_library("helloworld_lib") { 104 sources = [ 105 "include/helloworld1.h", 106 "src/helloworld1.cpp", 107 ] 108 public_configs = [ ":helloworld_lib_config" ] 109 part_name = "partA" 110 } 111 ``` 112 113 示例2：编写可执行文件gn脚本test/examples/partA/feature2/BUILD.gn，示例如下： 114 115 ```shell 116 ohos_executable("helloworld_bin") { 117 sources = [ 118 "src/helloworld2.cpp" 119 ] 120 include_dirs = [ "include" ] 121 deps = [ # 依赖部件内模块 122 "../feature1:helloworld_lib" 123 ] 124 external_deps = [ "partB:module1" ] # （可选）如果有跨部件的依赖，格式为“部件名:模块名” 125 install_enable = true # 可执行程序缺省不安装，需要安装时需要指定 126 part_name = "partA" 127 } 128 ``` 129 130 示例3：编写etc模块gn脚本test/examples/partA/feature3/BUILD.gn，示例如下： 131 132 ```shell 133 ohos_prebuilt_etc("feature3_etc") { 134 source = "src/config.conf" 135 relative_install_dir = "init" #可选，模块安装相对路径，相对于默认安装路径；默认在/system/etc目录 136 part_name = "partA" 137 } 138 ``` 139 140 示例4：在部件的bundle.json中添加模块配置：test/examples/bundle.json。每个部件都有一个bundle.json配置文件，在部件的根目录下。示例见：[部件的bundle.json](subsys-build-component.md#部件配置规则) 141 1422. 将部件添加到产品配置中。 在产品的配置中添加部件，产品对应的配置文件：//vendor/{product_company}/{product-name}/config.json。 143 144 在产品配置文件中添加 "subsystem_examples:partA"，表示该产品中会编译并打包partA到版本中。 145 1463. 编译。 主要有两种编译方式，[命令行方式和hb方式](subsys-build-all.md#编译命令)，下面以命令行方式为例： 147 148 部件可以使用"--build-target 部件名"进行单独编译，以编译产品hispark_taurus_standard的musl部件为例，编译命令如下： 149 150 ``` 151 ./build.sh --product-name hispark_taurus_standard --build-target musl --ccache 152 ``` 153 154 也可以编译相应产品，以编译hispark_taurus_standard为例，编译命令如下： 155 156 ```shell 157 ./build.sh --product-name hispark_taurus_standard --ccache 158 ``` 159 1604. 编译输出。 编译所生成的文件都归档在out/hispark_taurus/目录下，结果镜像输出在 out/hispark_taurus/packages/phone/images/ 目录下。
