设计模式之原型模式

原型模式的介绍

原型模式是一个创建型的模式,原型二字表明了该模式应该有一个样板实例,用户从这个样板对象中复制出一个内部属性一直的对象,这个过程也就是我们俗称的“克隆”。被复制的实例就是我们所称的“原型”,这个原型是可定制的。原型模式多用于创建复杂的或者构造耗时的实例,因为这种情况下,复制一个已经存在的实例可使程序运行更高效。

原型模式的定义

用原型实例指定创建对象的种类,并通过复制这些原型创建新的对象。

原型模式的使用场景

  • 类初始化需要消耗非常多的资源,这个资源包括数据、硬件、资源等,使用原型复制避免这些消耗
  • 通过new 产生一个对象需要非常繁琐的数据准备或访问权限,这时可以使用原型模式
  • 一个对象需要提供给其他对象访问,而且各个调用者可能需要修改其他值,可以考虑使用原型模式复制多个对象供调用者使用,即保护性拷贝。

需要注意的是,通过实现Cloneable接口的原型模式在调用clone函数构造实例时并不一定比通过new操作快,只有当通过new构造对象较为耗时或者说成本较高时,通过clone方法才能够获得效率上的提升。因此,在使用Cloneable 是需要考虑构建对象的成本已经做一些效率上的测试,当然,实现原型模式也不一定非要实现Cloneable接口,也有其他的方式。

原型模式的UML类图

UML类图如下:

原型模式1.png

  • Client :客户端用户。
  • ProtoType :抽象类或接口,声明具备clone能力。
  • ContretePrototype :具体的原型类。

原型模式的简单实现

首先创建一个文档对象,即WordDocument,这个文档中含有文字和图片。用户经过长时间的内容编辑后,打算对文档做进一步的编辑,但是,这个编辑后的文档是否被采用还不确定,因此,为了安全起见,用户需要将当前文档拷贝一份,然后在文档副本上进行修改,如此,这个原始文档就是我们上述所说的样板实例,也就是将要被”克隆“的对象,我们称为原型。

public class WordDocument implements Cloneable {
    private String mText;
    private ArrayList<String> mImages = new ArrayList<>();

    public WordDocument() {
        System.out.println("-------构造函数-------");
    }

    public void setmText(String mText) {
        this.mText = mText;
    }

    public void addImages(String mImages) {
        this.mImages.add(mImages);
    }

    public void show(){
        System.out.println("-------------Word Content Start-------------");
        System.out.println("mText" + mText);
        System.out.println("mImages" );
        for (String  s: mImages ) {
            System.out.println("ImageName:"+s);
        }
        System.out.println("-------------Word Content end-------------\n");
    }

    @Override
    protected WordDocument clone()  {
        try {
            WordDocument doc = (WordDocument) super.clone();
            doc.mText = this.mText;
            doc.mImages = this.mImages;
            return doc;
        } catch (CloneNotSupportedException e) {
            e.printStackTrace();
        }

        return null;
    }

    //客户端的使用
    @Test
    public void main() {
        WordDocument document = new WordDocument();
        document.setmText("这是一篇文章");
        document.addImages("图片1");
        document.addImages("图片2");
        document.addImages("图片3");
        document.show();

        //拷贝一份副本
        WordDocument document2 = document.clone();
        document2.show();

        document2.setmText("这是修改过的文本2");

        document2.show();

        document.show();
    }
}

通过WordDocument类模拟了Word文档中的基本元素,即文字和图片。WordDocument在该原型模式示例中扮演的角色为ConcreteProtoType,而Cloneable的角色为ProtoTypeWordDocument中的clone方法用以实现对象克隆,注意,这个方法并不是Cloneable接口中的,而是Object中的方法。Cloneable也是一个标识接口,它表明这个类的对象是可拷贝的。而没有实现Cloneable接口去调用了clone方法就会抛出异常。在这个实例中,通过实习Cloneable接口和重写clone方法实现原型模式。

​ 输出结果:

-------构造函数-------
-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是修改过的文本2
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

结合代码已经运行结果,document2 是通过document .clone 创建的,并且document2第一次输出的时候和document 输出的是一样的,即document2document 的一份拷贝,他们的内容是一样的,而document2 修改的文本内容以后并不会影响document 的文本内容,这就保证了document 的安全性。还需要注意的是,通过clone 拷贝对象时并不会执行构造函数!因此,如果在构造函数中需要一些特殊的初始化操作的类型,在使用Cloneable 实现拷贝时,需要注意构造函数不会执行的问题。

深拷贝和浅拷贝

上述原型模式的实现实际上只是一个浅拷贝,也称为影子拷贝。这份拷贝实际上并不是将原始文档的所有字段都重新构造了一份,而是副本文档的字段引用原始文档的字段,如图:

浅拷贝.png

我们知道 A 引用 B 就是说两个对象指向同一个地址,当修改 AB 也会改变,B修改时A 同样也会改变。将测试方法修改如下:

    @Test
    public void main() {
        WordDocument document = new WordDocument();
        document.setmText("这是一篇文章");
        document.addImages("图片1");
        document.addImages("图片2");
        document.addImages("图片3");
        document.show();

        //拷贝一份副本
        WordDocument document2 = document.clone();
        document2.show();

        document2.setmText("这是修改过的文本2");
        document2.addImages("哈哈.png");
        document2.show();

        document.show();
    }

输出结果

-------构造函数-------
-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是修改过的文本2
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
ImageName:哈哈.png
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
ImageName:哈哈.png
-------------Word Content end-------------

我们发现,最后两个文档信息输出是一致的,我们在document2 添加了一张名为“哈哈.png”的照片,但是,同时也显示在document中了,这是怎么回事呢?这是因为上文中只是简单地进行了浅拷贝,引用类型的新对象 document2mImages 只是单纯地指向了this.mImages引用,并没有重新构造一个mImages对象,然后将原始文档中的图片添加到新的mImages 对象中,这样就导致document2 中的mImages 与原始文档中的是同一个对象,因此,修改了其中一个文档也会受影响。document2mImages 添加了新的图片,实际上也就是往document 里添加新的图片,所以,document 里面也有“哈哈.png” 图片文件,那么如何解决呢?答案就是采用深拷贝,记在拷贝对象时,对于引用类型的字段也要采用拷贝的形式,而不是单纯引用的形式。clone方法修改如下:

    protected WordDocument clone()  {
        try {
            WordDocument doc = (WordDocument) super.clone();
            doc.mText = this.mText;
            //对mImaages 对象也调用clone函数进行拷贝
            doc.mImages = ((ArrayList<String>) this.mImages.clone());
            return doc;
        } catch (CloneNotSupportedException e) {
            e.printStackTrace();
        }
        return null;
    }

如上述代码所示,将doc.mImages指向this.mImages的一份拷贝,而不是this.mImages本身,这样在document2 添加图片时并不会影响ducument ,运行结果如下:

-------构造函数-------
-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是修改过的文本2
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
ImageName:哈哈.png
-------------Word Content end-------------

-------------Word Content Start-------------
mText这是一篇文章
mImages
ImageName:图片1
ImageName:图片2
ImageName:图片3
-------------Word Content end-------------

原型模式是非常简单的一个模式,它的核心问题就是对原始对象进行拷贝,在这个模式的使用过程中需要注意的一点就是:深浅拷贝的问题。在开发中为了减少错误,建议在使用该模式是尽量使用深拷贝,避免操作副本是影响原始对象的问题。

总结

原始模式本质就是对象拷贝,与C++ 中的拷贝构造函数有些类似,他们之间容易出现的问题也都是深、浅拷贝。使用原型模式可以解决构建复杂对象的资源消耗问题,能够在某些场景下提升创建对象的效率。还有一个重要的用途就是保护性拷贝,也就是某个对象对外可能是只读的。为了防止外部对这个只读对象修改,通常可以通过返回一个对象拷贝的形式实现只读的限制。

优点

原型模式是在内存中二进制流的拷贝,要比直接new 一个对象性能好很多,特别是在一个循环体内产生大量的对象时,原型模式可以更好地体现其优点。

缺点

这既是优点也是缺点,直接在内存中拷贝,构造函数是不会执行的。开发中应该注意这个潜在的问题。

Demo

设计模式Demo

参考

《Android源码设计模式》