README.md 58.6 KB
Newer Older
1
# Design pattern samples in Java.
I
Ilkka Seppälä 已提交
2

T
The Gitter Badger 已提交
3 4
[![Join the chat at https://gitter.im/iluwatar/java-design-patterns](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/iluwatar/java-design-patterns?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

I
Ilkka Seppälä 已提交
5 6 7 8
![Build status](https://travis-ci.org/iluwatar/java-design-patterns.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/iluwatar/java-design-patterns/badge.svg?branch=master)](https://coveralls.io/r/iluwatar/java-design-patterns?branch=master) <a href="https://scan.coverity.com/projects/5634">
  <img alt="Coverity Scan Build Status"
       src="https://scan.coverity.com/projects/5634/badge.svg"/>
</a>
I
Ilkka Seppälä 已提交
9

10
 <a name="top"/>
11 12 13 14 15
 - <a href="#introduction">Introduction</a>
 - <a href="#list-of-design-patterns">List of Design Patterns</a>
   - <a href="#creational-patterns">Creational Patterns</a>
   - <a href="#structural-patterns">Structural Patterns</a>
   - <a href="#behavioral-patterns">Behavioral Patterns</a>
16
   - <a href="#concurrency-patterns">Concurrency Patterns</a>
17 18 19 20 21 22 23 24 25 26 27 28 29
   - <a href="#presentation-tier-patterns">Presentation Tier Patterns</a>
   - <a href="#business-tier-patterns">Business Tier Patterns</a>
   - <a href="#architectural-patterns">Architectural Patterns</a>
   - <a href="#integration-patterns">Integration Patterns</a>
 - <a href="#idioms">Idioms</a>
 - <a href="#faq">Frequently Asked Questions</a>
 - <a href="#how-to-contribute">How to contribute</a>
 - <a href="#versioning">Versioning</a>
 - <a href="#credits">Credits</a>
 - <a href="#license">License</a>
 

## <a name="introduction">Introduction</a>
30

31 32
Design patterns are formalized best practices that the programmer can use to
solve common problems when designing an application or system.
33

34 35
Design patterns can speed up the development process by providing tested, proven
development paradigms.
36

37 38 39
Reusing design patterns helps to prevent subtle issues that can cause major
problems, and it also improves code readability for coders and architects who
are familiar with the patterns.
40

41
## <a name="list-of-design-patterns">List of Design Patterns</a> [&#8593;](#top)
42

43
### <a name="creational-patterns">Creational Patterns</a> [&#8593;](#top)
44

45 46
Creational design patterns abstract the instantiation process. They help make a
system independent of how its objects are created, composed, and represented.
47

I
Ilkka Seppälä 已提交
48 49 50 51
* [Abstract Factory](#abstract-factory)
* [Builder](#builder)
* [Factory Method](#factory-method)
* [Prototype](#prototype)
V
vehpsr 已提交
52
* [Property](#property)
I
Ilkka Seppälä 已提交
53
* [Singleton](#singleton)
54
* [Step Builder](#step-builder)
55
* [Multiton](#multiton)
56
* [Object Pool](#object-pool)
V
vehpsr 已提交
57

58
### <a name="structural-patterns">Structural Patterns</a> [&#8593;](#top)
59

60 61
Structural patterns are concerned with how classes and objects are composed to
form larger structures.
62

I
Ilkka Seppälä 已提交
63 64 65 66 67 68 69 70 71 72
* [Adapter](#adapter)
* [Bridge](#bridge)
* [Composite](#composite)
* [Decorator](#decorator)
* [Facade](#facade)
* [Flyweight](#flyweight)
* [Proxy](#proxy)
* [Service Locator](#service-locator)
* [Servant](#servant)
* [Event Aggregator](#event-aggregator)
73
 
74
### <a name="behavioral-patterns">Behavioral Patterns</a> [&#8593;](#top)
I
Ilkka Seppälä 已提交
75

76 77
Behavioral patterns are concerned with algorithms and the assignment of
responsibilities between objects.
78

I
Ilkka Seppälä 已提交
79 80 81 82 83 84 85 86 87 88 89 90
* [Chain of responsibility](#chain-of-responsibility)
* [Command](#command)
* [Interpreter](#interpreter)
* [Iterator](#iterator)
* [Mediator](#mediator)
* [Memento](#memento)
* [Observer](#observer)
* [State](#state)
* [Strategy](#strategy)
* [Template method](#template-method)
* [Visitor](#visitor)
* [Null Object](#null-object)
91
* [Intercepting Filter](#intercepting-filter)
I
Ilkka Seppala 已提交
92
* [Specification](#specification)
93
* [Dependency Injection](#dependency-injection)
94

95
### <a name="concurrency-patterns">Concurrency Patterns</a> [&#8593;](#top)
96

97 98
Concurrency patterns are those types of design patterns that deal with the
multi-threaded programming paradigm.
99 100

* [Double Checked Locking](#double-checked-locking)
I
Ilkka Seppala 已提交
101
* [Thread Pool](#thread-pool)
102
* [Async Method Invocation](#async-method-invocation)
103
* [Half-Sync/Half-Async](#half-sync-half-async)
104

105
### <a name="presentation-tier-patterns">Presentation Tier Patterns</a> [&#8593;](#top)
J
joshzambales 已提交
106

107 108 109
Presentation Tier patterns are the top-most level of the application, this is
concerned with translating tasks and results to something the user can
understand.
J
joshzambales 已提交
110

111
* [Model-View-Controller](#model-view-controller)
112
* [Model-View-Presenter](#model-view-presenter)
113
* [Flux](#flux)
114
* [Front Controller](#front-controller)
J
joshzambales 已提交
115

116
### <a name="business-tier-patterns">Business Tier Patterns</a> [&#8593;](#top)
117 118 119

* [Business Delegate](#business-delegate)

120
### <a name="architectural-patterns">Architectural Patterns</a> [&#8593;](#top)
121

122 123
An architectural pattern is a general, reusable solution to a commonly occurring
problem in software architecture within a given context.
124 125

* [Data Access Object](#dao)
126
* [Service Layer](#service-layer)
I
Ilkka Seppala 已提交
127
* [Naked Objects](#naked-objects)
128
* [Repository](#repository)
129

130
### <a name="integration-patterns">Integration Patterns</a> [&#8593;](#top)
I
Ilkka Seppala 已提交
131

132 133
Integration patterns are concerned with how software applications communicate
and exchange data.
I
Ilkka Seppala 已提交
134 135 136

* [Tolerant Reader](#tolerant-reader)

137
### <a name="idioms">Idioms</a> [&#8593;](#top)
138

139 140 141 142 143 144 145
A programming idiom is a means of expressing a recurring construct in one or
more programming languages. Generally speaking, a programming idiom is an
expression of a simple task, algorithm, or data structure that is not a built-in
feature in the programming language being used, or, conversely, the use of an
unusual or notable feature that is built into a programming language. What
distinguishes idioms from patterns is generally the size, the idioms tend to be
something small while the patterns are larger.
146 147

* [Execute Around](#execute-around)
V
vehpsr 已提交
148
* [Poison Pill](#poison-pill)
V
vehpsr 已提交
149
* [Callback](#callback)
I
Ilkka Seppala 已提交
150
* [Lazy Loading](#lazy-loading)
151
* [Double Dispatch](#double-dispatch)
152
* [Resource Acquisition Is Initialization](#resource-acquisition-is-initialization)
153
* [Private Class Data](#private-class-data)
J
joshzambales 已提交
154

155
## <a name="abstract-factory">Abstract Factory</a> [&#8593;](#list-of-design-patterns)
156 157
**Intent:** Provide an interface for creating families of related or dependent
objects without specifying their concrete classes.
I
Ilkka Seppälä 已提交
158

159
![alt text](./abstract-factory/etc/abstract-factory_1.png "Abstract Factory")
I
Ilkka Seppälä 已提交
160

I
Ilkka Seppälä 已提交
161
**Applicability:** Use the Abstract Factory pattern when
I
Ilkka Seppälä 已提交
162 163 164 165
* a system should be independent of how its products are created, composed and represented
* a system should be configured with one of multiple families of products
* a family of related product objects is designed to be used together, and you need to enforce this constraint
* you want to provide a class library of products, and you want to reveal just their interfaces, not their implementations
I
Ilkka Seppälä 已提交
166

167
**Real world examples:**
168
* [javax.xml.parsers.DocumentBuilderFactory](http://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/DocumentBuilderFactory.html)
169

170
## <a name="builder">Builder</a> [&#8593;](#list-of-design-patterns)
171 172 173
**Intent:** Separate the construction of a complex object from its
representation so that the same construction process can create different
representations.
I
Ilkka Seppälä 已提交
174

175
![alt text](./builder/etc/builder_1.png "Builder")
I
Ilkka Seppälä 已提交
176

I
Ilkka Seppälä 已提交
177 178
**Applicability:** Use the Builder pattern when
* the algorithm for creating a complex object should be independent of the parts that make up the object and how they're assembled
I
Ilkka Seppälä 已提交
179
* the construction process must allow different representations for the object that's constructed
I
Ilkka Seppälä 已提交
180

181
**Real world examples:**
182
* [java.lang.StringBuilder](http://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html)
183
* [Apache Camel builders](https://github.com/apache/camel/tree/0e195428ee04531be27a0b659005e3aa8d159d23/camel-core/src/main/java/org/apache/camel/builder)
184

185
## <a name="factory-method">Factory Method</a> [&#8593;](#list-of-design-patterns)
186 187 188
**Intent:** Define an interface for creating an object, but let subclasses
decide which class to instantiate. Factory Method lets a class defer
instantiation to subclasses.
I
Ilkka Seppälä 已提交
189

190
![alt text](./factory-method/etc/factory-method_1.png "Factory Method")
I
Ilkka Seppälä 已提交
191 192 193 194 195 196

**Applicability:** Use the Factory Method pattern when
* a class can't anticipate the class of objects it must create
* a class wants its subclasses to specify the objects it creates
* classes delegate responsibility to one of several helper subclasses, and you want to localize the knowledge of which helper subclass is the delegate

197
## <a name="prototype">Prototype</a> [&#8593;](#list-of-design-patterns)
198 199
**Intent:** Specify the kinds of objects to create using a prototypical
instance, and create new objects by copying this prototype.
I
Ilkka Seppälä 已提交
200

201
![alt text](./prototype/etc/prototype_1.png "Prototype")
I
Ilkka Seppälä 已提交
202 203 204 205 206 207

**Applicability:** Use the Prototype pattern when a system should be independent of how its products are created, composed and represented; and
* when the classes to instantiate are specified at run-time, for example, by dynamic loading; or
* to avoid building a class hierarchy of factories that parallels the class hierarchy of products; or
* when instances of a class can have one of only a few different combinations of state. It may be more convenient to install a corresponding number of prototypes and clone them rather than instantiating the class manually, each time with the appropriate state

208
**Real world examples:**
209
* [java.lang.Object#clone()](http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone%28%29)
210

211
## <a name="singleton">Singleton</a> [&#8593;](#list-of-design-patterns)
212 213
**Intent:** Ensure a class only has one instance, and provide a global point of
access to it.
I
Ilkka Seppälä 已提交
214

215
![alt text](./singleton/etc/singleton_1.png "Singleton")
I
Ilkka Seppälä 已提交
216 217

**Applicability:** Use the Singleton pattern when
M
Matthew Dean 已提交
218
* there must be exactly one instance of a class, and it must be accessible to clients from a well-known access point
I
Ilkka Seppälä 已提交
219 220
* when the sole instance should be extensible by subclassing, and clients should be able to use an extended instance without modifying their code

L
llitfkitfk 已提交
221 222 223 224 225
**Typical Use Case:**
* the logging class
* managing a connection to a database
* file manager

226
**Real world examples:**
227
* [java.lang.Runtime#getRuntime()](http://docs.oracle.com/javase/8/docs/api/java/lang/Runtime.html#getRuntime%28%29)
228

229 230 231 232 233 234 235 236
## <a name="step-builder">Step Builder</a> [&#8593;](#list-of-design-patterns)
**Intent:** An extension of the Builder pattern that fully guides the user through the creation of the object with no chances of confusion.
The user experience will be much more improved by the fact that he will only see the next step methods available, NO build method until is the right time to build the object.

![alt text](./step-builder/etc/step-builder.png "Step Builder")

**Applicability:** Use the Step Builder pattern when the algorithm for creating a complex object should be independent of the parts that make up the object and how they're assembled the construction process must allow different representations for the object that's constructed when in the process of constructing the order is important.

237
## <a name="adapter">Adapter</a> [&#8593;](#list-of-design-patterns)
238 239 240
**Intent:** Convert the interface of a class into another interface the clients
expect. Adapter lets classes work together that couldn't otherwise because of
incompatible interfaces.
I
Ilkka Seppälä 已提交
241

242
![alt text](./adapter/etc/adapter_1.png "Adapter")
I
Ilkka Seppälä 已提交
243 244 245 246 247 248

**Applicability:** Use the Adapter pattern when
* you want to use an existing class, and its interface does not match the one you need
* you want to create a reusable class that cooperates with unrelated or unforeseen classes, that is, classes that don't necessarily have compatible interfaces
* you need to use several existing subclasses, but it's impractical to adapt their interface by subclassing every one. An object adapter can adapt the interface of its parent class.

249
**Real world examples:**
250
* [java.util.Arrays#asList()](http://docs.oracle.com/javase/8/docs/api/java/util/Arrays.html#asList%28T...%29)
251

252
## <a name="bridge">Bridge</a> [&#8593;](#list-of-design-patterns)
253 254
**Intent:** Decouple an abstraction from its implementation so that the two can
vary independently.
I
Ilkka Seppälä 已提交
255

I
Ilkka Seppälä 已提交
256

257
![alt text](./bridge/etc/bridge_1.png "Bridge")
I
Ilkka Seppälä 已提交
258 259 260 261 262 263 264 265

**Applicability:** Use the Bridge pattern when
* you want to avoid a permanent binding between an abstraction and its implementation. This might be the case, for example, when the implementation must be selected or switched at run-time.
* both the abstractions and their implementations should be extensible by subclassing. In this case, the Bridge pattern lets you combine the different abstractions and implementations and extend them independently
* changes in the implementation of an abstraction should have no impact on clients; that is, their code should not have to be recompiled.
* you have a proliferation of classes. Such a class hierarchy indicates the need for splitting an object into two parts. Rumbaugh uses the term "nested generalizations" to refer to such class hierarchies
* you want to share an implementation among multiple objects (perhaps using reference counting), and this fact should be hidden from the client. A simple example is Coplien's String class, in which multiple objects can share the same string representation.

266
## <a name="composite">Composite</a> [&#8593;](#list-of-design-patterns)
267 268 269
**Intent:** Compose objects into tree structures to represent part-whole
hierarchies. Composite lets clients treat individual objects and compositions
of objects uniformly.
I
Ilkka Seppälä 已提交
270

271
![alt text](./composite/etc/composite_1.png "Composite")
I
Ilkka Seppälä 已提交
272 273 274 275 276

**Applicability:** Use the Composite pattern when
* you want to represent part-whole hierarchies of objects
* you want clients to be able to ignore the difference between compositions of objects and individual objects. Clients will treat all objects in the composite structure uniformly

277
**Real world examples:**
278
* [java.awt.Container](http://docs.oracle.com/javase/8/docs/api/java/awt/Container.html) and [java.awt.Component](http://docs.oracle.com/javase/8/docs/api/java/awt/Component.html)
279 280
* [Apache Wicket](https://github.com/apache/wicket) component tree, see [Component](https://github.com/apache/wicket/blob/91e154702ab1ff3481ef6cbb04c6044814b7e130/wicket-core/src/main/java/org/apache/wicket/Component.java) and [MarkupContainer](https://github.com/apache/wicket/blob/b60ec64d0b50a611a9549809c9ab216f0ffa3ae3/wicket-core/src/main/java/org/apache/wicket/MarkupContainer.java)

281
## <a name="decorator">Decorator</a> [&#8593;](#list-of-design-patterns)
282 283 284
**Intent:** Attach additional responsibilities to an object dynamically.
Decorators provide a flexible alternative to subclassing for extending
functionality.
I
Ilkka Seppälä 已提交
285

286
![alt text](./decorator/etc/decorator_1.png "Decorator")
I
Ilkka Seppälä 已提交
287 288 289 290

**Applicability:** Use Decorator
* to add responsibilities to individual objects dynamically and transparently, that is, without affecting other objects
* for responsibilities that can be withdrawn
291
* when extension by subclassing is impractical. Sometimes a large number of independent extensions are possible and would produce an explosion of subclasses to support every combination. Or a class definition may be hidden or otherwise unavailable for subclassing
I
Ilkka Seppälä 已提交
292

293
## <a name="facade">Facade</a> [&#8593;](#list-of-design-patterns)
294 295
**Intent:** Provide a unified interface to a set of interfaces in a subsystem.
Facade defines a higher-level interface that makes the subsystem easier to use.
I
Ilkka Seppälä 已提交
296

297
![alt text](./facade/etc/facade_1.png "Facade")
I
Ilkka Seppälä 已提交
298 299

**Applicability:** Use the Facade pattern when
W
wangliang 已提交
300
* you want to provide a simple interface to a complex subsystem. Subsystems often get more complex  as they evolve. Most patterns, when applied, result in more and smaller classes. This makes the subsystem more reusable and easier to customize, but it also becomes harder to use for clients that don't need to customize it. A facade can provide a simple default view of the subsystem that is good enough for most clients. Only clients needing more customizability will need to look beyond the facade.
I
Ilkka Seppälä 已提交
301 302 303
* there are many dependencies between clients and the implementation classes of an abstraction. Introduce a facade to decouple the subsystem from clients and other subsystems, thereby promoting subsystem independence and portability.
* you want to layer your subsystems. Use a facade to define an entry point to each subsystem level. If subsystems are dependent, the you can simplify the dependencies between them by making them communicate with each other solely through their facades

304
## <a name="flyweight">Flyweight</a> [&#8593;](#list-of-design-patterns)
305 306
**Intent:** Use sharing to support large numbers of fine-grained objects
efficiently.
I
Ilkka Seppälä 已提交
307

308
![alt text](./flyweight/etc/flyweight_1.png "Flyweight")
I
Ilkka Seppälä 已提交
309

310 311 312
**Applicability:** The Flyweight pattern's effectiveness depends heavily on how
and where it's used. Apply the Flyweight pattern when all of the following are
true
I
Ilkka Seppälä 已提交
313 314 315 316 317 318
* an application uses a large number of objects
* storage costs are high because of the sheer quantity of objects
* most object state can be made extrinsic
* many groups of objects may be replaced by relatively few shared objects once extrinsic state is removed
* the application doesn't depend on object identity. Since flyweight objects may be shared, identity tests will return true for conceptually distinct objects.

319
**Real world examples:**
320
* [java.lang.Integer#valueOf(int)](http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html#valueOf%28int%29)
321

322
## <a name="proxy">Proxy</a> [&#8593;](#list-of-design-patterns)
323 324
**Intent:** Provide a surrogate or placeholder for another object to control
access to it.
I
Ilkka Seppälä 已提交
325

326
![alt text](./proxy/etc/proxy_1.png "Proxy")
I
Ilkka Seppälä 已提交
327

328 329 330
**Applicability:** Proxy is applicable whenever there is a need for a more
versatile or sophisticated reference to an object than a simple pointer. Here
are several common situations in which the Proxy pattern is applicable
L
llitfkitfk 已提交
331

I
Ilkka Seppälä 已提交
332 333 334 335
* a remote proxy provides a local representative for an object in a different address space.
* a virtual proxy creates expensive objects on demand.
* a protection proxy controls access to the original object. Protection proxies are useful when objects should have different access rights.

L
llitfkitfk 已提交
336 337
**Typical Use Case:**

338 339
* control access to another object
* lazy initialization
L
llitfkitfk 已提交
340 341 342 343
* implement logging
* facilitate network connection
* to count references to an object

344
**Real world examples:**
345
* [java.lang.reflect.Proxy](http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Proxy.html)
346
* [Apache Commons Proxy](https://commons.apache.org/proper/commons-proxy/)
347

M
M Saif Asif 已提交
348
## <a name="service-locator">Service Locator</a> [&#8593;](#list-of-design-patterns)
349 350
**Intent:** Encapsulate the processes involved in obtaining a service with a
strong abstraction layer.
M
M Saif Asif 已提交
351

352
![alt text](./service-locator/etc/service-locator.png "Proxy")
M
M Saif Asif 已提交
353

354 355 356 357 358 359 360 361
**Applicability:** The service locator pattern is applicable whenever we want
to locate/fetch various services using JNDI which, typically, is a redundant
and expensive lookup. The service Locator pattern addresses this expensive
lookup by making use of caching techniques ie. for the very first time a
particular service is requested, the service Locator looks up in JNDI, fetched
the relevant service and then finally caches this service object. Now, further
lookups of the same service via Service Locator is done in its cache which
improves the performance of application to great extent.
M
M Saif Asif 已提交
362 363 364

**Typical Use Case:**

365
* when network hits are expensive and time consuming
M
M Saif Asif 已提交
366 367
* lookups of services are done quite frequently
* large number of services are being used
L
llitfkitfk 已提交
368

369
## <a name="chain-of-responsibility">Chain of responsibility</a> [&#8593;](#list-of-design-patterns)
370 371 372
**Intent:** Avoid coupling the sender of a request to its receiver by giving
more than one object a chance to handle the request. Chain the receiving
objects and pass the request along the chain until an object handles it.
I
Ilkka Seppälä 已提交
373

374
![alt text](./chain/etc/chain_1.png "Chain of Responsibility")
I
Ilkka Seppälä 已提交
375 376 377 378 379 380

**Applicability:** Use Chain of Responsibility when
* more than one object may handle a request, and the handler isn't known a priori. The handler should be ascertained automatically
* you want to issue a request to one of several objects without specifying the receiver explicitly
* the set of objects that can handle a request should be specified dynamically

381
**Real world examples:**
382
* [java.util.logging.Logger#log()](http://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html#log%28java.util.logging.Level,%20java.lang.String%29)
383
* [Apache Commons Chain](https://commons.apache.org/proper/commons-chain/index.html)
384

385
## <a name="command">Command</a> [&#8593;](#list-of-design-patterns)
386 387 388
**Intent:** Encapsulate a request as an object, thereby letting you
parameterize clients with different requests, queue or log requests, and
support undoable operations.
I
Ilkka Seppälä 已提交
389

390
![alt text](./command/etc/command.png "Command")
I
Ilkka Seppälä 已提交
391 392

**Applicability:** Use the Command pattern when you want to
L
llitfkitfk 已提交
393

I
Ilkka Seppälä 已提交
394 395 396 397 398 399
* parameterize objects by an action to perform. You can express such parameterization in a procedural language with a callback function, that is, a function that's registered somewhere to be called at a later point. Commands are an object-oriented replacement for callbacks.
* specify, queue, and execute requests at different times. A Command object can have a lifetime independent of the original request. If the receiver of a request can be represented in an address space-independent way, then you can transfer a command object for the request to a different process and fulfill the request there
* support undo. The Command's execute operation can store state for reversing its effects in the command itself. The Command interface must have an added Unexecute operation that reverses the effects of a previous call to execute. Executed commands are stored in a history list. Unlimited-level undo and redo is achieved by traversing this list backwards and forwards calling unexecute and execute, respectively
* support logging changes so that they can be reapplied in case of a system crash. By augmenting the Command interface with load and store operations, you can keep a persistent log of changes. Recovering from a crash involves reloading logged commands from disk and re-executing them with the execute operation
* structure a system around high-level operations build on primitive operations. Such a structure is common in information systems that support transactions. A transaction encapsulates a set of changes to data. The Command pattern offers a way to model transactions. Commands have a common interface, letting you invoke all transactions the same way. The pattern also makes it easy to extend the system with new transactions

L
llitfkitfk 已提交
400 401 402 403 404 405
**Typical Use Case:**

* to keep a history of requests
* implement callback functionality
* implement the undo functionality

406
**Real world examples:**
407
* [java.lang.Runnable](http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html)
408

409
## <a name="interpreter">Interpreter</a> [&#8593;](#list-of-design-patterns)
410 411 412
**Intent:** Given a language, define a representation for its grammar along
with an interpreter that uses the representation to interpret sentences in the
language.
I
Ilkka Seppälä 已提交
413

414
![alt text](./interpreter/etc/interpreter_1.png "Interpreter")
I
Ilkka Seppälä 已提交
415

416 417 418
**Applicability:** Use the Interpreter pattern when there is a language to
interpret, and you can represent statements in the language as abstract syntax
trees. The Interpreter pattern works best when
I
Ilkka Seppälä 已提交
419 420 421
* the grammar is simple. For complex grammars, the class hierarchy for the grammar becomes large and unmanageable. Tools such as parser generators are a better alternative in such cases. They can interpret expressions without building abstract syntax trees, which can save space and possibly time
* efficiency is not a critical concern. The most efficient interpreters are usually not implemented by interpreting parse trees directly but by first translating them into another form. For example, regular expressions are often transformed into state machines. But even then, the translator can be implemented by the Interpreter pattern, so the pattern is still applicable

422
## <a name="iterator">Iterator</a> [&#8593;](#list-of-design-patterns)
423 424
**Intent:** Provide a way to access the elements of an aggregate object
sequentially without exposing its underlying representation.
I
Ilkka Seppälä 已提交
425

426
![alt text](./iterator/etc/iterator_1.png "Iterator")
I
Ilkka Seppälä 已提交
427 428 429 430 431 432

**Applicability:** Use the Iterator pattern
* to access an aggregate object's contents without exposing its internal representation
* to support multiple traversals of aggregate objects
* to provide a uniform interface for traversing different aggregate structures

433
**Real world examples:**
434
* [java.util.Iterator](http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)
435

436
## <a name="mediator">Mediator</a> [&#8593;](#list-of-design-patterns)
437 438 439
**Intent:** Define an object that encapsulates how a set of objects interact.
Mediator promotes loose coupling by keeping objects from referring to each
other explicitly, and it lets you vary their interaction independently.
I
Ilkka Seppälä 已提交
440

441
![alt text](./mediator/etc/mediator_1.png "Mediator")
I
Ilkka Seppälä 已提交
442 443 444 445 446 447

**Applicability:** Use the Mediator pattern when
* a set of objects communicate in well-defined but complex ways. The resulting interdependencies are unstructured and difficult to understand
* reusing an object is difficult because it refers to and communicates with many other objects
* a behavior that's distributed between several classes should be customizable without a lot of subclassing

448
## <a name="memento">Memento</a> [&#8593;](#list-of-design-patterns)
449 450
**Intent:** Without violating encapsulation, capture and externalize an
object's internal state so that the object can be restored to this state later.
I
Ilkka Seppälä 已提交
451

452
![alt text](./memento/etc/memento.png "Memento")
I
Ilkka Seppälä 已提交
453 454 455 456 457

**Applicability:** Use the Memento pattern when
* a snapshot of an object's state must be saved so that it can be restored to that state later, and
* a direct interface to obtaining the state would expose implementation details and break the object's encapsulation

458
**Real world examples:**
459
* [java.util.Date](http://docs.oracle.com/javase/8/docs/api/java/util/Date.html)
S
Stamatis Pitsios 已提交
460

461
## <a name="observer">Observer</a> [&#8593;](#list-of-design-patterns)
462 463 464
**Intent:** Define a one-to-many dependency between objects so that when one
object changes state, all its dependents are notified and updated
automatically.
I
Ilkka Seppälä 已提交
465

466
![alt text](./observer/etc/observer_1.png "Observer")
I
Ilkka Seppälä 已提交
467 468

**Applicability:** Use the Observer pattern in any of the following situations
L
llitfkitfk 已提交
469

I
Ilkka Seppälä 已提交
470 471 472 473
* when an abstraction has two aspects, one dependent on the other. Encapsulating these aspects in separate objects lets you vary and reuse them independently
* when a change to one object requires changing others, and you don't know how many objects need to be changed
* when an object should be able to notify other objects without making assumptions about who these objects are. In other words, you don't want these objects tightly coupled

L
llitfkitfk 已提交
474 475 476 477
**Typical Use Case:**

* changing in one object leads to a change in other objects

478
**Real world examples:**
479
* [java.util.Observer](http://docs.oracle.com/javase/8/docs/api/java/util/Observer.html)
L
llitfkitfk 已提交
480

481
## <a name="state">State</a> [&#8593;](#list-of-design-patterns)
482 483
**Intent:** Allow an object to alter its behavior when its internal state
changes. The object will appear to change its class.
I
Ilkka Seppälä 已提交
484

485
![alt text](./state/etc/state_1.png "State")
I
Ilkka Seppälä 已提交
486 487 488 489 490

**Applicability:** Use the State pattern in either of the following cases
* an object's behavior depends on its state, and it must change its behavior at run-time depending on that state
* operations have large, multipart conditional statements that depend on the object's state. This state is usually represented by one or more enumerated constants. Often, several operations will contain this same conditional structure. The State pattern puts each branch of the conditional in a separate class. This lets you treat the object's state as an object in its own right that can vary independently from other objects.

491
## <a name="strategy">Strategy</a> [&#8593;](#list-of-design-patterns)
492 493 494
**Intent:** Define a family of algorithms, encapsulate each one, and make them
interchangeable. Strategy lets the algorithm vary independently from clients
that use it.
I
Ilkka Seppälä 已提交
495

496
![alt text](./strategy/etc/strategy_1.png "Strategy")
I
Ilkka Seppälä 已提交
497 498

**Applicability:** Use the Strategy pattern when
W
wangliang 已提交
499 500
* many related classes differ only in their behavior. Strategies provide a way to configure a class either one of many behaviors
* you need different variants of an algorithm. for example, you might define algorithms reflecting different space/time trade-offs. Strategies can be used when these variants are implemented as a class hierarchy of algorithms
I
Ilkka Seppälä 已提交
501 502 503
* an algorithm uses data that clients shouldn't know about. Use the Strategy pattern to avoid exposing complex, algorithm-specific data structures
* a class defines many behaviors, and these appear as multiple conditional statements in its operations. Instead of many conditionals, move related conditional branches into their own Strategy class

504
## <a name="template-method">Template method</a> [&#8593;](#list-of-design-patterns)
505 506 507
**Intent:** Define the skeleton of an algorithm in an operation, deferring some
steps to subclasses. Template method lets subclasses redefine certain steps of
an algorithm without changing the algorithm's structure.
I
Ilkka Seppälä 已提交
508

509
![alt text](./template-method/etc/template-method_1.png "Template Method")
I
Ilkka Seppälä 已提交
510 511 512 513 514 515

**Applicability:** The Template Method pattern should be used
* to implement the invariant parts of an algorithm once and leave it up to subclasses to implement the behavior that can vary
* when common behavior among subclasses should be factored and localized in a common class to avoid code duplication. This is good example of "refactoring to generalize" as described by Opdyke and Johnson. You first identify the differences in the existing code and then separate the differences into new operations. Finally, you replace the differing code with a template method that calls one of these new operations
* to control subclasses extensions. You can define a template method that calls "hook" operations at specific points, thereby permitting extensions only at those points

516
## <a name="visitor">Visitor</a> [&#8593;](#list-of-design-patterns)
517 518 519
**Intent:** Represent an operation to be performed on the elements of an object
structure. Visitor lets you define a new operation without changing the classes
of the elements on which it operates.
I
Ilkka Seppälä 已提交
520

521
![alt text](./visitor/etc/visitor_1.png "Visitor")
I
Ilkka Seppälä 已提交
522 523 524 525 526

**Applicability:** Use the Visitor pattern when
* an object structure contains many classes of objects with differing interfaces, and you want to perform operations on these objects that depend on their concrete classes
* many distinct and unrelated operations need to be performed on objects in an object structure, and you want to avoid "polluting" their classes with these operations. Visitor lets you keep related operations together by defining them in one class. When the object structure is shared by many applications, use Visitor to put operations in just those applications that need them
* the classes defining the object structure rarely change, but you often want to define new operations over the structure. Changing the object structure classes requires redefining the interface to all visitors, which is potentially costly. If the object structure classes change often, then it's probably better to define the operations in those classes
527

528 529 530
**Real world examples:**
* [Apache Wicket](https://github.com/apache/wicket) component tree, see [MarkupContainer](https://github.com/apache/wicket/blob/b60ec64d0b50a611a9549809c9ab216f0ffa3ae3/wicket-core/src/main/java/org/apache/wicket/MarkupContainer.java)

531
## <a name="model-view-presenter">Model-View-Presenter</a> [&#8593;](#list-of-design-patterns)
532 533
**Intent:** Apply a "Separation of Concerns" principle in a way that allows
developers to build and test user interfaces.
534

535
![alt text](./model-view-presenter/etc/model-view-presenter_1.png "Model-View-Presenter")
536

537 538
**Applicability:** Use the Model-View-Presenter in any of the following
situations
539 540 541
* when you want to improve the "Separation of Concerns" principle in presentation logic
* when a user interface development and testing is necessary.

542
## <a name="dao">Data Access Object</a> [&#8593;](#list-of-design-patterns)
543 544
**Intent:** Object provides an abstract interface to some type of database or
other persistence mechanism.
545

546
![alt text](./dao/etc/dao.png "Data Access Object")
547 548 549 550 551

**Applicability:** Use the Data Access Object in any of the following situations
* when you want to consolidate how the data layer is accessed
* when you want to avoid writing multiple data retrieval/persistence layers

552
## <a name="double-checked-locking">Double Checked Locking</a> [&#8593;](#list-of-design-patterns)
553 554 555 556
**Intent:** Reduce the overhead of acquiring a lock by first testing the
locking criterion (the "lock hint") without actually acquiring the lock. Only
if the locking criterion check indicates that locking is required does the
actual locking logic proceed.
557

558
![alt text](./double-checked-locking/etc/double_checked_locking_1.png "Double Checked Locking")
559

560 561 562
**Applicability:** Use the Double Checked Locking pattern when
* there is a concurrent access in object creation, e.g. singleton, where you want to create single instance of the same class and checking if it's null or not maybe not be enough when there are two or more threads that checks if instance is null or not.
* there is a concurrent access on a method where method's behaviour changes according to the some constraints and these constraint change within this method.
563

I
Ilkka Seppälä 已提交
564
## <a name="servant">Servant</a> [&#8593;](#list-of-design-patterns)
565 566 567
**Intent:** Servant is used for providing some behavior to a group of classes.
Instead of defining that behavior in each class - or when we cannot factor out
this behavior in the common parent class - it is defined once in the Servant.
P
Petros G. Sideris 已提交
568

569
![alt text](./servant/etc/servant-pattern.png "Servant")
P
Petros G. Sideris 已提交
570 571

**Applicability:** Use the Servant pattern when
572
* when we want some objects to perform a common action and don't want to define this action as a method in every class.
P
Petros G. Sideris 已提交
573

574
## <a name="null-object">Null Object</a> [&#8593;](#list-of-design-patterns)
575 576 577 578 579 580 581 582
**Intent:** In most object-oriented languages, such as Java or C#, references
may be null. These references need to be checked to ensure they are not null
before invoking any methods, because methods typically cannot be invoked on
null references. Instead of using a null reference to convey absence of an
object (for instance, a non-existent customer), one uses an object which
implements the expected interface, but whose method body is empty. The
advantage of this approach over a working default implementation is that a Null
Object is very predictable and has no side effects: it does nothing.
583

584
![alt text](./null-object/etc/null-object.png "Null Object")
585 586

**Applicability:** Use the Null Object pattern when
587
* you want to avoid explicit null checks and keep the algorithm elegant and easy to read.
588

589
## <a name="event-aggregator">Event Aggregator</a> [&#8593;](#list-of-design-patterns)
590 591 592 593 594 595
**Intent:** A system with lots of objects can lead to complexities when a
client wants to subscribe to events. The client has to find and register for
each object individually, if each object has multiple events then each event
requires a separate subscription. An Event Aggregator acts as a single source
of events for many objects. It registers for all the events of the many objects
allowing clients to register with just the aggregator.
596

597
![alt text](./event-aggregator/etc/classes.png "Event Aggregator")
598 599

**Applicability:** Use the Event Aggregator pattern when
600 601 602 603 604
* Event Aggregator is a good choice when you have lots of objects that are
  potential event sources. Rather than have the observer deal with registering
  with them all, you can centralize the registration logic to the Event
  Aggregator. As well as simplifying registration, a Event Aggregator also
  simplifies the memory management issues in using observers.
605

V
vehpsr 已提交
606
## <a name="callback">Callback</a> [&#8593;](#list-of-design-patterns)
607 608 609
**Intent:** Callback is a piece of executable code that is passed as an
argument to other code, which is expected to call back (execute) the argument
at some convenient time.
V
vehpsr 已提交
610

611
![alt text](./callback/etc/callback.png "Callback")
V
vehpsr 已提交
612 613

**Applicability:** Use the Callback pattern when
614
* when some arbitrary synchronous or asynchronous action must be performed after execution of some defined activity.
V
vehpsr 已提交
615

616 617
**Real world examples:**
* [CyclicBarrier] (http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/CyclicBarrier.html#CyclicBarrier%28int,%20java.lang.Runnable%29) constructor can accept callback that will be triggered every time when barrier is tripped.
618

J
joshzambales 已提交
619
## <a name="intercepting-filter">Intercepting Filter</a> [&#8593;](#list-of-design-patterns)
620 621
**Intent:** Provide pluggable filters to conduct necessary pre-processing and
post-processing to requests from a client to a target
J
joshzambales 已提交
622
 
623
![alt text](./intercepting-filter/etc/intercepting-filter.png "Intercepting Filter")
J
joshzambales 已提交
624 625 626 627 628
 
**Applicability:** Use the Intercepting Filter pattern when
* a system uses pre-processing or post-processing requests
* a system should do the authentication/ authorization/ logging or tracking of request and then pass the requests to corresponding handlers 
* you want a modular approach to configuring pre-processing and post-processing schemes
J
Josh 已提交
629

630
## <a name="execute-around">Execute Around</a> [&#8593;](#list-of-design-patterns)
631 632 633 634
**Intent:** Execute Around idiom frees the user from certain actions that
should always be executed before and after the business method. A good example
of this is resource allocation and deallocation leaving the user to specify
only what to do with the resource.
635

636
![alt text](./execute-around/etc/execute-around.png "Execute Around")
637 638

**Applicability:** Use the Execute Around idiom when
639
* you use an API that requires methods to be called in pairs such as open/close or allocate/deallocate.
640

V
vehpsr 已提交
641
## <a name="property">Property</a> [&#8593;](#list-of-design-patterns)
642 643
**Intent:** Create hierarchy of objects and new objects using already existing
objects as parents.
V
vehpsr 已提交
644

645
![alt text](./property/etc/property.png "Property")
V
vehpsr 已提交
646 647 648 649 650 651

**Applicability:** Use the Property pattern when
* when you like to have objects with dynamic set of fields and prototype inheritance

**Real world examples:**
* [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Inheritance_and_the_prototype_chain) prototype inheritance
652

V
vehpsr 已提交
653
## <a name="poison-pill">Poison Pill</a> [&#8593;](#list-of-design-patterns)
654 655
**Intent:** Poison Pill is known predefined data item that allows to provide
graceful shutdown for separate distributed consumption process.
V
vehpsr 已提交
656

657
![alt text](./poison-pill/etc/poison-pill.png "Poison Pill")
V
vehpsr 已提交
658 659 660

**Applicability:** Use the Poison Pill idiom when
* need to send signal from one thread/process to another to terminate
J
joshzambales 已提交
661

662
**Real world examples:**
I
Ilkka Seppälä 已提交
663
* [akka.actor.PoisonPill](http://doc.akka.io/docs/akka/2.1.4/java/untyped-actors.html)
664

I
Ilkka Seppala 已提交
665
## <a name="lazy-loading">Lazy Loading</a> [&#8593;](#list-of-design-patterns)
666 667 668 669
**Intent:** Lazy loading is a design pattern commonly used to defer
initialization of an object until the point at which it is needed. It can
contribute to efficiency in the program's operation if properly and
appropriately used.
I
Ilkka Seppala 已提交
670

671
![alt text](./lazy-loading/etc/lazy-loading.png "Lazy Loading")
I
Ilkka Seppala 已提交
672 673

**Applicability:** Use the Lazy Loading idiom when
W
wangliang 已提交
674
* eager loading is expensive or the object to be loaded might not be needed at all
I
Ilkka Seppala 已提交
675 676 677 678

**Real world examples:**
* JPA annotations @OneToOne, @OneToMany, @ManyToOne, @ManyToMany and fetch = FetchType.LAZY

679
## <a name="service-layer">Service Layer</a> [&#8593;](#list-of-design-patterns)
680 681 682 683 684 685
**Intent:** Service Layer is an abstraction over domain logic. Typically
applications require multiple kinds of interfaces to the data they store and
logic they implement: data loaders, user interfaces, integration gateways, and
others. Despite their different purposes, these interfaces often need common
interactions with the application to access and manipulate its data and invoke
its business logic. The Service Layer fulfills this role.
686

687
![alt text](./service-layer/etc/service-layer.png "Service Layer")
688 689 690 691 692

**Applicability:** Use the Service Layer pattern when
* you want to encapsulate domain logic under API
* you need to implement multiple interfaces with common logic and data

I
Ilkka Seppala 已提交
693
## <a name="specification">Specification</a> [&#8593;](#list-of-design-patterns)
694 695 696 697
**Intent:** Specification pattern separates the statement of how to match a
candidate, from the candidate object that it is matched against. As well as its
usefulness in selection, it is also valuable for validation and for building to
order
I
Ilkka Seppala 已提交
698

699
![alt text](./specification/etc/specification.png "Specification")
I
Ilkka Seppala 已提交
700 701

**Applicability:** Use the Specification pattern when
702 703
* you need to select a subset of objects based on some criteria, and to refresh the selection at various times
* you need to check that only suitable objects are used for a certain role (validation)
I
Ilkka Seppala 已提交
704 705

## <a name="tolerant-reader">Tolerant Reader</a> [&#8593;](#list-of-design-patterns)
706 707 708 709
**Intent:** Tolerant Reader is an integration pattern that helps creating
robust communication systems. The idea is to be as tolerant as possible when
reading data from another service. This way, when the communication schema
changes, the readers must not break.
I
Ilkka Seppala 已提交
710

711
![alt text](./tolerant-reader/etc/tolerant-reader.png "Tolerant Reader")
I
Ilkka Seppala 已提交
712 713

**Applicability:** Use the Tolerant Reader pattern when
714
* the communication schema can evolve and change and yet the receiving side should not break
I
Ilkka Seppala 已提交
715

716
## <a name="model-view-controller">Model-View-Controller</a> [&#8593;](#list-of-design-patterns)
717 718 719 720
**Intent:** Separate the user interface into three interconnected components:
the model, the view and the controller. Let the model manage the data, the view
display the data and the controller mediate updating the data and redrawing the
display.
721

722
![alt text](./model-view-controller/etc/model-view-controller.png "Model-View-Controller")
723 724 725 726

**Applicability:** Use the Model-View-Controller pattern when
* you want to clearly separate the domain data from its user interface representation

727
## <a name="flux">Flux</a> [&#8593;](#list-of-design-patterns)
728 729 730 731
**Intent:** Flux eschews MVC in favor of a unidirectional data flow. When a
user interacts with a view, the view propagates an action through a central
dispatcher, to the various stores that hold the application's data and business
logic, which updates all of the views that are affected.
732

733
![alt text](./flux/etc/flux.png "Flux")
734 735

**Applicability:** Use the Flux pattern when
736
* you want to focus on creating explicit and understandable update paths for your application's data, which makes tracing changes during development simpler and makes bugs easier to track down and fix.
737

738
## <a name="double-dispatch">Double Dispatch</a> [&#8593;](#list-of-design-patterns)
739 740
**Intent:** Double Dispatch pattern is a way to create maintainable dynamic
behavior based on receiver and parameter types.
741

742
![alt text](./double-dispatch/etc/double-dispatch.png "Double Dispatch")
743 744

**Applicability:** Use the Double Dispatch pattern when
745
* the dynamic behavior is not defined only based on receiving object's type but also on the receiving method's parameter type.
746 747 748 749

**Real world examples:** 
* [ObjectOutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/ObjectOutputStream.html)

750
## <a name="multiton">Multiton</a> [&#8593;](#list-of-design-patterns)
751 752
**Intent:** Ensure a class only has limited number of instances, and provide a
global point of access to them.
753

754
![alt text](./multiton/etc/multiton.png "Multiton")
755 756 757 758

**Applicability:** Use the Multiton pattern when
* there must be specific number of instances of a class, and they must be accessible to clients from a well-known access point

759 760 761
## <a name="resource-acquisition-is-initialization">Resource Acquisition Is Initialization</a> [&#8593;](#list-of-design-patterns)
**Intent:** Resource Acquisition Is Initialization pattern can be used to implement exception safe resource management.

762
![alt text](./resource-acquisition-is-initialization/etc/resource-acquisition-is-initialization.png "Resource Acquisition Is Initialization")
763 764

**Applicability:** Use the Resource Acquisition Is Initialization pattern when
765
* you have resources that must be closed in every condition
766

I
Ilkka Seppala 已提交
767
## <a name="thread-pool">Thread Pool</a> [&#8593;](#list-of-design-patterns)
768 769 770 771 772
**Intent:** It is often the case that tasks to be executed are short-lived and
the number of tasks is large. Creating a new thread for each task would make
the system spend more time creating and destroying the threads than executing
the actual tasks. Thread Pool solves this problem by reusing existing threads
and eliminating the latency of creating new threads.
I
Ilkka Seppala 已提交
773

774
![alt text](./thread-pool/etc/thread-pool.png "Thread Pool")
I
Ilkka Seppala 已提交
775 776

**Applicability:** Use the Thread Pool pattern when
777
* you have a large number of short-lived tasks to be executed in parallel
I
Ilkka Seppala 已提交
778

779
## <a name="async-method-invocation">Async Method Invocation</a> [&#8593;](#list-of-design-patterns)
780 781 782 783
**Intent:** Asynchronous method invocation is pattern where the calling thread
is not blocked while waiting results of tasks. The pattern provides parallel
processing of multiple independent tasks and retrieving the results via
callbacks or waiting until everything is done. 
784

785
![alt text](./async-method-invocation/etc/async-method-invocation.png "Async Method Invocation")
786

787
**Applicability:** Use async method invocation pattern when
788 789 790 791
* you have multiple independent tasks that can run in parallel
* you need to improve the performance of a group of sequential tasks
* you have limited amount of processing capacity or long running tasks and the
  caller should not wait the tasks to be ready
792 793 794 795 796

**Real world examples:**
* [FutureTask](http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/FutureTask.html), [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html) and [ExecutorService](http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html) (Java)
* [Task-based Asynchronous Pattern](https://msdn.microsoft.com/en-us/library/hh873175.aspx) (.NET)

797
## <a name="private-class-data">Private Class Data</a> [&#8593;](#list-of-design-patterns)
798 799 800
**Intent:** Private Class Data design pattern seeks to reduce exposure of
attributes by limiting their visibility. It reduces the number of class
attributes by encapsulating them in single Data object.
801

802
![alt text](./private-class-data/etc/private-class-data.png "Private Class Data")
803 804

**Applicability:** Use the Private Class Data pattern when
805
* you want to prevent write access to class data members
806

807
## <a name="object-pool">Object Pool</a> [&#8593;](#list-of-design-patterns)
808 809 810 811
**Intent:** When objects are expensive to create and they are needed only for
short periods of time it is advantageous to utilize the Object Pool pattern.
The Object Pool provides a cache for instantiated objects tracking which ones
are in use and which are available.
812

813
![alt text](./object-pool/etc/object-pool.png "Object Pool")
814 815

**Applicability:** Use the Object Pool pattern when
816 817
* the objects are expensive to create (allocation cost)
* you need a large number of short-lived objects (memory fragmentation)
818

819
## <a name="dependency-injection">Dependency Injection</a> [&#8593;](#list-of-design-patterns)
820 821 822 823 824 825
**Intent:** Dependency Injection is a software design pattern in which one or
more dependencies (or services) are injected, or passed by reference, into a
dependent object (or client) and are made part of the client's state. The
pattern separates the creation of a client's dependencies from its own
behavior, which allows program designs to be loosely coupled and to follow the
inversion of control and single responsibility principles.
826

827
![alt text](./dependency-injection/etc/dependency-injection.png "Dependency Injection")
828 829

**Applicability:** Use the Dependency Injection pattern when
830 831
* when you need to remove knowledge of concrete implementation from object
* to enable unit testing of classes in isolation using mock objects or stubs
832

I
Ilkka Seppala 已提交
833
## <a name="naked-objects">Naked Objects</a> [&#8593;](#list-of-design-patterns)
834 835 836
**Intent:** The Naked Objects architectural pattern is well suited for rapid
prototyping. Using the pattern, you only need to write the domain objects,
everything else is autogenerated by the framework.
I
Ilkka Seppala 已提交
837

838
![alt text](./naked-objects/etc/naked-objects.png "Naked Objects")
I
Ilkka Seppala 已提交
839 840

**Applicability:** Use the Naked Objects pattern when
841 842 843
* you are prototyping and need fast development cycle
* an autogenerated user interface is good enough
* you want to automatically publish the domain as REST services
I
Ilkka Seppala 已提交
844

I
Ilkka Seppala 已提交
845 846 847
**Real world examples:** 
* [Apache Isis](https://isis.apache.org/)

848
## <a name="front-controller">Front Controller</a> [&#8593;](#list-of-design-patterns)
849 850 851
**Intent:** Introduce a common handler for all requests for a web site. This
way we can encapsulate common functionality such as security,
internationalization, routing and logging in a single place.
852

853
![alt text](./front-controller/etc/front-controller.png "Front Controller")
854 855 856 857

**Applicability:** Use the Front Controller pattern when
* you want to encapsulate common request handling functionality in single place
* you want to implements dynamic request handling i.e. change routing without modifying code
858
* make web server configuration portable, you only need to register the handler web server specific way
859 860 861 862

**Real world examples:** 
* [Apache Struts](https://struts.apache.org/)

863
## <a name="repository">Repository</a> [&#8593;](#list-of-design-patterns)
864 865 866 867 868
**Intent:** Repository layer is added between the domain and data mapping
layers to isolate domain objects from details of the database access code and
to minimize scattering and duplication of query code. The Repository pattern is
especially useful in systems where number of domain classes is large or heavy
querying is utilized.
869

870
![alt text](./repository/etc/repository.png "Repository")
871 872 873 874 875 876 877 878 879 880

**Applicability:** Use the Repository pattern when
* the number of domain objects is large
* you want to avoid duplication of query code
* you want to keep the database querying code in single place
* you have multiple data sources

**Real world examples:** 
* [Spring Data](http://projects.spring.io/spring-data/)

881
## <a name="business-delegate">Business Delegate</a> [&#8593;](#list-of-design-patterns)
882 883 884 885
**Intent:** The Business Delegate pattern adds an abstraction layer between
presentation and business tiers. By using the pattern we gain loose coupling
between the tiers and encapsulate knowledge about how to locate, connect to,
and interact with the business objects that make up the application.
886

887
![alt text](./business-delegate/etc/business-delegate.png "Business Delegate")
888 889

**Applicability:** Use the Business Delegate pattern when
890
* you want loose coupling between presentation and business tiers
891 892 893
* you want to orchestrate calls to multiple business services
* you want to encapsulate service lookups and service calls

894
## <a name="half-sync-half-async">Half-Sync/Half-Async</a> [&#8593;](#list-of-design-patterns)
895 896 897
**Intent:** The Half-Sync/Half-Async pattern decouples synchronous I/O from
asynchronous I/O in a system to simplify concurrent programming effort without
degrading execution efficiency.
I
Ilkka Seppala 已提交
898

899 900 901
![Half-Sync/Half-Async class diagram](./half-sync-half-async/etc/half-sync-half-async.png)

**Applicability:** Use Half-Sync/Half-Async pattern when
902 903 904 905 906
* a system possesses following characteristics:
  * the system must perform tasks in response to external events that occur asynchronously, like hardware interrupts in OS
  * it is inefficient to dedicate separate thread of control to perform synchronous I/O for each external source of event
  * the higher level tasks in the system can be simplified significantly if I/O is performed synchronously.
* one or more tasks in a system must run in a single thread of control, while other tasks may benefit from multi-threading.
907 908 909 910 911

**Real world examples:**
* [BSD Unix networking subsystem](http://www.cs.wustl.edu/~schmidt/PDF/PLoP-95.pdf)
* [Real Time CORBA](http://www.omg.org/news/meetings/workshops/presentations/realtime2001/4-3_Pyarali_thread-pool.pdf)
* [Android AsyncTask framework](http://developer.android.com/reference/android/os/AsyncTask.html)
I
Ilkka Seppala 已提交
912

913
# <a name="faq">Frequently asked questions</a> [&#8593;](#top)
914

915
**<a id="Q1">Q: What is the difference between State and Strategy patterns?</a>**
I
Ilkka Seppälä 已提交
916

917 918 919 920 921
While the implementation is similar they solve different problems. The State
pattern deals with what state an object is in - it encapsulates state-dependent
behavior.
The Strategy pattern deals with how an object performs a certain task - it
encapsulates an algorithm.
922

923
**<a id="Q2">Q: What is the difference between Strategy and Template Method patterns?</a>**
I
Ilkka Seppälä 已提交
924

925 926
In Template Method the algorithm is chosen at compile time via inheritance.
With Strategy pattern the algorithm is chosen at runtime via composition.
I
Ilkka Seppälä 已提交
927

928
**<a id="Q3">Q: What is the difference between Proxy and Decorator patterns?</a>**
I
Ilkka Seppälä 已提交
929

930 931
The difference is the intent of the patterns. While Proxy controls access to
the object Decorator is used to add responsibilities to the object.
932

I
Ilkka Seppala 已提交
933 934
**<a id="Q4">Q: What is the difference between Chain of Responsibility and Intercepting Filter patterns?</a>**

935 936 937 938 939
While the implementations look similar there are differences. The Chain of
Responsibility forms a chain of request processors and the processors are then
executed one by one until the correct processor is found. In Intercepting
Filter the chain is constructed from filters and the whole chain is always
executed.
940

941 942
**<a id="Q5">Q: What is the difference between Visitor and Double Dispatch patterns?</a>**

943 944 945 946
The Visitor pattern is a means of adding a new operation to existing classes.
Double dispatch is a means of dispatching function calls with respect to two
polymorphic types, rather than a single polymorphic type, which is what
languages like C++ and Java _do not_ support directly.
947

948 949 950 951
**<a id="Q6">Q: What are the differences between Flyweight and Object Pool patterns?</a>**

They differ in the way they are used.

952 953 954 955 956
Pooled objects can simultaneously be used by a single "client" only. For that,
a pooled object must be checked out from the pool, then it can be used by a
client, and then the client must return the object back to the pool. Multiple
instances of identical objects may exist, up to the maximal capacity of the
pool.
957

958 959
In contrast, a Flyweight object is singleton, and it can be used simultaneously
by multiple clients.
960

961 962 963 964
As for concurrent access, pooled objects can be mutable and they usually don't
need to be thread safe, as typically, only one thread is going to use a
specific instance at the same time. Flyweight must either be immutable (the
best option), or implement thread safety.
965

966 967 968 969
As for performance and scalability, pools can become bottlenecks, if all the
pooled objects are in use and more clients need them, threads will become
blocked waiting for available object from the pool. This is not the case with
Flyweight.
970

971

972

973
# <a name="how-to-contribute">How to contribute</a> [&#8593;](#top)
974

I
Ilkka Seppälä 已提交
975
**To work on a new pattern** you need to do the following steps:
I
Ilkka Seppälä 已提交
976

977 978 979
1. If there is no issue for the new pattern yet, raise new issue. Comment on
   the issue that you are working on it so that others don't start work on the
   same thing.
I
Ilkka Seppälä 已提交
980
2. Fork the repository.
981 982 983
3. Implement the code changes in your fork. Remember to add sufficient comments
   documenting the implementation. Reference the issue id e.g. #52 in your
   commit messages.
I
Ilkka Seppälä 已提交
984 985 986
4. Create a simple class diagram from your example code.
5. Add description of the pattern in README.md and link to the class diagram.	
6. Create a pull request.
I
Ilkka Seppälä 已提交
987

I
Ilkka Seppälä 已提交
988
**To work on one of the non-pattern issues** you need to do the following steps:
989

I
Ilkka Seppälä 已提交
990 991 992
1. Check that the issue has "help wanted" badge
2. Comment on the issue that you are working on it
3. Fork the repository.
993 994 995
4. Implement the code changes in your fork. Remember to add sufficient comments
   documenting the implementation. Reference the issue id e.g. #52 in your
   commit messages.
I
Ilkka Seppälä 已提交
996
5. Create a pull request.
997

I
Ilkka Seppala 已提交
998
**For creating/editing UML diagrams** you need [ObjectAid UML Explorer for Eclipse](http://www.objectaid.com/home).
I
Ilkka Seppälä 已提交
999

I
Ilkka Seppala 已提交
1000 1001 1002 1003 1004 1005
**For inspiration** check out the following sources:

* there is a good list of design patterns at [Wikipedia](http://en.wikipedia.org/wiki/Software_design_pattern)
* Martin Fowler's [Catalog of Patterns of Enterprise Application Architecture](http://martinfowler.com/eaaCatalog/)
* [pattern language for microservices](http://microservices.io/patterns/index.html)
* Microsoft's [Cloud Design Patterns](http://download.microsoft.com/download/B/B/6/BB69622C-AB5D-4D5F-9A12-B81B952C1169/CloudDesignPatternsBook-PDF.pdf)
I
Ilkka Seppälä 已提交
1006

1007 1008
**Links to patterns applied in real world applications** are welcome. The links
should be added to the corresponding section of the `README.md`.
I
Ilkka Seppälä 已提交
1009 1010


1011
# <a name="versioning">Versioning</a> [&#8593;](#top)
1012

1013 1014 1015 1016
Java-design-patterns project uses [semantic versioning](http://semver.org/)
scheme. However, version numbers in this project do not signify binary releases
(since we don't make any) but rather milestones achieved on the roadmap. In
other words, version numbers are used only for project planning sake.
1017 1018


1019
# <a name="credits">Credits</a> [&#8593;](#top)
I
Ilkka Seppälä 已提交
1020

I
Ilkka Seppälä 已提交
1021 1022
* [Design Patterns: Elements of Reusable Object-Oriented Software](http://www.amazon.com/Design-Patterns-Elements-Reusable-Object-Oriented/dp/0201633612)
* [Effective Java (2nd Edition)](http://www.amazon.com/Effective-Java-Edition-Joshua-Bloch/dp/0321356683)
1023
* [Java Generics and Collections](http://www.amazon.com/Java-Generics-Collections-Maurice-Naftalin/dp/0596527756/)
1024
* [Let’s Modify the Objects-First Approach into Design-Patterns-First](http://edu.pecinovsky.cz/papers/2006_ITiCSE_Design_Patterns_First.pdf)
1025
* [Pattern Languages of Program Design](http://www.amazon.com/Pattern-Languages-Program-Design-Coplien/dp/0201607344/ref=sr_1_1)
1026
* [Martin Fowler - Event Aggregator](http://martinfowler.com/eaaDev/EventAggregator.html)
J
joshzambales 已提交
1027
* [TutorialsPoint - Intercepting Filter](http://www.tutorialspoint.com/design_pattern/intercepting_filter_pattern.htm)
I
Ilkka Seppala 已提交
1028
* [Presentation Tier Patterns](http://www.javagyan.com/tutorials/corej2eepatterns/presentation-tier-patterns)
I
Ilkka Seppala 已提交
1029
* [Functional Programming in Java: Harnessing the Power of Java 8 Lambda Expressions](http://www.amazon.com/Functional-Programming-Java-Harnessing-Expressions/dp/1937785467/ref=sr_1_1)
1030
* [Martin Fowler - Service Layer](http://martinfowler.com/eaaCatalog/serviceLayer.html)
I
Ilkka Seppala 已提交
1031
* [Martin Fowler - Specifications](http://martinfowler.com/apsupp/spec.pdf)
I
Ilkka Seppala 已提交
1032
* [Martin Fowler - Tolerant Reader](http://martinfowler.com/bliki/TolerantReader.html)
1033
* [Trygve Reenskaug - Model-view-controller](http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller)
I
Ilkka Seppala 已提交
1034
* [Flux - Application architecture for building user interfaces](http://facebook.github.io/flux/)
I
Ilkka Seppala 已提交
1035
* [Richard Pawson - Naked Objects](http://downloads.nakedobjects.net/resources/Pawson%20thesis.pdf)
I
Ilkka Seppala 已提交
1036
* [Patterns of Enterprise Application Architecture](http://www.amazon.com/Patterns-Enterprise-Application-Architecture-Martin/dp/0321127420)
I
Ilkka Seppala 已提交
1037
* [Spring Data](http://www.amazon.com/Spring-Data-Mark-Pollack/dp/1449323952/ref=sr_1_1)
I
Ilkka Seppala 已提交
1038
* [J2EE Design Patterns](http://www.amazon.com/J2EE-Design-Patterns-William-Crawford/dp/0596004273/ref=sr_1_2)
D
Dmitriy Zarubin 已提交
1039
* [Marco Castigliego - Step Builder](http://rdafbn.blogspot.co.uk/2012/07/step-builder-pattern_28.html)
1040 1041
* [Douglas C. Schmidt and Charles D. Cranor - Half Sync/Half Async](http://www.cs.wustl.edu/~schmidt/PDF/PLoP-95.pdf)
* [Pattern Oriented Software Architecture Vol I-V](http://www.amazon.com/Pattern-Oriented-Software-Architecture-Volume-Patterns/dp/0471958697)
I
Ilkka Seppälä 已提交
1042

1043

1044
# <a name="license">License</a> [&#8593;](#top)
I
Ilkka Seppälä 已提交
1045

J
joshzambales 已提交
1046
This project is licensed under the terms of the MIT license.