Java函数习惯用法详解

在Java编程中,有些知识 并不能仅通过语言规范或者标准API文档就能学到的。在本文中,我会尽量收集一些最常用的习惯用法,特别是很难猜到的用法。

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

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

实现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()的实现与这个类似。

实现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()方法是可以的也是合法的。

使用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的所有方法都是同步的,而你通常不需要同步的方法。

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

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时就会如此。

使用Iterator.remove()

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

remove()方法作用在next()方法最近返回的条目上。每个条目只能使用一次remove()方法。

返转字符串

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

这个方法可能应该加入Java标准库。

启动一条线程

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

实现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()。

使用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。

从输入流里读取块数据

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,所以你必须在处理逻辑中考虑返回的长度。

从文件里读取文本

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,但最好不要这样做。

向文件里写文本

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,但最好不要这样做。

预防性检测(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<String> 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);

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

使用循环:

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

把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),不要使用算术右移操作符(>>)。

(0)

相关推荐

  • Java回调函数实例代码详解

    首先说说什么叫回调函数? 在WINDOWS中,程序员想让系统DLL调用自己编写的一个方法,于是利用DLL当中回调函数(CALLBACK)的接口来编写程序,使它调用,这个就 称为回调.在调用接口时,需要严格的按照定义的参数和方法调用,并且需要处理函数的异步,否则会导致程序的崩溃. 这样的解释似乎还是比较难懂,这里举个简 单的例子: 程序员A写了一段程序(程序a),其中预留有回调函数接口,并封装好了该程序.程序员B要让a调用自己的程序b中的一个方法,于是,他通过a中的接口回调自己b中的方法.目的达到

  • Java8简单了解Lambda表达式与函数式接口

    Java8被称作Java史上变化最大的一个版本.其中包含很多重要的新特性,最核心的就是增加了Lambda表达式和StreamAPI.这两者也可以结合在一起使用.首先来看下什么是Lambda表达式. 使用Lambda表达式不仅让代码变的简单.而且可读.最重要的是代码量也随之减少很多.然而,在某种程度上,这些功能在Scala等这些JVM语言里已经被广泛使用. 并不奇怪,Scala社区是难以置信的,因为许多Java 8里的内容看起来就像是从Scala里搬过来的.在某种程度上,Java 8的语法要比Sc

  • python中print()函数的“,”与java中System.out.print()函数中的“+”功能详解

    python中的print()函数和java中的System.out.print()函数都有着打印字符串的功能. python中: print("hello,world!") 输出结果为:hello,world! java中: System.out.print("hello,world!"); 输出结果为:hello,world! 我们可以看到,这两个函数的用法是一样的 print()函数还有这种用法: print("1+1=",1+1) 输出结

  • Java语言中flush()函数作用及使用方法详解

    最近在学习io流,发现每次都会出现flush()函数,查了一下其作用,起作用主要如下 //------–flush()的作用--------– 笼统且错误的回答: 缓冲区中的数据保存直到缓冲区满后才写出,也可以使用flush方法将缓冲区中的数据强制写出或使用close()方法关闭流,关闭流之前,缓冲输出流将缓冲区数据一次性写出.flash()和close()都使数据强制写出,所以两种结果是一样的,如果都不写的话,会发现不能成功写出 针对上述回答,给出了精准的回答 FileOutPutStream

  • Java编程中的构造函数详细介绍

    本文主要是为新手.对java语言感兴趣的人和那些没有系统学习过java基础知识的人进行一个总结,在文章中对构造函数进行了较为详细的说明和讨论,也包含了我个人对于java面向对象中构造函数的一些看法.希望走在java学习道路上的同行者可以有一个较为清晰的认知和理解.当然仅为个人观点,水平有限,不足之处,还请大家多多指出,互相交流学习. 1.构造函数的概念 很多java新手谈到构造函数就会犯晕,我们先来看看什么是构造函数. 首先,构造函数是函数的一种特殊形式,特殊在哪里?构造函数中不需要定义返回类型

  • 实例详解Java8函数式接口

    以下我们继续深入Java8函数式编程模型 public class Test1 { public static void main(String[] args) { List<Integer> list = Arrays.asList(1,2,3,4,5,6,7,8,9,10); list.forEach(new Consumer<Integer>() { @Override public void accept(Integer integer) { System.out.prin

  • Java构造函数的相互调用代码示例

    在Java中,当为一个类创建了多个构造函数时,有时想在一个构造函数中调用另一个构造函数以减少代码量.这时可以使用this关键字来实现. 有关构造函数的相关内容,大家可以参阅:Java编程中的构造函数详细介绍 通常,当使用this关键字时,它意味着"这个对象"或者"当前对象",并且它自身产生对当前对象的引用.在一个构造函数中,当给传递给它一个参数列表时,它就有了不同的意义. 它将直接的调用能够匹配这个参数列表的构造函数.因此,我么可以直接的调用其它构造函数: pack

  • IO中flush()函数的使用代码示例

    The java.io.Writer.flush() method flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte st

  • Java函数习惯用法详解

    在Java编程中,有些知识 并不能仅通过语言规范或者标准API文档就能学到的.在本文中,我会尽量收集一些最常用的习惯用法,特别是很难猜到的用法. 我把本文的所有代码都放在公共场所里.你可以根据自己的喜好去复制和修改任意的代码片段,不需要任何的凭证. 实现equals() class Person { String name; int birthYear; byte[] raw; public boolean equals(Object obj) { if (!obj instanceof Per

  • Java中SimpleDateFormat用法详解

    public class SimpleDateFormat extends DateFormat SimpleDateFormat 是一个以国别敏感的方式格式化和分析数据的具体类. 它允许格式化 (date -> text).语法分析 (text -> date)和标准化. SimpleDateFormat 允许以为日期-时间格式化选择任何用户指定的方式启动. 但是,希望用 DateFormat 中的 getTimeInstance. getDateInstance 或 getDateTime

  • Java集合TreeSet用法详解

    第1部分 TreeSet介绍 TreeSet简介 TreeSet 是一个有序的集合,它的作用是提供有序的Set集合.它继承于AbstractSet抽象类,实现了NavigableSet<E>, Cloneable, java.io.Serializable接口. TreeSet 继承于AbstractSet,所以它是一个Set集合,具有Set的属性和方法. TreeSet 实现了NavigableSet接口,意味着它支持一系列的导航方法.比如查找与指定目标最匹配项. TreeSet 实现了Cl

  • Oracle中的INSTR,NVL和SUBSTR函数的用法详解

    Oracle中INSTR的用法: INSTR方法的格式为 INSTR(源字符串, 要查找的字符串, 从第几个字符开始, 要找到第几个匹配的序号) 返回找到的位置,如果找不到则返回0. 例如:INSTR('CORPORATE FLOOR','OR', 3, 2)中,源字符串为'CORPORATE FLOOR', 在字符串中查找'OR',从第三个字符位置开始查找"OR",取第三个字后第2个匹配项的位置. 默认查找顺序为从左到右.当起始位置为负数的时候,从右边开始查找. 所以SELECT I

  • Java RandomAccessFile的用法详解

    RandomAccessFile RandomAccessFile是用来访问那些保存数据记录的文件的,你就可以用seek( )方法来访问记录,并进行读写了.这些记录的大小不必相同:但是其大小和位置必须是可知的.但是该类仅限于操作文件. RandomAccessFile不属于InputStream和OutputStream类系的.实际上,除了实现DataInput和 DataOutput接口之外(DataInputStream和DataOutputStream也实现了这两个接口),它和这两个类系毫

  • ES6中Array.find()和findIndex()函数的用法详解

    ES6为Array增加了find(),findIndex函数. find()函数用来查找目标元素,找到就返回该元素,找不到返回undefined. findIndex()函数也是查找目标元素,找到就返回元素的位置,找不到就返回-1. 他们的都是一个查找回调函数. [1, 2, 3, 4].find((value, index, arr) => { }) 查找函数有三个参数. value:每一次迭代查找的数组元素. index:每一次迭代查找的数组元素索引. arr:被查找的数组. 例: 1.查找

  • C语言中memcpy 函数的用法详解

    C语言中memcpy 函数的用法详解 memcpy(内存拷贝函数) c和c++使用的内存拷贝函数,memcpy函数的功能是从源src所指的内存地址的起始位置开始拷贝n个字节到目标dest所指的内存地址的起始位置中. void* memcpy(void* destination, const void* source, size_t num); void* dest 目标内存 const void* src 源内存 size_t num 字节个数 库中实现的memcpy函数 struct { ch

  • Java中DecimalFormat用法详解

    我们经常要将数字进行格式化,比如取2位小数,这是最常见的.Java 提供DecimalFormat类,帮你用最快的速度将数字格式化为你需要的样子.下面是一个例子: importjava.text.DecimalFormat; public class TestNumberFormat{ public static void main(String[]args){ doublepi=3.1415927; //圆周率 //取一位整数 System.out.println(newDecimalForm

  • java.text.DecimalFormat用法详解

    简要 DecimalFormat 的 pattern 都包含着 正负子 pattern ,例如 "#,##0.00;(#,##0.00)": /** * Created by Shuai on 2016/7/11. */ public class Main { public static void main(String[] args) { // 正值 BigDecimal bigDecimal = BigDecimal.valueOf(-12211151515151.541666);

  • 对pandas中apply函数的用法详解

    最近在使用apply函数,总结一下用法. apply函数可以对DataFrame对象进行操作,既可以作用于一行或者一列的元素,也可以作用于单个元素. 例:列元素 行元素 列 行 以上这篇对pandas中apply函数的用法详解就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持我们. 您可能感兴趣的文章: 浅谈Pandas中map, applymap and apply的区别

随机推荐