NPReachability 技术文档

1. 安装指南

1.1 使用 Git 安装

1. 将项目作为子模块添加到你的项目仓库中。
2. 将 NPReachability.h 和 NPReachability.m 文件添加到你的项目中。

1.2 使用 CocoaPods 安装

1. 如果你使用 CocoaPods，可以在 Podfile 中添加以下内容：

   pod 'NPReachability'
   

2. 运行 pod install 命令进行安装。

1.3 直接添加文件

1. 将 NPReachability.h 和 NPReachability.m 文件直接添加到你的项目中。
2. 推荐使用前两种方法，因为它们更为方便。

2. 项目的使用说明

2.1 初始化

NPReachability 是一个单例类，使用时需要通过以下方式获取实例：

NPReachability *reachability = [NPReachability sharedInstance];

确保在代码中至少保持对一个该类对象的强引用，否则 ARC 会在你不注意时清理掉它。

2.2 网络状态监听

NPReachability 提供了三种方式来监听网络状态的变化：

2.2.1 使用 Block

你可以通过以下方式添加一个 Block 来处理网络状态变化：

[reachability addHandler:^(NPReachability *curReach) {
    // 处理网络状态变化的代码
}];

返回的对象是一个不透明的对象，你需要在适当的时候（例如在 dealloc 方法中）移除该处理程序：

[reachability removeHandler:opaqueObject];

2.2.2 使用 KVO

你可以观察以下两个属性来监听网络状态的变化：

@property (nonatomic, readonly, getter=isCurrentlyReachable) BOOL currentlyReachable;
@property (nonatomic, readonly) SCNetworkReachabilityFlags currentReachabilityFlags;

2.2.3 使用 NSNotification

当网络状态变化时，会发送一个 NPReachabilityChangedNotification 通知，通知对象是 NPReachability 实例。

3. 项目API使用文档

3.1 主要API

• + (NPReachability *)sharedInstance;

  • 获取 NPReachability 的单例实例。

• - (id)addHandler:(ReachabilityHandler)handler;

  • 添加一个 Block 处理程序，用于处理网络状态变化。

• - (void)removeHandler:(id)opaqueObject;

  • 移除之前添加的 Block 处理程序。

3.2 属性

• @property (nonatomic, readonly, getter=isCurrentlyReachable) BOOL currentlyReachable;

  • 当前网络是否可达。

• @property (nonatomic, readonly) SCNetworkReachabilityFlags currentReachabilityFlags;

  • 当前网络状态的标志位。

4. 项目安装方式

4.1 使用 Git

1. 将项目作为子模块添加到你的项目仓库中。
2. 将 NPReachability.h 和 NPReachability.m 文件添加到你的项目中。

4.2 使用 CocoaPods

1. 在 Podfile 中添加：

   pod 'NPReachability'
   

2. 运行 pod install 命令进行安装。

4.3 直接添加文件

1. 将 NPReachability.h 和 NPReachability.m 文件直接添加到你的项目中。

通过以上步骤，你可以成功安装并使用 NPReachability 项目来监听网络状态的变化。