在JDK 1.4以前,Java的IO操作集中在java.io這個(gè)包中,是基于流的同步(blocking)API。對(duì)于大多數(shù)應(yīng)用來說,這樣的API使用很方便,然而,一些對(duì)性能要求較高的應(yīng)用,尤其是服務(wù)端應(yīng)用,往往需要一個(gè)更為有效的方式來處理IO。從JDK 1.4起,NIO API作為一個(gè)基于緩沖區(qū),并能提供異步(non-blocking)IO操作的API被引入。本文對(duì)其進(jìn)行深入的介紹。
NIO API主要集中在java.nio和它的subpackages中:
java.nio
定義了Buffer及其數(shù)據(jù)類型相關(guān)的子類。其中被java.nio.channels中的類用來進(jìn)行IO操作的ByteBuffer的作用非常重要。
java.nio.channels
定義了一系列處理IO的Channel接口以及這些接口在文件系統(tǒng)和網(wǎng)絡(luò)通訊上的實(shí)現(xiàn)。通過Selector這個(gè)類,還提供了進(jìn)行異步IO操作的辦法。這個(gè)包可以說是NIO API的核心。
java.nio.channels.spi
定義了可用來實(shí)現(xiàn)channel和selector API的抽象類。
java.nio.charset
定義了處理字符編碼和解碼的類。
java.nio.charset.spi
定義了可用來實(shí)現(xiàn)charset API的抽象類。
java.nio.channels.spi和java.nio.charset.spi這兩個(gè)包主要被用來對(duì)現(xiàn)有NIO API進(jìn)行擴(kuò)展,在實(shí)際的使用中,我們一般只和另外的3個(gè)包打交道。下面將對(duì)這3個(gè)包一一介紹。
Package java.nio
這個(gè)包主要定義了Buffer及其子類。Buffer定義了一個(gè)線性存放primitive type數(shù)據(jù)的容器接口。對(duì)于除boolean以外的其他primitive type,都有一個(gè)相應(yīng)的Buffer子類,ByteBuffer是其中最重要的一個(gè)子類。
下面這張UML類圖描述了java.nio中的類的關(guān)系:

Buffer
定義了一個(gè)可以線性存放primitive type數(shù)據(jù)的容器接口。Buffer主要包含了與類型(byte, char…)無關(guān)的功能。值得注意的是Buffer及其子類都不是線程安全的。
每個(gè)Buffer都有以下的屬性:
capacity
這個(gè)Buffer最多能放多少數(shù)據(jù)。capacity一般在buffer被創(chuàng)建的時(shí)候指定。
limit
在Buffer上進(jìn)行的讀寫操作都不能越過這個(gè)下標(biāo)。當(dāng)寫數(shù)據(jù)到buffer中時(shí),limit一般和capacity相等,當(dāng)讀數(shù)據(jù)時(shí),limit代表buffer中有效數(shù)據(jù)的長(zhǎng)度。
position
讀/寫操作的當(dāng)前下標(biāo)。當(dāng)使用buffer的相對(duì)位置進(jìn)行讀/寫操作時(shí),讀/寫會(huì)從這個(gè)下標(biāo)進(jìn)行,并在操作完成后,buffer會(huì)更新下標(biāo)的值。
mark
一個(gè)臨時(shí)存放的位置下標(biāo)。調(diào)用mark()會(huì)將mark設(shè)為當(dāng)前的position的值,以后調(diào)用reset()會(huì)將position屬性設(shè)置為mark的值。mark的值總是小于等于position的值,如果將position的值設(shè)的比mark小,當(dāng)前的mark值會(huì)被拋棄掉。
這些屬性總是滿足以下條件:
0 <= mark <= position <= limit <= capacity
limit和position的值除了通過limit()和position()函數(shù)來設(shè)置,也可以通過下面這些函數(shù)來改變:
Buffer clear()
把position設(shè)為0,把limit設(shè)為capacity,一般在把數(shù)據(jù)寫入Buffer前調(diào)用。
Buffer flip()
把limit設(shè)為當(dāng)前position,把position設(shè)為0,一般在從Buffer讀出數(shù)據(jù)前調(diào)用。
Buffer rewind()
把position設(shè)為0,limit不變,一般在把數(shù)據(jù)重寫入Buffer前調(diào)用。
Buffer對(duì)象有可能是只讀的,這時(shí),任何對(duì)該對(duì)象的寫操作都會(huì)觸發(fā)一個(gè)ReadOnlyBufferException。isReadOnly()方法可以用來判斷一個(gè)Buffer是否只讀。
ByteBuffer
在Buffer的子類中,ByteBuffer是一個(gè)地位較為特殊的類,因?yàn)樵?/span>java.io.channels中定義的各種channel的IO操作基本上都是圍繞ByteBuffer展開的。
ByteBuffer定義了4個(gè)static方法來做創(chuàng)建工作:
ByteBuffer allocate(int capacity)
創(chuàng)建一個(gè)指定capacity的ByteBuffer。
ByteBuffer allocateDirect(int capacity)
創(chuàng)建一個(gè)direct的ByteBuffer,這樣的ByteBuffer在參與IO操作時(shí)性能會(huì)更好(很有可能是在底層的實(shí)現(xiàn)使用了DMA技術(shù)),相應(yīng)的,創(chuàng)建和回收direct的ByteBuffer的代價(jià)也會(huì)高一些。isDirect()方法可以檢查一個(gè)buffer是否是direct的。
ByteBuffer wrap(byte [] array)
ByteBuffer wrap(byte [] array, int offset, int length)
把一個(gè)byte數(shù)組或byte數(shù)組的一部分包裝成ByteBuffer。
ByteBuffer定義了一系列get和put操作來從中讀寫byte數(shù)據(jù),如下面幾個(gè):
byte get()
ByteBuffer get(byte [] dst)
byte get(int index)
ByteBuffer put(byte b)
ByteBuffer put(byte [] src)
ByteBuffer put(int index, byte b)
這些操作可分為絕對(duì)定位和相對(duì)定為兩種,相對(duì)定位的讀寫操作依靠position來定位Buffer中的位置,并在操作完成后會(huì)更新position的值。
在其它類型的buffer中,也定義了相同的函數(shù)來讀寫數(shù)據(jù),唯一不同的就是一些參數(shù)和返回值的類型。
除了讀寫byte類型數(shù)據(jù)的函數(shù),ByteBuffer的一個(gè)特別之處是它還定義了讀寫其它primitive數(shù)據(jù)的方法,如:
int getInt()
從ByteBuffer中讀出一個(gè)int值。
ByteBuffer putInt(int value)
寫入一個(gè)int值到ByteBuffer中。
讀寫其它類型的數(shù)據(jù)牽涉到字節(jié)序問題,ByteBuffer會(huì)按其字節(jié)序(大字節(jié)序或小字節(jié)序)寫入或讀出一個(gè)其它類型的數(shù)據(jù)(int,long…)。字節(jié)序可以用order方法來取得和設(shè)置:
ByteOrder order()
返回ByteBuffer的字節(jié)序。
ByteBuffer order(ByteOrder bo)
設(shè)置ByteBuffer的字節(jié)序。
ByteBuffer另一個(gè)特別的地方是可以在它的基礎(chǔ)上得到其它類型的buffer。如:
CharBuffer asCharBuffer()
為當(dāng)前的ByteBuffer創(chuàng)建一個(gè)CharBuffer的視圖。在該視圖buffer中的讀寫操作會(huì)按照ByteBuffer的字節(jié)序作用到ByteBuffer中的數(shù)據(jù)上。
用這類方法創(chuàng)建出來的buffer會(huì)從ByteBuffer的position位置開始到limit位置結(jié)束,可以看作是這段數(shù)據(jù)的視圖。視圖buffer的readOnly屬性和direct屬性與ByteBuffer的一致,而且也只有通過這種方法,才可以得到其他數(shù)據(jù)類型的direct buffer。
ByteOrder
用來表示ByteBuffer字節(jié)序的類,可將其看成java中的enum類型。主要定義了下面幾個(gè)static方法和屬性:
ByteOrder BIG_ENDIAN
代表大字節(jié)序的ByteOrder。
ByteOrder LITTLE_ENDIAN
代表小字節(jié)序的ByteOrder。
ByteOrder nativeOrder()
返回當(dāng)前硬件平臺(tái)的字節(jié)序。
MappedByteBuffer
ByteBuffer的子類,是文件內(nèi)容在內(nèi)存中的映射。這個(gè)類的實(shí)例需要通過FileChannel的map()方法來創(chuàng)建。
接下來看看一個(gè)使用ByteBuffer的例子,這個(gè)例子從標(biāo)準(zhǔn)輸入不停地讀入字符,當(dāng)讀滿一行后,將收集的字符寫到標(biāo)準(zhǔn)輸出:
public static void main(String [] args)
throws IOException
{
// 創(chuàng)建一個(gè)capacity為256的ByteBuffer
ByteBuffer buf = ByteBuffer.allocate(256);
while (true) {
// 從標(biāo)準(zhǔn)輸入流讀入一個(gè)字符
int c = System.in.read();
// 當(dāng)讀到輸入流結(jié)束時(shí),退出循環(huán)
if (c == -1)
break;
// 把讀入的字符寫入ByteBuffer中
buf.put((byte) c);
// 當(dāng)讀完一行時(shí),輸出收集的字符
if (c == '"n') {
// 調(diào)用flip()使limit變?yōu)楫?dāng)前的position的值,position變?yōu)?/span>0,
// 為接下來從ByteBuffer讀取做準(zhǔn)備
buf.flip();
// 構(gòu)建一個(gè)byte數(shù)組
byte [] content = new byte[buf.limit()];
// 從ByteBuffer中讀取數(shù)據(jù)到byte數(shù)組中
buf.get(content);
// 把byte數(shù)組的內(nèi)容寫到標(biāo)準(zhǔn)輸出
System.out.print(new String(content));
// 調(diào)用clear()使position變?yōu)?/span>0,limit變?yōu)?/span>capacity的值,
// 為接下來寫入數(shù)據(jù)到ByteBuffer中做準(zhǔn)備
buf.clear();
}
}
}
|
Package java.nio.channels
這個(gè)包定義了Channel的概念,Channel表現(xiàn)了一個(gè)可以進(jìn)行IO操作的通道(比如,通過FileChannel,我們可以對(duì)文件進(jìn)行讀寫操作)。java.nio.channels包含了文件系統(tǒng)和網(wǎng)絡(luò)通訊相關(guān)的channel類。這個(gè)包通過Selector和SelectableChannel這兩個(gè)類,還定義了一個(gè)進(jìn)行異步(non-blocking)IO操作的API,這對(duì)需要高性能IO的應(yīng)用非常重要。
下面這張UML類圖描述了java.nio.channels中interface的關(guān)系:

Channel
Channel表現(xiàn)了一個(gè)可以進(jìn)行IO操作的通道,該interface定義了以下方法:
boolean isOpen()
該Channel是否是打開的。
void close()
關(guān)閉這個(gè)Channel,相關(guān)的資源會(huì)被釋放。
ReadableByteChannel
定義了一個(gè)可從中讀取byte數(shù)據(jù)的channel interface。
int read(ByteBuffer dst)
從channel中讀取byte數(shù)據(jù)并寫到ByteBuffer中。返回讀取的byte數(shù)。
WritableByteChannel
定義了一個(gè)可向其寫byte數(shù)據(jù)的channel interface。
int write(ByteBuffer src)
從ByteBuffer中讀取byte數(shù)據(jù)并寫到channel中。返回寫出的byte數(shù)。
ByteChannel
ByteChannel并沒有定義新的方法,它的作用只是把ReadableByteChannel和WritableByteChannel合并在一起。
ScatteringByteChannel
繼承了ReadableByteChannel并提供了同時(shí)往幾個(gè)ByteBuffer中寫數(shù)據(jù)的能力。
GatheringByteChannel
繼承了WritableByteChannel并提供了同時(shí)從幾個(gè)ByteBuffer中讀數(shù)據(jù)的能力。
InterruptibleChannel
用來表現(xiàn)一個(gè)可以被異步關(guān)閉的Channel。這表現(xiàn)在兩方面:
1. 當(dāng)一個(gè)InterruptibleChannel的close()方法被調(diào)用時(shí),其它block在這個(gè)InterruptibleChannel的IO操作上的線程會(huì)接收到一個(gè)AsynchronousCloseException。
2. 當(dāng)一個(gè)線程block在InterruptibleChannel的IO操作上時(shí),另一個(gè)線程調(diào)用該線程的interrupt()方法會(huì)導(dǎo)致channel被關(guān)閉,該線程收到一個(gè)ClosedByInterruptException,同時(shí)線程的interrupt狀態(tài)會(huì)被設(shè)置。
接下來的這張UML類圖描述了java.nio.channels中類的關(guān)系:

異步IO
異步IO的支持可以算是NIO API中最重要的功能,異步IO允許應(yīng)用程序同時(shí)監(jiān)控多個(gè)channel以提高性能,這一功能是通過Selector,SelectableChannel和SelectionKey這3個(gè)類來實(shí)現(xiàn)的。
SelectableChannel代表了可以支持異步IO操作的channel,可以將其注冊(cè)在Selector上,這種注冊(cè)的關(guān)系由SelectionKey這個(gè)類來表現(xiàn)(見UML圖)。Selector這個(gè)類通過select()函數(shù),給應(yīng)用程序提供了一個(gè)可以同時(shí)監(jiān)控多個(gè)IO channel的方法:
應(yīng)用程序通過調(diào)用select()函數(shù),讓Selector監(jiān)控注冊(cè)在其上的多個(gè)SelectableChannel,當(dāng)有channel的IO操作可以進(jìn)行時(shí),select()方法就會(huì)返回以讓應(yīng)用程序檢查channel的狀態(tài),并作相應(yīng)的處理。
下面是JDK 1.4中異步IO的一個(gè)例子,這段code使用了異步IO實(shí)現(xiàn)了一個(gè)time server:
private static void acceptConnections(int port) throws Exception {
// 打開一個(gè)Selector
Selector acceptSelector =
SelectorProvider.provider().openSelector();
// 創(chuàng)建一個(gè)ServerSocketChannel,這是一個(gè)SelectableChannel的子類
ServerSocketChannel ssc = ServerSocketChannel.open();
// 將其設(shè)為non-blocking狀態(tài),這樣才能進(jìn)行異步IO操作
ssc.configureBlocking(false);
// 給ServerSocketChannel對(duì)應(yīng)的socket綁定IP和端口
InetAddress lh = InetAddress.getLocalHost();
InetSocketAddress isa = new InetSocketAddress(lh, port);
ssc.socket().bind(isa);
// 將ServerSocketChannel注冊(cè)到Selector上,返回對(duì)應(yīng)的SelectionKey
SelectionKey acceptKey =
ssc.register(acceptSelector, SelectionKey.OP_ACCEPT);
int keysAdded = 0;
// 用select()函數(shù)來監(jiān)控注冊(cè)在Selector上的SelectableChannel
// 返回值代表了有多少channel可以進(jìn)行IO操作 (ready for IO)
while ((keysAdded = acceptSelector.select()) > 0) {
// selectedKeys()返回一個(gè)SelectionKey的集合,
// 其中每個(gè)SelectionKey代表了一個(gè)可以進(jìn)行IO操作的channel。
// 一個(gè)ServerSocketChannel可以進(jìn)行IO操作意味著有新的TCP連接連入了
Set readyKeys = acceptSelector.selectedKeys();
Iterator i = readyKeys.iterator();
while (i.hasNext()) {
SelectionKey sk = (SelectionKey) i.next();
// 需要將處理過的key從selectedKeys這個(gè)集合中刪除
i.remove();
// 從SelectionKey得到對(duì)應(yīng)的channel
ServerSocketChannel nextReady =
(ServerSocketChannel) sk.channel();
// 接受新的TCP連接
Socket s = nextReady.accept().socket();
// 把當(dāng)前的時(shí)間寫到這個(gè)新的TCP連接中
PrintWriter out =
new PrintWriter(s.getOutputStream(), true);
Date now = new Date();
out.println(now);
// 關(guān)閉連接
out.close();
}
}
}
|
這是個(gè)純粹用于演示的例子,因?yàn)橹挥幸粋€(gè)ServerSocketChannel需要監(jiān)控,所以其實(shí)并不真的需要使用到異步IO。不過正因?yàn)樗暮?jiǎn)單,可以很容易地看清楚異步IO是如何工作的。
SelectableChannel
這個(gè)抽象類是所有支持異步IO操作的channel(如DatagramChannel、SocketChannel)的父類。SelectableChannel可以注冊(cè)到一個(gè)或多個(gè)Selector上以進(jìn)行異步IO操作。
SelectableChannel可以是blocking和non-blocking模式(所有channel創(chuàng)建的時(shí)候都是blocking模式),只有non-blocking的SelectableChannel才可以參與異步IO操作。
SelectableChannel configureBlocking(boolean block)
設(shè)置blocking模式。
boolean isBlocking()
返回blocking模式。
通過register()方法,SelectableChannel可以注冊(cè)到Selector上。
int validOps()
返回一個(gè)bit mask,表示這個(gè)channel上支持的IO操作。當(dāng)前在SelectionKey中,用靜態(tài)常量定義了4種IO操作的bit值:OP_ACCEPT,OP_CONNECT,OP_READ和OP_WRITE。
SelectionKey register(Selector sel, int ops)
將當(dāng)前channel注冊(cè)到一個(gè)Selector上并返回對(duì)應(yīng)的SelectionKey。在這以后,通過調(diào)用Selector的select()函數(shù)就可以監(jiān)控這個(gè)channel。ops這個(gè)參數(shù)是一個(gè)bit mask,代表了需要監(jiān)控的IO操作。
SelectionKey register(Selector sel, int ops, Object att)
這個(gè)函數(shù)和上一個(gè)的意義一樣,多出來的att參數(shù)會(huì)作為attachment被存放在返回的SelectionKey中,這在需要存放一些session state的時(shí)候非常有用。
boolean isRegistered()
該channel是否已注冊(cè)在一個(gè)或多個(gè)Selector上。
SelectableChannel還提供了得到對(duì)應(yīng)SelectionKey的方法:
SelectionKey keyFor(Selector sel)
返回該channe在Selector上的注冊(cè)關(guān)系所對(duì)應(yīng)的SelectionKey。若無注冊(cè)關(guān)系,返回null。
Selector
Selector可以同時(shí)監(jiān)控多個(gè)SelectableChannel的IO狀況,是異步IO的核心。
Selector open()
Selector的一個(gè)靜態(tài)方法,用于創(chuàng)建實(shí)例。
在一個(gè)Selector中,有3個(gè)SelectionKey的集合:
1.key set代表了所有注冊(cè)在這個(gè)Selector上的channel,這個(gè)集合可以通過keys()方法拿到。
2.Selected-key set代表了所有通過select()方法監(jiān)測(cè)到可以進(jìn)行IO操作的channel,這個(gè)集合可以通過selectedKeys()拿到。
3.Cancelled-key set代表了已經(jīng)cancel了注冊(cè)關(guān)系的channel,在下一個(gè)select()操作中,這些channel對(duì)應(yīng)的SelectionKey會(huì)從key set和cancelled-key set中移走。這個(gè)集合無法直接訪問。
以下是select()相關(guān)方法的說明:
int select()
監(jiān)控所有注冊(cè)的channel,當(dāng)其中有注冊(cè)的IO操作可以進(jìn)行時(shí),該函數(shù)返回,并將對(duì)應(yīng)的SelectionKey加入selected-key set。
int select(long timeout)
可以設(shè)置超時(shí)的select()操作。
int selectNow()
進(jìn)行一個(gè)立即返回的select()操作。
Selector wakeup()
使一個(gè)還未返回的select()操作立刻返回。
SelectionKey
代表了Selector和SelectableChannel的注冊(cè)關(guān)系。
Selector定義了4個(gè)靜態(tài)常量來表示4種IO操作,這些常量可以進(jìn)行位操作組合成一個(gè)bit mask。
int OP_ACCEPT
有新的網(wǎng)絡(luò)連接可以accept,ServerSocketChannel支持這一異步IO。
int OP_CONNECT
代表連接已經(jīng)建立(或出錯(cuò)),SocketChannel支持這一異步IO。
int OP_READ
int OP_WRITE
代表了讀、寫操作。
以下是其主要方法:
Object attachment()
返回SelectionKey的attachment,attachment可以在注冊(cè)channel的時(shí)候指定。
Object attach(Object ob)
設(shè)置SelectionKey的attachment。
SelectableChannel channel()
返回該SelectionKey對(duì)應(yīng)的channel。
Selector selector()
返回該SelectionKey對(duì)應(yīng)的Selector。
void cancel()
cancel這個(gè)SelectionKey所對(duì)應(yīng)的注冊(cè)關(guān)系。
int interestOps()
返回代表需要Selector監(jiān)控的IO操作的bit mask。
SelectionKey interestOps(int ops)
設(shè)置interestOps。
int readyOps()
返回一個(gè)bit mask,代表在相應(yīng)channel上可以進(jìn)行的IO操作。
ServerSocketChannel
支持異步操作,對(duì)應(yīng)于java.net.ServerSocket這個(gè)類,提供了TCP協(xié)議IO接口,支持OP_ACCEPT操作。
ServerSocket socket()
返回對(duì)應(yīng)的ServerSocket對(duì)象。
SocketChannel accept()
接受一個(gè)連接,返回代表這個(gè)連接的SocketChannel對(duì)象。
SocketChannel
支持異步操作,對(duì)應(yīng)于java.net.Socket這個(gè)類,提供了TCP協(xié)議IO接口,支持OP_CONNECT,OP_READ和OP_WRITE操作。這個(gè)類還實(shí)現(xiàn)了ByteChannel,ScatteringByteChannel和GatheringByteChannel接口。
DatagramChannel和這個(gè)類比較相似,其對(duì)應(yīng)于java.net.DatagramSocket,提供了UDP協(xié)議IO接口。
Socket socket()
返回對(duì)應(yīng)的Socket對(duì)象。
boolean connect(SocketAddress remote)
boolean finishConnect()
connect()進(jìn)行一個(gè)連接操作。如果當(dāng)前SocketChannel是blocking模式,這個(gè)函數(shù)會(huì)等到連接操作完成或錯(cuò)誤發(fā)生才返回。如果當(dāng)前SocketChannel是non-blocking模式,函數(shù)在連接能立刻被建立時(shí)返回true,否則函數(shù)返回false,應(yīng)用程序需要在以后用finishConnect()方法來完成連接操作。
Pipe
包含了一個(gè)讀和一個(gè)寫的channel(Pipe.SourceChannel和Pipe.SinkChannel),這對(duì)channel可以用于進(jìn)程中的通訊。
FileChannel
用于對(duì)文件的讀、寫、映射、鎖定等操作。和映射操作相關(guān)的類有FileChannel.MapMode,和鎖定操作相關(guān)的類有FileLock。值得注意的是FileChannel并不支持異步操作。
Channels
這個(gè)類提供了一系列static方法來支持stream類和channel類之間的互操作。這些方法可以將channel類包裝為stream類,比如,將ReadableByteChannel包裝為InputStream或Reader;也可以將stream類包裝為channel類,比如,將OutputStream包裝為WritableByteChannel。
Package java.nio.charset
這個(gè)包定義了Charset及相應(yīng)的encoder和decoder。下面這張UML類圖描述了這個(gè)包中類的關(guān)系,可以將其中Charset,CharsetDecoder和CharsetEncoder理解成一個(gè)Abstract Factory模式的實(shí)現(xiàn):

Charset
代表了一個(gè)字符集,同時(shí)提供了factory method來構(gòu)建相應(yīng)的CharsetDecoder和CharsetEncoder。
Charset提供了以下static的方法:
SortedMap availableCharsets()
返回當(dāng)前系統(tǒng)支持的所有Charset對(duì)象,用charset的名字作為set的key。
boolean isSupported(String charsetName)
判斷該名字對(duì)應(yīng)的字符集是否被當(dāng)前系統(tǒng)支持。
Charset forName(String charsetName)
返回該名字對(duì)應(yīng)的Charset對(duì)象。
Charset中比較重要的方法有:
String name()
返回該字符集的規(guī)范名。
Set aliases()
返回該字符集的所有別名。
CharsetDecoder newDecoder()
創(chuàng)建一個(gè)對(duì)應(yīng)于這個(gè)Charset的decoder。
CharsetEncoder newEncoder()
創(chuàng)建一個(gè)對(duì)應(yīng)于這個(gè)Charset的encoder。
CharsetDecoder
將按某種字符集編碼的字節(jié)流解碼為unicode字符數(shù)據(jù)的引擎。
CharsetDecoder的輸入是ByteBuffer,輸出是CharBuffer。進(jìn)行decode操作時(shí)一般按如下步驟進(jìn)行:
1.調(diào)用CharsetDecoder的reset()方法。(第一次使用時(shí)可不調(diào)用)
2.調(diào)用decode()方法0到n次,將endOfInput參數(shù)設(shè)為false,告訴decoder有可能還有新的數(shù)據(jù)送入。
3.調(diào)用decode()方法最后一次,將endOfInput參數(shù)設(shè)為true,告訴decoder所有數(shù)據(jù)都已經(jīng)送入。
4.調(diào)用decoder的flush()方法。讓decoder有機(jī)會(huì)把一些內(nèi)部狀態(tài)寫到輸出的CharBuffer中。
CharsetDecoder reset()
重置decoder,并清除decoder中的一些內(nèi)部狀態(tài)。
CoderResult decode(ByteBuffer in, CharBuffer out, boolean endOfInput)
從ByteBuffer類型的輸入中decode盡可能多的字節(jié),并將結(jié)果寫到CharBuffer類型的輸出中。根據(jù)decode的結(jié)果,可能返回3種CoderResult:CoderResult.UNDERFLOW表示已經(jīng)沒有輸入可以decode;CoderResult.OVERFLOW表示輸出已滿;其它的CoderResult表示decode過程中有錯(cuò)誤發(fā)生。根據(jù)返回的結(jié)果,應(yīng)用程序可以采取相應(yīng)的措施,比如,增加輸入,清除輸出等等,然后再次調(diào)用decode()方法。
CoderResult flush(CharBuffer out)
有些decoder會(huì)在decode的過程中保留一些內(nèi)部狀態(tài),調(diào)用這個(gè)方法讓這些decoder有機(jī)會(huì)將這些內(nèi)部狀態(tài)寫到輸出的CharBuffer中。調(diào)用成功返回CoderResult.UNDERFLOW。如果輸出的空間不夠,該函數(shù)返回CoderResult.OVERFLOW,這時(shí)應(yīng)用程序應(yīng)該擴(kuò)大輸出CharBuffer的空間,然后再次調(diào)用該方法。
CharBuffer decode(ByteBuffer in)
一個(gè)便捷的方法把ByteBuffer中的內(nèi)容decode到一個(gè)新創(chuàng)建的CharBuffer中。在這個(gè)方法中包括了前面提到的4個(gè)步驟,所以不能和前3個(gè)函數(shù)一起使用。
decode過程中的錯(cuò)誤有兩種:malformed-input CoderResult表示輸入中數(shù)據(jù)有誤;unmappable-character CoderResult表示輸入中有數(shù)據(jù)無法被解碼成unicode的字符。如何處理decode過程中的錯(cuò)誤取決于decoder的設(shè)置。對(duì)于這兩種錯(cuò)誤,decoder可以通過CodingErrorAction設(shè)置成:
1.忽略錯(cuò)誤
2.報(bào)告錯(cuò)誤。(這會(huì)導(dǎo)致錯(cuò)誤發(fā)生時(shí),decode()方法返回一個(gè)表示該錯(cuò)誤的CoderResult。)
3.替換錯(cuò)誤,用decoder中的替換字串替換掉有錯(cuò)誤的部分。
CodingErrorAction malformedInputAction()
返回malformed-input的出錯(cuò)處理。
CharsetDecoder onMalformedInput(CodingErrorAction newAction)
設(shè)置malformed-input的出錯(cuò)處理。
CodingErrorAction unmappableCharacterAction()
返回unmappable-character的出錯(cuò)處理。
CharsetDecoder onUnmappableCharacter(CodingErrorAction newAction)
設(shè)置unmappable-character的出錯(cuò)處理。
String replacement()
返回decoder的替換字串。
CharsetDecoder replaceWith(String newReplacement)
設(shè)置decoder的替換字串。
CharsetEncoder
將unicode字符數(shù)據(jù)編碼為特定字符集的字節(jié)流的引擎。其接口和CharsetDecoder相類似。
CoderResult
描述encode/decode操作結(jié)果的類。
CodeResult包含兩個(gè)static成員:
CoderResult OVERFLOW
表示輸出已滿
CoderResult UNDERFLOW
表示輸入已無數(shù)據(jù)可用。
其主要的成員函數(shù)有:
boolean isError()
boolean isMalformed()
boolean isUnmappable()
boolean isOverflow()
boolean isUnderflow()
用于判斷該CoderResult描述的錯(cuò)誤。
int length()
返回錯(cuò)誤的長(zhǎng)度,比如,無法被轉(zhuǎn)換成unicode的字節(jié)長(zhǎng)度。
void throwException()
拋出一個(gè)和這個(gè)CoderResult相對(duì)應(yīng)的exception。
CodingErrorAction
表示encoder/decoder中錯(cuò)誤處理方法的類。可將其看成一個(gè)enum類型。有以下static屬性:
CodingErrorAction IGNORE
忽略錯(cuò)誤。
CodingErrorAction REPLACE
用替換字串替換有錯(cuò)誤的部分。
CodingErrorAction REPORT
報(bào)告錯(cuò)誤,對(duì)于不同的函數(shù),有可能是返回一個(gè)和錯(cuò)誤有關(guān)的CoderResult,也有可能是拋出一個(gè)CharacterCodingException。
參考文獻(xiàn)
David Flanagan – Java in a Nutshell