设计模式学习笔记——代理(Proxy)模式

Love The Way You Lie 2022-06-17 01:55 191阅读 0赞

# 设计模式学习笔记——代理(Proxy)模式 #

@(设计模式)\[设计模式, 代理模式, proxy\]

*  设计模式学习笔记代理Proxy模式
    
     *  基本介绍
     *  代理案例
        
         *  类图
         *  实现代码
            
             *  Printable接口
             *  Printer类
             *  PrinterProxy类
             *  测试类
             *  运行结果
     *  代理模式中的角色
        
         *  Subject主体
         *  Proxy代理人
         *  RealSubject实际的主体
         *  Client请求者
         *  类图

## 基本介绍 ##

代理模式可以简单的看作是有个中间人代替你进行工作，当中间人完成不了时，才会由你出马完成。

## 代理案例 ##

### 类图 ###

![代理案例类图][SouthEast]

### 实现代码 ###

#### Printable接口 ####

package com.pc.proxy.example;
    
    /** * 可打印接口 * Created by Switch on 2017/3/31. */
    public interface Printable { 
        /** * 设置名字 * * @param name 名字 */
        void setPrinterName(String name);
    
        /** * 获取名字 * * @return 名字 */
        String getPrinterName();
    
        /** * 显示文字 * * @param string 文字 */
        void print(String string);
    }

#### Printer类 ####

package com.pc.proxy.example;
    
    /** * 打印类 * Created by Switch on 2017/3/31. */
    public class Printer implements Printable { 
        /** * 名字 */
        private String name;
    
        public Printer() {
            this.heavyJob("正在生成Printer的实例");
        }
    
        public Printer(String name) {
            this.name = name;
            this.heavyJob("正在生成Printer的实例(" + this.name + ")");
        }
    
        @Override
        public void setPrinterName(String name) {
            this.name = name;
        }
    
        @Override
        public String getPrinterName() {
            return this.name;
        }
    
        @Override
        public void print(String string) {
            System.out.println("===" + this.name + "===");
            System.out.println(string);
        }
    
        /** * 工作 * * @param msg 消息 */
        private void heavyJob(String msg) {
            System.out.print(msg);
            for (int i = 0; i < 5; i++) {
                try {
                    Thread.sleep(1000);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                System.out.print(".");
            }
            System.out.println("结束。");
        }
    }

#### PrinterProxy类 ####

package com.pc.proxy.example;
    
    /** * 打印代理类 * Created by Switch on 2017/3/31. */
    public class PrinterProxy implements Printable { 
        /** * 名字 */
        private String name;
        /** * 本人 */
        private Printer real;
    
        public PrinterProxy(String name) {
            this.name = name;
        }
    
        @Override
        public synchronized void setPrinterName(String name) {
            if (this.real != null) {
                this.real.setPrinterName(name);
            }
            this.name = name;
        }
    
        @Override
        public String getPrinterName() {
            return this.name;
        }
    
        @Override
        public void print(String string) {
            this.realize();
            this.real.print(string);
        }
    
        /** * 生成本人 */
        private synchronized void realize() {
            if (this.real == null) {
                this.real = new Printer(this.name);
            }
        }
    }

#### 测试类 ####

package com.pc.proxy.example.test;
    
    import com.pc.proxy.example.Printable;
    import com.pc.proxy.example.PrinterProxy;
    import org.junit.Test;
    
    /** * PrinterProxy Tester. * * @author Switch * @version 1.0 */
    public class ProxyTest { 
    
        /** * 测试代理模式 */
        @Test
        public void testProxy() {
            Printable p = new PrinterProxy("Alice");
            System.out.println("现在的名字是" + p.getPrinterName() + "。");
            p.setPrinterName("Bob");
            System.out.println("现在的名字是" + p.getPrinterName() + "。");
            p.print("Hello, World.");
        }
    
    }

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

现在的名字是Alice。
    现在的名字是Bob。
    正在生成Printer的实例(Bob).....结束。
    ===Bob=== Hello, World.

## 代理模式中的角色 ##

### Subject(主体) ###

`Subject`角色定义了使`Proxy`角色和`RealSubject`角色之间具有一致性的接口。由于存在`Subject`角色，所以`Client`角色不必在意它所使用的究竟是`Proxy`角色还是`RealSubject`角色。在案例中，由`Printable`接口扮演此角色。

### Proxy(代理人) ###

`Proxy`角色会尽量处理来自`Client`角色的请求。只有当自己不能处理时，它才会将工作交给`RealSubject`角色。`Proxy`角色只有在必要时才会生成`RealSubject`角色。`Proxy`角色实现了在`Subject`角色中定义的接口（`API`）。在案例中，由`PrinterProxy`类扮演此角色。

### RealSubject(实际的主体） ###

“本人”`RealSubject`角色会在“代理人”`Proxy`角色无法胜任工作时出场。它与`Proxy`角色一样，也实现了在`Subject`角色中定义的接口（`API`）。在案例中，由`Printer`类扮演此角色。

### Client(请求者) ###

使用`Proxy`模式的角色。在`GoF`书中，`Client`角色并不包含在`Proxy`模式中。在案例中，由测试类扮演此角色。

### 类图 ###

![代理模式类图][SouthEast 1]

GitHub：[DesignPatternStudy][]

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

[SouthEast]: /images/20220617/09545c0cdf834125a9dbb8fcd7e6c671.png
[SouthEast 1]: /images/20220617/d6ff6993b5e6403a8386313fd08bee4b.png
[DesignPatternStudy]: https://github.com/Switch-vov/DesignPatternStudy