C语言类反射机制实现

• C Reflection
  • 简介
  • 模块
  • 配置
  • 模型定义
  • 对象链表
  • Api
    • C Reflection Api
    • 对象链表Api

C Reflection是一个针对C语言的，类似于高级语言反射机制的实现，C Reflection通过使用数据结构体(Reflection 模型)对C语言结构体进行描述，通过内存直接操作数据

C Reflection本身并没有提供实用的功能，只是对于类反射机制的实现，并提供了几个通用的接口，比如结构体内存释放，基于C Reflection，可以实现一些需要借助反射机制才可实现的实用工具

C Reflection本身不提供实用工具，基于C Reflection实现的工具称之为模块，目前已经实现的模块如下：

C Reflecion需要使用内存管理的函数malloc和free，再使用前，需要在reflection_cfg.h文件中配置这两个函数

/**
 * @brief 内存分配函数
 */
#define REFLECT_MALLOC          malloc

/**
 * @brief 内存释放函数
 */
#define REFLECT_FREE            free

如果不使用标准库的内存管理，只需要对应地修改这两个宏即可

C Reflection使用Reflection 模型对数据进行描述，Reflection 模型是一个结构体数组，成员类型为Reflection，C Reflection定义了一系列宏，可以简化模型的定义

示例如下：

typedef struct
{
    int id;
    char *name;
} Repo;

Reflection repoReflection[] =
{
    REFLECT_MODEL_INT(Repo, id),
    REFLECT_MODEL_STRING(Repo, name),
    REFLECT_MODEL_OBJ(Repo),
}

结构体Repo共有两个成员，整型数据id和字符串name，使用Reflection 模型对这个结构体中的每个成员进行描述，在模型最后，需要加上REFLECT_MODEL_OBJ(Repo)，表示模型的结束

C Reflection模型定义相关的宏说明如下：

为了方便操作，C Reflection实现了一个链表，C Reflecion以及使用C Reflection实现的模块都使用这个链表进行操作

typedef struct obj_lsit
{
    void *obj;                                  /**< 对象 */
    struct obj_lsit *next;                      /**< 下一个节点指针 */
} ObjList;

C Reflection源文件有完整的注释，可以通过Doxygen等工具导出完整的API文档，以下是几个关键API的说明

C Reflection的Api主要提供了几个基础的操作接口，包括字符串复制，对象内存释放等

• 新字符串(字符串复制)

  从原字符串复制新的字符串，方便使用C Reflection内存操作

  /**
   * @brief 新字符串(字符串复制)
   *
   * @param str 原字符串
   * @return char* 复制得到的新字符串
   */
  char *reflectNewString(char *str);

  • 参数

    • str 原字符串

  • 返回

    • char * 复制得到的新字符串

• 释放对象内存

  使用Reflection 模型一次性释放结构体(包含子结构体)所有关联内存

  /**
   * @brief 释放对象内存
   *
   * @param obj 对象
   * @param model Reflection 模型
   */
  #define reflectFreeObj(obj, model) \
          reflectFreeObjEx(obj, model, 1)

  • 参数
    • obj 对象
    • model Reflection 模型

• 释放数据内存

  释放数据内存

  /**
   * @brief 释放内存
   *
   * @param mem 内存
   */
  #define reflectFreeMem(mem) \
          REFLECT_FREE(mem)

  • 参数
    • mem 内存

对象链表Api用于操作对象链表，包括对象的添加，删除等

• 对象添加

  向对象链表中添加新的对象

  /**
   * @brief 对象链表添加对象
   *
   * @param list 链表
   * @param obj 对象
   * @return ObjList* 链表
   */
  ObjList *objListAdd(ObjList *list, void *obj);

  • 参数

    • list 链表
    • obj 待添加的对象

  • 返回

    • Objlist * 添加对象后的链表

• 对象删除

  从对象链表中删除对象

  /**
   * @brief 对象链表删除对象
   *
   * @param list 链表
   * @param obj 待删除的对象
   * @return ObjList* 对象删除后的链表
   */
  ObjList *objListDel(ObjList *list, void *obj);

  • 参数

    • list 链表
    • obj 待删除的对象

  • 返回

    • Objlist * 删除对象后的链表