如何更规范化编写Java 代码

Many of the happiest people are those who own the least. But are we really so happy with our IPhones, our big houses, our fancy cars?

忘川如斯，拥有一切的人才更怕失去。

背景：如何更规范化编写Java 代码的重要性想必毋需多言，其中最重要的几点当属提高代码性能、使代码远离Bug、令代码更优雅。

一、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 操作也一样，可以用<set> 标记代替 1=1。

二、 迭代entrySet() 获取Map 的key 和value

当循环中只需要获取Map 的主键key时，迭代keySet() 是正确的；但是，当需要主键key 和取值value 时，迭代entrySet() 才是更高效的做法，其比先迭代keySet() 后再去通过get 取值性能更佳。

反例：

//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();
}

三、使用Collection.isEmpty() 检测空

使用Collection.size() 来检测是否为空在逻辑上没有问题，但是使用Collection.isEmpty() 使得代码更易读，并且可以获得更好的性能；除此之外，任何Collection.isEmpty() 实现的时间复杂度都是O(1) ，不需要多次循环遍历，但是某些通过Collection.size() 方法实现的时间复杂度可能是O(n)。O(1)纬度减少循环次数 例子

反例：

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()
if (CollectionUtils.isEmpty(collection)){
         System.out.println("collection is null.");
}

四、初始化集合时尽量指定其大小

尽量在初始化时指定集合的大小，能有效减少集合的扩容次数，因为集合每次扩容的时间复杂度很可能时O(n)，耗费时间和性能。

反例：

//初始化list，往list 中添加元素反例：
int[] arr = new int[]{1,2,3,4};
List<Integer> list = new ArrayList<>(); 
for (int i : arr){
    list.add(i); 
 }

正例：

//初始化list，往list 中添加元素正例：
int[] arr = new int[]{1,2,3,4};
// 指定集合list 的容量大小
List<Integer> list = new ArrayList<>(arr.length);
for (int i : arr){
    list.add(i);
}

五、使用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); 
}

六、若需频繁调用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);
   }
}

七、使用静态代码块实现赋值静态成员变量

  对于集合类型的静态成员变量，应该使用静态代码块赋值，而不是使用集合实现来赋值。

反例：

//赋值静态成员变量反例
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");
}

八、删除未使用的局部变量、方法参数、私有方法、字段、import包和多余的括号。

九、工具类中屏蔽构造函数

工具类是一堆静态字段和函数的集合，其不应该被实例化；但是，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();
}

十、删除多余的异常捕获并跑出

用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"; 
      }
}

十一、字符串转化使用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);

十二、避免使用BigDecimal(double), 使用BigDecimal(String)

BigDecimal(double) 存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。

反例：

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

正例：

// BigDecimal 正例
// 看源码得知 valueOf() 方法中使用的是Double.toString(Double)方法
BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);
image

十三、返回空数组和集合而非 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;
}
***正例：***
 ```java
//返回空数组和空集正例
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();
}

十四、优先使用常量或确定值调用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);
}

十五、枚举的属性字段必须是私有且不可变

枚举通常被当做常量使用，如果枚举中存在公共属性字段或设置字段方法，那么这些枚举常量的属性很容易被修改；理想情况下，枚举中的属性字段是私有的，并在私有构造函数中赋值，没有对应的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; 
      } 
 }

十六、string.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"]

图2. String.split(String regex) 正反例

image

*转载于： https://www.cnblogs.com/taojietaoge/p/11575376.html

文章自荐

IntelliJ IDEA如何正确地使用git
一文详解微服务架构(好文值得细读)
高级Java开发人员最常访问的几个网站
15款好用超赞的chrome插件， 开发者们的必备~

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,544评论 6赞 501
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,430评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,764评论 0赞 353
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,193评论 1赞 292
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,216评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,182评论 1赞 299
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,063评论 3赞 418
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,917评论 0赞 274
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,329评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2赞 332
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,425评论 5赞 343
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,019评论 3赞 326
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1赞 269
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2赞 353