乐趣区

参与国际化项目需遵循的java命名规范

jiezi

笔者最近帮助一些朋友应聘远程工作(一般都是一些国外的项目)，国外的项目负责人一般都会要求提供 github 账号或者一些源代码，很多朋友在这一关就被筛选掉了，其中不乏一些我认为技术非常厉害的行业大牛，他们都研发过很多的大型项目，经验与技术实力都非常不错。那究竟是为什么呢？我经过仔细的研究，发现他们都有一个共同点，就是命名规范不太严谨。我对这些在应聘远程项目第一关就被筛选掉了的程序员做了一个问卷调查：你都知道哪些 java 命名规范？最终结果显示：

  • 类的首字母要大写，使用驼峰标识
  • 变量首字母小写，使用驼峰标识
  • 常量字母全部大写，下划线分隔
  • 使用英文单词，不要使用拼音

在很多的 java 程序员看来能做到这些，就已经是很规范的命名方式了，究竟还有哪些不足之处？笔者总结了一下 java 开发中的最常用的一些命名规范，如果有不足之处，还请各位朋友不吝赐教！如果您觉得本文对您有帮助，期待您能帮忙关注、转发！

一、package 命名规范

软件项目的包名称应该是由您的公司的域名的倒序，再加上您的项目的名称，均使用小写字母，不能包含其他符号。可以在最后添加包的版本，如下图实例所示：


org.example.aprojectname
org.example.aprojectname.innerpkg
org.example.aprojectname.innerpkg.anotherpkg
org.example.aprojectname.innerpkg2

org.example.anotherproject
org.example.anotherproject.v2

二、Class 命名规范

类名必须是一个 名词，使用驼峰命名方式，首字母应大写，例如HashMap。应该可以从类名中推断出它大概会包含什么样的函数和变量。例如：


class Student{}

class ArrayList{}

class HashMap{}

class ComputerEngineer{}

三、Interface 接口

接口名称应尽量使用 形容词 。有时也可以是 名词 ，如：List 或Map。与类的命名规范一样，使用驼峰命名，首字母应大写。如下：


interface Cloneable{}

interface AutoCloseable{}

interface PreparedStatement{}

interface Engineer{}
  • 接口通常代表一类对象的总称。形容词“会跑的”可以是一个接口名称，实现类可以是人、狗、猫。
  • 而使用名词需要具有一定的概括性，“爪子”比“猫爪”更像是一个接口的名字。

四、变量

变量尽量是简短而且有意义的名词，遵循驼峰命名，首字母小写。并且不要使用划线（’_‘）或美元符号 ’$‘ 字符。

  • 在 for 循环中使用的计数变量，可以是 i，j，k，m 和 n，它们也常用于整数
  • 对于 布尔 值，通常开头应该是 is 或has。
  • 可以使用 Of 串联多个名词
  • 可以使用形容词修饰名词

int countOfCustomer;   //Of 串联

float averageInterest;   // 形容词修饰名词

long timeInMillisecond, daysInYear;    // 时间

boolean isEngineer, isCompleted, hasSubmitted;   // 布尔类型

五、常量

常量也是程序的重要组成部分。也要使用名词，或者形容词修饰的名词。全部字母大写，使用下划线分隔单词。


public static final float PI = 3.14;

static int CREATED_ON_YEAR = 2019;

六、方法

方法名称要使用 动词，并且应该从名称中可以推断出方法的功能，尽量简短。使用驼峰标志命名。通常，get 和 set 用于分别获取数据和设置数据。对于布尔值，方法名称应与与变量名称相同。


void print(Object obj);

void remove(Obejct obj);

Object update();

int getCountOfCustomer();//getter

void setCountOfCustomer(int countOfCustomers);//setter

boolean isUserAdmin(User user);  // 布尔类型

七、泛型

使用单个大写字母，T使用的比较广泛。E通常被用于集合元素，K和 V 通常被用于映射关系。请勿使用多字符。


public <T> void print(T t);

interface List<E>{}

class HashMap<K, V> {};

期待您的关注

  • 博主最近新写了一本书：《手摸手教您学习 SpringBoot 系列 -16 章 97 节》
  • 本文转载注明出处（必须带连接，不能只转文字）：字母哥博客。
退出移动版