1# NO-Depends-On-SA规则说明 2 3 4 5## 1. SA模块的定义 6 7SA模块是指System Ability对应的动态库模块，一般都在/system/profile/下描述，示例如下： 8 9```xml 10<?xml version="1.0" encoding="utf-8"?> 11<info> 12 <process>telephony</process> 13 <loadlibs> 14 <libpath>libtel_cellular_call.z.so</libpath> 15 <libpath>libtel_cellular_data.z.so</libpath> 16 <libpath>libtel_core_service.z.so</libpath> 17 <libpath>libtel_sms_mms.z.so</libpath> 18 </loadlibs> 19 ... 20</info> 21``` 22 23如上图所示，这些libpath里的动态库都是由SA框架通过dlopen的方式动态加载。 24 25## 2. 规则解释 26 27NO-Depends-On-SA规则有两个方面的含义： 28 29### 2.1 SA模块需要在编译模板中标识 30 31如下图所示，每个SA模块需要在对应的BUILD.gn中通过shlib_type字段来标识其类型： 32 33```go 34ohos_shared_library(sample_sa_module) { 35 ... 36 shlib_type = "sa" 37 ... 38} 39``` 40 41同样，非SA模块不要增加shlib_type="sa"标识。 42 43### 2.2 不允许依赖SA模块 44 45编译框架上ohos_shared_library模板会对所有的SA模块（shlib_type为sa）进行全局符号优化，使得所有的SA模块默认都不对外暴露符号，减小SA模块的大小，同时加快SA模块的加载速度。 46 47```go 48# Hide symbols for all sa libraries if not specified by version_script 49if (defined(invoker.shlib_type) && invoker.shlib_type == "sa") { 50 if (!defined(invoker.version_script)) { 51 configs += [ "//build/config/gcc:symbol_visibility_hidden" ] 52 } 53} 54``` 55 56## 3. 违规场景及处理方案建议 57 58### 3.1 SA模块没有添加shlib_type标识 59 60处理方式：参考2.2章节的描述增加shlib_type = "sa"标识。 61 62### 3.2 其它模块确实使用到了SA模块中的符号 63 64**方案一**：把SA模块中被使用到的符号下沉到对应的Inner API模块中供调用者使用，解除对SA模块的依赖。 65 66 67 68**方案二**：对于支持插件扩展的SA模块，需要提供API给插件调用。此场景可以通过version_script来显式申明SA模块需要对外提供的符号，示例如下： 69 70```go 71ohos_shared_library(partly_exported_symbols) { 72 ... 73 version_script = "libbeget_proxy.versionscript" 74 ... 75} 76``` 77 78示例的version_script文件如下： 79 80```apl 811.0 { 82 global: 83 AclGetDevUdid; 84 AclGetSerial; 85 ServiceWatchForStatus; 86 SystemWatchParameter; 87 WatchParameter; 88 Remove*Watcher; 89 local: 90 *; 91}; 92``` 93 94> 提示：如果符号名称有规律，可以使用*作为通配符简化version_script编写的工作量；如Acl\*;。 95 96### 3.3 ut测试代码需使用SA模块中的符号 97 98此场景可以为SA模块增加静态库目标，ut测试代码deps静态库目标来完成测试。 99 100## 4. 例外说明 101 102SA模块默认都不对外暴露符号；如需提供符号，通过version_script来申明，无其它例外选项。 103 104当前的白名单列表只用于归档存量待整改模块，整改完成后需清零。