本篇将会介绍Decorator 装饰模式,它是属于一个新的类别,按照C++设计模式_03_模板方法Template Method中介绍的划分为“单一职责”模式
。
“单一职责”模式讲的是在软件组件的设计中,如果责任划分的不清晰,使用继承得到的结果往往是随着需求的变化,子类急剧膨胀,同时充斥着重复代码,这时候的关键是划清责任。
典型的模式包括:Decorator
和 Bridge
。这是因为这两种模式在责任的问题上表现得特别突出,但不意味着其他模式没有责任问题。
本篇主要介绍Decorator 装饰模式
文章目录
- 1. 代码演示Decorator 装饰模式
- 1.1 基于继承的常规思维处理
- 1.2 基于组合关系的重构优化
- 1.3 采用Decorator 装饰模式的实现
- 2. 动机(Motivation)
- 3. 模式定义
- 4. 结构(Structure)
- 5. 要点总结
- 6. 其他参考博文
1. 代码演示Decorator 装饰模式
首先结合实际场景和代码进行分析
设计场景:设计一些IO库,涉及一些流操作,针对流的操作,我们具有很多需求,比如文件流、网络流、内存流等,也有对流进行加密,进行缓存等操作。
1.1 基于继承的常规思维处理
首先我们可能会想到流的设计首先需要一个基类,基类有一些例如:Read()、Seek()、Write()等方法的公共操作,作为纯虚函数,放到Stream基类中。文件流FileStream继承自Stream基类,override Read()、Seek()、Write()等虚函数。网络流NetworkStream、内存流MemoryStream操作也是类似的
当我们进行加密操作时可以发现,首先我们需要对流有个主体的操作才能加密,我们对其中的文件流进行加密,首先去继承文件流FileStream,在Read()中进行额外的加密操作,调用基类的方法FileStream::Read(number);
,Seek()、Write()方法也是在其前面做额外的加密操作。
上述过程是对文件流进行加密操作,对网络流、内存流也有加密需求,也需要重复上面在文件流加密中的动作,我们可以发现加密操作是一样的,只是流的读取操作等不一样。
相应的对流的缓冲操作BufferedFileStream,也需要考虑文件流、网络流、内存流的操作,代码并未详细写
对文件流既加密又缓冲的双重操作CryptoBufferedFileStream,此处是继承了FileStream,当然有些朋友可以直接在这里继承一个CryptoFileStream也是可以的。此处进行额外的加密和缓冲操作。
//业务操作
class Stream{
public:
virtual char Read(int number)=0;
virtual void Seek(int position)=0;
virtual void Write(char data)=0;
virtual ~Stream(){}
};
//主体类
class FileStream: public Stream{
public:
virtual char Read(int number){
//读文件流
}
virtual void Seek(int position){
//定位文件流
}
virtual void Write(char data){
//写文件流
}
};
class NetworkStream :public Stream{
public:
virtual char Read(int number){
//读网络流
}
virtual void Seek(int position){
//定位网络流
}
virtual void Write(char data){
//写网络流
}
};
class MemoryStream :public Stream{
public:
virtual char Read(int number){
//读内存流
}
virtual void Seek(int position){
//定位内存流
}
virtual void Write(char data){
//写内存流
}
};
//扩展操作
class CryptoFileStream :public FileStream{
public:
virtual char Read(int number){
//额外的加密操作...
FileStream::Read(number);//读文件流
}
virtual void Seek(int position){
//额外的加密操作...
FileStream::Seek(position);//定位文件流
//额外的加密操作...
}
virtual void Write(byte data){
//额外的加密操作...
FileStream::Write(data);//写文件流
//额外的加密操作...
}
};
class CryptoNetworkStream : :public NetworkStream{
public:
virtual char Read(int number){
//额外的加密操作...
NetworkStream::Read(number);//读网络流
}
virtual void Seek(int position){
//额外的加密操作...
NetworkStream::Seek(position);//定位网络流
//额外的加密操作...
}
virtual void Write(byte data){
//额外的加密操作...
NetworkStream::Write(data);//写网络流
//额外的加密操作...
}
};
class CryptoMemoryStream : public MemoryStream{
public:
virtual char Read(int number){
//额外的加密操作...
MemoryStream::Read(number);//读内存流
}
virtual void Seek(int position){
//额外的加密操作...
MemoryStream::Seek(position);//定位内存流
//额外的加密操作...
}
virtual void Write(byte data){
//额外的加密操作...
MemoryStream::Write(data);//写内存流
//额外的加密操作...
}
};
class BufferedFileStream : public FileStream{
//...
};
class BufferedNetworkStream : public NetworkStream{
//...
};
class BufferedMemoryStream : public MemoryStream{
//...
}
class CryptoBufferedFileStream :public FileStream{
public:
virtual char Read(int number){
//额外的加密操作...
//额外的缓冲操作...
FileStream::Read(number);//读文件流
}
virtual void Seek(int position){
//额外的加密操作...
//额外的缓冲操作...
FileStream::Seek(position);//定位文件流
//额外的加密操作...
//额外的缓冲操作...
}
virtual void Write(byte data){
//额外的加密操作...
//额外的缓冲操作...
FileStream::Write(data);//写文件流
//额外的加密操作...
//额外的缓冲操作...
}
};
void Process(){
//编译时装配
CryptoFileStream *fs1 = new CryptoFileStream();
BufferedFileStream *fs2 = new BufferedFileStream();
CryptoBufferedFileStream *fs3 =new CryptoBufferedFileStream();
}
针对上述代码,我们来分析是否存在问题。
整理设计类图结构,Stream是基类,FileStream、NetworkStream、MemoryStream均继承自Syream,并对Read()、Seek()、Write()等进行了override,并且对各个基类进行了CryptoFileStream、BufferedFileStream和CryptoBufferedFileStream。
大家可以考虑下,当存在n个流类型的需求时,这个类的规模有多少呢?
Stream记作1
,FileStream、NetworkStream、MemoryStream…等n
种流类型,对于每个流类型有CryptoFileStream、BufferedFileStream和CryptoBufferedFileStream…等m
种操作。总共加起来的个数为:1+n+(m!/2)
,(很多人很容易想到其为1+nm,但实际在操作中会有既加密又等组合的情况,实际就是n(m+(m-1)+(m-2)…+1),数学中对应的就是m的阶乘除以2)。这个类的规模就会变得十分大。
再研究上面的代码,发现对于加密操作,不管是哪个类方法的加密方法,都是一样的,大量重复的代码就造成了代码冗余。
1.2 基于组合关系的重构优化
为了消除重复带来的代码冗余,对代码进行重构。
利用组合关系替代继承关系(设计原则中也有提到组合由于继承),在重构中的规则:当一个变量的声明类型都是某一个类型的子类的时候,那么在声明时就将其声明为该类型
例如上面代码转化组合关系时,从某一个类的FileStream* stream,改定义为Stream* stream;,利用多态在运行时定义为子类型既可以(实现方法:Stream* stream = new FileStream();),这也就使得编译时的东西变为运行时的东西,这里可以悟出一个设计模式的真谛就是“编译时一样,运行时不一样”
。
经过对代码的重构,就将class CryptoFileStream :public FileStream
、class CryptoNetworkStream : :public NetworkStream和class CryptoMemoryStream : public MemoryStream的3段重复性代码重构为以下的一段代码。
class CryptoStream: public Stream {
Stream* stream;//...
public:
CryptoStream(Stream* stm):stream(stm){
}
virtual char Read(int number){
//额外的加密操作...
stream->Read(number);//读文件流
}
virtual void Seek(int position){
//额外的加密操作...
stream::Seek(position);//定位文件流
//额外的加密操作...
}
virtual void Write(byte data){
//额外的加密操作...
stream::Write(data);//写文件流
//额外的加密操作...
}
};
以上代码中Read()、Seek()、Write()均采用虚函数的方式,这是因为遵循流的规范,才能使用虚函数,因此class CryptoStream需要继承public Stream,是完善Read()、Seek()、Write()虚函数的接口规范,也就是Stream基类定义了CryptoStream的接口规范。
class CryptoStream: public Stream {
virtual char Read(int number){...}
virtual void Seek(int position){...}
virtual void Write(byte data){...}
}
这时就有一个特别有意思的变化,既有一个Stream基类,又有Stream* stream
的字段。
同样的道理class BufferedStream
也可以重构为以下代码
class BufferedStream : public Stream{
Stream* stream;//...
public:
BufferedStream(Stream* stm):stream(stm){
}
//...
};
写到此处,最初代码中的问题已经得到了极大的缓解,真正使用的时候。
void Process(){
//运行时装配
FileStream* s1=new FileStream();
CryptoStream* s2=new CryptoStream(s1);
BufferedStream* s3=new BufferedStream(s1);
//既加密又缓存
BufferedStream* s4=new BufferedStream(s2);
}
编译时不存在加密文件流,缓存文件流的类,但是运行时可以通过组合的方式把他们装配起来满足需求。
这样最终的代码为:
//业务操作
class Stream{
public:
virtual char Read(int number)=0;
virtual void Seek(int position)=0;
virtual void Write(char data)=0;
virtual ~Stream(){}
};
//主体类
class FileStream: public Stream{
public:
virtual char Read(int number){
//读文件流
}
virtual void Seek(int position){
//定位文件流
}
virtual void Write(char data){
//写文件流
}
};
class NetworkStream :public Stream{
public:
virtual char Read(int number){
//读网络流
}
virtual void Seek(int position){
//定位网络流
}
virtual void Write(char data){
//写网络流
}
};
class MemoryStream :public Stream{
public:
virtual char Read(int number){
//读内存流
}
virtual void Seek(int position){
//定位内存流
}
virtual void Write(char data){
//写内存流
}
};
//扩展操作
class CryptoStream: public Stream {
Stream* stream;//...
public:
CryptoStream(Stream* stm):stream(stm){
}
virtual char Read(int number){
//额外的加密操作...
stream->Read(number);//读文件流
}
virtual void Seek(int position){
//额外的加密操作...
stream::Seek(position);//定位文件流
//额外的加密操作...
}
virtual void Write(byte data){
//额外的加密操作...
stream::Write(data);//写文件流
//额外的加密操作...
}
};
class BufferedStream : public Stream{
Stream* stream;//...
public:
BufferedStream(Stream* stm):stream(stm){
}
//...
};
void Process(){
//运行时装配
FileStream* s1=new FileStream();
CryptoStream* s2=new CryptoStream(s1);
BufferedStream* s3=new BufferedStream(s1);
BufferedStream* s4=new BufferedStream(s2);
}
到这里问题已经解决的差不多了,这个版本在很多类库中也是比较常见的,这样其实已经OK了
1.3 采用Decorator 装饰模式的实现
如果根据马丁福勒经典意义上的重构理论,重构理论中还有一条:“如果某一个类它有多个子类具有同样的字段时,应该往上提”,Stream* stream;
如果放到class Stream
,但是在其子类class FileStream
并不需要这个字段,FileStream本身就是主体,并不需要Stream* stream字段。
这个时候怎么去做呢?此时需要一个中间类,这个中间类就是class DecoratorStream
。
class DecoratorStream: public Stream{
protected:
Stream* stream;//...
DecoratorStream(Stream * stm):stream(stm){
}
};
整体代码为:
//业务操作
class Stream{
public:
virtual char Read(int number)=0;
virtual void Seek(int position)=0;
virtual void Write(char data)=0;
virtual ~Stream(){}
};
//主体类
class FileStream: public Stream{
public:
virtual char Read(int number){
//读文件流
}
virtual void Seek(int position){
//定位文件流
}
virtual void Write(char data){
//写文件流
}
};
class NetworkStream :public Stream{
public:
virtual char Read(int number){
//读网络流
}
virtual void Seek(int position){
//定位网络流
}
virtual void Write(char data){
//写网络流
}
};
class MemoryStream :public Stream{
public:
virtual char Read(int number){
//读内存流
}
virtual void Seek(int position){
//定位内存流
}
virtual void Write(char data){
//写内存流
}
};
//扩展操作
class DecoratorStream: public Stream{
protected:
Stream* stream;//...
DecoratorStream(Stream * stm):stream(stm){
}
};
class CryptoStream: public DecoratorStream {
public:
CryptoStream(Stream* stm):DecoratorStream(stm){
}
virtual char Read(int number){
//额外的加密操作...
stream->Read(number);//读文件流
}
virtual void Seek(int position){
//额外的加密操作...
stream::Seek(position);//定位文件流
//额外的加密操作...
}
virtual void Write(byte data){
//额外的加密操作...
stream::Write(data);//写文件流
//额外的加密操作...
}
};
class BufferedStream : public DecoratorStream{
Stream* stream;//...
public:
BufferedStream(Stream* stm):DecoratorStream(stm){
}
//...
};
void Process(){
//运行时装配
FileStream* s1=new FileStream();
CryptoStream* s2=new CryptoStream(s1);
BufferedStream* s3=new BufferedStream(s1);
BufferedStream* s4=new BufferedStream(s2);
}
梳理一下,就会发现很巧妙,FileStream、NetworkStream和MemoryStream始终是没有动的,他们是可以单独行驶行为的,但是加密流必须传一个流的对象。这些操作的本质上就是扩展,这就是Decorator 的含义,装饰是附着在其他上的操作。
Stream基类,FileStream、NetworkStream、MemoryStream作为Stream的子类也是不变,设计了DecoratorStream,CryptoStream和BufferedStream继承自DecoratorStream。这种情况下类的规模就是1+n+m
,对比前面1+n+(m!/2)
减少了很多。
对两者进行分析发现:出现1+n+(m!/2)
的规模是由于重复代码的多次使用,继承的不良使用
,我们现在想一下CryptoFileStream和BufferedFileStream一定要继承FileStream来完成加密和缓存操作吗?不是的,组合更好,class DecoratorStream: public Stream{ protected: Stream* stream;//... }
中的Stream* stream; 是设计的核心,就是用组合的方式,来引出未来多态的支持。
2. 动机(Motivation)
-
在某些情况下我们可能会
“过度地使用继承来扩展对象的功能”
,由于继承为类型引入的静态特质,使得这种扩展方式缺乏灵活性;并且随着子类的增多(扩展功能的增多),各种子类的组合(扩展功能的组合)会导致更多子类的膨胀。
例如:在decorator1.cpp
代码中,class CryptoFileStream中的FileStream::Read(number);就是静态特质,是没有变化的可能性的,这是由继承实现的;而在decorator3.cpp
代码中class CryptoStream中的stream->Read(number);中stream是基类的多态指针就是有变化的,这也就是动态特质,这是由组合实现的 -
如何使“对象功能的扩展”能够根据需要来动态地实现?同时避免“扩展功能的增多”带来的子类膨胀问题?从而使得任何“功能扩展变化”所导致的影响将为最低?
3. 模式定义
动态(组合
)地给一个对象增加一些额外的职责。就增加功能而言,Decorator模式比生成子类(继承
)更为灵活(消除重复代码 & 减少子类个数)。 ——《设计模式》GoF
4. 结构(Structure)
上图是《设计模式》GoF中定义的Decorator 装饰模式的设计结构。结合上面的代码看图中最重要的是看其中稳定和变化部分,也就是下图中红框和蓝框框选的部分。
5. 要点总结
-
通过采用组合而非继承的手法, Decorator模式实现了在
运行时
动态扩展对象功能的能力,而且可以根据需要扩展多个功能。避免了使用继承带来的“灵活性差”和“多子类衍生问题”。 -
Decorator类在接口上表现为
is-a
Component的继承关系,即Decorator类继承了Component类所具有的接口。但在实现上又表现为has-a
Component的组合关系,即Decorator类又使用了另外一个Component类。
这是一种同时继承与组合的模式,以后如果看到一个类,它的父类是一个类,例如父类是Stream,又有一个字段是Stream* stream,这个时候就高度怀疑是Decorator 装饰模式。有的时候看不到内部字段,至少可以从类的外部接口进行推测,父类是一个类,构造器的参数也是某一个类型,例如:class CryptoStream: public DecoratorStream {public:CryptoStream(Stream* stm):DecoratorStream(stm){ }}
- Decorator模式的目的并非解决“多子类衍生的多继承”问题,Decorator模式应用的要点在于解决“主体类在多个方向上的扩展功能”——是为“装饰”的含义。
6. 其他参考博文
Decorator 装饰模式