C 结构信息隐藏（不透明指针）答案

【问题标题】：C struct information hiding (Opaque pointer)C 结构信息隐藏（不透明指针）
【发布时间】：2020-05-17 06:10:54
【问题描述】：

我目前对 C-struct 的信息隐藏概念有点困惑。

本题背景是一个嵌入式c项目，OOP知识几乎为零。

到目前为止，我总是在相应模块的头文件中声明我的 typedef 结构。所以每个想要使用这个结构的模块都知道结构类型。

但经过 MISRA-C 检查后，我发现了中等严重性警告：MISRAC2012-Dir-4.8 - 结构的实现不必要地暴露给翻译单元。

经过一番研究，我通过将结构成员的可见访问限制在私有范围内，发现了 C 结构信息隐藏的概念。

我立即尝试了一个简单的示例，如下所示：

struct_test.h

//struct _structName;

typedef struct _structName structType_t;

struct_test.c

#include "struct_test.h"

typedef struct _structName
{
    int varA;
    int varB;
    char varC;
}structType_t;

main.c

#include "struct_test.h"

structType_t myTest;

myTest.varA = 0;
myTest.varB = 1;
myTest.varC = 'c';

这会产生编译器错误，即对于 main.c，myTest 的大小是未知的。当然是的，main.c 只知道 structType_t 类型的结构存在，没有别的。

于是我继续研究，偶然发现了不透明指针的概念。

于是我又尝试了第二次：

struct_test.h

typedef struct _structName *myStruct_t;

struct_test.c

#include "struct_test.h"

typedef struct _structName
{
    int varA;
    int varB;
    char varC;
}structType_t;

main.c

#include "struct_test.h"

myStruct_t myTest;

myTest->varA = 1;

我得到编译器错误：取消引用指向不完整类型struct _structName的指针

显然我还没有理解这种技术的基本概念。我的主要困惑是结构对象的数据将在哪里？

到目前为止，我的理解是，指针通常指向数据类型的“物理”表示，并在相应地址上读取/写入内容。

但是使用上面的方法，我声明了一个指针 myTest 但从未设置它应该指向的地址。

我从这篇文章中得到了这个想法： What is an opaque pointer in C?

在帖子中提到，访问是通过 set/get 接口方法处理的，所以我尝试添加一个类似的方法：

void setVarA ( _structName *ptr, int valueA )
{
  ptr->varA = valueA;
}

但这也不起作用，因为现在他告诉我_structName 是未知的...... 那么我只能在其他接口方法的帮助下访问该结构吗？如果可以，我该如何在我的简单示例中实现这一点？

我更大的问题仍然是我的结构对象在内存中的位置。我只知道指针的概念：

varA - 地址：10 - 值：1

ptrA - 地址：22 - 值：10

但在这个例子中我只有

myTest - 地址：xy - 值：??

我无法理解相应myTest 指针的“物理”表示在哪里？

此外，在我是模块的生产者和消费者的相对较小范围的嵌入式项目中，我看不到这样做的好处。

如果这种方法对于有 1-2 名开发人员使用代码的中小型嵌入式项目是否真的合理，有人可以解释一下吗？目前，制作所有这些接口指针方法似乎比仅仅在我的头文件中声明结构更努力。

提前谢谢你

【问题讨论】：

指针的不透明版本的类型为void *，在需要时转换为真正的指针类型。
Here is a complete example.。对于嵌入式系统（和 MISRA-C），虽然不能使用 malloc，但必须实现自己的静态内存池，example。
“此外，在我是模块的生产者和消费者的相对较小范围的嵌入式项目中，我看不到这样做的好处。”当您实现有点复杂的 ADT 时，特别是如果是 HAL 的一部分，考虑到可移植性，这很有意义。例如，当我制作库质量、跨平台的 CAN 总线 HAL 时，我使用 opaque 类型。然后，不透明结构将包含特定的硬件外围数据并放置在特定驱动程序中，位于比 HAL 更低的级别。 ->
对于像项目特定的 SPI 和 UART 等更简单的东西，我通常不会为 HAL 和不透明类型而烦恼，而只是用零可移植性和代码重用对整个东西进行硬编码。什么时候使用它，什么时候不使用它取决于系统设计经验，因此，它是相当主观的。至于 MISRA-C 对此有一个指令，主要目的是教育并让您了解。请注意，Dir 4.8 是建议性的，因此您可以根据具体情况应用它。
感谢您的回答，因为我的项目并不大，我们也不需要如此大规模的独立性，我会看看我们是否可以像 Lundin 暗示的那样打破这条规则 :)

标签： c struct misra information-hiding opaque-pointers

【解决方案1】：

我的主要困惑是结构对象的数据将在哪里？

关键是您不要在其他翻译单元中使用struct 表示（即其大小、字段、布局等），而是调用为您完成工作的函数。你需要使用一个不透明的指针，是的。

如何在我的简单示例中实现这一点？

您必须将所有使用结构字段（真正的结构）的函数放在一个文件（实现）中。然后，在标头中，仅公开接口（您希望用户调用的函数，以及那些采用不透明指针的函数）。最后，用户将使用标头仅调用那些函数。他们将无法调用任何其他函数，也无法知道结构内部的内容，因此尝试执行此操作的代码将无法编译（这就是重点！）。

此外，在我是模块的生产者和消费者的相对较小范围的嵌入式项目中，我看不到这样做的好处。

这是一种强制模块相互独立的方法。有时它用于向客户隐藏实现或能够保证 ABI 稳定性。

但是，是的，对于内部使用，这通常是一种负担（并且会阻碍优化，因为除非您使用 LTO 等，否则一切都会成为编译器的黑匣子）。在 C++ 等其他语言中，像 public/private 这样的句法方法更好。

但是，如果您必须遵守 MISRA 到这样的程度（即，如果您的项目必须遵守该规则，即使它只是建议性的），您也无能为力。

如果这种方法对于 1-2 名开发人员使用代码的中小型嵌入式项目是否真的合理，有人可以解释一下吗？

这取决于你。有非常个大型项目没有遵循该建议并取得了成功。通常，对私有字段的注释或命名约定就足够了。

【讨论】：

实际上没有必要让所有函数都使用一个文件中的结构字段，这在复杂情况下可能会变得非常庞大。或者，您可以将结构定义放在不公开的内部标头中。
“但是，如果您一定要遵循 MISRA，您无能为力。”关于不透明类型的指令是建议性的——主要目的是教育程序员。您可以在不使用 opaque 类型的情况下符合 MISRA。
@Lundin 确实，我会澄清我的意思。
@IngoLeonhardt 当然，但我在这里简化，因为 OP 不了解编译模型，而且他/她的“简单示例”只是一些功能，我想。
感谢您的回答 :) 我现在明白了这项技术的意义所在。但是我会再次检查我是否需要 100% 投诉，或者我是否可以对这条规则进行例外处理，并仔细检查我们当前的方法有多“干净”。

【解决方案2】：

正如您所推断的，当使用诸如此类的不透明类型时，主源文件无法访问结构的成员，实际上也不知道结构有多大。正因为如此，你不仅需要访问函数来读取/写入结构的字段，还需要一个函数来为结构分配内存，因为只有库源知道结构的定义和大小。

所以你的头文件将包含以下内容：

typedef struct _structName structType_t;

structType_t *init();
void setVarA(structType_t *ptr, int valueA );
int getVarA(structType_t *ptr);
void cleanup(structType_t *ptr);

此接口允许用户创建结构的实例、获取和设置值以及清理它。库源代码如下所示：

#include "struct_test.h"

struct _structName
{
    int varA;
    int varB;
    char varC;
};

structType_t *init()
{
    return malloc(sizeof(structType_t ));
}

void setVarA(structType_t *ptr, int valueA )
{
    ptr->varA = valueA;
}

int getVarA(structType_t *ptr)
{
    return ptr->varA;
}

void cleanup(structType_t *ptr)
{
    free(ptr);
}

请注意，您只需定义一次typedef。这既定义了类型别名，又声明了结构。然后在源文件中出现的实际结构定义没有 typedef。

调用者使用init 函数为结构分配空间并返回指向它的指针。然后可以将该指针传递给 getter / setter 函数。

所以现在你的主代码可以像这样使用这个接口了：

#include "struct_test.h"

int main()
{
    structType_t *s = init();
    setVarA(s, 5);
    printf("s->a=%d\n", getVarA(s));
    cleanup(s);l
}

【讨论】：

谢谢，这帮助我更好地理解了这个概念:)
我使用相同的示例来运行代码，但是 gcc test.c（主文件）在所有函数上都给出了未定义的引用错误。我做错了什么？
@trail99 您需要将多个源文件链接在一起，即gcc -o myprog test.c struct_test.c
请注意，建议的方法使用动态内存分配违反了 MISRA-C 指令 4.12。据我所知，当涉及到隐藏对象成员时，这是一个“挑你的毒”的问题。

【解决方案3】：

在帖子中提到，访问是通过 set/get 接口方法处理的，所以我尝试添加一个类似的方法：
void setVarA ( _structName *ptr, int valueA )
{
  ptr->varA = valueA;
}
但这也不起作用，因为现在他告诉我_structName 是未知的......

类型不是_structName，而是struct _structName 或（定义）structType_t。

我更大的问题仍然是我的结构对象在内存中的位置。

使用这种技术，将有一个方法返回这种不透明对象的地址。它可以是静态或动态分配的。当然也应该有释放对象的方法。

此外，在我是模块的生产者和消费者的相对较小范围的嵌入式项目中，我看不到这样做的好处。

我同意你的看法。

【讨论】：