嵌入式C保护结构体的方式

原创嵌入式大杂烩 2024-07-24 11:38

精密双向电流感应放大器设计方案 【有奖直播】提升毫米波信号测试精度

评论中之前分享的文章：嵌入式 C 语言知识点，掩码结构体，似乎有些争议？

不知道是因为宏的实现看不懂还是用法不懂？掩码结构体宏的实现本质上就是使用一个掩码数组 chMask 把结构体保护起来。

用法可以结合大佬的PLOOC使用示例及其基于C语言的面向对象编程-傻孩子.pdf（本公众号聊天界面回复：基于C语言的面向对象编程）来一起看：

https://github.com/GorgonMeducer/PLOOC

同样，也可以结合使用不完全类型（Incomplete Types）来保护结构体的方式一起看一下，这个之前有分享过。这里也一起分享下。

C语言中使用不完全类型（Incomplete Types）来保护结构体的方式，主要涉及到在声明结构体时不提供完整的定义，仅在需要时（如在其源文件中）才给出完整的定义。这种方式的的优点和缺点：

优点：

封装性增强：使用不完全类型可以在一定程度上隐藏结构体的内部细节，防止外部代码直接访问结构体的成员，从而提高代码的封装性和安全性。

模块间解耦：通过不完全类型声明，可以在多个模块之间传递结构体的指针，而无需暴露结构体的完整定义。这有助于减少模块间的耦合度，使得系统更加灵活和易于维护。

缺点：

使用限制：不完全类型有一些使用上的限制，比如不能直接使用sizeof运算符来获取不完全类型的大小（因为编译器不知道其完整定义）。这可能导致在需要知道结构体大小的情况下无法使用不完全类型。

容易出错：如果在使用不完全类型时没有正确地提供其完整定义，或者在多个地方提供了不一致的定义，都可能导致编译错误或运行时错误。

什么是不完全类型？

C/C++中不完全类型有三种不同形式：void、未指定长度的数组以及具有非指定内容的结构和联合。使用不完全类型的指针或引用，不需要知道类型的全部内容。比如：

我们常用以下方式声明数组：

extern int array[];

此时的array就是一个不完全类型的数组，一般这样的数组声明会放在.h中，而其定义放在.c中，在定义的时候在给出数组的具体长度，若之后有需要改变数组的长度时，直接改.c里的就可以，对外的.h就保持原样不用修改。

用数组来说明可能还是有点不太好理解，下面我们用结构体的例子来做说明。

在此之前，我们先思考一个问题，我们的结构体实体是在头文件中定义还是源文件中定义呢？

实际上，在头文件、源文件中定义都可以。

下面我们以一个动态数组的管理为例来做一些演示说明。

动态数组，是相对于静态数组而言。静态数组的长度是预先定义好的，在整个程序中，一旦给定大小后就无法改变。而动态数组则不然，它可以随程序需要而重新指定大小。
动态数组的内存空间是从堆（heap）上分配（即动态分配）的。是通过执行代码而为其分配存储空间。当程序执行到这些语句时，才为其分配。程序员自己负责释放内存。使用动态数组的优点是可以根据用户需要，有效利用存储空间。

（1）结构体实体定义在头文件中

比如我们本次的demo有如下三个文件：

此时dynamic_array.h的内容如下：

我们创建了一些接口函数来操作DA对象，我们希望他人可以使用我们的这些接口来操作数据。并且，一般我们使用其它人写的代码时，一般也是优先找到相关头文件，然后调用头文件里提供的对外接口函数。

但是，从这个头文件中，我们不仅仅看到了一些对外接口，还可以看到结构体实体。于是乎，可能就有些人写出这样的代码：

命名有接口可以用，却偏偏有人喜欢直接操作数据，这是比较容易出错的做法。而且调用者推锅的理由很充足：你暴露数据给我，我为什么不可以直接操控你的数据，我就不喜欢用你提供的接口，咋的。。。

所以dynamic_array.h的提供者还是得背锅。

（2）结构体实体定义在源文件中

为了不被推锅，我们把我们的头文件改为：

此时，这里的dynamic_array_def结构类型就是一个不完全类型。

我们把结构体实体定义挪到源文件中，这时候调用者看不到dynamic_array_def里有什么数据了，间接得就可以强迫调用者使用我们提供的接口了。此时如果出问题被推锅，那我们也乐意接锅，乐意查找问题呀。

最后，顺便贴一下本demo工程完整代码，有需要的朋友自取：

dynamic_array.h：

/* 公众号：嵌入式大杂烩 */
#ifndef __DYNAMIC_ARRAY_H
#define __DYNAMIC_ARRAY_H

/* 结构体“重命名” */
typedefstruct dynamic_array dynamic_array_def;

/* 初始化dynamic_array */
dynamic_array_def *DA_Init(void);

/* 销毁dynamic_array */
voidDA_Clean(dynamic_array_def *pThis);

/* 设置dynamic_array长度 */
voidDA_SetSize(dynamic_array_def *pThis, unsigned len);

/* 获取dynamic_array长度 */
unsignedDA_GetSize(dynamic_array_def *pThis);

/* 设置dynamic_array某元素的值 */
intDA_SetValue(dynamic_array_def *pThis, unsigned index, int value);

/* 获取dynamic_array某元素的值 */
intDA_GetValue(dynamic_array_def *pThis, unsigned index, int *pValue);

#endif

dynamic_array.c：

/* 公众号：嵌入式大杂烩 */
#include "dynamic_array.h"
#include 

/* 创建一个动态数组结构体模板 */
struct dynamic_array
{
int*array;
unsigned len;
};

/* 初始化dynamic_array */
dynamic_array_def *DA_Init(void)
{
    dynamic_array_def *pArray =malloc(sizeof(dynamic_array_def));

    pArray->array=NULL;
    pArray->len =0;
}

/* 销毁dynamic_array */
voidDA_Clean(dynamic_array_def *pThis)
{
free(pThis->array);
    pThis->len =0;
free(pThis);
}

/* 设置dynamic_array长度 */
voidDA_SetSize(dynamic_array_def *pThis, size_t len)
{
    pThis->len = len;
    pThis->array=(int*)realloc(pThis->array, pThis->len*sizeof(int));
}

/* 获取dynamic_array长度 */
size_tDA_GetSize(dynamic_array_def *pThis)
{
return pThis->len;
}

/* 设置dynamic_array某元素的值 */
intDA_SetValue(dynamic_array_def *pThis, size_t index, int value)
{
if(index > pThis->len)
{
return-1;
}

    pThis->array[index]= value;
return0;
}

/* 获取dynamic_array某元素的值 */
intDA_GetValue(dynamic_array_def *pThis, size_t index, int *pValue)
{
if(index > pThis->len)
{
return-1;
}

*pValue = pThis->array[index];
return0;
}

main.c

/* 公众号：嵌入式大杂烩 */
#include 
#include 
#include "dynamic_array.h"

intmain(void)
{
int arr_elem =0;

/* 初始化一个动态数组 */
    dynamic_array_def *pArray = DA_Init();

/* 设置数组长度为10 */
    DA_SetSize(pArray,10);

/* 给数组元素赋值 */
for(int i =0; i <10; i++)
{
        DA_SetValue(pArray, i, i);
}

/* 遍历数组元素并打印 */
for(int i =0; i <10; i++)
{
        DA_GetValue(pArray, i,&arr_elem);
printf("%d ", arr_elem);
}

/* 数组清理 */
    DA_Clean(pArray);

return0;
}

编译、运行：