Reachability 项目技术文档

1. 安装指南

首先，将 Reachability 的 .h 和 .m 文件添加到您的项目中。然后，执行以下步骤：

• 转到 项目设置 -> Targets -> Build Phases -> Link Binary With Libraries。
• 点击列表左下角的加号。
• 添加 SystemConfiguration.framework。

完成以上步骤后，您的项目就可以使用 Reachability 类了。

2. 项目的使用说明

Reachability 是一个用于检测网络连接状态的类，完全兼容 ARC，并使用新的 GCD 方法通知网络接口的更改。它不仅支持标准的 NSNotification，还允许使用块（blocks）来通知网络变为可达和不可达的状态。

2.1 使用 Blocks

以下是如何在 Objective-C 和 Swift 中使用 Blocks 的示例：

Objective-C 示例

// 创建 Reachability 对象
Reachability* reach = [Reachability reachabilityWithHostname:@"www.google.com"];

// 设置 Blocks
reach.reachableBlock = ^(Reachability*reach) {
    dispatch_async(dispatch_get_main_queue(), ^{
        NSLog(@"网络可达！");
    });
};

reach.unreachableBlock = ^(Reachability*reach) {
    NSLog(@"网络不可达！");
};

// 启动通知器
[reach startNotifier];

Swift 3 示例

import Reachability

var reach: Reachability?

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    // 创建 Reachability 对象
    self.reach = Reachability.forInternetConnection()
    
    // 设置 Blocks
    self.reach!.reachableBlock = {
        (reach: Reachability?) -> Void in
        DispatchQueue.main.async {
            print("网络可达！")
        }
    }
    
    self.reach!.unreachableBlock = {
        (reach: Reachability?) -> Void in
        print("网络不可达！")
    }
    
    self.reach!.startNotifier()
    
    return true
}

2.2 使用 NSNotification

以下是如何在 Objective-C 和 Swift 中使用 NSNotification 的示例：

Objective-C 示例

// 创建 Reachability 对象
Reachability* reach = [Reachability reachabilityWithHostname:@"www.google.com"];

// 设置 Reachability 不在 WWAN 上视为可达
reach.reachableOnWWAN = NO;

// 添加 NSNotification 监听器
[[NSNotificationCenter defaultCenter] addObserver:self
                                         selector:@selector(reachabilityChanged:])
                                             name:kReachabilityChangedNotification
                                           object:nil];

[reach startNotifier];

Swift 3 示例

import Reachability

var reach: Reachability?

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    // 创建 Reachability 对象
    self.reach = Reachability.forInternetConnection()
    
    // 设置 Reachability 不在 WWAN 上视为可达
    self.reach!.reachableOnWWAN = false
    
    // 添加 NSNotification 监听器
    NotificationCenter.default.addObserver(
        self,
        selector: #selector(reachabilityChanged),
        name: NSNotification.Name.reachabilityChanged,
        object: nil
    )
    
    self.reach!.startNotifier()
    
    return true
}

func reachabilityChanged(notification: NSNotification) {
    if self.reach!.isReachableViaWiFi() || self.reach!.isReachableViaWWAN() {
        print("服务可用！")
    } else {
        print("服务不可用！")
    }
}

3. 项目API使用文档

Reachability 类提供了以下主要方法和属性：

• + (instancetype)reachabilityWithHostname:(NSString *)hostname;：根据主机名创建 Reachability 对象。
• - (void)startNotifier;：开始监听网络状态变化。
• - (void)stopNotifier;：停止监听网络状态变化。
• @property (nonatomic, copy) dispatch_block_t reachableBlock;：网络变为可达时执行的块。
• @property (nonatomic, copy) dispatch_block_t unreachableBlock;：网络变为不可达时执行的块。
• @property (nonatomic, assign) BOOL reachableOnWWAN;：指定是否将 WWAN 连接视为可达。

4. 项目安装方式

Reachability 可以通过将源文件添加到项目中来进行安装。目前不支持通过 CocoaPods 或其他包管理工具进行安装。如需使用，请按照“安装指南”中的步骤操作。