设为首页收藏本站
开启辅助访问

在路上

 找回密码
 立即注册
在路上 › 站点首页 ›学习 › 查看内容

Java习惯用法总结

2016-12-13 12:56| 发布者: zhangjf| 查看: 645| 评论: 0

摘要: 在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()
  1. class Person {
  2. String name;
  3. int birthYear;
  4. byte[] raw;
  6. public boolean equals(Object obj) {
  7. if (!obj instanceof Person)
  8. return false;
  10. Person other = (Person)obj;
  11. return name.equals(other.name)
  12. && birthYear == other.birthYear
  13. && Arrays.equals(raw, other.raw);
  14. }
  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;
  7. public int hashCode() {
  8. return a.hashCode() + b.hashCode() + c + Arrays.hashCode(d);
  9. }
  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;
  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;
  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 (first) first = 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();
  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. }
复制代码
这个方法可能应该加入Java标准库。 参考：java.lang.StringBuilder.reverse()。

启动一条线程

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

实现Runnnable的方式：

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

继承Thread的方式：

  1. void startAThread1() {
  2. new MyThread().start();
  3. }
  5. class MyThread extends Thread {
  6. public void run() {
  7. ...
  8. }
  9. }
复制代码

匿名继承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. }
复制代码
要记住的是，read()方法不一定会填满整个buf，所以你必须在处理逻辑中考虑返回的长度。 参考： java.io.InputStream.read(byte[])、java.io.InputStream.read(byte[], int, int)。

从文件里读取文本
  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.BufferedReader、java.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.PrintWriter、java.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 off, int 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);
复制代码
参考：java.util.Arrays.fill(T[], T)。 参考：java.util.Arrays.fill(T[], int, int, T)。

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

使用循环：

  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);
复制代码
参考：java.lang.System.arraycopy(Object, int, Object, int, int)。

调整数组大小

使用循环（扩大规模）：

  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. byte[] a = (...);
  3. byte[] b = new byte[newLen];
  4. for (int i = 0; i < b.length; i++) // Goes up to length of B
  5. b[i] = a[i];
  6. 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. }
  8. int packLittleEndian(byte[] b) {
  9. return (b[0] & 0xFF) << 0
  10. | (b[1] & 0xFF) << 8
  11. | (b[2] & 0xFF) << 16
  12. | (b[3] & 0xFF) << 24;
  13. }
复制代码

把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. }
  10. byte[] unpackLittleEndian(int x) {
  11. return new byte[] {
  12. (byte)(x >>> 0),
  13. (byte)(x >>> 8),
  14. (byte)(x >>> 16),
  15. (byte)(x >>> 24)
  16. };
  17. }
复制代码
总是使用无符号右移操作符（>>>）对位进行包装（packing），不要使用算术右移操作符（>>）。 原文链接： nayuki 翻译： ImportNew.com - 进林
译文链接： http://www.importnew.com/15605.html
[ 转载请保留原文出处、译者和译文链接。]

收藏 邀请
上一篇：通过代码直接设置Java的DNS - Java Dns Cache Manipulator下一篇：透视JVM之垃圾回收

最新评论

相关分类

小黑屋|在路上 ( 蜀ICP备15035742号-1 )  

;

GMT+8, 2025-7-8 06:05

Copyright 2015-2025 djqfx

返回顶部