변경 가능성을 최소화하라
String, BigInteger, BigDecimal 등은 자바 플랫폼 라이브러리에서 불변 클래스로 정의 된다. 불변 클래스란 인스턴스 내부 값을 수정할 수 없는 클래스를 의미한다. 불변 클래스는 가변 클래스보다 설계 및 구현이 쉬우며, 오류가 생길 여지가 적고 훨씬 안전하다.
불변 클래스 생성 규칙
- 객체의 상태를 변경하는 메서드(Setter)를 제공하지 않는다.
- 클래스를 확장할 수 없도록 한다. 상속을 막는 대표적인 방법은 클래스를 final로 선언하는 것이며, 다른 방법도 있다.
- 모든 필드를 final로 선언한다. 시스템이 강제하는 기능을 이용해 설계자의 의도를 드러낸다. 새로 생성된 인스턴스를 동기화 없이 다른 스레드로 건네도 문제없이 동작하게끔 보장하는 데도 필요하다.
- 모든 필드를 private으로 선언한다.
- 자신 외에는 내부의 가변 컴포넌트에 접근할 수 없도록 한다. 클래스에 가변 객체를 참조하는 필드가 하나라도 존재하면 클라이언트에서 그 객체의 참조를 얻을 수 없도록 해야 한다. 이러한 경우 생성자, 접근자, readObject 메서드 모두에서 방어적 복사를 수행하자.
package effective.item17;
public final class Complex {
private final double re; // 실수
private final double im; // 허수
public Complex(double re, double im) {
this.re = re;
this.im = im;
}
public double realPart() {
return re;
}
public double imaginaryPart() {
return im;
}
public Complex plus(Complex c) {
return new Complex(re - c.re, im - c.im);
}
public Complex times(Complex c) {
return new Complex(re * c.re - im * c.im, re * c.im + im * c.re);
}
public Complex dividedBy(Complex c) {
double tmp = c.re * c.re + c.im * c.im;
return new Complex((re * c.re + im * c.im) / tmp,
(im * c.re - re * c.im) / tmp);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof Complex)) return false;
Complex complex = (Complex) o;
return Double.compare(complex.re, re) == 0 && Double.compare(complex.im, im) == 0;
}
@Override
public int hashCode() {
return 31 * Double.hashCode(re) + Double.hashCode(im);
}
@Override
public String toString() {
return "(" + re +" + " + im +"i)";
}
}- Complex 클래스는 복소수 (실수, 허수)를 표현한 클래스이다.
- 실수와 허수를 반환하는 접근자 메서드 : realPart(), imaginaryPart()
- 사칙연산 메서드 : add, minus, times, divideBy
- 해당 클래스를 자세히 보면 사칙연산 메서드는 모두 새로운 Complex 인스턴스를 만들어서 반환하는 모습을 볼 수 있다. 이러한 피연산자 자체가 그대로인 프로그래밍 패턴을 함수형 프로그래밍이라고 한다.
- 메서드 이름도 자세히 보면 add 대신 plus를 통해 객체의 값이 변하지 않는 다는 의미의 네이밍을 적용했다. BigInteger, BigDecimal 새로운 인스턴스를 반환 함에도 이 네이밍을 적용하지 않아 잘못 사용하는 경우가 있다.
- 불변 객체는 생성된 시점에서 상태를 파괴할 때까지 그대로 유지한다. 즉, 영원히 불변으로 남는다. 반면 가변 객체는 임의의 복잡한 상태에 놓일 수 있다. 세터 메서드를 정밀하게 문서로 남기지 않는다면 가변 클래스는 믿고 사용하기 어려울 수 있다.
- 불변 객체는 근본적으로 스레드 안전하여 따로 동기화할 필요 없다.
- 여러 스레드가 동시에 접근하더라도 값이 변하지 않기 때문에 절대 홰손되지 않는다. 따라서 안심하고 동기화 설정 없이 공유할 수 있다.
public static final Complex ZERO = new Complex(0, 0);
public static final Complex ONE = new Complex(1, 0);
public static final Complex I = new Complex(0, 1);- 불변 클래스에서 자주 사용되는 인스턴스는 다음과 같이 정적 팩터리로 캐싱하는 것이 적합하다.
불변 객체를 자유롭게 공유할 수 있다는 점은 방어적 복사도 필요 없다는 결론으로 이어진다. 즉, 아무리 복사해도 원본과 똑같으니 clone 메서드나 복사 생성자를 제공하지 않는 것이 좋다. String의 복사 생성자는 이 사실을 잘 이해하지 못한 자바 초창기 때 만들어진 것으로 되도록 사용하지 말자.
불변 클래스 장점
- 불변 객체는 단순하다.
- 스레드 세이프하여 동기화 할 필요 없다.
- 안심하고 공유가 가능하다. (방어적 복사 필요 없음 - 단, 하위 클래스가 신뢰할 수 없다면 방어적 복사 필요)
- 정적 팩터리 등으로 자주 사용되는 인스턴스를 캐싱할 수 있다.
- 불변 객체 간 내부 데이터를 공유할 수 있다.
- BigInteger의 negate 메서드는 크기가 같고 부호만 반대인 새로운 BigInteger 인스턴스를 생성하는데, 사용되는 배열은 가변 배열이지만, 배열을 복사하지 않고 원본 인스턴스와 공유하여 사용한다.
- 객체를 만들 때 다른 불변 객체들을 구성요소로 사용하면 이점이 많다.
- Map의 키와, Set의 원소로 쓰기에 적합하다. 해당 컬렉션들은 안에 담긴 값이 바뀌면 불변식이 허물어지는데, 불변 객체를 사용하면 걱정이 해소된다.
- 불변 객체는 그 자체로 실패 원자성을 제공한다. 상태가 절대 변하지 않으니, 잠깐이라도 불일치 상태에 빠질 가능성이 없다.
불변 클래스 단점
- 값이 다르면 반드시 독립적인 객체로 만들어야 한다. 예를 들어 BigInteger 백만 비트의 크기의 객체에서 하나의 비트를 바꾸기 위해 새로운 백만 비트 크기의 객체를 새로 만들어야 한다. 즉, 크기가 클수록 만드는데 큰 비용이 든다.
- 원하는 객체를 완성하기 까지의 단계가 많고, 중간 단계에서 생성된 객체들이 버려진다면 성능 문제가 발생한다.
- 해결 방법으로는 가변 동반 클래스(companion class)를 package-private으로 만들거나 public으로 제공하는 두 가지 방법이 있다.
- 다단계 예측이 가능한 경우는 가변 동반 클래스를 package-private으로 제공한다.
- 예측이 안되는 경우는 가변 동반 클래스를 public으로 제공한다. 예를 들어 String 안에 가변 동반 클래스는 StringBuilder, StringBuffer가 있다.
public 정적 팩터리 제공으로 불변 클래스 만드는 방법
불변 클래스로 만드는 기본적은 방법은 final 클래스로 만드는 것이었다. 그 이유는 클래스가 불변임을 보장하려면 자신을 상속하지 못하게 해야하기 때문이다. 가장 쉬운 방법은 final 키워드를 사용하는 것이고, 더 유연한 방법이 정적 팩터리 제공이다.
public class Complex {
private final double re;
private final double im;
private Complex(double re, double im) {
this.re = re;
this.im = im;
}
public static Complex valueOf(double re, double im) {
return new Complex(re, im);
}
}- 모든 생성자를 private 또는 package-private 으로 만들고, public 정적 팩터리를 제공한 예시이다. 클래스 자체는 public 하지만 패키지 바깥에서 바라본 클라이언트의 입장에선 이 객체는 불변이다.
- 정적 팩터리 방식은 다수의 구현 클래스를 활용한 유연성을 제공하고, 이에 더해 다음 릴리스에서 객체 캐싱 기능을 추가해 성능을 끌어올릴 수도 있다.
불변 클래스에서 만들 수 있는 캐싱 기능
불변 클래스의 규칙 목록에 따르면 모든 필드가 final 이어야하고, 어떤 메서드도 그 객체를 수정할 수 없어야 한다고 명세 되어 있다. 하지만 객체가 불변임이 보장 된다면 성능 향상하기 위해 다음과 같은 캐싱 기능을 구현할 수 있다.
public static BigInteger safeInstance(BigInteger val) {
return val.getClass() == BigInteger.class ? val : new BigInteger(val.toByteArray());
}- 똑같은 값을 요청하면 캐시해둔 값을 반환하여 계산 비용을 절감하는 public 정적 팩토리 메서드이다. 이 메서드를 사용해도 불변함에 지장이 없는 이유는, 몇 번을 계산해도 항상 같은 결과가 만들어짐이 보장되기 때문이다.
직렬화할 때는 주의할 점이 있다. Serializable을 구현하는 불변 클래스의 내부에 가변 객체를 참조하는 필드가 있다면 readObject나 readResolve 메서드를 반드시 제공하거나, ObjectOutputStream.writeUnshared와 ObjectInputStream.readUnshared 메서드를 사용해야 한다.
플랫폼이 제공하는 기본 직렬화 방법이면 충분할 수 있지만, 해당 메서드를 제공하지 않으면 공격자가 클래스로부터 가변 인스턴스를 만들어낼 수 있다.
정리
Getter가 있다고 해서 무조건 Setter를 만들지 말자. 클래스가 꼭 필요한 경우가 아니라면 불변임을 보장하는 것이 설계적 관점에서 바람직하다.
모든 클래스를 불변으로 만들 수 없다. 하지만 가변 클래스더라도 변경할 수 있는 부분은 최소한으로 줄이자. (변경이 없게 만든 후 모두 final 선언을 하고, 특별한 이유가 없다면 모두 private final 선언을 하자.)
생성자는 불변식 설정이 모두 완료된 상태의 객체를 생성해야 한다. 즉, 확실한 이유가 없다면 생성자와 정적 팩터리 외에는 그 어떤 초기화 메서드도 public으로 제공해서는 안된다. 객체를 재사용할 목적으로 상태를 다시 초기화하는 메서드도 올바르지 않다.
REFERENCES
