原型（Prototype）模式

# 原型（Prototype）模式

原型模式（Prototype Pattern）是用于创建重复的对象，同时又能保证性能。

本体给外部提供一个克隆体进行使用

Java 中 Object 类是所有类的根类，Object 类提供了一个 clone () 方法，该方法可以将一个 Java 对象复制一份，但是需要实现 clone 的 Java 类必须要实现一个接口 Cloneable，该接口表示该类能够复制且具有复制的能力 => 原型模式

原型模式 (Prototype 模式) 是指：用原型实例指定创建对象的种类，并且通过拷贝这些原型，创建新的对象
原型模式是一种创建型设计模式，允许一个对象再创建另外一个可定制的对象，无需知道如何创建的细节
工作原理是：通过将一个原型对象传给那个要发动创建的对象，这个要发动创建的对象通过请求原型对象拷贝它们自己来实施创建，即对象.clone ()

pojo 对象需要实现 Cloneable 接口并实现 clone 方法

public class User implements Cloneable{
    private String username;
    private int age;

    public User() {
        System.out.println("原型创建成功");
    }

    @Override
    protected User clone() throws CloneNotSupportedException {
        System.out.println("原型复制成功");
        User user = (User) super.clone();
        return user;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "username='" + username + '\'' +
                ", age=" + age +
                '}';
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

第一次从数据库查询会创建原形对象，放入缓存为放入原形对象的克隆体，并且每次从缓存中查询后返回的对象也是克隆，避免业务对缓存中的原形进行污染（修改）。

public class Mybatis {
    //缓存user
    private Map<String, User> userCache = new HashMap<>();

    //从数据查询数据
    public User getUser(String username) throws CloneNotSupportedException {
        User user;
        //缓存中没有
        if (!userCache.containsKey(username)) {
            //查询数据库
            user = getUserFormDb(username);
        } else {
            //从缓存中直接拿
            user = userCache.get(username);
            System.out.println("从缓存");
            //从缓存中拿不能直接返回 需要再次clone 再返回 防止用户直接对缓存中的数据进行修改
            user = user.clone();
        }
        return user;
    }

    private User getUserFormDb(String username) throws CloneNotSupportedException {
        System.out.println("从数据库查询" + username);
        User user = new User();
        user.setUsername(username);
        user.setAge(18);
        //注意不能直接赋值给user否则无效 因为最后返回是user 不能影响第一从数据查询的user
//        user = user.clone();
        // 放入缓存 前也要clone一下
        userCache.put(username, user.clone());
        return user;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

调用测试

public static void main(String[] args) throws CloneNotSupportedException {
        Mybatis mybatis = new Mybatis();

        User user1 = mybatis.getUser("张三");
        System.out.println("1==>" + user1);
        user1.setUsername("李四");
        user1.setAge(77);
        System.out.println("1修改了信息==>" + user1);



        User user2 = mybatis.getUser("张三");
        System.out.println("2==>"+user2);


        User user3 = mybatis.getUser("张三");
        System.out.println("4==>"+user3);

        User user4 = mybatis.getUser("张三");
        System.out.println("4==>"+user4);

        System.out.println(user1 == user4);
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

输出结果

从数据库查询张三
原型创建成功
原型复制成功
1==>User{username='张三', age=18}
1修改了信息==>User{username='李四', age=77}
从缓存
原型复制成功
2==>User{username='张三', age=18}
从缓存
原型复制成功
4==>User{username='张三', age=18}
从缓存
原型复制成功
4==>User{username='张三', age=18}
false

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 深入讨论 - 浅拷贝和深拷贝

# 浅拷贝

对于数据类型是基本数据类型的成员变量，浅拷贝会直接进行值传递，也就是将该属性值复制一份给新的对象。
对于数据类型是引用数据类型的成员变量，比如说成员变量是某个数组、某个类的对象等，那么浅拷贝会进行引用传递，也就是只是将该成员变量的引用值（内存地址）复制一份给新的对象。因为实际上两个对象的该成员变量都指向同一个实例。在这种情况下，在一个对象中修改该成员变量会影响到另一个对象的该成员变量值
前面我们原型就是浅拷贝
浅拷贝是使用默认的 clone () 方法来实现

# 深拷贝

复制对象的所有基本数据类型的成员变量值
为所有引用数据类型的成员变量申请存储空间，并复制每个引用数据类型成员变量所引用的对象，直到该对象可达的所有对象。也就是说， 对象进行深拷贝要对整个对象 (包括对象的引用类型) 进行拷贝
深拷贝实现方式 1：重写 clone 方法来实现深拷贝
深拷贝实现方式 2：通过 对象序列化实现深拷贝 (推荐)

import java.io.Serializable;
public class DeepCloneableTarget implements Serializable, Cloneable {
    /**
     *
    */
    private static final long serialVersionUID = 1L;
    private String cloneName;
    private String cloneClass;
    //构造器
    public DeepCloneableTarget(String cloneName, String cloneClass) {
        this.cloneName = cloneName;
        this.cloneClass = cloneClass;
    }
    //因为该类的属性，都是 String , 因此我们这里使用默认的 clone 完成即可
    @Override
    protected Object clone() throws CloneNotSupportedException {
        return super.clone();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

深拷贝

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
public class DeepProtoType implements Serializable, Cloneable {
    public String name; //String 属性
    public DeepCloneableTarget deepCloneableTarget;// 引用类型
    public DeepProtoType() {
        super();
    }
    //深拷贝 - 方式 1 使用 clone 方法
    @Override
    protected Object clone() throws CloneNotSupportedException {
        Object deep = null;
    //这里完成对基本数据类型(属性)和 String 的克隆
        deep = super.clone();
    //对引用类型的属性，进行单独处理
        DeepProtoType deepProtoType = (DeepProtoType)deep;
        deepProtoType.deepCloneableTarget = (DeepCloneableTarget)deepCloneableTarget.clone();
    // TODOAuto-generated method stub
        return deepProtoType;
    }
    //深拷贝 - 方式 2 通过对象的序列化实现 (推荐)
    public Object deepClone() {
        //创建流对象
        ByteArrayOutputStream bos = null;
        ObjectOutputStream oos = null;
        ByteArrayInputStream bis = null;
        ObjectInputStream ois = null;
        try {
            //序列化
            bos = new ByteArrayOutputStream();
            oos = new ObjectOutputStream(bos);
            oos.writeObject(this); //当前这个对象以对象流的方式输出
            //反序列化
            bis = new ByteArrayInputStream(bos.toByteArray());
            ois = new ObjectInputStream(bis);
            DeepProtoType copyObj = (DeepProtoType)ois.readObject();
            return copyObj;
        } catch (Exception e) {
            // TODO: handle exception
            e.printStackTrace();
            return null;
        } finally {
            //关闭流
            try {
                bos.close();
                oos.close();
                bis.close();
                ois.close();
            } catch (Exception e2) {
                // TODO: handle exception
                System.out.println(e2.getMessage());
            }
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

测试

public class Client {
    public static void main(String[] args) throws Exception {
        // TODOAuto-generated method stub
        DeepProtoType p = new DeepProtoType();
        p.name = "宋江";
        p.deepCloneableTarget = new DeepCloneableTarget("大牛", "小牛");
        //方式 1 完成深拷贝
        // DeepProtoType p2 = (DeepProtoType) p.clone();
        //
        // System.out.println("p.name=" + p.name + "p.deepCloneableTarget=" + p.deepCloneableTarget.hashCode());
        // System.out.println("p2.name=" + p.name + "p2.deepCloneableTarget=" + p2.deepCloneableTarget.hashCode());
        //方式 2 完成深拷贝
        DeepProtoType p2 = (DeepProtoType) p.deepClone();
        System.out.println("p.name=" + p.name + "p.deepCloneableTarget=" + p.deepCloneableTarget.hashCode());
        System.out.println("p2.name=" + p.name + "p2.deepCloneableTarget=" + p2.deepCloneableTarget.hashCode());
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 应用场景

什么场景用到？
- 资源优化
- 性能和安全要求
- 一个对象多个修改者的场景。
- 一个对象需要提供给其他对象访问，而且各个调用者可能都需要修改其值时可以考虑使用原型模式拷贝多个对象供调用者使用。
- 深（两个完全对象不一样的【递归克隆】，内容却完全一样）、浅（只是属性赋值）

原型模式已经与 Java 融为浑然一体，大家可以随手拿来使用。

Spring 中原型 bean 的创建，就是原型模式的应用

# 原型模式的注意事项和细节

创建新的对象比较复杂时，可以利用原型模式简化 对象的创建过程，同时也能够提高效率

不用重新初始化对象，而是 动态地获得对象运行时的状态
如果原始对象发生变化 (增加或者减少属性)，其它克隆对象的也会发生相应的变化，无需修改代码
在实现深克隆的时候可能需要比较复杂的代码
缺点：需要为每一个类配备一个克隆方法，这对全新的类来说不是很难，但对已有的类进行改造时，需要修改其源代码，违背了 ocp 原则，这点请同学们注意。

编辑

上次更新: 2023/12/13, 06:06:02

← 单例（Singleton）模式工厂（Factory）模式→