意图
使用组合模式可以将对象组合成树状结构,并且能像使用独立对象一样使用它们。
组合模式结构
组件(Component)接口描述了树中简单项目和复杂项目所共有的操作。
叶节点(Leaf)是树的基本结构,它不包含子项目。
一般情况下,叶节点最终会完成大部分的实际工作,因为它们无法将工作指派给其他部分。
容器(Container)又名 “组合(Composite)” 是包含叶节点或其他容器等子项目的单位。容器不知道其子项目所属的具体类,它只通过通用的组件接口与其子项目交互。容器接收到请求后会将工作分配给自己的子项目, 处理中间结果, 然后将最终结果返回给客户端。
客户端(Client)通过组件接口与所有项目交互。因此,客户端能以相同方式与树状结构中的简单或复杂项目交互。
示例
以下是 AWTK 控件类进行绘制的部分代码,完整代码请看 AWTK 源码 :
/* widget.h */
/**
* @class widget_t
* @annotation ["scriptable","widget"]
* widget_t 是所有控件、窗口和窗口管理器的基类。
* widget_t 也是一个容器,可放其它 widget_t 到它的内部,形成一个树形结构。
*/
struct _widget_t {
/**
* @property {darray_t*} children
* @annotation ["readable"]
* 全部子控件。
*/
darray_t* children;
/* 省略其他属性 */
};
/**
* @method widget_add_child
* 加入一个子控件。
*
* @annotation ["scriptable"]
* @param {widget_t*} widget 控件对象。
* @param {widget_t*} child 子控件对象。
*
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
*/
ret_t widget_add_child(widget_t* widget, widget_t* child);
/**
* @method widget_remove_child
* 移出指定的子控件(并不销毁)。
*
* @annotation ["scriptable"]
* @param {widget_t*} widget 控件对象。
* @param {widget_t*} child 子控件对象。
*
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
*/
ret_t widget_remove_child(widget_t* widget, widget_t* child);
/**
* @method widget_paint
* 绘制控件到一个canvas上。
* @param {widget_t*} widget 控件对象。
* @param {canvas_t*} c 画布对象。
*
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
*/
ret_t widget_paint(widget_t* widget, canvas_t* c);
/* widget.c */
/* widget_add_child() 和 widget_remove_child() 主要是用于将目标控件添加到 children 数组中,本示例省略实现 */
static ret_t widget_paint_impl(widget_t* widget, canvas_t* c) {
int32_t ox = widget->x;
int32_t oy = widget->y;
uint8_t save_alpha = c->global_alpha;
if (widget->opacity < TK_OPACITY_ALPHA) {
canvas_set_global_alpha(c, (widget->opacity * save_alpha) / 0xff);
}
if (widget->astyle != NULL) {
ox += style_get_int(widget->astyle, STYLE_ID_X_OFFSET, 0);
oy += style_get_int(widget->astyle, STYLE_ID_Y_OFFSET, 0);
}
canvas_translate(c, ox, oy);
widget_on_paint_begin(widget, c);
widget_on_paint_background(widget, c);
widget_on_paint_self(widget, c);
/* 遍历 children 数组进行对子控件的绘制 */
widget_on_paint_children(widget, c);
widget_on_paint_border(widget, c);
widget_on_paint_end(widget, c);
canvas_untranslate(c, ox, oy);
if (widget->opacity < TK_OPACITY_ALPHA) {
canvas_set_global_alpha(c, save_alpha);
}
widget_on_paint_done(widget, c);
return RET_OK;
}
ret_t widget_paint(widget_t* widget, canvas_t* c) {
return_value_if_fail(widget != NULL && c != NULL, RET_BAD_PARAMS);
if (!widget->visible || widget->opacity <= 0x08 || widget->w <= 0 || widget->h <= 0) {
widget->dirty = FALSE;
return RET_OK;
}
if (widget->need_relayout_children) {
widget_layout_children(widget);
}
if (widget->need_update_style) {
widget_update_style(widget);
}
canvas_save(c);
/* 绘制控件具体实现 */
widget_paint_impl(widget, c);
canvas_restore(c);
widget->dirty = FALSE;
return RET_OK;
}
总结
适合应用场景:
- 如果你需要实现树状对象结构, 可以使用组合模式。
- 如果你希望客户端代码以相同方式处理简单和复杂元素, 可以使用该模式。
优点:
- 你可以利用多态和递归机制更方便地使用复杂树结构。
- 开闭原则。 无需更改现有代码, 你就可以在应用中添加新元素, 使其成为对象树的一部分。
- 单一职责原则,可以将每种产品生成代码抽取到同一位置, 使得代码易于维护。
- 生成不同形式的产品时, 你可以复用相同的制造代码。
缺点:
对于功能差异较大的类, 提供公共接口或许会有困难。 在特定情况下, 你需要过度一般化组件接口, 使其变得令人难以理解。
参考
22种设计模式:refactoringguru.cn/design-patterns
AWTK:github.com/zlgopen/awtk
《设计模式:可复用面向对象软件的基础》