C模块兼容Jansson库的优雅方案：解决json_t未定义问题

我有一个C模块foo.c，其中定义了函数：

json_t* foo_to_json(foo_t*);

该模块的使用者可能安装了Jansson库，也可能没有。我通过autoconf进行检测，将结果通过config.h传入，并条件性引入Jansson头文件：

#ifdef HAVE_JANNSON_H
#include <jansson.h>
#endif

为避免在每个调用foo_to_json的地方都加#ifdef，我实现了“降级版本”：

#ifdef HAVE_JANNSON_H

json_t* foo_to_json(foo_t *foo)
{
  <创建并返回json_t>
}

#else 

json_t* foo_to_json(foo_t *foo)
{
  fprintf(stderr, "no JSON support\n");
  return NULL;
}

#endif

现在遇到的问题是：未引入jansson.h时json_t未定义。我知道该头文件中json_t的定义为：

typedef struct json_t { <细节> } json_t;

在公开头文件中加入不完全定义typedef struct json_t json_t;可以编译，但C11前不允许重复typedef，且该头文件会被安装，不想让typedef依赖HAVE_JANNSON_H。现有两种不够优雅的方案：

• 全程用struct json_t*；
• 全程用void*并强制转换。

想知道是否有更优雅的解决方案？

可以在公开头文件（比如foo.h）中添加一段兼容的类型声明，既不依赖HAVE_JANNSON_H宏，又能避免重复typedef的问题：

// 兼容Jansson库的json_t类型声明
#ifndef json_t
typedef struct json_t json_t;
#endif

// 原函数原型保持不变
json_t* foo_to_json(foo_t*);

然后在foo.c中保留原有的条件编译逻辑即可：

#include "foo.h"
#include <stdio.h>
#include "config.h"  // 包含autoconf生成的HAVE_JANNSON_H定义

#ifdef HAVE_JANNSON_H
#include <jansson.h>

json_t* foo_to_json(foo_t *foo)
{
    // 正常创建并返回json_t对象的业务逻辑
}

#else 

json_t* foo_to_json(foo_t *foo)
{
    fprintf(stderr, "no JSON support\n");
    return NULL;
}

#endif

方案优势 #

• 头文件无依赖：公开头文件不需要引入config.h或依赖HAVE_JANNSON_H，可以直接安装给用户，用户无需关心编译检测的宏定义；
• 兼容C标准：通过#ifndef json_t判断，只有当Jansson未定义json_t时才会执行自定义的不完全类型typedef，避免了C11前重复typedef的未定义行为；
• 代码一致性：函数原型保持json_t*的形式，调用方不需要做任何条件编译，直接调用即可，无需切换struct json_t*或void*；
• 合法性保障：未安装Jansson时，json_t作为不完全类型的指针，仅用于声明函数返回值和返回NULL，不会涉及解引用操作，完全符合C语言语法规范。

内容的提问来源于stack exchange，提问作者jjg