java開發(fā)規(guī)范

發(fā)布時(shí)間：2020-08-07 11:34:26 來源：ITPUB博客閱讀：247 作者：andrew3001 欄目：編程語言

所有的程序開發(fā)手冊(cè)都包含了各種規(guī)則。一些習(xí)慣自由程序人員可能對(duì)這些規(guī)則很不適
應(yīng)，但是在多個(gè)開發(fā)人員共同寫作的情況下，這些規(guī)則是必需的。這不僅僅是為了開
發(fā)效率來考慮，而且也是為了后期維護(hù)考慮。

命名規(guī)范
定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來像一個(gè)人寫的，增加可讀性，減少
項(xiàng)目組中因?yàn)閾Q人而帶來的損失。（這些規(guī)范并不是一定要絕對(duì)遵守，但是一定要讓
程序有良好的可讀性）

Package 的命名
Package 的名字應(yīng)該都是由一個(gè)小寫單詞組成。
Class 的命名
Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成
Class 變量的命名
變量的名字必須用一個(gè)小寫字母開頭。后面的單詞用大寫字母開頭。
Static Final 變量的命名
Static Final 變量的名字應(yīng)該都大寫，并且指出完整含義。
參數(shù)的命名
參數(shù)的名字必須和變量的命名規(guī)范一致。
數(shù)組的命名
數(shù)組應(yīng)該總是用下面的方式來命名：

byte[] buffer;

而不是：

byte buffer[];

方法的參數(shù)
使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字段一樣的名字：

SetCounter(int size){
this.size = size;
}

Java 文件樣式
所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)則

版權(quán)信息
版權(quán)信息必須在 java 文件的開頭，比如：

/**
* Copyright ? 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/

其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。

Package/Imports
package 行要在 import 行之前，import 中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按
照字母順序排列。如果 import 行中包含了同一個(gè)包中的不同子目錄，則應(yīng)該用 * 來
處理。

package hotlava.net.stats;

import java.io.*;
import java.util.Observable;
import hotlava.util.Application;

這里 java.io.* 使用來代替InputStream and OutputStream 的。

Class
接下來的是類的注釋，一般是用來解釋類的。

/**
* A class representing a set of packet and byte counters
* It is observable to allow it to be watched, but only
* reports changes when the current set is complete
*/

接下來是類定義，包含了在不同的行的 extends 和 implements

public class CounterSet
extends Observable
implements Cloneable

Class Fields
接下來是類的成員變量：

/**
* Packet counters
*/
protected int[] packets;

public 的成員變量必須生成文檔（JavaDoc）。proceted、private和 package 定義
的成員變量如果名字含義明確的話，可以沒有注釋。

存取方法
接下來是類變量的存取的方法。它只是簡單的用來將類的變量賦值獲取值的話，可以簡
單的寫在一行上。

/**
* Get the counters
* @return an array containing the statistical data. This array has been
* freshly allocated and can be modified by the caller.
*/
public int[] getPackets() { return copyArray(packets, offset); }
public int[] getBytes() { return copyArray(bytes, offset); }

public int[] getPackets() { return packets; }
public void setPackets(int[] packets) { this.packets = packets; }

其它的方法不要寫在一行上

構(gòu)造函數(shù)
接下來是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫（比如：參數(shù)多的寫在后面）。
訪問類型 ("public", "private" 等.) 和任何 "static", "final" 或 "synchronized"
應(yīng)該在一行中，并且方法和參數(shù)另寫一行，這樣可以使方法和參數(shù)更易讀。

public
CounterSet(int size){
this.size = size;
}

克隆方法
如果這個(gè)類是可以被克隆的，那么下一步就是 clone 方法：

public
Object clone() {
try {
CounterSet obj = (CounterSet)super.clone();
obj.packets = (int[])packets.clone();
obj.size = size;
return obj;
}catch(CloneNotSupportedException e) {
throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage());
}
}

類方法
下面開始寫類的方法：

/**
* Set the packet counters
* (such as when restoring from a database)
*/
protected final
void setArray(int[] r1, int[] r2, int[] r3, int[] r4)
throws IllegalArgumentException
{
//
// Ensure the arrays are of equal size
//
if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
throw new IllegalArgumentException("Arrays must be of the same size");
System.arraycopy(r1, 0, r3, 0, r1.length);
System.arraycopy(r2, 0, r4, 0, r1.length);
}

toString 方法
無論如何，每一個(gè)類都應(yīng)該定義 toString 方法：

public
String toString() {
String retval = "CounterSet: ";
for (int i = 0; i < data.length(); i++) {
retval += data.bytes.toString();
retval += data.packets.toString();
}
return retval;
}
}

main 方法
如果main(String[]) 方法已經(jīng)定義了, 那么它應(yīng)該寫在類的底部.

代碼編寫格式

代碼樣式
代碼應(yīng)該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）
文檔化
必須用 javadoc 來為類生成文檔。不僅因?yàn)樗菢?biāo)準(zhǔn)，這也是被各種 java 編譯器都
認(rèn)可的方法。使用 @author 標(biāo)記是不被推薦的，因?yàn)榇a不應(yīng)該是被個(gè)人擁有的。
縮進(jìn)
縮進(jìn)應(yīng)該是每行2個(gè)空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具
時(shí)Tab字符將因?yàn)橛脩粼O(shè) 置的不同而擴(kuò)展為不同的寬度.
如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過如下操作來禁止
保存Tab字符, 方法是通過 UltrEdit中先設(shè)定 Tab 使用的長度室2個(gè)空格，然后用
Format|Tabs to Spaces 菜單將 Tab 轉(zhuǎn)換為空格。
頁寬
頁寬應(yīng)該設(shè)置為80字符. 源代碼一般不會(huì)超過這個(gè)寬度, 并導(dǎo)致無法完整顯示, 但這一設(shè)
置也可以靈活調(diào)整. 在任何情況下, 超長的語句應(yīng)該在一個(gè)逗號(hào)或者一個(gè)操作符后折行.
一條語句折行后, 應(yīng)該比原來的語句再縮進(jìn)2 個(gè)字符.
{} 對(duì)
{} 中的語句應(yīng)該單獨(dú)作為一行. 例如, 下面的第1行是錯(cuò)誤的, 第2行是正確的:

if (i>0) { i ++ }; // 錯(cuò)誤, { 和 } 在同一行

if (i>0) {
i ++
}; // 正確, { 單獨(dú)作為一行

} 語句永遠(yuǎn)單獨(dú)作為一行.

如果 } 語句應(yīng)該縮進(jìn)到與其相對(duì)應(yīng)的 { 那一行相對(duì)齊的位置。

括號(hào)
左括號(hào)和后一個(gè)字符之間不應(yīng)該出現(xiàn)空格, 同樣, 右括號(hào)和前一個(gè)字符之間也不應(yīng)該出
現(xiàn)空格. 下面的例子說明括號(hào)和空格的錯(cuò)誤及正確使用:

CallProc( AParameter ); // 錯(cuò)誤
CallProc(AParameter); // 正確

不要在語句中使用無意義的括號(hào). 括號(hào)只應(yīng)該為達(dá)到某種目的而出現(xiàn)在源代碼中。下面
的例子說明錯(cuò)誤和正確的用法:

if ((I) = 42) { // 錯(cuò)誤 - 括號(hào)毫無意義
if (I == 42) or (J == 42) then // 正確 - 的確需要括號(hào)

程序編寫規(guī)范

exit()
exit 除了在 main 中可以被調(diào)用外，其他的地方不應(yīng)該調(diào)用。因?yàn)檫@樣做不給任何代碼
代碼機(jī)會(huì)來截獲退出。一個(gè)類似后臺(tái)服務(wù)地程序不應(yīng)該因?yàn)槟骋粋€(gè)庫模塊決定了要退出
就退出。
異常
申明的錯(cuò)誤應(yīng)該拋出一個(gè)RuntimeException或者派生的異常。
頂層的main()函數(shù)應(yīng)該截獲所有的異常，并且打?。ɑ蛘哂涗浽谌罩局校┰谄聊簧稀?
垃圾收集
JAVA使用成熟的后臺(tái)垃圾收集技術(shù)來代替引用計(jì)數(shù)。但是這樣會(huì)導(dǎo)致一個(gè)問題：你必須在
使用完對(duì)象的實(shí)例以后進(jìn)行清場工作。比如一個(gè)prel的程序員可能這么寫：

...
{
FileOutputStream fos = new FileOutputStream(projectFile);
project.save(fos, "IDE Project File");
}
...

除非輸出流一出作用域就關(guān)閉，非引用計(jì)數(shù)的程序語言，比如JAVA，是不能自動(dòng)完成變
量的清場工作的。必須象下面一樣寫：

FileOutputStream fos = new FileOutputStream(projectFile);
project.save(fos, "IDE Project File");
fos.close();

Clone
下面是一種有用的方法：

implements Cloneable

public
Object clone()
{
try {
ThisClass obj = (ThisClass)super.clone();
obj.field1 = (int[])field1.clone();
obj.field2 = field2;
return obj;
} catch(CloneNotSupportedException e) {
throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage());
}
}

final 類
絕對(duì)不要因?yàn)樾阅艿脑驅(qū)㈩惗x為 final 的（除非程序的框架要求）
如果一個(gè)類還沒有準(zhǔn)備好被繼承，最好在類文檔中注明，而不要將她定義為 final 的。
這是因?yàn)闆]有人可以保證會(huì)不會(huì)由于什么原因需要繼承她。
訪問類的成員變量
大部分的類成員變量應(yīng)該定義為 protected 的來防止繼承類使用他們。
注意，要用"int[] packets"，而不是"int packets[]"，后一種永遠(yuǎn)也不要用。

public void setPackets(int[] packets) { this.packets = packets; }

CounterSet(int size)
{
this.size = size;
}

編程技巧

byte 數(shù)組轉(zhuǎn)換到 characters
為了將 byte 數(shù)組轉(zhuǎn)換到 characters，你可以這么做：

"Hello world!".getBytes();

Utility 類
Utility 類（僅僅提供方法的類）應(yīng)該被申明為抽象的來防止被繼承或被初始化。

初始化
下面的代碼是一種很好的初始化數(shù)組的方法：

objectArguments = new Object[] { arguments };

枚舉類型
JAVA 對(duì)枚舉的支持不好，但是下面的代碼是一種很有用的模板：

class Colour {
public static final Colour BLACK = new Colour(0, 0, 0);
public static final Colour RED = new Colour(0xFF, 0, 0);
public static final Colour GREEN = new Colour(0, 0xFF, 0);
public static final Colour BLUE = new Colour(0, 0, 0xFF);
public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);
}

這種技術(shù)實(shí)現(xiàn)了RED, GREEN, BLUE 等可以象其他語言的枚舉類型一樣使用的常量。
他們可以用 '==' 操作符來比較。
但是這樣使用有一個(gè)缺陷：如果一個(gè)用戶用這樣的方法來創(chuàng)建顏色 BLACK

new Colour(0,0,0)

那么這就是另外一個(gè)對(duì)象，'=='操作符就會(huì)產(chǎn)生錯(cuò)誤。她的 equal() 方法仍然有效。
由于這個(gè)原因，這個(gè)技術(shù) 的缺陷最好注明在文檔中，或者只在自己的包中使用。

Swing

避免使用 AWT 組件
混合使用 AWT 和 Swing 組件
如果要將 AWT 組件和 Swing 組件混合起來使用的話，請(qǐng)小心使用。實(shí)際上，盡量不
要將他們混合起來使用。

滾動(dòng)的 AWT 組件
AWT 組件絕對(duì)不要用 JscrollPane 類來實(shí)現(xiàn)滾動(dòng)。滾動(dòng) AWT 組件的時(shí)候一定要用
AWT ScrollPane 組件來實(shí) 現(xiàn)。

避免在 InternalFrame 組件中使用 AWT 組件
盡量不要這么做，要不然會(huì)出現(xiàn)不可預(yù)料的后果。

Z-Order 問題
AWT 組件總是顯示在 Swing 組件之上。當(dāng)使用包含 AWT 組件的 POP-UP 菜單的時(shí)候要
小心，盡量不要這樣使用。

調(diào)試

調(diào)試在軟件開發(fā)中是一個(gè)很重要的部分，存在軟件生命周期的各個(gè)部分中。調(diào)試能夠用
配置開、關(guān)是最基本的。

很常用的一種調(diào)試方法就是用一個(gè) PrintStream 類成員，在沒有定義調(diào)試流的時(shí)候就為
null，類要定義一個(gè) debug 方法來設(shè)置調(diào)試用的流。

性能

在寫代碼的時(shí)候，從頭至尾都應(yīng)該考慮性能問題。這不是說時(shí)間都應(yīng)該浪費(fèi)在優(yōu)化代碼上，
而是我們時(shí)刻應(yīng)該提醒自己要注意代碼的效率。比如：如果沒有時(shí)間來實(shí)現(xiàn)一個(gè)高效的
算法，那么我們應(yīng)該在文檔中記錄下來，以便在以后有空的時(shí)候再來實(shí)現(xiàn)她。

不是所有的人都同意在寫代碼的時(shí)候應(yīng)該優(yōu)化性能這個(gè)觀點(diǎn)的，他們認(rèn)為性能優(yōu)化的問題
應(yīng)該在項(xiàng)目的后期再去考慮，也就是在程序的輪廓已經(jīng)實(shí)現(xiàn)了以后。
不必要的對(duì)象構(gòu)造
不要在循環(huán)中構(gòu)造和釋放對(duì)象

使用 StringBuffer 對(duì)象
在處理 String 的時(shí)候要盡量使用 StringBuffer 類，StringBuffer 類是構(gòu)成 String 類
的基礎(chǔ)。String 類將 StringBuffer 類封裝了起來，（以花費(fèi)更多時(shí)間為代價(jià)）為開發(fā)
人員提供了一個(gè)安全的接口。當(dāng)我們?cè)跇?gòu)造字符串的時(shí)候，我們應(yīng)該用 StringBuffer
來實(shí)現(xiàn)大部分的工作，當(dāng)工作完成后將 StringBuffer 對(duì)象再轉(zhuǎn)換為需要的 String 對(duì)象。
比如：如果有一個(gè)字符串必須不斷地在其后添加許多字符來完成構(gòu)造，那么我們應(yīng)該使
用 StringBuffer 對(duì)象和她的 append() 方法。如果我們用 String 對(duì)象代替 StringBuffer
對(duì)象的話，會(huì)花費(fèi) 許多不必要的創(chuàng)建和釋放對(duì)象的 CPU 時(shí)間。

避免太多的使用 synchronized 關(guān)鍵字
避免不必要的使用關(guān)鍵字 synchronized，應(yīng)該在必要的時(shí)候再使用她，這是一個(gè)避免死
鎖的好方法。

可移植性
Borland Jbulider 不喜歡 synchronized 這個(gè)關(guān)鍵字，如果你的斷點(diǎn)設(shè)在這些關(guān)鍵字的
作用域內(nèi)的話，調(diào)試的時(shí)候你會(huì)發(fā)現(xiàn)的斷點(diǎn)會(huì)到處亂跳，讓你不知所措。除非必須，盡
量不要使用。

換行
如果需要換行的話，盡量用 println 來代替在字符串中使用" "。
你不要這樣：

System.out.print("Hello,world! ");

要這樣：

System.out.println("Hello,world!");

或者你構(gòu)造一個(gè)帶換行符的字符串，至少要象這樣：

String newline = System.getProperty("line.separator");
System.out.println("Hello world" + newline);

PrintStream
PrintStream 已經(jīng)被不贊成（deprecated）使用，用 PrintWrite 來代替她。[@more@]

向AI問一下細(xì)節(jié)

java開發(fā)規(guī)范

猜你喜歡

最新資訊

相關(guān)推薦

相關(guān)標(biāo)簽