xcx
文章 标签 分类
xcx

目录

命名规范

 出版于 common
   约 2875 字   预计阅读 6 分钟 

命名规范

1 文件命名规范

文件夹命名,最好用一个单词,如果必须多个单词,建议使用横线连接-

文件命名,最好使用一个单词,如果需要多个单词,建议使用蛇形命名_ ,特殊代码文件可以使用不同语言的建议规范进行命名,例如 java 建议驼峰命名

文件和文件夹命名,建议不要中英文混搭,如果需要中英文混搭, 建议不超过一个分隔, 意思是(ok: 中-en, en-中) (bad: 中_en_中, en_中_en)

文件和文件夹命名,建议不要使用斜杠/和反斜杠\和特殊符号 @%~`*&

文件和文件夹命名,尽量也不使用括号,相对可以接受:D

大小写问题: 建议专有名词使用大写,其余字母使用小写

人名一定不能写错

简体繁体问题: 非对港对台,建议使用简体,建议不要简体繁体混合使用

空格问题: 文件和文件夹都建议不用空格命名,相对可以接受:D

目前由于各种编码都对英文支持良好,建议存放程序的路径都使用英文

2 文本规范

文本中,中英文和数字之间空格隔开 这个后续看能不能找到输入法支持,或者写一个插件支持保存时候格式化

标点,中文全角,英文半角 但是我个人习惯都使用英文标点,这个看后续能不能找到插件,保存时候自动格式化

3 程序命名规范

大名鼎鼎的《重构》的作者老马(Martin Fowler)曾经在TwoHardThings这篇文章中提到过 CS 领域有两大最难的事情：一是 缓存失效 ，一是 程序命名 。

./marting-naming.png

这个句话实际上也是老马引用别人的，类似的表达还有很多。比如分布式系统领域有两大最难的事情：一是 保证消息顺序 ，一是 严格一次传递 。

./20210629104844645.png

今天咱们就单独拎出 “命名” 来聊聊！

3.1 为什么需要重视命名？

咱们需要先搞懂为什么要重视编程中的命名这一行为，它对于我们的编码工作有着什么意义。

为什么命名很重要呢？ 这是因为 好的命名即是注释，别人一看到你的命名就知道你的变量、方法或者类是做什么的！

简单来说就是 别人根据你的命名就能知道你的代码要表达的意思 (不过，前提这个人也要有基本的英语知识，对于一些编程中常见的单词比较熟悉)。

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

《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.2 常见命名规则以及适用场景

这里只介绍 3 种最常见的命名规范。

3.2.1 驼峰命名法(CamelCase)

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

3.2.1.1 大驼峰命名法(UpperCamelCase)

类名需要使用大驼峰命名法(UpperCamelCase)

正例：

ServiceDiscovery、ServiceInstance、LruCacheFactory

反例：

serviceDiscovery、Serviceinstance、LRUCacheFactory
3.2.1.2 小驼峰命名法(lowerCamelCase)

方法名、参数名、成员变量、局部变量需要使用小驼峰命名法(lowerCamelCase)。

正例：

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

反例：

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

3.2.2 蛇形命名法(snake_case)

测试方法名、常量、枚举名称需要使用蛇形命名法(snake_case)

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

蛇形命名法的优势是命名所需要的单词比较多的时候，比如我把上面的命名通过小驼峰命名法给大家看一下：“shouldGet200StatusCodeWhenRequestIsValid”。

感觉如何？ 相比于使用蛇形命名法(snake_case)来说是不是不那么易读？

正例：

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

反例：

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

3.2.3 串式命名法(kebab-case)

在串式命名法中，各个单词之间通过连接符“-”连接，比如dubbo-registry。

建议项目文件夹名称使用串式命名法(kebab-case)，比如 dubbo 项目的各个模块的命名是下面这样的。

./dubbo-naming.png

3.3 命名易读性规范

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

2、命名不像函数一样要尽量追求短，可读性强的名字优先于简短的名字，虽然可读性强的名字会比较长一点。 这个对应我们上面说的第 1 点。

3、避免无意义的命名，你起的每一个名字都要能表明意思。

正例：UserService userService; int userCount;

反例: UserService service int count

4、避免命名过长(50 个字符以内最好)，过长的命名难以阅读并且丑陋。

5、不要使用拼音，更不要使用中文。 不过像 alibaba 、wuhan、taobao 这种国际通用名词可以当做英文来看待。

正例：discount

反例：dazhe

4 常见编程语言命名规范

4.1 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.threadLocals

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 前缀，否则部分框架解析会引起序列化错误。

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

5 相关阅读推荐

  1. 《阿里巴巴 Java 开发手册》
  2. 《Clean Code》
  3. Google Java 代码指南：https://google.github.io/styleguide/javaguide.html#s5.1-identifier-name
  4. 告别编码 5 分钟，命名 2 小时！史上最全的 Java 命名规范参考：https://www.cnblogs.com/liqiangchn/p/12000361.html
common basis
更新于 2022-06-17