“main（）类”文件的最佳编码（布局）实践？答案

【问题标题】：Best coding (layout) practice for the "main() class" file?“main（）类”文件的最佳编码（布局）实践？
【发布时间】：2013-11-30 16:58:02
【问题描述】：

目前，我的“main() 类”文件看起来有点像下面的代码。我没有用 //cmets 把这个示例代码弄得乱七八糟，而是简单地用数字（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() 的本地私有方法，该方法旨在启动项目。

【问题讨论】：

所有类都应该在包中。

标签： java main methodology

【解决方案1】：

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

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

对于2.main（特别是public static void main(String[] args)是Java需要的一个特定的标准签名。任何可运行的程序，一个产生输出并可以执行的程序都需要一个带有这个签名的main方法。我将尝试解释签名，这可能会帮助你理解为什么会这样。

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

它是静态的，因为没有static，JVM 代码将需要您的类的实例才能实际访问该方法。请记住，仅使用类名就可以访问静态方法和字段。但是，非静态成员需要有效的活动对象才能访问它们。

它是无效的，因为 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
}

你可以选择你需要的，放弃你需要的。公共方法还包括变量的 getter 和 setter（如果您使用它们）。

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

希望这会有所帮助。

【讨论】：

谢谢安德烈...我的英语有点生疏了。
编辑后的摘要描述说“固定拼写”，但不幸的是它包含两个拼写错误。（应该对齐和格式化。）

【解决方案2】：

1 是的，您应该始终使用包。但不要在其中使用驼峰式...所以 myotherpackage 而不是 myOtherpackage。

2 是的，合并单词 main 是一个很好的约定，例如我的应用程序主。记住类名以大写字母开头。

3 是的，常见的顺序是静态、成员、构造函数、方法，就像你已经拥有的一样

4 是的！这样可以实现更好的测试，并且您不应使用静态上下文超过您需要的时间。

如果你添加一个包并接受我的大写字母提示，我认为你上面的内容绝对没问题。

【讨论】：

【解决方案3】：

通常，最好定义自己的包，以避免与类路径中的任何其他类发生命名冲突。这也适用于主类。想象一下，如果在您的依赖项中的其他地方有一个类，其创建者使用相同的方法将其保留在默认包中，会发生什么情况。所以是的，把 i 放进一个包里。
命名由您自行决定，但 Java 编码约定肯定要求您将类名大写。所以，Main 或 MainProject 或 EntryPoint 会是更好的选择。
我认为您将字段和方法称为类的成员。请注意，局部变量和局部方法具有完全不同的含义（它们不是类本身的成员）。通常的顺序是静态字段、实例字段、静态方法构造函数、实例方法。我不认为有一个强烈的约定，但这些都是习惯。
保持any方法干净简单是值得的；）

【讨论】：

【解决方案4】：

始终使用package。无论。这是你的命名空间！
不要在你的包名中使用camelCase。
避免导入整个packages.*，最好导入单个package.Clazz。
类名应始终为UpperCaseAndCamelCase。
在类或方法名和左括号{之间留一个空格，这样可以提高可读性。

其余的似乎还可以。这或多或少是一个实用主义的问题。您的代码必须满足编写它的目的，并且还需要是可测试和可读的（由其他人）。

所有这些标准都将为您或您的团队构成一个规则集。

【讨论】：

【解决方案5】：

如果其他人有一个同名的主类怎么办？除了最简单的测试程序之外，最好将它放在一个包中。
在类名中加入“Main”是个好主意，因为它可以快速告诉读者类的目的，但是根据java language conventions，“mainClass”应该是“MainClass”
The usual order is variables, constructors, and methods in whatever order is reasonable
是的，保持 main 方法小而易读。其中的逻辑大部分应该只与传递给程序的参数有关，甚至当它变得太大时也应该考虑到这一点。

【讨论】：

【解决方案6】：

绝对应该使用1个包。出于维护目的，如果您的项目随着时间的推移变得更大，那么 main 使用的语法可能完全相同。包名也应该有意义，并为相关功能类提供简洁的包含。

2 是的，最好在类名中包含单词 main 并且应该以大写字母开头。

3 通常顺序是变量、构造函数、方法。

4 保持主要简洁明了。你已经完成的代码越少越好。

【讨论】：