乐趣区

关于java:Java-命名之道

jiezi

为什么须要器重命名？

好的命名即是正文，他人一看到你的命名就晓得你的变量、办法或者类是做什么的！ 好的命名对于其他人（包含你本人）了解你的代码有着很大的帮忙！

简略举个例子阐明一下命名的重要性。

《Clean Code》这本书明确指出：

好的代码自身就是正文，咱们要尽量标准和丑化本人的代码来缩小不必要的正文。

若编程语言足够有表达力，就不须要正文，尽量通过代码来论述。

举个例子：

去掉上面简单的正文，只须要创立一个与正文所言同一事物的函数即可

// check to see if the employee is eligible for full benefits
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))

应替换为

if (employee.isEligibleForFullBenefits())

[](https://github.com/Snailclimb…

这里只介绍 3 种最常见的命名标准。

驼峰命名法（CamelCase）

驼峰命名法应该咱们最常见的一个，这种命名形式应用大小写混合的格局来区别各个单词，并且单词之间不应用空格隔开或者连贯字符连贯的命名形式

大驼峰命名法（CamelCase）

类名须要应用大驼峰命名法（UpperCamelCase）

正例：

ServiceDiscovery、ServiceInstance、LruCacheFactory

反例：

serviceDiscovery、Serviceinstance、LRUCacheFactory

小驼峰命名法（lowerCamelCase）

办法名、参数名、成员变量、局部变量须要应用小驼峰命名法（lowerCamelCase）。

正例：

getUserInfo()、createCustomThreadPool()、setNameFormat(String nameFormat)
Uservice userService;

反例：

GetUserInfo()、CreateCustomThreadPool()、setNameFormat(String NameFormat)
Uservice user_service

蛇形命名法（snake_case）

测试方法名、常量、枚举名称须要应用蛇形命名法（snake_case）

在蛇形命名法中，各个单词之间通过下划线“_”连贯，比方should_get_200_status_code_when_request_is_valid、CLIENT_CONNECT_SERVER_FAILURE。

蛇形命名法的劣势是命名所须要的单词比拟多的时候，比方我把下面的命名通过小驼峰命名法给大家看一下：“shouldGet200StatusCodoWhenRequestIsValid”。感觉如何？相比于应用蛇形命名法（snake_case）来说是不是不那么易读？**

正例：

@Test
void should_get_200_status_code_when_request_is_valid() {......}

反例：

@Test
void shouldGet200StatusCodoWhenRequestIsValid() {......}

串式命名法（kebab-case）

在串式命名法中，各个单词之间通过下划线“-”连贯，比方dubbo-registry。

倡议我的项目文件夹名称应用串式命名法（kebab-case），比方 dubbo 我的项目的各个模块的命名是上面这样的。

常见命名标准

Java 语言根本命名标准

1. 类名须要应用大驼峰命名法（UpperCamelCase）格调。办法名、参数名、成员变量、局部变量须要应用小驼峰命名法（lowerCamelCase）。

2. 测试方法名、常量、枚举名称须要应用蛇形命名法（snake_case），比方 should_get_200_status_code_when_request_is_valid、CLIENT_CONNECT_SERVER_FAILURE。并且， 测试方法名称要求全副小写，常量以及枚举名称须要全副大写。

3. 我的项目文件夹名称应用串式命名法（kebab-case），比方dubbo-registry。

4. 包名对立应用小写，尽量应用单个名词作为包名，各个单词通过 “.” 分隔符连贯，并且各个单词必须为复数。

正例：org.apache.dubbo.common.threadlocal

反例：org.apache.dubbo.common.threadLocal

5. 抽象类命名应用 Abstract 结尾。

// 为近程传输局部形象进去的一个抽象类（出处：Dubbo 源码）public abstract class AbstractClient extends AbstractEndpoint implements Client {}

6. 异样类命名应用 Exception 结尾。

// 自定义的 NoSuchMethodException（出处：Dubbo 源码）public class NoSuchMethodException extends RuntimeException {
    private static final long serialVersionUID = -2725364246023268766L;

    public NoSuchMethodException() {super();
    }

    public NoSuchMethodException(String msg) {super(msg);
    }
}

7. 测试类命名以它要测试的类的名称开始，以 Test 结尾。

// 为 AnnotationUtils 类写的测试类（出处：Dubbo 源码）public class AnnotationUtilsTest {......}

POJO 类中布尔类型的变量，都不要加 is 前缀，否则局部框架解析会引起序列化谬误。

如果模块、接口、类、办法应用了设计模式，在命名时需体现出具体模式。

命名易读性标准

1. 为了能让命名更加易懂和易读，尽量不要缩写 / 简写单词，除非这些单词曾经被公认能够被这样缩写 / 简写。比方 CustomThreadFactory 不能够被写成 ~~CustomTF。

2. 命名不像函数一样要尽量谋求短，可读性强的名字优先于简短的名字，尽管可读性强的名字会比拟长一点。 这个对应咱们下面说的第 1 点。

3. 防止无意义的命名，你起的每一个名字都要能表明意思。

正例：UserService userService; int userCount;

反例: UserService service int count

4. 防止命名过长（50 个字符以内最好），过长的命名难以浏览并且俊俏。

5.不要应用拼音，更不要应用中文。 留神：像 alibaba、wuhan、taobao 这种国内通用名词能够当做英文来对待。

正例：discount

反例：dazhe

Codelf: 变量命名神器?

这是一个由国人开发的网站，网上有很多人称其为变量命名神器，Guide 在理论应用了几天之后感觉没那么好用。小伙伴们能够自行体验一下，而后再给出本人的判断。

Codelf 提供了在线网站版本，网址：https://unbug.github.io/codelf/，具体应用状况如下：

我抉择了 Java 编程语言，而后搜寻了“序列化”这个关键词，而后它就返回了很多对于序列化的命名。

并且，Codelf 还提供了 VS code 插件，看这个评估，看来大家还是很喜爱这款命名工具的。

总结

如下图所示，涵盖下面所有重要内容的思维导图，便于小伙伴们日后查阅。

其余举荐浏览

  1. 《阿里巴巴 Java 开发手册》
  2. 《Clean Code》
  3. Google Java 代码指南
  4. 辞别编码 5 分钟，命名 2 小时！史上最全的 Java 命名标准参考
  5. 《2020 最新 Java 根底精讲视频教程和学习路线！》
退出移动版