java - "main() class"文件的最佳编码(布局)实践？

Question

目前，我的“main() 类”文件看起来有点像下面的代码。我没有用//注释来​​困惑这个示例代码以供讨论，而是简单地用数字(1 到 4)标记了四个代码行，这些数字指的是代码后面出现的问题。谢谢。

// package myPackage;  // **1**

import myOtherPackage.*;

class mainProject{  // **2**

    // **3**
    private int myVar;

    mainProject(){
        myVar = 0;
    }

    public static void main(String args[]){

        // Keep main() looking fairly simple?
        // Perhaps just have some "essentials" here, such as error handling?

        new mainProject().start();  // **4**
    }

    private void start(){
        // The project gets going here..
    }
}

1 与我的项目中的其他类文件不同，我没有为“main() 类”文件分配包名称。这是一个糟糕的设计选择吗？

2 “主类”有一个好的命名约定吗？将“main”一词合并到该类名称中是否有帮助？类似于“mainProject”的东西是个好主意吗？

3 各种编码结构可以出现在主类文件中。例如，局部变量、构造函数、main() 方法和局部方法。它们在此文件中出现的“最佳顺序”是否存在？

4 是否值得让 main() 方法看起来相当“简洁”？在此示例中，我刚刚调用了一个名为 start() 的本地私有(private)方法，该方法旨在启动项目。

Answer 1

好的，这就是我在专业项目中的做法。

对于1.每个类都应该有一个包。主要或没有主要没有区别。包是java在运行时以 namespace 的形式组织类的方式。因此，如果您停止提供包，那么您最终可能会在同一个文件夹或 jar 中得到两个具有相同名称的类文件，当发生这种情况时，JVM 会选择它通过类路径上的名称找到的第一个类。这可能不完全是您想要的。

对于2.main(特别是public static void main(String[] args)来说，是Java需要的一个特定的、标准的签名。任何可运行的程序，产生输出并且可以被执行的程序需要一个具有此签名的 main 方法。我将尝试解释该签名，这也许会帮助您理解为什么它是这样的。

它是公开的，因为您希望 JVM 运行时代码执行该方法。使用 private 或 protected 将不允许 JVM 代码查看您的方法。

它是静态的，因为如果没有静态，JVM 代码将需要类的实例才能实际访问该方法。请记住，只需使用类名即可访问静态方法和字段。但是，非静态成员需要有效的 Activity 对象才能访问它们。

它是无效的，因为 main 不会向其调用者返回任何内容。就像任何具有 void 返回类型的方法一样。

它被称为 main 是因为 Java 的创建者想给它起这个名字。执行此方法的 JVM 运行时代码需要知道将启动执行的方法的名称。现在，如果我给它起任何名字，那么 JVM 代码就不可能做出疯狂的猜测。因此，名称标准化需要一个标准名称，而 Java 创建者则坚持使用 main。

String[] 实际上是一个字符串数组，其中包含传递给程序的命令行参数。 args 是参数的名称，具有讽刺意味的是，这是您唯一可以更改为您想要的任何名称的东西。

对于命名主类，我通常更喜欢 MyProjectLauncher 或 MyProjectBootstrap 这样的名称，其中 myProject 是项目的名称，例如 tomcat 或 bigben 或任何您喜欢的名称。

对于3.标准约定是:

public class MyClass{

    //private members

    //protected members

    //constructors

    //private methods

    //protected methods

    //public methods

    //hashcode and equals

    //toString overrides
}

您可以选择您需要的内容并删除您需要的内容。公共(public)方法还包括变量的 getter 和 setter(如果您使用它们)。

对于 4. 设计类时，您需要牢记代码的可扩展性和可管理性。在项目开始时有一个 main 类和几个类是很常见的，然后当它们成长为数千行的超大袋鼠时，然后重构代码来调整它。您应该做的是根据功能、服务助手或操作创建类。将 main 保留在不同的类中。只需使用 main 初始化一些东西，解析命令行选项并委托(delegate)启动或初始化方法，该方法执行剩余的操作来启动你的程序。

希望这有帮助。