Proxy pattern
Software design pattern
- 6 min read
- 4 chapters
Related on Lably
Through Computer programming and Object-oriented programming
Overview
The proxy design pattern is one of the twenty-three well-known GoF design patterns that describe how to solve recurring design problems to design flexible and reusable object-oriented software, that is, objects that are easier to implement, change, test, and reuse.
Problem
The proxy design pattern is used to solve such problems:
- The access to an object should be controlled.
- Additional functionality should be provided when accessing an object.
When accessing sensitive objects, for example, it should be possible to check that clients have the needed access rights.
Solution
Define a separate Proxy object that
- can be used as a substitute for another object (
Subject), and - implements additional functionality to control the access to this subject.
This makes it possible to work through a Proxy object to perform additional functionality when accessing a subject, like checking the access rights of clients accessing a sensitive object.
To act as a substitute for a subject, a proxy must implement the Subject interface. Clients can't tell whether they work with a subject or its proxy.
See also the UML class and sequence diagram below.
Sign in to keep reading
3 more chapters are free with a Lably account.
Structure
UML class and sequence diagram
In the above UML class diagram, the Proxy class implements the Subject interface so that it can act as substitute for Subject objects. It maintains a reference (realSubject) to the substituted object (RealSubject) so that it can forward requests to it (realSubject.operation()).
The sequence diagram shows the run-time interactions: The Client object works through a Proxy object that controls the access to a RealSubject object. In this example, the Proxy forwards the request to the RealSubject, which performs the request.
Class diagram
Possible usage scenarios
Remote proxy
In distributed object communication, a local object represents a remote object (one that belongs to a different address space). The local object is a proxy for the remote object, and method invocation on the local object results in remote method invocation on the remote object. An example would be an ATM implementation, where the ATM might hold proxy objects for bank information that exists in the remote server.
Virtual proxy
In place of a complex or heavy object, a skeleton representation may be advantageous in some cases. When an underlying image is huge in size, it may be represented using a virtual proxy object, loading the real object on demand.
Protection proxy
A protection proxy might be used to control access to a resource based on access rights.
Example
The following is an example of the proxy design pattern in C++:
<span id="mwYA"></span><span class="k" id="mwYQ">import</span><span class="w" id="mwYg"> </span><span class="n" id="mwYw">std</span><span class="p" id="mwZA">;</span> <span class="k" id="mwZQ">using</span><span class="w" id="mwZg"> </span><span class="n" id="mwZw">std</span><span class="o" id="mwaA">::</span><span class="n" id="mwaQ">string</span><span class="p" id="mwag">;</span> <span class="k" id="mwaw">using</span><span class="w" id="mwbA"> </span><span class="n" id="mwbQ">std</span><span class="o" id="mwbg">::</span><span class="n" id="mwbw">unique_ptr</span><span class="p" id="mwcA">;</span> <span class="c1" id="mwcQ">// Subject Interface</span> <span class="k" id="mwcg">class</span><span class="w" id="mwcw"> </span><span class="nc" id="mwdA">Image</span><span class="w" id="mwdQ"> </span><span class="p" id="mwdg">{</span> <span class="k" id="mwdw">public</span><span class="o" id="mweA">:</span> <span class="w" id="mweQ"> </span><span class="k" id="mweg">virtual</span><span class="w" id="mwew"> </span><span class="kt" id="mwfA">void</span><span class="w" id="mwfQ"> </span><span class="n" id="mwfg">display</span><span class="p" id="mwfw">()</span><span class="w" id="mwgA"> </span><span class="k" id="mwgQ">const</span><span class="w" id="mwgg"> </span><span class="o" id="mwgw">=</span><span class="w" id="mwhA"> </span><span class="mi" id="mwhQ">0</span><span class="p" id="mwhg">;</span> <span class="w" id="mwhw"> </span><span class="k" id="mwiA">virtual</span><span class="w" id="mwiQ"> </span><span class="o" id="mwig">~</span><span class="n" id="mwiw">Image</span><span class="p" id="mwjA">()</span><span class="w" id="mwjQ"> </span><span class="o" id="mwjg">=</span><span class="w" id="mwjw"> </span><span class="k" id="mwkA">default</span><span class="p" id="mwkQ">;</span> <span class="p" id="mwkg">};</span> <span class="c1" id="mwkw">// Real Subject (expensive to load)</span> <span class="k" id="mwlA">class</span><span class="w" id="mwlQ"> </span><span class="nc" id="mwlg">RealImage</span><span class="w" id="mwlw"> </span><span class="o" id="mwmA">:</span><span class="w" id="mwmQ"> </span><span class="k" id="mwmg">public</span><span class="w" id="mwmw"> </span><span class="n" id="mwnA">Image</span><span class="w" id="mwnQ"> </span><span class="p" id="mwng">{</span> <span class="k" id="mwnw">private</span><span class="o" id="mwoA">:</span> <span class="w" id="mwoQ"> </span><span class="n" id="mwog">string</span><span class="w" id="mwow"> </span><span class="n" id="mwpA">filename</span><span class="p" id="mwpQ">;</span> <span class="k" id="mwpg">public</span><span class="o" id="mwpw">:</span> <span class="w" id="mwqA"> </span><span class="k" id="mwqQ">explicit</span><span class="w" id="mwqg"> </span><span class="n" id="mwqw">RealImage</span><span class="p" id="mwrA">(</span><span class="k" id="mwrQ">const</span><span class="w" id="mwrg"> </span><span class="n" id="mwrw">string</span><span class="o" id="mwsA">&</span><span class="w" id="mwsQ"> </span><span class="n" id="mwsg">file</span><span class="p" id="mwsw">)</span><span class="o" id="mwtA">:</span> <span class="w" id="mwtQ"> </span><span class="n" id="mwtg">filename</span><span class="p" id="mwtw">{</span><span class="n" id="mwuA">file</span><span class="p" id="mwuQ">}</span><span class="w" id="mwug"> </span><span class="p" id="mwuw">{</span> <span class="w" id="mwvA"> </span><span class="n" id="mwvQ">loadFromDisk</span><span class="p" id="mwvg">();</span> <span class="w" id="mwvw"> </span><span class="p" id="mwwA">}</span> <span class="w" id="mwwQ"> </span><span class="kt" id="mwwg">void</span><span class="w" id="mwww"> </span><span class="n" id="mwxA">display</span><span class="p" id="mwxQ">()</span><span class="w" id="mwxg"> </span><span class="k" id="mwxw">const</span><span class="w" id="mwyA"> </span><span class="k" id="mwyQ">override</span><span class="w" id="mwyg"> </span><span class="p" id="mwyw">{</span> <span class="w" id="mwzA"> </span><span class="n" id="mwzQ">std</span><span class="o" id="mwzg">::</span><span class="n" id="mwzw">println</span><span class="p" id="mw0A">(</span><span class="s" id="mw0Q">"Displaying image: {}"</span><span class="p" id="mw0g">,</span><span class="w" id="mw0w"> </span><span class="n" id="mw1A">filename</span><span class="p" id="mw1Q">);</span> <span class="w" id="mw1g"> </span><span class="p" id="mw1w">}</span> <span class="k" id="mw2A">private</span><span class="o" id="mw2Q">:</span> <span class="w" id="mw2g"> </span><span class="kt" id="mw2w">void</span><span class="w" id="mw3A"> </span><span class="n" id="mw3Q">loadFromDisk</span><span class="p" id="mw3g">()</span><span class="w" id="mw3w"> </span><span class="k" id="mw4A">const</span><span class="w" id="mw4Q"> </span><span class="p" id="mw4g">{</span> <span class="w" id="mw4w"> </span><span class="n" id="mw5A">std</span><span class="o" id="mw5Q">::</span><span class="n" id="mw5g">println</span><span class="p" id="mw5w">(</span><span class="s" id="mw6A">"Loading image from disk: {}"</span><span class="p" id="mw6Q">,</span><span class="w" id="mw6g"> </span><span class="n" id="mw6w">filename</span><span class="p" id="mw7A">);</span> <span class="w" id="mw7Q"> </span><span class="p" id="mw7g">}</span> <span class="p" id="mw7w">};</span> <span class="c1" id="mw8A">// Proxy (controls access to RealImage)</span> <span class="k" id="mw8Q">class</span><span class="w" id="mw8g"> </span><span class="nc" id="mw8w">ProxyImage</span><span class="w" id="mw9A"> </span><span class="o" id="mw9Q">:</span><span class="w" id="mw9g"> </span><span class="k" id="mw9w">public</span><span class="w" id="mw-A"> </span><span class="n" id="mw-Q">Image</span><span class="w" id="mw-g"> </span><span class="p" id="mw-w">{</span> <span class="k" id="mw_A">private</span><span class="o" id="mw_Q">:</span> <span class="w" id="mw_g"> </span><span class="n" id="mw_w">string</span><span class="w" id="mwAQA"> </span><span class="n" id="mwAQE">filename</span><span class="p" id="mwAQI">;</span> <span class="w" id="mwAQM"> </span><span class="k" id="mwAQQ">mutable</span><span class="w" id="mwAQU"> </span><span class="n" id="mwAQY">unique_ptr</span><span class="o" id="mwAQc"><</span><span class="n" id="mwAQg">RealImage</span><span class="o" id="mwAQk">></span><span class="w" id="mwAQo"> </span><span class="n" id="mwAQs">realImage</span><span class="p" id="mwAQw">;</span><span class="w" id="mwAQ0"> </span><span class="c1" id="mwAQ4">// lazily created</span> <span class="k" id="mwAQ8">public</span><span class="o" id="mwARA">:</span> <span class="w" id="mwARE"> </span><span class="k" id="mwARI">explicit</span><span class="w" id="mwARM"> </span><span class="n" id="mwARQ">ProxyImage</span><span class="p" id="mwARU">(</span><span class="k" id="mwARY">const</span><span class="w" id="mwARc"> </span><span class="n" id="mwARg">string</span><span class="o" id="mwARk">&</span><span class="w" id="mwARo"> </span><span class="n" id="mwARs">file</span><span class="p" id="mwARw">)</span><span class="o" id="mwAR0">:</span> <span class="w" id="mwAR4"> </span><span class="n" id="mwAR8">filename</span><span class="p" id="mwASA">{</span><span class="n" id="mwASE">file</span><span class="p" id="mwASI">}</span><span class="w" id="mwASM"> </span><span class="p" id="mwASQ">{}</span> <span class="w" id="mwASU"> </span><span class="kt" id="mwASY">void</span><span class="w" id="mwASc"> </span><span class="n" id="mwASg">display</span><span class="p" id="mwASk">()</span><span class="w" id="mwASo"> </span><span class="k" id="mwASs">const</span><span class="w" id="mwASw"> </span><span class="k" id="mwAS0">override</span><span class="w" id="mwAS4"> </span><span class="p" id="mwAS8">{</span> <span class="w" id="mwATA"> </span><span class="k" id="mwATE">if</span><span class="w" id="mwATI"> </span><span class="p" id="mwATM">(</span><span class="o" id="mwATQ">!</span><span class="n" id="mwATU">realImage</span><span class="p" id="mwATY">)</span><span class="w" id="mwATc"> </span><span class="p" id="mwATg">{</span> <span class="w" id="mwATk"> </span><span class="n" id="mwATo">std</span><span class="o" id="mwATs">::</span><span class="n" id="mwATw">println</span><span class="p" id="mwAT0">(</span><span class="s" id="mwAT4">"(Proxy) Loading image on demand..."</span><span class="p" id="mwAT8">);</span> <span class="w" id="mwAUA"> </span><span class="n" id="mwAUE">realImage</span><span class="w" id="mwAUI"> </span><span class="o" id="mwAUM">=</span><span class="w" id="mwAUQ"> </span><span class="n" id="mwAUU">std</span><span class="o" id="mwAUY">::</span><span class="n" id="mwAUc">make_unique</span><span class="o" id="mwAUg"><</span><span class="n" id="mwAUk">RealImage</span><span class="o" id="mwAUo">></span><span class="p" id="mwAUs">(</span><span class="n" id="mwAUw">filename</span><span class="p" id="mwAU0">);</span> <span class="w" id="mwAU4"> </span><span class="p" id="mwAU8">}</span> <span class="w" id="mwAVA"> </span><span class="n" id="mwAVE">realImage</span><span class="o" id="mwAVI">-></span><span class="n" id="mwAVM">display</span><span class="p" id="mwAVQ">();</span> <span class="w" id="mwAVU"> </span><span class="p" id="mwAVY">}</span> <span class="p" id="mwAVc">};</span> <span class="c1" id="mwAVg">// Client code</span> <span class="kt" id="mwAVk">int</span><span class="w" id="mwAVo"> </span><span class="nf" id="mwAVs">main</span><span class="p" id="mwAVw">()</span><span class="w" id="mwAV0"> </span><span class="p" id="mwAV4">{</span> <span class="w" id="mwAV8"> </span><span class="n" id="mwAWA">Image</span><span class="o" id="mwAWE">*</span><span class="w" id="mwAWI"> </span><span class="n" id="mwAWM">img</span><span class="w" id="mwAWQ"> </span><span class="o" id="mwAWU">=</span><span class="w" id="mwAWY"> </span><span class="k" id="mwAWc">new</span><span class="w" id="mwAWg"> </span><span class="n" id="mwAWk">ProxyImage</span><span class="p" id="mwAWo">(</span><span class="s" id="mwAWs">"photo.png"</span><span class="p" id="mwAWw">);</span> <span class="w" id="mwAW0"> </span><span class="c1" id="mwAW4">// First display (should load)</span> <span class="w" id="mwAW8"> </span><span class="n" id="mwAXA">img</span><span class="o" id="mwAXE">-></span><span class="n" id="mwAXI">display</span><span class="p" id="mwAXM">();</span> <span class="w" id="mwAXQ"> </span><span class="c1" id="mwAXU">// Second display (should use cached image)</span> <span class="w" id="mwAXY"> </span><span class="n" id="mwAXc">img</span><span class="o" id="mwAXg">-></span><span class="n" id="mwAXk">display</span><span class="p" id="mwAXo">();</span> <span class="w" id="mwAXs"> </span><span class="k" id="mwAXw">delete</span><span class="w" id="mwAX0"> </span><span class="n" id="mwAX4">img</span><span class="p" id="mwAX8">;</span> <span class="w" id="mwAYA"> </span><span class="k" id="mwAYE">return</span><span class="w" id="mwAYI"> </span><span class="mi" id="mwAYM">0</span><span class="p" id="mwAYQ">;</span> <span class="p" id="mwAYU">}</span>
