Java 命名约定

Java 命名约定是一种准则，程序程序员应遵循这些准则来在整个应用程序中编写一致且可读的代码。如果团队不遵循这些约定，则可能会编写出难以阅读和理解的应用程序代码。

Java 大量使用驼峰（第一个单词的全部小写，其他后面的单词首字母大写）表示法来命名方法，变量等，而类和接口则使用标题表示法（每个词的首字母大写，其余字母小写）。

让我们通过示例详细了解这些命名约定。

1. 软件包命名约定

软件包名称必须是一组以所有小写域名（例如 com，org，net 等）开头的单词。包名称的后续部分可能会根据组织内部的内部命名约定而有所不同。

package com.howtodoinjava.webapp.controller;
 
package com.company.myapplication.web.controller;
 
package com.google.search.common;

2. 类命名约定

在 Java 中，类名通常应为名词，在首字母大写的情况下，每个单独单词的首字母应大写。例如

public class ArrayList {}
 
public class Employee {}
 
public class Record {}
 
public class Identity {}

3. 接口命名约定

在 Java 中，接口名称通常应为形容词。接口应使用大写字母，每个单独单词的首字母大写。在相同情况下，当接口表示一类类型（例如 List 和 Map）时，它们也可以是名词。

public interface Serializable {}
 
public interface Clonable {}
 
public interface Iterable {}
 
public interface List {}

4. 方法命名约定

方法名应该总是动词。它们代表一个动作，方法名称应清楚说明它们执行的动作。为了清楚地表示操作，方法名称可以是单个单词或 2-3 个单词。单词应使用驼峰式大写。

public Long getId() {}
 
public void remove(Object o) {}
 
public Object update(Object o) {}
 
public Report getReportById(Long id) {}
 
public Report getReportByName(String name) {}

5. 变量命名约定

所有的实例，静态变量和方法参数变量名称均应采用驼峰表示法。它们应该简短，足以描述其目的。临时变量可以是单个字符，例如循环中的计数器。

public Long id;
 
public EmployeeDao employeeDao;
 
private Properties properties;
 
for (int i = 0; i < list.size(); i++) {
     
}

6. 常量命名约定

Java 常量应全部为大写，其中单词之间用下划线字符（“_”）分隔。并且请一定将 final 修饰符与常量变量一起使用。

public final String SECURITY_TOKEN = "...";
 
public final int INITIAL_SIZE = 16;
 
public final Integer MAX_SIZE = Integer.MAX;

7. 泛型命名约定

泛型参数名称应为大写单字母。 'T' 通常建议输入字母。在 JDK 类中， E 用于集合元素， S 用于服务加载程序，K 和 V用于映射键和值。

public interface Map <K,V> {}
 
public interface List<E> extends Collection<E> {}
 
Iterator<E> iterator() {}

8. 枚举命名约定

类似于类常量，枚举名称应全部为大写字母。

enum Direction {NORTH, EAST, SOUTH, WEST}

9. 注解命名约定

注解名称遵循标题大小写。根据要求，它们可以是形容词，动词或名词。

public @interface FunctionalInterface {}
 
public @interface Deprecated {}
 
public @interface Documented {}
 
public @Async Documented {
 
public @Test Documented {

在本文中，我们讨论了一致的代码编写所遵循的 Java 命名约定，这使代码更具可读性和可维护性。

在使用任何编程语言编写简洁的代码时，命名约定可能是遵循的第一个最佳实践。