设计模式 | 代理模式

 1 | 代理模式的概述

我们回顾以下电子商务中常见的现象 =》代购，简单的说就是找人帮忙购买所需的商品，当然代购者可能需要向实施代购的人支付一定的费用。代购的两种情况：

1. 当地购买不到该产品，或者当地该产品的价格比其他地区贵，因此托人在其他地区甚至国外购买该商品；
2. 消费者对该产品的相关信息认知缺乏，自己无法确定商品的实际价值而又不想被商家“坑”，此时只好委托中介机构帮忙讲价或代买，典型的代购网站应用而生；

1.1 代理模式的定义

• 代理模式：给某一个对象提供一个代理或占位服务，并由代理对象来控制对原对象的访问。
• Proxy Pattern：Provide a surrogate or placeholder for another obiect to control access to it.

代理模式是一种对象结构型模式。在代理模式中引人了一个新的代理对象，代理对象在客户端对象和目标对象之间起到中介的作，它去掉客户不能看到的内容和服务或者增添客户需要的额外的新服务。

2 | 代理模式的结构与实现

2.1 代理模式的结构

代理模式的结构比较简单，其核心是代理类，为了让客户端能够一致性地对待真实对象和代理对象，在代理模式中引入了抽象层。

代理模式包含以下3个角色：

• Subject(抽象主题角色)：它声明了真实主题和代理主题的共同接口,这样一来在任何使用真实主题的地方都可以使用代理主题,客户端通常需要针对抽象主题角色进行编程。
• Proxy(代理主题角色)：

1. 它包含了对真实主题的引用，从而可以在任何时候操作真实主题对象；
2. 在代理主题角色中提供了一个与真实主题角色相同的接口，以便在任何时候都可以代替真实主题；
3. 代理主题角色还可以控制对真实主题的使用，负责在需要的时候创建和删除真实主题对象，并对真实主题对象的使用加以约束。通常，在代理主题角色中，客户端在调用所引用的真实主题操作之前或之后还需要执行其他操作，而不仅仅是单纯地调用真实主题对象中的操作。

• RealSubiect(真实主题角色)：它定义了代理角色所代表的真实对象，在真实主题角色中实现了真实的业务操作，客户端可以通过代理主题角色间接调用真实主题角色中的定义的操作。

2.2 代理模式的实现

代理模式的结构图比较简单，但在实际的使用和实现过程中要复杂得多，特别是代理类的设计和实现。典型代码如下：

/// 

/// 抽象主题类
/// 
abstract class Subject 
{
    public abstract void Request();
}

/// 

/// 真实主题类
/// 
class RealSubject : Subject
{
    public override void Request()
    {
        Console.WriteLine("实现具体的业务方法。");
    }
}

/// 

/// 代理类
/// 
class Proxy : Subject 
{
    //维持一个对真实主题对象的引用
    private readonly RealSubject realSubject = new RealSubject();

    public void PreRequest()
    {
        Console.WriteLine("调用真实对象方法前的预处理业务。");
    }

    public override void Request()
    {
        PreRequest();
        realSubject.Request();
        PostRequest();
    }

    public void PostRequest()
    {
        Console.WriteLine("调用真实对象方法后的预处理业务。");
    }
}

• 抽象主题类 Subject 声明了真实主题类和代理类的公共方法，它可以是接口，抽象类或者具体类，客户端针对抽象主题类编程，一致性的对待真实主题和代理主题。
• 真实主题类 RealSubject 继承抽象主题类 Subject，并实现具体的业务方法。
• 代理类 Proxy 也继承抽象主题类 Subject，负责维持一个对真实主题对象的引用，方便对真实主题类中的方法调用，在此基础上还可以扩展附加一些新的方法对功能进行扩展或约束。

在实际开发中，代理类的实现要比上述的例子复杂得多；

代理模式的分类，根据其目的和实现方式的不同，代理模式可以分为以下几种：

• (1) 远程代理(Remote Proxy)：为一个位于不同地址空间的对象提供一个本地的代理对象，这个不同的地址空间可以在同一台主机中，也可以在另一台主机中，远程代理又称为大使(Ambassador)。
• (2) 虚拟代理(Virtual Proxy)：如果需要创建一个资源消耗较大的对象，先创建一个消耗相对较小的对象来表示，真实对象只在需要时才会被真正创建。
• (3) 保护代理(Protect Proxy)：控制对一个对象的访问，可以给不同的用户提供不同级别的使用权限。
• (4) 缓冲代理(Cache Proxy)：为某一个目标操作的结果提供临时的存储空间，以便多个客户端可以共享这些结果。
• (5) 智能引用代理(Smart Reference Proxy)：当一个对象被引用时，提供一些额外的操作，例如将对象被调用的次数记录下来等。

在这些常用的代理模式中，有些代理类的设计非常复杂，例如远程代理类，它封装了底层网络通信和对远程对象的调用，其实现较为复杂。

3 | 代理模式的应用实例

3.1 保护代理应用实例

3.1.1 实例说明

某软件公司承接了某信息咨询公司的收费商务信息查询系统的开发任务，该系统的基本需求如下：

• (1)在进行商务信息查询之前用户需要通过身份验证，只有合法用户才能够使用该查询系统。
• (2)在进行商务信息查询时系统需要记录查询日志，以便根据查询次数收取查询费用。该软件公司开发人员已完成了商务信息查询模块的开发任务，现希望能够以一种松耦合的方式向原有系统增加身份验证和日志记录功能，客户端代码可以无区别地对待原始的商务信息查询模块和增加新功能之后的商务信息查询模块，而且可能在将来还要在该信息查询模块中增加此新的功能。

现使用代理模式设计并实现该收费商务信息查询系统。

3.1.2 实列类图

3.1.3 实例代码

• (1) AccessValidator 身份校验类，业务类，用于验证用户身份信息；

using System;

namespace ProxyPattern.BusinessQuerySystem
{
	/// 

	/// 身份校验类，业务类，用于验证用户身份信息；
	/// 
	class AccessValidator
    {
        //模拟实现登录验证
        public bool Validate(string userId) 
        {
		    Console.WriteLine($"在数据库中验证用户'{userId}'是否是合法用户？");
		    if (userId.Equals("杨过")) 
			{
			    Console.WriteLine("'{0}'登录成功！",userId);
			    return true;
		    }
		    else 
			{
                Console.WriteLine("'{0}'登录失败！", userId);
			    return false;
		    }
	    }
    }
}

• (2) Logger 日志记录类，业务类，它提供方法 Log() 用于记录用户查询日志；

using System;

namespace ProxyPattern.BusinessQuerySystem
{
    class Logger
    {
        //模拟实现日志记录
        public void Log(string userId) 
        {
            Console.WriteLine($"更新数据库，用户'{userId}'查询次数加1！");
	    }
    }
}

• (3) ISearcher 抽象查询类，接口实现，充当抽象主题角色。它申明了 DoSearch() 方法；

namespace ProxyPattern.BusinessQuerySystem
{
    interface ISearcher
    {
        string DoSearch(string userId, string keyword);
    }
}

• (4) RealSearcher 具体查询类，充当真实主题角色。它实现 ISearcher 的 DoSearch() 方法来提供查询信息；

using System;

namespace ProxyPattern.BusinessQuerySystem
{
    class RealSearcher : ISearcher
    {
        //模拟查询商务信息
        public string DoSearch(string userId, string keyword) 
        {
            Console.WriteLine("用户'{0}'使用关键词'{1}'查询商务信息！",userId,keyword);
		    return "返回具体内容";
	    }
    }
}

• (5) ProxySearcher 查询代理类，充当代理主题角色。它是查询代理，维持了对 RealSearcher 对象、 AccessValidator 对象和 Logger 对象的引用。

namespace ProxyPattern.BusinessQuerySystem
{
    class ProxySearcher : ISearcher
    {
        private readonly RealSearcher searcher = new RealSearcher(); //维持一个对真实主题的引用
        private AccessValidator validator;
        private Logger logger;

        public string DoSearch(string userId, string keyword)
        {
            //如果身份验证成功，则执行查询
            if (this.Validate(userId))
            {
                string result = searcher.DoSearch(userId, keyword); //调用真实主题对象的查询方法
                this.Log(userId); //记录查询日志
                return result; //返回查询结果
            }
            else
            {
                return null;
            }
        }

        //创建访问验证对象并调用其Validate()方法实现身份验证
        public bool Validate(string userId)
        {
            validator = new AccessValidator();
            return validator.Validate(userId);
        }

        //创建日志记录对象并调用其Log()方法实现日志记录
        public void Log(string userId)
        {
            logger = new Logger();
            logger.Log(userId);
        }
    }
}

• 配置文件 App.config

• 客户端调用

完整代码示例请查看=》https://gitee.com/dolayout/DesignPatternOfCSharp/tree/master/DesignPatternOfCSharp/ProxyPattern

3.2 远程代理

远程代理(Remote Proxv)是一种常用的代理模式，它使得客户端程序可以访问在远程主机上的对象，远程主机可能具有更好的计算性能与外理速度，可以快速地响应并处理客户端的请求。远程代理可以将网络的细节隐藏起来，使得客户端不必考虑网络的存在。客户端完全可以认为被代理的远程业务对象是在本地而不是在远程，而远程代理对象承担了大部分的网络通信工作，并负责对远程业务方法的调用。

客户端对象不能直接访问远程主机中的业务对象，只能采取间接访问的方式。远程业务对象在本地主机中有一个代理对象，该代理对象负责对远程业务对象的访问和网络通信，它对于客户端对象而言是透明的。客户端无须关心实现具体业务的是谁，只需要按照服务接口所定义的方式直接与本地主机中的代理对象交互即可。

 

在基于.NET平台的分布式技术，例如 DCOM(Distribute Component Object Model分布式组件对象模型)、Web Service 中，都应用了远程代理模式，感兴趣的小伙伴可以自行查阅相关资料行扩展学习。 

• 【三层架构】——COM/DCOM初识
• 分布式设计之DCOM实现

3.3 虚拟代理

虚拟代理(Virtual Proxy)也是一种常用的代理模式，对于一些占用系统资源较多或者加载时间较长的对象，可以给这些对象提供一个虚拟代理。在真实对象的创建成功之前虚拟代理扮演真实对象的替身，而当真实对象创建之后，虚拟代理将用户的请求转发给真实对象。

通常，在以下两种情况下可以考虑使用虚拟代理：

• (1)由于对象本身的复杂性或者网络等原因导致一个对象需要较长的加载时间，此时可以用一个加载时间相对较短的代理对象来代表真实对象。通常，在实现时可以结合多线程技术，一个线程用于显示代理对象，其他线程用于加载真实对象。这种虚拟代理模式可以应用在程序启动的时候，由于创建代理对象在时间和处理复杂度上要少于创建真实的对象，因此，在程序启动时，可以用代理对象代替真实对象初始化，大大加速了系统的启动时间。当需要适用真实对象时，在通过代理对象来引用，而此时真实对象可能已经成功加载完毕，可以缩短用户的等待时间。
• (2)当一个对象的加载十分耗费系统资源的时候，也非常适合使用虚拟代理。虚拟代理可以让那些占用大量内存或处理起来非常复杂的对象推迟到使用它们的时候才创建，而在此之前用一个相对来说占用资源较少的代理对象来代表真实对象，再通过代理对象来引用真实对象。为了节省内存，在第一次引用真实对象时再创建对象，并且该对象可以被多次重用，在以后每次访问时需要检测所需对象是否已经被创建，因此在访问该对象时需要进行存在性检测，这需要消耗一定的系统时间，但是可以 节省内存空间，这是一种用时间换取空间的做法。

无论是以上哪种情况，虚拟代理都是用一个“虚假”的代理对象来代表真实对象，通过代理对象来间接引用真实对象，可以在一定程度上提高系统的性能。

3.4 缓冲代理

缓冲代理(Cache Proxy)也是一种较 为常用的代理模式，它为某一个操作的结果提供临时的缓存存储空间，以便在后续使用中能够共享这些结果，从而避免某些方法的重复执行，优化系统性能。

在微软示例项目 PetShop 4.0 的业务逻辑层(Business Logic Layer，BLL)中定义了 Product、Category、Item 等类，它们封装了相关的业务方法，用于调用数据访问层(DataAccess Layer， DAL)对象访问数据库，以获取相关数据。为了改进系统性能，PetShop 4. 0为这些实现方法增加了缓存机制，引人一个新的对象去控制原来的BLL业务逻辑对象，这些新的对象对应于代理模式中的代理对象。在引入代理模式后，实现了在缓存级别上对业务对象的封装，增强了对业务对象的控制，如果需要访问的数据在缓存中已经存在，则无须再重复执行获取数据的方法，直接返回存储在缓存中的数据即可。由于原有业务对象(真实对象)和新增代理对象暴露在外的方法是一致的，因而对于调用方(即客户端)而言，调用代理对象与真实对象并没有实质的区别。

这些新引人的代理类包括 ProductDataProxy、CategoryDataProxy 和 ItemDataProxy 等。下面以 PetShop.BLL.Product 业务对象为例进行说明，PetShop 4.0 为其建立了代理对象 ProductDataProxy ，并在该代理对象的 GetProductsByCategory() 方法，同时增加了缓存机制，如下入所示：

在  ProductDataProxy 类中存在以下代码片段：

 

3.4.1 PetShop vNext 简单介绍

PetShop vNext 访问地址 =》https://archive.codeplex.com/?p=petshopvnext#DownloadId=25356

CodePlex 是微软的免费开源项目托管网站，趁着在退役前（2021年7月1日）网站还能访问（目前处于存档模式），页面截图做个历史 (*￣︶￣) 

petshopvnext 源代码地址 =》https://download.csdn.net/download/ChaITSimpleLove/16686855

Microsoft .NET PetShop 相关参考文章：

• 《解剖PetShop》之一：PetShop的系统架构设计
• 《解剖PetShop》之二：PetShop数据访问层数之据库访问设计 
• 《解剖PetShop》之三：PetShop数据访问层之消息处理
• 《解剖PetShop》之四：PetShop之ASP.NET缓存
• 《解剖PetShop》之五：PetShop之业务逻辑层设计
• 《解剖PetShop》之六：PetShop之表示层设计
•   学会sql数据库关系图(Petshop)
• Microsoft .NET PetShop 4.0 架构与技术分析
• Microsoft .NET PetShop 4.0 架构与技术分析(一)​​​​​​
• 【文档下载】PetShop 5.0 详解之一（系统架构设计-2017-09-01）修订版

4 | 代理模式的优缺点与适用环境

代理模式是常用的结构型设计模式之一，它为对象的间接访问提供了一个解决方案，可以对刘象的访问进行控制。代理模式的类型较多，其中远程代理、虚拟代理、保护代理等在软件开发中的应用非常广泛。

4.1 代理模式的优点

• (1)代理模式能够协调调用者和被调用者，在一定程度上降低了系统的熊合度。
• (2)客户烟可以针对抽象主题角色进行编程，增加和更换代理类无须修改源代码，符合开团原则，系统具有较好的灵活性和可扩展性。

此外，不同类型的代理模式具有独特的优点，例如：

• (1)远程代理为位于两个不同地址空间对象的访问提供了一种实现机制，可以将一些消耗资源较多的对象和操作移至性能更好的计算机上，提高了系统的整体运行效率。
• (2)虚拟代理通过一个消耗资源较少的对象来代表一个消耗资源较多的对象，可以在一定程度上节省系统的运行开销。
• (3)缓冲代理为某一个操作的结果提供临时的缓存存储空间，以便在后续使用中能够共享这些结果，优化系统性能，缩短执行时间。
• (4)保护代理可以控制对一个对象的访问权限，为不同用户提供不同级别的使用权限。

4.2 代理模式的缺点

• (1)由于在客户端和真实主题之间增加了代理对象﹐因此有些类型的代理模式可能会造成请求的处理速度变慢，例如保护代理。
• (2)实现代理模式需要额外的工作，而且有些代理模式的实现过程较为复杂，例如远程代理。

4.3 代理模式的适用环境

代理模式的类型较多，不同类型的代理模式有不同的优缺点，它们应用于不同的环境;

• (1)当客户端对象需要访间远程主机中的对象时可以使用远程代理。
• (2)当需要用一个消耗资源较少的对象来代表一个消耗资源较多的对象，从而降低系就开销、缩短运行时间时可以使用虚拟代理，例如一个对象圈要很长时间才能完成加载时。
• (3)当需要为某一个被频繁访间的操作结果枫供一个临时存储空间，以供多个客户端共享访间这些结果时可以使用缓冲代理，通过使用缓冲代理，系统无须在客户端每一次访问时都重新执行操作，只需直接从临时缓冲区获取操作结果即可。
• (4)当需要控制对一个对象的访问，为不同用户提供不同级别的访问权限时可以使用保护代理。
• (5)当需要为一个对象的访问(引用)提供一些额外的操作时可以使用智能引用代理。