MBProgressHUD源码学习2：实现方式简单分析

提要：

1. “全能”实现方法；
2. “延后显示”和“最少显示时间”；
3. 使用KVO更新UI；
4. 使用通知方式处理自身视图的朝向变化；
5. 总结

   1. “全能”实现方法

“全能”实现方法，即真正用于实现功能的方法。这一封装方式在MBProgressHUD.m中屡见不鲜。如“全能”初始化方法initWithFrame：

/** 全能初始化方法 */
- (id)initWithFrame:(CGRect)frame {
	self = [super initWithFrame:frame];
	if (self) {
		// 各种属性初始值设置
		...
		
        // 初始化label
		[self setupLabels];
        // 加载indicator
		[self updateIndicators];
        // 注册KVO，将UI的属性修改绑定到一起
		[self registerForKVO];
        // 注册屏幕朝向通知，自动旋转
		[self registerForNotifications];
	}
	return self;
}

- (id)initWithView:(UIView *)view {
	NSAssert(view, @"View must not be nil.");
	return [self initWithFrame:view.bounds];
}

- (id)initWithWindow:(UIWindow *)window {
	return [self initWithView:window];
}

在以上代码中，可以看出，外部API使用的初始化最终都是通过调用initWithFrame方法完成的。该方法的主要功能如下：

• 提供了主要属性的初始赋值；
• 对用于显示信息的的UILabel对象进行初始化，真正的布局在layoutSubView中进行处理；
• 根据mode属性，对不同类型的indicator视图对象进行初始化；
• 通过KVO，将用于更新UI的相关属性进行统一配置；
• 使用通知，监听系统屏幕转向消息，配置视图转向重绘方法。

类似的封装方式，在本类中还体现在：

1. 如线程block的任务配置api中，showAnimated:whileExecutingBlock:onQueue:completionBlock:方法作为真正的实现方法，其余均为本方法的不同调用版本。
2. 显示和隐藏HUD方法，分别通过showUsingAnimation:和hideUsingAnimation:方法进行真正的功能实现。

这种封装方式的好处是使实现代码集中，便于管理，且不易出错。

2. “延后显示”和“最少显示时间”

1. MBProgressHUD中，存在graceTime这一属性，其意义为“延迟一定的时间显示HUD”。即当任务运行时间过短的情况下，防止“闪烁”情况发生（HUD刚刚显示就隐藏）。此值需要我们手动设置，默认为0。

/** 显示自身 */
- (void)show:(BOOL)animated {
	useAnimation = animated;
	// 设置了graceTime后，就会延时显示了
	if (self.graceTime > 0.0) {
		self.graceTimer = [NSTimer scheduledTimerWithTimeInterval:self.graceTime target:self 
						   selector:@selector(handleGraceTimer:) userInfo:nil repeats:NO];
	} 
	// 直接显示
	else {
		[self showUsingAnimation:useAnimation];
	}
}

- (void)handleGraceTimer:(NSTimer *)theTimer {
	// 任务执行期间，才会显示；否则就不必显示HUD了
	if (taskInProgress) {
		[self showUsingAnimation:useAnimation];
	}
}

1. 代码中还存在minShowTime这一属性，即“最小显示时长”。用于在HUD隐藏时，当少于指定显示时长时延迟消失时机，防止“闪烁”情况发生：

/** 隐藏自身 */
- (void)hide:(BOOL)animated {
	useAnimation = animated;
    // 存在最小显示时长，并且HUD已经在显示（showStarted中保存了显示时刻）
	if (self.minShowTime > 0.0 && showStarted) {
        // 计算已显示时长
		NSTimeInterval interv = [[NSDate date] timeIntervalSinceDate:showStarted];
		if (interv < self.minShowTime) {
            // 小于最小显示时长，则补齐时长后，执行隐藏功能（防止过早隐藏，出现闪烁）
			self.minShowTimer = [NSTimer scheduledTimerWithTimeInterval:(self.minShowTime - interv) target:self 
								selector:@selector(handleMinShowTimer:) userInfo:nil repeats:NO];
			return;
		} 
	}
	// 直接隐藏
	[self hideUsingAnimation:useAnimation];
}

- (void)handleMinShowTimer:(NSTimer *)theTimer {
	[self hideUsingAnimation:useAnimation];
}

3. 使用KVO更新UI

对于MBProgressHUD中过于繁杂的各种配置属性（如mode、progress、各种文字及样式颜色等），设置后都需要进行UI更新。为了进行统一管理，且降低代码复杂程度，源码中使用了KVO的方式进行处理：

- (void)registerForKVO {
    // 依次设置需要的实例变量为KVO
	for (NSString *keyPath in [self observableKeypaths]) {
		[self addObserver:self forKeyPath:keyPath options:NSKeyValueObservingOptionNew context:NULL];
	}
}

- (NSArray *)observableKeypaths {
    // 返回所有需要设置为KVO的实例变量
	return [NSArray arrayWithObjects:@"mode", @"customView", @"labelText", @"labelFont", @"labelColor",
			@"detailsLabelText", @"detailsLabelFont", @"detailsLabelColor", @"progress", @"activityIndicatorColor", nil];
}

- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
    // 由于所有KVO监听的实例变量均为UI相关，确保在主线程设置
	if (![NSThread isMainThread]) {
		[self performSelectorOnMainThread:@selector(updateUIForKeypath:) withObject:keyPath waitUntilDone:NO];
	} else {
		[self updateUIForKeypath:keyPath];
	}
}

- (void)updateUIForKeypath:(NSString *)keyPath {
    // 统一进行属性设置
	if ([keyPath isEqualToString:@"mode"] || [keyPath isEqualToString:@"customView"] ||
		[keyPath isEqualToString:@"activityIndicatorColor"]) {
		[self updateIndicators];
	} else if ([keyPath isEqualToString:@"labelText"]) {
		label.text = self.labelText;
	} else if ([keyPath isEqualToString:@"labelFont"]) {
		label.font = self.labelFont;
	} else if ([keyPath isEqualToString:@"labelColor"]) {
		label.textColor = self.labelColor;
	} else if ([keyPath isEqualToString:@"detailsLabelText"]) {
		detailsLabel.text = self.detailsLabelText;
	} else if ([keyPath isEqualToString:@"detailsLabelFont"]) {
		detailsLabel.font = self.detailsLabelFont;
	} else if ([keyPath isEqualToString:@"detailsLabelColor"]) {
		detailsLabel.textColor = self.detailsLabelColor;
	} else if ([keyPath isEqualToString:@"progress"]) {
		if ([indicator respondsToSelector:@selector(setProgress:)]) {
			[(id)indicator setValue:@(progress) forKey:@"progress"];
		}
		return;
	}
    // 设置完成后，更新布局（label等）并重绘界面（progress等）
	[self setNeedsLayout];
	[self setNeedsDisplay];
}

通过updateUIForKeypath:方法，统一对所有UI相关修改进行属性设置，并在最后统一绘制并刷新布局，完成UI更新。

移除KVO监听时，使用同样的方式：

- (void)unregisterFromKVO {
    // 依次移除KVO监听
	for (NSString *keyPath in [self observableKeypaths]) {
		[self removeObserver:self forKeyPath:keyPath];
	}
}

- (NSArray *)observableKeypaths {
    // 返回所有需要设置为KVO的实例变量
	return [NSArray arrayWithObjects:@"mode", @"customView", @"labelText", @"labelFont", @"labelColor",
			@"detailsLabelText", @"detailsLabelFont", @"detailsLabelColor", @"progress", @"activityIndicatorColor", nil];
}

4. 使用通知方式处理自身视图的朝向变化

在设备朝向发生改变时，通过监听系统通知事件（UIApplicationDidChangeStatusBarOrientationNotification），重绘自身，以适应视图转向：

- (void)registerForNotifications {
	NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
    // 监听屏幕旋转消息
	[nc addObserver:self selector:@selector(statusBarOrientationDidChange:)
			   name:UIApplicationDidChangeStatusBarOrientationNotification object:nil];
}

- (void)unregisterFromNotifications {
	NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
	[nc removeObserver:self name:UIApplicationDidChangeStatusBarOrientationNotification object:nil];
}

- (void)statusBarOrientationDidChange:(NSNotification *)notification {
	UIView *superview = self.superview;
	if (!superview) {
		return;
	} else {
        // 依附于父视图上，则进行自身更新
		[self updateForCurrentOrientationAnimated:YES];
	}
}

- (void)updateForCurrentOrientationAnimated:(BOOL)animated {
    // Stay in sync with the superview in any case
    if (self.superview) {
        // 自身尺寸为转向后的父视图尺寸
        self.bounds = self.superview.bounds;
        // 重绘自身，更新为新样式
        [self setNeedsDisplay];
    }
    ...
}

5. 总结

1. 高效统一的UI更新：由于源码中将视图组件（如UILabel和）的布局配置封装于layoutSubView:方法中；将HUD的背景图及progress进度条绘制置于drawRect:方法中，故可以在任意时机通过调用setNeedsLayout以及setNeedsDisplay统一更新UI。再通过KVO、通知等方式统一进行绑定，实现了高效率的UI更新及代码规范的封装方式。
2. 对于“全能”实现方法的二次封装：只将真正的实现代码封装在指定方法中，并提供详细的配置参数。其他相关API只是对改方法进行不同配置上的二次封装，使代码机制，易于管理，减少了出错概率。
3. 灵活使用KVO等方式进行变量的自动设置：KVO可以在运行期间自动完成对应变量的更新，这对于大量对象的频繁修改尤其有效，也是集中管理代码的良好方式。