[Effective Java]톱레벨 클래스는 한 파일에 하나만 담으라

클래스와 인터페이스, 열한 번째 아이템

Posted by SungBeom on April 02, 2020 · 5 mins read

컴파일 순서에 따라 결과가 달라지는 경우: 원인

소스 파일 하나에 톱레벨 클래스를 여러 개 선언하더라도 자바 컴파일러는 불평하지 않는다. 하지만 이렇게 하면 한 클래스를 여러 가지로 정의할 수 있으며, 그중 어느 것을 사용할지는 어느 소스 파일을 먼저 컴파일하냐에 따라 달라지는 심각한 위험이 있다.

1
2
3
4
5
public class Main {
    public static void main(String[] args) {
        System.out.println(Utensil.NAME + Dessert.NAME);
    }
}
cs

1
2
3
4
5
6
7
8
9
// Utensil.java
// 두 클래스가 한 파일(Utensil.java)에 정의되었다.
class Utensil {
    static final String NAME = "pan";
}
 
class Dessert {
    static final String NAME = "cake";
}
cs

1
2
3
4
5
6
7
8
9
// Dessert.java
// 두 클래스가 한 파일(Dessert.java)에 정의되었다.
class Utensil {
    static final String NAME = "pot";
}
 
class Dessert {
    static final String NAME = "pie";
}
cs

운 좋게 javac Main.java Dessert.java 명령으로 컴파일한다면 컴파일 오류가 나고 Utensil과 Dessert 클래스를 중복 정의했다고 알려줄 것이다. 컴파일러는 가장 먼저 Main.java를 컴파일하고, 그 안에서 Dessert 참조보다 먼저 나오는 Utensil 참조를 만나면 Utensil.java 파일을 살펴 Utensil과 Dessert를 모두 찾아낼 것이다. 그런 다음 컴파일러가 두 번째 명령줄 인수로 넘어온 Dessert.java를 처리하려 할 때 같은 클래스의 정의가 이미 있음을 알게 된다.

한편, javac Main.java나 javac Main.java Utensil.java 명령으로 컴파일하면 Dessert.java 파일이 없는 것처럼 pancake를 출력한다. 그러나 javac Dessert.java Main.java 명령으로 컴파일하면 potpie를 출력한다. 이처럼 컴파일러에 어느 소스 파일을 먼저 건네느냐에 따라 동작이 달라지므로 반드시 바로 잡아야 할 문제다.

컴파일 순서에 따라 결과가 달라지는 경우: 해결책

다행히 해결책은 아주 간단한데, 단순히 톱레벨 클래스들(Utensil과 Dessert)을 서로 다른 소스 파일로 분리하면 그만이다. 굳이 여러 톱레벨 클래스를 한 파일에 담고 싶다면 정적 멤버 클래스를 사용하는 방법을 고민해볼 수 있다. 다른 클래스에 딸린 부차적인 클래스라면 정적 멤버 클래스로 만드는 쪽이 읽기 좋고, private로 선언하면 접근 범위도 최소로 관리할 수 있기 때문에 더 나을 것이다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 톱레벨 클래스들을 정적 멤버 클래스로 바꿔본 모습
public class Test {
    public static void main(String[] args) {
        System.out.println(Utensil.NAME + Dessert.NAME);
    }
 
    private static class Utensil {
        static final String NAME = "pan";
    }
 
    private static class Dessert {
        static final String NAME = "cake";
    }
}
cs

핵심 정리

교훈은 명확하다. 소스 파일 하나에는 반드시 톱레벨 클래스(혹은 톱레벨 인터페이스)를 하나만 담자. 이 규칙만 따른다면 컴파일러가 한 클래스에 대한 정의를 여러 개 만들어내는 일은 사라진다. 소스 파일을 어떤 순서로 컴파일하든 바이너리 파일이나 프로그램의 동작이 달라지는 일은 결코 일어나지 않을 것이다.