[이펙티브 자바] Item9. try-finally 보다는 try-with-resources 를 사용하라.

 

item09. try-finally 보다는 try-with-resources를 사용하라. 

 

https://hyejin.tistory.com/1011

[이펙티브 자바] Item8. finalizer와 cleaner 사용을 피하라.

 

여기서 내용이 추가된? 느낌으로 Item09. 에서도 try-with-resources 사용을 권장하고 있다. (권장보다는 사용하라고 하고 있다.) 

 

 

자바에서는 close 메서드를 호출해서 직접 닫아줘야하는 자원이 InputStream, OutputStream, Connection 등이 있다. 

자원 닫기는 클라이언트가 놓치기 쉬운 부분이기 때문에 예측할 수 없는 성능 문제로 이어지기도 한다.. 

예전에는 자원이 제대로 닫힘을 보장하는 수단으로 try-finally가 많이 쓰였는데 자바7이상부터는 더이상 try-finally가 최선의 방법이 아니다. 

 

public class TopLine {
    // try-finally: 더 이상 자원을 회수하는 최선의 방책이 아니다!!
    static String firstLineOfFile(String path) throws IOException {
        BufferedReader br = new BufferedReader(new FileReader(path));
        try {
            return br.readLine();
        }finally {
            br.close();
        }
    }

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

이렇게 예전에는 자원이 제대로 닫힘을 보장하는 수단으로 많이 썼었는데 이 코드가 틀렸다는 것은 아니지만 

만약에 자원을 한개가 아닌 두개 이상을 사용한다면 ? 

 

package chapter01.item09.tryfinally;

import java.io.*;

/**
 * item09. try-finally보다 try-with-resources를 사용하라.
 */
public class Copy {

    private static final int BUFFER_SIZE = 8 * 1024;

    // 자원이 둘 이상이면 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();
        }
    }

    public static void main(String[] args) throws IOException {
        String src = args[0];
        String dst = args[1];
        copy(src, dst);
    }
}

-> 자원이 두개 이상이 되니까 try-finally 방식은 코드가 굉장히 지저분해진다. 

 

 

public class TopLine {
    // try-with-resources 이 자원을 회수하는 최선책이다.
    static String firstLineOfFile(String path) throws IOException {
        try (BufferedReader br = new BufferedReader(new FileReader(path))){
            return br.readLine();
        }
    }

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

package chapter01.item09.trywithresources;

import java.io.*;

/**
 * item09: try-finally 보다는 try-with-resources 를 사용하라.
 */
public class Copy {
    private static final int BUFFER_SIZE = 8 * 1024;

    // 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);
            }
        }
    }

    public static void main(String[] args) throws IOException {
        String src = args[0];
        String dst = args[1];
        copy(src, dst);
    }
}

 

그에 비해 try-with-resources를 사용하면 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();
    }
}

우선 이렇게 BufferedReader를 상속받고, readLine 메서드를 사용하면 CharconversionException이 던져지고, close 메서드를 호출하면 StreamCorruptedException이 던져진다고 한다. 

 

public class TopLine {
    static String firstLineOfFile(String path) throws IOException {
        BufferedReader br = new BadBufferedReader(new FileReader(path));
        // try-finally는 맨 마지막에 발생한 예외만 보인다는 단점이 있다.
        // 첫번째 예외가 중요한데 다른 예외들은 보이지 않는 것이 단점..!!
        try {
            return br.readLine();
        }finally {
            br.close();
        }

    }

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

try-finally 를 사용한 firstLineOfFile 메서드를 실행하면 

readLine 에서 발생한 예외는 완전히 삼켜지고 close 에서 발생한 예외만 보이는 것을 확인할 수 있다..

이렇게 되면 스택 추적 내역에서 첫번째 예외에 관한 정보는 하나도 남지 않기 때문에 실제 시스템에서 디버깅을 굉장히 어렵게 한다..! 

물론 두번째 예외에서 첫번째 예외를 기록하도록 코드를 수정해주면 되기는 하지만 이렇게 하는 경우에는 코드가 굉장히 지저분해 지고, 이렇게 하는 경우도 없다고 한다.

 

 

public class TopLineWithTryWithResources {

    // try-with-resources 는 예외를 모두 보여준다.
    static String firstLineOfFile(String path) throws IOException {
        try (BufferedReader bufferedReader = new BadBufferedReader(new FileReader(path))){
            return bufferedReader.readLine();
        }
    }

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

이번에는 같은 문제를 try-with-resources 를 사용하면 해결된다. 

 

🐥 이전 item에서 봤지만 try-with-resources를 사용하기 위해서는 해당 자원이 AutoCloseable 인터페이스를 구현하고 있어야 한다. 

https://hyejin.tistory.com/1014

[이펙티브 자바] Item08 완벽공략. AutoClosable

 

try-with-resources를 사용하면 readLine 과 close 에서 모두 예외가 발생한다고 하면 readLine 메서드에서 발생한 예외가 기록되고, close에서 발생한 예외는 숨겨지는데 이런 숨겨진 예외들이 그냥 버려지는것이 아니라 스택 추적 내역에서 Suppressed 라고 해서 꼬리표를 달고 출력해주기 때문에 

예외 정보를 모두 확인 가능하다는 장점이 있다!!! 

 

 

 

 

💡 꼭 회수해야 하는 자원이 있을 때 이제는 try-finally 대신 try-with-resources를 사용하자!! 

try-finally에 비해 코드도 더 짧고 분명하며, 만들어지는 예외 정보도 훨씬 훨씬 유용하기 때문이다.