什麼樣的代碼是好代碼？金秋十月，讀阿里JAVA開發手冊有感而發

時間 2019-11-06

標籤什麼樣代碼金秋十月 10月阿里 java 開發手冊有感而發欄目阿里巴巴简体版

原文原文鏈接

前言

最近重溫阿里巴巴Java開發手冊這本書，思考了什麼樣的代碼是好代碼，給你們分享一下個人想法，有哪裏不對，歡迎指出，感激涕零。java

什麼樣的代碼是好代碼？

什麼是好代碼？實現了功能的代碼只是合格的代碼，而真正的好代碼具備如下特色：數據庫

命名易於理解，語義表達清晰而不需人揣摩
代碼邏輯清晰透明，井井有條
代碼格式公整美觀
性能效率高
安全性高

好的命名

好的命名，命名易於理解，語義表達清晰。是醞釀好代碼的第一步。如下列舉阿里JAVA開發手冊的幾點，都是在強調好的命名，以便於閱讀。編程

抽象類命名使用 Abstract 或 Base 開頭；異常類命名使用 Exception 結尾；測試類命名以它要測試的類的名稱開始，以 Test 結尾。

理由：你們約定俗成這樣寫，閱讀者一看這個類就知道它是抽象類仍是異常類，豈不美哉。設計模式

推薦指數：五星緩存

杜絕徹底不規範的縮寫，避免望文不知義。

理由：AbstractClass「縮寫」命名成 AbsClass；condition「縮寫」命名成 condi，此類隨意縮寫嚴重下降了代碼的可閱讀性安全

推薦指數：五星性能優化

爲了達到代碼自解釋的目標，任何自定義編程元素在命名時，使用盡可能完整的單詞組合來表達其意

正例：在 JDK 中，表達原子更新的類名爲：AtomicReferenceFieldUpdater。bash

反例：變量 int a 的隨意命名方式架構

理由：完整的單詞，表達意思更清楚。框架

推薦指數：四星

若是模塊、接口、類、方法使用了設計模式，在命名時需體現出具體模式。

正例：

public class OrderFactory;     
   public class LoginProxy;      
   public class ResourceObserver;
複製代碼

理由：將設計模式體如今名字中，有利於閱讀者快速理解架構設計理念。

推薦指數：四星

不容許任何魔法值（即未經預先定義的常量）直接出如今代碼中。

反例：

String key = "Id#taobao_" + tradeId;      
cache.put(key, value); 
複製代碼

理由：魔法值只有開發者本身知道，或者過一段時間他本身也不知道了。。。還談何維護。。。

推薦指數：五星

枚舉類名建議帶上 Enum 後綴，枚舉成員名稱須要全大寫，單詞間用下劃線隔開。

正例：枚舉名字爲 ProcessStatusEnum 的成員名稱：SUCCESS / UNKNOWN_REASON。

理由：枚舉其實就是特殊的類，域成員均爲常量，且構造方法被默認強制是私有。

推薦指數：三星

清晰的結構，分明的層次，明瞭的邏輯

好的代碼，還表如今清晰的結構，分明的層次，明瞭的邏輯。不只表如今代碼功能層明上，代碼塊、函數各司其職，符合設計模式設計理念，還表如今項目結構輪廓分明。列舉了如下幾點：

不要使用一個常量類維護全部常量，要按常量功能進行歸類，分開維護。

正例：緩存相關常量放在類 CacheConsts 下，系統配置相關常量放在類 ConfigConsts 下。

理由：大而全的常量類，雜亂無章，使用查找功能才能定位到修改的常量，不利於理解和維護。

推薦指數：四星

一個過於冗長的函數或者一段須要註釋才能讓人理解用途的代碼，能夠考慮把它切分紅一個功能明確的函數單元，並定義清晰簡短的函數名，這樣會讓代碼變得更加優雅。

反例：

private String name;
    private Vector<Order> orders = new Vector<Order>();

    public void printOwing() {
        //print banner
        System.out.println("****************");
        System.out.println("*****customer Owes *****");
        System.out.println("****************");

        //calculate totalAmount
        Enumeration env = orders.elements();
        double totalAmount = 0.0;
        while (env.hasMoreElements()) {
            Order order = (Order) env.nextElement();
            totalAmount += order.getAmout();
        }

        //print details
        System.out.println("name:" + name);
        System.out.println("amount:" + totalAmount);
    }

複製代碼

正例：

private String name;
    private Vector<Order> orders = new Vector<Order>();

    public void printOwing() {
        
        //print banner
        printBanner();
        //calculate totalAmount
        double totalAmount = getTotalAmount();
        //print details
        printDetail(totalAmount);
    }

    void printBanner(){
        System.out.println("****************");
        System.out.println("*****customer Owes *****");
        System.out.println("****************");
    }

    double getTotalAmount(){
        Enumeration env = orders.elements();
        double totalAmount = 0.0;
        while (env.hasMoreElements()) {
            Order order = (Order) env.nextElement();
            totalAmount += order.getAmout();
        }
        return totalAmount;
    }

    void printDetail(double totalAmount){
        System.out.println("name:" + name);
        System.out.println("amount:" + totalAmount);
    }
複製代碼

推薦指數：四星

使用多態或者適當的設計模式替代複雜冗長的if...else/switch

好比：

int getArea() {
        switch (shape){
        case SHAPE.CIRCLE:
        return 3.14 * _r * _r; break;
        case SHAPE.RECTANGEL;
        return width *,heigth;
        }
    }
複製代碼

使用多態後：

class Shape {
        int getArea(){};
    }

    class Circle extends Shape {
        int getArea() {
            return 3.14 * r * r; 
        }
    }

    class Rectangel extends Shape {
        int getArea() {
            return width * heigth;
        }
    }

複製代碼

推薦指數：三星