Design Pattern----14.Structural.Proxy.Pattern (CSharp Sample)

Intent

• Provide a surrogate or placeholder for another object to control access to it.
• Use an extra level of indirection to support distributed, controlled, or intelligent access.
• Add a wrapper and delegation to protect the real component from undue complexity.

Problem

You need to support resource-hungry objects, and you do not want to instantiate such objects unless and until they are actually requested by the client.

Discussion

Design a surrogate, or proxy, object that: instantiates the real object the first time the client makes a request of the proxy, remembers the identity of this real object, and forwards the instigating request to this real object. Then all subsequent requests are simply forwarded directly to the encapsulated real object.

 

There are four common situations in which the Proxy pattern is applicable.

 

1. A virtual proxy is a placeholder for “expensive to create” objects. The real object is only created when a client first requests/accesses the object.
2. A remote proxy provides a local representative for an object that resides in a different address space. This is what the “stub” code in RPC and CORBA provides.
3. A protective proxy controls access to a sensitive master object. The “surrogate” object checks that the caller has the access permissions required prior to forwarding the request.
4. A smart proxy interposes additional actions when an object is accessed. Typical uses include:
   • Counting the number of references to the real object so that it can be freed automatically when there are no more references (aka smart pointer),
   • Loading a persistent object into memory when it’s first referenced,
   • Checking that the real object is locked before it is accessed to ensure that no other object can change it.

Structure

By defining a Subject interface, the presence of the Proxy object standing in place of the RealSubject is transparent to the client.

Example

The Proxy provides a surrogate or place holder to provide access to an object. A check or bank draft is a proxy for funds in an account. A check can be used in place of cash for making purchases and ultimately controls access to cash in the issuer’s account.

Check list

1. Identify the leverage or “aspect” that is best implemented as a wrapper or surrogate.
2. Define an interface that will make the proxy and the original component interchangeable.
3. Consider defining a Factory that can encapsulate the decision of whether a proxy or original object is desirable.
4. The wrapper class holds a pointer to the real class and implements the interface.
5. The pointer may be initialized at construction, or on first use.
6. Each wrapper method contributes its leverage, and delegates to the wrappee object.

Rules of thumb

• Adapter provides a different interface to its subject. Proxy provides the same interface. Decorator provides an enhanced interface.
• Decorator and Proxy have different purposes but similar structures. Both describe how to provide a level of indirection to another object, and the implementations keep a reference to the object to which they forward requests.

CSharp Sample

Provides a surrogate or placeholder for another object to control access to it.

 

This structural code demonstrates the Proxy pattern which provides a representative object (proxy) that controls access to another similar object.

  1: using System;



  2: 



  3:   // MainApp test application 



  4:   class MainApp



  5:   {



  6:     static void Main()



  7:     {



  8:       // Create proxy and request a service 



  9:       Proxy proxy = new Proxy();



 10:       proxy.Request();



 11: 



 12:       // Wait for user 



 13:       Console.Read();



 14:     }



 15:   }



 16: 



 17:   // "Subject" 



 18:   abstract class Subject 



 19:   {



 20:     public abstract void Request();    



 21:   }



 22: 



 23:   // "RealSubject" 



 24:   class RealSubject : Subject



 25:   {



 26:     public override void Request()



 27:     {



 28:       Console.WriteLine("Called RealSubject.Request()");



 29:     }



 30:   }



 31: 



 32:   // "Proxy" 



 33:   class Proxy : Subject



 34:   {



 35:     RealSubject realSubject;



 36: 



 37:     public override void Request()



 38:     {



 39:       // Use 'lazy initialization' 



 40:       if (realSubject == null)



 41:       {



 42:         realSubject = new RealSubject();



 43:       }



 44: 



 45:       realSubject.Request();



 46:     }  



 47:   }

Called RealSubject.Request()