Java函数习惯用法详解

2023-09-19 13:35:07 275

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

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

实现equals()

classPerson{
Stringname;
intbirthYear;
byte[]raw;
publicbooleanequals(Objectobj){
if(!objinstanceofPerson)
returnfalse;

Personother=(Person)obj;
returnname.equals(other.name)
&&birthYear==other.birthYear
&&Arrays.equals(raw,other.raw);
}
publicinthashCode(){...}
}

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

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

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

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

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

实现hashCode()

classPerson{
Stringa;
Objectb;
bytec;
int[]d;
publicinthashCode(){
returna.hashCode()+b.hashCode()+c+Arrays.hashCode(d);
}
publicbooleanequals(Objecto){...}
}

当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()最简单的合法实现就是简单地return0；虽然这个实现是正确的，但是这会导致HashMap这些数据结构运行得很慢。

实现compareTo()

classPersonimplementsComparable{
StringfirstName;
StringlastName;
intbirthdate;
//ComparebyfirstName,breaktiesbylastName,finallybreaktiesbybirthdate
publicintcompareTo(Personother){
if(firstName.compareTo(other.firstName)!=0)
returnfirstName.compareTo(other.firstName);
elseif(lastName.compareTo(other.lastName)!=0)
returnlastName.compareTo(other.lastName);
elseif(birthdateother.birthdate)
return1;
else
return0;
}
}

总是实现泛型版本Comparable而不是实现原始类型Comparable。因为这样可以节省代码量和减少不必要的麻烦。

只关心返回结果的正负号（负/零/正），它们的大小不重要。

Comparator.compare()的实现与这个类似。

实现clone()

classValuesimplementsCloneable{
Stringabc;
doublefoo;
int[]bars;
Datehired;

publicValuesclone(){
try{
Valuesresult=(Values)super.clone();
result.bars=result.bars.clone();
result.hired=result.hired.clone();
returnresult;
}catch(CloneNotSupportedExceptione){//Impossible
thrownewAssertionError(e);
}
}
}

使用super.clone()让Object类负责创建新的对象。

基本类型域都已经被正确地复制了。同样，我们不需要去克隆String和BigInteger等不可变类型。

手动对所有的非基本类型域（对象和数组）进行深度复制（deepcopy）。

实现了Cloneable的类，clone()方法永远不要抛CloneNotSupportedException。因此，需要捕获这个异常并忽略它，或者使用不受检异常（uncheckedexception）包装它。

不使用Object.clone()方法而是手动地实现clone()方法是可以的也是合法的。

使用StringBuilder或StringBuffer

//join(["a","b","c"])->"aandbandc"
Stringjoin(Liststrs){
StringBuildersb=newStringBuilder();
booleanfirst=true;
for(Strings:strs){
if(first)first=false;
elsesb.append("and");
sb.append(s);
}
returnsb.toString();
}

不要像这样使用重复的字符串连接：s+=item，因为它的时间效率是O(n^2)。

使用StringBuilder或者StringBuffer时，可以使用append()方法添加文本和使用toString()方法去获取连接起来的整个文本。

优先使用StringBuilder，因为它更快。StringBuffer的所有方法都是同步的，而你通常不需要同步的方法。

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

Randomrand=newRandom();
//Between1and6,inclusive
intdiceRoll(){
returnrand.nextInt(6)+1;
}

总是使用JavaAPI方法去生成一个整数范围内的随机数。

不要试图去使用Math.abs(rand.nextInt())%n这些不确定的用法，因为它的结果是有偏差的。此外，它的结果值有可能是负数，比如当rand.nextInt()==Integer.MIN_VALUE时就会如此。

使用Iterator.remove()

voidfilter(Listlist){
for(Iteratoriter=list.iterator();iter.hasNext();){
Stringitem=iter.next();
if(...)
iter.remove();
}
}

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

返转字符串

Stringreverse(Strings){
returnnewStringBuilder(s).reverse().toString();
}

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

启动一条线程

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

实现Runnnable的方式：

voidstartAThread0(){
newThread(newMyRunnable()).start();
}
classMyRunnableimplementsRunnable{
publicvoidrun(){
...
}
}

继承Thread的方式：

voidstartAThread1(){
newMyThread().start();
}
classMyThreadextendsThread{
publicvoidrun(){
...
}
}

匿名继承Thread的方式：

voidstartAThread2(){
newThread(){
publicvoidrun(){
...
}
}.start();
}

不要直接调用run()方法。总是调用Thread.start()方法，这个方法会创建一条新的线程并使新建的线程调用run()。

使用try-finally

I/O流例子：

voidwriteStuff()throwsIOException{
OutputStreamout=newFileOutputStream(...);
try{
out.write(...);
}finally{
out.close();
}
}

锁例子：

voiddoWithLock(Locklock){
lock.acquire();
try{
...
}finally{
lock.release();
}
}

如果try之前的语句运行失败并且抛出异常，那么finally语句块就不会执行。但无论怎样，在这个例子里不用担心资源的释放。

如果try语句块里面的语句抛出异常，那么程序的运行就会跳到finally语句块里执行尽可能多的语句，然后跳出这个方法（除非这个方法还有另一个外围的finally语句块）。

从输入流里读取字节数据

InputStreamin=(...);
try{
while(true){
intb=in.read();
if(b==-1)
break;
(...processb...)
}
}finally{
in.close();
}

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

从输入流里读取块数据

InputStreamin=(...);
try{
byte[]buf=newbyte[100];
while(true){
intn=in.read(buf);
if(n==-1)
break;
(...processbufwithoffset=0andlength=n...)
}
}finally{
in.close();
}

要记住的是，read()方法不一定会填满整个buf，所以你必须在处理逻辑中考虑返回的长度。

从文件里读取文本

BufferedReaderin=newBufferedReader(
newInputStreamReader(newFileInputStream(...),"UTF-8"));
try{
while(true){
Stringline=in.readLine();
if(line==null)
break;
(...processline...)
}
}finally{
in.close();
}

BufferedReader对象的创建显得很冗长。这是因为Java把字节和字符当成两个不同的概念来看待（这与C语言不同）。

你可以使用任何类型的InputStream来代替FileInputStream，比如socket。

当达到流的末端时，BufferedReader.readLine()会返回null。

要一次读取一个字符，使用Reader.read()方法。

你可以使用其他的字符编码而不使用UTF-8，但最好不要这样做。

向文件里写文本

PrintWriterout=newPrintWriter(
newOutputStreamWriter(newFileOutputStream(...),"UTF-8"));
try{
out.print("Hello");
out.print(42);
out.println("world!");
}finally{
out.close();
}

Printwriter对象的创建显得很冗长。这是因为Java把字节和字符当成两个不同的概念来看待（这与C语言不同）。

就像System.out，你可以使用print()和println()打印多种类型的值。

你可以使用其他的字符编码而不使用UTF-8，但最好不要这样做。

预防性检测（Defensivechecking）数值

intfactorial(intn){
if(n<0)
thrownewIllegalArgumentException("Undefined");
elseif(n>=13)
thrownewArithmeticException("Resultoverflow");
elseif(n==0)
return1;
else
returnn*factorial(n-1);
}

不要认为输入的数值都是正数、足够小的数等等。要显式地检测这些条件。

一个设计良好的函数应该对所有可能性的输入值都能够正确地执行。要确保所有的情况都考虑到了并且不会产生错误的输出（比如溢出）。

预防性检测对象

intfindIndex(Listlist,Stringtarget){
if(list==null||target==null)
thrownewNullPointerException();
...
}

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

预防性检测数组索引

voidfrob(byte[]b,intindex){
if(b==null)
thrownewNullPointerException();
if(index<0||index>=b.length)
thrownewIndexOutOfBoundsException();
...
}

不要认为所以给的数组索引不会越界。要显式地检测它。

预防性检测数组区间

voidfrob(byte[]b,intoff,intlen){
if(b==null)
thrownewNullPointerException();
if(off<0||off>b.length
||len<0||b.length-off
不要认为所给的数组区间（比如，从off开始，读取len个元素）是不会越界。要显式地检测它。
填充数组元素
使用循环：
//Filleachelementofarray'a'with123
byte[]a=(...);
for(inti=0;i
（优先）使用标准库的方法：
Arrays.fill(a,(byte)123);
复制一个范围内的数组元素
使用循环：
//Copy8elementsfromarray'a'startingatoffset3
//toarray'b'startingatoffset6,
//assuming'a'and'b'aredistinctarrays
byte[]a=(...);
byte[]b=(...);
for(inti=0;i<8;i++)
b[6+i]=a[3+i];
（优先）使用标准库的方法：
System.arraycopy(a,3,b,6,8);
调整数组大小
使用循环（扩大规模）：
//Makearray'a'largertonewLen
byte[]a=(...);
byte[]b=newbyte[newLen];
for(inti=0;i
使用循环（减小规模）：
//Makearray'a'smallertonewLen
byte[]a=(...);
byte[]b=newbyte[newLen];
for(inti=0;i
（优先）使用标准库的方法：
a=Arrays.copyOf(a,newLen);
把4个字节包装（packing）成一个int
intpackBigEndian(byte[]b){
return(b[0]&0xFF)<<24
|(b[1]&0xFF)<<16
|(b[2]&0xFF)<<8
|(b[3]&0xFF)<<0;
}

intpackLittleEndian(byte[]b){
return(b[0]&0xFF)<<0
|(b[1]&0xFF)<<8
|(b[2]&0xFF)<<16
|(b[3]&0xFF)<<24;
}
把int分解（Unpacking）成4个字节
byte[]unpackBigEndian(intx){
returnnewbyte[]{
(byte)(x>>>24),
(byte)(x>>>16),
(byte)(x>>>8),
(byte)(x>>>0)
};
}

byte[]unpackLittleEndian(intx){
returnnewbyte[]{
(byte)(x>>>0),
(byte)(x>>>8),
(byte)(x>>>16),
(byte)(x>>>24)
};
}
总是使用无符号右移操作符（>>>）对位进行包装（packing），不要使用算术右移操作符（>>）。

Java函数习惯用法详解

热门推荐

随机推荐