为什么“屎山”代码有时却异常稳定？

关注公众号，回复“入门资料”获取单片机入门到高级开挂教程

 开发板带你入门，我们带你飞

文 | 无际（微信:2777492857）

全文约3790字，阅读大约需要 10 分钟

相信工程师有这样的经历，接手别人写的代码，都会抱怨：“这代码简直是坨屎山“。

但有些屎山代码却能稳如老狗！几年不崩。

这事在单片机开发里尤其常见，你可能也遇到过：接手一个老项目，代码看得头皮发麻，但跑起来却一点毛病没有。是不是挺好奇？

刚毕业那几年，我也经常写屎山代码，给各位看官欣赏下。

一、什么是“屎山”代码？

“屎山”代码，顾名思义，就是指那些结构混乱、逻辑复杂、可读性极差，让人望而生畏的代码。它可能是历史遗留问题，也可能是赶工期下的产物，其特点如下：

•巨无霸文件：几千甚至上万行代码塞在一个文件里，找个变量像大海捞针。

•命名混乱：变量名像乱码，函数名让人摸不着头脑，比如a1、b2、flag_temp1、function_xyz。    

•注释缺失：代码里空空如也，没有注释，只有作者留下的谜团。

•过度耦合：各个模块之间你中有我，我中有你，牵一发而动全身。

•逻辑复杂：各种if-else和goto满天飞，让你怀疑人生。

如果你对以上描述感到熟悉，那么恭喜你，你可能已经身处“屎山”之中了！别担心，你不是一个人在战斗。

二、为何“屎山”代码有时反而稳定？

按理说，这么糟糕的代码应该bug满天飞才对，但为什么有些“屎山”代码反而异常稳定，甚至能跑好几年？这背后其实有一些原因：

1.久经考验，bug已尽

想象一下，一座老房子，虽然外表破旧不堪，但经过多年的风吹雨打，该掉的砖瓦早就掉光了，剩下的结构反而更加稳固。

“屎山”代码也一样，经过长时间的运行，各种潜在的bug可能已经被触发和修复了，剩下的都是经过验证的核心逻辑。

就好比一个老司机，虽然开的是辆破车，但对每个零件的脾气都了如指掌，反而不容易出事故。

例子：我曾经接手过一个老项目，代码简直惨不忍睹。但研发经理说，这个项目已经卖了好几年了，很少出问题。仔细分析后发现，很多bug早在项目初期就被解决了，剩下的都是经过时间验证的“稳定”代码。

2.硬件耦合，难以迁移    

单片机软件和硬件紧密结合。有些“屎山”代码之所以稳定，是因为它和特定的硬件环境高度耦合。

代码里的各种魔术数字和特殊处理可能都是为了适配特定的硬件特性。

一旦你尝试修改代码或者更换硬件，就可能引发意想不到的问题。

就好比一个生态系统，虽然看起来混乱，但各个物种之间已经形成了微妙的平衡，任何轻微的改变都可能导致整个系统崩溃。

例子：我见过一个项目，代码里直接操作特定型号传感器的寄存器地址。虽然这种做法非常不规范，但它能保证传感器在特定环境下稳定工作。一旦更换传感器型号，就需要修改大量的代码，而且很难保证兼容性。

// 这是一个反面的例子！直接操作寄存器地址，缺乏可移植性#define SENSOR_DATA_REG  0x40001234  // 传感器数据寄存器地址uint16_t getSensorData() {  return *((volatile uint16_t *)SENSOR_DATA_REG);}

3.过度自信，不敢触碰

维护“屎山”代码的工程师往往有一种莫名的恐惧感。他们知道代码很烂，但又不敢轻易修改，生怕引入新的bug。

这种心态导致代码长期处于“冻结”状态，即使有问题也选择视而不见。这就像一个定时炸弹，你知道它存在，但你不敢拆解，只能祈祷它永远不会爆炸。

4.中断处理，异步驱动

单片机系统通常使用中断来处理各种事件。“屎山”代码中可能存在一些不规范的中断处理逻辑，例如在中断服务程序中进行耗时操作，或者多个中断共享资源。

虽然这些做法不推荐，但在某些情况下，它们可能反而能保证系统的实时性。就好比一个交通网络，虽然交通规则混乱，但司机们凭借经验和直觉也能勉强维持秩序。

例子：比如在代码里直接在串口中断服务程序中发送大量数据。虽然这种做法会导致中断延迟，但在特定的波特率和数据量下，它能保证数据传输的实时性。如果改为使用DMA方式发送数据，反而可能引入新的问题。

// 这是一个反面的例子！在中断中进行耗时操作，可能导致中断延迟void USART1_IRQHandler(void) {  if (USART_GetITStatus(USART1, USART_IT_RXNE) != RESET)   {    uint8_t data = USART_ReceiveData(USART1);    // 假设要发送一个很长的字符串    char long_string[] = "This is a very long string to send...";    for (int i = 0; long_string[i] != '\0'; i++)     {      USART_SendData(USART1, long_string[i]);      while (USART_GetFlagStatus(USART1, USART_FLAG_TXE) == RESET); // 等待发送完成    }    USART_ClearITPendingBit(USART1, USART_IT_RXNE);  }}

三、维护“屎山”代码，步步惊心：工程师的噩梦

虽然“屎山”代码有时能保持稳定，但这并不意味着我们可以放任不管。维护“屎山”代码是一个痛苦的过程，它充满了挑战和风险：

•理解困难：阅读“屎山”代码就像在迷宫中穿行，你不知道下一步会走到哪里，也不知道哪里是出口。

•修改风险：修改“屎山”代码就像拆除一座危楼，你不知道哪块砖头会引发连锁反应，导致整个系统崩溃。

•测试困难：由于代码的复杂性和耦合性，很难编写有效的测试用例来覆盖所有可能的场景。

•扩展困难：在“屎山”代码的基础上添加新功能就像在沼泽地上盖房子，你不知道地基是否牢固，也不知道房子会不会塌陷。

四、如何与“屎山”代码和平共处？避坑指南来啦！

既然我们无法避免接触“屎山”代码，那么如何才能与它和平共处，并尽可能地减少维护成本和风险呢？这里有一些建议：

1.敬畏之心，谨慎评估

不要轻视“屎山”代码的稳定性，在修改之前，一定要进行充分的评估，了解代码的逻辑和依赖关系。如果你不确定修改会带来什么影响，最好先备份代码，并在测试环境中进行验证。记住，不求有功，但求无过！    

2.模块封装，隔离风险

将“屎山”代码分解成小的模块，并使用接口进行封装。这样可以隔离风险，减少修改对其他模块的影响。就好比给老房子加固，先从局部开始，逐步改善整体结构。

例子：如果你的“屎山”代码包含多个外设驱动，可以将每个外设驱动封装成一个独立的模块，并使用统一的接口进行访问。这样，即使你需要修改某个外设驱动，也不会影响其他外设驱动的正常工作。

// 原始的屎山代码，所有代码都在一个文件里// (为了简洁，这里只展示部分代码)void processSensorData() {  // 读取传感器数据 (直接操作寄存器)  uint16_t rawData = *((volatile uint16_t *)0x40001234);  // 数据处理逻辑...  float temperature = (float)rawData * 0.1;  // 显示温度...  displayTemperature(temperature);}void displayTemperature(float temp) {  // 控制LCD显示温度...  // (代码省略)}// 重构后的代码，将传感器驱动封装成一个模块// sensor.h#ifndef SENSOR_H#define SENSOR_Hfloat getTemperature();#endif// sensor.c#include "sensor.h"float getTemperature() {  // 读取传感器数据 (封装成函数)  uint16_t rawData = readSensorRawData();  return (float)rawData * 0.1;}uint16_t readSensorRawData() {  // 直接操作寄存器，但封装在模块内部  return *((volatile uint16_t *)0x40001234);}// main.c#include "sensor.h"void processSensorData() {  float temperature = getTemperature();  displayTemperature(temperature);}void displayTemperature(float temp) {  // 控制LCD显示温度...  // (代码省略)}

说明：通过将传感器驱动相关的代码封装到sensor.c和sensor.h文件中，我们将对硬件的操作隐藏起来，降低了代码的耦合性，提高了可维护性。

3.建立防护网，测试先行

在修改代码之前，编写测试用例来覆盖现有的功能。修改完成后，运行测试用例来验证代码是否仍然正常工作。这就像给老房子安装安全网，防止拆除过程中掉落的碎石伤到人。

例子：假设你要修改上面sensor.c中的readSensorRawData()函数，可以先编写一个测试用例，验证在不同的输入条件下，getTemperature()函数是否返回正确的结果。

4.逐步重构，积少成多

不要试图一次性重构整个“屎山”代码，这几乎是不可能完成的任务。可以采用逐步重构的方式，每次只修改一小部分代码，并进行充分的测试。这就像给老房子装修，先从一个房间开始，逐步改善整体环境。

5.拥抱文档，胜过猜测

如果“屎山”代码有文档，一定要仔细阅读。即使文档已经过时，也能帮助你了解代码的原始意图。

如果没有文档，可以尝试通过代码分析工具来生成文档。这就像给老房子找来设计师，了解房屋的结构和历史，才能更好地进行改造。

6.团队协作，集思广益

维护“屎山”代码需要团队协作。可以邀请其他工程师参与代码审查，共同寻找潜在的问题和解决方案。这就像给老房子找来多个建筑工人，集思广益，共同解决难题。

五、避免成为“屎山”的制造者

维护“屎山”代码是一个痛苦的过程，但更重要的是，我们要避免成为“屎山”的制造者。以下是一些建议，帮助你编写高质量的代码：

•清晰命名，见名知意：使用有意义的变量名和函数名，让代码更容易理解。

•适当注释，解释意图：在关键代码段添加注释，解释代码的意图和逻辑。

•模块化设计，降低耦合：将代码分解成小的模块，并使用接口进行封装。

•代码规范，统一风格：遵循统一的代码规范，保持代码风格一致。

•测试驱动，保证质量：在编写代码之前，编写测试用例，并确保代码通过测试。

•持续集成，及时发现：使用持续集成工具，自动化构建和测试过程，及时发现问题。

六、总结

“屎山”代码虽然乱，但它的稳定性是时间和经验的结晶。

作为单片机工程师，咱们得学会尊重这种“老古董”，但也不能迷恋它。

正确的姿势是：理解它的稳定之道，用策略维护它，逐步改进它。

下次再遇到“屎山”，别急着骂街，试着理解它。你会发现，即使是“屎山”，也有它的故事和智慧。毕竟，在工程世界里，能稳定解决问题，就是最大的美德！

end

下面是更多无际原创的个人成长经历、行业经验、技术干货。

1.电子工程师是怎样的成长之路？10年5000字总结

2.如何快速看懂别人的代码和思维

3.单片机开发项目全局变量太多怎么管理？

4.C语言开发单片机为什么大多数都采用全局变量的形式？

5.单片机怎么实现模块化编程？实用程度让人发指！

6.c语言回调函数的使用及实际作用详解

7.手把手教你c语言队列实现代码，通俗易懂超详细！

8.c语言指针用法详解，通俗易懂超详细！