iOS_NSStream使用指南

NSStream简介

stream(流)是编程中的一个基本抽象概念:一系列的位有序的从一个点传输到另一个点。Cocoa提供了三个类代表steam以便于你在程序中使用:NSStream,NSInputStream,NSOutputStream。使用这些类的实例,你可以读或者写数据从文件或者应用程序的内存。你也可使用在基于socket连接的网络中使用这些对象和远程主机交换数据。你也可继承stream类而获取专有的stream操作。常见的Stream应用场景有:读/写取文件,socket通信, 从NSData中读/写数据, 写数据到buffer中。

NSInputStream

NSInputStream 是输入流,对客户端而言,就是读数据。

读文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@interface ViewController ()<NSStreamDelegate>
@property (nonatomic,strong)NSInputStream *istream;
@end
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
//获取所读文件的路径
NSString *path = [[NSBundle mainBundle] pathForResource:@"init" ofType:@"json"];
[self setUpStreamForFile:path];
}
-(void)setUpStreamForFile:(NSString *)path
{
//创建NSInputStream
self.istream = [[NSInputStream alloc] initWithFileAtPath:path];
// 设置delegate
self.istream.delegate = self;
// 加入到Runloop中
[self.istream scheduleInRunLoop:[NSRunLoop currentRunLoop] forMode:NSDefaultRunLoopMode];
// 打开流
[self.istream open];
}
- (void)stream:(NSStream *)aStream handleEvent:(NSStreamEvent)eventCode;
{
switch (eventCode) {
// 有数据可读
case NSStreamEventHasBytesAvailable:
{
//读取数据并打印
NSMutableData *data = [[NSMutableData alloc] init];
uint8_t buf[2048];
NSInteger len = 0;
len = [(NSInputStream *)aStream read:buf maxLength:2048];
if (len) {
[data appendBytes:(const void *)buf length:len];
NSString *str = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
NSLog(@"%@", str);
}else{
NSLog(@"no buffer");
}
break;
}
//读到了流的结尾
case NSStreamEventEndEncountered:{
// 关闭流
[aStream close];
[aStream removeFromRunLoop:[NSRunLoop currentRunLoop] forMode:NSDefaultRunLoopMode];
aStream = nil;
break;
}
default:
break;
}
}

NSOutputStream

NSOutputStream是输入流,对于客户端而言,就是写数据。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
#import "ViewController.h"
@interface ViewController ()<NSStreamDelegate>
{
NSString *pathtxt;
}
@property (nonatomic,strong)NSOutputStream *ostream;
@property (nonatomic,strong)NSData *data;
@property (nonatomic,assign)NSInteger readBytes;
@property (nonatomic,assign)NSInteger byteIndex;
@end
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
NSString *path = [[NSBundle mainBundle] pathForResource:@"init" ofType:@"json"];
self.data = [NSData dataWithContentsOfFile:path];
pathtxt = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES).firstObject;
//建议这个路径一定要是沙盒中的路径,放在工程目录里面是无法写入数据的。
pathtxt = [pathtxt stringByAppendingPathComponent:@"cache.json"];
[self createOutputStream];
}
-(void)createOutputStream
{
self.ostream = [[NSOutputStream alloc] initToFileAtPath:pathtxt append:YES];
self.ostream.delegate = self;
[self.ostream scheduleInRunLoop:[NSRunLoop currentRunLoop] forMode:NSDefaultRunLoopMode];
[self.ostream open];
}
- (void)stream:(NSStream *)aStream handleEvent:(NSStreamEvent)eventCode;
{
switch (eventCode) {
case NSStreamEventHasSpaceAvailable:
{
self.readBytes += self.byteIndex;
NSUInteger data_len = [_data length];
NSUInteger len = (data_len - self.readBytes >= 1024) ? 1024 : (data_len - self.readBytes);
uint8_t buf[len];
[self.data getBytes:buf range:NSMakeRange(self.readBytes, len)];
len = [(NSOutputStream *)aStream write:buf maxLength:sizeof(buf)];
self.byteIndex = len;
break;
}
case NSStreamEventEndEncountered:
{
[aStream close];
[aStream removeFromRunLoop:[NSRunLoop currentRunLoop]
forMode:NSDefaultRunLoopMode];
aStream = nil; // oStream is instance variable
break;
}
default:
break;
}
}
@end

RunLoop的作用

我们都知道RunLoop可以保留线程不释放,有任务的时候执行,没有任务的时候休息并且不阻塞UI线程。我们在对流进行读/写操作时候,如果没有runloop我们需要一次性将流中的数据读完或者写完,这显然是不现实的,那么我们可以通过另一种方式进行分段读取。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
while (1) {
if (len == 0) break;
if ([oStream hasSpaceAvailable])
{
(void)strncpy(buf, readBytes, len);
readBytes += len;
if ([oStream write:(const uint8_t *)buf maxLength:len] == -1)
{
[self handleError:[oStream streamError]];
break;
}
[bytesWritten setIntValue:[bytesWritten intValue]+len];
len = (([data length] - [bytesWritten intValue] >= 1024) ? 1024 : [data length] - [bytesWritten intValue]);
}
}

使用while循环,每次读取一定的字节并记录读取的位置,知道读取完毕,结束white循环。这么做也能达到我们的目的,但是显然这会造成阻塞线程。所以最好的方法还是使用runloop监听数据源是否可读/写。

参考

Stream Programming Guide
南峰子的博客