将结构划分为私有部分和公共部分？

Question

在 C++ 和 Java 中，数据结构可以具有私有、公共和受保护区域。我想将这个概念移植到我正在编写的 C 语言程序中。

在 C 结构体中是否有实现私有或受保护函数指针和数据字段的习惯用法？ 我知道 C struct 是公共的，我正在寻找一种习惯用法来帮助隐藏一些实现细节并强制用户使用公共接口。

注意：该语言已由商店选择，因此我一直在将面向对象的概念实施到 C 中。

谢谢。

Answer 1

如您所知，您不能这样做。然而，有一些习语可以达到类似的效果。

C 将允许您做一些类似于面向对象设计中所谓的“pimpl”惯用法的事情。您的结构可以有一个不透明的指针，指向另一个向前声明的结构，该结构充当该结构的私有数据。对结构进行操作的函数代替成员函数，可以拥有私有成员的完整定义，并且可以使用它，而代码的其他部分则不能。例如：

在标头中，foo.h：

  struct FooPrivate;

  struct Foo {
     /* public: */
       int x; 
       double y;
     /* private: */
       struct FooPrivate* p;
  };

  extern struct Foo* Foo_Create(); /* "constructor" */

  extern void Foo_DoWhatever(struct Foo* foo); /* "member function" */

在实现中，foo.c：

  struct FooPrivate {
     int z;
  };

  struct Foo* Foo_Create()
  {
     struct Foo* foo = malloc(sizeof(Foo));

     foo->p = malloc(sizeof(FooPrivate));

     foo->x = 0;
     foo->y = 0;
     foo->p->z = 0;

     return foo;
  }

  void Foo_DoWhatever(struct Foo* foo) 
  {
      foo->p->z = 4; /* Can access "private" parts of foo */
  }

在程序中：

  #include "foo.h"

  int main()
  {
      struct Foo* foo = Foo_Create();

      foo->x = 100; /* Can access "public" parts of foo */
      foo->p->z = 20; /* Error! FooPrivate is not fully declared here! */

      Foo_DoWhatever(foo); /* Can call "member" function */

      return 0;
  }

请注意，需要使用“构造函数”函数以便为私有数据分配内存。显然，您需要将其与特殊的“析构函数”函数配对，以便正确地释放私有数据。

或者，如果您希望您的结构没有任何公共字段，您可以使整个结构不透明，并且只需让标头类似于

  struct Foo;

  extern struct Foo* Foo_Create(); /* "constructor" */

  extern void Foo_DoWhatever(struct Foo* foo); /* "member function" */

struct Foo的实际定义 在 foo.c 中，并且 getter 和 setter 函数可用于您想要提供直接访问的任何属性。

Answer 2

C 中有时使用的概念是：

// lib.h
typedef struct {
  int publicInt;
  //...
  char * publicStr;
} Public;

Public * getPublic();
int function(Public * public);

// lib.c

typedef struct {
  Public public;
  int privateInt;
  // ...
  char * privateStr
} Private;

static Private * getPrivate();

Public * getPublic() { return (Public*) getPrivate(); }
int function(Public * public) {
  Private * private = (Private *) public;
  // ...
}

这使用了标准技巧，即指向结构的指针可以与指向结构中第一个元素的指针互换。

如果您希望所有字段都是私有的，那就更简单了：

// lib2.h
typedef struct AllPrivate * Handle;
Handle getHandle();
int function2(Handle handle);

// lib2.c
struct AllPrivate { /* ... */ }

#include lib2.h 的文件不会抱怨，因为我们只使用 struct AllPrivate *，并且所有指针的大小相同，因此编译器不需要了解struct AllPrivate的内部结构。

要创建受保护区域，您只需定义

// include/public.h
struct Public { /* ... */ }
struct Public * getPublic();
int somePublicFunction(struct Public *);

// dev/include/protected.h
struct Protected { struct Public public; /* ... */ }
struct Protected * getProtected();
int someProtectedFunction(struct Protected *);

// dev/src/private.c
struct Private { struct Protected protected; /* ... * /}
struct Public * getPublic() { return (struct Public *) getPrivate(); }
struct Public * getProtected() { return (struct Protected *) getPrivate(); }
int somePublicFunction(struct Public * public) { 
  struct Private private = (struct Private *) public;
  // ...
}
int someProtectedFunction(struct Protected * protected) { 
  struct Private private = (struct Private *) protected;
  // ...
}

然后只需确保 dev/include 不被传递即可。

Answer 3

对于数据字段——只是不要使用它们。你可以采取一些技巧，比如给它们起一些疯狂的名字来阻止它们的使用，但这并不能阻止人们。唯一真正的方法是创建另一个私有结构，库函数可以通过 void 指针访问该结构。

对于私有函数——使用文件静态函数。将所有库函数放入一个 C 文件中，并将要设为私有的库函数声明为 static，并且不要将它们放入任何头文件中。

Answer 4

通常按照约定，私有成员的名称中会有一个额外的下划线，或者附加类似 _pri 的内容。或者可能是一条评论。这项技术不会进行编译器强制检查以确保没有人不当访问这些字段，而是向任何阅读 struct 声明的人发出警告，表明内容是实现细节，他们不应该偷看或者戳他们。

另一种常见的技术是将结构公开为不完整类型。例如，在您的头文件中，您可能具有：

struct my_struct;

void some_function(struct my_struct *);

在实现中，或者库的使用者无法访问的某些内部头文件中，您具有：

struct my_struct
{
    /* Members of that struct */
};

您还可以使用 void 指针执行类似的技巧，将其强制转换为右侧放置在代码的“私有”部分。这种方法失去了一些灵活性（例如，您不能拥有未定义类型的堆栈分配实例），但这可能是可以接受的。

如果您想要混合使用私有和公共成员，则可以执行与上述相同的操作，但将私有结构指针存储为公共结构指针的成员，并在库的公共使用者中保留不完整的结构指针。

尽管如此，这引入了一些间接性，这可能会损害性能。您也可以使用一些（通常不可移植，但适用于合理的编译器）类型双关技巧：

struct public_struct
{
   int public_member;
   int public_member2;
   /* etc.. */
};

struct private_struct
{
   struct public_struct base_members;

   int private_member1;
   int private_member2;
};

void some_function(struct public_struct *obj)
{
   /* Hack alert! */
   struct private_struct *private = (struct private_struct*)obj;
}

这还假设您无法将这些对象存储在堆栈或静态存储中，或者无法在编译时获取大小时间。

Answer 5

我为你感到遗憾，因为将不同的 OO 概念混入 C 中通常就像圆孔中的方钉一样。话虽这么说，GObject 支持公共和私有成员，但它是我最不喜欢的体系结构之一。如果您不关心较小的性能影响，您也许可以采取更简单的解决方案 - 有一个充满私有成员的辅助结构，并有一个从主（公共）结构指向该结构的匿名指针。