CYAN
 MAGENTA

 YELLOW
  BLACK
 PANTONE 123 C

Books for professionals by professionals ®

Pro JavaScript Design Patterns

The EXPERT’s VOIce ® in Web Development
Companion
eBook
Available

™

Ross Harmes and Dustin Diaz

Related Titles

Companion eBook

See last page for details
on $10 eBook version

 

www.apress.com


Harmes,
Diaz

SOURCE CODE ONLINE

 

™

Web programming is becoming more complex and collaborative each day. A
new JavaScript™ library is born each week, and we are getting closer to the time
when web applications can seamlessly replace those found on our desktops. It
is no longer possible to design the behavior of your sites haphazardly without
thinking about long-term software maintainability.
The JavaScript language has matured. We have reached a point where software development techniques once considered useful only in languages such
as Java and C++ are being applied to web programming. Therefore, we felt the
time has come for a book that explores object-oriented design principles and
applies them to the JavaScript language. The techniques needed to implement
patterns like factory, singleton, observer, composite, and facade in JavaScript
are easily understood, but they have not previously been discussed in depth in
a single book. We wanted to show programmers that JavaScript contains features
on par with other high-level languages and is an object-oriented programming
language in its own right. In fact, we wrote the book that we ourselves have always
wanted to read.
In this book, we will teach you about commonly used software patterns for
designing the code that drives your websites and applications. You will learn
object-oriented JavaScript programming, starting with routine tasks and progressing to advanced techniques and patterns. We will help you create libraries
and APIs that can be used by others, as well as show you techniques that will
help you interact with other JavaScript programmers and work effectively in
large teams. Most of all, we will show you how powerful, expressive, and flexible

Proofreader: Dan Shaw
Indexer: Julie Grady
Cover Designer: Kurt Krames
Manufacturing Director: Tom Debolski
Distributed to the book trade worldwide by Springer-Verlag New York, Inc., 233 Spring Street, 6th Floor,
New York, NY 10013. Phone 1-800-SPRINGER, fax 201-348-4505, e-mail [email protected], or
visit http://www.springeronline.com.
For information on translations, please contact Apress directly at 2855 Telegraph Avenue, Suite 600, Berkeley,
CA 94705. Phone 510-549-5930, fax 510-549-5939, e-mail [email protected], or visit http://www.apress.com.
The information in this book is distributed on an “as is” basis, without warranty. Although every precaution
has been taken in the preparation of this work, neither the author(s) nor Apress shall have any liability to
any person or entity with respect to any loss or damage caused or alleged to be caused directly or indirectly
by the information contained in this work.
The source code for this book is available to readers at http://www.apress.com.


908Xch00FM.qxd

11/16/07

1:05 PM

Page iii

To Mom, and those who have listened, thanks
—Dustin Diaz
To Alec, Dymphi, and Terry
—Ross Harmes




PART 2
■CHAPTER
■CHAPTER
■CHAPTER
■CHAPTER
■CHAPTER
■CHAPTER
■CHAPTER
■CHAPTER
■CHAPTER
■CHAPTER
■CHAPTER

■■■
1
2
3
4
5
6

Expressive JavaScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Encapsulation and Information Hiding . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
The Singleton Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Chaining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

■■■

v


908Xch00FM.qxd

11/16/07

1:05 PM

Page vi


908Xch00FM.qxd

11/16/07

1:05 PM

Page vii

Contents
About the Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
About the Technical Reviewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi

PART 1

■■■


Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
vii


908Xch00FM.qxd

viii

11/16/07

1:05 PM

Page viii

■CONTENTS

■CHAPTER 3

Encapsulation and Information Hiding . . . . . . . . . . . . . . . . . . . . 25
The Information Hiding Principle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Encapsulation vs. Information Hiding . . . . . . . . . . . . . . . . . . . . . . . . . . 26
The Role of the Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Basic Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Fully Exposed Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Private Methods Using a Naming Convention . . . . . . . . . . . . . . . . . . . 30
Scope, Nested Functions, and Closures . . . . . . . . . . . . . . . . . . . . . . . . 32
Private Members Through Closures . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
More Advanced Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Static Methods and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37



908Xch00FM.qxd

11/16/07

1:05 PM

Page ix

■CONTENTS

A Singleton As a Wrapper for Page-Specific Code . . . . . . . . . . . . . . . . . . . . 68
A Singleton with Private Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Using the Underscore Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Using Closures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Comparing the Two Techniques. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Lazy Instantiation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Branching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Example: Creating XHR Objects with Branching . . . . . . . . . . . . . . . . . . . . . 79
When Should the Singleton Pattern Be Used? . . . . . . . . . . . . . . . . . . . . . . . 81
Benefits of the Singleton Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Drawbacks of the Singleton Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

■CHAPTER 6

Chaining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
The Structure of a Chain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Building a Chainable JavaScript Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86


x

11/16/07

1:05 PM

Page x

■CONTENTS

■CHAPTER 8

The Bridge Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Example: Event Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Other Examples of Bridges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Bridging Multiple Classes Together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Example: Building an XHR Connection Queue . . . . . . . . . . . . . . . . . . . . . . 111
Including the Core Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Including an Observer System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Developing the Queue Skeleton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Implementing the Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Where Have Bridges Been Used? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
When Should the Bridge Pattern Be Used? . . . . . . . . . . . . . . . . . . . . . . . . . 122
Benefits of the Bridge Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Drawbacks of the Bridge Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

■CHAPTER 9



11/16/07

1:05 PM

Page xi

■CONTENTS

■CHAPTER 11 The Adapter Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Characteristics of an Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Adapting Existing Implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Example: Adapting One Library to Another . . . . . . . . . . . . . . . . . . . . . . . . . 150
Example: Adapting an Email API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Wrapping the Webmail API in an Adapter . . . . . . . . . . . . . . . . . . . . . 157
Migrating from fooMail to dedMail . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
When Should the Adapter Pattern Be Used? . . . . . . . . . . . . . . . . . . . . . . . . 158
Benefits of the Adapter Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Drawbacks of the Adapter Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

■CHAPTER 12 The Decorator Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
The Structure of the Decorator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
The Role of the Interface in the Decorator Pattern . . . . . . . . . . . . . . 163
The Decorator Pattern vs. the Composite Pattern . . . . . . . . . . . . . . 163
In What Ways Can a Decorator Modify Its Component? . . . . . . . . . . . . . . 164
Adding Behavior After a Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Adding Behavior Before a Method . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Replacing a Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Adding New Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Page xii

■CONTENTS

Example: Tooltip Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
The Unoptimized Tooltip Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Tooltip As a Flyweight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Storing Instances for Later Reuse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
When Should the Flyweight Pattern Be Used? . . . . . . . . . . . . . . . . . . . . . . 192
General Steps for Implementing the Flyweight Pattern . . . . . . . . . . . . . . 193
Benefits of the Flyweight Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Drawbacks of the Flyweight Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

■CHAPTER 14 The Proxy Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
The Structure of the Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
How Does the Proxy Control Access to Its Real Subject? . . . . . . . 197
Virtual Proxy, Remote Proxy, and Protection Proxy . . . . . . . . . . . . . . 200
The Proxy Pattern vs. the Decorator Pattern . . . . . . . . . . . . . . . . . . . 201
When Should the Proxy Be Used? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Example: Page Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
General Pattern for Wrapping a Web Service . . . . . . . . . . . . . . . . . . . . . . . 205
Example: Directory Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
General Pattern for Creating a Virtual Proxy . . . . . . . . . . . . . . . . . . . . . . . . 210
Benefits of the Proxy Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Drawbacks of the Proxy Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

■CHAPTER 15 The Observer Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Example: Newspaper Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Types of Command Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Example: Menu Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
The Menu Composites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
The Command Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Putting It All Together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Adding More Menu Items Later On . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Example: Undo and Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Implementing Undo with Nonreversible Actions By Logging
Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Logging Commands for Crash Recovery . . . . . . . . . . . . . . . . . . . . . . 242
When to Use the Command Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Benefits of the Command Pattern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Drawbacks of the Command Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

■CHAPTER 17 The Chain of Responsibility Pattern . . . . . . . . . . . . . . . . . . . . . . 245
The Structure of the Chain of Responsibility. . . . . . . . . . . . . . . . . . . . . . . . 245
Passing on Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Implementing a Chain of Responsibility in an Existing Hierarchy . . . . . . 254
Event Delegation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
When Should the Chain of Responsibility Pattern Be Used? . . . . . . . . . . 255
Example: Image Gallery Revisited. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Using the Chain of Responsibility to Make Composites
More Efficient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Adding Tags to Photos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Benefits of the Chain of Responsibility Pattern . . . . . . . . . . . . . . . . . . . . . 261
Drawbacks of the Chain of Responsibility Pattern . . . . . . . . . . . . . . . . . . . 262
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

■INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

This is Ross’s first book, but he has been publishing his stray thoughts
online for years. These days his technical ramblings can be found at
http://techfoolery.com.
■DUSTIN DIAZ is a user interface engineer for Google in Mountain View,
California. He enjoys writing JavaScript, CSS, and HTML, as well as making
interactive and usable interfaces to inspire passionate users. Dustin has
written articles for Vitamin and Digital Web Magazine, and posts regularly
about web development at his site, http://dustindiaz.com.

xv


908Xch00FM.qxd

11/16/07

1:05 PM

Page xvi


908Xch00FM.qxd

11/16/07

1:05 PM

Page xvii

About the Technical Reviewer

much less accurate, practical, and interesting. He worked tirelessly to provide amazing feedback
for each and every chapter.
Thanks to our colleagues and coworkers who took the time to wade through the early drafts
and provide notes and corrections. Dave Marr and Ernest Delgado in particular went above and
beyond and were instrumental in finding typos, technical errors, and poorly worded sentences.
Also, thanks to Lindsey Simon and Robert Otani, each of whom supported us by providing
ceaseless JavaScript humor.
Thanks to our friends and family, who stood by patiently while we bored them to death
with our endless tales of writing and incomprehensible technical minutiae. Your support kept
us going.
And lastly, we both wish to give our sincerest thanks to the people at Apress who made
this book a reality. The patience, understanding, and perseverance of Chris Mills, Tom Welsh,
Dominic Shakeshaft, Richard Dal Porto, and Jennifer Whipple deserve special recognition and
won’t be forgotten.

xix


908Xch00FM.qxd

11/16/07

1:05 PM

Page xx


908Xch00FM.qxd

11/16/07

and one that is well-suited to experimentation. Play around with any of our code examples.
Let us know if you find a novel way of implementing a pattern, or a new use for an old technique. More information and downloadable code examples can be found at the book’s
website, http://jsdesignpatterns.com, and at the Apress website, http://www.apress.com.

Who This Book Is For
This book is meant primarily for two types of people. The first is web developers or front-end
engineers who know some JavaScript and wish to learn more. Specifically, those who want to
improve their understanding of the object-oriented capabilities of JavaScript and learn how
they can make their code more modular, maintainable, and efficient. This book will teach
these readers about the basics of object-oriented programming in JavaScript. It will also teach
them about specific design patterns, showing when they can be used and how to implement

xxi


908Xch00FM.qxd

xxii

11/16/07

1:05 PM

Page xxii

■INTRODUCTION

them. This type of reader will already be familiar with the basic JavaScript syntax and will focus
more on the sections that deal with converting existing code to implement specific patterns,
and explanations of when each pattern should or shouldn’t be used.

We look at how other object-oriented languages implement interfaces and try to emulate the
best features of each in JavaScript. We explore the options available for interface checking and
come up with a reusable class that can be used to check objects for needed methods.


908Xch00FM.qxd

11/16/07

1:05 PM

Page xxiii

■INTRODUCTION

Chapter 3: Encapsulation and Information Hiding
We explore the different ways in which objects can be created in JavaScript, and the techniques
available within each to create public, private, and protected methods. We also take a look at the
situations where using complex encapsulated objects can benefit the JavaScript programmer.

Chapter 4: Inheritance
We look at the techniques that can be used to create subclasses in JavaScript. We cover both
classical and prototypal inheritance, and outline the situations where it is appropriate to use
each. We also discuss mixin classes and how they can be used as an alternative to multiple
inheritance.

Chapter 5: The Singleton Pattern
We discuss the uses of the singleton pattern in JavaScript. We cover namespacing, code organization, and branching, which can be used to define methods dynamically based on the run-time
environment. We look at the patterns that benefit from being coupled with singletons, such as
factories and flyweights.