关于Java一些习惯用法的总结

简介:

关于Java习惯用法的总结


在Java编程中,有些知识 并不能仅通过语言规范或者标准API文档就能学到的。在本文中,我会尽量收集一些最常用的习惯用法,特别是很难猜到的用法。(Joshua Bloch的《Effective Java》对这个话题给出了更详尽的论述,可以从这本书里学习更多的用法。)

我把本文的所有代码都放在公共场所里。你可以根据自己的喜好去复制和修改任意的代码片段,不需要任何的凭证。

实现equals()


 
 
  1. class Person { 
  2.   String name
  3.   int birthYear; 
  4.   byte[] raw; 
  5.  
  6.   public boolean equals(Object obj) { 
  7.     if (!obj instanceof Person) 
  8.       return false
  9.  
  10.     Person other = (Person)obj; 
  11.     return name.equals(other.name
  12.         && birthYear == other.birthYear 
  13.         && Arrays.equals(raw, other.raw); 
  14.   } 
  15.  
  16.   public int hashCode() { ... } 
  17. }  
  • 参数必须是Object类型,不能是外围类。
  • foo.equals(null) 必须返回false,不能抛NullPointerException。(注意,null instanceof 任意类 总是返回false,因此上面的代码可以运行。)
  • 基本类型域(比如,int)的比较使用 == ,基本类型数组域的比较使用Arrays.equals()。
  • 覆盖equals()时,记得要相应地覆盖 hashCode(),与 equals() 保持一致。
  • 参考: java.lang.Object.equals(Object)

实现hashCode()


 
 
  1. class Person { 
  2.   String a; 
  3.   Object b; 
  4.   byte c; 
  5.   int[] d; 
  6.  
  7.   public int hashCode() { 
  8.     return a.hashCode() + b.hashCode() + c + Arrays.hashCode(d); 
  9.   } 
  10.  
  11.   public boolean equals(Object o) { ... } 
  12. }  
  • 当x和y两个对象具有x.equals(y) == true ,你必须要确保x.hashCode() == y.hashCode()。
  • 根据逆反命题,如果x.hashCode() != y.hashCode(),那么x.equals(y) == false 必定成立。
  • 你不需要保证,当x.equals(y) == false时,x.hashCode() != y.hashCode()。但是,如果你可以尽可能地使它成立的话,这会提高哈希表的性能。
  • hashCode()最简单的合法实现就是简单地return 0;虽然这个实现是正确的,但是这会导致HashMap这些数据结构运行得很慢。
  • 参考:java.lang.Object.hashCode()

实现compareTo()


 
 
  1. class Person implements Comparable<Person> { 
  2.   String firstName; 
  3.   String lastName; 
  4.   int birthdate; 
  5.  
  6.   // Compare by firstName, break ties by lastName, finally break ties by birthdate 
  7.   public int compareTo(Person other) { 
  8.     if (firstName.compareTo(other.firstName) != 0) 
  9.       return firstName.compareTo(other.firstName); 
  10.     else if (lastName.compareTo(other.lastName) != 0) 
  11.       return lastName.compareTo(other.lastName); 
  12.     else if (birthdate < other.birthdate) 
  13.       return -1; 
  14.     else if (birthdate > other.birthdate) 
  15.       return 1; 
  16.     else 
  17.       return 0; 
  18.   } 
  19. }  
  • 总是实现泛型版本 Comparable 而不是实现原始类型 Comparable 。因为这样可以节省代码量和减少不必要的麻烦。
  • 只关心返回结果的正负号(负/零/正),它们的大小不重要。
  • Comparator.compare()的实现与这个类似。
  • 参考:java.lang.Comparable

实现clone()


 
 
  1. class Values implements Cloneable { 
  2.   String abc; 
  3.   double foo; 
  4.   int[] bars; 
  5.   Date hired; 
  6.  
  7.   public Values clone() { 
  8.     try { 
  9.       Values result = (Values)super.clone(); 
  10.       result.bars = result.bars.clone(); 
  11.       result.hired = result.hired.clone(); 
  12.       return result; 
  13.     } catch (CloneNotSupportedException e) {  // Impossible 
  14.       throw new AssertionError(e); 
  15.     } 
  16.   } 
  17. }  
  • 使用 super.clone() 让Object类负责创建新的对象。
  • 基本类型域都已经被正确地复制了。同样,我们不需要去克隆String和BigInteger等不可变类型。
  • 手动对所有的非基本类型域(对象和数组)进行深度复制(deep copy)。
  • 实现了Cloneable的类,clone()方法永远不要抛CloneNotSupportedException。因此,需要捕获这个异常并忽略它,或者使用不受检异常(unchecked exception)包装它。
  • 不使用Object.clone()方法而是手动地实现clone()方法是可以的也是合法的。
  • 参考:java.lang.Object.clone()、java.lang.Cloneable()

使用StringBuilder或StringBuffer


 
 
  1. // join(["a""b""c"]) -> "a and b and c" 
  2. String join(List<String> strs) { 
  3.   StringBuilder sb = new StringBuilder(); 
  4.   boolean first = true
  5.   for (String s : strs) { 
  6.     if (firstfirst = false
  7.     else sb.append(" and "); 
  8.     sb.append(s); 
  9.   } 
  10.   return sb.toString(); 
  11. }  
  • 不要像这样使用重复的字符串连接:s += item ,因为它的时间效率是O(n^2)。
  • 使用StringBuilder或者StringBuffer时,可以使用append()方法添加文本和使用toString()方法去获取连接起来的整个文本。
  • 优先使用StringBuilder,因为它更快。StringBuffer的所有方法都是同步的,而你通常不需要同步的方法。
  • 参考java.lang.StringBuilder、java.lang.StringBuffer

生成一个范围内的随机整数


 
 
  1. Random rand = new Random(); 
  2.  
  3. // Between 1 and 6, inclusive 
  4. int diceRoll() { 
  5.   return rand.nextInt(6) + 1; 
  6. }  
  • 总是使用Java API方法去生成一个整数范围内的随机数。
  • 不要试图去使用 Math.abs(rand.nextInt()) % n 这些不确定的用法,因为它的结果是有偏差的。此外,它的结果值有可能是负数,比如当rand.nextInt() == Integer.MIN_VALUE时就会如此。
  • 参考:java.util.Random.nextInt(int)

使用Iterator.remove()


 
 
  1. void filter(List<String> list) { 
  2.   for (Iterator<String> iter = list.iterator(); iter.hasNext(); ) { 
  3.     String item = iter.next(); 
  4.     if (...) 
  5.       iter.remove(); 
  6.   } 
  7. }  
  • remove()方法作用在next()方法最近返回的条目上。每个条目只能使用一次remove()方法。
  • 参考:java.util.Iterator.remove()

返转字符串


 
 
  1. String reverse(String s) { 
  2.   return new StringBuilder(s).reverse().toString(); 
  3. }  

启动一条线程

下面的三个例子使用了不同的方式完成了同样的事情。

实现Runnnable的方式:


 
 
  1. void startAThread0() { 
  2.   new Thread(new MyRunnable()).start(); 
  3.  
  4. class MyRunnable implements Runnable { 
  5.   public void run() { 
  6.     ... 
  7.   } 
  8. }  

继承Thread的方式:


 
 
  1. void startAThread1() { 
  2.   new MyThread().start(); 
  3.  
  4. class MyThread extends Thread { 
  5.   public void run() { 
  6.     ... 
  7.   } 
  8. }  

匿名继承Thread的方式:


 
 
  1. void startAThread2() { 
  2.   new Thread() { 
  3.     public void run() { 
  4.       ... 
  5.     } 
  6.   }.start(); 
  7. }  
  • 不要直接调用run()方法。总是调用Thread.start()方法,这个方法会创建一条新的线程并使新建的线程调用run()。
  • 参考:java.lang.Thread, java.lang.Runnable

使用try-finally

I/O流例子:


 
 
  1. void writeStuff() throws IOException { 
  2.   OutputStream out = new FileOutputStream(...); 
  3.   try { 
  4.     out.write(...); 
  5.   } finally { 
  6.     out.close(); 
  7.   } 
  8. }  

锁例子:


 
 
  1. void doWithLock(Lock lock) { 
  2.   lock.acquire(); 
  3.   try { 
  4.     ... 
  5.   } finally { 
  6.     lock.release(); 
  7.   } 
  8. }  
  • 如果try之前的语句运行失败并且抛出异常,那么finally语句块就不会执行。但无论怎样,在这个例子里不用担心资源的释放。
  • 如果try语句块里面的语句抛出异常,那么程序的运行就会跳到finally语句块里执行尽可能多的语句,然后跳出这个方法(除非这个方法还有另一个外围的finally语句块)。

从输入流里读取字节数据


 
 
  1. InputStream in = (...); 
  2. try { 
  3.   while (true) { 
  4.     int b = in.read(); 
  5.     if (b == -1) 
  6.       break; 
  7.     (... process b ...) 
  8.   } 
  9. } finally { 
  10.   in.close(); 
  11. }  
  • read()方法要么返回下一次从流里读取的字节数(0到255,包括0和255),要么在达到流的末端时返回-1。
  • 参考:java.io.InputStream.read()

从输入流里读取块数据


 
 
  1. InputStream in = (...); 
  2. try { 
  3.   byte[] buf = new byte[100]; 
  4.   while (true) { 
  5.     int n = in.read(buf); 
  6.     if (n == -1) 
  7.       break; 
  8.     (... process buf with offset=0 and length=n ...) 
  9.   } 
  10. } finally { 
  11.   in.close(); 
  12. }  

从文件里读取文本


 
 
  1. BufferedReader in = new BufferedReader( 
  2.     new InputStreamReader(new FileInputStream(...), "UTF-8")); 
  3. try { 
  4.   while (true) { 
  5.     String line = in.readLine(); 
  6.     if (line == null
  7.       break; 
  8.     (... process line ...) 
  9.   } 
  10. } finally { 
  11.   in.close(); 
  12. }  
  • BufferedReader对象的创建显得很冗长。这是因为Java把字节和字符当成两个不同的概念来看待(这与C语言不同)。
  • 你可以使用任何类型的InputStream来代替FileInputStream,比如socket。
  • 当达到流的末端时,BufferedReader.readLine()会返回null。
  • 要一次读取一个字符,使用Reader.read()方法。
  • 你可以使用其他的字符编码而不使用UTF-8,但最好不要这样做。
  • 参考:java.io.BufferedReaderjava.io.InputStreamReader

向文件里写文本


 
 
  1. PrintWriter out = new PrintWriter( 
  2.     new OutputStreamWriter(new FileOutputStream(...), "UTF-8")); 
  3. try { 
  4.   out.print("Hello "); 
  5.   out.print(42); 
  6.   out.println(" world!"); 
  7. } finally { 
  8.   out.close(); 
  9. }  
  • Printwriter对象的创建显得很冗长。这是因为Java把字节和字符当成两个不同的概念来看待(这与C语言不同)。
  • 就像System.out,你可以使用print()和println()打印多种类型的值。
  • 你可以使用其他的字符编码而不使用UTF-8,但最好不要这样做。
  • 参考:java.io.PrintWriterjava.io.OutputStreamWriter

预防性检测(Defensive checking)数值


 
 
  1. int factorial(int n) { 
  2.   if (n < 0) 
  3.     throw new IllegalArgumentException("Undefined"); 
  4.   else if (n >= 13) 
  5.     throw new ArithmeticException("Result overflow"); 
  6.   else if (n == 0) 
  7.     return 1; 
  8.   else 
  9.     return n * factorial(n - 1); 
  10. }  
  • 不要认为输入的数值都是正数、足够小的数等等。要显式地检测这些条件。
  • 一个设计良好的函数应该对所有可能性的输入值都能够正确地执行。要确保所有的情况都考虑到了并且不会产生错误的输出(比如溢出)。

预防性检测对象


 
 
  1. int findIndex(List<String> list, String target) { 
  2.   if (list == null || target == null
  3.     throw new NullPointerException(); 
  4.   ... 
  5. }  
  • 不要认为对象参数不会为空(null)。要显式地检测这个条件。

预防性检测数组索引


 
 
  1. void frob(byte[] b, int index) { 
  2.   if (b == null
  3.     throw new NullPointerException(); 
  4.   if (index < 0 || index >= b.length) 
  5.     throw new IndexOutOfBoundsException(); 
  6.   ... 
  7. }  
  • 不要认为所以给的数组索引不会越界。要显式地检测它。

预防性检测数组区间


 
 
  1. void frob(byte[] b, int offint len) { 
  2.   if (b == null
  3.     throw new NullPointerException(); 
  4.   if (off < 0 || off > b.length 
  5.     || len < 0 || b.length - off < len) 
  6.     throw new IndexOutOfBoundsException(); 
  7.   ... 
  8. }  
  • 不要认为所给的数组区间(比如,从off开始,读取len个元素)是不会越界。要显式地检测它。

填充数组元素

使用循环:


 
 
  1. // Fill each element of array 'a' with 123 
  2. byte[] a = (...); 
  3. for (int i = 0; i < a.length; i++) 
  4.   a[i] = 123;  

(优先)使用标准库的方法:


 
 
  1. Arrays.fill(a, (byte)123); 

复制一个范围内的数组元素

使用循环:


 
 
  1. // Copy 8 elements from array 'a' starting at offset 3 
  2. // to array 'b' starting at offset 6, 
  3. // assuming 'a' and 'b' are distinct arrays 
  4. byte[] a = (...); 
  5. byte[] b = (...); 
  6. for (int i = 0; i < 8; i++) 
  7.   b[6 + i] = a[3 + i];  

(优先)使用标准库的方法:


 
 
  1. System.arraycopy(a, 3, b, 6, 8); 

调整数组大小

使用循环(扩大规模):


 
 
  1. // Make array 'a' larger to newLen 
  2. byte[] a = (...); 
  3. byte[] b = new byte[newLen]; 
  4. for (int i = 0; i < a.length; i++)  // Goes up to length of A 
  5.   b[i] = a[i]; 
  6. a = b;  

使用循环(减小规模):


 
 
  1. // Make array 'a' smaller to newLen 
  2.  
  3. byte[] a = (...); 
  4.  
  5. byte[] b = new byte[newLen]; 
  6.  
  7. for (int i = 0; i < b.length; i++) // Goes up to length of B 
  8.  
  9. b[i] = a[i]; 
  10.  
  11. a = b;  

(优先)使用标准库的方法:


 
 
  1. a = Arrays.copyOf(a, newLen); 
  • 参考:java.util.Arrays.copyOf(T[], int)。
  • 参考:java.util.Arrays.copyOfRange(T[], int, int)。

把4个字节包装(packing)成一个int


 
 
  1. int packBigEndian(byte[] b) { 
  2.   return (b[0] & 0xFF) << 24 
  3.        | (b[1] & 0xFF) << 16 
  4.        | (b[2] & 0xFF) <<  8 
  5.        | (b[3] & 0xFF) <<  0; 
  6.  
  7. int packLittleEndian(byte[] b) { 
  8.   return (b[0] & 0xFF) <<  0 
  9.        | (b[1] & 0xFF) <<  8 
  10.        | (b[2] & 0xFF) << 16 
  11.        | (b[3] & 0xFF) << 24; 
  12. }  

把int分解(Unpacking)成4个字节


 
 
  1. byte[] unpackBigEndian(int x) { 
  2.   return new byte[] { 
  3.     (byte)(x >>> 24), 
  4.     (byte)(x >>> 16), 
  5.     (byte)(x >>>  8), 
  6.     (byte)(x >>>  0) 
  7.   }; 
  8.  
  9. byte[] unpackLittleEndian(int x) { 
  10.   return new byte[] { 
  11.     (byte)(x >>>  0), 
  12.     (byte)(x >>>  8), 
  13.     (byte)(x >>> 16), 
  14.     (byte)(x >>> 24) 
  15.   }; 
  16. }  

  • 总是使用无符号右移操作符(>>>)对位进行包装(packing),不要使用算术右移操作符(>>)。 

作者:空心城冷
来源:51CTO
相关文章
|
4月前
|
Java
Java中的equals()与==的区别与用法
【7月更文挑战第28天】
67 12
|
10天前
|
存储 安全 Java
深入理解Java中的FutureTask:用法和原理
【10月更文挑战第28天】`FutureTask` 是 Java 中 `java.util.concurrent` 包下的一个类,实现了 `RunnableFuture` 接口,支持异步计算和结果获取。它可以作为 `Runnable` 被线程执行,同时通过 `Future` 接口获取计算结果。`FutureTask` 可以基于 `Callable` 或 `Runnable` 创建,常用于多线程环境中执行耗时任务,避免阻塞主线程。任务结果可通过 `get` 方法获取,支持阻塞和非阻塞方式。内部使用 AQS 实现同步机制,确保线程安全。
|
2月前
|
Java
Java 正则表达式高级用法
Java 中的正则表达式是强大的文本处理工具,用于搜索、匹配、替换和分割字符串。`java.util.regex` 包提供了 `Pattern` 和 `Matcher` 类来高效处理正则表达式。本文介绍了高级用法,包括使用 `Pattern` 和 `Matcher` 进行匹配、断言(如正向和负向前瞻/后顾)、捕获组与命名组、替换操作、分割字符串、修饰符(如忽略大小写和多行模式)及 Unicode 支持。通过这些功能,可以高效地处理复杂文本数据。
|
2月前
|
存储 Java 数据处理
Java 数组的高级用法
在 Java 中,数组不仅可以存储同类型的数据,还支持多种高级用法,如多维数组(常用于矩阵)、动态创建数组、克隆数组、使用 `java.util.Arrays` 进行排序和搜索、与集合相互转换、增强 for 循环遍历、匿名数组传递以及利用 `Arrays.equals()` 比较数组内容。这些技巧能提升代码的灵活性和可读性,适用于更复杂的数据处理场景。
|
2月前
|
安全 Java
Java switch case隐藏用法
在 Java 中,`switch` 语句是一种多分支选择结构,常用于根据变量值执行不同代码块。除基本用法外,它还有多种进阶技巧,如使用字符串(Java 7 开始支持)、多个 `case` 共享代码块、不使用 `break` 实现 “fall-through”、使用枚举类型、使用表达式(Java 12 及以上)、组合条件以及使用标签等。这些技巧使代码更加简洁、清晰且高效。
|
3月前
|
Java 数据处理
Java IO 接口(Input)究竟隐藏着怎样的神秘用法?快来一探究竟,解锁高效编程新境界!
【8月更文挑战第22天】Java的输入输出(IO)操作至关重要,它支持从多种来源读取数据,如文件、网络等。常用输入流包括`FileInputStream`,适用于按字节读取文件;结合`BufferedInputStream`可提升读取效率。此外,通过`Socket`和相关输入流,还能实现网络数据读取。合理选用这些流能有效支持程序的数据处理需求。
41 2
|
4月前
|
Java
java中return,break以及continue的用法
java中return,break以及continue的用法
47 10
|
5月前
|
Java
深入理解 Java 8 函数式接口:定义、用法与示例详解
深入理解 Java 8 函数式接口:定义、用法与示例详解
285 2
|
5月前
|
Java
Java 中 MessageFormat.format 用法
Java 中 MessageFormat.format 用法
52 1
|
4月前
|
Java 编译器 数据库连接
Java面试题:什么是Java中的注解以及如何自定义注解?举例说明注解的经典用法
Java面试题:什么是Java中的注解以及如何自定义注解?举例说明注解的经典用法
82 0