[嵌入式开发模块]环形缓冲区/循环队列C语言面向对象实现(一)Buffer类介绍及使用示例

小咪咪 2022-03-12 16:50 2110阅读 0赞

### 文章目录 ###

*  前言
 *  缓冲区介绍
 *  模块类图
 *  模块设计思路简介
 *  编程约定
 *  示例程序

# 前言 #

学习完《Test-Driven Development for Embedded C》后对C语言中的面向对象开发又多了一层理解，过两天可能专门出个博客来说说新的理解。

而我已经按照更面向对象的方法大改了原来的那个[环形缓冲区模块][Link 1]，考虑到整个结构已经完全不同了，所以直接弃用了原来那个模块，新模块直接重新开始记版本号。

Buffer模块为了通用，定义了前后都可以进出，想当成队列来用比如可以入队用BackIn，出队用FrontOut；相当成栈来用比如可以入栈用BackIn，出栈用BackOut。当然，第三篇中我会给出Queue类，并把Buffer类适配为了Queue类，这样可能用起来更舒服些，虽然当然有额外的开销。

# 缓冲区介绍 #

实际项目中我们常常会需要一小块区域来暂存一些数据，可能是用来缓存使用，可能是用来线程间通信，我们把其称为缓冲区/Buffer。这块区域可能是先入先出的(队列)也可能是先入后出的(栈)，但反正最后都可以抽象为一个可以在头或尾存取数据的内存区域。

缓冲区的具体实现方式一般有链表和数组，当不能确定需要的缓冲区大小时使用链表较好，能确定时使用数组可以节省很多动态分配内存的开销。

而在具体实现上我们常常会使用环形缓冲区，环形缓冲区就是一个逻辑上环形的区域，因为其(逻辑上)是环形的，所以不需要在内部元素变动的时候需要移动内部剩下的元素。这样就使元素进出头尾的时间复杂度只有O(1)，效率十分的高，在通信等领域应用频繁。

# 模块类图 #

以下是目前整个模块的类图。  
![Buffer模块][Buffer]

# 模块设计思路简介 #

缓冲区是个很常见的需求，即对一块逻辑上环形的区域的头尾进行In和Out操作，以缓存各种类型的数据。对调用者来说，并不需要知道其使用的模块/类内部实际是怎么实现的，只需要知道这个模块/类实现哪几个方法，这几个方法是干什么用的就行(其实就是所谓的**面向接口编程**)。因此，需要为环形缓冲区定义通用的接口。

在一个略大的项目中我们常常需要在多处使用环形缓冲区。所以在这次的实现中我并没有使用单例的方式来实现这个模块，而是直接默认是**多例**的方式，不同的实现各自提供Create方法来返回对象引用，Destroy方法来销毁。

实际开发中有时会需要混用多种实现，比如有的你希望使用一个RAM数组，有的想用链表，甚至有的是使用Flash来存储的等。而只要接口相同，调用者不需要知道具体的实现细节，只需要你给他传递一个实现了这个接口的对象就行。这其实就实现了不同模块间的解耦。而为了实现在同一个C工程中调用同一个接口能实际调用不同的实现(即**多态**)，这就需要使用虚表技术。这里就不展开了。

再考虑一个很实际的需求，在CodeWarrior对S12X的编程中，为了节省非分页的RAM，我常想要把这个环形缓冲区放在分页的RAM中，这样，两种环形缓冲区可能唯一的差别就是具体访问某个元素的方式是使用普通指针还是rptr指针，如果分别写一个实现，就会有大量的冗余代码。出于程序员的自我修养，肯定得把这些通用的部分给抽象出来。用**继承**的方式实现代码的复用。

好像前面说的有点混乱。**简而言之，就是按照面向对象的思想，定义不同层次的接口，通过虚表实现多态，通过类继承尽可能复用代码，最终实现这个完整的模块**。

我们可以照着类图看看目前我的抽象方式。首先所有对象都会有个Destroy方法，所以object接口对其进行了定义。这里我没有专门再定义一个Object虚类，后面可能会抽象出来。而最主要的一个基类叫做Container(容器)，所有的容器都要实现getCapacity和getCount接口。而isEmpty和isFull其实是通过调用这两个虚方法返回结果的。

而后虚类BufferTYPE继承了Container虚类，并(虚)实现了环形缓冲区的7个通用方法，包括检查头/尾元素(Front和Back)、从头/尾取出元素(FrontOut和BackOut)、往头/尾放入元素(FrontOut和BackOut)以及清空缓冲区(Cleanup)。

TYPE只是一个代号，使用时要替换成实际类型。目前我实现了UINT8、UINT16、UINT32的。如果需要使用其他类型，如果类型的size为8、16、32，建议直接适配一下就好(其实就是对同样size的进行强制类型转换一下，BufferChar给出了一个示例)，这样可以尽可能地实现代码复用，如果是其他特殊的，那就照着源代码中的自己扩展一下吧，主要是C语言没有模板功能，只好直接在名字中标记上类型来区分。

然后继承的BufferTYPEIndexed虚类要实现索引器接口，其是所有能通过索引直接访问的Buffer的基类。

BufferArrayShare类继承BufferTYPEIndexed类并实现了所有通过类数组操作来实现的Buffer类的通用部分，其调用索引器来访问数组元素，这样就实现了不同访问方式的复用。与之相对的则是子类BufferTypeArray和BufferTypeArrayR分别实现了位于直接访问区的数组和分页区数组的索引器。

而末尾的3个实现类则主要负责内存的管理部分，动态分配实例并实现对应的Destroy方法，然后调用父类的Init方法来实现完整的类。项目中可以同时使用这几个类。

当然，因为高度的面向对象，导致有大量的小文件，这其实和面向对象语言提供的各种类有一堆文件一个道理。好在使用起来还是很方便的。

如果只是使用的话建议不需要具体了解内部的实现，根据类图了解下继承关系，看看每个类的接口的描述。然后直接调用实例的方法就行。那一堆小文件就直接全部拖到项目中就好。(PS.没有用到的类是不会链接进去占用内存的，所以直接扔进项目就好了，没用到就没用到。)

现在会有这些文件。  
![模块文件][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbl9zdHJvbmc_size_16_color_FFFFFF_t_70]

# 编程约定 #

接口定义在.h头文件中，如名字中带有Private则代表其中的接口为private或protect的，非开发者不应该使用，否则为public的，供给用户使用。

由于C语言本身没有OO这个概念，所以类的方法以这种方式命名，这样可以很直观地知道是哪个类的方法：

> 类名\_方法()；

另，对于多例的类，第一个参数为被调用方法的实例，其后跟其他参数。

如BufferUINT8的Back方法的签名如下：

uint8_t BufferUINT8_Back    (BufferUINT8 buf);

子类实例可以直接调用父类方法。如：

uint8_t arr[ARRSIZE];
    BufferUINT8ArrayR buf；
    buf = BufferUINT8ExternalArray_Create(arr, ARRSIZE);
    // 缓冲区前面放入55
    BufferUINT8_FrontIn((BufferUINT8)buf,55);
    // 现在缓冲区内元素为[ 55 ]

# 示例程序 #

这里已隐去不重要的代码：

#include <stdio.h>
    #include "BufferExternalArrayR.h"
    #include "BufferExternalArray.h"
    #include "BufferMallocArray.h"
    
    #pragma push
    #pragma DATA_SEG __RPAGE_SEG PAGED_RAM
    static uint8_t PagedArray[300];
    #pragma pop
    static uint8_t nonPagedArray[50];
    
    static void BufferTest(BufferUINT8 buf){
        
      int i;
      printf("sizeof buffer:%u\nFrontIn: 0 to 9\nBackOut: ",BufferUINT8_getCapacity(buf));
      for(i = 0; i < 10; i++)
        BufferUINT8_FrontIn(buf,i);
      for(i = 0; i < 10; i++)
        printf(" %u",BufferUINT8_BackOut(buf));
      printf("\n");
    }
    void main(void) {
        
      BufferUINT8 buf1,buf2,buf3;
      buf1 = BufferUINT8ExternalArrayR_Create(PagedArray,sizeof(PagedArray));
      buf2 = BufferUINT8ExternalArray_Create(nonPagedArray,sizeof(nonPagedArray));
      buf3 = BufferUINT8MallocArray_Create(40);
      printf("buf1(BufferExternalArrayR) Test:\n");
      BufferTest(buf1);
      printf("buf2(BufferExternalArray) Test:\n");
      BufferTest(buf2);
      printf("buf3(BufferMallocArray) Test:\n");
      BufferTest(buf3);
      for(;;) {
        
      } 
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbl9zdHJvbmc_size_16_color_FFFFFF_t_70 1][]  
可以看到，上例中BufferTest并不知道传递给他的BufferUINT8的具体实现，它只需要知道这个实例实现了BufferUINT8的方法就可以正确地对其进行操作，从而实现了解耦。

另，上例中的BufferUINT8\_getCapacity其实是因为我在Buffer模块的头文件中用宏的方式给Container\_getCapacity起了别名，这样用起来就更顺手了对吧。

具体代码详见下一篇博客。

[Link 1]: https://blog.csdn.net/lin_strong/article/details/73604561
[Buffer]: /images/20220312/1325aae7bc6c4e1a960ff50fd908daac.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbl9zdHJvbmc_size_16_color_FFFFFF_t_70]: /images/20220312/fb79883ab946425298d52a614cb8d52a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbl9zdHJvbmc_size_16_color_FFFFFF_t_70 1]: /images/20220312/60a85aadfd844f0a848dd40819c446cf.png