在有些系统中,存在大量相同或相似对象的创建问题,如果用传统的构造函数来创建对象,会比较复杂且耗时耗资源,用原型模式生成对象就很高效,就像孙悟空拔下猴毛轻轻一吹就变出很多孙悟空一样简单。
原型模式的定义与特点
原型(Prototype)模式的定义如下:用一个已经创建的实例作为原型,通过复制该原型对象来创建一个和原型相同或相似的新对象。在这里,原型实例指定了要创建的对象的种类。用这种方式创建对象非常高效,根本无须知道对象创建的细节。例如,Windows 操作系统的安装通常较耗时,如果复制就快了很多。在生活中复制的例子非常多,这里不一一列举了。
原型模式的优点:
- Java 自带的原型模式基于内存二进制流的复制,在性能上比直接 new 一个对象更加优良。
- 可以使用深克隆方式保存对象的状态,使用原型模式将对象复制一份,并将其状态保存起来,简化了创建对象的过程,以便在需要的时候使用(例如恢复到历史某一状态),可辅助实现撤销操作。
原型模式的缺点:
- 需要为每一个类都配置一个 clone 方法
- clone 方法位于类的内部,当对已有类进行改造的时候,需要修改代码,违背了开闭原则。
- 当实现深克隆时,需要编写较为复杂的代码,而且当对象之间存在多重嵌套引用时,为了实现深克隆,每一层对象对应的类都必须支持深克隆,实现起来会比较麻烦。因此,深克隆、浅克隆需要运用得当。
原型模式的结构与实现
由于 Java 提供了对象的 clone() 方法,所以用 Java 实现原型模式很简单。
1. 模式的结构
原型模式包含以下主要角色。
- 抽象原型类:规定了具体原型对象必须实现的接口。
- 具体原型类:实现抽象原型类的 clone() 方法,它是可被复制的对象。
- 访问类:使用具体原型类中的 clone() 方法来复制新的对象。
其结构图如图 1 所示。
图1 原型模式的结构图
2. 模式的实现
原型模式的克隆分为浅克隆和深克隆。
- 浅克隆:创建一个新对象,新对象的属性和原来对象完全相同,对于非基本类型属性,仍指向原有属性所指向的对象的内存地址。
- 深克隆:创建一个新对象,属性中引用的其他对象也会被克隆,不再指向原有对象地址。
Java 中的 Object 类提供了浅克隆的 clone() 方法,具体原型类只要实现 Cloneable 接口就可实现对象的浅克隆,这里的 Cloneable 接口就是抽象原型类。其代码如下:
//具体原型类
class Realizetype implements Cloneable {
Realizetype() {
System.out.println("具体原型创建成功!");
}
public Object clone() throws CloneNotSupportedException {
System.out.println("具体原型复制成功!");
return (Realizetype) super.clone();
}
}
//原型模式的测试类
public class PrototypeTest {
public static void main(String[] args) throws CloneNotSupportedException {
Realizetype obj1 = new Realizetype();
Realizetype obj2 = (Realizetype) obj1.clone();
System.out.println("obj1==obj2?" + (obj1 == obj2));
}
}
程序的运行结果如下:
具体原型创建成功!
具体原型复制成功!
obj1==obj2?false
原型模式的应用实例
【例1】用原型模式模拟“孙悟空”复制自己。
分析:孙悟空拔下猴毛轻轻一吹就变出很多孙悟空,这实际上是用到了原型模式。这里的孙悟空类 SunWukong 是具体原型类,而 Java 中的 Cloneable 接口是抽象原型类。
同前面介绍的猪八戒实例一样,由于要显示孙悟空的图像,所以将孙悟空类定义成面板 JPanel 的子类,里面包含了标签,用于保存孙悟空的图像。
另外,重写了 Cloneable 接口的 clone() 方法,用于复制新的孙悟空。访问类可以通过调用孙悟空的 clone() 方法复制多个孙悟空,并在框架窗体 JFrame 中显示。图 2 所示是其结构图。
图2 孙悟空生成器的结构图
程序代码如下:
import java.awt.*;
import javax.swing.*;
class SunWukong extends JPanel implements Cloneable {
private static final long serialVersionUID = 5543049531872119328L;
public SunWukong() {
JLabel l1 = new JLabel(new ImageIcon("src/Wukong.jpg"));
this.add(l1);
}
public Object clone() {
SunWukong w = null;
try {
w = (SunWukong) super.clone();
} catch (CloneNotSupportedException e) {
System.out.println("拷贝悟空失败!");
}
return w;
}
}
public class ProtoTypeWukong {
public static void main(String[] args) {
JFrame jf = new JFrame("原型模式测试");
jf.setLayout(new GridLayout(1, 2));
Container contentPane = jf.getContentPane();
SunWukong obj1 = new SunWukong();
contentPane.add(obj1);
SunWukong obj2 = (SunWukong) obj1.clone();
contentPane.add(obj2);
jf.pack();
jf.setVisible(true);
jf.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
}
}
程序的运行结果如图 3 所示。
图3 孙悟空克隆器的运行结果
用原型模式除了可以生成相同的对象,还可以生成相似的对象,请看以下实例。
【例2】用原型模式生成“三好学生”奖状。
分析:同一学校的“三好学生”奖状除了获奖人姓名不同,其他都相同,属于相似对象的复制,同样可以用原型模式创建,然后再做简单修改就可以了。图 4 所示是三好学生奖状生成器的结构图。
图4 奖状生成器的结构图
程序代码如下:
public class ProtoTypeCitation {
public static void main(String[] args) throws CloneNotSupportedException {
citation obj1 = new citation("张三", "同学:在2016学年第一学期中表现优秀,被评为三好学生。", "韶关学院");
obj1.display();
citation obj2 = (citation) obj1.clone();
obj2.setName("李四");
obj2.display();
}
}
//奖状类
class citation implements Cloneable {
String name;
String info;
String college;
citation(String name, String info, String college) {
this.name = name;
this.info = info;
this.college = college;
System.out.println("奖状创建成功!");
}
void setName(String name) {
this.name = name;
}
String getName() {
return (this.name);
}
void display() {
System.out.println(name + info + college);
}
public Object clone() throws CloneNotSupportedException {
System.out.println("奖状拷贝成功!");
return (citation) super.clone();
}
}
程序运行结果如下:
奖状创建成功!
张三同学:在2016学年第一学期中表现优秀,被评为三好学生。韶关学院
奖状拷贝成功!
李四同学:在2016学年第一学期中表现优秀,被评为三好学生。韶关学院
原型模式的应用场景
原型模式通常适用于以下场景。
- 对象之间相同或相似,即只是个别的几个属性不同的时候。
- 创建对象成本较大,例如初始化时间长,占用CPU太多,或者占用网络资源太多等,需要优化资源。
- 创建一个对象需要繁琐的数据准备或访问权限等,需要提高性能或者提高安全性。
- 系统中大量使用该类对象,且各个调用者都需要给它的属性重新赋值。
在 Spring 中,原型模式应用的非常广泛,例如 scope='prototype'、JSON.parseObject() 等都是原型模式的具体应用。
原型模式的扩展
原型模式可扩展为带原型管理器的原型模式,它在原型模式的基础上增加了一个原型管理器 PrototypeManager 类。该类用 HashMap 保存多个复制的原型,Client 类可以通过管理器的 get(String id) 方法从中获取复制的原型。其结构图如图 5 所示。
图5 带原型管理器的原型模式的结构图
【例3】用带原型管理器的原型模式来生成包含“圆”和“正方形”等图形的原型,并计算其面积。分析:本实例中由于存在不同的图形类,例如,“圆”和“正方形”,它们计算面积的方法不一样,所以需要用一个原型管理器来管理它们,图 6 所示是其结构图。
图6 图形生成器的结构图
程序代码如下:
import java.util.*;
interface Shape extends Cloneable {
public Object clone(); //拷贝
public void countArea(); //计算面积
}
class Circle implements Shape {
public Object clone() {
Circle w = null;
try {
w = (Circle) super.clone();
} catch (CloneNotSupportedException e) {
System.out.println("拷贝圆失败!");
}
return w;
}
public void countArea() {
int r = 0;
System.out.print("这是一个圆,请输入圆的半径:");
Scanner input = new Scanner(System.in);
r = input.nextInt();
System.out.println("该圆的面积=" + 3.1415 * r * r + "\n");
}
}
class Square implements Shape {
public Object clone() {
Square b = null;
try {
b = (Square) super.clone();
} catch (CloneNotSupportedException e) {
System.out.println("拷贝正方形失败!");
}
return b;
}
public void countArea() {
int a = 0;
System.out.print("这是一个正方形,请输入它的边长:");
Scanner input = new Scanner(System.in);
a = input.nextInt();
System.out.println("该正方形的面积=" + a * a + "\n");
}
}
class ProtoTypeManager {
private HashMap<String, Shape> ht = new HashMap<String, Shape>();
public ProtoTypeManager() {
ht.put("Circle", new Circle());
ht.put("Square", new Square());
}
public void addshape(String key, Shape obj) {
ht.put(key, obj);
}
public Shape getShape(String key) {
Shape temp = ht.get(key);
return (Shape) temp.clone();
}
}
public class ProtoTypeShape {
public static void main(String[] args) {
ProtoTypeManager pm = new ProtoTypeManager();
Shape obj1 = (Circle) pm.getShape("Circle");
obj1.countArea();
Shape obj2 = (Shape) pm.getShape("Square");
obj2.countArea();
}
}
运行结果如下所示:
这是一个圆,请输入圆的半径:3
该圆的面积=28.2735
这是一个正方形,请输入它的边长:3
该正方形的面积=9
原型模式也称为克隆模式,如果您想深入了解原型(克隆)模式,可以阅读下面的文章。
浅克隆和深克隆
我们在《Java原型设计模式》一节介绍了,在 Java 提供的 API 中,不需要手动创建抽象原型接口。Java 中的 Object 类提供了浅克隆的 clone() 方法。因为 Java 已经内置了 Cloneable 抽象原型接口,自定义的类型只需实现该接口并重写 Object.clone() 方法就可实现对象的浅克隆。
通过查看 JDK 的源码可以发现,Cloneable 是一个空接口,如下。
public interface Cloneable {
}
Java 之所以提供 Cloneable 接口,只是为了在运行时通知 Java 虚拟机可以安全地在该类上使用 clone() 方法。而如果该类没有实现 Cloneable 接口,那么调用 clone() 方法会抛出 CloneNotSupportedException 异常。
一般情况下,使用 clone() 方法需要满足以下条件。
- 对任何对象 o,都有 o.clone() != o。换言之,克隆对象与原型对象不是同一个对象。
- 对任何对象 o,都有 o.clone().getClass() == o.getClass()。换言之,克隆对象与原型对象的类型一样。
- 如果对象 o 的 equals() 方法定义恰当,则 o.clone().equals(o) 应当成立。
我们在设计自定义类的 clone() 方法时,应当遵守这 3 个条件。一般来说,这 3 个条件中的前 2 个是必需的,第 3 个是可选的。
下面使用 Java 提供的 API 应用来实现原型模式,代码如下。
public class Client {
public static void main(String[] args) {
//创建原型对象
ConcretePrototype type = new ConcretePrototype("original");
System.out.println(type);
//复制原型对象
ConcretePrototype cloneType = null;
try {
cloneType = type.clone();
} catch (CloneNotSupportedException e) {
e.printStackTrace();
}
cloneType.desc = "clone";
System.out.println(cloneType);
}
static class ConcretePrototype implements Cloneable {
private String desc;
public ConcretePrototype(String desc) {
this.desc = desc;
}
@Override
protected ConcretePrototype clone() throws CloneNotSupportedException {
ConcretePrototype cloneType = null;
try {
cloneType = (ConcretePrototype) super.clone();
} catch (CloneNotSupportedException e) {
e.printStackTrace();
}
return cloneType;
}
@Override
public String toString() {
return "ConcretePrototype{" + "desc='" + desc + '\'' + '}';
}
}
}
运行结果如下:
ConcretePrototype{desc='original'}
ConcretePrototype{desc='clone'}
super.clone() 方法直接从堆内存中以二进制流的方式进行复制,重新分配一个内存块,因此其效率很高。由于 super.clone() 方法基于内存复制,因此不会调用对象的构造函数,也就是不需要经历初始化过程。
在日常开发中,使用 super.clone() 方法并不能满足所有需求。如果类中存在引用对象属性,则原型对象与克隆对象的该属性会指向同一对象的引用。添加 ConcretePrototype 类实现 Cloneable 接口,代码如下。
@Data
public class ConcretePrototype implements Cloneable {
private int age;
private String name;
private List<String> hobbies;
@Override
protected ConcretePrototype clone() {
try {
return (ConcretePrototype) super.clone();
} catch (CloneNotSupportedException e) {
e.printStackTrace();
return null;
}
}
@Override
public String toString() {
return "ConcretePrototype{" + "age=" + age + ",name='" + name + '\'' + ",hobbies=" + hobbies
+ '}';
}
}
修改客户端测试代码。
public class Client {
public static void main(String[] args) {
//创建原型对象
ConcretePrototype type = new ConcretePrototype();
type.setAge(18);
type.setName("C语言中文网");
List<String> hobbies = new ArrayList<String>();
hobbies.add("书法");
hobbies.add("美术");
type.setHobbies(hobbies);
//拷贝原型对象
ConcretePrototype cloneType = type.clone();
cloneType.getHobbies().add("技术控");
System.out.println("原型对象:" + type);
System.out.println("克隆对象:" + cloneType);
}
}
运行结果如下:
原型对象:ConcretePrototype{age=18,name='C语言中文网',hobbies=[书法, 美术, 技术控]}
克隆对象:ConcretePrototype{age=18,name='C语言中文网',hobbies=[书法, 美术, 技术控]}
我们给克隆对象新增一个属性 hobbies(爱好)之后,发现原型对象也发生了变化,这显然不符合预期。因为我们希望克隆对象和原型对象是两个独立的对象,不再有联系。
从测试结果来看,应该是 hobbies 共用了一个内存地址,意味着复制的不是值,而是引用的地址。这样的话,如果我们修改任意一个对象中的属性值,protoType 和 cloneType 的 hobbies 值都会改变。这就是我们常说的浅克隆,只是完整复制了值类型数据,没有复制引用对象。换言之,所有的引用对象仍然指向原来的对象,显然不是我们想要的结果。那如何解决这个问题呢?
Java 自带的 clone() 方法进行的就是浅克隆。如果我们想进行深克隆,可以直接在 super.clone() 后,手动给克隆对象的相关属性分配另一块内存,不过如果当原型对象维护很多引用属性的时候,手动分配会比较烦琐。因此,在 Java 中,如果想完成原型对象的深克隆,通常使用序列化(Serializable)的方式。
使用序列化实现深克隆
在上面的基础上继续改造,增加一个 deepClone() 方法。
public class ConcretePrototype implements Cloneable,Serializable {
private int age;
private String name;
private List<String> hobbies;
@Override
public ConcretePrototype clone() {
try {
return (ConcretePrototype)super.clone();
} catch (CloneNotSupportedException e) {
e.printStackTrace();
return null;
}
}
public ConcretePrototype deepCloneHobbies(){
try {
ConcretePrototype result = (ConcretePrototype)super.clone();
result.hobbies = (List)((ArrayList)result.hobbies).clone();
return result;
} catch (CloneNotSupportedException e) {
e.printStackTrace();
return null;
}
}
public ConcretePrototype deepClone(){
try {
ByteArrayOutputStream bos = new ByteArrayOutputStream();
ObjectOutputStream oos = new ObjectOutputStream(bos);
oos.writeObject(this);
ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray());
ObjectInputStream ois = new ObjectInputStream(bis);
return (ConcretePrototype)ois.readObject();
}catch (Exception e){
e.printStackTrace();
return null;
}
}
@Override
public String toString() {
return "ConcretePrototype{" +
"age=" + age +
", name='" + name + '\'' +
", hobbies=" + hobbies +
'}';
}
}
客户端调用代码如下:
public static void main(String[] args) {
//创建原型对象
ConcretePrototype prototype = new ConcretePrototype();
prototype.setAge(18);
prototype.setName("C语言中文网");
List<String> hobbies = new ArrayList<String>();
hobbies.add("书法");
hobbies.add("美术");
prototype.setHobbies(hobbies);
//拷贝原型对象
ConcretePrototype cloneType = prototype.deepCloneHobbies();
cloneType.getHobbies().add("技术控");
System.out.println("原型对象:" + prototype);
System.out.println("克隆对象:" + cloneType);
System.out.println(prototype == cloneType);
System.out.println("原型对象的爱好:" + prototype.getHobbies());
System.out.println("克隆对象的爱好:" + cloneType.getHobbies());
System.out.println(prototype.getHobbies() == cloneType.getHobbies());
}
运行结果如下,与期望的结果一致。
原型对象:ConcretePrototype{age=18, name='C语言中文网', hobbies=[书法, 美术]}
克隆对象:ConcretePrototype{age=18, name='C语言中文网', hobbies=[书法, 美术, 技术控]}
false
原型对象的爱好:[书法, 美术]
克隆对象的爱好:[书法, 美术, 技术控]
false
从以上结果来看,我们完成了深克隆。
克隆会破坏单例对象吗?
假设有这样一个场景,如果复制的目标对象恰好是单例对象,那会不会破坏单例对象呢?
当然,我们在已知的情况下肯定不会这么干,但如果发生了意外怎么办?不防来修改一下代码。
public class ConcretePrototype implements Cloneable {
private static ConcretePrototype instance = new ConcretePrototype();
private ConcretePrototype() {
}
public static ConcretePrototype getInstance() {
return instance;
}
@Override
public ConcretePrototype clone() {
try {
return (ConcretePrototype) super.clone();
} catch (CloneNotSupportedException e) {
return null;
}
}
}
我们把构造方法私有化,并且提供 getInstance() 方法。编写客户端测试代码如下。
public static void main(String[] args) {
//创建原型对象
ConcretePrototype protoType = ConcretePrototype.getInstance();
//复制原型对象
ConcretePrototype cloneType = protoType.clone();
System.out.println("原型对象和克隆对象比较"+(protoType==cloneType));
}
运行结果如下所示:
原型对象和克隆对象比较false
从运行结果来看,确实创建了两个不同的对象。实际上防止复制破坏单例对象的解决思路非常简单,禁止复制便可。那么我们的单例类不实现 Cloneable 接口,要么我们重写 clone() 方法,在 clone() 方法中返回单例对象即可,具体代码如下。
@Override
public ConcretePrototype clone() {
return instance;
}
原型模式在JDK源码中的应用
本节来讲原型模式在 JDK 源码中的应用。首先查看 JDK 中的 Cloneable 接口。
public interface Cloneable {
}
我们只需要在源码中看哪些类实现了 Cloneable 接口即可。下面是 ArrayList 类的实现代码。
public Object clone() {
try {
@SuppressWarnings("unchecked")
ArrayList<E> v = (ArrayList<E>) super.clone();
v.elementData = Arrays.copyOf(elementData, size);
v.modCount = 0;
return v;
} catch (CloneNotSupportedException e) {
// this shouldn't happen, since we are Cloneable
throw new InternalError();
}
}
从以上代码可以看出,clone() 方法只是将 List 中的元素循环遍历了一遍。此时,再思考一下,是不是这种形式就是深克隆呢?
下面用代码验证一下,继续修改 ConcretePrototype 类,增加一个 deepCloneHobbies() 方法,代码如下:
public class ConcretePrototype implements Cloneable,Serializable {
public ConcretePrototype deepCloneHobbies(){
try {
ConcretePrototype result = (ConcretePrototype) super.clone();
result.hobbies = (List) ((ArrayList) result.hobbies).clone();
return result;
}catch (CloneNotSupportedException){
return null;
}
}
...
}
客户端代码修改如下:
public static void main(String[] args) {
...
//复制原型对象
ConcretePrototype cloneType = prototype.deepCloneHobbies();
...
}
运行结果如下:
原型对象:ConcretePrototype{age=18,name='C语言中文网',hobbies=[书法, 美术]}
克隆对象:ConcretePrototype{age=18,name='C语言中文网',hobbies=[书法, 美术, 技术控]}