离线下载
PDF版 ePub版

刘伟 · 更新于 2018-07-19 17:00:54

C# 设计模式之代理模式(二)

代理模式应用实例

下面通过一个应用实例来进一步学习和理解代理模式。

实例说明

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

(1) 在进行商务信息查询之前用户需要通过身份验证,只有合法用户才能够使用该查询系统;

(2) 在进行商务信息查询时系统需要记录查询日志,以便根据查询次数收取查询费用。

该软件公司开发人员已完成了商务信息查询模块的开发任务,现希望能够以一种松耦合的方式向原有系统增加身份验证和日志记录功能,客户端代码可以无区别地对待原始的商务信息查询模块和增加新功能之后的商务信息查询模块,而且可能在将来还要在该信息查询模块中增加一些新的功能。

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

实例分析及类图

通过分析,可以采用一种间接访问的方式来实现该商务信息查询系统的设计,在客户端对象和信息查询对象之间增加一个代理对象,让代理对象来实现身份验证和日志记录等功能,而无须直接对原有的商务信息查询对象进行修改,如图所示:

商务信息查询系统设计方案示意图

在图中,客户端对象通过代理对象间接访问具有商务信息查询功能的真实对象,在代理对象中除了调用真实对象的商务信息查询功能外,还增加了身份验证和日志记录等功能。使用代理模式设计该商务信息查询系统,结构图如图所示。

商务信息查询系统结构图

在图 15-4 中,业务类 AccessValidator 用于验证用户身份,业务类 Logger 用于记录用户查询日志,Searcher 充当抽象主题角色,RealSearcher 充当真实主题角色,ProxySearcher 充当代理主题角色。

实例代码

(1) AccessValidator:身份验证类,业务类,它提供方法 Validate() 来实现身份验证。

//AccessValidator.cs
using System;

namespace ProxySample
{
    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() 来保存日志。

//Logger.cs
using System;

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

(3) Searcher:抽象查询类,充当抽象主题角色,它声明了 DoSearch() 方法。

//Searcher.cs
namespace ProxySample
{
    interface Searcher
    {
        string DoSearch(string userId, string keyword);
    }
}

(4) RealSearcher:具体查询类,充当真实主题角色,它实现查询功能,提供方法 DoSearch() 来查询信息。

//RealSearcher.cs
using System;

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

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

//ProxySearcher.cs
namespace ProxySample
{
    class ProxySearcher : Searcher
    {
        private 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);
        }
    }
}

(6) 配置文件 App.config,在配置文件中存储了代理主题类类名。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="proxy" value="ProxySample.ProxySearcher"/>
  </appSettings>
</configuration>

(7) Program:客户端测试类

//Program.cs
using System;
using System.Configuration;
using System.Reflection;

namespace ProxySample
{
    class Program
    {
        static void Main(string[] args)
        {
            //读取配置文件
            string proxy = ConfigurationManager.AppSettings["proxy"];

            //反射生成对象,针对抽象编程,客户端无须分辨真实主题类和代理类
            Searcher searcher;
            searcher = (Searcher)Assembly.Load("ProxySample").CreateInstance(proxy);

            String result = searcher.DoSearch("杨过", "玉女心经");
            Console.Read();
        }
    }
}

结果及分析

编译并运行程序,输出结果如下:

在数据库中验证用户'杨过'是否是合法用户?
'杨过'登录成功!
用户'杨过'使用关键词'玉女心经'查询商务信息!
更新数据库,用户'杨过'查询次数加1!

本实例是保护代理和智能引用代理的应用实例,在代理类 ProxySearcher 中实现对真实主题类的权限控制和引用计数,如果需要在访问真实主题时增加新的访问控制机制和新功能,只需增加一个新的代理类,再修改配置文件,在客户端代码中使用新增代理类即可,源代码无须修改,符合开闭原则。