Effective Java ( 이펙티브 자바 ) - 아이템 50

적시에 방어적 복사본을 만들라

---

  자바는 안전한 언어다. 자바를 쓰는 즐거움 중 하나다. 하지만 아무리 자바라 해도 다른 클래스로부터의 침범을 아무런 노력 없이 다 막을 수 있는 건 아니다. 그러니 클라이언트가 여러분의 불변식을 깨뜨리려 혈안이 되어 있다고 가정하고 방어적으로 프로그래밍해야 한다. 충분한 시간을 투자하자.

  어떤 객체든 그 객체의 허락 없이는 외부에서 내부를 수정하는 일은 불가능하다. 하지만 주의를 기울이지 않으면 자기도 모르게 내부를 수정하도록 허락하는 경우가 생긴다. 흔히 발생하는 문제다. 예컨대 기간을 표현하는 다음 클래스는 한번 값이 정해지면 변하지 않도록 할 생각이었다. 

public final class Period {
   private final Date start;
   private final Date end;
   
   /**
    * @param start 시작 시각
    * @param end 종료 시각. 시작 시각보다 뒤여야 한다.
    * @throws IllegalArgumentException 시작 시각이 종료 시각보다 늦을 때 발생한다.
    * @throws NullPointerException start나 end가 null이면 발생한다.
   */
   public Period(Date start, Date end) {
      if (start.compareTo(end) > 0)
         throw new IllegalArgumentException(
            start + " after " + end);
      this.start = start;
      this.end = end;
   }
   
   public Date start() {
      return start;
   }
   
   public Date end() {
      return end;
   }
   
   .. // 나머지 생략
}

얼핏 이 클래스는 불변처럼 보이고, 시작 시각이 종료 시각보다 늦을 수 없다는 불변식이 지켜질 것 같지만, Date가 가변이라는 사실을 이용하면 어렵지 않게 깨뜨릴 수 있다.

 

Date start = new Date();
Date end = new Date();
Period p = new Period(start, end);
end.setYear(78); // p의 내부를 수정했다.

다행히 자바 8 이후로는 쉽게 해결할 수있다. Date 대신 불변인 Instant를 사용하면된다. (혹은 LocalDateTime, ZonedDateTime) Date는 낡은 API이니 새로운 코드를 작성할 때는 더 이상 사용하면 안 된다. 하지만 앞으로 쓰지 않는다고 이 문제에서 해방되는 건 아니다. 여전히 남아있다. 이번 아이템은 예전에 작성된 낡은 코드들을 대처하기 위한 것이다.

 

  외부 공격으로부터 Period 인스턴스의 내부를 보호하려면 생성자에서 받은 가변 매개변수 각각을 방어적으로 복사해야 한다. 그런 다음 Period 인스턴스 안에서는 원본이 아닌 복사본을 사용한다.

public Period(Date start, Date end) {
   this.start = new Date(start.getTime());
   this.end = new Date(end.getTime());
   
   if (this.start.compareTo(this.end) > 0)
      throw new IllegalArgumentException(
         this.start + " after " + this.end);
}

 

매개변수의 유효성을 검사하기 전에 방어적 복사본을 만들고, 이 복사본으로 유효성을 검사한 점에 주목하자. 순서가 부자연스러워 보이겠지만, 반드시 이렇게 작성해야 한다. 멀티스레딩 환경이라면 원본 객체의 유효성을 검사한 후 복사본을 만드는 그 찰나의 취약한 순간에 다른 스레드가 원본 객체를 수정할 위험이 있기 때문이다. 

 

 

  방어적 복사에 Date의 clone 메서드를 사용하지 않은 점에도 주목하자. Date는 final이 아니므로 clone이 Date가 정의한게 아닐 수도 있다. 즉, 악의를 가진 하위 클래스의 인스턴스를 반환할 수도 있다. 그러므로 매개변수가 제3자에 의해 확장될 수 있는 타입이라면 방어적 복사본을 만들 때 clone을 사용해서는 안 된다.

 

  생정자를 수정하면 앞서의 공격은 막아낼 수 있지만, Period 인스턴스는 아직도 변경 가능하다. 접근자 메서드가 있기 때문이다.

Date start = new Date();
Date end = new Date();
Period p = new Period(start, end);
p.end().setYear(78); // p의 내부를 변경했다!

단순히 접근자가 가변 필드의 방어적 복사본을 반환하면 된다.

public Date start() {
   return new Date(start.getTime());
}

public Date end() {
   return new Date(end.getTime());
}

이제 Period는 완벽한 불변으로 거듭난다. (네이티브 메서드나 리플렉션 같이 언어 외적인 수단을 동원하지 않고는). 

 

  매개변수를 방어적으로 복사하는 목적이 불변 객체를 만들기 위해서만은 아니다. 메서드는 생성자든 클라이언트가 제공한 객체의 참조를 내부의 자료구조에 보관해야 할 때면 항시 그 객체가 잠재적으로 변경될 수 있는지를 생각해야 한다. 변경될 수 있는 객체라면 넘겨진 뒤 임의로 변경되어도 그 클래스가 문제없이 동작할지를 따져보라. 확신할 수 없다면 복사본을 만들어 저장해야 한다. 

예컨대 클라이언트가 건네준 객체를 내부의 Set에 저장하거나, Map 인스턴스의 키로 사용한다면, 불변식이 깨질 수 있다.

 

 길이가 1 이상인 배열은 무조건 가변임을 잊지 말자. 그러니 내부에서 사용하는 배열을 클라이언트에 반환할 때는 항상 방어적 복사를 수행해야 한다. 

 

이상의 모든 작업에서 우리는 "되도록 불변 객체들을 조합해 객체를 구성해야 방어적 복사를 할 일이 줄어든다"는 교훈을 얻을 수 있다.

 

Period 예제의 경우, 자바 8 이상으로 개발해도 된다면 Instant(LocalDateTime, ZonedDateTime)를 사용하라. 

 

  방어적 복사에는 성능 저하가 따르고, 또 항상 쓸 수 있는 것도 아니다. 호출자가 컴포넌트 내부를 수정하지 않으리라 확신하면 방어적 복사를 생략할 수 있다. 그래도 수정하지 말아야 함을 명확히 문서화하는 게 좋다.

 

  때로는 메서드나 생성자의 매개변수로 넘기는 행위가 그 객체의 통제권을 명백히 이전함을 뜻하기도 한다. 이처럼 통제권을 이전하는 메서드를 호출하는 클라이언트는 해당 객체를 더 이상 직접 수정하는 일이 없다고 약속해야 한다. 

 

  따라서 방어적 복사를 생략해도 되는 상황은 해당 클래스와 그 클라이언트가 상호 신뢰할 수 있을 때, 혹은 불변식이 깨지더라도 그 영향이 오직 호출한 클라이언트로 국한될 때로 한정해야 한다. 

클래스가 클라이언트로부터 받는 혹은 클라이언트로 반환하는 구성요소가 가변이라면 그 요소는 반드시 방어적으로 복사해야 한다. 복사 비용이 너무 크거나 클라이언트를 신뢰한다면 방어적 복사를 수행하는 대신 수정했을 때의 책임이 클라이언트에 있음을 문서에 명시하도록 하자.