《阿里巴巴 Java開發手冊》讀後感

時間 2019-11-08

標籤阿里巴巴 Java開發手冊讀後感欄目阿里巴巴简体版

原文原文鏈接

前言

只有光頭才能變強

前一陣子一直在學Redis，結果在黃金段位被虐了，暫時升不了段位了，天天都拿不到首勝(好煩)。java

趁着學校校運會，合理地給本身放了一個小長假，而後就回家了。回到家才發現當時618買了一堆書，這堆書還有沒撕包裝的呢....因而我翻出了最薄的一本《阿里巴巴 Java開發手冊》git

這本書一共就90多頁，一天就能夠通讀完了，看完以後我又來水博文了。程序員

注意：github

書上不少的規範是能夠用IDE來避免的，也有不少以前已經知道的了。
因此，這篇文章只記錄我認爲比較重要，或者說是我以前開發時沒有注意到的一些規範(知識點)。
該文章的內容確定沒有書上寫得那麼全的，若是感興趣的同窗能夠去買一原本讀一下~

PDF官方地址：算法

https://github.com/alibaba/p3c

1、Java相關

POJO是DO/DTO/BO/VO的統稱，禁止命名爲xxxPOJO
獲取多個對象的方法中list做爲前綴
獲取統計值的方法用count做爲前綴
POJO類中的布爾類型(Boolean)的變量都不要加is前綴，不然部分框架解析會引發序列化錯誤sql
- 若是你的變量名帶is的話，好比isActive，框架解析的時候可能就當成active了。
若是是形容能力的接口名稱，取對應的形容詞爲接口名(一般是-able的形式)
不容許任何魔法值(未經預先定義的常量)直接出如今代碼中
Object的euqals方法容易拋出空指針異常，應使用常量或者有值的對象來調用equals。推薦使用java.util.Object#equals工具類
全部POJO類的屬性所有使用包裝數據類型，RPC的返回值和參數必須使用包裝數據類型，全部的局部變量都使用基本數據類型。定義VO/DTO/DO等POJO類時，不要設定任何屬性的默認值數據庫
- 若是你的類屬性使用int這樣的基本數據類型，默認值是0。通常狀況下該變量沒有賦值，通常想表達的是不存在(null)，而不是0。
構造方法禁止加入任何的業務邏輯，若是初始化邏輯能夠放在init方法中。set/get方法也不要增長業務邏輯。編程
- 若是set/get方法放入業務邏輯，有時候排查問題就變得很麻煩了
工具類Arrays.asList()把數組轉成List時，不能使用其修改集合的相關方法。好比說add、clear、remove
在JDK7以及以上版本中，Comparator要知足三個條件，否則調用Arrays.sort()或者Collections.sort()會報異常。數組
- x，y 的比較結果和 y，x 的比較結果相反
- 傳遞性：x>y而且y>z，那麼x必定大於z
- 對稱性：x=y,則 x,z 比較結果和y，z比較結果相同
使用entrySet遍歷Map類集合K/V，而不是用keySet方式遍歷安全
- keySet遍歷了兩次，一次是轉成Iterator對象，一次是從hashMap中取出key所對應的value，若是JDK8可使用Map.foreach方法
線程資源必須由線程池提供，不容許在應用中自行顯示建立線程。線程池不容許用Executors建立，經過ThreadPoolExecutor的方式建立，這樣的處理方式可以讓編寫代碼的工程師更加明確線程池的運行規則，規避資源耗盡的風險。
SimpleDateFormat是線程不安全的類，通常不要定義爲static變量，若是定義爲static，必須加鎖，或者使用DateUtils工具類
- 若是是JDK8應用，可使用Instant(針對時間統計等場景)代替Date，LocalDateTime代替Calendar，DateTimeFormatter代替SimpleDateFormat
避免Random實例被多線程使用，雖然共享該實例是線程安全的，但會因競爭同一seed致使性能降低
- 在JDK7以後，能夠直接使用API ThreadLocalRandom，而在JDK7 以前，須要編碼保證每一個線程持有一個實例。
類、類屬性、類方法的註釋必須使用 Javadoc 規範，使用 /**內容*/ 格式，不得使用 //xxx 方式
全部的抽象方法（包括接口中的方法）必需要用 Javadoc 註釋，除了返回值、參數、異常說明外，還必須指出該方法作什麼事情，實現什麼功能。全部的類都必須添加建立者和建立日期。
對於暫時被註釋掉，後續可能恢復使用的代碼片段，在註釋代碼的上方，使用三個斜槓///來講明註釋代碼的理由
保證單元測試的獨立性。爲了保證單元測試穩定可靠且便於維護，單元測試之間不能互相調用，也不能依賴執行的前後順序。
高併發服務器建議調小TCP協議的time_await超時時間，調大最大事件句柄數(fd)，

1.1值得說明的點

1、不容許任何魔法值(未經預先定義的常量)直接出如今代碼中

例子：

Negative example:
    //Magic values, except for predefined, are forbidden in coding.
    if (key.equals("關注公衆號：Java3y")) {
        //...
    }

    Positive example:
    String KEY_PRE = "關注公衆號：Java3y";
    if (KEY_PRE.equals(key)) {
        //...
    }

ps:我猜是把先常量定義出來，後續引用/修改的時候就很方便了。

2、Object的euqals方法容易拋出空指針異常，應使用常量或者有值的對象來調用equals。推薦使用java.util.Object#equals工具類

java.util.Object#equals的源碼(已經判斷null的狀況了)

public static boolean equals(Object a, Object b) {
        return (a == b) || (a != null && a.equals(b));
    }

3、工具類Arrays.asList()把數組轉成List時，不能使用其修改集合的相關方法。

由於返回的ArrayList是一個內部類，並無實現集合的修改方法。後臺的數據還是數組，這裏體現的是適配器模式。

4、在JDK7以及以上版本中，Comparator要知足自反性，傳遞性，對稱性，否則調用Arrays.sort()或者Collections.sort()會報異常。

The implementor must ensure that sgn(compare(x, y)) == -sgn(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)
The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z.

1） x，y 的比較結果和 y，x 的比較結果相反。
2）傳遞性：x>y,y>z,則 x>z。
3）對稱性：x=y,則 x,z 比較結果和 y，z 比較結果相同。

反例：下例中沒有處理相等的狀況，實際使用中可能會出現異常：

new Comparator<Student>() {
    @Override
    public int compare(Student o1, Student o2) {
        return o1.getId() > o2.getId() ? 1 : -1;
    }
}

使用entrySet遍歷Map類集合K/V，而不是用keySet方式遍歷

首先咱們來看一下使用keySet是如何遍歷HashMap的：

public static void main(String[] args) throws InterruptedException {

        HashMap<String, String> hashMap = new HashMap<>();
        hashMap.put("關注公衆號:", "Java3y");
        hashMap.put("堅持原創", "Java3y");
        hashMap.put("點贊", "關注，轉發，分享");


        // 獲得keySet，遍歷keySet獲得全部的key
        Set<String> strings = hashMap.keySet();
        Iterator<String> iterator = strings.iterator();
        while (iterator.hasNext()) {

            // HashMap的每一個key
            String key = iterator.next();

            // 經過key能夠得到對應的value，若是有看過HashMap的同窗知道get方法的時間複雜度是O(1)
            System.out.println("key = " + key + ", value = " + hashMap.get(key));
        }

    }

再來看一下源碼：

// 1. 獲得keySet，若是不存在，則建立
public Set<K> keySet() {
    Set<K> ks = keySet;
    if (ks == null) {
        ks = new KeySet();
        keySet = ks;
    }
    return ks;
}

// 2.初始化ks (實際上就是Set集合[HashMap的內部類]，在初始化時須要順便初始化iterator)
ks = new AbstractSet<K>() {
    public Iterator<K> iterator() {
        return new Iterator<K>() {
            private Iterator<Entry<K,V>> i = entrySet().iterator();

            public boolean hasNext() {
                return i.hasNext();
            }

            public K next() {
                return i.next().getKey();
            }

            public void remove() {
                i.remove();
            }
        };
    }

};

再來看一下entrySet，能夠直接拿到key和value，不用再使用get方法來獲得value，因此比keySet更加推薦使用！

public static void main(String[] args) throws InterruptedException {

        HashMap<String, String> hashMap = new HashMap<>();
        hashMap.put("關注公衆號:", "Java3y");
        hashMap.put("堅持原創", "Java3y");
        hashMap.put("點贊", "關注，轉發，分享");


        // 獲得entrySet，遍歷entrySet獲得結果
        Set<Map.Entry<String, String>> entrySet = hashMap.entrySet();
        Iterator<Map.Entry<String, String>> iterator = entrySet.iterator();
        while (iterator.hasNext()) {
            Map.Entry<String, String> entry = iterator.next();
            System.out.println("key = " + entry.getKey() + ", value = " + entry.getValue());
        }
    }

若是是JDK8的話，推薦直接使用Map.forEach()就行了，咱們也來看看用法：

public static void main(String[] args) throws InterruptedException {

    HashMap<String, String> hashMap = new HashMap<>();
    hashMap.put("關注公衆號:", "Java3y");
    hashMap.put("堅持原創", "Java3y");
    hashMap.put("點贊", "關注，轉發，分享");

    
    // forEach用法
    hashMap.forEach((key, value) -> System.out.println("key = " + key + ", value = " + value));
}

其實在源碼裏邊咱們能夠發現，forEach實際上就是封裝了entrySet，提供forEach給咱們能夠更加方便地遍歷Map集合

// forEach源碼
    default void forEach(BiConsumer<? super K, ? super V> action) {
        Objects.requireNonNull(action);
        for (Map.Entry<K, V> entry : entrySet()) {
            K k;
            V v;
            try {
                k = entry.getKey();
                v = entry.getValue();
            } catch(IllegalStateException ise) {
                // this usually means the entry is no longer in the map.
                throw new ConcurrentModificationException(ise);
            }
            action.accept(k, v);
        }
    }

5、SimpleDateFormat是線程不安全的類，通常不要定義爲static變量，若是定義爲static，必須加鎖，或者使用DateUtils工具類。

有如下的例子能夠正確使用SimpleDateFormat：

// 1. 在方法內部使用，沒有線程安全問題
private static final String FORMAT = "yyyy-MM-dd HH:mm:ss";
public String getFormat(Date date){
    SimpleDateFormat dateFormat = new SimpleDateFormat(FORMAT);
    return dateFormat.format(date);
}


// 2. 每次使用的時候加鎖      
private static final SimpleDateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
public void getFormat(){
    synchronized (SIMPLE_DATE_FORMAT){
    SIMPLE_DATE_FORMAT.format(new Date());
    ….;
}
        
// 3. 使用ThreadLocal，每一個線程都有本身的SimpleDateFormat對象，互不干擾
private static final ThreadLocal<DateFormat> DATE_FORMATTER = new ThreadLocal<DateFormat>() {
    @Override
    protected DateFormat initialValue() {
        return new SimpleDateFormat("yyyy-MM-dd");
    }
};

// 4. 使用DateTimeFormatter(This class is immutable and thread-safe.)

    DateTimeFormatter timeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
    System.out.println(timeFormatter.format(LocalDateTime.now()));

若是是JDK8應用，可使用Instant代替Date，LocalDateTime代替Calendar，DateTimeFormatter代替SimpleDateFormat。

2、數據庫相關

表達是否概念的字段，必須使用isxxx的方式命名，數據類型是unsigned tinyint(1表示是，0表示否)
小數類型用decimal，禁止使用float和double。
varchar是可變字符串，不預選分配存儲空間的話，長度不要超過5000個字符。若是超過則用text，獨立一張表，用主鍵對應，避免影響到其餘字段的索引效率。
表必備的三個字段：id(類型是unsigned bigint)，gmt_create(建立時間)，gme_modified(修改時間)
字段容許適當冗餘，以提升查詢性能，但必須考慮數據一致性。冗餘的字段必須不是頻繁修改的字段，不是varhar超長字段(更不能是text字段)。
單錶行數超過500萬行或者單表容量超過2GB才推薦進行分庫分表(若是預計三年都達不到這個數據量，不要在建立表的時候就分庫分表!)
超過三個表禁止使用join，須要join的字段，數據類型必須保持一致，當多表關聯查詢時，保證被關聯的字段須要有索引！
在varchar字段上創建索引時，必須指定索引長度，不必對全字段創建索引，頁面搜索嚴禁左模糊或者全模糊，若是須要則經過搜索引擎來解決。
- 充分利用好最左前綴匹配特性！
利用延遲關聯或者子查詢優化超多也分場景。
若是有全球化須要，均以utf-8編碼。若是須要存儲表情，選擇utf8mb4進行存儲。

2.1值得說明的點

1、利用延遲關聯或者子查詢優化超多也分場景。

MySQL並非跳過 offset行，而是取 offset+N行，而後返回放棄前offset行，返回N行，那當 offset特別大的時候，效率就很是的低下，要麼控制返回的總頁數，要麼對超過特定閾值的頁數進行SQL改寫。

例子：

// 優化前

SELECT id, cu_id, name, info, biz_type
    , gmt_create, gmt_modified, start_time, end_time, market_type
    , back_leaf_category, item_status, picuture_url
FROM relation
WHERE biz_type = '0'
    AND end_time >= '2014-05-29'
ORDER BY id ASC
LIMIT 149420, 20;


// 優化後

SELECT a.*
FROM relation a, (
        SELECT id
        FROM relation
        WHERE biz_type = '0'
            AND end_time >= '2014-05-29'
        ORDER BY id ASC
        LIMIT 149420, 20
    ) b
WHERE a.id = b.id

解釋：其實這裏就是經過使用覆蓋索引查詢返回須要的主鍵,再根據主鍵關聯原表得到須要的數據。這樣就是充分利用了索引！

3、未解決的問題

在看《手冊》的時候還有一些知識點沒看過、沒實踐過、涉及到的知識點比較多的，在這裏先mark一下，後續再遇到或者有空的時候再回來補坑~

使用CountDownLatch進行異步轉同步操做，每一個線程退出前必須調用 countDown方法，線程執行代碼注意 catch 異常，確保 countDown 方法被執行到，避免主線程沒法執行至 await 方法，直到超時才返回結果。說明：注意，子線程拋出異常堆棧，不能在主線程 try-catch 到。
對於一寫多讀，是能夠解決變量同步問題，可是若是多寫，一樣沒法解決線程安全問題。若是是 count++操做，使用以下類實現: AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 若是是 JDK8，推薦使用 LongAdder 對象，比 AtomicLong 性能更好(減小樂觀鎖的重試次數)。
使用JDK8的Optional類來防止NPE問題。

固然了，若是你有比較好的資料閱讀，也能夠在評論區告訴我。我也會mark住好好看看。

好比說：「3y，我發現Optional類有篇文章寫得很不錯，url是xxxx(書籍的名稱是xxx)

因爲如今沒有必定的經驗積累，因此如下的章節得回頭看：