C语言的项目代码的架构设计很少有书籍介绍到,今天来谈论一下一个通用的软件代码架构模型。
项目工程中有include目录和src目录。src目录中的所有文件最终会被生成一个so文件。在部署的时候将这个so文件和include目录中的所有h文件一起发布,这样,当用户程序包含了include目录中的文件后,就能使用其中的API函数了。
接着,就以libssh2.h这个文件做说明。这个文件没有包含任何一个与libssh2功能有关的文件,做到了简洁。同时,诸如
typedef struct _LIBSSH2_SESSION LIBSSH2_SESSION
用户仅仅能使用LIBSSH2_SESSION类型的指针,而不能访问其中的成员。
而struct _LIBSSH2_SESSION 结构的定义位于src目录中的libssh2_priv.h文件中。因为这个目录中的文件没有被发布,所以用户无法使用看不到结构的定义,就无法访问具体成员。libssh2.h,libssh2_priv.h一起合作,很好的实现了细节隔离。
对于libssh2.h中的函数,比如libssh2_init(),它的实现位于global.c文件中,而这个文件包含了libssh2_priv.h文件。所以,有如下包含关系:
libssh2.h <--libssh2_priv.h<-- global.c
libssh2.h 中有很多接口函数,可以分类为全局类的,会话类的等等。所以这些接口的实现分布在文件global.c,session.c,hostkey.c等文件中。这些实现文件中,若需要其他功能,可以包含其他文件。
如下图:
libssh2.h //用户可用的接口声明
^
|
libssh2_priv.h // 内部数据结构的定义
^ ^ ^
| | |
global.c session.c hostkey.c // 功能函数定义
谢谢观赏:)