这样规范写代码,同事直呼“666”

开发 后端
本文介绍了十六项如何规范的写出代码,我们一起来看一下吧。

[[344095]]

一、MyBatis 不要为了多个查询条件而写 1 = 1

当遇到多个查询条件,使用where 1=1 可以很方便的解决我们的问题,但是这样很可能会造成非常大的性能损失,因为添加了 “where 1=1 ”的过滤条件之后,数据库系统就无法使用索引等查询优化策略,数据库系统将会被迫对每行数据进行扫描(即全表扫描) 以比较此行是否满足过滤条件,当表中的数据量较大时查询速度会非常慢;此外,还会存在SQL 注入的风险。

反例: 

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

正例: 

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

UPDATE 操作也一样,可以用标记代替 1=1。

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

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

反例: 

  1. //Map 获取value 反例:  
  2. HashMap<String, String> map = new HashMap<>();  
  3. for (String key : map.keySet()){  
  4.     String value = map.get(key);  

正例: 

  1. //Map 获取key & value 正例:  
  2. HashMap<String, String> map = new HashMap<>();  
  3. for (Map.Entry<String,String> entry : map.entrySet()){  
  4.  String key = entry.getKey();  
  5.  String value = entry.getValue();  

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

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

反例: 

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

正例: 

  1. LinkedList<Object> collection = new LinkedList<>();  
  2. if (collection.isEmpty()){  
  3.     System.out.println("collection is empty.");  
  4.  
  5. //检测是否为null 可以使用CollectionUtils.isEmpty()  
  6. if (CollectionUtils.isEmpty(collection)){ 
  7.      System.out.println("collection is null.");  

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

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

反例: 

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

正例: 

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

五、使用StringBuilder 拼接字符串

一般的字符串拼接在编译期Java 会对其进行优化,但是在循环中字符串的拼接Java 编译期无法执行优化,所以需要使用StringBuilder 进行替换。

反例: 

  1. //在循环中拼接字符串反例  
  2. String str = "" 
  3. for (int i = 0; i < 10; i++){  
  4.     //在循环中字符串拼接Java 不会对其进行优化  
  5.     str += i;  

正例: 

  1. //在循环中拼接字符串正例  
  2. String str1 = "Love" 
  3. String str2 = "Courage" 
  4. String strConcat = str1 + str2;  //Java 编译器会对该普通模式的字符串拼接进行优化  
  5. StringBuilder sb = new StringBuilder();  
  6. for (int i = 0; i < 10; i++){  
  7.    //在循环中,Java 编译器无法进行优化,所以要手动使用StringBuilder  
  8.    &nbsp;sb.append(i);  

六、若需频繁调用Collection.contains 方法则使用Set

在Java 集合类库中,List的contains 方法普遍时间复杂度为O(n),若代码中需要频繁调用contains 方法查找数据则先将集合list 转换成HashSet 实现,将O(n) 的时间复杂度将为O(1)。

反例: 

  1. //频繁调用Collection.contains() 反例  
  2. List<Object> list = new ArrayList<>();  
  3. for (int i = 0; i <= Integer.MAX_VALUE; i++){  
  4.     //时间复杂度为O(n)  
  5.     if (list.contains(i))  
  6.     System.out.println("list contains "+ i);  

正例: 

  1. //频繁调用Collection.contains() 正例  
  2. List<Object> list = new ArrayList<>();  
  3. Set<Object> set = new HashSet<>();  
  4. for (int i = 0; i <= Integer.MAX_VALUE; i++){  
  5.     //时间复杂度为O(1)  
  6.     if (set.contains(i)){  
  7.         System.out.println("list contains "+ i);  
  8.     }  

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

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

反例: 

  1. //赋值静态成员变量反例 
  2.  private static Map<String, Integer> map = new HashMap<String, Integer>(){  
  3.     {  
  4.         map.put("Leo",1);  
  5.         map.put("Family-loving",2);  
  6.         map.put("Cold on the out side passionate on the inside",3);  
  7.     }  
  8. }; 
  9.  private static List<String> list = new ArrayList<>(){  
  10.     {  
  11.         list.add("Sagittarius");  
  12.         list.add("Charming");  
  13.         list.add("Perfectionist");  
  14.     }  
  15. }; 

正例: 

  1. //赋值静态成员变量正例  
  2. private static Map<String, Integer> map = new HashMap<String, Integer>();  
  3. static {  
  4.     map.put("Leo",1);  
  5.     map.put("Family-loving",2);  
  6.     map.put("Cold on the out side passionate on the inside",3);  
  7.  
  8. private static List<String> list = new ArrayList<>(); 
  9.  static {  
  10.     list.add("Sagittarius");  
  11.     list.add("Charming");  
  12.     list.add("Perfectionist");  

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

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

工具类是一堆静态字段和函数的集合,其不应该被实例化;但是,Java 为每个没有明确定义构造函数的类添加了一个隐式公有构造函数,为了避免不必要的实例化,应该显式定义私有构造函数来屏蔽这个隐式公有构造函数。

反例: 

  1. public class PasswordUtils {  
  2. //工具类构造函数反例  
  3. private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);  
  4. public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES"
  5. public static String encryptPassword(String aPassword) throws IOException {  
  6.     return new PasswordUtils(aPassword).encrypt();  

正例: 

  1. public class PasswordUtils {  
  2. //工具类构造函数正例  
  3. private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);  
  4. //定义私有构造函数来屏蔽这个隐式公有构造函数  
  5. private PasswordUtils(){} 
  6. public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES" 
  7. public static String encryptPassword(String aPassword) throws IOException {  
  8.     return new PasswordUtils(aPassword).encrypt();  

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

用catch 语句捕获异常后,若什么也不进行处理,就只是让异常重新抛出,这跟不捕获异常的效果一样,可以删除这块代码或添加别的处理。

反例: 

  1. //多余异常反例  
  2. private static String fileReader(String fileName)throws IOException{  
  3.     try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {  
  4.         String line;  
  5.         StringBuilder builder = new StringBuilder();  
  6.         while ((line = reader.readLine()) != null) {  
  7.             builder.append(line);  
  8.         }  
  9.         return builder.toString();  
  10.     } catch (Exception e) {  
  11.         //仅仅是重复抛异常 未作任何处理  
  12.         throw e;  
  13.     }  

正例: 

  1. //多余异常正例  
  2. private static String fileReader(String fileName)throws IOException{  
  3.     try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {  
  4.         String line;  
  5.         StringBuilder builder = new StringBuilder();  
  6.         while ((line = reader.readLine()) != null) {  
  7.             builder.append(line);  
  8.         }  
  9.         return builder.toString();  
  10.         //删除多余的抛异常,或增加其他处理:  
  11.         /*catch (Exception e) {  
  12.             return "fileReader exception";  
  13.         }*/  
  14.     }  

十一、字符串转化使用String.valueOf(value) 代替 " " + value

把其它对象或类型转化为字符串时,使用String.valueOf(value) 比 ""+value 的效率更高。

反例: 

  1. //把其它对象或类型转化为字符串反例:  
  2. int num = 520 
  3. // "" + value  
  4. String strLove = "" + num; 

正例: 

  1. //把其它对象或类型转化为字符串正例:  
  2. int num = 520 
  3. // String.valueOf() 效率更高  
  4. String strLove = String.valueOf(num); 

十二、避免使用BigDecimal(double)

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

反例: 

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

正例: 

  1. // BigDecimal 正例  
  2. BigDecimal bigDecimalbigDecimal1 = bigDecimal.valueOf(0.11D); 

十三、返回空数组和集合而非 null

若程序运行返回null,需要调用方强制检测null,否则就会抛出空指针异常;返回空数组或空集合,有效地避免了调用方因为未检测null 而抛出空指针异常的情况,还可以删除调用方检测null 的语句使代码更简洁。

反例: 

  1. //返回null 反例  
  2. public static Result[] getResults() {  
  3.     return null; 
  4.   
  5. public static List<Result> getResultList() {  
  6.     return null;  
  7.  
  8. public static Map<String, Result> getResultMap() {  
  9.     return null;  

正例: 

  1. //返回空数组和空集正例  
  2. public static Result[] getResults() {  
  3.     return new Result[0];  
  4.  
  5. public static List<Result> getResultList() {  
  6.     return Collections.emptyList();  
  7.  
  8. public static Map<String, Result> getResultMap() {  
  9.     return Collections.emptyMap();  

十四、优先使用常量或确定值调用equals 方法

对象的equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals 方法。

反例: 

  1. //调用 equals 方法反例  
  2. private static boolean fileReader(String fileName)throws IOException{  
  3.  // 可能抛空指针异常 
  4.   return fileName.equals("Charming");  

正例: 

  1. //调用 equals 方法正例  
  2. private static boolean fileReader(String fileName)throws IOException{  
  3.     // 使用常量或确定有值的对象来调用 equals 方法  
  4.     return "Charming".equals(fileName);   
  5.     //或使用:java.util.Objects.equals() 方法  
  6.    return Objects.equals("Charming",fileName);  

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

枚举通常被当做常量使用,如果枚举中存在公共属性字段或设置字段方法,那么这些枚举常量的属性很容易被修改;理想情况下,枚举中的属性字段是私有的,并在私有构造函数中赋值,没有对应的Setter 方法,最好加上final 修饰符。

反例: 

  1. public enum SwitchStatus {  
  2.     // 枚举的属性字段反例  
  3.     DISABLED(0, "禁用"),  
  4.     ENABLED(1, "启用");  
  5.     public int value;  
  6.     private String description;  
  7.     private SwitchStatus(int value, String description) {  
  8.         this.value = value;  
  9.         this.description = description;  
  10.     }  
  11.     public String getDescription() {  
  12.         return description;  
  13.     }  
  14.     public void setDescription(String description) {  
  15.         this.description = description;  
  16.     }  

正例: 

  1. public enum SwitchStatus {  
  2.     // 枚举的属性字段正例  
  3.     DISABLED(0, "禁用"),  
  4.     ENABLED(1, "启用");  
  5.     // final 修饰  
  6.     private final int value;  
  7.     private final String description;  
  8.     private SwitchStatus(int value, String description) {  
  9.         this.value = value;  
  10.         this.description = description;  
  11.     }  
  12.     // 没有Setter 方法  
  13.     public int getValue() {  
  14.         return value;  
  15.     }  
  16.     public String getDescription() {  
  17.         return description;  
  18.     }  

十六、tring.split(String regex)部分关键字需要转译

使用字符串String 的plit 方法时,传入的分隔字符串是正则表达式,则部分关键字(比如 .[]()| 等)需要转义。

反例: 

  1. // String.split(String regex) 反例  
  2. String[] split = "a.ab.abc".split(".");  
  3. System.out.println(Arrays.toString(split));   // 结果为[]  
  4. String[] split1 = "a|ab|abc".split("|");  
  5. System.out.println(Arrays.toString(split1));  // 结果为["a", "|", "a", "b", "|", "a", "b", "c"] 

正例: 

  1. // String.split(String regex) 正例  
  2. // . 需要转译  
  3. String[] split2 = "a.ab.abc".split("\\.");  
  4. System.out.println(Arrays.toString(split2));  // 结果为["a", "ab", "abc"]  
  5. // | 需要转译  
  6. String[] split3 = "a|ab|abc".split("\\|");  
  7. System.out.println(Arrays.toString(split3));  // 结果为["a", "ab", "abc"]  

 

责任编辑:庞桂玉 来源: Java知音
相关推荐

2021-07-20 06:37:33

CTO代码程序员

2020-09-24 11:10:05

Python代码字符串

2020-02-20 10:45:57

代码JS开发

2022-05-07 07:33:55

TypeScript条件类型

2022-04-29 06:54:48

TS 映射类型User 类型

2022-06-08 08:01:28

模板字面量类型

2022-03-23 08:01:04

Python语言代码

2022-12-20 08:32:02

2020-03-20 08:00:32

代码程序员追求

2021-04-27 07:52:19

StarterSpring Boot配置

2017-07-07 16:57:35

代码Python

2017-06-26 09:40:50

Python代码写法

2021-10-26 08:40:33

String Java面试题

2021-03-02 20:01:08

写代码开发工具idea

2022-04-11 08:20:36

编程辅助工具GitHubCopilot

2021-07-06 07:21:17

桥接模式组合

2021-03-28 16:55:11

Python工具链代码

2022-03-04 06:46:30

Python代码

2015-07-02 11:20:17

程序员代码

2020-03-06 11:30:08

JavaGitHub编程
点赞
收藏

51CTO技术栈公众号