design doc.

This commit is contained in:
xiaojiazhu 2023-07-21 22:38:05 -07:00
parent b7739f7602
commit aa635a3001
2 changed files with 42 additions and 4 deletions

16
customization/README.md Normal file
View File

@ -0,0 +1,16 @@
# 1. 客制化目录
## 1.1. 概述
   客制化目录,依赖整个项目源码(含各层目录),继承并重载接口实现客制化功能,用于管理定制化版本 / Debug版本 / 生产版本等,使特殊功能代码与公版代码解耦合,保持公版版本功能稳定性和一致性。
## 1.2. Debug版本
### 1.2.1. Debug版本概述
   Debug版本用于满足测试需求例如开启log / 特殊的功能。
### 1.2.2. 生产测试版本
   生产时使用的验证产品功能的版本。
### 1.2.3. 其它定制版本
   基于公版,继承派生出来的特殊功能的商业化版本。

View File

@ -62,11 +62,11 @@ libLogAbstract.a -->> -User:return
   根据多态单例设计模式,指定使用多态单例模式开发的模块的源码目录结构,耦合思路清晰。
```
└── Log // 多态单例模式模块的目录
├── include // 多态单例模块对外暴露的头文件目录,抽象接口定义
│   └── ILogAbstract.h
├── abstract // 多态单例模式抽象接口声明
│   └── ILogAbstract.cpp
├── include // 多态单例模块对外暴露的头文件目录,抽象接口定义
│   └── ILogAbstract.h
└── src // 多态单例接口实例代码,目录名称可根据实际功能定义
└── src // 多态单例接口实例代码,目录名称可根据实际功能定义
├── LogAstract.cpp
└── LogAstract.h
```
@ -139,6 +139,7 @@ libLogAbstract.a -->> -User:return
##### 1.4.2.4.3. 返回码管理库
###### 1.4.2.4.3.1. 返回码管理库概述
   提供整个应用程序的返回码管理功能例如打印返回码的字符串含义。提供C语言接口纯C语言开发的模块形成项目内部唯一返回码标准。
1. 创建返回码操作“句柄”;
@ -146,6 +147,27 @@ libLogAbstract.a -->> -User:return
3. 不同的模块可继承实现各自的返回码处理接口;
##### 1.4.2.4.4. 系统标准接口库
   对系统标准接口的套壳封装,主要是为了对系统标准打桩满足测试需求。
   使用普通的C语言接口封装即可通过使用gcc编译参数在Linux x86系统中满足打桩需求在交叉编译担心工具链兼容问题测试程序中无法对系统标准接口进行打桩。
   使用普通的C语言接口封装即可通过使用gcc编译参数在Linux x86系统中满足打桩需求在交叉编译担心工具链兼容问题测试程序中无法对系统标准接口进行打桩。
##### 1.4.2.4.5. 配置库
###### 1.4.2.4.5.1. 配置库概述
   配置库负责管理软件配置参数,对配置数据进行设置 / 获取 / 存储 / 备份 / 升级等功能;
###### 1.4.2.4.5.2. 配置库设计模式
   对外提供C语言接口内部不局限使用C或者C++。
###### 1.4.2.4.5.3. 开源库
###### 1.4.2.4.5.4. 备份机制
   备份数据用于数据异常时可还原旧数据。
###### 1.4.2.4.5.5. 升级机制
   程序升级后配置数据发生增 / 删时如何兼容和还原。