使用 typedef 结构时的 C 设计风格

Question

当在源文件中使用 typedef 结构并且外部系统需要通过接口连接到此类时，处理输入的正确方法是什么？

一个例子是，如果子系统内的源文件具有

typedef struct
{
    double latitude;
    double longitude;
}
GPSLocation;

并且外部类想要使用以下函数，

void setupGPSSystem(char* navigationSystem, GPSLocation *start, GPSLocation *destination)

可以说我使用接口对其进行抽象，并具有外部类调用的函数。该函数是否应该采用 GPSLocation 类型的参数（从而强制外部系统 #include 包含该结构的源文件，现在不再那么外部），或者最好保留子结构中使用的所有 typedef 结构-system 并因此具有如下接口函数？

void setupGPSSystem(char* navigationSystem, double startLat, double startLong, double destinationLat, double destinationLong)

Answer 1

您可以在接口的公共标头中声明类型，并将结构定义隐藏在实现源文件中。因此，您可能拥有：

gps_system.h:

typedef struct GPSLocation GPSLocation;

void setupGPSSystem(char* navigationSystem, GPSLocation *start, GPSLocation *destination);

gps_system.c:

struct GPSLocation
{
    double latitude;
    double longitude;
}

这样，您就可以两全其美：您的用户可以在接口中使用有意义的类型，并且您的实现是私有的。

Answer 2

在设计模块时，您需要决定该模块的用户是否需要直接访问结构中的字段，这将决定您最终在哪里定义结构。我将描述一些不同的场景：

1。 （模块的）用户将直接操作结构中的 GPS 数据。您别无选择，只能在头文件 (.h) 文件中定义结构作为 API 的一部分。优点是这种技术很简单，并且使用户能够根据需要为结构静态或动态分配内存（因为结构的组成对于其他模块来说是已知的）。缺点是该技术不会隐藏您的数据；它可能被用户有意或无意地破坏。

2.用户并不关心“GPS位置”是什么，它总是使用模块的函数来操作您的数据结构。在这种情况下，您的结构可以是不透明的。您在头文件 (.h) 中声明它，并在源文件 (.c) 中定义它（如 Graham 的答案所述）。优点是您可以隐藏所有数据，这意味着用户无法轻易破坏它或（在专有库的情况下）了解它是如何实现的。缺点是您的模块必须管理不透明类型的分配（和释放）（有关此想法的扩展，请参阅下面的第 3 点）。

gps_system.h

typedef struct _GPSLocation GPSLocation;

void setupGPSSystem(char* navigationSystem, GPSLocation *start, GPSLocation *destination);

gps_system.c

struct _GPSLocation
{
    double latitude;
    double longitude;
}

3.您希望授予用户对某些字段的只读访问权限，但隐藏其他字段。这可能是一种有用的技术，可以隐藏实现细节并防止用户损坏您的数据，同时可以轻松访问有用的数据信息。缺点是您仍然需要模块来管理不透明类型的分配。

gps_system.h

typedef struct
{
    double latitude;
    double longitude;    
}
GPSLocation;

/*  Create a new GPS object. */
void gps_new(GPSLocation **gps);

/*  Set the GPS object's current location. */
void gps_set(GPSLocation *gps, double latitude, double longitude);

/*  Calculate the distance from a GPS coordinate to a different location. */
void gps_distance(GPSLocation *gps, double latitude, double longitude);

/*  Free all memory allocated to a gps object. */
void gps_delete(GPSLocation *gps);

gps_system.c

struct GPSLocation_private
{
    GPSLocation gps_public;

    int field_0;
    int field_1;
};

/** Convert from the public version of the gps object object to the private. */
#define gps_get_private(gps_public)  ((struct GPSLocation_private *)(((char *)(gps_public)) - offsetof(struct GPSLocation_private, gps_public)))

void gps_new(GPSLocation **gps)
{
    struct GPSLocation_private *priv;

    priv = malloc(sizeof(struct GPSLocation_private));

    if (priv)
    {
        priv->field_0 = 1234;
        priv->field_1 = 4567;
        priv->gps_public.latitude = 1111;
        priv->gps_public.longitude = 2222;
        gps = &priv->gps_public;
    }
    else
    {
        *gps = NULL;
    }    
}

void gps_set(GPSLocation *gps, double latitude, double longitude)
{
    struct GPSLocation_private *priv;

    priv = gps_get_private(gps);

    /*  Do stuff with 'priv'. */
}

void gps_delete(GPSLocation *gps)
{
    struct GPSLocation_private *priv;

    priv = gps_get_private(gps);
    free(priv);
}

Answer 3

您的子系统可能（应该）有一个头文件，定义其他人用来访问您的系统的函数原型（API）。在该头文件中定义结构并使用 typedef 完成也没有什么问题。事实上这很常见。这样，只要你的函数原型遵循该原型，就可以了。所以这个：

#ifndef MYSUBSYSTEM_H
#define MYSUBSYSTEM_H

typedef struct
{
    double latitude;
    double longitude;
}
GPSLocation;

void setupGPSSystem(char* navigationSystem, 
                     GPSLocation *start, GPSLocation *destination);

#endif

会是一个很好的标题。在函数中间换行以使其适合 SO。 #include 在链接到您的代码中，您就完成了设置。

Answer 4

GPSLocation 类型属于 API，并且应该位于头文件（以 .h 结尾的文件）中，API 的用户将 #include< /代码>。

Answer 5

您必须为用户#include 提供一个包含接口函数原型的标头，因此您也可以将结构定义粘贴在该标头中。

Answer 6

在有关 C 语言结构的问题中提及“类”可能不是一个热门的想法:-)只是为了避免与 C++ 等可能产生的混淆。

您问“该函数是否应该采用 GPSLocation 类型的参数（从而强制外部系统#include 具有结构的源文件，...”

您编写的函数不采用GPSLocation 类型的参数；它采用 GPSLocation 结构的指针类型的参数（即地址），这是一个非常不同且美妙的事情，

并且非常正确和正确 。 ，您不会强迫任何人 #include 除了定义 GPSLocation 的头文件 (.h) 之外的任何内容，这是因为在您的函数条目中（据我所知）您期望指向 的指针。 因为它们存在于调用程序中，您将通过它们的地址/指针获得每个按引用传递的结构的成员。

实例化 错误，这些结构的副本（开始和结束） ， 到目前为止 在 C 中传递结构的最佳方法 - 通过指向调用程序的这些结构的副本的指针，

永远忘记您给出的第二个选择！