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

📍상황

• 자바 라이브러리에는 close 메서드를 호출해 직접 닫아줘야 하는 자원이 존재함
  • ex) InputStream, OutputStream, java.sql.Connection
  • 이러한 자원 닫기는 클라이언트가 놓치기 쉬워 예측할 수 없는 성능 문제로 이어지기도 함
• 그렇다면 꼭 회수해야 하는 자원을 다룰 때는 어떻게 해야할까?

 

📍방법

1) try-finally

• 전통적으로 자원이 제대로 닫힘을 보장하는 수단

 

코드 9-1 try-finally - 더 이상 자원을 회수하는 최선의 방책이 아님

public class BadBufferedReader extends BufferedReader {
    public BadBufferedReader(Reader in, int sz) {
        super(in, sz);
    }

    public BadBufferedReader(Reader in) {
        super(in);
    }

    @Override
    public String readLine() throws IOException {
        throw new CharConversionException();
    }

    @Override
    public void close() throws IOException {
        throw new StreamCorruptedException();
    }
}

public class TopLine {

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

    public static void main(String[] args) throws IOException {
        System.out.println(firstLineOfFile("pom.xml"));
    }
}

결점

• 서버에 물리적인 문제 발생 시 readLine()과 close() 메서드에서 모두 예외가 발생할 수 있음
• 이때 두 번째 예외가 첫 번째 예외를 덮어씌워서 스택 추적 내역에 첫 번째 예외에 관한 정보는 남지 않게 되어 디버깅이 어려워짐
  • 두 번째 예외 대신 첫 번째 예외를 기록하도록 코드를 수정할 수 있지만, 코드가 너무 지저분해짐

 

코드 9-2 자원이 둘 이상이면 try-finally 방식은 너무 지저분함

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

 

2) try-with-resources (권장)

• 위에서 언급한 문제들은 자바 7의 try-with-resources 덕에 모두 해결되었음
  
  • catch 절도 함께 사용 가능함

 

• 조건
  • 해당 구조를 사용하려면 해당 자원이 AutoCloseable 인터페이스를 구현해야 함
    • 자바 라이브러리와 서드파티 라이브러리들의 수많은 클래스와 인터페이스가 이미 해당 인터페이스를 구현하거나 확장해둠
    • 닫아야 하는 자원을 뜻하는 클래스를 작성한다면 해당 인터페이스를 반드시 구현하는 것이 좋음

 

코드 9-3 try-with-resources - 자원을 회수하는 최선책!

public class TopLine {

    static String firstLineOfFile(String path) throws IOException {
        try(BufferedReader br = new BadBufferedReader(new FileReader(path))) { //try-with-resources 적용
            return br.readLine();
        }
    }

    public static void main(String[] args) throws IOException {
        System.out.println(firstLineOfFile("pom.xml"));
    }
}

개선

• readLine()과 close() 호출 모두에서 예외가 발생하면, close()에서 발생한 예외는 숨겨지고 readLine()에서 발생한 예외가 기록됨
  • 이렇게 숨겨진 예외들은 그냥 버려지지 않고, 스택 추적 내역에 suppressed 꼬리표를 달고 출력됨
  • 자바 7에서 Throwable에 추가된 getSuppressed 메서드를 이용하면 프로그램 코드에서 가져올 수 있음

 

어떻게 이렇게 동작할까?

• target 폴더 내의 클래스 파일을 보면 다음과 같음 (인텔리제이에서 컴파일된 바이트코드를 보기 쉽게 제공해줌)

//TopLine.class
public class TopLine {
    public TopLine() {
    }

    static String firstLineOfFile(String path) throws IOException {
        BufferedReader br = new BufferedReader(new FileReader(path));

        String var2;
        try {
            var2 = br.readLine();
        } catch (Throwable var5) { //1)
            try {
                br.close();
            } catch (Throwable var4) { //2)
                var5.addSuppressed(var4);
            }

            throw var5;
        }

        br.close();
        return var2;
    }

    public static void main(String[] args) throws IOException {
        String path = args[0];
        System.out.println(firstLineOfFile(path));
    }
}

• 1) readLine()에서의 예외를 catch문으로 잡음
• 2) catch문 내에서 close() 메서드를 호출하고, 해당 메서드에서의 예외를 catch문으로 잡음
  • 이때 발생한 예외는 Throwable의 addSuppressed()를 통해 추가됨

 

코드 9-4 복수의 자원을 처리하는 try-with-resources

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

 

📍핵심 정리

• 꼭 회수해야 하는 자원을 다룰 때는 try-finally 말고, try-with-resources를 사용하자
  • 코드는 더 짧고 분명해지고, 만들어지는 예외 정보도 훨씬 유용함