[IOS] NSInputStream从输入流里读入数据

原文：Reading From Input Streams

ios cocoa 编程，从NSInputStream中读入数据包括几个步骤：

1.从数据源创建和初始化一个NSInputStream实例

2.将输入流对象配置到一个run loop，open the stream

3. 通过流对象的delegate函数处理事件

4. 当所有数据读完，进行流对象的内存处理

一，使用流对象的准备工作

在使用NSInputStream对象之前你必须有流的数据源，数据源的类型可以是文件，NSData对象，或者一个网络套接字。

NSInputStream的初始化函数和工厂方法可以从NSData和文件创建和初始化一个NSInputStream的实例。下面的例子是从文件创建一个NSInputStream的实例：

[cpp]  view plain copy print ?

1. - (void)setUpStreamForFile:(NSString *)path {  
2.     // iStream is NSInputStream instance variable  
3.     iStream = [[NSInputStream alloc] initWithFileAtPath:path];  
4.     [iStream setDelegate:self];  
5.     [iStream scheduleInRunLoop:[NSRunLoop currentRunLoop]  
6.         forMode:NSDefaultRunLoopMode];  
7.     [iStream open];  
8. }  

上面的例子显示，当你创建对象之后你应该设置其delegate。当把 NSInputStream 对象配置到一个run loop，并且有与流相关的事件(例如流中有可读数据)发生时，该对象会收到 stream:handleEvent:消息。

在你open stream之前，给流对象发送一个scheduleInRunLoop:forMode:消息，来将该对象配置到一个run loop接收stream events。这样，当流中没有数据可读时可以避免delegate阻塞。如果流是发生在另一个线程，你需要确认该流对象是配置在那个线程的run loop中。你不应该尝试从一个除了包含该流对象的run loop的线程的其他线程中对流进行操作。最后，对NSInputStream对象发送open消息开始对输入数据的流操作。

二，处理Stream Events

当你对一个流对象发送open消息之后，你可以查找到它的当前状态。通过下面的消息可以知道流对象中是否有数据可读，以及任何错误的属性:

• streamStatus

• hasBytesAvailable

• streamError

返回的状态是一个 NSStreamStatus常量，它可以指示流对象是处于opening，reading，或者at the end of the stream等等。返回的错误是一个NSError对象，它封装了可能发生的所有错误信息。

重要的是，一旦 open 流对象，流对象会一直向其delegate发送stream:handleEvent: 消息直到到达了流对象的末尾。这些消息的参数中包含一个指示流事件类型的NSStreamEvent常量。对NSInputStream对象而言，最常用的事件类型是NSStreamEventOpenCompleted，NSStreamEventHasBytesAvailable，NSStreamEventEndEncountered。我们尤其感兴趣的应该是NSStreamEventHasBytesAvailable事件。下面的例子就是一个处理NSStreamEventHasBytesAvailable事件的好的方法：

[cpp]  view plain copy print ?

1. - (void)stream:(NSStream *)stream handleEvent:(NSStreamEvent)eventCode {  
2.    
3.     switch(eventCode) {  
4.         case NSStreamEventHasBytesAvailable:  
5.         {  
6.             if(!_data) {  
7.                 _data = [[NSMutableData data] retain];  
8.             }  
9.             uint8_t buf[1024];  
10.             unsigned int len = 0;  
11.             len = [(NSInputStream *)stream read:buf maxLength:1024];  
12.             if(len) {  
13.                 [_data appendBytes:(const void *)buf length:len];  
14.                 // bytesRead is an instance variable of type NSNumber.  
15.                 [bytesRead setIntValue:[bytesRead intValue]+len];  
16.             } else {  
17.                 NSLog(@"no buffer!");  
18.             }  
19.             break;  
20.         }  
21.         // continued  
22. }  

stream:handleEvent: 函数使用switch语句来判别NSStreamEvent常量，当这个常量是MSStreamEventHasBytesAvailable的时候，delegate函数会lazy create 一个NSMutableData对象_data来接收读取的数据。然后声明一个大小为1024的uint8_t类型数组buf，调用read:maxLength:函数从stream中读取指定大小的数据到buf中，如果读取成功，delegate将会将读取到的数据添加到NSMutableData对象_data中，并且更新总的读取到的数据bytesRead.

至于一次从stream中读取多大的数据，一般来说，使用一些常用的数据大小规格，比如说512Bytes，1kB，4kB(一个页面大小)。

三，处理stream object

当NSInputStream对象到达steam的末尾的时候，它会向stream:handleEvent:函数发送一个NSStreamEventEndEncountered事件类型常量，delegate函数应该做出与准备使用流对象相反的操作，也就是说，需要关闭流对象，从run loop中移除，最终释放流对象。如下面的代码所示：

[cpp]  view plain copy print ?

1. - (void)stream:(NSStream *)stream handleEvent:(NSStreamEvent)eventCode  
2. {  
3.     switch(eventCode) {  
4.         case NSStreamEventEndEncountered:  
5.         {  
6.             [stream close];  
7.             [stream removeFromRunLoop:[NSRunLoop currentRunLoop]  
8.                 forMode:NSDefaultRunLoopMode];  
9.             [stream release];  
10.             stream = nil; // stream is ivar, so reinit it  
11.             break;  
12.         }  
13.         // continued ...  
14.     }  
15. }