简单聊聊编程头疼的事情之一命名

开发 前端
编程过程中,有太多太多让我们头疼的事情了,比如命名、维护其他人的代码、写测试、与其他人沟通交流等等。

 [[329484]]

本文转载自微信公众号「 JavaGuide」作者Guide哥,转载本文请联系 JavaGuide公众号。

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

 

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

为什么需要重视命名?

好的命名即是注释,别人一看到你的命名就知道你的变量、方法或者类是做什么的! 好的命名对于其他人(包括你自己)理解你的代码有着很大的帮助!

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

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

“好的代码本身就是注释,我们要尽量规范和美化自己的代码来减少不必要的注释。若编程语言足够有表达力,就不需要注释,尽量通过代码来阐述。举个例子:去掉下面复杂的注释,只需要创建一个与注释所言同一事物的函数即可

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

应替换为

  1. if (employee.isEligibleForFullBenefits()) 

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

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

驼峰命名法(CamelCase)

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

大驼峰命名法(CamelCase)

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

正例:

  1. ServiceDiscovery、ServiceInstance、LruCacheFactory 

反例:

  1. serviceDiscovery、Serviceinstance、LRUCacheFactory 

小驼峰命名法(lowerCamelCase)

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

正例:

  1. getUserInfo()、createCustomThreadPool()、setNameFormat(String nameFormat) 
  2. Uservice userService; 

反例:

  1. GetUserInfo()、CreateCustomThreadPool()、setNameFormat(String NameFormat) 
  2. Uservice user_service 

蛇形命名法(snake_case)

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

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

蛇形命名法的优势是命名所需要的单词比较多的时候,比如我把上面的命名通过小驼峰命名法给大家看一下:“shouldGet200StatusCodoWhenRequestIsValid”。感觉如何?相比于使用蛇形命名法(snake_case)来说是不是不那么易读?**

正例:

  1. @Test 
  2. void should_get_200_status_code_when_request_is_valid() { 
  3.   ...... 

反例:

  1. @Test 
  2. void shouldGet200StatusCodoWhenRequestIsValid() { 
  3.   ...... 

串式命名法(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 开头。

  1. //为远程传输部分抽象出来的一个抽象类(出处:Dubbo源码) 
  2. public abstract class AbstractClient extends AbstractEndpoint implements Client { 
  3.  

6.异常类命名使用 Exception 结尾。

  1. //自定义的 NoSuchMethodException(出处:Dubbo源码) 
  2. public class NoSuchMethodException extends RuntimeException { 
  3.     private static final long serialVersionUID = -2725364246023268766L; 
  4.  
  5.     public NoSuchMethodException() { 
  6.         super(); 
  7.     } 
  8.  
  9.     public NoSuchMethodException(String msg) { 
  10.         super(msg); 
  11.     } 

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

  1. //为 AnnotationUtils 类写的测试类(出处:Dubbo源码) 
  2. public class AnnotationUtilsTest { 
  3.   ...... 

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 制作了一个涵盖上面所有重要内容的思维导图,便于小伙伴们日后查阅。

 

 

 

责任编辑:武晓燕 来源: JavaGuide
相关推荐

2020-11-12 19:02:43

命名编程编码

2021-02-04 15:08:37

Vue渐进式框架

2020-04-09 13:40:28

C语言操作系统Java

2013-11-01 17:24:39

程序员命名

2023-04-19 09:05:44

2018-09-19 07:33:03

开源储存系统

2012-03-08 21:54:20

Windows Pho

2020-02-21 10:44:21

网络安全态势感知漏洞分析

2014-07-31 10:57:15

Android组件Service

2017-03-27 21:59:57

TDD开发编程

2020-11-05 12:56:19

Python办公自动化

2011-05-31 09:51:23

编程语言

2022-02-11 14:39:11

游戏JS鸿蒙

2021-07-07 09:18:00

Java并发编程

2022-02-23 09:03:29

JavaScript开发命名约定

2023-08-10 08:28:46

网络编程通信

2020-08-10 15:04:35

Golang编译跨平台

2021-08-10 19:15:17

语言编程应用

2022-08-02 20:21:42

开源项目工具

2020-10-09 10:51:42

部署
点赞
收藏

51CTO技术栈公众号