用C语言实现interface

本文是C语言封装设计的第四篇文章，前三篇请见《C 语言面向对象的封装方式》、《 C语言面向对象的封装方式(示例)》和《C语言数据结构的封装方法》。

本文介绍C语言中如何实现接口(interface)，应用场景为：

多个提供者提供的服务接口函数完全相同，但实现不同，因而在性能、可靠性等方面有所差异。比如，两个HashMap的实现，一个性能非常快，但内存占用大；另一个内存占用非常少，但性能一般。但二者提供的服务接口函数都是一样的，如get、put等。

通过interface，我们可以把服务提供者的服务界面抽象成一致的函数群，调用者只需要对接口进行编程即可，无需关心接口下面的具体实现。这是对函数群的封装。

接口(interface)技术，是非常强大的技术。通过接口，调用者可以在对服务提供者完全无感知，甚至调用者的代码写完之后，还可以继续增加新的服务提供者，无需调用者的代码做任何更改。比如，一个操作系统需要管理各种文件系统，但文件系统的种类是非常多的，无法把每一种文件系统都写入操作系统的内核中，因此内核可以对文件系统进行接口抽象，只要满足了这个接口要求，后续新的文件系统都可以注册进内核，无需对内核的代码进行任何修改。

与上面类似的业务场景，非常多，比如I/O的多种调度策略、复杂服务程序支持的各种插件接口、GUI界面对Window、Widget的接口抽象等等。

我们用文件系统的场景，来展示C语言中如何设计和实现接口。
操作系统内核是调用者，各种文件系统是服务实现者，这些文件系统都实现了如下接口：

interface IFileSystem {
    int create_file(const char* path, int flags, int mode);
    int open_file(const char* path, int flags);
    int read_file(int fd, char* buf, int len);
    int write_file(int fd, const char* buf, int len);
    int close_file(int fd);
    // ...
}

C语言中，没有interface这个语法，因此上面的代码在C语言中，需要用struct 来实现。具体包括：
1. 每个接口函数，需要声明一个单独的函数指针类型；
2. 整个interface的方法集，用一个struct来表示，struct的成员为各个函数指针
3. 每个文件系统的实现者，各自需要一个struct来表示，这个struct的类型对调用者不可见。各个文件系统有自己的struct结构，彼此互不相同，也互不可见。
4. 接口的实现，包括两部分：1）接口函数的实现；2）文件系统的struct实例。这两部分放在一起，构成了接口的实现。我们用一个struct来把这两部分组合在一起。
5. 由于各个文件系统的struct结构，对调用者不可见，因此文件系统用void*把自己的struct指针传递给调用者。

具体的代码实现，如下：(为了保持篇幅简洁，只列了open_file和read_file 两个方法)

//fs_interface.h
#ifndef FS_INTERFACE_H
#define FS_INTERFACE_H

// 接口函数指针类型
typedef int (*open_file_fn)(void* pfs, const char* path, int flags);
typedef int (*read_file_fn)(void* pfs, int fd, char* buf, int len);


// 接口方法集
typedef struct fs_methods_t {
        open_file_fn open_file;
        read_file_fn read_file;
} fs_methods_t;

// 接口的实现体
typedef struct file_system_interface {
        void* pfs;                              // 文件系统的具体实现struct
        fs_methods_t* pmethods; // 这个文件系统的具体接口方式实现
} file_system_interface;

// 各个文件系统，通过 register_file_system 将自己注册进内核
// const char* pname;           // 文件系统的名称，如ext2, xfs...
int register_file_system(const char* pname, file_system_interface fsi);

上面的代码中，有几个地方需要注意：
1）每个接口函数类型声明中，都比interface中的函数多了一个参数：void* pfs, 这个参数指向具体的文件系统的struct。
   这样，内核才能真正对这个struct对象发起调用。
2）file_system_interface 是interface的具体实现体，里面包含2个指针：一个是指向文件系统实现体struct的指针pfs, 另一个指针指向文件系统实现的接口函数的集合。这样，interface就是一个简单的struct，可以像简单变量一样声明、赋值和参数传递，其按值拷贝传递即可，无需传指针引用。

这样，通过 file_system_interface，内核就可以对文件系统发起调用。例如，调用ext2 文件系统的open_file:

// find ext2 file_system_interface by name "ext2"
file_system_interface fsi = ....
// call open_file
int fd = fsi.pmethods->open_file(fsi.pfs, path, flags);
return fd;

再看看 ext2 文件系统，如何实现这个接口：
ext2_fs.h 的内容如下：

// ext2_fs.h
#ifndef EXT2_FS_H
#define EXT2_FS_H

#include "fs_interface.h"

typedef struct ext2_fs_t {
        // ......
} ext2_fs_t;

int ext2_open_file(ext2_fs_t* pfs, const char* path, int flags);
int ext2_read_file(ext2_fs_t* pfs, int fd, char* buf, int len);

int ext2_init(void);

#endif

ext2_fs.c 的实现代码：

// ext2_fs.c
#include "ext2_fs.h"

// 接口方法实现集合
fs_methods_t ext2_methods = {
    .open_file = (open_file_fn)ext2_open_file,
    .read_file = (read_file_fn)ext2_read_file,
};

// 服务实例
ext2_fs_t g_ext2_fs;

int ext2_init(void) {
    // init g_ext2_fs struct ....
    // ....

    file_system_interface fsi = { .pfs = &g_ext2_fs, .pmethods = &ext2_methods };
    int ret = register_file_system("ext2", fsi);
    return ret;
}


int ext2_open_file(ext2_fs_t* pfs, const char* path, int flags) {
    // ....
}

int ext2_read_file(ext2_fs_t* pfs, int fd, char* buf, int len) {
    // ....
}

其它文件系统，如xfs，ext4等，实现的代码与上面的ext2类似，这样就都可以注册进内核中。通过接口，内核可以对这些实现无感知。

接口，是非常强大的封装手段，在业务场景中经常遇到，希望通过本文的代码展示，让大家都学会这种技术。

我的微信号 "实力程序员"，欢迎大家关注我。