Builder Pattern 🎞

생성자에 들어갈 매개 변수가 많든 적든 차례대로 매개 변수를 받아들이고 모든 매개 변수를 받은 뒤,
변수들을 통합해서 한 번에 사용

Why Use Builder Pattern?

//조건 : 이 객체는 한번 생성되면 읽기(Read)만 가능
public class PersonInfo {
	private String name;
	private Integer age;
	private String favoriteColor;
	private String favoriteAnimal;
	private Integer favoriteNumber;

	public PersonInfo(String name, Integer age, String favoriteColor, String
    favoriteAnimal, Integer favoriteNumber) {
		super();
		this.name = name;
		this.age = age;
		this.favoriteColor = favoriteColor;
		this.favoriteAnimal = favoriteAnimal;
		this.favoriteNumber = favoriteNumber;
	}

	public String getPersonInfo() {
		String personInfo = String.format(
        
       "name:%s, age:%d, favoriteColor:%s, 
  	favoriteAnimal:%s, favoriteNumber:%d",
        name, age, favoriteColor, favoriteAnimal, favoriteNumber);

		return personInfo;
	}
}

위의 조건을 고려하면 setter 메서드는 존재 불가능,
생성자를 통해서만 데이터를 입력받을 수 있습니다.

이 과정에서 생성자를 통해 데이터를 입력받을 때 다양한 예외🤕들이 발생합니다.

1. 생성자 중 일부만을 알고 있는 예외
2. 데이터를 입력하는 순서가 다른 예외
3. 가독성을 좋게 하기 위해 추가 생성자를 만들어서 처리할 예외 등

다양한 예외들을 전부 고려해서 새로운 생성자를 만들고 해결할 수 없습니다.
매번 사용자가 체크해야 되는 상황이 오기 때문입니다.
그렇기 때문에 Builder Pattern을 사용합니다. 😀

Implement Builder Pattern

• 불필요한 생성자를 만들지 않고 객체를 만든다.
• 데이터의 순서에 상관없이 객체를 만든다.
• 사용자가 봤을 때 명시적이고 이해할 수 있어야 한다.

public class PersonInfoBuilder {
	private String name;
	private Integer age;
	private String favoriteColor;
	private String favoriteAnimal;
	private Integer favoriteNumber;

	public PersonInfoBuilder setName(String name) {
		this.name = name;
		return this;
	}

	public PersonInfoBuilder setAge(Integer age) {
		this.age = age;
		return this;
	}

	public PersonInfoBuilder setFavoriteColor(String favoriteColor) {
		this.favoriteColor = favoriteColor;
		return this;
	}

	public PersonInfoBuilder setFavoriteAnimal(String favoriteAnimal) {
		this.favoriteAnimal = favoriteAnimal;
		return this;
	}

	public PersonInfoBuilder setFavoriteNumber(Integer favoriteNumber) {
		this.favoriteNumber = favoriteNumber;
		return this;
	}

	public PersonInfo build() {
		PersonInfo personInfo = new PersonInfo(name, age, favoriteColor, 
        	favoriteAnimal, favoriteNumber);
		return personInfo;
	}
}

public class BuilderPattern {

	public static void main(String[] args) {
		
		PersonInfoBuilder personInfoBuilder = new PersonInfoBuilder();

		PersonInfo result = personInfoBuilder.setName("Hong").setAge(24).
        	setFavoriteAnimal("cat").setFavoriteColor("black").build();

		System.out.println(result.getPersonInfo());
	}
}

정상 동작합니다.

---

• Builder class를 꼭 객체를 만들어낼 class와 분리할 필요는 없습니다. 👆
  아래와 같이 객체를 만들어낼 class 내부에 Builder class를 포함할 수 있습니다.

// 정적 중첩 클래스 형태(Static Nested Class)

public class PersonInfo {

	private String name;
	private Integer age;
	private String favoriteColor;
	private String favoriteAnimal;
	private Integer favoriteNumber;

	private PersonInfo(String name, Integer age, String favoriteColor, String favoriteAnimal, 
    Integer favoriteNumber) {
		super();
		this.name = name;
		this.age = age;
		this.favoriteColor = favoriteColor;
		this.favoriteAnimal = favoriteAnimal;
		this.favoriteNumber = favoriteNumber;
	}

	public String getPersonInfo() {
		String personInfo = String.format("name:%s, age:%d, favoriteColor:%s, 
        	favoriteAnimal:%s, favoriteNumber:%d",
            	name, age, favoriteColor, favoriteAnimal, favoriteNumber);

		return personInfo;
	}

	public static class PersonInfoBuilder {
		
		/* 밖에 있는 class의 변수와 메소드 중에 static이 붙은 것들을 사용 가능
		 * 
		 * */
		private String name;
		private Integer age;
		private String favoriteColor;
		private String favoriteAnimal;
		private Integer favoriteNumber;

		public PersonInfoBuilder setName(String name) {
			this.name = name;
			return this;
		}

		public PersonInfoBuilder setAge(Integer age) {
			this.age = age;
			return this;
		}

		public PersonInfoBuilder setFavoriteColor(String favoriteColor) {
			this.favoriteColor = favoriteColor;
			return this;
		}

		public PersonInfoBuilder setFavoriteAnimal(String favoriteAnimal) {
			this.favoriteAnimal = favoriteAnimal;
			return this;
		}

		public PersonInfoBuilder setFavoriteNumber(Integer favoriteNumber) {
			this.favoriteNumber = favoriteNumber;
			return this;
		}

		public PersonInfo build() {
			PersonInfo personInfo = new PersonInfo(name, age, favoriteColor, 
            		favoriteAnimal, 
            		favoriteNumber);
			return personInfo;
		}
	}
}

public class BuilderPattern {

	public static void main(String[] args) {

		// PersonInfo class의 객체가 없어도 PersonInfoBuilder class의 객체 생성이 가능
		PersonInfo.PersonInfoBuilder personInfoBuilder = new PersonInfo.PersonInfoBuilder();

		PersonInfo result = personInfoBuilder.setAge(23).setName("Hong").
        				 setFavoriteColor("black")
					.setFavoriteAnimal("cat").build();

		System.out.println(result.getPersonInfo());
	}
}

이 경우에도 정상 동작합니다.

Closing Remarks

이해를 돕기 위해 다이어그램을 첨부하겠습니다.

• Builder class를 객체를 만들어낼 class와 분리한 경우
  

• Builder class를 객체를 만들어낼 class 내부에 포함한 경우