【代碼規範】16條軍規

1、MyBatis 不要爲了多個查詢條件而寫 1 = 1

當遇到多個查詢條件，使用where 1=1 能夠很方便的解決咱們的問題，可是這樣極可能會形成很是大的性能損失，由於添加了 「where 1=1 」的過濾條件以後，數據庫系統就沒法使用索引等查詢優化策略，數據庫系統將會被迫對每行數據進行掃描（即全表掃描） 以比較此行是否知足過濾條件，當表中的數據量較大時查詢速度會很是慢；此外，還會存在SQL 注入的風險。

反例

<select id="queryBookInfo" parameterType="com.tjt.platform.entity.BookInfo" resultType="java.lang.Integer">
 select count(*) from t_rule_BookInfo t where 1=1
<if test="title !=null and title !='' ">
 AND title = #{title}
</if>
<if test="author !=null and author !='' ">
 AND author = #{author}
</if>
</select>

正例

<select id="queryBookInfo" parameterType="com.tjt.platform.entity.BookInfo" resultType="java.lang.Integer">
 select count(*) from t_rule_BookInfo t
<where>
<if test="title !=null and title !='' ">
 title = #{title}
</if>
<if test="author !=null and author !='' ">
 AND author = #{author}
</if>
</where>
</select>

UPDATE 操做也同樣，能夠用標記代替 1=1。

2、迭代entrySet() 獲取Map 的key 和value

反例

//Map 獲取value 反例:
HashMap<String, String> map = new HashMap<>();
for (String key : map.keySet()){
    String value = map.get(key);
}

 

正例

//Map 獲取key & value 正例:
HashMap<String, String> map = new HashMap<>();
for (Map.Entry<String,String> entry : map.entrySet()){
 String key = entry.getKey();
 String value = entry.getValue();
}

3、使用Collection.isEmpty() 檢測空

使用Collection.size() 來檢測是否爲空在邏輯上沒有問題，可是使用Collection.isEmpty() 使得代碼更易讀，而且能夠得到更好的性能；除此以外，任何Collection.isEmpty() 實現的時間複雜度都是O(1) ，不須要屢次循環遍歷，可是某些經過Collection.size() 方法實現的時間複雜度多是O(n)

反例

LinkedList<Object> collection = new LinkedList<>();
if (collection.size() == 0){
 System.out.println("collection is empty.");
}

正例

LinkedList<Object> collection = new LinkedList<>();
if (collection.isEmpty()){
    System.out.println("collection is empty.");
}

檢測是否爲null 可使用CollectionUtils.isEmpty()

//檢測是否爲null 可使用CollectionUtils.isEmpty()
if (CollectionUtils.isEmpty(collection)){
    System.out.println("collection is null.");
}

 

4、初始化集合時儘可能指定其大小

儘可能在初始化時指定集合的大小，能有效減小集合的擴容次數，由於集合每次擴容的時間複雜度極可能時O(n)，耗費時間和性能。
反例

Map<String, String> paramMap = new HashMap<>();
paramMap.put("parentPin", param.getParentPin());
paramMap.put("pin", param.getPin());

正例

Map<String, String> paramMap = new HashMap<>(16);
paramMap.put("parentPin", param.getParentPin());
paramMap.put("pin", param.getPin());

　　

5、使用StringBuilder 拼接字符串

通常的字符串拼接在編譯期Java 會對其進行優化，可是在循環中字符串的拼接Java 編譯期沒法執行優化，因此須要使用StringBuilder 進行替換。
反例：

//在循環中拼接字符串反例
String str = "";
for (int i = 0; i < 10; i++){
    //在循環中字符串拼接Java 不會對其進行優化
    str += i;
}

正例

//在循環中拼接字符串正例
String str1 = "Love";
String str2 = "Courage";
String strConcat = str1 + str2;  //Java 編譯器會對該普通模式的字符串拼接進行優化
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 10; i++){
   //在循環中，Java 編譯器沒法進行優化，因此要手動使用StringBuilder
    sb.append(i);
}

6、若需頻繁調用Collection.contains 方法則使用Set

在Java 集合類庫中，List的contains 方法廣泛時間複雜度爲O(n)，若代碼中須要頻繁調用contains 方法查找數據則先將集合list 轉換成HashSet 實現，將O(n) 的時間複雜度將爲O(1)。

 

反例

//頻繁調用Collection.contains() 反例
List<Object> list = new ArrayList<>();
for (int i = 0; i <= Integer.MAX_VALUE; i++){
    //時間複雜度爲O(n)
    if (list.contains(i))
    System.out.println("list contains "+ i);
}

　　

正例

/頻繁調用Collection.contains() 正例
List<Object> list = new ArrayList<>();
Set<Object> set = new HashSet<>();
for (int i = 0; i <= Integer.MAX_VALUE; i++){
    //時間複雜度爲O(1)
    if (set.contains(i)){
        System.out.println("list contains "+ i);
    }
}

　　

7、使用靜態代碼塊實現賦值靜態成員變量

對於集合類型的靜態成員變量，應該使用靜態代碼塊賦值，而不是使用集合實現來賦值。
反例

//賦值靜態成員變量反例
private static Map<String, Integer> map = new HashMap<String, Integer>(){
    {
        map.put("Leo",1);
        map.put("Family-loving",2);
        map.put("Cold on the out side passionate on the inside",3);
    }
};
private static List<String> list = new ArrayList<>(){
    {
        list.add("Sagittarius");
        list.add("Charming");
        list.add("Perfectionist");
    }
};

　　

正例

//賦值靜態成員變量正例
private static Map<String, Integer> map = new HashMap<String, Integer>();
static {
    map.put("Leo",1);
    map.put("Family-loving",2);
    map.put("Cold on the out side passionate on the inside",3);
}

private static List<String> list = new ArrayList<>();
static {
    list.add("Sagittarius");
    list.add("Charming");
    list.add("Perfectionist");
}

　　

8、刪除未使用的局部變量、方法參數、私有方法、字段和多餘的括號。

 

9、工具類中屏蔽構造函數

工具類是一堆靜態字段和函數的集合，其不該該被實例化；可是，Java 爲每一個沒有明肯定義構造函數的類添加了一個隱式公有構造函數，爲了不沒必要要的實例化，應該顯式定義私有構造函數來屏蔽這個隱式公有構造函數。
反例

public class PasswordUtils {
//工具類構造函數反例
private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);

public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES";

public static String encryptPassword(String aPassword) throws IOException {
    return new PasswordUtils(aPassword).encrypt();
}

　　

正例

public class PasswordUtils {
//工具類構造函數正例
private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);

//定義私有構造函數來屏蔽這個隱式公有構造函數
private PasswordUtils(){}

public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES";

public static String encryptPassword(String aPassword) throws IOException {
    return new PasswordUtils(aPassword).encrypt();
}

　　

10、刪除多餘的異常捕獲並拋出

用catch 語句捕獲異常後，若什麼也不進行處理，就只是讓異常從新拋出，這跟不捕獲異常的效果同樣，能夠刪除這塊代碼或添加別的處理。
反例

//多餘異常反例
private static String fileReader(String fileName)throws IOException{

    try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {
        String line;
        StringBuilder builder = new StringBuilder();
        while ((line = reader.readLine()) != null) {
            builder.append(line);
        }
        return builder.toString();
    } catch (Exception e) {
        //僅僅是重複拋異常 未做任何處理
        throw e;
    }
}

　　

正例

//多餘異常正例
private static String fileReader(String fileName)throws IOException{

    try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {
        String line;
        StringBuilder builder = new StringBuilder();
        while ((line = reader.readLine()) != null) {
            builder.append(line);
        }
        return builder.toString();
        //刪除多餘的拋異常，或增長其餘處理：
        /*catch (Exception e) {
            return "fileReader exception";
        }*/
    }
}

11、字符串轉化使用String.valueOf(value) 代替 " " + value

把其它對象或類型轉化爲字符串時，使用String.valueOf(value) 比 ""+value 的效率更高。
反例

//把其它對象或類型轉化爲字符串反例：
int num = 520;
// "" + value
String strLove = "" + num;

　　

正例

//把其它對象或類型轉化爲字符串正例：
int num = 520;
// String.valueOf() 效率更高
String strLove = String.valueOf(num);

　　

12、避免使用BigDecimal(double)

BigDecimal(double) 存在精度損失風險，在精確計算或值比較的場景中可能會致使業務邏輯異常。
反例

// BigDecimal 反例
BigDecimal bigDecimal = new BigDecimal(0.11D);

正例

// BigDecimal 正例
BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);

十3、返回空數組和集合而非 null

若程序運行返回null，須要調用方強制檢測null，不然就會拋出空指針異常；返回空數組或空集合，有效地避免了調用方由於未檢測null 而拋出空指針異常的狀況，還能夠刪除調用方檢測null 的語句使代碼更簡潔。
反例

//返回null 反例
public static Result[] getResults() {
    return null;
}

public static List<Result> getResultList() {
    return null;
}

public static Map<String, Result> getResultMap() {
    return null;
}

　　

正例

//返回空數組和空集正例
public static Result[] getResults() {
    return new Result[0];
}

public static List<Result> getResultList() {
    return Collections.emptyList();
}

public static Map<String, Result> getResultMap() {
    return Collections.emptyMap();
}

　　

十4、優先使用常量或肯定值調用equals 方法

對象的equals 方法容易拋空指針異常，應使用常量或肯定有值的對象來調用equals 方法。
反例

//調用 equals 方法反例
private static boolean fileReader(String fileName)throws IOException{

 // 可能拋空指針異常
 return fileName.equals("Charming");
}

　　

正例

//調用 equals 方法正例
private static boolean fileReader(String fileName)throws IOException{

    // 使用常量或肯定有值的對象來調用 equals 方法
    return "Charming".equals(fileName);

    //或使用：java.util.Objects.equals() 方法
   return Objects.equals("Charming",fileName);
}

　　

十5、枚舉的屬性字段必須是私有且不可變

枚舉一般被當作常量使用，若是枚舉中存在公共屬性字段或設置字段方法，那麼這些枚舉常量的屬性很容易被修改；理想狀況下，枚舉中的屬性字段是私有的，並在私有構造函數中賦值，沒有對應的Setter 方法，最好加上final 修飾符。
反例

public enum SwitchStatus {
    // 枚舉的屬性字段反例
    DISABLED(0, "禁用"),
    ENABLED(1, "啓用");

    public int value;
    private String description;

    private SwitchStatus(int value, String description) {
        this.value = value;
        this.description = description;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

　　

正例

public enum SwitchStatus {
    // 枚舉的屬性字段正例
    DISABLED(0, "禁用"),
    ENABLED(1, "啓用");

    // final 修飾
    private final int value;
    private final String description;

    private SwitchStatus(int value, String description) {
        this.value = value;
        this.description = description;
    }

    // 沒有Setter 方法
    public int getValue() {
        return value;
    }

    public String getDescription() {
        return description;
    }
}

　　

十6、tring.split(String regex)部分關鍵字須要轉譯

使用字符串String 的plit 方法時，傳入的分隔字符串是正則表達式，則部分關鍵字（好比 .| 等）須要轉義。
反例

// String.split(String regex) 反例
String[] split = "a.ab.abc".split(".");
System.out.println(Arrays.toString(split));   // 結果爲[]

String[] split1 = "a|ab|abc".split("|");
System.out.println(Arrays.toString(split1));  // 結果爲["a", "|", "a", "b", "|", "a", "b", "c"]

　　

正例

// String.split(String regex) 正例
// . 須要轉譯
String[] split2 = "a.ab.abc".split("\\.");
System.out.println(Arrays.toString(split2));  // 結果爲["a", "ab", "abc"]

// | 須要轉譯
String[] split3 = "a|ab|abc".split("\\|");
System.out.println(Arrays.toString(split3));  // 結果爲["a", "ab", "abc"]