在C语言中实现工厂模式
在需要对某个功能做拓展时,使用工厂模式能给代码带来尽量少的修改量。本文将通过遵循SOLID设计原则中的开闭原则和依赖倒置原则
在需要对某个功能做拓展时,使用工厂模式能给代码带来尽量少的修改量。本文将通过遵循SOLID设计原则中的开闭原则和依赖倒置原则在C语言上实现工厂模式。
下面将使用解码器功能作为例子进行讲解。
工厂设计
以下为工厂类中的成员与成员函数。
/**n * @enum ret_tn * @annotation ["scriptable"]n * 函数返回值常量定义。n */ntypedef enum _ret_t {n /**n * @const RET_OKn * 成功。n */n RET_OK = 0,n /**n * @const RET_OOMn * Out of memory。n */n RET_OOM,n /**n * @const RET_FAILn * 失败。n */n RET_FAIL,n // ...n /**n * @const RET_BAD_PARAMSn * 无效参数。n */n RET_BAD_PARAMS = 16,n} ret_t;n/* decoder_factory.h */n#ifndef DECODER_FACTORY_Hn#define DECODER_FACTORY_Hnn#include "tkc/darray.h"n#include "audio_decoder.h"nntypedef decoder_t* (*decoder_create_t)(void);nn/**n * @class decoder_factory_tn * decoder工厂。n */ntypedef struct _audio_decoder_factory_t {n /*private*/n darray_t creators;n} audio_decoder_factory_t;nn/**n * @method decoder_factory_instancen * 获取decoder工厂实例。n * @annotation ["constructor"]n * @return {decoder_factory_t*} 返回decoder工厂实例。n */ndecoder_factory_t* decoder_factory_instance(void);nn/**n * @method decoder_factory_registern * 注册decoder创建函数。n * @param {decoder_factory_t*} factory decoder工厂对象。n * @param {const char*} type 类型(如mp3)。n * @param {decoder_create_t} create decoder创建函数。n *n * @return {ret_t} 返回RET_OK表示成功,否则表示失败。n */nret_t decoder_factory_register(decoder_factory_t* factory, const char* type,n decoder_create_t create);nn/**n * @method decoder_factory_create_decodern * 创建指定类型的decoder对象。n * @param {decoder_factory_t*} factory decoder工厂对象。n * @param {const char*} type 类型(如mp3)。n *n * @return {decoder_t*} 创建decoder对象。n */ndecoder_t* decoder_factory_create_decoder(decoder_factory_t* factory,n const char* type);n#endif /* DECODER_FACTORY_H */
使用工厂注册对象类型
注册的实现方式是将对象创建的函数指针与类型使用结构体creator_item_t
捆绑在一起,然后插入到动态数组中。(代码中使用的是AWTK中的动态数组darray,可以使用链表等方式代替。)
#define NAME_LEN 31n#define return_value_if_fail(p, value) n if (!(p)) { n printf("%s:%d " #p "n", __FUNCTION__, __LINE__); n return (value); n }ntypedef struct _creator_item_t {n char type[NAME_LEN + 1];n decoder_create_t create;n} creator_item_t;nnret_t decoder_factory_register(decoder_factory_t* factory, const char* type,n decoder_create_t create) {n creator_item_t* item = NULL;n return_value_if_fail(factory != NULL && type != NULL && create != NULL, RET_BAD_PARAMS);nn item = (creator_item_t*)malloc(sizeof(creator_item_t));n return_value_if_fail(item != NULL, RET_OOM);nn item->create = create;n strncpy(item->type, type, NAME_LEN);n darray_push(&(factory->creators), item);nn return RET_OK;n}ndecoder_factory_register(decoder_factory_instance(), "mp3", decoder_mp3_create);
使用工厂创建对象
通过类型在动态数组中寻找对应函数指针创建对象。
decoder_t* decoder_factory_create_decoder(decoder_factory_t* factory,n const char* type) {n const creator_item_t* iter = NULL;n return_value_if_fail(type != NULL, NULL);n return_value_if_fail(factory != NULL && factory->creators != NULL, NULL);nn iter = darray_find(&(factory->creators), (void*)type);nn return (NULL != iter) ? iter->create() : NULL;n}ndecoder_mp3_t* mp3_decoder = decoder_factory_create_decoder(decoder_factory_instance(), "mp3");
通过接口调用对象功能
在调用具体对象的创建函数时,让对象的虚函数表指针vt
指向该类型的虚函数表,这样就可以通过对象的虚函数表指针调用具体方法。详情请查看文章:用C语言实现C++继承与多态。
/**n * @class decoder_tn * 解码器接口。n */nstruct _decoder_t {n const decoder_vtable_t* vt;n}nnint32_t decoder_decode(decoder_t* decoder, void* buff, uint32_t size) {n return_value_if_fail(buff != NULL && size > 0, 0);n return_value_if_fail(decoder != NULL && decoder->vt != NULL && decoder->vt->decode != NULL, 0);nn return decoder->vt->decode(decoder, buff, size);n}nnret_t decoder_destroy(decoder_t* decoder) {n return_value_if_fail(decoder != NULL && decoder->vt != NULL && decoder->vt->destroy != NULL, RET_BAD_PARAMS);n return decoder->vt->destroy(decoder);n}ntypedef struct _decoder_mp3_t {n decoder_t decoder;n} decoder_mp3_t;nnstatic int32_t decoder_mp3_decode(decoder_t* decoder, void* buff, uint32_t size) {n /* 具体实现 略 */n}nnstatic ret_t decoder_mp3_destroy(decoder_t* decoder) {n /* 具体实现 略 */n}nnstatic const decoder_vtable_t s_decoder_mp3_vtable = {n .decode = decoder_mp3_decode,n .destroy = decoder_mp3_destroy,n};nndecoder_t* decoder_mp3_create(void) {n decoder_mp3_t* mp3_decoder = (decoder_mp3_t*)malloc(sizeof(decoder_mp3_t));n return_value_if_fail(mp3_decoder != NULL, NULL);nn mp3_decoder->decoder.vt = &s_decoder_mp3_vtable;nn return (decoder_t*)mp3_decoder;n}ndecoder_decode(mp3_decoder, buff, sizeof(buff));ndecoder_destroy(mp3_decoder);