装饰模式是一种结构型设计模式， 允许你通过将对象放入包含行为的特殊封装对象中来为原对象绑定新的行为。
由于目标对象和装饰器遵循同一接口， 因此你可用装饰来对对象进行无限次的封装。 结果对象将获得所有封装器叠加而来的行为。
装饰模式结构
Java 核心程序库中有一些关于装饰的示例：
- java.io.InputStream、 OutputStream、 Reader 和 Writer 的所有代码都有以自身类型的对象作为参数的构造函数。
- java.util.Collections； checkedXXX()、 synchronizedXXX() 和 unmodifiableXXX() 方法。
- javax.servlet.http.HttpServletRequestWrapper 和 HttpServletResponseWrapper
识别方法： 装饰可通过以当前类或对象为参数的创建方法或构造函数来识别。
样例
程序使用一对装饰来封装数据源对象。 这两个封装器都改变了从磁盘读写数据的方式：
- 当数据即将被写入磁盘前， 装饰对数据进行加密和压缩。 在原始类对改变毫无察觉的情况下， 将加密后的受保护数据写入文件。
- 当数据刚从磁盘读出后， 同样通过装饰对数据进行解压和解密。 装饰和数据源类实现同一接口， 从而能在客户端代码中相互替换。
读取和写入操作的通用数据接口
package structural.decorator;
/**
* 定义了读取和写入操作的通用数据接口
*/
public interface IDataSource {
void writeData(String data);
String readData();
}
简单数据读写器
package structural.decorator;
import java.io.*;
/**
* 简单数据读取器
*/
public class FileIDataSource implements IDataSource {
private String name;
public FileIDataSource(String name) {
this.name = name;
}
@Override
public void writeData(String data) {
File file = new File(name);
try (OutputStream fos = new FileOutputStream(file)) {
fos.write(data.getBytes(), 0, data.length());
} catch (IOException e) {
System.out.println(e.getMessage());
}
}
@Override
public String readData() {
char[] buffer = null;
File file = new File(name);
try (FileReader reader = new FileReader(file)) {
buffer = new char[(int) file.length()];
reader.read(buffer);
} catch (IOException e) {
System.out.println(e.getMessage());
}
return new String(buffer);
}
}
抽象基础装饰
package structural.decorator;
/**
* 抽象基础装饰
*/
public class DataSourceDecorator implements IDataSource{
private IDataSource wrapped;
public DataSourceDecorator(IDataSource wrapped) {
this.wrapped = wrapped;
}
@Override
public void writeData(String data) {
wrapped.writeData(data);
}
@Override
public String readData() {
return wrapped.readData();
}
}
加密装饰
package structural.decorator;
import java.util.Base64;
/**
* 加密装饰
*/
public class EncryptionDecorator extends DataSourceDecorator {
public EncryptionDecorator(IDataSource wrapped) {
super(wrapped);
}
@Override
public void writeData(String data) {
super.writeData(encode(data));
}
@Override
public String readData() {
return decode(super.readData());
}
private String encode(String data) {
byte[] result = data.getBytes();
for (int i = 0; i < result.length; i++) {
result[i] += (byte) 1;
}
return Base64.getEncoder().encodeToString(result);
}
private String decode(String data) {
byte[] result = Base64.getDecoder().decode(data);
for (int i = 0; i < result.length; i++) {
result[i] -= (byte) 1;
}
return new String(result);
}
}
压缩装饰
package structural.decorator;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Base64;
import java.util.zip.Deflater;
import java.util.zip.DeflaterOutputStream;
import java.util.zip.InflaterInputStream;
/**
* 压缩装饰
*/
public class CompressionDecorator extends DataSourceDecorator {
private int compLevel = 6;
public CompressionDecorator(IDataSource wrapped) {
super(wrapped);
}
public int getCompLevel() {
return compLevel;
}
public void setCompLevel(int compLevel) {
this.compLevel = compLevel;
}
@Override
public void writeData(String data) {
super.writeData(compress(data));
}
@Override
public String readData() {
return decompress(super.readData());
}
private String compress(String stringData) {
byte[] data = stringData.getBytes();
try {
ByteArrayOutputStream bout = new ByteArrayOutputStream(512);
DeflaterOutputStream dos = new DeflaterOutputStream(bout, new Deflater(compLevel));
dos.write(data);
dos.close();
bout.close();
return Base64.getEncoder().encodeToString(bout.toByteArray());
} catch (IOException e) {
e.printStackTrace();
return null;
}
}
private String decompress(String stringData) {
byte[] data = Base64.getDecoder().decode(stringData);
try (InputStream in = new ByteArrayInputStream(data);
InflaterInputStream iin = new InflaterInputStream(in);
ByteArrayOutputStream bout = new ByteArrayOutputStream(512)) {
int b;
while ((b = iin.read()) != -1) {
bout.write(b);
}
return new String(bout.toByteArray());
} catch (IOException e) {
e.printStackTrace();
return null;
}
}
}
测试代码
package structural.decorator;
public class Demo {
public static void main(String[] args) {
String salaryRecords = "Name,Salary
John Smith,10000
Steven Jobs,912000";
DataSourceDecorator encoded = new CompressionDecorator(
new EncryptionDecorator(
new FileIDataSource("OutPutDemo.txt")
)
);
encoded.writeData(salaryRecords);
IDataSource plain = new FileIDataSource("OutPutDemo.txt");
System.out.println("- Input ----------------");
System.out.println(salaryRecords);
System.out.println("- Encoded --------------");
System.out.println(plain.readData());
System.out.println("- Decoded --------------");
System.out.println(encoded.readData());
}
}
/**
* - Input ----------------
* Name,Salary
* John Smith,10000
* Steven Jobs,912000
* - Encoded --------------
* Zkt7e1Q5eU8yUm1Qe0ZsdHJ2VXp6dDBKVnhrUHtUe0sxRUYxQkJMdjVLTVZ0dVI5Q2IwOXFISmVUMU5rcENCQmRleFBmaD4+
* - Decoded --------------
* Name,Salary
* John Smith,10000
* Steven Jobs,912000
*/
适用场景
-
如果你希望在无需修改代码的情况下即可使用对象， 且希望在运行时为对象新增额外的行为， 可以使用装饰模式。
装饰能将业务逻辑组织为层次结构， 你可为各层创建一个装饰， 在运行时将各种不同逻辑组合成对象。 由于这些对象都遵循通用接口， 客户端代码能以相同的方式使用这些对象。
-
如果用继承来扩展对象行为的方案难以实现或者根本不可行， 你可以使用该模式。
许多编程语言使用
final最终关键字来限制对某个类的进一步扩展。 复用最终类已有行为的唯一方法是使用装饰模式： 用封装器对其进行封装。
实现方式
- 确保业务逻辑可用一个基本组件及多个额外可选层次表示。
- 找出基本组件和可选层次的通用方法。 创建一个组件接口并在其中声明这些方法。
- 创建一个具体组件类， 并定义其基础行为。
- 创建装饰基类， 使用一个成员变量存储指向被封装对象的引用。 该成员变量必须被声明为组件接口类型， 从而能在运行时连接具体组件和装饰。 装饰基类必须将所有工作委派给被封装的对象。
- 确保所有类实现组件接口。
- 将装饰基类扩展为具体装饰。 具体装饰必须在调用父类方法 （总是委派给被封装对象） 之前或之后执行自身的行为。
- 客户端代码负责创建装饰并将其组合成客户端所需的形式。
装饰模式优点
- 你无需创建新子类即可扩展对象的行为。
- 你可以在运行时添加或删除对象的功能。
- 你可以用多个装饰封装对象来组合几种行为。
- 单一职责原则。 你可以将实现了许多不同行为的一个大类拆分为多个较小的类。
装饰模式缺点
- 在封装器栈中删除特定封装器比较困难。
- 实现行为不受装饰栈顺序影响的装饰比较困难。
- 各层的初始化配置代码看上去可能会很糟糕。