[Effective Java 3/E] 2장 객체 생성과 파괴

📋 목차.

2. 객체 생성과 파괴
    .아이템 1 - 생성자 대신 정적 팩터리 메서드를 고려하라.
    .아이템 2 - 생성자에 매개변수가 많다면 빌더를 고려하라.
    .아이템 3 - private 생성자나 열거 타입으로 싱글턴임을 보증하라.
    .아이템 4 - 인스턴스화를 막으려거든 private 생성자를 사용하라
    .아이템 5 - 자원을 직접 명시하지 말고 의존 객체 주입을 사용하라
    .아이템 6 - 불필요한 객체 생성을 피하라
    .아이템 7 - 다 쓴 객체 참조를 해제하라.
    .아이템 8 - finalizer와 cleaner 사용을 피하라
    .아이템 9 - try-finally 보다는 try-with-resources를 사용하라.

---

✔️ 내용.

 

2. 객체 생성과 파괴

 

 학습 내용

1. 객체를 만들어야 할 때와 만들지 말아야 할 때 구분법
2. 올바른 객체 생성방법
3. 불필요한 생성을 피하는 방법
4. 제 때 파괴됨을 보장하고 파괴 전에 수행해야 할 정리 작업을 관리하는 방법

 

 

---

.아이템 1 - 생성자 대신 정적 팩터리 메서드를 고려하라.

 

 클래스는 클라이언트에 Public 생성자 대신 정적 팩터리 메서드를 제공할 수 있다.

 

각 장점과 단점

장점	단점
이름을 가질 수 있다. 1. 의미 표현이 더 잘 된다. ex) BigInteger(int) -> BigInteger.probablePrime(int) 2. 하나의 시그니처로는 생성자를 하나만 만들 수 있는 반면 정적 팩토리 메서드에는 제약이 없다.  ex) BigInteger(int) -> BigInteger.probablePrime(int), BigInteger.probablePrime2(int), BigInteger.probablePrime3(int) 등등	상속을 하려면 public 이나 protected 생성자가 필요하니 정적 팩터리 메서드만 제공하면 하위 클래스를 만들 수 없다.  팩터리 메서드는 상속 받을 수 없다. 다르게 보면 상속보다 컴포지션을 사용(아이템 18)하도록 유도하고 불변 타입(아이템 17)으로 만들려면 이 제약을 지켜야 한다는 점에서 오히려 장점이 될 수도 있다.
호출될 때마다 인스턴스를 새로 생성하지는 않아도 된다. 1. 이로인해 불변 클래스(Immutable class; 아이템 17)은 인스턴스를 미리 만들어 놓거나 새로 생성한 인스턴스를 캐싱하여 재활용 하는식으로 불필요한 객체 생성을 하지 않는다. 따라서 같은 객체가 자주 요청되는 상황에서 성능 효과가 뛰어나다. *플라이웨이트 패턴(Flyweight pattern)도 이와 비슷한 기법이다. ex) Boolean.valueOf(boolean) public static final Boolean TRUE = new Boolean(true); public static final Boolean FALSE = new Boolean(false); public static Boolean valueOf(boolean var0) {     return var0 ? TRUE : FALSE; } 2. 반복되는 요청에 같은 객체를 반환하는 식으로 언제 어느 인스턴스를 살아 있게 할지를 철저히 통제할 수 있다.  이런 통제를 인스턴스 통제 클래스라 한다. 인스턴스를 통제 하면 싱글턴(아이템 3)으로 반들 수도, 인스턴스화 불가(아이템 4)로 만들 수 있다.    또한 불변 값 클래스(아이템 17)에서 동치인 인스턴스가 단 하나뿐 임을 보장할 수 있다.( a == b일 때만 a.equals(b) 가 성립)   인스턴스 통제는 플라이웨이트 패턴의 근간이 된다.    열거 타입(아이템 34)은 인스턴스가 하나만 만들어짐을 보장한다.	정적 팩터리 메서드는 프로그래머가 찾기 어렵다.  생성자와 같이 명확히 드러나지 않으니 사용자는 정적 팩터리 메서드 방식 클래스를 인스턴스화할 방법을 알아야 한다.   (사용 하는 메소드가 정적 팩토리인지 확인할 방법?)  따라서 정적 팩터리 메서드에 흔히 사용하는 명명 방식으로 규약을 따라 짓는다. - from : 매게 변수를 하나 받아 해당 타입의 인스턴스를 반환하는 형 변환 메서드 Date d = Date.from(Instant.now()); - of: 여러 매개변수를 받아 적합한 타입의 인스턴스를 반환하는 집계 메서드 Set<Rank> faceCards = EnumSet.of(JACK, QUEEN, KING);  - valueOf: from 과 of의 더 자세한 버전 BigInteger prime = BigInteger.valueOf(Integer.MAX_VALUE);  - instance 혹은 getInstance: 매개변수로 명시한 인스턴스를 반환하지만, 같은 인스터임을 보장하지는 않는다. StackWalker luke = StackWalker.getInstance(options);  - create 혹은 newInstance : instance 혹은 getInstance와 같지만, 매번 새로운 인스턴스를 생성해 반환함을 보장한다. Object newArray = Array.newInstance(classObject, arrayLen);  - getType : getInstance와 같으나, 생성할 클래스가 아닌 다른 클래스에 팩터리 메서드를 정의할 때 쓴다. "Type"은 팩터리 메서드가 반환할 객체의 타입이다. FileStore fs = Files.getFileStore(path);  - newType: newInstance와 같으나, 생성할 클래스가 아닌 다른 클래스에 팩터리 메서드를 정의할 때 쓴다. "Type"은 팩터리 메서드가 반환할 객체의 타입이다. BufferedReader br = Files.newBufferedReader(path);  - type: getType과 newType의 간결한 버전 List<Complaint> litany = Collections.list(legacyLitany);
반환 타입의 하위 타입 객체를 반환할 수 있는 능력이 있다. 1. 구현 클래스를 공개하지 않고도 객체 반환을 할 수 있어 API를 작게 유지할 수 있다. 이는 인터페이스를 정적 팩터리 메서드의 반환 타입으로 사용하는 인터페이스 기반 프레임워크(아이템 20)를 만드는 핵심 기술이기도 하다.
입력 매개변수에 따라 매번 다른 클래스의 객체를 반환할 수 있다.  반환 타입의 하위 타입이기만 하면 어떤 클래스의 객체를 반환하든 상관 없다.  가령 EnumSet 클래스(아이템 36)는 public 생성자 없이 오직 정적 팩터리만 제공하는데 원소의 수에 따라 두가지 하위 클래스 중 하나의 인스턴스를 반환한다. 원소가 64개 이하면 long 변수 하나로 관리하는 RegularEnumSet의 인스턴스를, 65개 이상이면 long 배열로 관리하는 JumboEnumSet의 인스턴스를 반환한다. public static <E extends Enum<E>> EnumSet<E> noneOf(Class<E> var0) {     Enum[] var1 = getUniverse(var0);     if (var1 == null) {         throw new ClassCastException(var0 + " not an enum");     } else {         return (EnumSet)(var1.length <= 64 ? new RegularEnumSet(var0, var1) : new JumboEnumSet(var0, var1));     } }  클라이언트는 위의 두 클래스의 존재를 모른다. 알필요도 없다. EnumSet의 하위 클래스이기만 하면 되는 것이다.
정적 팩터리 메서드를 작성하는 시점에는 반환할 객체의 클래스가 존재하지 않아도 된다. 대표적으로 JDBC 드라이버 클래스를 로드하기 위해 Class.forName()을 사용한다. 클래스 이름을 문자열로 받아 반환 타입으로 Class 객체를 받을 수 있다. 이를 통해 클라이언트는 JDBC 드라이버 클래스를 변경할 필요 없이 Class.forName()메서드를 사용하여 로드할 수 있다. try {     Class<?> testClass = Class.forName("test"); } catch (ClassNotFoundException e) {     throw new RuntimeException(e); } ex) class LoggerFactory {     private LoggerFactory() {     // private constructor     }     public static Logger getLogger(Class clazz) {     // implementation     }     public static Logger getLogger(String name) {     // implementation     } } public class Main {     private static final Logger logger = LoggerFactory.getLogger(Main.class);     public static void main(String[] args) {         logger.info("Hello, world!");     } }  LoggerFactory는 정적 팩터리 메서드를 사용하여 logger 객체를 생성한다. 클래스의 이름이나 문자열 이름을 사용하여 생성 할 수 있다.

 

핵심 정리

 정적 팩터리 메서드와 public 생성자는 각자의 쓰임새가 있으니 상대적인 장단점을 이해하고 사용하는 것이 좋다.  그렇다고 하더라도 정적 팩터리를 사용하는 게 유리한 경우가 더 많으므로 무작적 public 생성자를 제공하던 습관이 있다면 고치자

---

 

.아이템 2 - 생성자에 매개변수가 많다면 빌더를 고려하라.

 

 매개변수가 많을 때 활용하는 방식은 다음과 같았다.

 

- 점층적 생성자 패턴

    public NutritionFacts(int servingSize, int servings) {
        this(servingSize, servings, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories) {
        this(servingSize, servings, calories, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories, int fat) {
        this(servingSize, servings, calories, fat, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium) {
        this(servingSize, servings, calories, fat, sodium, 0);
    }

NutritionFacts nutritionFacts = new NutritionFacts(1, 2, 3, 4, 5, 6);

 

 점층적 생성자 패턴은 매개변수 개수가 많아지면 클라이언트 코드를 작성하거나 읽기 어렵다. 

 

- 자바빈즈 패턴

    public void setServingSize(int servingSize) {
        this.servingSize = servingSize;
    }

    public void setServings(int servings) {
        this.servings = servings;
    }
    public void setCalories(int calories) {
        this.calories = calories;
    }
    public void setFat(int fat) {
        this.fat = fat;
    }

    public void setSodium(int sodium) {
        this.sodium = sodium;
    }

    public void setCarbohydrate(int carbohydrate) {
        this.carbohydrate = carbohydrate;
    }

NutritionFacts nutritionFacts2 = new NutritionFacts();
nutritionFacts2.setServingSize(1);
nutritionFacts2.setServings(2);
nutritionFacts2.setCalories(3);
nutritionFacts2.setFat(4);
nutritionFacts2.setSodium(5);
nutritionFacts2.setCarbohydrate(6);

 

자바 빈즈 패턴은 객체 하나를 만들기 위해 여러 메서드를 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성이 무너진 상태에 놓인다.

 

- 빌더 패턴

 점층적 생정자 패턴의 안전성과 자바빈즈 패턴의 가독성을 겸비한 패턴.

 

 

빌더는 생성할 클래스 안에 정적 멤버 클래스로 만들어 두는 게 보통이다.

 

public static class Builder {
// 필수 매개변수
    
    private final int servingSize; // (mL, 1회 제공량) 필수
    private final int servings; // (회, 총 n회 제공량) 필수

// 선택 매개변수 - 기본값으로 초기화한다.
    private int calories = 0; // (1회 제공량당) 선택
    private int fat = 0; // (g/1회 제공량) 선택
    private int sodium = 0; // (mg/1회 제공량) 선택
    private int carbohydrate = 0;// (g/1회 제공량) 선택
    
public Builder(int servingSize, int servings) {
    this.servingSize = servingSize;
    this.servings = servings;
}

public Builder calories(int val) {
    calories = val;
    return this;
}

public Builder fat(int val) {
    fat = val;
    return this;
}

public Builder sodium(int val) {
    sodium = val;
    return this;
}

public Builder carbohydrate(int val) {
    carbohydrate = val;
    return this;
}

public NutritionFacts build() {
    return new NutritionFacts(this);
}
}

NutritionFacts nutritionFacts3 = new NutritionFacts.Builder(1, 2)
.calories(3)
.fat(4)
.sodium(5)
.carbohydrate(6)
.build();

 

NutritionFacts 클래스는 불변이며, 모든 매개변수의 기본값들을 한 곳에 모아 두었다. 빌더의 세터 메서들은 자기 자신을 반환하기 때문에 연쇄적으로 호출이 가능하다 (메서드 체이닝)

 

빌더 패턴은 (파이썬, 스칼라에 있는) 명명된 선택적 매개변수를 흉내 낸 것이다.

 

빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기 좋다.

 

핵심 정리

 생성자나 정적 팩터리가 처리해야 할 매개변수가 많다면 빌더 패턴을 선택하는 게 더 낫다.
매개 변수 중 다수가 필수가 아니거나 같은 타입이면 특히 더 그렇다. 빌더는 점층적 생성자보다 클라이언트 코드를 읽고 쓰기가 훨씬 간결하고, 자바빈즈보다 훨씬 안전하다.

 

---

 

.아이템 3 - private 생성자나 열거 타입으로 싱글턴임을 보증하라.

 

 싱글턴이란 인스턴스를 오직 하나만 생성할 수 있는 클래스이다.

전형적인 예로 함수(아이템 24)와 같은 무상태(stateless) 객체나 설계상 유일해야 하는 시스템 컴포넌트를 들 수 있다.

그런데 클래스를 싱글턴으로 만들 경우 이를 사용하는 클라이언트를 테스트하기가 어렵다.  타입을 인터페이스로 정의한 다음 인터페이스를 구현해서 만든 싱글턴이 아니라면 싱글턴 인스턴스를 가짜(Mock) 구현으로 대체할 수 없기 때문이다.

 

 싱글턴을 만드는 방식은 보통 두 가지로 나뉜다. 

두 방식 모두 생성자는 private로 감춰두고, 유일한 인스턴스에 접근할 수 있는 수단으로 public static 멤버를 하나 마련해 둔다.

 

 - public static 멤버 final 필드인 방식

public class Elvis {
public static final Elvis INSTANCE = new Elvis();

private Elvis() {
}

public void leaveTheBuilding() {
    System.out.println("Elvis has left the building.");
}
}

private 생성자는 Elvis.INSTANCE를 초기화할 때 단 한 번만 호출된다.

public, protected 생성자가 없으므로 전체 시스템에서 하나뿐임을 보장한다.

클라이언트가 손쓸 방법은 리플렉션 API(아이템 65)인 AccessibleObject.setAccessible을 사용해 호출하는 방법이다.

이러한 리플렉션 공격을 방어하려면 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던지게 하면 된다.

 

 - 장점

 

1. 해당 클래스가 싱글턴임이 명백히 드러난다.

2. 간결함

 

 - 정적 팩터리 방식의 싱글턴

 

private static final Elvis INSTANCE2 = new Elvis();

public static Elvis getInstance() {
    return INSTANCE2;
}

public void leaveTheBuilding2() {
    System.out.println("Elvis has left the building.");
}

Elvis.getInstance는 항상 같은 객체의 참조를 반환하므로 제2의 Elvis 인스턴스는 결코 만들어지지 않는다. (앞선 방식과 같이 리플렉션 예외는 똑같이 적용)

 

- 장점

1. API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다. - 스레드 별로 다른 인스턴스 반환 가능

2. 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다 (아이템 30)

3. 정적 팩터리의 메서드 참조를 공급자(supplier)로 사용할 수 있다. - Elvis::getInstance -> Supplier<Elvis> (아이템 43, 44)

 

 둘 중 하나의 방식으로 만든 싱글턴 클래스를 직렬화하려면(12장 참조) 단순히 Serializable을 구현한다고 선언하는 것만으로 부족하다.

 모든 인스턴스 필드를 일시적(transient)이라고 선언하고 readResolve 메서드를 제공해야 한다(아이템 89) 이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다. 

 가짜 Elvis 탄생을 예방하고 싶다면 Elvis 클래스에 다음의 readResolve 메서드를 추가하자.

private Object readResolve() {
// '진짜' Elvis를 반환하고, 가짜 Elvis는 가비지 컬렉터에 맡긴다.
    return INSTANCE;
}

 

 - 열거 타입 방식의 싱글턴 - 바람직한 방법

 

 public 필드 방식과 비슷하지만, 더 간결하고 추가 노력 없이 직렬화할 수 있고, 심지어 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 완벽히 막아준다.

 대부분의 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다.

단, 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다.(열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다.).

 

---

 

.아이템 4 - 인스턴스화를 막으려거든 private 생성자를 사용하라

 

 이따금 단순히 정적 메서드와 정적 필드만을 담은 클래스를 만들고 싶을 때이다.

1. java.lang.Math 와 java.util.Arrays처럼 기본 타입 값이나 배열 관련 메서드들을 모아놓을 수 있다.

2. java.util.Collections처럼 특정 인터페이스를 구현하는 객체를 생성해 주는 정적 메서드(혹은 팩터리)를 모아 놓을 수 있다.

3. final 클래스와 관련한 메서들을 모아 놓을 때 사용한다. final 클래스를 상속해서 하위 클래스에 메서드를 넣는 건 불가능하기 때문이다.

 

 위 와 같이 정적 멤버만 담은 유틸 클래스는 인스턴스로 만들어 사용하고자 한 게 아니다. 하지만 생성자를 명시하지 않으면 컴파일러가 자동으로 public 기본 생성자를 만들어준다.

 

 추상 클래스로 만드는 것으로는 인스턴스화를 막을 수 없다. 하위 클래스를 만들어 인스턴스화하면 그만이다. 다른 사용자가 상속해서 사용하라는 뜻으로 오해할 수 있으니 큰 문제다(아이템 19).

 

 때문에 private으로 생성자를 추가하면 컴파일러가 public 기본 생성자를 만들지 않아 클래스의 인스턴스화를 막을 수 있다.

 

---

 

.아이템 5 - 자원을 직접 명시하지 말고 의존 객체 주입을 사용하라

 

 많은 클래스가 하나 이상의 자원에 의존한다. 가령 맞춤법 검사기는 사전(dictionary)에 의존하는데, 이런 클래스를 정적 유틸리티 클래스(아이템 4)로 구현한 모습을 드물지 않게 볼 수 있다.

 

 대신 클래스(SpellChecker)가 여러 자원 인스턴스를 지원해야 하며, 클라이언트가 원하는 자원(dictionary)을 사용해야 한다.

 

 이를 만족하는 간단한 조건은 인스턴스를 생성할 때 생성자에 필요한 자원을 넘겨준다. 이는 의존 객체 주입의 한 형태이다.

 

public class SpellChecker {
private final Lexicon dictionary;

public SpellChecker(Lexicon dictionary) { // 의존 객체 주입
    this.dictionary = Objects.requireNonNull(dictionary);  
}

public boolean isValid(String word){
    return true;
}

public static List<String> suggestions(String typo){
    return new ArrayList<>();
}
}

 

핵심 정리

 클래스가 내부적으로 하나 이상의 자원에 의존하고, 그 자원이 클래스 동작에 영향을 준다면 싱글턴과 정적 유틸리티 클래스는 사용하지 않는 것이 좋다. 이 자원들을 클래스가 직접 만들게 해서도 안 된다. 
 대신 필요한 자원을 생성자에 넘겨주자. 의존 객체 주입이라 하는 이 기법은 클래스의 유연성, 재사용성, 테스트 용이성을 개선해 준다.

---

 

.아이템 6 - 불필요한 객체 생성을 피하라

 

 똑같은 기능의 객체를 매번 생성하기보다는 객체 하나를 재사용하는 편이 나을 때가 많다. 재사용은 빠르고 세련되다.

특히 불변 객체(아이템 17)는 언제든 재사용할 수 있다.

 

 

static boolean isRomanNumeral(String s){
    return s.matches("^(?=.)M*(C[MD]|D?C{0,3})" + "(X[CL]|L?X{0,3})(I[XV]|V?I{0,3})$");
}

 위 방식은 String.matches로 정규표현식을 활용한 메서드이다. 

문제점으로는 String.matches는 정규표현식으로 문자열 형태를 확인하는 가장 쉬운 방법이지만, 성능이 중요한 상황에서 반복해 사용하기엔 적합하지 않다. 

 이 메서드가 내부에서 만드는 정규표현식용 Pattern 인스턴스는, 한 번 쓰고 버려져서 곧바로 가비지 컬렉션 대상이 된다.

Pattern은 입력받은 정규표현식에 해당하는 유한 상태 머신을 만들기 때문에 인스턴스 생성 비용이 높다.

 

public boolean matches(String var1) {
    return Pattern.matches(var1, this);
}

---

public static boolean matches(String var0, CharSequence var1) {
    Pattern var2 = compile(var0);
    Matcher var3 = var2.matcher(var1);
    return var3.matches();
}

---

public static Pattern compile(String var0) {
    return new Pattern(var0, 0);
}

 

따라서 성능 개선을 위해 필요한 정규표현식을 표현하는 Pattern 인스턴스를 클래스 초기화 과정에서 직접 생성해 캐싱해 두고, 나중에 isRomanNumeral 메서드가 호출될 때마다 이 인스턴스를 재사용한다.

 

public class RomanNumerals {
private static final Pattern ROMAN = Pattern.compile(
"^(?=.)M*(C[MD]|D?C{0,3})" +
"(X[CL]|L?X{0,3})(I[XV]|V?I{0,3})$"
);

/* String.matches */
static boolean isRomanNumeral(String s){
    return ROMAN.matcher(s).matches();
}
}

 

 만일 개선된 isRomanNumberal 방식의 클래스가 초기화 후 한 번도 호출되지 않는다면 불필요한 초기화가 된 꼴이다.

이를 위해 지연 초기화(아이템 83)로 없앨 수는 있지만 , 권하지는 않는다. 

 지연 초기화는 코드를 복잡하게 만드는데, 성능은 크게 개선되지 않을 때가 많기 때문이다.(아이템 67)

 

  불필요한 객체를 만들어내는 또 다른 예로 오토박싱을 들 수 있다.

오토 박싱은 기본 타입과 그에 대응하는 박싱 된 기본 타입의 구분을 흐려주지만, 완전히 없애주는 것은 아니다.

 

 

static long sum(){
    Long sum = 0L;
    for (long i = 0; i < Integer.MAX_VALUE; i++) {
        sum += i;
    }
    return sum;
}

 

 위의 코드는 sum 변수를 long 이 아닌 Long으로 선언해서 불필요한 인스턴스가 Integer.Max_Value 개수만큼 만들어진다.

단순히 sum 타입을 long으로만 바꿔주면 빨라진다.

 

 박싱된 기본 타입보다는 기본타입을 사용하고, 의도치 않은 오토박싱이 숨어들지 않도록 주의하자.

 

 이번 아이템은 방어적 복사(아이템 50)와 대조적이다.

이번 아이템이 '기존 객체를 재사용해야 한다면 새로운 객체를 만들지 마라' 라면, 방어적 복사(아이템 50)는 '새로운 객체를 만들어야 한다면 기존 객체를 재사용하지 마라'다.

 방어적 복사가 필요한 상황에서 객체를 재사용했을 때의 피해가, 필요 없는 객체를 반복 생성했을 때의 피해보다 훨씬 크다는 사실을 기억하자.

 방어적 복사에 실패하면 버그와 보안 구멍이 생기지만, 불필요한 객체 생성은 그저 코드형태와 성능에 영향을 준다.

---

 

.아이템 7 - 다 쓴 객체 참조를 해제하라.

 

public class Stack {
private Object[] elements;
private int size = 0;
private static final int DEFAULT_INITIAL_CAPACITY = 16;

public Stack() {
this.elements = new Object[DEFAULT_INITIAL_CAPACITY];
}

public void push(Object e){
ensureCapacity();
elements[size++] = e;
}

public Object pop(){
if(size == 0)
throw new EmptyStackException();
Object result = elements[--size];
return result;
}

/**
* 원소를 위한 공간을 적어도 하나 이상 확보한다.
* 배열 크기를 늘려야 할 때마다 대략 두 배씩 늘린다.
*/
private void ensureCapacity() {
if (elements.length == size)
elements = java.util.Arrays.copyOf(elements, 2 * size + 1);
}
}

 스택을 예시로 보면 이 코드에서는 스택이 커졌다가 줄어들었을 때 스택에서 꺼내진 객체들을 가비지 컬렉터가 회수하지 않는다.

 프로그램에서 그 객체들을 더 이상 사용하지 않더라도 말이다. 이 스택이 그 객체들의 다 쓴 참조(obsolete reference)를 여전히 가지고 있기 때문이다. 여기서 다 쓴 참조란. 문자 그대로 앞으로 다시 쓰지 않을 참조를 뜻한다.

 앞의 코드에서는 elements 배열의 '활성 영역' 밖의 참조들이 모두 여기에 해당한다. 활성 영역은 인덱스가 size보다 작은 원소들로 구성된다.

 

 해법은 간단하다. 해당 참조를 다 썼을 때 Null 처리(참조 해제)하면 된다.

위의 코드에서는 원소의 참조가 더 이상 필요 없어지는 시점은 스택에서 꺼내지는 pop() 메서드에서 이다.

다음과 같이 null로 참조해제 하면 된다.

public Object pop(){
if(size == 0)
throw new EmptyStackException();
Object result = elements[--size];
elements[size] = null; // 다 쓴 참조 해제
return result;
}

 

 하지만 객체 참조를 null 처리하는 일은 예외적인 경우여야 한다. 다 쓴 참조를 해제하는 가장 좋은 방법은 그 참조를 담은 변수를 유효 범위(scope) 밖으로 밀어내는 것이다. 변수의 범위를 최소가 되게 정의했다면(아이템 57) 이 일은 자연스럽게 이뤄진다.

 

그렇다면 null 처리는 언제 해야 할까? Stack 클래스는 왜 메모리 누수에 취약할 걸까?

바로 스택이 자기 메모리를 직접 관리하기 때문이다. 이 스택은 elements 배열로 저장소 풀을 만들어 원소들을 관리한다. 배열의 활성 영역에 속한 원소들이 사용되고 비활성 영역은 쓰이지 않는다. 문제는 GC는 이 사실을 알 길이 없다는 데 있다. GC가 보기에는 비활성 영역에서 참조하는 객체도 똑같이 유효한 객체다. 그러므로 프로그래머는 비활성 영역이 되는 순간 null 처리해서 해당 객체를 더는 쓰지 않을 것임을 GC에 알려야 한다.

 

 일반적으로 자기 메모리를 직접 관리하는 클래스라면 프로그래머는 항시 메모리 누수에 주의해야 한다. 원소를 다 사용한 즉시 원소가 참조한 객체들을 다 null 처리해줘야 한다.

 

 캐시 역시 메모리 누수를 일으키는 주범이다. 운 좋게 캐시 외부에서 키(key)를 참조하는 동안만 엔트리가 살아 있는 캐시가 필요한 상황이라면 WeakHashMap을 사용해 캐시를 만들자. 다 쓴 엔트리는 그 즉시 자동으로 제거될 것이다.

단, WeakHashMap은 이러한 상황에서만 유용하다는 것을 기억해야 한다.

 

 캐시를 만들 때 보통은 캐시 엔트리의 유효 기간을 정확히 정의하기 어렵기 때문에 시간이 지날수록 엔트리의 가치를 떨어뜨리는 방식을 흔히 사용한다. 이런 방식에서는 쓰지 않는 엔트리를 이따금 청소해줘야 한다. (Scheduled ThreadPoolExecutor 같은) 백그라운드 스레드를 활 요하거나 캐시에 새 엔트리를 추가할 때 부수 작업으로 수행하는 방법이 있다.

 LinkedHashMap은 removeEldestEntry 메서드를 써서 후자의 방식으로 처리한다. 더 복잡한 캐시를 만들고 싶다면 java.lang.ref 패키지를 직접 활용해야 할 것이다.

 

 메모리 누수의 세 번째 주범은 바로 리스너 혹은 콜백이라 부르는 것이다. 

클라이언트가 콜백을 등록만 하고 명확히 해치 하지 않는다면, 뭔가 조치해주지 않는 한 콜백은 계속 쌓여갈 것이다. 이럴 때 콜백을 약한 참조(weak reference)로 저장하면 가비지 컬렉터가 즉시 수거해 간다. 예로 WeakHashMap에 킬로 저장하면 된다.

* WeakReference : 약한 참조 공부하기

핵심 정리

 메모리 누수는 겉으로 잘 드러나지 않아 시스템에 수년간 잠복하는 사례도 있다. 이런 누수는 철저한 코드 리뷰나 힙 프로파일러 같은 디버깅 도구를 동원해야만 발견되기도 한다. 그래야 이런 종류의 문제는 예방법을 익혀두는 것이 매우 중요하다.

 

---

 

. 아이템 8 - finalizer와 cleaner 사용을 피하라

 

 자바는 두 가지 객체 소멸자를 제공한다. 그중 finalizer는 예측할 수 없고, 상황에 따라 위험할 수 있어 일반적으로 불필요하다. 오동작, 낮은 성능 이식성 문제의 원인이 되기도 한다.  이번 장에서 몇 가지 쓰임새를 소개하지만 기본적으로 '쓰지 말아야' 한다. 그래서 자바 9에서는 finalizer를 사용 자제(deprecated) API로 지정하고 cleaner를  그 대안으로 소개했다.

 cleaner는 finalizer보다는 덜 위험하지만, 여전히 예측할 수 없고, 느리고, 일반적으로 불 필요하다. 

 

 finalizer와 cleaner는 즉시 수행된다는 보장이 없다. 객체에 접근할 수 없게 된 후 finalizer나 cleaner가 실행되기까지 얼마나 걸릴지 알 수 없다. 즉, finalizer와 cleaner로는 제때 실행되어야 하는 작업은 절대 할 수 없다.

예컨대 파일 닫기를 finalizer나 cleaner에 맡기면 중대한 오류를 일으킬 수 있다. 시스템이 동시에 열 수 있는 파일 개수에 한계가 있기 때문이다.

 

 finalizer와 cleaner를 얼마나 신속히 수행할지는 전적으로 가비지 컬렉터 알고리즘에 달려있다.

 

 자바 언어 명세는 finalizer 나 cleaner의 수행 시점뿐 아니라 수행 여부조차 보장하지 않는다.

접근할 수 없는 일부 객체에 딸린 종료 작업을 전혀 수행하지 못한 채 프로그램이 중단될 수도 있다는 얘기다 따라서 프로그램 생애 주기와 상관없는, 상태를 영구적으로 수정하는 작업에서는 절대 finlizer나 cleaner에 의존해서는 안 된다.

 예로 DB 같은 공유 자원의 영구 락 해제를 finalizer나 cleaner에 맡겨 놓으면 분산 시스템 전체가 서서히 멈추게 될 것이다.

 

 finalizer는 사용한 객체를 생성하고 파괴하니 GC의 효율을 떨어뜨린다. 

 

 finalizer를 사용한 클래스는 finalizer 공격에 노출되어 심각한 보안 문제를 일으킬 수 있다. 공격 원리는 생성자나 직렬화 과정에서 예외가 발생하면, 이 생성되다 만 객체에서 악의적인 하위 클래스의 finalizer가 수행될 수 있게 된다. 객체의 생성을 막으려면 생성자에서 예외를 던지는 것만으로 충분하지만, finalizer가 있다면 그렇지도 않다.

 final이 아닌 클래스를 finalizer 공격으로부터 방어하려면  아무 일도 하지 않는 finalize 메서드를 만들고 final로 선언해 하위 클래스를 만들 수 없게 하자.

 

 

 

 finalizer나 cleaner 대안으로는 AutoCloseable을 구현해 주고, 클라이언트에서 인스턴스를 다 쓰고 나면 close 메서드를 호출하면 된다. (아이템 9 참조).

 

 finalizer와 cleaner의 쓰임새는 어디일까?

 

1. 자원의 소유자가 close 메서드를 호출하지 않은 것에 대한 안전망 역할.

 - finalizer와 cleaner가 즉시 호출 되리라는 보장은 없지만, 클라이언트가 하지 않은 자원 회수를 늦게나마 해주는 것이 아예 하지 않는 것보다 낫다.

 

2. 네이티브 피어 연결 객체 회수

 - 네이티브 피어(Native peer)란 일반 자바 객체가 네이티브 메서드를 통해 기능을 위임한 네이티브 객체를 말한다. 네이티브 피어는 자바 객체가 아니니 GC는 그 존재를 알지 못한다. 따라서 finalizer나 cleaner 가 처리하기에 적당한 작업이다.

단, 성능 저하를 감당할 수 없거나, 네이티브 피어가 사용하는 자원을 즉시 회수 해야 한다면 close를 사용해야 한다.

 

 cleaner 사용 예

Room 클래스로 방(room) 자원을 수거하기 전에 반드시 청소(clean) 해야 한다. 

import java.lang.ref.Cleaner;

public class Room implements AutoCloseable {

private static final Cleaner cleaner = Cleaner.create();

// 청소가 필요한 자원. 절대 Room을 참조해서는 안 된다!
private static class State implements Runnable{

int numJunkPiles; // Room 안의 쓰레기 수

State(int numJunkPiles){
    this.numJunkPiles = numJunkPiles;
}

// close 메서드나 cleaner가 호출한다.
@Override
public void run() {
    System.out.println("Cleaning Room");
    numJunkPiles = 0;
}
}

private final State state;

private final Cleaner.Cleanable cleanable;

public Room(int numJunkPiles){
    state = new State(numJunkPiles);
    cleanable = cleaner.register(this, state);
}

@Override
public void close() throws Exception {
cleanable.clean();
}
}

 

 run() 메서드가 호출되는 상황은 둘 중 하나이다.

보통은  Room의 close 메서드를 호출할 때다. close 메서드에서 Cleanable의 clean을 호출하면 이 메서드 안에서 run을 호출한다.

 혹은 GC가 Room을 회수할 때까지 클라이언트가 close를 호출하지 않는다면, cleaner가 State의 run 메서드를 호출해 줄 것이다.

 State 인스턴스는 '절대로' Room 인스턴스를 참조해서는 안 된다.

Room 인스턴스를 참조할 경우 순환참조가 생겨 GC가 Room 인스턴수를 회수 해갈 기회가 오지 않는다.

State가 정적 중첩 클래스인 이유가 있다. 정적 이아닌 중첩 클래스는 자동으로 바깥 객체의 참조를 갖게 되기 때문이다(아이템 24)

 

 앞서 이야기한 대로 Room의 cleaner는 단지 안정망이다. 클라이언트가 모든 Room 생성을 try-with-resources 블록으로 감쌌다면 자동 청소는 전혀 필요하지 않다.

 

 좋은 예

public static void main(String[] args) throws Exception {
// try-with-resources를 사용해 예외를 회피한다.
    try(Room room = new Room(7)){
        System.out.println("안녕");
    }
}

 좋지 않은 예

public static void main(String[] args) {
// try-with-resources를 사용하지 않아 방청소를 출력되리라 기대할 수 없다.
// Room 생성자에서 Cleaner의 register 메서드를 호출하면서 Room을 참조하므로 Room은 Cleaner가 수거할 때까지 회수되지 않는다.
// 따라서 Room의 close 메서드는 호출되지 않고, Room에 담긴 쓰레기 수도 0으로 초기화되지 않는다.
// 이 프로그램은 "Peace out"을 출력하고 종료된다.
// 이런 상황을 방지하려면 Room을 try-with-resources 블록 바깥에서 초기화해야 한다.
// try-with-resources 블록 바깥에서 초기화하면 Room이 영원히 열려있지 않게 된다.
    Room room = new Room(99);
    System.out.println("Peace out");
}

  - System.exit을 호출할  때의 cleaner 동작은 구현하기 나름이다. 청소가 이뤄질지는 보장하지 않는다.

 

핵심 정리

 cleaner(자바 8까지는 finalizer)는 안전망 역할이니 중요하지 않은 네이티브 자원 회수용으로만 사용하자. 물론 이런 경우라도 불확실성과 성능 저하에 주의해야 한다.

---

 

.아이템 9 - try-finally 보다는 try-with-resources를 사용하라.

 

 java 라이브러리에는 close 메서드를 호출해 직접 닫아줘야 하는 자원이 많다. Stream, Connection 등이 있다.

 

전통적으로 자원이 제대로 닫힘을 보장하는 수단인 try-finally

 

static String firstLineOfFile(String path) throws Exception {
    BufferedReader br = new BufferedReader(new java.io.FileReader(path));
    try {
        return br.readLine();
    } finally {
        br.close();
    }
}

자원을 하나 더 썼을 경우?

static void copy(String src, String dst) throws Exception {
    InputStream in = new FileInputStream(src);
    try {
        OutputStream out = new FileOutputStream(dst);
        try {
            byte[] buf = new byte[100];
            int n;
        while((n = in.read(buf)) >= 0)
        out.write(buf, 0, n);
        } finally {
            out.close(); 
        }
    } finally {
    in.close();
    }
}

 try-finally 문을 제대로 사용한 앞의 두 코드 예제에조차 미묘한 결점이 있다.

예외는 tryh 블록과 finally 블록 모두에서 발생할 수 있다. 예로 기기에 물리적 문제가 생길 경우 firstLineOfFile 메서드 안의 readLine 메서드가 예외를 던지고, 같은 이유로 close 메서드도 실패할 것이다. 이런 상황이라면 두 번째 예외가 첫 번째 예외를 완전히 집어삼키게 된다. 이로인 헤 실제 오류 파악이 힘들게 되고 디버깅을 몹시 어렵게 한다.

 

 이러한 문제들은 자바 7에서 try-with-resources 덕에 모두 해결되었다.

이 구조를 사용하려면 해당 자원이 AutoCloseable 인터페이스를 구현해야 한다. 단순히 void를 반환하는 close 메서드 하나만 덩그러니 정의한 인터페이스다. 자바 라이브러리와 서드파티 라이브러리들의 수많은 클래스와 인터페이스가 이미 AutoCloseable을 구현하거나 확장해 뒀다. 만일 닫아야 하는 자원을 뜻하는 클래스를 작성한다면 AutoCloseable을 반드시 구현하기 바란다.

 

 위의 두 메서드를 try-with-resources를 적용한 모습이다.

static String firstLineOfFile(String path) throws Exception {
    try (BufferedReader br = new BufferedReader(new FileReader(path))) {
         return br.readLine();
    }
}

static void copy(String src, String dst) throws Exception {
    try (InputStream in = new FileInputStream(src);
        OutputStream out = new FileOutputStream(dst)) {
        byte[] buf = new byte[100];
        int n;
        while ((n = in.read(buf)) >= 0)
        out.write(buf, 0, n);
    }
}

 

 수정 버전이 읽기 수월할 뿐 아니라. 문제 진단에도 훨씬 좋다.

readLine과 close 호출 양쪽에서 예외 발생하게 될 경우, close에서 발생한 예외는 숨겨지고 readLine에서 발생한 예외가 기록된다. 이렇게 숨겨진 예외들도 그냥 버려지지는 않고, 스택 추적 내역에 '숨겨졌다(suppressed)'라는 꼬리표를 달고 출력된다. 또한 Java 7에서 Throwable에 추가되니 getSuppressed 메서드를 이용하면 프로그램 코드에서 가져올 수도 있다.

 

 보통의 try-finally처럼 try-with-resoureces에서도 catch 절이 사용 가능하다.

 

static String firstLineOfFile(String path) {
        try (BufferedReader br = new BufferedReader(new FileReader(path))) {
              return br.readLine();
        } catch (IOException e) {
              return "Error";
       }
}

 

핵심 정리

 꼭 회수해야 하는 자원을 다룰 때는 try-finally 말고, try-with-resources를 사용하자.
예외는 없다. 코드는 더 짧고 분명해지고, 만들어지는 예외 정보도 훨씬 유용하다. try-finally로 작성하면 실용적이지 못할 만큼 코드가 지저분해지는 경우라도, try-with-resources로는 정확하고 쉽게 자원을 회수할 수 있다.

 

---

Gihub Code - https://github.com/younwony/effectiveJava/tree/master/src/main/java/dev/wony/effectivejava/chapter_1

📝 느낀점.

생각보다 몰랐던 부분들이 많아서 부족한 부분을 많이 채운 느낌이었다.