入职1年，总结了让你的命名更优雅的好习惯

本文已经收录进个人 80K+ Star 的 Java 开源项目 JavaGuide： https://github.com/Snailclimb/JavaGuide （「Java学习+面试指南」一份涵盖大部分Java程序员所须要掌握的核心知识。）

编程过程当中，有太多太多让咱们头疼的事情了，好比命名、维护其余人的代码、写测试、与其余人沟通交流等等。就连世界级软件大师 Martin Fowler 大神都说过 CS 领域有两大最难的事情，一是缓存失效，一是程序命名（@ https://martinfowler.com/bliki/TwoHardThings.html）。

今天 Guide 就单独拎出 “命名” 来聊聊，听说以前在 Quora 网站，由接近 5000 名程序员票选出来的最难的事情就是“命名”。

这篇文章配合我以前发的 《编码 5 分钟，命名 2 小时？史上最全的 Java 命名规范参考！》 这篇文章阅读效果更佳哦！

为何须要重视命名？

好的命名便是注释，别人一看到你的命名就知道你的变量、方法或者类是作什么的！ 好的命名对于其余人（包括你本身）理解你的代码有着很大的帮助！

简单举个例子说明一下命名的重要性。

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

好的代码自己就是注释，咱们要尽可能规范和美化本身的代码来减小没必要要的注释。

若编程语言足够有表达力，就不须要注释，尽可能经过代码来阐述。

举个例子：

去掉下面复杂的注释，只须要建立一个与注释所言同一事物的函数便可

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

应替换为

if (employee.isEligibleForFullBenefits())

常见命名规则以及适用场景

这里只介绍 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 插件，看这个评价，看来你们仍是很喜欢这款命名工具的。

总结

Guide 制做了一个涵盖上面全部重要内容的思惟导图，便于小伙伴们往后查阅。

其余推荐阅读

1. 《阿里巴巴 Java 开发手册》
2. 《Clean Code》
3. Google Java 代码指南：https://google.github.io/styl...

推荐阅读

1. 接近8000字的Spring/SpringBoot经常使用注解总结！安排！
2. 面试官问我Java8~14的有哪些重要的新特性，我哭了~~~
3. 第一弹！安排！安利10个让你爽到爆的IDEA必备插件！
4. 完结撒花！JavaGuide面试突击版来啦！

做者介绍: Github 80k Star 项目 JavaGuide（公众号同名） 做者。每周都会在公众号更新一些本身原创干货。公众号后台回复“1”领取Java工程师必备学习资料+面试突击pdf。