《Effective JavaJava》名著，必讀。如果能嚴(yán)格遵從本文的原則，以編寫API的質(zhì)量來苛求自己的代碼，會大大提升編碼素質(zhì)。

以下內(nèi)容只記錄了我自己整理的東西，還是建議讀原文。為了聚焦知識點，一些說明故意忽略掉了。相當(dāng)于是一篇摘要。

1、考慮用靜態(tài)工廠方法替代構(gòu)造函數(shù)

例子：

Integer.valueOf(“1”)、Boolean.valueOf(“true”)等。

優(yōu)勢：

• 可讀性高（方法名）
• 性能（不一定創(chuàng)建對象）
• 靈活性高

下面針對三個優(yōu)勢進(jìn)行一些解讀。

可讀性高

new Point(x,y)和Point.at(x,y)、Point.origin()。構(gòu)造函數(shù)只能看出兩個參數(shù)，不知其意，后者更易理解。

性能

在某些情況下，可以事先進(jìn)行實例化一些對象，調(diào)用時直接調(diào)用即可，不需要進(jìn)行改變。比如，Boolean。

public final class Boolean implements Serializable, Comparable<Boolean> {
    // 預(yù)先設(shè)置兩個對象
    public static final Boolean TRUE = new Boolean(true);
    public static final Boolean FALSE = new Boolean(false);

    public Boolean(boolean var1) {
        this.value = var1;
    }

    public Boolean(String var1) {
        this(parseBoolean(var1));
    }

    // 工廠方法
    public static Boolean valueOf(boolean var0) {
        return var0?TRUE:FALSE;    // 返回預(yù)先設(shè)置的對象，而不是創(chuàng)建對象
    }
    // 工廠方法
    public static Boolean valueOf(String var0) {
        return parseBoolean(var0)?TRUE:FALSE;
    }
    // ... other code
}

靈活性高

可根據(jù)具體情況，返回子類。相當(dāng)于更強大的工廠。直接從父類獲取到子類。尤其適用于工具類（提供各種API）。例子：Collections。

public class Collections {
    // 私有，典型工廠
    private Collections() {
    }

    public static final List EMPTY_LIST = new EmptyList<>();
    // 工廠方法
    public static final <T> List<T> emptyList() {
        return (List<T>) EMPTY_LIST;
    }
    private static class EmptyList<E> extends AbstractList<E> implements RandomAccess, Serializable {
    // code
    }

    // 工廠方法
    public static <E> List<E> checkedList(List<E> list, Class<E> type) {
    // 根據(jù)具體情況，獲取相應(yīng)子類
        return (list instanceof RandomAccess ?
                new CheckedRandomAccessList<>(list, type) :
                new CheckedList<>(list, type));
    }

    // 子類1
    static class CheckedRandomAccessList<E> extends CheckedList<E> implements RandomAccess {
        CheckedRandomAccessList(List<E> list, Class<E> type) {
            super(list, type);
        }

        public List<E> subList(int fromIndex, int toIndex) {
            return new CheckedRandomAccessList<>(
                    list.subList(fromIndex, toIndex), type);
        }
    }

    // 子類2
    static class CheckedList<E> extends CheckedCollection<E> implements List<E> {
    // code
    }
}

2、多個構(gòu)造函數(shù)時，考慮使用構(gòu)造器

尤其在進(jìn)行Android開發(fā)時，會碰到這種情況。通常是一個對象，具有多個成員變量可能需要初始化，常規(guī)方法，需要提供大量構(gòu)造函數(shù)。例如：

// 非Android中的AlertDialog，便于說明問題，舉個例子
public class AlertDialog {
    private int width;
    private int height;
    private String title;
    private String confirmText;
    private String denyText;

    private AlertDialog(){}
    public AlertDialog(int width, int height){    // 空白的警告框
         AlertDialog(width,height,null);
    }

    // 帶標(biāo)題的警告框
    public AlertDialog(int width, int height, String title){    // 帶標(biāo)題的警告框
        AlertDialog(width, height, title, "確定");
    }

    // 帶標(biāo)題的警告框，有確定按鈕
    public AlertDialog(int width, int height, String title, String confirm){   
        AlertDialog(width, height, title, confirm, null);
    }

    // 帶標(biāo)題的警告框，有確定按鈕，取消按鈕
    public AlertDialog(int width, int height, String title, String confirm, String denyText){
        // set every thing.
    }
}

有多種樣式的警告框，為了調(diào)用方便，必須提供多個構(gòu)造函數(shù)。否則用戶在調(diào)用時，只能使用完整構(gòu)造函數(shù)，容易犯錯且無法進(jìn)行閱讀。極不靈活。如果采用另外一種方式，則可以解決，但會花費很多經(jīng)歷處理并發(fā)的情況:

// 非Android中的AlertDialog，便于說明問題，舉個例子
public class AlertDialog {
    private int width;
    private int height;
    private String title;
    private String confirmText;
    private String denyText;

    public AlertDialog(){}// 空白的構(gòu)造函數(shù)
   
    public void setWidth(int width){
        this.width = width;
    }
    // 其他set方法
}

調(diào)用時，通過調(diào)用各個參數(shù)的set方法進(jìn)行設(shè)置。問題來了：

1. 并發(fā)
2. 無法進(jìn)行參數(shù)校驗。例如，只創(chuàng)建了對象，設(shè)置了標(biāo)題，卻沒有尺寸，相當(dāng)于創(chuàng)建了一個沒有尺寸的警告框。

在Android中，大量的控件都使用了構(gòu)造器Builder。

// 非Android中的AlertDialog，便于說明問題，舉個例子
public class AlertDialog {
    private int width;
    private int height;
    private String title;
    private String confirmText;
    private String denyText;

    // private
    private AlertDialog(){}

    // Builder中使用
    protected AlertDialog(Builder b){
        width = b.width;
        height = b.height;
        // .....
        if(width==0||height==0) throws new Exception("size must be set");
    }

    // 構(gòu)造器
    public static class Builder {
        private int width;
        private int height;
        private String title;
        private String confirmText;
        private String denyText;

        // 注意：返回的Builder。
        public Builder setTitle(String title) {
            this.title = title;
            return this;
        }
        // 其他set...
        
        public AlertDialog build(){
            return AlertDialog(this);
        }
    }
}

于是，可以根據(jù)相應(yīng)需求，進(jìn)行相應(yīng)設(shè)置，并在AlertDialog真正構(gòu)造時，進(jìn)行參數(shù)校驗。就像這樣：

new AlertDialog.Builder().setTitle("提示").build();

上述例子，會成功拋出異常。

3、用私有化構(gòu)造器或者枚舉型強化Singleton。

Singleton指最多會被實例化一次的類。通常情況下，以前的做法是沒有問題的。但是在某些高級情況，通過使用反射的相關(guān)知識訪問private的構(gòu)造函數(shù)，破壞Singleton。

public class Elvis{
    // 注意，公有final對象
    public static final Elvis INSTANCE = new Elvis();
    private Elvis(){}
}

另一種情況，在序列化的過程中，反序列化得到的對象已經(jīng)不再是以前的對象（破壞了Singleton），這種情況下，可以通過單元素枚舉型處理。

public enum Elvis{
    INSTANCE;
    // some methods
}

4、通過私有化構(gòu)造器強化不可實例化的能力

有一些工具類，僅僅是提供一些能力，自己本身不具備任何屬性，所以，不適合提供構(gòu)造函數(shù)。然而，缺失構(gòu)造函數(shù)編譯器會自動添加上一個無參的構(gòu)造器。所以，需要提供一個私有化的構(gòu)造函數(shù)。為了防止在類內(nèi)部誤用，再加上一個保護(hù)措施和注釋。

public class Util{
    private Util(){
        // 拋出異常，防止內(nèi)部誤調(diào)用
        throw new AssertionError();
    }
}

弊端是無法對該類進(jìn)行繼承（子類會調(diào)用super()）。

5、避免創(chuàng)建不必要的對象

• 對象的重用
• 昂貴的對象，使用對象池
• 廉價的對象，慎用對象池?，F(xiàn)代JVM對廉價對象的創(chuàng)建和銷毀非常快，此時不適于使用對象池。

6、消除過期的對象引用

以下三種情況可能會造成內(nèi)存泄露：

• 自己管理的內(nèi)存（數(shù)組長度減小后，pop出的對象容易導(dǎo)致內(nèi)存泄漏）
• 緩存
• 監(jiān)聽和回調(diào)

自己管理的內(nèi)存

對于自己管理的內(nèi)存要小心，比如：

public class Stack{
    private Object[] elements;
    private int size = 0;
    private static final int DEFAULT_INITIAL_CAPACITY = 16;
    
    public Stack(){
         elements = new Object[DEFAULT_INITIAL_CAPACITY];
    }

    public void push(Object e){
        ensureCapacity();
        elements[size++]=e;    // allocate新的堆內(nèi)存和棧內(nèi)存
    }

    public Object pop(){
        if(size==0) throw new EmptyStackException();
        return element[--size];    // pop出element[size]，該對象不再有效。內(nèi)存泄漏原因。
    }
    
    private void ensureCapacity(){
        if(elements.length==size)
            elements = Arrays.copyOf(elements, 2*size+1);
    }
}

彈出的對象不再有效，但JVM不知道，所以會一直保持該對象，造成內(nèi)存泄露。

解決：

public Object pop(){
    if(size==0) throw new EmptyStackException();
    elements[size] = null;        // 等待回收
    return element[--size];
}

緩存

緩存的對象容易被程序員遺忘，需要設(shè)置機(jī)制來維護(hù)緩存，例如不定期回收不再使用的緩存（使用定時器）。某些情況下，使用WeakHashMap可以達(dá)到緩存回收的功效。注，只有緩存依賴于外部環(huán)境，而不是依賴于值時，WeakHashMap才有效。

監(jiān)聽或回調(diào)

使用監(jiān)聽和回調(diào)要記住取消注冊。確?；厥盏淖詈玫膶崿F(xiàn)是使用弱引用（weak reference），例如，只將他們保存成WeakHashMap的鍵。

7、避免顯示調(diào)用GC

Java的GC有強大的回收機(jī)制，可以簡單的記?。翰灰@示調(diào)用finalizer?？梢赃@樣理解：

jvm是針對具體的硬件設(shè)計的，然而程序卻不是針對具體硬件設(shè)計的，所以，java代碼無法很好的解決gc問題（因為他具有平臺差異化）。另外，finalizer的性能開銷也非常大，從這個角度上考慮也不應(yīng)該使用它。

8、覆蓋equals方法請遵守通用約定

• 自反性。x.equals(x) == true
• 對稱性。當(dāng)前僅當(dāng)y.equals(x)==true時，x.equals(y)==true
• 傳遞性。if(x.equals(y)&&y.equals(z))，y.equals(z)==true
• 一致性。
• 非空性。x.equals(null)==false

9、覆蓋equals方法時總要覆蓋hashCode

為了保證基于散列的集合使用該類（HashMap、HashSet、HashTable），同時，也是Object.hashCode的通用約定，覆蓋equals方法時，必須覆蓋hashCode。

10、始終覆蓋toString

Object的toString方法的通用約定是該對象的描述。注意覆蓋時，如果有格式，請備注或者嚴(yán)格按照格式返回。

11、謹(jǐn)慎覆蓋clone

12、考慮實現(xiàn)Comparable接口

13、使類和成員的可訪問性最小化

目的是解耦。簡單來講，使用修飾符的優(yōu)先級從大到小，private>protected>default(缺省)>public。如果在設(shè)計之初，設(shè)計為private修飾符后，在之后的編碼過程如果不得不擴(kuò)大其作用于，應(yīng)該先檢查是否設(shè)計的確如此。

子類覆蓋超類，不允許訪問級別低于超類的訪問級別。（超類的protected，子類覆蓋后不能改為default）。

成員變量決不允許是公有的。一旦設(shè)置為公有，則放棄了對他處理的能力。這種類并不是線程安全的。即使是final的，也不允許。除非希望通過public static final來暴露常量。成員變量總是需要使用setter和getter來維護(hù)。有一個例外：長度非零的數(shù)組。這是安全漏洞的一個根源。

// 安全漏洞！此處的數(shù)組，并不是不可變的
public static final Thing[] VALUES = {...}

改進(jìn)：

private static final Thing[] PRIVATE_VALUES = {...}
// 此時獲取到的才是“常量”
public static final List<Thing> VALUS = 
    Collections.unmodifiableList(Arrays.asList(PRIVATE_VALUES))

另一種：

private static final Thing[] PRIVATE_VALUES = {...}
// 此時獲取到的才是“常量”
public static final Thing[] values(){
    return PRIVATE_VALUES.clone();
}

14、在公有類中使用訪問方法而非公有成員變量（類似13）

15、使可變性最小化

16、復(fù)合優(yōu)先于繼承

繼承有利于代碼復(fù)用，但是盡可能不要進(jìn)行跨包的繼承。包內(nèi)的繼承是優(yōu)秀的設(shè)計方式，一個包里的文件處在同一個程序員的控制之下。但是繼承有其局限性：子類依賴于超類。超類一旦發(fā)生更改，將可能破壞子類。并且，如果超類是有缺陷的，子類也會得“遺傳病”。

復(fù)合，即不擴(kuò)展已有的類，而是在的類中新增一個現(xiàn)有類的。相當(dāng)于現(xiàn)有類作為一個組建存在于新類中。如此，將只會用到需要用到的東西，而不表現(xiàn)現(xiàn)有類所有的方法和成員變量。新類也可以稱為“包裝類”，也就是設(shè)計模式中的Decorate模式。

17、要么就為繼承而設(shè)計，并提供文檔說明，要么就禁止繼承

18、接口優(yōu)于抽象類

19、接口只用于定義類型

20、類層次優(yōu)先于標(biāo)簽類

21、用函數(shù)對象表示策略

函數(shù)參數(shù)可以傳入類似listener的對象，目的是使用listener中的方法。如果使用匿名的參數(shù)，每一次調(diào)用會創(chuàng)建新的對象。可以將listener聲明為成員變量，每次都復(fù)用同一個對象，并且可以使用靜態(tài)域（static變量）。比如String類的CASE_INSENSITIVE_ORDER域。

關(guān)注公眾號【程序員白楠楠】獲取2020年末總結(jié)面試資料一套！

考慮靜態(tài)類成員

嵌套類的目的應(yīng)該只是為了他的外圍類提供服務(wù)，如果以后還可能用于其他環(huán)境中，則應(yīng)該設(shè)計為頂層類。靜態(tài)類相當(dāng)于一個普通的外部類，只是恰好聲明在了一個類內(nèi)部。通常的用戶是：Calculator.Operation.PLUS等。和普通類的區(qū)別只是，在PLUS前，有了2個前綴，來表明其含義。而非靜態(tài)類必須存在于外部類對象中。不要手動在外部創(chuàng)建一個內(nèi)部非靜態(tài)類對象，創(chuàng)建的過程是：instance.New MemberClass()。這非常奇怪。

如果成員類不需要訪問外圍類，則需要添加static，是他成為靜態(tài)成員類，否則每個實例都將包含一個額外指向外圍對象的引用。將會影響垃圾回收機(jī)制。

23、應(yīng)指定泛型的具體類型，而不是直接使用原生類型。

例如，應(yīng)該指定List<E>，而不建議直接使用List。

24、消除非首檢警告

在使用IDE進(jìn)行編碼時，強大的IDE都會在你編碼過程中提示warning，需要盡可能的消除warning，至少，應(yīng)該小心這些warning。慎用SuppresWarning，如果IDE提示你可以通過添加該注解解決掉warning，請不要那么做。如果實在要使用，請?zhí)砑幼⑨屨f明原因。

25、列表優(yōu)先于數(shù)組

類比泛型，數(shù)組是有一定缺陷的。List和List是沒有關(guān)系的，而Sub[]是Super[]的子類。

// Fails at runtime
Object[] objectArray = new Long[1];
objectArray[0] = "I don't fit in";       // throw exception

// won't compile
List<Object> ol = new ArrayList<Long>();   // Incompatible types
ol.add("I don't fit in");

從代碼中可以看到，使用泛型，會提前發(fā)現(xiàn)錯誤。

26、優(yōu)先考慮泛型

27、優(yōu)先考慮泛型方法

28、利用有限制通配符來提升API的靈活性

PECS，producer-extends，consumer-super。

//public class Stack<E>{
//    public Stack();
//    public void push(E e);
//    public E pop();
//    public boolean isEmpty();
//}

public void pushAll(Iterator<? extends E> src){
    for(E e : src)
        push(e);
}

public void popAll(Collection<? super E> dst){
    while(!isEmpty()){
        dst.add(pop());
    }
}

// Get and Put Principle

所有comparable和comparator都是消費者（Consumer）。

29、優(yōu)先考慮類型安全的異構(gòu)容器

30、用enum代替int常量

public enum Apple { FUJI, PIPPIN, GRANNY_SMITH }
public enum Orange { NAVEL, TEMPLE, BLOOD }

枚舉型在java中非常強大，當(dāng)需要一組固定常量時，使用enum比int好很多。比如代碼可讀性，安全性等。

31、enum用實例域代替序數(shù)

// bad solution
public enum Ensemble {
    SOLO, DUET, TRIO, QUARTET, QUINTET, 
    SEXTET, SEPTET, OCTET, NONET, DECTET;

    public int numberOfMusicians() { return ordinal() + 1; }
}
// 

// improvement
public enum Ensemble {
    SOLO(1), DUET(2), TRIO(3), QUARTET(4), QUINTET(5), 
    SEXTET(6), SEPTET(7), OCTET(8), NONET(9), DECTET(10), TRIPLE_QUARTET(12);

    private final int numberOfMusicians;
    Ensemble(int size) { this.numberOfMusicians = size; }
    public int numberOfMusicians() { return numberOfMusicians; }
}

永遠(yuǎn)不要像第一種的方式，利用序數(shù)訪問enum，需要在構(gòu)造函數(shù)中使用參數(shù)來初始化。

32、用EnumSet代替位域

public class Text{
    public static final int STYLE_BOLD                     = 1 << 0;    // 1
    public static final int STYLE_ITALIC                    = 1 << 1;    // 2
    public static final int STYLE_UNDERLINE          = 1 << 2;    // 4
    public static final int STYLE_STRIKETHROUGH = 1 << 3;    // 8

    public void applyStyles(int styles){  
        // ...
    }
}



// 
text.applyStyles(STYLE_BOLD | STYLE_ITALIC);

以上叫做位圖法，但是有更好的方案來傳遞多組常量——EnumSet。

public class Text{
    public enum Style { BOLD, ITALIC, UNDERLINE, STRIKETHROUGH }

    // 注意此處，使用的是Set而不是EnumSet
    public void applyStyles(Set<Style> styles){  
        // ...
    }
}



// 
text.applyStyles(EnumSet.of(Style.BOLD, Style.ITALIC));

33、用EnumMap代替序數(shù)索引

任何時候都不要使用enum的ordinal()方法。

34、用接口模擬可伸縮的枚舉

35、注解優(yōu)先于命名模式

36、堅持使用Override注解

37、檢查參數(shù)的有效性

公有方法檢查參數(shù)，參數(shù)異常需要跑出Exception。私有方法利用斷言assertion檢查參數(shù)。

38、必要時進(jìn)行保護(hù)性拷貝

假設(shè)類的客戶端會盡其所能來破壞這個類的約束條件，因此你必須保護(hù)性的設(shè)計程序。以下是一個不可變類的設(shè)計。

public Period(Date start, Date end){
    this.start  = new Date(start);        // 使用了值的拷貝，沒有使用原對象（指針）
    this.end = new Date(end);
    if(this.start.compareTo(this.end)>0)
        throw new IllegalArgumentException(start + " after " + end)
}

注意：保護(hù)性拷貝是在檢查參數(shù)之前進(jìn)行的，防止多線程的影響。不要使用clone方法進(jìn)行保護(hù)性拷貝。

以上方法防御了傳入?yún)?shù)的修改，但是對于get方法獲取到的對象，仍然可以被修改，通過以下方法可以防止這種攻擊。

public Date start(){
    return new Date(start);
}

public Date end(){
    return new Date(end);
}

39、謹(jǐn)慎設(shè)計方法簽名

40、慎用重載

41、慎用可變參數(shù)

42、返回0長度的數(shù)組或者集合，而不是null

null一般用于表示沒有被初始化或處理，如果方法返回了null，則需要在上層做更多的處理，以防止NPE。

43、為所有導(dǎo)出的API元素編寫文檔注釋

正確的javadoc文檔，需要每個被導(dǎo)出的類、接口、構(gòu)造器、方法和域之前增加文檔注釋。注釋應(yīng)該是對實現(xiàn)透明的，只需要簡潔的描述它和客戶端之間的約定。并且，還應(yīng)該附上該方法的副作用。

44、將局部變量的作用域最小化

45、for-each優(yōu)先于for循環(huán)

for-each規(guī)避掉了for循環(huán)的index變量的引用，通常來說它是不必要的——會增加引入錯誤的風(fēng)險，并且風(fēng)險一旦發(fā)生，很難被發(fā)現(xiàn)。不過有三種情況下，無法使用for-each（注：在jdk1.8中已經(jīng)很好的解決了這些問題）。

• 過濾
• 轉(zhuǎn)換
• 平行迭代

46、如果需要精確的答案，請避免使用float和double

float和double是執(zhí)行的二進(jìn)制浮點運算，目的是在廣泛數(shù)值范圍上使用精確的快速近似計算而設(shè)計的。然而他們并沒有提供完全精確的計算（實際應(yīng)用中，經(jīng)常會碰到出現(xiàn)x.99999等結(jié)果）。尤其是，在進(jìn)行貨幣計算時，他們并不適用。比如：

System.out.println(1.03-.42);

得到的結(jié)果將是：0.610000000001。

為了解決這個問題，需要使用BigDecimal。然而這也有一些問題，相對于普通的運算，它顯得更加麻煩，而且也更慢。通常來說后一個缺點可以忽略，但是前者可能會讓人很不舒服。有一種做法是將需要處理的數(shù)值*10(或更多），使用int進(jìn)行計算，不過需要你自己處理四舍五入等操作。

47、基本類型優(yōu)先于裝箱基本類型

• 基本類型只有值，裝箱類具有與他們值不同的同一性。
• 基本類型只有功能完備的值，裝箱類還具有非功能值：null。所以你可能會碰到NPE
• 基本類型省空間省時間

48、如果有更精確的類型，請避免使用字符串

• 字符串不適合代替其他值的類型。例如：int，boolean等
• 不適合代替枚舉類型（第30條）
• 不適合聚集類型

49、當(dāng)心字符串連接的性能

操作符“+”可以將多個字符串進(jìn)行連接。但是在大規(guī)模使用“+”的情況下，連接n個字符串的開銷是n的平房級時間。這是由于字符串的不可變性導(dǎo)致的。在這種情況下請使用StringBuilder進(jìn)行連接。

50、通過接口引用對象