Java习惯用法总结分享

在Java编程中,有些知识
并不能仅通过语言规范或者标准API文档就能学到的。在本文中,我会尽量收集一些最常用的习惯用法,特别是很难猜到的用法。(Joshua
Bloch的《Effective
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()


hashCode()

**实现equals()
class Person {
  String name;
  int birthYear;
  byte[] raw;

compareTo()

  public boolean equals(Object obj)
{
    if (!obj instanceof Person)
      return false;

clone()

    Person other = (Person)obj;
    return
name.equals(other.name)
        && birthYear ==
other.birthYear
        && Arrays.equals(raw,
other.raw);
  }
  public int hashCode() { … }
}
**

应用:

  • 参数必须是Object类型,不能是外围类。
  • foo.equals(null)
    必须返回false,不能抛NullPointerException。(注意,null instanceof
    任意类 总是返回false,因此上面的代码可以运行。)
  • 基本类型域(比如,int)的比较使用 ==
    ,基本类型数组域的比较使用Arrays.equals()。
  • 覆盖equals()时,记得要相应地覆盖 hashCode(),与 equals()
    保持一致。
  • 参考:java.lang.Object.equals(Object)。

StringBuilder/StringBuffer

**实现hashCode()
class Person {
  String a;
  Object b;
  byte c;
  int[] d;

Random.nextInt(int)

  public int hashCode() {
    return a.hashCode() + b.hashCode() + c + Arrays.hashCode(d);
  }

Iterator.remove()

  public boolean equals(Object o) { … }
}
**

StringBuilder.reverse()

  • 当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()。

Thread/Runnable

**实现compareTo()

try-finally

class Person implements
Comparable<澳门新葡亰网站注册 1erson>
{
  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;
}
**

调整数组大小

  • 总是使用Java API方法去生成一个整数范围内的随机数。
  • 不要试图去使用 Math.abs(rand.nextInt()) % n
    这些不确定的用法,因为它的结果是有偏差的。此外,它的结果值有可能是负数,比如当rand.nextInt()
    == Integer.MIN_VALUE时就会如此。
  • 参考:java.util.Random.nextInt(int)澳门新葡亰网站注册,。

包装

**使用Iterator.remove()

个字节包装成一个int

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

分解成4个字节

  • remove()方法作用在next()方法最近返回的条目上。每个条目只能使用一次remove()方法。
  • 参考:java.util.Iterator.remove()。

实现equals()

**返转字符串

class Person {

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

String name;

  • 这个方法可能应该加入Java标准库。
  • 参考:java.lang.StringBuilder.reverse()。

int birthYear;

**启动一条线程
**

byte[] raw;

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

public boolean equals(Object obj) {

实现Runnnable的方式:

if (!obj instanceof Person)

void startAThread0() {

return false;

  new Thread(new MyRunnable()).start();

Person other = (Person)obj;

}

return name.equals(other.name)

class MyRunnable implements Runnable {

birthYear == other.birthYear

  public void run() {

Arrays.equals(raw, other.raw);

    …

}

  }

public int hashCode() { … }

}

}

继承Thread的方式:

参数必须是Object类型,不能是外围类。

void startAThread1() {

foo.equals(null) 必须返回false,不能抛NullPointerException。(注意,null
instanceof 任意类 总是返回false,因此上面的代码可以运行。)

  new MyThread().start();

基本类型域(比如,int)的比较使用 ==
,基本类型数组域的比较使用Arrays.equals()。

}

覆盖equals()时,记得要相应地覆盖 hashCode(),与 equals() 保持一致。

class MyThread extends Thread {

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

  public void run() {

实现hashCode()

    …

class Person {

  }

String a;

}

Object b;

匿名继承Thread的方式:

byte c;

void startAThread2() {

int[] d;

  new Thread() {

public int hashCode() {

    public void run() {

return a.hashCode() + b.hashCode() + c + Arrays.hashCode(d);

      …

}

    }

public boolean equals(Object o) { … }

  }.start();

}

}

当x和y两个对象具有x.equals(y) == true ,你必须要确保x.hashCode() ==
y.hashCode()。

  • 不要直接调用run()方法。总是调用Thread.start()方法,这个方法会创建一条新的线程并使新建的线程调用run()。
  • 参考:java.lang.Thread,
    java.lang.Runnable。

根据逆反命题,如果x.hashCode() != y.hashCode(),那么x.equals(y) == false
必定成立。

使用try-finally

你不需要保证,当x.equals(y) == false时,x.hashCode() !=
y.hashCode()。但是,如果你可以尽可能地使它成立的话,这会提高哈希表的性能。

I/O流例子:

hashCode()最简单的合法实现就是简单地return
0;虽然这个实现是正确的,但是这会导致HashMap这些数据结构运行得很慢。

void writeStuff() throws IOException {

参考:java.lang.Object.hashCode()。

  OutputStream out = new FileOutputStream(…);

实现compareTo()

  try {

class Person implements Comparable{

    out.write(…);

String firstName;

  } finally {

String lastName;

    out.close();

int birthdate;

  }

// Compare by firstName, break ties by lastName, finally break ties by
birthdate

}

public int compareTo(Person other) {

锁例子: