me 常用的的java编程规范

最新推荐文章于 2024-04-13 14:44:50 发布

Yexiaomola

最新推荐文章于 2024-04-13 14:44:50 发布

阅读量459

点赞数

分类专栏：配置类专业课类笔记文章标签： java 搜索

本文链接：https://blog.csdn.net/qq_32603745/article/details/52069045

版权

专业课类笔记同时被 2 个专栏收录

10 篇文章 4 订阅

订阅专栏

配置类

3 篇文章 0 订阅

订阅专栏

###写在前面
####前言

搜索到 谷歌Java编程规范 翻译版
但是发现太多了,有点繁琐, 不适合我(刚刚接触 java 的菜鸟)
所以自己按照自己的习惯,拿出来了常用的一些, 以作参考

所以大神请自动绕过,(哈哈哈哈)
如果总结有错误的地方, 或者格式不对, 请指出来, 不胜感激
####疑问
谷歌Java编程规范 中代码缩进为 2
平时遇到的, 写的代码都是 4
但是为了尊重原文, 示例代码还是缩进 2

###源文件

文件编码: `UTF-8`

####package 语句

package 语句不换行. 即 package语句写在一行

####import语句
2. import 不要使用通配符
3. import 不要换行 * 每个import语句独立成行*
4. import 语句的顺序和间距

1,所有的静态导入独立成组
2,第三方包.每个顶级包为一组,字典顺序.例如: android, com, junit, org, sun
3,java imports
4,javax import

<组内不空行,按字典顺序排列.>

####类的声明
9. 只有一个顶级类声明

每个顶级类都在一个与它同名的源文件中(当然,包括 .java 后缀).
例外:package-info.java , 该文件中可没有 package-info 类

类成员顺序

类的成员顺序对易学性有很大的影响，但这也不存在唯一的通用法则.
不同的类对成员的排序可能是不同的。最重要的一点，每个类应该以某种逻辑去排序它的成员，维护者应该要能解释这种排序逻辑.
比如，新的方法不能总是习惯性地添加到类的结尾 [因为这样就是按时间顺序而非某种逻辑来排序的][6]
重载:当一个类有多个构造函数,或是多个同名方法,这些 函数/方法应该按顺序出现在一起,中间不要放进其它函数/方法

###格式

####大括号
这一条很重要,一定要记牢,不能偷懒
1, 大括号与 if, else, for, do, while … 语句应一起使用时.

即使只有一条语句(或者是空的), 也应该把大括号写上.

2, 非空块: K&R 风格 ( [Egyptian brackets][6] )

-左大括号前不换行
-左大括号后换行
-右大括号前换行

如果右大括号前是一个 语句 函数体 类的终止,则右大括号后换行; 否则不换行 . 例如:如果右大括号后是 else或者逗号, 则不换行.

示例 :

return new MyClass() {
  @Override public void method() {
    if (condition()) {
      try {
        something();
      } catch (ProblemException e) {
        recover();
      }
    }
  }
};

3, 空块 : 可以用简洁版本

一个空的块状结构里什么也不包含，大括号可以简洁地写成 {}，不需要换行。例外：如果它是一个多块语句的一部分(if/else 或 try/catch/finally) ，即使大括号内没内容，右大括号也要换行。

示例:

void doNothing() {}

####自动换行

术语说明:一般情况下，一行长代码为了避免超出列限制(80或100个字符)而被分为多行，我们称之为自动换行(line-wrapping)。

1,从哪里断开

	自动换行的基本准则是：更倾向于在更高的语法级别处断开。

如果在非赋值运算符处断开，那么在该符号前断开(比如+，它将位于下一行)。注意：这一点与Google其它语言的编程风格不同(如C++和JavaScript)。这条规则也适用于以下“类运算符”符号：点分隔符(.)，类型界限中的&（<T extends Foo & Bar>)，catch 块中的管道符号(catch (FooException | BarException e)

如果在赋值运算符处断开，通常的做法是在该符号后断开(比如=，它与前面的内容留在同一行)。这条规则也适用于foreach语句中的分号.
方法名或构造函数名与左括号留在同一行.
逗号 ( , ) ,与其前面的内容留在同一行.

2, 自动换行时缩进至少+4个空格

自动换行时，第一行后的每一行至少比第一行多缩进4个空格(注意：制表符不用于缩进)。

当存在连续自动换行时，缩进可能会多缩进不只4个空格(语法元素存在多级时)。一般而言，两个连续行使用相同的缩进当且仅当它们开始于同级语法元素。

####空白
1, 垂直空白
2, 水平空白
3, 水平对齐 不做要求
4,
####用小括号限定组 (推荐使用)
除非作者和reviewer都认为去掉小括号也不会使代码被误解，或是去掉小括号能让代码更易于阅读，否则我们不应该去掉小括号。我们没有理由假设读者能记住整个Java运算符优先级表。
####具体结构
1, 枚举类

枚举常量间用逗号隔开, 换行可选.

没有方法和文档的枚举类可写成数组初始化的格式:


private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS}

由于枚举类也是一个类, 因此所有适用于其他类的格式规则也适用于枚举类.

2, 变量声明

每次只声明一个变量

 不要使用组合声明, 比如   `int a, b;`

需要变量时才声明，并尽快进行初始化

 不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法)，而是在第一次需要使用它时才声明。 局部变量在声明时最好就进行初始化，或者声明后尽快进行初始化。

3, 数组

数组初始化：可写成块状结构

例如:下面的写法都是 OK 的

	   new int[] {
	   0, 1, 2, 3 
	   }
	   new int[] {
	       0,
	       1,
	       2,
	       3
	    }
	   new int[] {  
	       0, 1,
	       2, 3
	    }
	   new int [] {0, 1, 2, 3}

非 C风格的数组声明

中括号是类型的一部分：String[] args，而非String args[]。

4, switch 语句

术语说明:switch块的大括号内是一个或多个语句组。每个语句组包含一个或多个switch标签(`case FOO`:或`default:`)，后面跟着一条或多条语句。

缩进
与其它块状结构一致，switch块中的内容缩进为2个空格。
每个switch标签后新起一行，再缩进2个空格，写下一条或多条语句。
注释
在一个switch块内，每个语句组要么通过break, continue, return或抛出异常来终止，要么通过一条注释来说明程序将继续执行到下一个语句组，任何能表达这个意思的注释都是OK的(典型的是用 // fall through)。这个特殊的注释并不需要在最后一个语句组(一般是default)中出现。示例：

		switch (input) {
			case 1:
			case 2:
			prepareOneOrTwo();
			// fall through
			case 3:
			    handleOneTwoOrThree();
		    break;
			  default:
		handleLargeNumber(input);
		}

default 的情况要写出来

每个switch 语句都包含一个 default 语句组, 即使它什么代码也不包含.

5, 注解

注解紧跟在文档块后面，应用于类、方法和构造函数，一个注解独占一行。这些换行不属于自动换行, 因此缩进级别不变。例如：

		@Override
		@Nullable
		public String getNameIfPresent(){ ... }

例外：单个的注解可以和签名的第一行出现在同一行。例如：

@Override public int hashCode() { ... }

应用于字段的注解紧随文档块出现，应用于字段的多个注解允许与字段出现在同一行。例如：

@Partial @Mock DataLoader loader;

参数和局部变量注解没有特定规则。

6, 注释

块注释风格

块注释与其周围的代码在同一缩进级别。它们可以是/* ... */风格，也可以是// ...风格。对于多行的/* ... */注释，后续行必须从*开始，并且与前一行的*对齐。以下示例注释都是OK的。

/*
 * This is          // And so           /* Or you can
 * okay.            // is this.          * even do this. */
 */

注释不要封闭在由星号或其它字符绘制的框架里。

 Tip：在写多行注释时，如果你希望在必要时能重新换行(即注释像段落风格一样)，那么使用 /* ... */ 。

####命名约定
1, 对所有标识符的要求

标识符只能使用ASCII字母和数字，因此每个有效的标识符名称都能匹配正则表达式 \w+。

在Google其它编程语言风格中使用的特殊前缀或后缀，如 name_, mName, s_name和kName，在Java编程风格中都不再使用。

2, 标识符类型的规则

包名

包名全部小写，连续的单词只是简单地连接起来，不使用下划线。

类名

类名都以 UpperCamelCase风格编写。

类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。

测试类的命名以它要测试的类的名称开始，以Test结束。例如，HashTest或HashIntegrationTest。

方法名

方法名都以 lowerCamelCase风格编写。

方法名通常是动词或动词短语。

下划线可能出现在JUnit测试方法名称中用以分隔名称的逻辑组件。一个典型的模式是：test<MethodUnderTest>_<state>，例如testPop_emptyStack。并不存在唯一正确的方式来命名测试方法。

常量名

常量名命名模式为CONSTANT_CASE，全部字母大写，用下划线分隔单词。那，到底什么算是一个常量？

每个常量都是一个静态final字段，但不是所有静态final字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的，它要真的一直不变才能将它示为常量。

// Constants
static final int NUMBER = 5;
static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");
static final Joiner COMMA_JOINER = Joiner.on(',');  // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};
enum SomeEnum { ENUM_CONSTANT }
// Not constants
static String nonFinal = "non-final";
final String nonStatic = "non-static";
static final Set<String> mutableCollection = new HashSet<String>();
static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {"these", "can", "change"};

非常量字段名

非常量字段名以lowerCamelCase风格编写。

这些名字通常是名词或名词短语。

参数名

参数名以 lowerCamelCase风格编写。

参数应该避免用单个字符命名。

局部变量名

局部变量名以lowerCamelCase风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。

虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。

即使局部变量是final和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。

类型变量名

类型变量名可用以下两种风格之一进行命名:

单个的大写字母，后面可以跟一个数字(如：E, T, X, T2)。
以类命名方式，后面加个大写的T(如：RequestT, FooBarT)。
####驼峰命名法

驼峰式命名法分大驼峰式命名法(UpperCamelCase)和小驼峰式命名法(lowerCamelCase)。

有时，我们有不只一种合理的方式将一个英语词组转换成驼峰形式，如缩略语或不寻常的结构(例如”IPv6”或”iOS”)。Google指定了以下的转换方案。

名字从 散文形式 (prose from) 开始:
把短语转换为纯ASCII码，并且移除任何单引号。例如：”Müller’s algorithm”将变成”Muellers algorithm”。
把这个结果切分成单词，在空格或其它标点符号(通常是连字符)处分割开。

推荐：如果某个单词已经有了常用的驼峰表示形式，按它的组成将它分割开(如”AdWords”将分割成”ad words”)。需要注意的是”iOS”并不是一个真正的驼峰表示形式，因此该推荐对它并不适用

现在将所有字母都小写(包括缩写)，然后将单词的第一个字母大写：

每个单词的第一个字母都大写，来得到大驼峰式命名。
除了第一个单词，每个单词的第一个字母都大写，来得到小驼峰式命名。

最后将所有的单词连接起来得到一个标识符。
示例:

Prose form                Correct               Incorrect------------------------------------------------------------------
"XML HTTP request"        XmlHttpRequest        XMLHTTPRequest
"new customer ID"         newCustomerId         newCustomerID
"inner stopwatch"         innerStopwatch        innerStopWatch
"supports IPv6 on iOS?"   supportsIpv6OnIos     supportsIPv6OnIOS
"YouTube importer"        YouTubeImporter
                         YoutubeImporter*

###编程实践
####@Override : 能用则用

捕获的异常: 不能忽视

除了下面的例子，对捕获的异常不做响应是极少正确的。(典型的响应方式是打印日志，或者如果它被认为是不可能的，则把它当作一个AssertionError重新抛出。)
如果它确实是不需要在catch块中做任何响应，需要做注释加以说明(如下面的例子).
try {

int i = Integer.parseInt(response);
return handleNumericResponse(i);
} catch (NumberFormatException ok) {
// it’s not numeric; that’s fine, just continue
}
return handleTextResponse(response);

- 例外 : 在测试中，如果一个捕获的异常被命名为expected，则它可以被不加注释地忽略。下面是一种非常常见的情形，用以确保所测试的方法

会抛出一个期望中的异常，因此在这里就没有必要加注释.

try {

emptyStack.pop();
fail();
} catch (NoSuchElementException expected) {
}

####静态成员 : 使用类进行调用

使用类名调用静态的类成员，而不是具体某个对象或表达式。
Foo aFoo = ...;

Foo.aStaticMethod(); // good
aFoo.aStaticMethod(); // bad
somethingThatYieldsAFoo().aStaticMethod(); // very bad

####Finalizers : 禁用

极少会去重写Object.finalize。

Tip：不要使用finalize。如果你非要使用它，请先仔细阅读和理解Effective Java 第7条款：“Avoid Finalizers”，然后不要使用它。
###Javadoc
####格式

一般格式(Javadoc块的基本格式如下所示：)

    /**
    * Multiple lines of Javadoc text are written here,
    * wrapped normally...
    */
public int method(String p1) { ... }

或者是以下单行显示

/** An especially short bit of Javadoc. */

基本格式总是OK的。当整个Javadoc块能容纳于一行时(且没有Javadoc标记@XXX)，可以使用单行形式.

段落

空行(即，只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。除了第一个段落，每个段落第一个单词前都有标签 <p>，并且它和第一个单词间没有空格。

Javadoc 标记

标准的Javadoc标记按以下顺序出现：param, @return, @throws, @deprecated 前面这4种标记如果出现，描述都不能为空。当描述无法在一行中容纳，连续行需要至少再缩进4个空格。

####摘要片段

每个类或成员的Javadoc以一个简短的摘要片段开始。这个片段是非常重要的，在某些情况下，它是唯一出现的文本，比如在类和方法索引中

这只是一个小片段，可以是一个名词短语或动词短语，但不是一个完整的句子。它不会以A {@code Foo} is a...或This method returns...开头, 它也不会是一个完整的祈使句，如Save the record...。然而，由于开头大写及被加了标点，它看起来就像是个完整的句子。

Tip：一个常见的错误是把简单的Javadoc写成/** @return the customer ID /，这是不正确的。它应该写成/* Returns the customer ID. */。

####哪里需要使用 Javadoc

至少在每个public类及它的每个public和protected成员处使用Javadoc

以下是一些例外：

例外 1：不言自明的方法

对于简单明显的方法如getFoo，Javadoc是可选的(即，是可以不写的)。这种情况下除了写“Returns the foo”，确实也没有什么值得写了。

单元测试类中的测试方法可能是不言自明的最常见例子了，我们通常可以从这些方法的描述性命名中知道它是干什么的，因此不需要额外的文档说明

Tip：如果有一些相关信息是需要读者了解的，那么以上的例外不应作为忽视这些信息的理由。例如，对于方法名getCanonicalName，就不应该忽视文档说明，因为读者很可能不知道词语canonical name指的是什么。

例外2:重写

如果一个方法重写了超类中的方法，那么Javadoc并非必需的。

可选的Javadoc

对于包外不可见的类和方法，如有需要，也是要使用Javadoc的。如果一个注释是用来定义一个类，方法，字段的整体目的或行为，那么这个注释应该写成Javadoc，这样更统一更友好。
###后记
本文参考处
原文作者: Hawstein
原文出处:原文
声明: 本文采用以下协议进行授权：自由转载-非商用-非衍生-保持署名|Creative Commons BY-NC-ND 3.0 ，转载请注明作者及出处。