构建C语言开发环境

末蓝、 2024-03-24 18:27 108阅读 0赞

有些C/C++项目开发周期极长。在处理此类项目过程中，**构建开发环境**就像施展魔法一样：**测试框架**被巧妙集成在一起，**CI/CD流程**将开发者从繁琐重复的工作中解脱出来。

作为程序员，在开发过程中，我只有一个简单的愿望：**在当前的开发环境中将C库简化为少数几个文件。**

在本文中，我们将介绍如何为**C语言项目**构建容器化开发环境，也将介绍如何使用CMake设置构建系统、使用Unity设置测试环境以及如何在**CI流水线**中构建容器化环境。

### **一、现代化开发环境** ###

接下来，我们将展示如何为C项目构建**完整的、容器化**的开发环境：

*  创建Docker镜像作为vscode的开发容器；
 *  基于最小化的Dummy库，在容器中设置构建库的工具；
 *  设置静态代码分析器clang-tidy检查代码是否有常见错误；
 *  clang-format维持代码库的格式保持正常和整洁；
 *  设置Unity，通过在主机上执行Ceedling测试虚拟函数；
 *  最后，我们将设置GitHub工作流，使用本地Docker镜像**执行、构建**和**测试**项目。

在本文中，我将使用Docker命令行接口。如果你不明白为什么需要某些参数，建议参考在线文档。你也可以直接打开GitHub上的示例项目。

### **二、在Docker中运行程序**  ###

有时，使用**嵌入式系统**或**C/C++**需要安装大量**专用工具**或**编译器**。如果你正在同时处理不同的项目，版本之间很容易发生冲突。因此，我更倾向于在Docker容器中运行所有程序。

你可以使用**Dockerfiles**，这能避免在本地安装工具，任何人都能通过**预构建镜像**或**本地镜像**加入项目。

##### **1.为什么是Docker?存在哪些陷阱？** #####

如果你是**Docker新手**，需注意以下几点：

*  Dockerfiles不稳定：昨天构建出的Dockerfile今天就可能无法使用，存在太多的外部依赖关系；
 *  Docker不是平台独立型的，例如Apple ARM；
 *  某些Docker特性仅在Linux或专用Windows中获得了支持；例如，并非所有平台都支持将USB设备安装到Docker容器之中，这是自2016年以来的限制。

鉴于此，建议你不要将**“赌注”**都**“押”**在同一项技术上，并且你需要随时做好**切换**的准备。

##### **2.让我们这样做**  #####

让我们从零开始，构建**空存储库**：

![图片][758278c079972d904a908761707b1fbd.png]

确保安装Dockor并顺利运行，在项目的根目录中创建如下内容：builder.Dockerfile

![图片][d05fba6b6ee34f80552217303cb42937.png]

这个Dockerifle指定了基本镜像并安装了一些包，便于在后续步骤中使用。我不会详细介绍每一个**软件包**：在创建镜像时，你很快就能注意到缺少了什么，可以扩展软件包列表，重要的是以下几点：

*  对于基本图像，我强烈建议使用特定标签。apt包在基本镜像之间变化很大，选择标记可以为你节省更多时间；
 *  我倾向于在镜像开发过程中使用特定平台 ，这一点对后续开发步骤的顺利进行很重要。

如果不使用**vscode**，也可以指定不同的镜像。在本文中，我们将使用vscode，也将坚持使用Dev容器所支持的镜像。

镜像是用如下的命令构建出来的，执行起来可能需要一点时间：

![图片][5198349489ffd8b123c68b0c03b52164.png]

##### **3.详细命令行调用的快捷方式**  #####

Docker命令非常冗长，因此，我通常将常用命令放在makefile项目根目录中。假设安装make后可进行如下操作：

![图片][cffca03a89abd5a96f06a83b501b0b22.png]

现在，执行如下操作重建镜像：

![图片][256e31c2cab23464a1fce606202e1423.png]

让我们从图像中旋转容器并进行测试：

![图片][2d2f2f53876f0e2fd4e5b1e0324e6360.png]

当使用apt时，已安装的工具版本取决于**基础镜像**，也取决于**包注册表**。如果需要安装特定的版本，可以通过执行自定义的RUN命令。

### **三、Visual Studio代码开发容器**  ###

**没有在本地安装所有工具的缺点是：**你选择的IDE无法利用这些工具，例如，当使用vscode时，如果没有安装编译器，你将无法正确设置**智能提示**或任何其它的**辅助程序**。

vscode允许你在开发容器中运行编辑器。这也是我们选择将mcr.microsoft.com/vscode/devcontainers/base当作基础图像的原因：我们可以在容器中链接到vscode，因此所有工具都将被安装在Docker镜像中。

值得注意的是，vscode实例与本地vscode安装不匹配，与远程实例非常相似。

通过创建.devcontainer/devcontainer.json文件，我们可以让vscode使用新构建的图像作为开发容器，还可以在vscode实例中安装3个扩展，通过使用 customizations.extensions字段中的devcontainer.json配置文件：

![图片][bb57b4a07830b9c70cc2d29db50c4e11.png]

如果你从现在开始重新**加载窗口**或重新打开vscode，vscode应该会询问你是否需要使用检测到的开发容器。

![图片][d4866d40526bf95475eacc85ce5ee549.png]

需要一段时间为vscode**设置**你的**容器**、**安装扩展**，并用vscode连接到**Linux容器**。

![图片][0b113bd1f8f938f9e45ba7de9a24d06a.png]

### **四、系统架构**  ###

我们将使用CMake构建单独的.c和.h对。

![图片][ccbff26595b815ddb2dfdd5b7215382f.png]

![图片][0d8d524dbc913d39345be57222d9912c.png]

CMakeLists.txt简单定义了名为“Dummy”的库，并将相应的文件添加到库中。

重要的是：这已在开发容器和vscode中被构建出来了!在你的远程实例中打开集成终端并执行CMake，如下所示：

![图片][3631ec358d7730d402bc6c3d3f6aabf5.png]

### **五、安装clang工具：格式化和静态代码分析** ###

C和C++的灵活性也伴随着大量“footguns”的出现；因此，我尝试在项目中添加至少一个最小的静态代码分析任务，这有助于发现最明显的错误。市面上有很多工具，但到目前为止，我个人更偏爱clang-tidy。

另外，在代码库上进行协作时，格式化器极好；当我们在安装clang-tidy时，不妨继续安装clang-format。

你需要将两个配置文件clang-format和.clang-tidy放置到**项目根目录**中，以便任何IDE都能自动拾取它们：

![图片][e7b8b4fc38a3d41e32b7e2a7ba9450cf.png]

### **六、添加单元测试框架** ###

我们已经能够构建并分析库，还提供了**格式化**功能。在开发环境中，我们还需要一个**单元测试框架**。

在本文中，我选择了Unity测试框架，通过Ceedling在主机上执行。顺便说一句，使用这个框架便于**嵌入式系统**在目标硬件上执行任务。

##### **1.安装Unity和Ceedling**  #####

在构建者镜像的第一步中，我们已经安装了ruby，所以，安装**单元测试工具**变得更加简单：

![图片][0f62e2b18688bf3a2f30ced4a9b6fdcc.png]

重建镜像后，我们就可以开始了!

![图片][e214993ce4e55979d403ba443084c427.png]

##### **2.配置Unity和运行单元测试**  #####

简而言之，你需要在一个专门的unity\_config.h文件中将配置开关设置为Unity并配置Ceedling与project.yml. Ceedling，为你生成所有的测试运行程序。

你需要做的就是**添加**你的**测试文件**，然后**“告诉”**Ceedling如何检测它们：

![图片][e3f3e49168361b57f98a8b824113bc62.png]

然后，我们可以创建第一个单元测试tests/unittest/test/test\_dummy.c：

![图片][92ba4d284f1c0e7006a18d1bdaeb6efa.png]

### **七、结论** ###

到这里，所有的工作就都完成了，包括**库的构建**等，报告也可以使用了。神奇的是，所有这些操作都不会使计算机因工具而**“堵塞”**。

![图片][7b4820535b62071fec676abf4b17e9b9.png]

最后，值得一提的是：有了Docker桌面，你不仅可以轻松**检查图像漏洞**，还能**检查Dockerfile**中的每一步：

![图片][d63a8ad0240534ba0a9c5f1dbd3ff53d.png]

现在，你已具备在GitHub上用CI设置容器化C/C++项目的所有技能。有了这项技能，你能轻松地在文档中添加**特定编译器**或**清理**设置CI时出现的所有**错误**。

#### **善用工具** ####

成功的前端工程师很会善用工具，这些年低代码概念开始流行，像国外的 Mendix，国内的 JNPF，这种新型的开发方式，图形化的拖拉拽配置界面，并兼容了自定义的组件、代码扩展，确实在 B 端后台管理类网站建设中很大程度上的提升了效率。

开源地址：[JNPF体验中心][JNPF]

代码量少，系统的稳定性和易调整性都会得到一定的保障。基于代码生成器，可一站式开发多端使用 Web、Android、IOS、微信小程序。代码自动生成后可以下载本地，进行二次开发，有效提高整体开发效率。同时，支持多种云环境部署、本地部署给予最大的安全保障，可以快速搭建适合自身应用场景的产品。

[758278c079972d904a908761707b1fbd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/b8dfba89e65943769482ab5f58aa6eb0.png
[d05fba6b6ee34f80552217303cb42937.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/8e6af0316e9d45caae067fe8ec1205a0.png
[5198349489ffd8b123c68b0c03b52164.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/8a80cb3eabd74561abebe0009bd03754.png
[cffca03a89abd5a96f06a83b501b0b22.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/0d5cb25affba4c47a89a0c3f77fc7087.png
[256e31c2cab23464a1fce606202e1423.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/bd528b349bdc4ad39e8d062b81a13d0e.png
[2d2f2f53876f0e2fd4e5b1e0324e6360.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e13b46ffb0494c64975ab93056e27acf.png
[bb57b4a07830b9c70cc2d29db50c4e11.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/80e4e56cb401481da6f31a07e493e4b0.png
[d4866d40526bf95475eacc85ce5ee549.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/1911665ad2754dd5b2be9756035c3910.png
[0b113bd1f8f938f9e45ba7de9a24d06a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/9463e9d9607e44fda620c636924db1a2.png
[ccbff26595b815ddb2dfdd5b7215382f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/04b44f93a39148b48b94a1deb1eaf06d.png
[0d8d524dbc913d39345be57222d9912c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/18f1cf536877418391a111e465a964a9.png
[3631ec358d7730d402bc6c3d3f6aabf5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/4222339d9d6240a1ae1c7388c292cd95.png
[e7b8b4fc38a3d41e32b7e2a7ba9450cf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/478c2f9c0f7f4c49ab4802c9e0232926.png
[0f62e2b18688bf3a2f30ced4a9b6fdcc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/807417a6595f4197a01149f456dfae84.png
[e214993ce4e55979d403ba443084c427.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/b6e08141f3ae4fd68d8ee27ce39de064.png
[e3f3e49168361b57f98a8b824113bc62.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/034d0a0cbdeb4e6f80c0521e78ec50da.png
[92ba4d284f1c0e7006a18d1bdaeb6efa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/6f2d443581e84384b35534ae09605eb5.png
[7b4820535b62071fec676abf4b17e9b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/848df4d04ddb44589ee36e7acc66e470.png
[d63a8ad0240534ba0a9c5f1dbd3ff53d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/a9f352e1c6e5463b912275fce6a5c12b.png
[JNPF]: https://www.jnpfsoft.com/?csdn