代码组织：跨平台开发的架构设计与实践-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_42571280/article/details/146941911

跨平台代码组织：QF框架的架构与实践

背景简介

在软件开发中，跨平台兼容性是一个重要议题。它要求开发者在保持软件核心功能不变的同时，适应不同操作系统的特性。本文将探讨如何通过合理的代码组织，实现跨平台软件的高效开发。我们将以Quantum Framework（QF）为例，深入解析其代码结构和构建过程，揭示其跨平台设计的精妙之处。

平台独立与依赖的代码组织

QF框架采用了清晰的代码组织策略，将代码分为平台独立（PI）和平台依赖（PD）两部分。这种结构不仅提升了代码的可读性，还便于管理和维护。

平台独立的代码

对于平台独立的代码，QF框架将其放置在 Cpp/Qf/Source 目录下，并在所有相关文件中包含 port.h 头文件。这些头文件和实现文件属于同一个QF包，但它们并不指定具体目录，而是通过构建时自动选择对应的平台相关版本。

平台依赖的代码

平台依赖的代码则存放在特定平台的目录下，例如 Cpp/Qf/Win32 ，并包含平台特定的头文件，如 port.h 。构建时，编译器会自动组合当前平台目录和平台独立目录下的源文件。

公共作用域与包作用域头文件

QF框架使用两层头文件结构，分别提供公共作用域和包作用域的接口。公共作用域头文件（如 qf_win32.h ）提供了平台依赖的接口，而包作用域头文件（如 Cpp/Win32/port.h ）则定义了构建QF端口所需的额外接口。

公共作用域头文件

公共作用域头文件是平台特定的，包含了操作系统相关的头文件以及平台特定的数据成员定义。例如，Win32端口的公共作用域头文件中定义了线程、事件队列和OS事件对象。

// 示例：Win32端口的公共作用域头文件 qf_win32.h
#ifndef qf_win32_h
#define qf_win32_h

#include <windows.h>

// 定义Win32特有的数据成员
#define QF_OS_EVENT(x_)   HANDLE   x_;
#define QF_EQUEUE(x_)     QEQueue x_;
#define QF_THREAD(x_)     HANDLE   x_;

// 包含框架元素
#include "qevt.h"
#include "qhsm.h"
#include "qequeue.h" // Win32需要事件队列
// ... 其他包含

#endif // qf_win32_h

包作用域头文件

包作用域头文件包括公共接口，并定义了共享实现文件使用的宏，用于编写平台相关的操作。例如，Win32端口的包作用域头文件定义了临界区操作、事件队列操作和事件池操作等。

// 示例：Win32端口的包作用域头文件 Cpp/Win32/port.h
#ifndef port_h
#define port_h

#include "qf_win32.h"
#include "qfpkg.h"

// 定义临界区操作宏
#define QF_PROTECT()          EnterCriticalSection(&pkgWin32CritSect)
#define QF_UNPROTECT()        LeaveCriticalSection(&pkgWin32CritSect)

// ... 其他宏定义

#endif // port_h

构建过程的细节

构建过程中，QF框架将源文件从两个目录中组合起来：当前平台相关目录和平台无关目录。编译器的include路径需要包含当前目录、公共包含目录和源目录。源代码和makefiles只使用相对于当前目录的相对路径，这使得QF框架可以在目录树的任何层级被放置，而无需修改源代码或makefiles。

常见元素：事件池的实现

QF框架中的事件池是一个固定大小的内存块堆，用于存储事件实例。事件池的设计允许灵活地预分配事件存储，同时保持内存使用的高效和最小化中断延迟。

事件池的数据结构

事件池通过链表管理内存块，其中所有未使用的内存块链接在一起形成空闲列表。这种数据结构的访问模式类似于栈（LIFO），且通过将空闲块链接在一起，QEPool类可以重用这些块。

// 示例：QEPool类的声明
class QEPool {
private:
    void init(QEvent *poolSto, unsigned nEvts, unsigned evtSize);
    QEvent *get();
    void put(QEvent *e);
    void *myFree;
    unsigned short myEvtSize;
    unsigned short myNtot;
    unsigned short myNfree;
    unsigned short myNmin;
    friend class QF;
};