设计模式学习笔记——原型(Prototype)框架

谁践踏了优雅 2022-06-17 01:50 233阅读 0赞

# 设计模式学习笔记——原型(Prototype)框架 #

@(设计模式)\[设计模式, 原型模式, prototype\]

*  设计模式学习笔记原型Prototype框架
    
     *  基本介绍
     *  原型案例
        
         *  类图
         *  实现代码
            
             *  Product接口
             *  Manager类
             *  MessageBox类
             *  UnderlinePen类
             *  测试类
             *  运行结果
     *  原型模式中的角色
        
         *  Prototype原型
         *  ConcretePrototype具体的原型
         *  Client使用者
         *  类图

## 基本介绍 ##

在`Java`中，可以使用`new`关键字指定类名来生成类的实例。像这样使用`new`来生成实例时，是必须指定类名的。但是，在开发过程中，有时候也会有“类名的前提下生成实例”的需求。

例如，在以下情况下，我们就不能根据类来生成实例，而要根据现有的实例来生成新的实例。

*  对象种类繁多，无法将它们整合到一个类中时  
    
    
     *  第一种情况是需要处理的对象太多，如果将它们分别作为一个类，必须要编写很多个类文件。
 *  难以根据类生成实例时
    
     *  第二种情况是生成实例的过程太过复杂，很难根据类来生成实例。例如，我们假设这里有一个实例，即表示用户在图形编辑器中使用鼠标制作出的图形的实例。想在程序中创建这样的实例是非常困难的。通常，在想生成一个和之前用户通过操作所创建出的实例完全一样的实例的时候，我们会事先将用户通过操作所创建出的实例保存起来，然后在需要时通过复制来生成新的实例。
 *  想解耦框架与生成的实例时
    
     *  第三种情况是想要让生成实例的框架不依赖于具体的类。这时，不能指定类名来生成实例，而要事先”注册”一个”原型”实例，然后通过复制该实例来生成新的实例。根据实例生成实例与使用复印机复印文档相类似。即使不知道原来的文档中的内容，我们也可以使用复印机复制出完全相同的文挡，无论多少份都行。

在设计模式中，它是指根据实例原型、实例模型来生成新的实例。

## 原型案例 ##

### 类图 ###

![原型案例类图][SouthEast]

### 实现代码 ###

#### Product接口 ####

package com.pc.prototype.example.framwork;
    
    /** * 产品接口 * Created by Switch on 2017-02-13. */
    public interface Product extends Cloneable { 
        /** * 使用 * * @param s 字符串 */
        void use(String s);
    
        /** * 创建一个clone对象 * * @return */
        Product createClone();
    }

#### Manager类 ####

package com.pc.prototype.example.framwork;
    
    import java.util.HashMap;
    import java.util.Map;
    
    /** * 管理类 * Created by Switch on 2017-02-13. */
    public class Manager { 
        // 注册中心，管理Product接口实现类的原型
        private Map<String, Product> products = new HashMap<>();
    
        /** * 注册原型 * * @param protoName 原型名称 * @param product 原型类对象 */
        public void register(String protoName, Product product) {
            products.put(protoName, product);
        }
    
        /** * 使用原型创造对象 * * @param protoName 原型注册名称 * @return 原型注册名称对应对象的clone对象 */
        public Product create(String protoName) {
            Product product = this.products.get(protoName);
            return product.createClone();
        }
    
    }

#### MessageBox类 ####

package com.pc.prototype.example.concrete.product;
    
    import com.pc.prototype.example.framwork.Product;
    
    /** * 消息框类 * Created by Switch on 2017-02-13. */
    public class MessageBox implements Product { 
        // 装饰字符
        private char decochar;
    
        /** * 构造方法传入装饰字符 * * @param decochar 装饰字符 */
        public MessageBox(char decochar) {
            this.decochar = decochar;
        }
    
        @Override
        public void use(String s) {
            // 获取字符串字节长度
            int length = s.getBytes().length;
            // 输出上边框
            this.outputBorder(length);
    
            // 输出消息
            System.out.println(this.decochar + " " + s + " " + this.decochar);
    
            // 输出下边框
            this.outputBorder(length);
        }
    
        /** * 输出边框 * * @param length 字符串字节长度 */
        private void outputBorder(int length) {
            for (int i = 0; i < length + 4; i++) {
                System.out.print(this.decochar);
            }
            System.out.println();
        }
    
        @Override
        public Product createClone() {
            Product p = null;
            try {
                // 克隆
                p = (Product) clone();
            } catch (CloneNotSupportedException e) {
                e.printStackTrace();
            }
            return p;
        }
    }

#### UnderlinePen类 ####

package com.pc.prototype.example.concrete.product;
    
    import com.pc.prototype.example.framwork.Product;
    
    /** * 下划线类 * Created by Switch on 2017-02-13. */
    public class UnderlinePen implements Product { 
        // 下划线字符
        private char ulchar;
    
        /** * 构造方法传入下划线字符 * * @param ulchar 下划线字符 */
        public UnderlinePen(char ulchar) {
            this.ulchar = ulchar;
        }
    
    
        @Override
        public void use(String s) {
            // 字符串字节长度
            int length = s.getBytes().length;
    
            // 输出字符串
            System.out.println("\"" + s + "\"");
    
            // 输出下划线
            System.out.print(" ");
            for (int i = 0; i < length; i++) {
                System.out.print(this.ulchar);
            }
            System.out.println();
        }
    
        @Override
        public Product createClone() {
            Product product = null;
            try {
                product = (Product) clone();
            } catch (CloneNotSupportedException e) {
                e.printStackTrace();
            }
            return product;
        }
    }

#### 测试类 ####

package com.pc.prototype.example.test;
    
    import com.pc.prototype.example.concrete.product.MessageBox;
    import com.pc.prototype.example.concrete.product.UnderlinePen;
    import com.pc.prototype.example.framwork.Manager;
    import com.pc.prototype.example.framwork.Product;
    import org.junit.Test;
    
    /** * 原型测试类 * Created by Switch on 2017-02-13. */
    public class PrototypeTest { 
        @Test
        public void testPrototype() {
            // 创建管理器
            Manager manager = new Manager();
            // 下划线
            UnderlinePen underlinePen = new UnderlinePen('~');
            // 消息框
            MessageBox messageBox = new MessageBox('*');
    
            // 加入管理
            String underline = "underline";
            String box = "box";
            manager.register(underline, underlinePen);
            manager.register(box, messageBox);
    
            // 使用管理器创建克隆对象并使用
            Product underlineProduct = manager.create(underline);
            Product boxProduct = manager.create(box);
    
            String hello = "Hello World!";
            underlineProduct.use(hello);
            boxProduct.use(hello);
        }
    }

#### 运行结果 ####

"Hello World!"
     ~~~~~~~~~~~~
    ****************
    * Hello World! *
    ****************

## 原型模式中的角色 ##

### Prototype(原型) ###

`Product`角色负责定义用于复制现有实例来生成新实例的方法。在案例中，由`Product`接口扮演此角色。

### ConcretePrototype(具体的原型) ###

`ConcretePrototype`角色负责实现复制现有实例并生成新实例的方法。在案例中，由`MessageBox`类和`UnderlinePen`类扮演此角色。

### Client(使用者) ###

`Client`角色负责使用复制实例的方法生成新的实例。在案例中，由`Manager`类扮演此角色。

### 类图 ###

![原型模式类图][SouthEast 1]

GitHub：[DesignPatternStudy][]

——————参考《图解设计模式》

[SouthEast]: /images/20220617/466b607024264249acd698b2271438d6.png
[SouthEast 1]: /images/20220617/ecc0747099cd49ee937f08f43330c995.png
[DesignPatternStudy]: https://github.com/Switch-vov/DesignPatternStudy