疯狂Java学习笔记（89）-----------Java习惯用法总结

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

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

目录

• 实现：
  • equals()
  • hashCode()
  • compareTo()
  • clone()
• 应用：
  • StringBuilder/StringBuffer
  • Random.nextInt(int)
  • Iterator.remove()
  • StringBuilder.reverse()
  • Thread/Runnable
  • try-finally
• 输入/输出：
  • 从输入流里读取字节数据
  • 从输入流里读取块数据
  • 从文件里读取文本
  • 向文件里写文本
• 预防性检测：
  • 数值
  • 对象
  • 数组索引
  • 数组区间
• 数组：
  • 填充元素
  • 复制一个范围内的数组元素
  • 调整数组大小
• 包装
  • 个字节包装成一个int
  • 分解成4个字节

实现equals()

      class Person {
        String name;
       int birthYear;
       byte[] raw;
       public boolean equals(Object obj) {
         if (!obj instanceof Person)
           return false;
         Person other = (Person)obj;
         return name.equals(other.name)
              && birthYear == other.birthYear
              && Arrays.equals(raw, other.raw);
        }
       public int hashCode() { ... }
      }
  
 

参考： java.lang.Object.equals(Object)。

实现hashCode()

      class Person {
        String a;
        Object b;
       byte c;
       int[] d;
       public int hashCode() {
         return a.hashCode() + b.hashCode() + c + Arrays.hashCode(d);
        }
       public boolean equals(Object o) { ... }
      }
  
 

• 当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这些数据结构运行得很慢。

实现compareTo()

      class Person implements Comparable<Person> {
        String firstName;
        String lastName;
       int birthdate;
       // Compare by firstName, break ties by lastName, finally break ties by birthdate
       public int compareTo(Person other) {
         if (firstName.compareTo(other.firstName) != 0)
           return firstName.compareTo(other.firstName);
         else if (lastName.compareTo(other.lastName) != 0)
           return lastName.compareTo(other.lastName);
         else if (birthdate < other.birthdate)
           return -1;
         else if (birthdate > other.birthdate)
           return 1;
         else
           return 0;
        }
      }
  
 

• 总是实现泛型版本 Comparable 而不是实现原始类型 Comparable 。因为这样可以节省代码量和减少不必要的麻烦。
• 只关心返回结果的正负号（负/零/正），它们的大小不重要。
• Comparator.compare()的实现与这个类似。
• 参考：java.lang.Comparable。

实现clone()

      class Values implements Cloneable {
        String abc;
       double foo;
       int[] bars;
        Date hired;
       public Values clone() {
         try {
           Values result = (Values)super.clone();
            result.bars = result.bars.clone();
            result.hired = result.hired.clone();
           return result;
          } catch (CloneNotSupportedException e) {  // Impossible
           throw new AssertionError(e);
          }
        }
      }
  
 

• 使用 super.clone() 让Object类负责创建新的对象。
• 基本类型域都已经被正确地复制了。同样，我们不需要去克隆String和BigInteger等不可变类型。
• 手动对所有的非基本类型域（对象和数组）进行深度复制（deep copy）。
• 实现了Cloneable的类，clone()方法永远不要抛CloneNotSupportedException。因此，需要捕获这个异常并忽略它，或者使用不受检异常（unchecked exception）包装它。
• 不使用Object.clone()方法而是手动地实现clone()方法是可以的也是合法的。
• 参考：java.lang.Object.clone()、java.lang.Cloneable()。

使用StringBuilder或StringBuffer

      // join(["a", "b", "c"]) -> "a and b and c"
      String join(List<String> strs) {
       StringBuilder sb = new StringBuilder();
       boolean first = true;
       for (String s : strs) {
         if (first) first = false;
         else sb.append(" and ");
          sb.append(s);
        }
       return sb.toString();
      }
  
 

• 不要像这样使用重复的字符串连接：s += item ，因为它的时间效率是O(n^2)。
• 使用StringBuilder或者StringBuffer时，可以使用append()方法添加文本和使用toString()方法去获取连接起来的整个文本。
• 优先使用StringBuilder，因为它更快。StringBuffer的所有方法都是同步的，而你通常不需要同步的方法。
• 参考java.lang.StringBuilder、java.lang.StringBuffer。

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

       Random rand = new Random();
       // Between 1 and 6, inclusive
       int diceRoll() {
        return rand.nextInt(6) + 1;
       }
   
  

       void filter(List<String> list) {
        for (Iterator<String> iter = list.iterator(); iter.hasNext(); ) {
          String item = iter.next();
          if (...)
             iter.remove();
         }
       }
   
  

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

        void startAThread0() {
         new Thread(new MyRunnable()).start();
        }
        class MyRunnable implements Runnable {
         public void run() {
            ...
          }
        }
    
   

       void startAThread1() {
        new MyThread().start();
       }
       class MyThread extends Thread {
        public void run() {
           ...
         }
       }
   
  

       void startAThread2() {
        new Thread() {
          public void run() {
             ...
           }
         }.start();
       }
   
  

       void writeStuff() throws IOException {
        OutputStream out = new FileOutputStream(...);
        try {
           out.write(...);
         } finally {
           out.close();
         }
       }
   
  

       void doWithLock(Lock lock) {
         lock.acquire();
        try {
           ...
         } finally {
           lock.release();
         }
       }
   
  

       InputStream in = (...);
       try {
        while (true) {
          int b = in.read();
          if (b == -1)
            break;
           (... process b ...)
         }
       } finally {
         in.close();
       }
   
  

       InputStream in = (...);
       try {
        byte[] buf = new byte[100];
        while (true) {
          int n = in.read(buf);
          if (n == -1)
            break;
           (... process buf with offset=0 and length=n ...)
         }
       } finally {
         in.close();
       }
   
  

       BufferedReader in = new BufferedReader(
          new InputStreamReader(new FileInputStream(...), "UTF-8"));
       try {
        while (true) {
          String line = in.readLine();
          if (line == null)
            break;
           (... process line ...)
         }
       } finally {
         in.close();
       }
   
  

        PrintWriter out = new PrintWriter(
           new OutputStreamWriter(new FileOutputStream(...), "UTF-8"));
        try {
          out.print("Hello ");
          out.print(42);
          out.println(" world!");
        } finally {
          out.close();
        }
    
   

        int factorial(int n) {
         if (n < 0)
           throw new IllegalArgumentException("Undefined");
         else if (n >= 13)
           throw new ArithmeticException("Result overflow");
         else if (n == 0)
           return 1;
         else
           return n * factorial(n - 1);
        }
    
   

        int findIndex(List<String> list, String target) {
         if (list == null || target == null)
           throw new NullPointerException();
          ...
        }
    
   

        void frob(byte[] b, int index) {
         if (b == null)
           throw new NullPointerException();
         if (index < 0 || index >= b.length)
           throw new IndexOutOfBoundsException();
          ...
        }
    
   

         void frob(byte[] b, int off, int len) {
          if (b == null)
            throw new NullPointerException();
          if (off < 0 || off > b.length
             || len < 0 || b.length - off < len)
            throw new IndexOutOfBoundsException();
           ...
         }
     
    

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

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

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

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

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

         // Make array 'a' smaller to newLen
         byte[] a = (...);
         byte[] b = new byte[newLen];
         for (int i = 0; i < b.length; i++)  // Goes up to length of B
           b[i] = a[i];
         a = b;
     
    

a = Arrays.copyOf(a, newLen);
    

         int packBigEndian(byte[] b) {
          return (b[0] & 0xFF) << 24
                | (b[1] & 0xFF) << 16
                | (b[2] & 0xFF) <<  8
                | (b[3] & 0xFF) <<  0;
         }
         int packLittleEndian(byte[] b) {
          return (b[0] & 0xFF) <<  0
                | (b[1] & 0xFF) <<  8
                | (b[2] & 0xFF) << 16
                | (b[3] & 0xFF) << 24;
         }
     
    

         byte[] unpackBigEndian(int x) {
          return new byte[] {
             (byte)(x >>> 24),
             (byte)(x >>> 16),
             (byte)(x >>>  8),
             (byte)(x >>>  0)
           };
         }
         byte[] unpackLittleEndian(int x) {
          return new byte[] {
             (byte)(x >>>  0),
             (byte)(x >>>  8),
             (byte)(x >>> 16),
             (byte)(x >>> 24)
           };
         }
     
    

文章来源: brucelong.blog.csdn.net，作者：Bruce小鬼，版权归原作者所有，如需转载，请联系作者。

原文链接：brucelong.blog.csdn.net/article/details/79978659