java习惯用法总结-mile米乐体育

在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() { ... } }

• 参数必须是object类型，不能是外围类。
• foo.equals(null) 必须返回false，不能抛nullpointerexception。（注意，null instanceof 任意类 总是返回false，因此上面的代码可以运行。）
• 基本类型域（比如，int）的比较使用 == ，基本类型数组域的比较使用arrays.equals()。
• 覆盖equals()时，记得要相应地覆盖 hashcode()，与 equals() 保持一致。
• 参考： 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这些数据结构运行得很慢。
• 参考：java.lang.object.hashcode()。

实现compareto()

class person implements comparable {   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 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()

void filter(list list) {   for (iterator iter = list.iterator(); iter.hasnext(); ) {     string item = iter.next();     if (...)       iter.remove();   } }

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

返转字符串

string reverse(string s) {   return new stringbuilder(s).reverse().tostring(); }

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

启动一条线程

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

实现runnnable的方式：

void startathread0() {   new thread(new myrunnable()).start(); }  class myrunnable implements runnable {   public void run() {     ...   } }

继承thread的方式：

void startathread1() {   new mythread().start(); }  class mythread extends thread {   public void run() {     ...   } }

匿名继承thread的方式：

void startathread2() {   new thread() {     public void run() {       ...     }   }.start(); }

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

使用try-finally

i/o流例子：

void writestuff() throws ioexception {   outputstream out = new fileoutputstream(...);   try {     out.write(...);   } finally {     out.close();   } }

锁例子：

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

• 如果try之前的语句运行失败并且抛出异常，那么finally语句块就不会执行。但无论怎样，在这个例子里不用担心资源的释放。
• 如果try语句块里面的语句抛出异常，那么程序的运行就会跳到finally语句块里执行尽可能多的语句，然后跳出这个方法（除非这个方法还有另一个外围的finally语句块）。

从输入流里读取字节数据

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

• read()方法要么返回下一次从流里读取的字节数（0到255，包括0和255），要么在达到流的末端时返回-1。
• 参考：java.io.inputstream.read()。

从输入流里读取块数据

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

• 要记住的是，read()方法不一定会填满整个buf，所以你必须在处理逻辑中考虑返回的长度。
• 参考： java.io.inputstream.read(byte[])、java.io.inputstream.read(byte[], int, int)。

从文件里读取文本

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

• bufferedreader对象的创建显得很冗长。这是因为java把字节和字符当成两个不同的概念来看待（这与c语言不同）。
• 你可以使用任何类型的inputstream来代替fileinputstream，比如socket。
• 当达到流的末端时，bufferedreader.readline()会返回null。
• 要一次读取一个字符，使用reader.read()方法。
• 你可以使用其他的字符编码而不使用utf-8，但最好不要这样做。
• 参考：java.io.bufferedreader、java.io.inputstreamreader。

向文件里写文本

printwriter out = new printwriter(     new outputstreamwriter(new fileoutputstream(...), "utf-8")); try {   out.print("hello ");   out.print(42);   out.println(" world!"); } finally {   out.close(); }

• printwriter对象的创建显得很冗长。这是因为java把字节和字符当成两个不同的概念来看待（这与c语言不同）。
• 就像system.out，你可以使用print()和println()打印多种类型的值。
• 你可以使用其他的字符编码而不使用utf-8，但最好不要这样做。
• 参考：java.io.printwriter、java.io.outputstreamwriter。

预防性检测（defensive checking）数值

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 list, string target) {   if (list == null || target == null)     throw new nullpointerexception();   ... }

• 不要认为对象参数不会为空（null）。要显式地检测这个条件。

预防性检测数组索引

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

• 不要认为所给的数组区间（比如，从off开始，读取len个元素）是不会越界。要显式地检测它。

填充数组元素

使用循环：

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

• 参考：java.util.arrays.fill(t[], t)。
• 参考：java.util.arrays.fill(t[], int, int, t)。

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

使用循环：

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

• 参考：java.lang.system.arraycopy(object, int, object, int, int)。

调整数组大小

使用循环（扩大规模）：

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

• 参考：java.util.arrays.copyof(t[], int)。
• 参考：java.util.arrays.copyofrange(t[], int, int)。

把4个字节包装（packing）成一个int

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

把int分解（unpacking）成4个字节

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

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