C++最佳实践之编译篇

C++最佳实践之工程编译

在大型c/c++工程开发中，往往会涉及多级CMakeLists.txt的调用，并且调用方式错综复杂，主要有以下两种方式：

1. 子目录中的CMakeList.txt独立生成目标，不作为主目标生成过程的依赖关系（比如dev_tool、driver、ut_test等），与主目标并无任何关系。2. 子目录中的CMakeList.txt作为主目标的依赖源文件，不单独生成目标，作为主目标生成过程主的部分源文件，通常以生成.a源文件的方式提供给主CMakeList.txt使用。

一、工程目录结构

下面给出了测试工程目录，进行了两项测试：

  • unit—test目录作为独立生成目标，其CMakeLists.txt在主CMakeList.txt主被调用；

  • subfunc和subsubfunc作为主CMakeList.txt向下两级的依赖，为主CMakeList.txt提供源文件支持，其CMakeLists.txt为逐级调用的方式：
    CMakeList.txt->subfunc/CMakeList.txt->subfunc/subfuncfunc/CMakeLists.txt

具体目录结构如下：

在这里插入图片描述

  • build: 编译目录，生成的目标执行文件、静态库、中间缓存文件都在此处
  • inc：主头文件目录
  • src：主源文件目录
  • subfunc：依赖的一级子目录
  • uinit-test：单元测试目录，独立生成的目标文件
  • CMakeList.txt：最上层，主CMakeList.txt

二、工程源代码

2.1、工程源代码
cmake_minimum_required(VERSION 3.8)       # cmake 版本
PROJECT(cmaketest)                        # 工程名#set project name
set(PROJECT_NAME cmaketest)               # 设置工程名字set(CMAKE_CXX_STANDARD 17)                # 设置C++标准为C++17
set(CMAKE_CXX_STANDARD_REQUIRED ON)       # 设置本地头文件路径，注意：子目录的头文件是通过target_include_directories添加到${PROJECT_NAME}中
INCLUDE_DIRECTORIES(inc                                   #上层头文件${SUB_INCLUDE_DIR}                    #下级头文件
)#将源文件路径添加到变量src_list中
AUX_SOURCE_DIRECTORY(.          SRC_LIST)
AUX_SOURCE_DIRECTORY(src        SRC_LIST)# 7.生成目标(可执行文件)：cmaketest
ADD_EXECUTABLE(${PROJECT_NAME} ${SRC_LIST})# 8.设置编译时依赖的subfunc静态库
target_link_libraries(${PROJECT_NAME}    #目标：tcusubfunc        # sub子目录下的静态库文件subsubfunc     # subsub子目录下的静态库文件
)# 9.添加子目录，这样子目录中的CMakeLists.txt才会被调用# 调用subfunc子目录中的CMakeLists.txt，生成静态库而不生成新目标，目标与主CMakeLists.txt中设定的一致
add_subdirectory(subfunc) 
# 调用unit-test子目录中的CMakeLists.txt，生成新目标，目标与主CMakeLists.txt中设定的无关，仅仅是调用
add_subdirectory(unit-test)

注意：

include_directories包含的头文件路径可以被各级子目录中的目标所引用;target_include_directories包含的头文件只能被特定目标使用；采用变量传递的方式(${sub_include_dir}引入子路径)引入子目录的头文件路径

cmakettest/main.cpp:

#include <iostream>
#include <string>
#include "func1.hpp"   //应用层头文件1
#include "func2.hpp"   //应用层头文件2int main(int argc, char *argv[])
{func1();          //调用上层func1func2();          //调用上层func2return 0;
}

cmakettest/inc/func1.hpp:

#ifndef __FUNC1_HPP__
#define __FUNC1_HPP__int func1(void);#endif

cmakettest/inc/func2.hpp:

#ifndef __FUNC2_HPP__
#define __FUNC2_HPP__int func2(void);#endif

cmakettest/src/func1.cpp:

#include "subfunc.hpp"   //subfunc头文件
#include "func1.hpp"     //应用层头文件1
#include <iostream>
#include <string>int func1(void)
{std::cout<<"------------func1函数调用开始----------"<<std::endl;subfunc1();std::cout<<"------------func1函数调用结束----------"<<std::endl<<std::endl;return 0;
}

cmakettest/src/func2.cpp:

#include "subfunc.hpp"   //subfunc头文件
#include "func2.hpp"     //应用层头文件1
#include <iostream>
#include <string>int func2(void)
{std::cout<<"------------func2函数调用开始----------"<<std::endl;subfunc2();std::cout<<"------------func2函数调用结束----------"<<std::endl;return 0;
}
2.2、subfunc以及subsubfunc子目录

cmaketest/subfunc/CMakeLists.txt

# 1.将本目录下的所有.c 文件添加到SUB_DIR_LIB_SRCS变量
AUX_SOURCE_DIRECTORY(. SUB_DIR_SRC_LIST)# 2.设置当前的头文件路径
set(SUB_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}          # 当前源文件路径${SUB_SUB_INCLUDE_DIR}               # 由下层subsubfunc目录传递的头文件路径CACHE INTERNAL "subfunc include dir" # 这个字符串相当于对变量SUB_INCLUDE_DIR的描述说明，不能省略，但可以自己随便定义,只有添加了这个描述SUB_INCLUDE_DIR变量才能被上层CMakeLists.txt调用！！！
)MESSAGE(STATUS "subfunc层头文件路径 :${SUB_INCLUDE_DIR}")# 3.生成静态库
add_library(subfunc ${SUB_DIR_SRC_LIST})# 4.添加subsubfunc子目录，这样子目录中的CMakeLists.txt才会被调用
add_subdirectory(subsubfunc)

cmaketest/subfunc/subfunc.hpp:

#ifndef __SUB_FUNC_HPP__
#define __SUB_FUNC_HPP__int subfunc1(void);
int subfunc2(void);#endif

cmaketest/subfunc/subfunc.cpp:

#include "subfunc.hpp"
#include "subsubfunc.hpp"
#include <iostream>
#include <string>int subfunc1(void)
{std::cout<<"------subfunc1函数调用开始------"<<std::endl;/* 中间调用subsubfunc1函数 */
subsubfunc1();std::cout<<"------subfunc1函数调用结束------"<<std::endl;return 0;
}
int subfunc2(void)
{std::cout<<"------subfunc2函数调用开始------"<<std::endl;
subsubfunc2();/* 中间调用subsubfunc2函数 */std::cout<<"------subfunc2函数调用结束------"<<std::endl;return 0;
}

cmaketest/subfunc/subsubfunc/CMakeLists.txt

# 1.将本目录下的所有.c 文件添加到SUB_DIR_LIB_SRCS变量
AUX_SOURCE_DIRECTORY(. SUB_SUB_DIR_SRC_LIST)# 2.设置当前的头文件路径
set(SUB_SUB_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}              # 当前源文件路径CACHE INTERNAL "subsubfunc include dir"  # 这个字符串相当于对变量SUB_SUB_INCLUDE_DIR的描述说明，不能省略，但可以自己随便定义,只有添加了这个描述SUB_SUB_INCLUDE_DIR变量才能被上层CMakeLists.txt调用！！！
)MESSAGE(STATUS "subsubfunc层头文件路径 :${SUB_SUB_INCLUDE_DIR}")# 3.生成静态库
add_library(subsubfunc ${SUB_SUB_DIR_SRC_LIST})

分析：

1. 头文件目录变量的逐级向上传递，通过设置sub_sub_include_dir变量（必须包含cache internel “subsubfunc include dir”描述），将subsubfunc下的头文件路径传递给了上级subfunc的CMakeList.txt；2. 通过设置SUB_INCLUDE_DIR变量（必须添加CACHE INTERNAL "subfunc include dir"描述），将subfunc文件下的头文件路径（包含之前获得的${SUB_SUB_INCLUDE_DIR}）传递给了最上层文件下的CMakeLists.txt。
2.3、UT子目录

cmaketest/unit-test/CMakeLists.txt：

add_executable(unit-test unit-test.cpp)
target_link_libraries(unit-test boost_system pthread)

cmaketest/unit-test/unit-test.cpp：

#include <boost/asio.hpp> 
#include <iostream>int main(int argc,char* argv[])
{std::cout<<"unit-test代码调用!!!"<<std::endl;return 0;
}

三、编译与实践

在项目路径下创建/build文件夹，用于存放cmake编译过程中生成的各种中间文件、库、最终目标文件等：

cd build
cmake ..
make

在cmake编译的过程中发现了一个问题，就是一开始执行cmake . .时候，并没有完成头文件变量的传递，导致make编译出错。执行结果如下：

在这里插入图片描述

make，结果如下：

在这里插入图片描述

可以看到，由于SUB_SUB_INCLUDE_DIR变量并没有传递到subfunc层的CMakeLists.txt，从而导致了在subfunc层并没有包含全部发头文件路径，导致编译的时候找不到subsubfunc.hpp。

解决方案：

经过反复测试发现，多执行几次cmake…(三次以上)就可以解决这个问题，猜测是因为多次执行cmake的过程完成了SUB_SUB_INCLUDE_DIR和SUB_INCLUDE_DIR变量向上层的传递:
在这里插入图片描述

四、build目录分析

在这里插入图片描述

  • unit-test作为独立的子目录，生成了独立的目标文件unit-test；
  • subfunc下生成了libsubfunc.a的静态库文件，在subsubfunc下生成了libsubsubfunc.a的静态库文件，这两个库文件供最上层CMakeLists.txt调用，并最终生成一个目标文件cmaketest；

五、程序执行结果

在这里插入图片描述

六、总结

1. 一种是独立的unit-test生成独立的目标文件，与主CMakeLists.txt仅有一个调用与被调用的关系，并不存在任何的编译依关系；2. 另一种多级CMakeLists.txt调用之间存在上下级的依赖关系，下层的源代码给上层的调用提供支持（以生成静态库的方式），这里进行了分层设计。3. 下层的头文件路径仅传递给调用的上一层而不会传递给最上层，这种变量传递的方式提高了代码的分层性，这里需要注意变量的设置（CACHE INTERNAL属性的必须添加）以完成下层到上层的变量传递，上述的两种分层CMakeLists.txt调用方式可覆盖基本的全部开发场景。

七、未完待续

下章将继续介绍C++相关的工程能力。欢迎关注知乎：北京不北欢迎关注douyin：near.X （北京不北）欢迎+V：beijing_bubei获得免费答疑，长期技术交流。

八、参考文献

，这里进行了分层设计。

3. 下层的头文件路径仅传递给调用的上一层而不会传递给最上层，这种变量传递的方式提高了代码的分层性，这里需要注意变量的设置（CACHE INTERNAL属性的必须添加）以完成下层到上层的变量传递，上述的两种分层CMakeLists.txt调用方式可覆盖基本的全部开发场景。

七、未完待续

下章将继续介绍C++相关的工程能力。欢迎关注知乎：北京不北欢迎关注douyin：near.X （北京不北）欢迎+V：beijing_bubei获得免费答疑，长期技术交流。

八、参考文献

https://blog.csdn.net/weixin_42700740/article/details/126364574

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/487339.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

2024Node.js零基础教程(小白友好型)，nodejs新手到高手，（八）NodeJS入门——http模块

2024Node.js零基础教程(小白友好型)，nodejs新手到高手，（八）NodeJS入门——http模块

一念心清净&#xff0c;处处莲花开。 055_http模块_网页资源加载基本过程 哈喽&#xff0c;大家好&#xff0c;这一课节我们来介绍一下网页资源加载的基本过程。首先先强调一点&#xff0c;这个内容对于我们后续学习非常非常的关键&#xff0c;所以大家务必要将其掌握。 首先先…
阅读更多...
C++奇怪的 ::template

C++奇怪的 ::template

答疑解惑 怎么会有::template的写法 起初 在阅读stl的源码的时候&#xff0c;发现了一条诡异的代码 // ALIAS TEMPLATE _Rebind_alloc_t template<class _Alloc,class _Value_type> using _Rebind_alloc_t typename allocator_traits<_Alloc>::template rebind…
阅读更多...
【高德地图】Android高德地图绘制标记点Marker

【高德地图】Android高德地图绘制标记点Marker

&#x1f4d6;第4章 Android高德地图绘制标记点Marker ✅绘制默认 Marker✅绘制多个Marker✅绘制自定义 Marker✅Marker点击事件✅Marker动画效果✅Marker拖拽事件✅绘制默认 Infowindow&#x1f6a9;隐藏InfoWindow 弹框 ✅绘制自定义 InfoWindow&#x1f6a9;实现 InfoWindow…
阅读更多...
6.网络游戏逆向分析与漏洞攻防-游戏网络架构逆向分析-通过逆向分析确定游戏明文发送数据过程

6.网络游戏逆向分析与漏洞攻防-游戏网络架构逆向分析-通过逆向分析确定游戏明文发送数据过程

内容参考于&#xff1a;易道云信息技术研究院VIP课 上一个内容&#xff1a;测试需求与需求拆解 在开始之前要了解一个小知识&#xff0c;在逆向开始之前要很清楚知道要找的东西是什么&#xff0c;大概长什么样子&#xff0c;只有这样才能看到它第一眼发现它&#xff0c;现在我…
阅读更多...
nginx反向代理和负载均衡配置

nginx反向代理和负载均衡配置

配置文件 位置 : /usr/local/software/nginx/conf vim nginx.conf 在http大括号下配置: upstream wnBalance{ server ip:端口 weight比重 :1或者2; 1为配重高 server ip:端口 weight1; } wnBalance : 代表括号中两个ip的变量名 位置 : /usr/local/so…
阅读更多...
华为配置WLAN AC和AP之间VPN穿越示例

华为配置WLAN AC和AP之间VPN穿越示例

配置WLAN AC和AP之间VPN穿越示例 组网图形 图1 配置WLAN AC和AP之间VPN穿越示例组网图 业务需求组网需求数据规划配置思路配置注意事项操作步骤配置文件 业务需求 企业用户接入WLAN网络&#xff0c;以满足移动办公的最基本需求。且在覆盖区域内移动发生漫游时&#xff0c;不影响…
阅读更多...
详解AP3216C（三合一sensor： 光照、距离、照射强度）驱动开发

详解AP3216C（三合一sensor： 光照、距离、照射强度）驱动开发

目录 概述 1 认识AP3216C 1.1 AP3216C特性 1.2 AP3216C内部结构 1.3 AP3216C 硬件电路 1.4 AP3216C工作时序 1.4.1 I2C 写数据协议 1.4.2 I2C 读数据协议 1.5 重要的寄存器 1.5.1 系统配置寄存器 1.5.2 和中断相关寄存器 1.5.3 IR数据寄存器 1.5.4 ALS 数据寄存器 …
阅读更多...
【openGL教程08】着色器（02）

【openGL教程08】着色器（02）

LearnOpenGL - Shaders 一、说明 着色器是openGL渲染的重要内容&#xff0c;客户如果想自我实现渲染灵活性&#xff0c;可以用着色器进行编程&#xff0c;这种程序小脚本被传送到GPU的显卡内部&#xff0c;起到动态灵活的着色作用。 二、着色器简述 正如“Hello Triangle”一章…
阅读更多...
【Logback】Logback 日志框架的架构

【Logback】Logback 日志框架的架构

目录 1、Logger&#xff08;记录器&#xff09; &#xff08;1&#xff09;有效级别和级别继承 &#xff08;2&#xff09;日志打印和日志筛选 &#xff08;3&#xff09;记录器命名 2、Appenders&#xff08;追加器&#xff09; 3、Layouts&#xff08;布局&#xff09;…
阅读更多...
Window部署SkyWalking

Window部署SkyWalking

SkyWalking mysql的驱动依赖 选择下载版本 v9.4 现在后解压缩目录结构 一、修改config目录文件 application.yml 修改1&#xff1a; selector: ${SW_STORAGE:h2} 修改后&#xff1a; selector: ${SW_STORAGE:mysql} 修改2&#xff1a;使用mysql数据库 mysql: properti…
阅读更多...
光伏气象站：实现自动化、高精度的气象监测

光伏气象站：实现自动化、高精度的气象监测

型号推荐&#xff1a;云境天合 TH-FGF9】光伏气象站是一种基于光伏技术的气象监测设备&#xff0c;它利用太阳能转化为电能&#xff0c;为气象站提供持续的电力供应&#xff0c;并实现自动化、高精度的气象监测。 光伏气象站的工作原理可以分为以下几个部分&#xff1a; 光伏发…
阅读更多...
城市白模：裸眼3D下的未来都市构想

城市白模：裸眼3D下的未来都市构想

随着科技的飞速发展&#xff0c;城市规划与建设已经迈入了一个全新的时代。在这个时代里&#xff0c;“城市白模”成为了设计师、建筑师、城市规划者乃至普通市民的热门话题。那么&#xff0c;什么是“城市白模”&#xff1f;它又如何改变我们对城市的认知与期待呢&#xff1f;…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023