小编点评

**原文链接：**微信公众号「englyf」 **引言：** 本篇介绍如何设计工程目录以实现对部分功能模块代码模块的保密性。 **设计工程目录：** * **顶层工程项目：**demo工程，存放工程文件。 * **子项目：**math子项目，存放涉密模块的源文件。 **配置子项目：** * **头文件：**存放接口声明的头文件。 * **库文件：**包含算法实现的库文件。 **添加子项目：** * 利用 `add_subdirectory` 命令添加子项目 math。 **配置输出库文件：** * 库文件输出到 `src/libs/` 目录下。 * `LIBRARY_OUTPUT_PATH`变量指定库文件输出目录。 **编译链接：** * 每个项目按顺序编译链接：子项目，然后顶层项目。 * 为了编译 demo 项目，需要删除 `math` 目录。 **接口头文件：** * 递归地检索指定目录下的所有文件。 * 将所有接口头文件添加到 `src/include/` 目录中。 **结果：** 该工程设计确保对部分功能模块代码模块的保密性，同时方便进行单独开发和打包。

正文

以下内容为本人的著作，如需要转载，请声明原文链接 微信公众号「englyf」https://mp.weixin.qq.com/s/o-_aGqreuQda-ZmKktvxwA

---

以往在公司开发众多的项目中，都会出现要求本项目里部分功能模块代码需要具备保密性。如果需要对外输出demo工程，那么需要做到不会泄密。

举一下爪子，以前做雷达开发的时候，客户从公司那儿买了这些雷达模块，也会需要从作为供应商的厂家这里拿到这些模块的开发demo（也就是示范软件工程）。但是由于demo里可能会用到一些涉及计算的内部算法函数调用，这些函数的实现属于公司商业机密是不能对外公开的，于是就提出了对部分代码保密的需求。

那么，怎么引入和管理这些需要保密的代码模块呢？一般的做法就是将需要保密的功能模块以子项目的形式引入到demo工程，这些子项目在编译时输出库文件，而demo工程则通过子项目提供的接口头文件引用这些库提供的接口。最后在打包输出demo工程之前，会把涉及保密功能模块所属的子项目源码从工程目录树中删除掉。被清理掉的子项目只留下生成的库文件和引用头文件(如果你的工程用的开发语言是C/C++)。

下面就继续用 Qt Quick 的开发示例来展开（果然。。。），这个示例里会实现一个简单的加法GUI小工具，计算过程所用到的算法以库API的形式提供，算法源码封装在库里。

本示例工程完整代码见文末链接分享！

设计工程目录

为了方便调用涉密的功能模块的接口以及打包输出不包含涉密模块源码的demo工程，接口的实现源码存放在对应模块的子工程（子项目）目录内，而接口的声明所在的头文件和涉密模块编译后输出的库文件需要存放在对应模块子项目的文件夹之外。之所以这样安排存放位置，是为了方便打包输出时对demo工程的清理。

看看我的工程目录：

这里有两个项目，一个顶层工程项目，也就是demo工程，命名为 gettingStartWithQtQuickSubProject，存放目录与工程名一致。另一个是子项目，里边代表着涉密模块的功能源码，命名为math。每个项目都对应一个CMakeLists.txt配置文件，其他文件视乎项目内容需要而定。

配置子项目

子项目 ./math/src/ 目录下存放着涉密模块的实现源码，这里只是简单地演示了加法的计算接口

/* inside file MyMath.cpp */
#include "MyMath.h"

myMath::myMath(QObject *parent) : QObject(parent)
{}

QVariant myMath::sum(QVariant a, QVariant b)
{
  return a.toInt() + b.toInt();
}

定义接口源文件

子项目math的所有源文件都存放在 ./math/src/ 目录下，所以将该目录指定为源文件搜索目录，并将搜索结果存到cmake自定义变量DIR_SRCS中，

aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src DIR_SRCS)

变量CMAKE_CURRENT_SOURCE_DIR是cmake自带变量，指向当前所属项目的配置文件所在目录，也即是 ./math/。

包含接口头文件

接口声明所在的头文件存放在demo项目的./src/include/中，在子项目中包含对应的目录需要通过demo项目的源码目录相对地指定。

include_directories(${CMAKE_SOURCE_DIR}/src/include)

变量CMAKE_SOURCE_DIR指向的内容就是顶层项目的配置文件(CMakeLists.txt)所在目录，这里的demo项目就是顶层项目。

配置输出库文件

子项目编译后输出的库文件应该自动输出到demo项目的./src/libs/中，可以通过设置cmake变量LIBRARY_OUTPUT_PATH来实现。

SET(LIBRARY_OUTPUT_PATH "${CMAKE_SOURCE_DIR}/src/libs")

配置顶层项目(demo项目)

我们以demo项目为顶层项目，根据实际项目需要，本来是可以添加各式各样的子项目，但是这里根据示例需要仅添加math子项目。

添加子项目

本项目作为顶层项目，配置文件(CMakeLists.txt)中除了要描述清楚本项目的配置内容，还需要指明添加了哪些子项目，而且子项目需要在编译顶层项目之前被编译完成。

add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/math)

如上，利用指令add_subdirectory添加了子项目math。此语句必须在add_executable语句之前。在完整工程编译链接后，打包输出demo工程时，需要手动删除此语句，因为客户在拿到demo工程后，不需要重新编译子项目的内容，而是直接使用库文件即可。

添加接口头文件

为了简化添加源文件和头文件的过程，采用递归目录搜索的方式，将指定目录下所有需要的文件检索到cmake自定义变量SRC_FILES中，方便后边的编译引用

file(GLOB_RECURSE SRC_FILES
    ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp
    ${CMAKE_CURRENT_SOURCE_DIR}/src/*.h
)

接口头文件所在的目录./src/include也包含在上面的检索过程中了

添加链接库文件

指定链接目录以及链接的库math

link_directories(${CMAKE_CURRENT_SOURCE_DIR}/src/libs)
link_libraries(math)

输出demo工程包

完整编译执行一遍demo工程后，库文件会被自动保存在demo工程目录下。编译过程中，各项目是分开按顺序编译链接的，先是子项目，然后才是顶层项目demo。

为了之后能单独编译链接demo项目内容，需要删除math目录，并且在demo工程的顶层CMakeLists.txt文件中，把添加子项目math的语句删除即可。

执行一下上面的工程

点击=执行

好了，简单演示到这里，欢迎后续交流...

---

本示例工程完整代码git仓库链接: git@github.com:ifi-leung/gettingStartWithQtQuickSubProject.git

我的博客即将同步至腾讯云开发者社区，邀请大家一同入驻：https://cloud.tencent.com/developer/support-plan?invite_code=3drgp8nbaeg4s