Builder pattern
The builder pattern is a design pattern designed to provide a flexible solution to various object creation problems in object-oriented programming. The intent of the Builder design pattern is to separate the construction of a complex object from its representation. It is one of the Gang of Four design patterns.
Overview
The Builder design pattern is one of the GoF design patterns[1] that describe how to solve recurring design problems in object-oriented software.
The Builder design pattern solves problems like:[2]
- How can a class (the same construction process) create different representations of a complex object?
- How can a class that includes creating a complex object be simplified?
Creating and assembling the parts of a complex object directly within a class is inflexible. It commits the class to creating a particular representation of the complex object and makes it impossible to change the representation later independently from (without having to change) the class.
The Builder design pattern describes how to solve such problems:
- Encapsulate creating and assembling the parts of a complex object in a separate
Builder
object. - A class delegates object creation to a
Builder
object instead of creating the objects directly.
A class (the same construction process) can delegate to different Builder
objects to create different representations of a complex object.
Definition
The intent of the Builder design pattern is to separate the construction of a complex object from its representation. By doing so, the same construction process can create different representations.[1]
Advantages
Advantages of the Builder pattern include:[3]
- Allows you to vary a product's internal representation.
- Encapsulates code for construction and representation.
- Provides control over steps of construction process.
Disadvantages
Disadvantages of the Builder pattern include:[3]
- Requires creating a separate ConcreteBuilder for each different type of product.
- Requires the builder classes to be mutable.
- Dependency injection may be less supported.
Structure
UML class and sequence diagram
In the above UML class diagram,
the Director
class doesn't create and assemble the ProductA1
and ProductB1
objects directly.
Instead, the Director
refers to the Builder
interface for building (creating and assembling) the parts of a complex object,
which makes the Director
independent of which concrete classes are instantiated (which representation is created).
The Builder1
class implements the Builder
interface by creating and assembling the ProductA1
and ProductB1
objects.
The UML sequence diagram shows the run-time interactions:
The Director
object calls buildPartA()
on the Builder1
object, which creates and assembles the ProductA1
object.
Thereafter,
the Director
calls buildPartB()
on Builder1
, which creates and assembles the ProductB1
object.
Class diagram
- Builder
- Abstract interface for creating objects (product).
- ConcreteBuilder
- Provides implementation for Builder. It is an object able to construct other objects. Constructs and assembles parts to build the objects.
Examples
C#
/// <summary>
/// Represents a product created by the builder
/// </summary>
public class Car
{
public string Make { get; set; }
public string Model { get; set; }
public int NumDoors { get; set; }
public string Colour { get; set; }
public Car(string make, string model, string colour, int numDoors)
{
Make = make;
Model = model;
Colour = colour;
NumDoors = numDoors;
}
}
/// <summary>
/// The builder abstraction
/// </summary>
public interface ICarBuilder
{
string Colour { get; set; }
int NumDoors { get; set; }
Car GetResult();
}
/// <summary>
/// Concrete builder implementation
/// </summary>
public class FerrariBuilder : ICarBuilder
{
public string Colour { get; set; }
public int NumDoors { get; set; }
public Car GetResult()
{
return NumDoors == 2 ? new Car("Ferrari", "488 Spider", Colour, NumDoors) : null;
}
}
/// <summary>
/// The director
/// </summary>
public class SportsCarBuildDirector
{
private ICarBuilder _builder;
public SportsCarBuildDirector(ICarBuilder builder)
{
_builder = builder;
}
public void Construct()
{
_builder.Colour = "Red";
_builder.NumDoors = 2;
}
}
public class Client
{
public void DoSomethingWithCars()
{
var builder = new FerrariBuilder();
var director = new SportsCarBuildDirector(builder);
director.Construct();
Car myRaceCar = builder.GetResult();
}
}
The Director assembles a car instance in the example above, delegating the construction to a separate builder object that has been given to the Director by the Client.
See also
References
- Erich Gamma, Richard Helm, Ralph Johnson, John Vlissides (1994). Design Patterns: Elements of Reusable Object-Oriented Software. Addison Wesley. pp. 97ff. ISBN 0-201-63361-2.CS1 maint: multiple names: authors list (link)
- "The Builder design pattern - Problem, Solution, and Applicability". w3sDesign.com. Retrieved 2017-08-13.
- "Index of /archive/2010/winter/51023-1/presentations" (PDF). www.classes.cs.uchicago.edu. Retrieved 2016-03-03.
- "The Builder design pattern - Structure and Collaboration". w3sDesign.com. Retrieved 2017-08-12.
External links
The Wikibook Computer Science Design Patterns has a page on the topic of: Builder implementations in various languages |
- The JavaWorld article Build user interfaces without getters and setters (Allen Holub) shows the complete Java source code for a Builder.