23中设计模式之_原型模式(深/浅拷贝)

前言

原型模式其实java Object中已经提供了一个Clone( )方法，平时很少用到，最近读Retrofit源码时候看到有这种使用方式。

定义

原型模式就是在系统clone()标记的基础上，对Clone()进行复写，不同的操作可以产生两种拷贝模式。

UML类图

源码分析

今天我们来讲原型模式，这个模式的简单程度是仅次于单例模式和迭代器模式，非常简单，但是要使
用好这个模式还有很多注意事项。我们通过一个例子来解释一下什么是原型模式。
现在电子账单越来越流行了，比如你的信用卡，到月初的时候银行就会发一份电子邮件到你邮箱中，
说你这个月消费了多少，什么时候消费的，积分是多少等等，这个是每个月发一次，但是还有一种也是银
行发的邮件你肯定有印象：广告信，现在各大银行的信用卡部门都在拉拢客户，电子邮件是一种廉价、快
捷的通讯方式，你用纸质的广告信那个费用多高呀，比如我今天推出一个信用卡刷卡抽奖活动，通过电子
账单系统可以一个晚上发送给 600 万客户，为什么要用电子账单系统呢？直接找个发垃圾邮件不就解决问
题了吗？是个好主意，但是这个方案在金融行业是行不通的，银行发这种邮件是有要求的，一是一般银行
都要求个性化服务，发过去的邮件上总有一些个人信息吧，比如“XX 先生”，“XX 女士”等等，二是邮件的
到达率有一定的要求，由于大批量的发送邮件会被接收方邮件服务器误认是垃圾邮件，因此在邮件头要增
加一些伪造数据，以规避被反垃圾邮件引擎误认为是垃圾邮件；从这两方面考虑广告信的发送也是电子账单系统（电子账单系统一般包括：账单分析、账单生成器、广告信管理、发送队列管理、发送机、退信处
理、报表管理等）的一个子功能，我们今天就来考虑一下广告信这个模块是怎么开发的。那既然是广告信，
肯定需要一个模版，然后再从数据库中把客户的信息一个一个的取出，放到模版中生成一份完整的邮件，
然后扔给发送机进行发送处理，我们来看类图：

在类图中 MailTem是广告信的模板，一般都是从数据库取出，生成一个 BO 或者是 DTO，我们这里
使用一个静态的值来做代表；Mail 类是一封邮件类，发送机发送的就是这个类，我们先来看看我们的程序：
贴代码：

Mail 就是一个业务对象，我们再来看业务场景类是怎么调用的：

  package com.weichao.prototy;    import java.util.Random;    /**     * 原型模式 银行电子广告     *      * @author weichyang     *      *         1.有什么弊端 2.单线程，发送 600万封需要多长时间 3.改用多线程     *      */    public class CopyOfClient {        public static int MAX_COUNT = 5;        public static void main(String[] args) {            /* 发送邮件 */            final Mail mail = new Mail(new MailTemp());            mail.setTail("xxx银行的所有版权");            for (int i = 0; i < MAX_COUNT; i++) {                mail.setSub(getRandString(5) + " 先生（女士） ");                mail.setReceiver(getRandString(5) + "@" + getRandString(8) + ".com");                sendMail(mail);            }        }        public static void sendMail(Mail mail) {            System.out.println("标题： " + mail.getSub() + "\t收件人"                    + mail.getReceiver() + "\t....发送成功！ ");        }        public static String getRandString(int maxLength) {            String source = "abcdefghijklmnopqrskuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";            StringBuffer sb = new StringBuffer();            Random rand = new Random();            for (int i = 0; i < maxLength; i++) {                sb.append(source.charAt(rand.nextInt(source.length())));            }            return sb.toString();        }    }

Mail

 package com.weichao.prototy;    public class Mail implements {        public String receiver;// 接收者        public String tail;// 结尾备注        private String context; // 内容        private String sub; // 标题        public Mail(MailTemp mTemp) {            this.context = mTemp.getMainContentString();            this.sub = mTemp.getSubString();        }        public String getReceiver() {            return receiver;        }        public void setReceiver(String receiver) {            this.receiver = receiver;        }        public String getTail() {            return tail;        }        public void setTail(String tail) {            this.tail = tail;        }        public String getContext() {            return context;        }        public void setContext(String context) {            this.context = context;        }        public String getSub() {            return sub;        }        public void setSub(String sub) {            this.sub = sub;        }    }

MailTemp

    package com.weichao.prototy;    public class MailTemp {        public String subString;// 标题        public String mainContentString; // 广告内容        public String getSubString() {            return "xxxxxxxxxxxxx账单";        }        public String getMainContentString() {            return "xxx" + "(先生/女士)";        }    }

运行结果：

标题： OcqZc 先生（女士） 收件人[e-mail] ….发送成功！
标题： qunOc 先生（女士） 收件人[e-mail] ….发送成功！
标题： arBDA 先生（女士） 收件人[e-mail] ….发送成功！
标题： VgaMg 先生（女士） 收件人[e-mail] ….发送成功！
标题： TxuHD 先生（女士） 收件人[e-mail] ….发送成功！

由于是随机数，每次运行都由所差异，不管怎么样，我们这个电子账单发送程序时写出来了，也能发
送出来了，我们再来仔细的想想，这个程序是否有问题？你看，你这是一个线程在运行，也就是你发送是
单线程的， 那按照一封邮件发出去需要 0.02 秒 （够小了，你还要到数据库中取数据呢）， 600 万封邮件需要…
我算算（掰指头计算中…），恩，是 33 个小时，也就是一个整天都发送不完毕，今天发送不完毕，明天的
账单又产生了，积累积累，激起甲方人员一堆抱怨，那怎么办？
好办，把 sendMail 修改为多线程，但是你只把 sendMail 修改为多线程还是有问题的呀，你看哦，产
生第一封邮件对象，放到线程 1 中运行，还没有发送出去；线程 2 呢也也启动了，直接就把邮件对象 mail的收件人地址和称谓修改掉了，线程不安全了，好了，说到这里，你会说这有 N 多种解决办法，我们不多
说，我们今天就说一种，使用原型模式来解决这个问题，使用对象的拷贝功能来解决这个问题，类图稍作
修改，如下图：

这里贴出来修改的地方

在Mail中实现

 public class Mail implements Cloneable {    ...    ...    ...        // 进行浅拷贝        @Override        protected Mail clone() throws CloneNotSupportedException {            Mail mail = (Mail) super.clone();            return mail;        }    }

Client调用的地方

  public class Client {        public static int MAX_COUNT = 5;        public static void main(String[] args) {            /* 发送邮件 */            final Mail mail = new Mail(new MailTemp());            mail.setTail("xxx银行的所有版权");            for (int i = 0; i < MAX_COUNT; i++) {                Mail cloneMail;                try {                    cloneMail = mail.clone();                    cloneMail.setSub(getRandString(5) + " 先生（女士） ");                    cloneMail.setReceiver(getRandString(5) + "@" + getRandString(8)                            + ".com");                    sendMail(cloneMail);                } catch (CloneNotSupportedException e) {                    // TODO Auto-generated catch block                    e.printStackTrace();                }            }        }    }    }

运行结果不变，一样完成了电子广告信的发送功能，而且 sendMail 即使是多线程也没有关系，看到mail.clone()这个方法了吗？把对象拷贝一份，产生一个新的对象，和原有对象一样，然后再修改细节的数据，如设置称谓，设置收件人地址等等。这种不通过 new 关键字来产生一个对象，而是通过对象拷贝来实现的模式就叫做原型模式，这个模式的核心是一个clone( )方法，通过这个方法进行对象的拷贝，Java 提供了一个 Cloneable 接口
来标示这个对象是可拷贝的，为什么说是“标示”呢？翻开 JDK 的帮助看看 Cloneable 是一个方法都没有
的，这个接口只是一个标记作用，在 JVM 中具有这个标记的对象才有可能被拷贝，那怎么才能从“有可能被拷贝”转换为“可以被拷贝”呢？方法是覆盖clone()方法，是的，你没有看错是重写 clone()方法，看看我们上面 Mail 类：

   @Override    public Mail clone(){}

在 clone()方法上增加了一个注解@Override， 没有继承一个类为什么可以重写呢？在 Java 中所有类的
老祖宗是谁？对嘛，Object 类，每个类默认都是继承了这个类，所以这个用上@Override是非常正确的。原型模式虽然很简单，但是在 Java 中使用原型模式也就是 clone 方法还是有一些注意事项的，我们通过几个例子一个一个解说（如果你对 Java 不是很感冒的话，可以跳开以下部分）。

对象拷贝时，类的构造函数是不会被执行的。 一个实现了 Cloneable 并重写了 clone 方法的类 A,有一个无参构造或有参构造 B，通过 new 关键字产生了一个对象 S，再然后通过 S.clone()方式产生了一个新的
对象 T，那么在对象拷贝时构造函数 B 是不会被执行的，
对象拷贝时确实构造函数没有被执行，这个从原理来讲也是可以讲得通的，Object 类的 clone 方法的
原理是从内存中（具体的说就是堆内存）以二进制流的方式进行拷贝，重新分配一个内存块，那构造函数
没有被执行也是非常正常的了。

浅拷贝和深拷贝问题。 再解释什么是浅拷贝什么是深拷贝前，我们先来看个例子：

 package ShallowCopy;    import java.util.ArrayList;    /**     * 1.浅拷贝拷贝外层对象，对象里面的引用对象不进行拷贝。     * 2.深拷贝需要进行内部的拷贝（人为进行拷贝）。     * @author weichyang     *      */    public class ShallowOne implements Cloneable {        public ArrayList<String> getShallowCopyArrayList() {            return shallowCopyArrayList;        }        public void setShallowCopyArrayList(ArrayList<String> shallowCopyArrayList) {            this.shallowCopyArrayList = shallowCopyArrayList;        }        ArrayList<String> shallowCopyArrayList = new ArrayList<String>();        @SuppressWarnings("unchecked")        @Override        protected ShallowOne clone() throws CloneNotSupportedException {            //只是clone（）属于浅拷贝            ShallowOne shallowOne = (ShallowOne)     super.clone();            return shallowOne;        }    }

调用

    package ShallowCopy;    import java.util.ArrayList;    /**     * 拷贝 原来 list 进行操作，原来的list中元素同样会增加 1.前拷贝 只拷贝基础数据类型 2.深拷贝，拷贝所有，需要手动进行操作     *      * @author weichyang     *      */    public class Client {        public static void main(String[] args) {            ShallowOne shallowOne = new ShallowOne();            ArrayList<String> strings = shallowOne.getShallowCopyArrayList();            strings.add("张三");            ArrayList<String> cloneObject = (ArrayList<String>) strings.clone();            cloneObject.add("李四");            System.out.println(strings.toString());        }    }

大家猜想一下运行结果应该是什么？是就一个“张三”吗？运行结果如下：
[张三, 李四]
怎么会有李四呢？是因为 Java 做了一个偷懒的拷贝动作，Object 类提供的方法 clone 只是拷贝本对象，
其对象内部的数组、引用对象等都不拷贝，还是指向原生对象的内部元素地址，这种拷贝就叫做浅拷贝，
确实是非常浅，两个对象共享了一个私有变量，你改我改大家都能改，是一个种非常不安全的方式，在实
际项目中使用还是比较少的。你可能会比较奇怪，为什么在 Mail 那个类中就可以使用使用 String 类型，
而不会产生由浅拷贝带来的问题呢？内部的数组和引用对象才不拷贝，其他的原始类型比如int,long,String(Java 就希望你把 String 认为是基本类型，String 是没有 clone 方法的)等都会被拷贝的。
浅拷贝是有风险的，那怎么才能深入的拷贝呢？我们修改一下我们的程序

 public class ShallowOne implements Cloneable {        protected ShallowOne clone() throws CloneNotSupportedException {            //只是clone（）属于浅拷贝            ShallowOne shallowOne = (ShallowOne) super.clone();            //手动操作属于深拷贝             this.shallowCopyArrayList = (ArrayList<String>)             this.shallowCopyArrayList             .clone();            return shallowOne;        }    }

结果就是

[张三]

深拷贝，两种对象互为独立，属于单独对象

Eg：final 类型修饰的成员变量不能进行深拷贝

原型模式适合在什么场景使用？一是类初始化需要消化非常多的资源，这个资源包括数据、硬件资源等；二是通过 new 产生一个对象需要非常繁琐的数据准备或访问权限，则可以使用原型模式；三是一个对象需要提供给其他对象访问，而且各个调用者可能都需要修改其值时，可以考虑使用原型模式拷贝多个对象供调用者使用。在实际项目中，原型模式很少单独出现，一般是和工厂方法模式一起出现，通过 clone的方法创建一个对象，然后由工厂方法提供给调用者。原型模式先产生出一个包含大量共有信息的类，然后可以拷贝出副本，修正细节信息，建立了一个完整的个性对象。