Effective Java 3rd 条目25 将源文件限制在单个顶层类

虽然Java编译器让你在单个源文件中定义多个顶层类,但是这么做没有任何益处。危险性来自这个事实:在单个源文件中定义多个顶层类,使得为一个类提供多个定义变得可能。使用哪个定义,受传递到编译器的源文件顺序的影响。

为了使得这具体些,考虑如下源文件,它仅仅包含了一个Main类,这个类引用另外两个顶层类(Utensil和Dessert)的成员:

public class Main { 
    public static void main(String[] args) { 
        System.out.println(Utensil.NAME + Dessert.NAME); 
    } 
}

现在假设你在命名为Utensil.java的单个源文件中,同时定义Utensil和Dessert:

// 同个文件中定义了两个类。永远不要这么做! 
class Utensil { 
    static final String NAME = "pan"; 
}

class Dessert { 
    static final String NAME = "cake"; 
}

当然,主程序打印了pancake。

现在假设你恰巧在命名为Dessert.java的另外一个源文件中,定义了相同的两个类:

// 同个文件中定义了两个类。永远不要这么做! 
class Utensil { 
    static final String NAME = "pot"; 
}

class Dessert { 
    static final String NAME = "pie"; 
}

如果你足够幸运用命令javac Main.java Dessert.java编译这个程序,那么编译会失败,而且这个编译器将会告诉你:你已经多次定义了Utensil and Dessert类。确实如此,因为编译器将会编译 Main.java,而且当它看见Utensil(它早于Dessert的引用)的引用,它将在Utensil.java中寻找这个类,然后发现了Utensil和Dessert。当编译器遇见了命令行上的Dessert.java,它也将引入这个文件,这造成了它同时遇见了Utensil和Dessert。

如果你使用命令javac Main.java或者javac Main.java Utensil.java编译这个程序,它表现为你编写Dessert.java文件之前的行为,即打印pancake。但是如果你使用javac Dessert.java Main.java编译这个程序,它将打印potpie。因此这个程序的行为受到源文件传递到编译器顺序的影响,这是明显不可接受的。

解决这个问题,就像分解这个顶层类(在我们例子情形中,Utensil和Dessert)到不同的源文件这么简单。如果你很想把多个顶层类放置到单个文件中,考虑使用静态成员类(条目24)作为分解类到不同源文件的替代方法。如果类从属于另外一个类,把他们变成静态成员类通常是更好的替代方法,因为它增强了可读性,而且通过声明这个类为私有来减少类的可访问性(条目15)。以下是使用静态成员类我们的例子看上去的样子:

// 静态成员类而不是多个顶层类
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"; 
    }
}

这堂课是明显的:永远不要把多个顶层类或者接口放到单个源文件中。遵从这个规则保证你不会在编译时单个类有多个定义。这转而保证,编译产生的类文件和最终程序的行为,是独立于源文件传入编译器的顺序。

推荐阅读更多精彩内容