1# 编译构建规范
2## gn构建规范
3### 规则
41. 在声明编译模块时，应使用OpenHarmony提供的高级模板，如编译C++代码相关的ohos_excutable，ohos_shared_library，ohos_static_library模板等。
52. 在所有编译模块中需要指定**subsystem_name**和**part_name**，都不应使用**output_dir**来指定编译产物的目录，
63. 模块之间建立依赖应避免使用public_deps，因为public_deps会通过依赖传递隐式配置，导致依赖模块引入多余配置而出现编译问题。
7    ```
8    # This target can include files from "c" but not from
9    # "super_secret_implementation_details".
10    executable("a") {
11      deps = [ ":b" ]
12    }
13
14    shared_library("b") {
15      deps = [ ":super_secret_implementation_details" ]
16      public_deps = [ ":c" ]
17    }
18    ```
19### 建议
201. gn的宏变量定义主要有三种位置选择：
21   | 定义位置 | 作用 |
22   | --- | --- |
23   | BUILDCONFIG.gn | 对于构建系统全局可见，一般定义工具链，cpu架构等变量，使用时不需要导入该文件 |
24   | ohos_var.gni | 常规用于OpenHarmony构建多处使用的相关变量，使用变量需要导入该文件 |
25   | xxx.gni | 各业务仓自定义文件，用于使用范围较小的相关变量，一般限制于单个代码仓内。使用变量需要导入该文件 |
26
27   以上文件定义均采用下列方式：
28   ```
29    declare_args() {
30      enable_test_var = true
31    }
32   ```
332. gn中声明的代码宏可以通过**defines**或"-D"选项来进行定义，参考如下：
34   ```
35   config("common") {
36    defines = [ "ENABLE_BYTECODE_OPT" ]
37    cflags_cc = [ "-DARK_GC_SUPPORT" ]
38   }
39   ```
403. 声明编译目标或者配置要关注其可见性，使用visibility来对可见范围进行限制。部件内模块若不对外提供接口，应将visibility字段设置为所在部件目录内。三方部件内模块可以将可见范围进一步扩大。visibility的使用有如下几种形式：
41   ```
42   config("common") {
43    visibility = []
44   }
45
46   ohos_shared_library("test_shared_library") {
47    visibility = [
48      ":*",   # 对当前文件可见
49      "//a/b/c/*",   # 通过绝对路径指定范围
50      "./a/b/c/*",   # 通过相对路径指定范围
51    ]
52   }
53   ```