普通视图

发现新文章,点击刷新页面。
今天 — 2026年3月2日首页

01-研究系统框架@Web@iOS | JavaScriptCore 框架:从使用到原理解析

JavaScriptCore 框架:从使用到原理解析

JavaScript 越来越多地出现在我们客户端开发的视野中,从 React Native 到 JSPatch,JavaScript 与客户端相结合的技术开始变得魅力无穷。本文主要讲解 iOS 中的 JavaScriptCore 框架,正是它为 iOS 提供了执行 JavaScript 代码的能力。未来的技术日新月异,JavaScript 与 iOS 正在碰撞出新的激情。

JavaScriptCoreJavaScript虚拟机,为 JavaScript 的执行提供底层资源。


📋 目录


一、JavaScript

在讨论JavaScriptCore之前,我们首先必须对JavaScript有所了解。

1. JavaScript干啥的?

  • 说的高大上一点:一门基于原型、函数先行的高级编程语言,通过解释执行,是动态类型的直译语言。是一门多范式的语言,它支持面向对象编程,命令式编程,以及函数式编程。
  • 说的通俗一点:主要用于网页,为其提供动态交互的能力。可嵌入动态文本于HTML页面,对浏览器事件作出响应,读写HTML元素,控制cookies等。
  • 再通俗一点:抢月饼,button.click()。(PS:请谨慎使用while循环)

img

2. JavaScript起源与历史

  • 1990年底,欧洲核能研究组织(CERN)科学家Tim Berners-Lee,在互联网的基础上,发明了万维网(World Wide Web),从此可以在网上浏览网页文件。
  • 1994年12月,Netscape 发布了一款面向普通用户的新一代的浏览器Navigator 1.0版,市场份额一举超过90%。
  • 1995年,Netscape公司雇佣了程序员Brendan Eich开发这种嵌入网页的脚本语言。最初名字叫做Mocha,1995年9月改为LiveScript。
  • 1995年12月,Netscape公司与Sun公司达成协议,后者允许将这种语言叫做JavaScript。

3. JavaScript与ECMAScript

  • “JavaScript”是Sun公司的注册商标,用来特制网景(现在的Mozilla)对于这门语言的实现。网景将这门语言作为标准提交给了ECMA——欧洲计算机制造协会。由于商标上的冲突,这门语言的标准版本改了一个丑陋的名字“ECMAScript”。同样由于商标的冲突,微软对这门语言的实现版本取了一个广为人知的名字“Jscript”。
  • ECMAScript作为JavaScript的标准,一般认为后者是前者的实现。

4. Java和JavaScript

img

《雷锋和雷峰塔》

Java 和 JavaScript 是两门不同的编程语言 一般认为,当时 Netscape 之所以将 LiveScript 命名为 JavaScript,是因为 Java 是当时最流行的编程语言,带有 “Java” 的名字有助于这门新生语言的传播。

二、 JavaScriptCore

1. 浏览器演进

  • 演进完整图

upload.wikimedia.org/wikipedia/c…

  • WebKit分支

现在使用WebKit的主要两个浏览器Sfari和Chromium(Chorme的开源项目)。WebKit起源于KDE的开源项目Konqueror的分支,由苹果公司用于Sfari浏览器。其一条分支发展成为Chorme的内核,2013年Google在此基础上开发了新的Blink内核。

img

2. WebKit排版引擎

webkit是sfari、chrome等浏览器的排版引擎,各部分架构图如下

img

  • webkit Embedding API是browser UI与webpage进行交互的api接口;
  • platformAPI提供与底层驱动的交互, 如网络, 字体渲染, 影音文件解码, 渲染引擎等;
  • WebCore它实现了对文档的模型化,包括了CSS, DOM, Render等的实现;
  • JSCore是专门处理JavaScript脚本的引擎;

3. JavaScript引擎

  • JavaScript引擎是专门处理JavaScript脚本的虚拟机,一般会附带在网页浏览器之中。第一个JavaScript引擎由布兰登·艾克在网景公司开发,用于Netscape Navigator网页浏览器中。JavaScriptCore就是一个JavaScript引擎。
  • 下图是当前主要的还在开发中的JavaScript引擎

img

4. JavaScriptCore组成

JavaScriptCore主要由以下模块组成:

  • Lexer 词法分析器,将脚本源码分解成一系列的Token
  • Parser 语法分析器,处理Token并生成相应的语法树
  • LLInt 低级解释器,执行Parser生成的二进制代码
  • Baseline JIT 基线JIT(just in time 实施编译)
  • DFG 低延迟优化的JIT
  • FTL 高通量优化的JIT

关于更多JavaScriptCore的实现细节,参考 trac.webkit.org/wiki/JavaSc…

5. JavaScriptCore 框架与历史

JavaScriptCore 是一个 C++ 实现的开源项目(WebKit 的一部分)。历史上,JSC 长期作为 Safari / WebKit 的内置 JS 引擎;自 iOS 7.0 / OS X 10.9 起,Apple 将 JavaScriptCore 以系统框架 JavaScriptCore.framework 的形式开放给开发者,使其可在 Objective-C 或基于 C 的程序中执行 JavaScript 代码,并向 JS 环境中插入自定义对象,而无需依赖 UIWebView。这为 Hybrid 应用、热更新、脚本引擎等场景提供了统一的底层能力。

JavaScriptCore.h 中,我们可以看到:

#ifndef JavaScriptCore_h
#define JavaScriptCore_h

#include <JavaScriptCore/JavaScript.h>
#include <JavaScriptCore/JSStringRefCF.h>

#if defined(__OBJC__) && JSC_OBJC_API_ENABLED

#import "JSContext.h"
#import "JSValue.h"
#import "JSManagedValue.h"
#import "JSVirtualMachine.h"
#import "JSExport.h"

#endif

#endif /* JavaScriptCore_h */

这里已经很清晰地列出了JavaScriptCore的主要几个类:

  • JSContext
  • JSValue
  • JSManagedValue
  • JSVirtualMachine
  • JSExport

接下来我们会依次讲解这几个类的用法。

6. Hello World!

这段代码展示了如何在 Objective-C 中执行一段 JavaScript 代码,并且获取返回值并转换成 OC 数据打印:

// 创建虚拟机
JSVirtualMachine *vm = [[JSVirtualMachine alloc] init];

//创建上下文
JSContext *context = [[JSContext alloc] initWithVirtualMachine:vm];

//执行JavaScript代码并获取返回值
JSValue *value = [context evaluateScript:@"1+2*3"];

// 转换成 OC 数据并打印
NSLog(@"value = %d", [value toInt32]);
// Output: value = 7

Swift 等价写法:

import JavaScriptCore

let vm = JSVirtualMachine()!
let context = JSContext(virtualMachine: vm)!
let value = context.evaluateScript("1 + 2 * 3")!
print("value =", value.toInt32())  // value = 7

三、 JSVirtualMachine

一个JSVirtualMachine的实例就是一个完整独立的JavaScript的执行环境,为JavaScript的执行提供底层资源。

这个类主要用来做两件事情:

  1. 实现并发的 JavaScript 执行
  2. JavaScript 和 Objective-C 桥接对象的内存管理

看下头文件 JSVirtualMachine.h 里有什么:

NS_CLASS_AVAILABLE(10_9, 7_0)
@interface JSVirtualMachine : NSObject

/* 创建一个新的完全独立的虚拟机 */
(instancetype)init;

/* 对桥接对象进行内存管理 */
- (void)addManagedReference:(id)object withOwner:(id)owner;

/* 取消对桥接对象的内存管理 */
- (void)removeManagedReference:(id)object withOwner:(id)owner;

@end

每一个JavaScript上下文(JSContext对象)都归属于一个虚拟机(JSVirtualMachine)。每个虚拟机可以包含多个不同的上下文,并允许在这些不同的上下文之间传值(JSValue对象)。

然而,每个虚拟机都是完整且独立的,有其独立的堆空间和垃圾回收器(garbage collector ),GC无法处理别的虚拟机堆中的对象,因此你不能把一个虚拟机中创建的值传给另一个虚拟机。

img

线程和JavaScript的并发执行

JavaScriptCore API都是线程安全的。你可以在任意线程创建JSValue或者执行JS代码,然而,所有其他想要使用该虚拟机的线程都要等待。

  • 如果想并发执行JS,需要使用多个不同的虚拟机来实现。
  • 可以在子线程中执行JS代码。

通过下面这个 demo 来理解这个并发机制:

JSContext *context = [[CustomJSContext alloc] init];
JSContext *context1 = [[CustomJSContext alloc] init];
JSContext *context2 = [[CustomJSContext alloc] initWithVirtualMachine:[context virtualMachine]];
NSLog(@"start");
dispatch_async(queue, ^{
    while (true) {
        sleep(1);
        [context evaluateScript:@"log('tick')"];
    }
});
dispatch_async(queue1, ^{
    while (true) {
        sleep(1);
        [context1 evaluateScript:@"log('tick_1')"];
    }
});
dispatch_async(queue2, ^{
    while (true) {
        sleep(1);
        [context2 evaluateScript:@"log('tick_2')"];
    }
});
[context evaluateScript:@"sleep(5)"];
NSLog(@"end");

context和context2属于同一个虚拟机。

context1属于另一个虚拟机。

三个线程分别异步执行每秒1次的js log,首先会休眠1秒。

在context上执行一个休眠5秒的JS函数。

首先执行的应该是休眠5秒的JS函数,在此期间,context所处的虚拟机上的其他调用都会处于等待状态,因此tick和tick_2在前5秒都不会有执行。

而context1所处的虚拟机仍然可以正常执行tick_1

休眠5秒结束后,tick和tick_2才会开始执行(不保证先后顺序)。

实际运行输出的 log 是:

start
tick_1
tick_1
tick_1
tick_1
end
tick
tick_2

四、 JSContext

一个JSContext对象代表一个JavaScript执行环境。在native代码中,使用JSContext去执行JS代码,访问JS中定义或者计算的值,并使JavaScript可以访问native的对象、方法、函数。

img

1. JSContext执行JS代码

  • 调用evaluateScript函数可以执行一段top-level 的JS代码,并可向global对象添加函数和对象定义
  • 其返回值是JavaScript代码中最后一个生成的值

API Reference

NS_CLASS_AVAILABLE(10_9, 7_0)
@interface JSContext : NSObject

/* 创建一个JSContext,同时会创建一个新的JSVirtualMachine */
(instancetype)init;

/* 在指定虚拟机上创建一个JSContext */
(instancetype)initWithVirtualMachine:
        (JSVirtualMachine*)virtualMachine;

/* 执行一段JS代码,返回最后生成的一个值 */
(JSValue *)evaluateScript:(NSString *)script;

/* 执行一段JS代码,并将sourceURL认作其源码URL(仅作标记用) */
- (JSValue *)evaluateScript:(NSString *)script withSourceURL:(NSURL*)sourceURL     NS_AVAILABLE(10_10, 8_0);

/* 获取当前执行的JavaScript代码的context */
+ (JSContext *)currentContext;

/* 获取当前执行的JavaScript function*/
+ (JSValue *)currentCallee NS_AVAILABLE(10_10, 8_0);

/* 获取当前执行的JavaScript代码的this */
+ (JSValue *)currentThis;

/* Returns the arguments to the current native callback from JavaScript code.*/
+ (NSArray *)currentArguments;

/* 获取当前context的全局对象。WebKit中的context返回的便是WindowProxy对象*/
@property (readonly, strong) JSValue *globalObject;

@property (strong) JSValue *exception;
@property (copy) void(^exceptionHandler)(JSContext *context, JSValue
    *exception);

@property (readonly, strong) JSVirtualMachine *virtualMachine;

@property (copy) NSString *name NS_AVAILABLE(10_10, 8_0);


@end

2. JSContext访问JS对象

一个JSContext对象对应了一个全局对象(global object)。例如web浏览器中中的JSContext,其全局对象就是window对象。在其他环境中,全局对象也承担了类似的角色,用来区分不同的JavaScript context的作用域。全局变量是全局对象的属性,可以通过JSValue对象或者context下标的方式来访问。

示例代码:

JSValue *value = [context evaluateScript:@"var a = 1+2*3;"];

NSLog(@"a = %@", [context objectForKeyedSubscript:@"a"]);
NSLog(@"a = %@", [context.globalObject objectForKeyedSubscript:@"a"]);
NSLog(@"a = %@", context[@"a"]);
// Output: a = 7, a = 7, a = 7

这里列出了三种访问JavaScript对象的方法

  • 通过context的实例方法objectForKeyedSubscript
  • 通过context.globalObject的objectForKeyedSubscript实例方法
  • 通过下标方式

设置属性也是对应的。

API Reference

/* 为 JSContext 提供下标访问元素的方式 */
@interface JSContext (SubscriptSupport)

/* 首先将key转为JSValue对象,然后使用这个值在JavaScript context的全局对象中查找这个名字的属性并返回 */
(JSValue *)objectForKeyedSubscript:(id)key;

/* 首先将key转为JSValue对象,然后用这个值在JavaScript context的全局对象中设置这个属性。
可使用这个方法将native中的对象或者方法桥接给JavaScript调用 */
(void)setObject:(id)object forKeyedSubscript:(NSObject <NSCopying>*)key;

@end



/* 例如:以下代码在JavaScript中创建了一个实现是Objective-C block的function */
context[@"makeNSColor"] = ^(NSDictionary *rgb){
    float r = [rgb[@"red"] floatValue];
    float g = [rgb[@"green"] floatValue];
    float b = [rgb[@"blue"] floatValue];
    return [NSColor colorWithRed:(r / 255.f) green:(g / 255.f) blue:(b / 255.f)         alpha:1.0];
};
JSValue *value = [context evaluateScript:@"makeNSColor({red:12, green:23, blue:67})"];

五、 JSValue

一个JSValue实例就是一个JavaScript值的引用。使用JSValue类在JavaScript和native代码之间转换一些基本类型的数据(比如数值和字符串)。你也可以使用这个类去创建包装了自定义类的native对象的JavaScript对象,或者创建由native方法或者block实现的JavaScript函数。

每个JSValue实例都来源于一个代表JavaScript执行环境的JSContext对象,这个执行环境就包含了这个JSValue对应的值。每个JSValue对象都持有其JSContext对象的强引用,只要有任何一个与特定JSContext关联的JSValue被持有(retain),这个JSContext就会一直存活。通过调用JSValue的实例方法返回的其他的JSValue对象都属于与最始的JSValue相同的JSContext。

img

每个JSValue都通过其JSContext间接关联了一个特定的代表执行资源基础的JSVirtualMachine对象。你只能将一个JSValue对象传给由相同虚拟机管理(host)的JSValue或者JSContext的实例方法。如果尝试把一个虚拟机的JSValue传给另一个虚拟机,将会触发一个Objective-C异常。

img

1. JSValue类型转换

JSValue提供了一系列的方法将native与JavaScript的数据类型进行相互转换:

img

2. NSDictionary与JS对象

NSDictionary 对象以及其包含的 keys 与 JavaScript 中的对应名称的属性相互转换。key 所对应的值也会递归地进行拷贝和转换。

[context evaluateScript:@"var color = {red:230, green:90, blue:100}"];

//js->native 给你看我的颜色
JSValue *colorValue = context[@"color"];
NSLog(@"r=%@, g=%@, b=%@", colorValue[@"red"], colorValue[@"green"], colorValue[@"blue"]);
NSDictionary *colorDic = [colorValue toDictionary];
NSLog(@"r=%@, g=%@, b=%@", colorDic[@"red"], colorDic[@"green"], colorDic[@"blue"]);

//native->js 给你点颜色看看
context[@"color"] = @{@"red":@(0), @"green":@(0), @"blue":@(0)};
[context evaluateScript:@"log('r:'+color.red+'g:'+color.green+' b:'+color.blue)"];
// Output:
// r=230, g=90, b=100
// r=230, g=90, b=100
// r:0 g:0 b:0

可见,JS中的对象可以直接转换成Objective-C中的NSDictionary,NSDictionary传入JavaScript也可以直接当作对象被使用。

3. NSArray与JS数组

NSArray 对象与 JavaScript 中的 array 相互转换。其子元素也会递归地进行拷贝和转换。

[context evaluateScript:@"var friends = ['Alice','Jenny','XiaoMing']"];

//js->native 你说哪个是真爱?
JSValue *friendsValue = context[@"friends"];
NSLog(@"%@, %@, %@", friendsValue[0], friendsValue[1], friendsValue[2]);
NSArray *friendsArray = [friendsValue toArray];
NSLog(@"%@, %@, %@", friendsArray[0], friendsArray[1], friendsArray[2]);

//native->js 我觉得 XiaoMing 不错,给你再推荐个 Jimmy
context[@"girlFriends"] = @[friendsArray[2], @"Jimmy"];
[context evaluateScript:@"log('girlFriends :'+girlFriends[0]+' '+girlFriends[1])"];
// Output: Alice, Jenny, XiaoMing / girlFriends : XiaoMing Jimmy

4. Block/函数和JS function

Objective-C中的block转换成JavaScript中的function对象。参数以及返回类型使用相同的规则转换。

将一个代表native的block或者方法的JavaScript function进行转换将会得到那个block或方法。

其他的JavaScript函数将会被转换为一个空的dictionary。因为JavaScript函数也是一个对象。

5. OC对象和JS对象

对于所有其他 native 的对象类型,JavaScriptCore 都会创建一个拥有 constructor 原型链的 wrapper 对象,用来反映 native 类型的继承关系。默认情况下,native 对象的属性和方法并不会导出给其对应的 JavaScript wrapper 对象。通过 JSExport 协议可选择性地导出属性和方法。下面第六节对 JSExport 与原生对象导出做详细讲解。


六、JSExport 与原生对象导出

JSExport 是 JavaScriptCore 框架中的协议,用于将 Objective-C/Swift 的类(属性与方法)选择性导出给 JavaScript,使 JS 代码可以像调用普通对象一样调用原生对象 [1][2]。

6.1 作用与机制

  • 遵循 JSExport 的协议中声明的属性和方法,会在将 native 对象注入到 JSContext(如 context[@"bridge"] = nativeObject)时,自动暴露为 JS 侧的属性和函数。
  • 若类未实现 JSExport 或未在协议中声明,则对应属性/方法不会出现在 JS 中;这样可控制「桥接面」,避免暴露内部实现 [1][2]。

6.2 使用示例(概念)

@protocol MyPointExport <JSExport>
@property (nonatomic, assign) double x;
@property (nonatomic, assign) double y;
- (NSString *)description;
@end

@interface MyPoint : NSObject <MyPointExport>
@property (nonatomic, assign) double x;
@property (nonatomic, assign) double y;
@end

MyPoint 实例赋给 context[@"point"] 后,在 JS 中可访问 point.xpoint.y 并调用 point.description()
注意:若在 Block 或导出方法中再次使用 JSValueJSContext,需注意线程与内存管理(见第七节 JSManagedValue)[1][2]。

Swift 中的等价写法(通过 JSContext 注入遵循 JSExport 的类):

import JavaScriptCore

@objc protocol PointExport: JSExport {
    var x: Double { get set }
    var y: Double { get set }
    func description() -> String
}

class Point: NSObject, PointExport {
    @objc var x: Double
    @objc var y: Double
    init(x: Double, y: Double) { self.x = x; self.y = y }
    func description() -> String { "Point(\(x), \(y))" }
}

// 注入到 context
let context = JSContext()!
context.setObject(Point(x: 1, y: 2), forKeyedSubscript: "point" as NSString)
context.evaluateScript("point.x; point.description()")

6.3 与 Block 注入的对比

方式 适用场景
context[@"fn"] = ^(id arg){ ... } 单次或简单逻辑,直接暴露为 JS 函数
JSExport 协议 + 原生对象 需要暴露多个方法/属性、保持对象身份与状态的「桥接对象」

七、JSManagedValue 与内存管理

7.1 为何需要 JSManagedValue

  • JSValueJSContext强引用JSContext 又挂在 JSVirtualMachine 上。
  • 若在 堆上的 OC 对象(如某 ViewController 的 property)中直接强引用 JSValue,而该 JSValue 通过某种方式(例如被注入到 context 的全局对象)又引用回该 OC 对象,会形成 OC ↔ JS 的循环引用,导致 Context 与 OC 对象均无法释放 [1][2]。

7.2 JSManagedValue 的职责

JSManagedValueJSValue 的包装类,用于在「被 OC 堆对象持有」的场景下,以条件保留的方式引用 JS 值,并可与 JSVirtualMachineaddManagedReference:withOwner: / removeManagedReference:withOwner: 配合,让虚拟机在合适的时机断开或保留对 native 对象的引用,从而打破循环、避免 JSContext 无法释放 [1][2]。

7.3 使用要点(概念)

  • 当需要把 JSValue(或从 JS 传回的函数/对象)存为 OC 对象的成员变量时,应使用 JSManagedValue 包装,并以 owner 注册到 JSVirtualMachine;在 owner 析构或不再需要时调用 removeManagedReference:withOwner: [1][2]。
  • 仅临时在栈上使用 JSValue(如 evaluateScript 的返回值在方法内使用后不再持有)时,一般无需 JSManagedValue。

八、关键概念图示与流程

8.1 VM、Context、Value 关系

flowchart TB
  subgraph VM1[JSVirtualMachine 1]
    C1[JSContext 1]
    C2[JSContext 2]
  end
  subgraph VM2[JSVirtualMachine 2]
    C3[JSContext 3]
  end
  C1 --> V1[JSValue]
  C2 --> V2[JSValue]
  C1 -.->|可传值| C2
  C1 -.->|不可跨 VM| C3

同一 JSVirtualMachine 下多个 JSContext 可共享、传递 JSValue;不同 VM 之间不能传递 JSValue [3]。

8.2 JavaScriptCore 引擎执行层级(概念)

源码经 Lexer → Parser 得到语法树并生成字节码后,由下至上的执行/编译层级可概括为:

flowchart LR
  A[源码] --> B[Lexer]
  B --> C[Parser / AST]
  C --> D[字节码]
  D --> E[LLInt 解释器]
  E --> F[Baseline JIT]
  F --> G[DFG JIT]
  G --> H[FTL JIT]
  • LLInt:低级解释器,低延迟启动。
  • Baseline JIT:首次 JIT,兼顾分析与回退。
  • DFG:基于数据流的优化 JIT。
  • FTL:更高优化层(历史上曾用 LLVM/B3 后端)[4][5]。

更多实现细节见 WebKit JavaScriptCore Wiki


九、应用场景与最佳实践

9.1 典型应用场景

场景 说明
Hybrid 应用 在 App 内执行 JS 脚本、调用原生能力(如弹窗、定位、支付),JavaScriptCore 提供 OC/Swift 与 JS 的双向桥接 [1][2]
React Native / 类 RN 方案 早期 RN 等方案在 iOS 上依赖 JSC 执行 JS bundle;JSC 提供 VM、Context、Value 等能力 [3]
JSPatch 等热修复 通过下发 JS 脚本并在 JSC 中执行,动态调用原生类与方法,实现热更新(需注意安全与审核政策)[3]
WKWebView 与 Web 页面 WKWebView 内部使用系统 WebKit,其 JS 引擎与 Safari 一致;独立使用 JSC 时无需 WebView 即可执行 JS [1][2]
规则引擎 / 脚本配置 将业务规则或配置写成 JS,由原生在 JSC 中执行并取结果,便于迭代与 A/B 测试

9.2 最佳实践要点

  • 线程:同一 VM 下多线程会串行等待;需并发执行 JS 时使用多个 JSVirtualMachine [3]。
  • 异常:设置 context.exceptionHandler,在 JS 抛错时记录或上报,避免静默失败 [3]。
  • 内存:在 OC 堆对象中持有 JS 值时使用 JSManagedValue + add/removeManagedReference,避免循环引用 [1][2]。
  • 安全:执行来自网络或不可信来源的 JS 时,需做沙箱与权限控制;避免将敏感 API 无限制暴露给 JS [3]。

十、伪代码与算法说明

10.1 执行脚本并取返回值(概念)

function evaluateScript(script: String) -> JSValue:
  parse script -> AST
  generate bytecode from AST
  execute bytecode (via LLInt or JIT tier)
  return last expression value as JSValue

10.2 将 Native 对象注入 Context(概念)

function setObject(object: Any, forKey key: String):
  if object is Block or conforms to JSExport:
    create JS wrapper (function or object with exported properties/methods)
  else:
    create generic wrapper preserving native type hierarchy
  set wrapper on context.globalObject[key]

10.3 JS 调用 Native Block 时(概念)

JavaScript 侧,调用通过 context[@"key"] 注入的 Block,与调用普通函数一致:

// 假设 Native 已注入:context["makeColor"] = ^(NSDictionary *rgb) { ... }
var color = makeColor({ red: 12, green: 23, blue: 67 });

底层流程(伪代码):

当 JS 调用 context 中注册的 Block 时:
  1. JSC 将 JS 参数按类型转换为 OC 对象(NSNumber/NSString/NSDictionary/NSArray 等)
  2. 调用 Block,传入转换后的参数
  3. 将 Block 返回值按类型转换为 JSValue 并返回给 JS

参考文献

[1] Apple. JavaScriptCore Framework. iOS / macOS Developer Documentation.
[2] 掘金 / 博客. iOS 与 JS 交互开发知识总结JavaScriptCore 初探 等.
[3] 本文原稿与常见 JSC 教程(JSVirtualMachine、JSContext、JSValue、并发与内存).
[4] WebKit. Introducing the WebKit FTL JIT. webkit.org/blog/3362/i…
[5] WebKit. JavaScriptCore - Deep Dive. docs.webkit.org/Deep%20Dive…
[6] trac.webkit.org. JavaScriptCore. trac.webkit.org/wiki/JavaSc…
[7] 美团技术团队. 深入理解 JSCore. blog.csdn.net/MeituanTech…

01-HarmonyOS底层原理|HarmonyOS的各个渲染框架和HarmonyOS图层渲染原理

HarmonyOS 底层原理:各个渲染框架与图层渲染原理

前言


概述

本文主要对 HarmonyOS 页面渲染原理 展开讨论。在讨论本文主题之前,我们需要先了解 HarmonyOS,然后进行一定的知识铺垫,先带大家简单回顾一下 计算机图形渲染原理。若您不想了解 HarmonyOS 的系统背景,可以从第二节「铺垫知识」开始。若您也有一定的 计算机图形学基础,可以忽略前期的知识准备,直接从本文的第三节开始阅读。

本文总共有以下几个章节:


📋 目录


一、HarmonyOS 简述

HarmonyOS 系统由中国的华为公司发行。它作为首款完全自主国产智能移动终端搭载系统,自诞生以来就备受关注,至今为止已经迭代了 3+ 代。国内很多电子发烧友都想进一步了解 HarmonyOS,在此过程中也提出了一些疑问:HarmonyOS 是否是 Android 系统的套皮?(换言之就是怀疑:HarmonyOS 是否是以安卓操作系统为底座,修改了上层的 UI 图形显示界面的系统)。华为公司在多次系统发布会也对 HarmonyOS 的定位、它的设计等各方面做出了介绍。在本文中我们首先从以下几个方面来认识发烧友们的质疑是否可靠:

  • 系统定位
  • 内核对比
  • 运行速度

鸿蒙(HarmonyOS):一款面向万物互联时代的、全新的分布式操作系统。在传统的单设备系统能力基础上,HarmonyOS 提出了基于同一套系统能力、适配多种终端形态的分布式理念,能够支持手机、平板、智能穿戴、智慧屏、车机等多种终端设备,提供全场景(移动办公、运动健康、社交通信、媒体娱乐等)业务能力。

1.1 鸿蒙系统和 Android 系统的定位不同

华为官方对于 HarmonyOS 系统定位的介绍视频 我们可以得知:

Android 和 HarmonyOS 两款产品的研发初衷完全不一样,根本就不在同一个赛道上。安卓系统面向的是手机端,而鸿蒙系统面向的是这些年比较新的概念物联网,致力于利用其 5G 世界领先的技术,优先布局和打造一个超级终端、万物互联的生态。

安卓(Android): 是一种基于 Linux 内核(不包含 GNU 组件)的自由及开放源代码的操作系统,主要使用于移动设备,如智能手机和平板电脑,由美国 Google 公司和开放手机联盟领导及开发。

鸿蒙(HarmonyOS): 是一款面向万物互联时代的、全新的分布式操作系统。在传统的单设备系统能力基础上,HarmonyOS 提出了基于同一套系统能力、适配多种终端形态的分布式理念,能够支持手机、平板、智能穿戴、智慧屏、车机等多种终端设备,提供全场景(移动办公、运动健康、社交通信、媒体娱乐等)业务能力。

1.2 鸿蒙系统和 Android 系统的内核不同

安卓(Android): 基于 Linux 的宏内核设计。宏内核包含了操作系统绝大多数的功能和模块,而且这些功能和模块都具有最高的权限,只要一个模块出错,整个系统就会崩溃,这也是安卓系统容易崩溃的原因。

  • 系统开发难度低。

鸿蒙(HarmonyOS): 基于微内核设计。微内核仅包括了操作系统必要的功能模块(任务管理、内存分配等),处在核心地位具有最高权限;其他模块不具有最高权限,也就是说其他模块出现问题,对于整个系统的运行是没有阻碍的。

  • 微内核稳定性很高。
  • 鸿蒙系统包含了两个内核:
    • Linux 内核
    • LiteOS 内核
  • 内核子系统:HarmonyOS 采用多内核设计,支持针对不同资源受限设备选用适合的 OS 内核。
    • 内核抽象层(KAL,Kernel Abstract Layer) 通过屏蔽多内核差异,对上层提供基础的内核能力,包括进程/线程管理、内存管理、文件系统、网络管理和外设管理等。
  • 驱动子系统:硬件驱动框架(HDF)是 HarmonyOS 硬件生态开放的基础,提供统一外设访问能力和驱动开发、管理框架。

关于鸿蒙系统内核的介绍,我们也可以通过 官方视频 的介绍来进一步认识。

HarmonyOS 底层内核空间 以 【Linux Kernel】作为基石。上层用户空间由 Native 系统库虚拟机运行环境框架层 组成,通过系统调用(Syscall) 连通系统的 内核空间用户空间

对于用户空间主要采用 C++ 和 Java 代码编写,通过 JNI 技术 打通用户空间的 Java 层Native 层(C++/C),从而连通整个系统。

我们今天就以 HarmonyOS 渲染原理为主题,对 HarmonyOS 系统的渲染框架和渲染流水线展开讨论,以为后期在项目实施过程中做技术选型做知识储备!!那就让我们进入今天的正题吧!!!

1.3 鸿蒙系统和 Android 系统的运行速度对比

安卓(Android): 基于 Java 语言编码。Java 语言有个很大的缺点是其不能直接与底层操作系统通信,需要通过虚拟机(JVM)充当中间转换的角色,这是每一个 Java 开发人员都知道的知识点。虽然 Java 语言由于虚拟机的优化、编译器的优化、热点代码等技术使得其越来越快,但是无法直接与操作系统互相通信一直影响着其性能的突破。

鸿蒙(HarmonyOS): 鸿蒙的开发也可以采用 Java 语言,官方也推荐使用 Java 语言开发,但是 华为针对 Java 语言的这种特性,研发了方舟编译器,通过方舟编译器编译的软件可以直接与底层操作系统通信,方舟编译器在这一层面做到了取代虚拟机。通过方舟编译器转换为操作系统能够读懂的机器语言,这样就可以跳过虚拟机解释这一步骤,当然这是肯定对机器的内存要求比较高,应该也存在启动后无法继续优化等问题。

1.4 方舟编译器简单介绍

华为方舟编译器作为一款全新的编译器可以显著提高手机的运行速度,它 不采用现有编译器边解释边执行的模式,而是将这种动态编译改为静态编译,可以做到全程执行机器码,进而高效运行程序,大大缩短程序响应时间

方舟编译器的优势

  • 多语言联合:将同一应用中的不同语言代码联合编译、联合优化,消除语言间的性能「鸿沟」,降低开发者的优化成本
  • 轻量运行时:通过编译器的语言实现能力和优化能力增强,应用运行时的开销更小
  • 软硬件协同:编译器与芯片实现软硬件协同优化,充分发挥硬件能效,应用体验更佳
  • 多平台支持:支持面向多样化的终端设备平台进行编译和运行,根据设备特征提供便捷的开发与部署策略,提高开发效率


二、铺垫知识

HarmonyOS 系统的图形渲染原理其实在核心部分都是和 计算机图形学 的计算机图形渲染原理一样的。所以我们在了解 HarmonyOS 的 视图系统 和其 2D、3D 渲染框架渲染流水线 之前,我们需要进入笔者的这篇文章:计算机图形渲染原理 进行一定的知识准备。

链接 附带的文章中,我们可以了解到「智能硬件 的 CPU、GPU 的设计理念以及两者之间的性能差异」、「计算机图形渲染芯片 GPU 的诞生史」、「围绕 GPU 工作的 3D 图形渲染库(OpenGL、DirectX 等)、图形学相关的专业术语和 OpenGL 工作的渲染流水线」、「屏幕成像的电子束 CRT 扫描原理」、「屏幕成像原理」等诸多相关的核心要点。

您若是不想关注 CPU、GPU,直接了解移动设备的屏幕成像原理,也可以阅读笔者这一份专门为移动而写的简约版:移动终端屏幕成像与卡顿
在这篇文章中,我们可以分别从两个维度去关注:第一个就是 系统成像遇到的 Bug 问题,第二个就是 解决问题的解决方案。几个要点可以简单归纳为:

  • 问题:「屏幕撕裂 Screen Tearing」、「掉帧 Jank」、视图成像切换衔接失误导致的画面空白
  • 解决方案:「Vsync」、「Double Buffering」、「Triple Buffering」

总结:我们这里主要关注屏幕成像的整个渲染流水线,以便于我们后面对 HarmonyOS 的图像渲染原理展开讨论:

① 获取图层渲染数据 → ② GPU 加工成像素数据 → ③ 帧缓冲器(存储像素信息)→ ④ 视频控制器读取缓存 → ⑤ 数模转换、显示器显示

我们今天的主题就是主要关注第一个环节。入手点分为几个:

  • HarmonyOS 系统的**视图层(Layer)视图窗口(Window)**以及系统中的各个图形渲染框架(2D/3D)
  • HarmonyOS 系统的渲染流水线
  • HarmonyOS 系统的事件机制

下面用一张流程图概括从「应用绘制」到「屏幕显示」的通用流水线(与第二节铺垫知识对应):

flowchart LR
  subgraph 应用与框架
    A[应用/ArkUI 绘制]
    B[图层数据]
  end
  subgraph 系统与硬件
    C[GPU 光栅化]
    D[帧缓冲]
    E[视频控制器]
    F[显示器]
  end
  A --> B --> C --> D --> E --> F

三、HarmonyOS 的视图层和视图窗口

本节在不删减原有结构的前提下,对 HarmonyOS 的 窗口(Window)窗口层级视图层(Layer)Surface 等概念做系统性补充,便于与后文「渲染框架与流水线」衔接。相关表述综合自华为/开放原子官方文档、开发者社区与项目实践 [1][2][3][4]。

3.1 窗口子系统与窗口类型

HarmonyOS 的窗口模块(窗口子系统)负责在同一块物理屏幕上提供多个应用界面的显示与交互,其核心职责包括 [2]:

  • 提供应用系统界面的窗口对象
  • 组织不同窗口的显示关系,维护窗口的叠加层次位置属性
  • 提供窗口动效交互
  • 指导输入事件分发

窗口在类型上可分为两大类 [2]:

类型 说明
系统窗口 完成系统特定功能的窗口,如音量条、壁纸、通知栏、状态栏、导航栏等
应用窗口 应用主窗口:显示应用主界面,在任务管理界面中显示;应用子窗口:弹窗、悬浮窗等辅助窗口,生命周期跟随主窗口

应用主窗口与子窗口在尺寸上有约束:宽度范围 [320, 2560] vp,高度范围 [240, 2560] vp(具体以当前版本文档为准)[1]。

3.2 窗口层级与 WindowType

窗口的前后叠加关系WindowTypepriority(优先级) 共同决定 [4]:

  • BelowApp:底层,如桌面、壁纸等,priority = 0
  • App:中间层,应用主窗口(priority = 0)、应用子窗口(priority = 1)等
  • AboveApp:上层,如锁屏(priority = 114)、状态栏(priority = 110)等

同一 WindowType 下,priority 值越大,层级越高,越靠近用户 [4]。窗口模式(WindowMode)可配置为全屏、分屏主/副、悬浮等(如 WINDOW_MODE_FULLSCREENWINDOW_MODE_FLOATING 等)[4]。

flowchart TB
  subgraph AboveApp
    L[锁屏 priority=114]
    S[状态栏 priority=110]
  end
  subgraph App
    M[应用主窗口 priority=0]
    C[应用子窗口 priority=1]
  end
  subgraph BelowApp
    D[桌面/壁纸 priority=0]
  end
  L --> S --> M --> C --> D

系统侧由 WindowManagerService(WMS) 负责窗口的创建、销毁、布局、层级与焦点管理;DisplayManagerService(DMS) 管理 Display 与 Screen 的映射关系。Screen 表示物理屏幕,Display 表示逻辑屏幕,Window 依附于某个 Display [4]。

3.3 UIAbility 与 WindowStage

在应用开发模型中,窗口生命周期与 UIAbilityWindowStage 绑定 [3][5]:

  • UIAbility 是应用组件的一种,代表一个「界面能力」的抽象;一个 UIAbility 可拥有一个主窗口及若干子窗口。
  • WindowStage 在 UIAbility 创建时被建立,负责该 Ability 下窗口的创建与生命周期维护
  • onWindowStageCreate 回调中,应用加载 UI 界面(如 ArkUI 页面),主窗口在此阶段被创建并展示。

因此,从「界面」到「窗口」的链条为:UIAbility → WindowStage → Window(s);渲染框架则基于这些窗口提供的 Surface 进行绘制与合成。

3.4 视图层(Layer)与 Surface

在图形栈中,窗口对应可绘制的表面(Surface)。应用或 ArkUI 将 UI 内容绘制到与窗口绑定的 Surface 上,形成图层(Layer)数据;多个 Layer 由系统的 GPU 合成器(如 Rosen / Render Service) 按 z-order 合成为最终一帧,再送入帧缓冲,经 VSync显示控制器输出到屏幕 [1][2][6]。

  • Surface:可绘制的缓冲区抽象,对应窗口的绘图目标;应用侧通过 Canvas、Skia/OpenGL 等接口向 Surface 提交绘制命令或像素。
  • Layer:可理解为某一层绘制结果(或某棵视图树对应的渲染结果);多层叠加后经合成器合成为一帧。

OpenHarmony 文档与社区资料中常出现 RSSurfaceRSWindow 等接口,用于创建和管理可绘制的表面与窗口,与上述概念对应 [6]。


四、HarmonyOS 的各个渲染框架和渲染流水线

本节系统性地介绍 HarmonyOS / OpenHarmony 的图形栈分层ArkUI 声明式框架2D/3D 渲染框架Measure-Layout-Draw 渲染管线以及 Rosen(Render Service)合成,并给出从应用层到屏幕的完整流水线概览。内容综合自华为/开放原子官方文档、InfoQ 等技术文章及开发者社区 [1][2][6][7][8][9]。

4.1 图形栈整体架构

OpenHarmony 采用自研的图形栈,按分层抽象可分为 [6][7]:

层次 内容说明
接口层 向应用提供 NDK 等能力,包括 WebGL、Native Canvas、OpenGL 指令级支持等
框架层 Render Service(RS)、Drawing、Animation、Effect、显示与内存管理等
引擎层 2D 图形库、3D 图形引擎等

华为开发者官网将 ArkGraphics 2D 作为 HarmonyOS 上二维图形绘制、渲染与显示的核心模块,采用 API 层 — 服务层 — 硬件适配层 的三层架构,支持 ArkTS 与 C/C++ 开发 [1]。整体上,应用 UI 框架(如 ArkUI) 调用 2D/3D 图形 API,由 RS 进行合成与 VSync 调度,最终输出到屏幕。

flowchart TB
  subgraph 应用层
    ArkUI[ArkUI / ArkUI JS]
  end
  subgraph 图形栈
    API[API 层 / ArkGraphics 2D 等]
    RS[Render Service / Rosen]
    Draw[Drawing / 2D 引擎]
    Eng[3D 引擎]
  end
  subgraph 硬件
    GPU[GPU]
    Disp[显示控制器]
  end
  ArkUI --> API --> Draw
  ArkUI --> Eng
  Draw --> RS
  Eng --> RS
  RS --> GPU --> Disp

4.2 ArkUI 框架与声明式渲染

ArkUI 是 HarmonyOS 上主推的 声明式 UI 框架,面向 1+8+N 多设备,支持 ArkUI JS(类 Web/小程序范式)与 ArkUI eTS(声明式 + 方舟编译器)两套开发范式 [7][8]。从渲染角度看,ArkUI 可概括为 [7][8][9]:

  • 声明层:通过 build() 描述 UI 结构,用 @State / @Prop / @Link 等装饰器管理状态,遵循 UI = f(State) 的声明式范式。
  • 节点层:将声明式描述转化为内部可计算的节点树(Component 树、Alignment 树、Render 树等),支持细粒度更新,避免整树重算。
  • 渲染管线层:在 VSync 驱动下,经历 Measure → Layout → Draw,最终通过统一的渲染引擎(如 Skia 或华为自研引擎)将内容绘制到 Surface [7][8]。

ArkUI 采用前后端分离:前端为声明式 DSL(eTS 或类 Web),后端为 C++ 编写的声明式后端引擎,包含布局、动画、多态组件、自绘制渲染管线等;底层使用统一的框架层渲染引擎(当前文档多提及 Skia,华为亦在自研替代方案)[7][8]。

4.3 2D 与 3D 渲染框架

HarmonyOS 在应用层可归纳为两类典型渲染路线 [1][9]:

方式 适用场景 说明
ArkUI + Canvas / 内置组件 常规 UI、轻量 2D 动效、小游戏 使用 ArkGraphics 2D、Canvas 等 API,由框架完成 Measure-Layout-Draw
XComponent + Native(OpenGL ES) 复杂 3D、高性能图形、游戏 通过 XComponent 获得 Native 层 Surface,直接调用 OpenGL ES,细粒度控制

ArkGraphics 2D 提供画布操作、图元绘制(几何、图片、文本)、文本模块、可变帧率、Vsync、Window 管理等能力 [1]。3D 渲染则依赖系统图形子系统(含 Rosen/RS)提供的 Native 缓冲区与 OpenGL ES/Vulkan 等接口,实现完整渲染管线控制 [9]。

4.4 渲染管线:Measure、Layout、Draw

ArkUI 的 UI 渲染管线与常见移动端框架一致,分为三个阶段 [8][9]:

  1. Measure(测量):系统询问每个组件的尺寸需求,父容器根据子元素约束与自身约束计算每个节点的宽高。
  2. Layout(布局):根据测量结果与布局规则(如 Column、Row、Flex)确定每个组件在父容器中的位置(x, y)。
  3. Draw(绘制):将组件的几何、图片、文本等绘制到 Surface 对应的缓冲区,最终由 RS 合成并送显。

伪代码(概念)

function renderFrame():
  for each node in renderTree (from root to leaf):
    node.measure()   // 测量宽高
  for each node in renderTree (from root to leaf):
    node.layout()    // 确定 x, y
  for each node in renderTree (in draw order):
    node.draw()      // 绘制到 Surface
  submitToRenderService()

自定义 NDK 组件可通过 onMeasure / onLayout / onDraw 等回调接入该管线;测量与布局相关的 API(如 measureNodelayoutNodesetMeasuredSizesetLayoutPosition)需在对应的 ARKUI_NODE_CUSTOM_EVENT_ON_MEASUREARKUI_NODE_CUSTOM_EVENT_ON_LAYOUT 回调中使用 [9]。

flowchart LR
  M[Measure 测量]
  L[Layout 布局]
  D[Draw 绘制]
  RS[Render Service]
  M --> L --> D --> RS

4.5 Rosen / Render Service 与合成

Rosen 是 OpenHarmony 的 GPU 合成与显示服务,在架构上类似 Android 的 SurfaceFlinger,负责 [6][7]:

  • 管理 RSSurfaceRSWindow 等可绘制表面与窗口;
  • 接收各应用/窗口提交的图层数据,按 z-order 与可见性进行 GPU 合成
  • DisplayManager 配合,分发 VSync 信号,实现帧同步与双缓冲/三缓冲,减少撕裂与掉帧。

可通过系统调试命令(如 hidumper -s RenderService)查看 RS 状态、屏幕、节点、FPS 等信息 [7]。图层数据经 RS 合成后写入帧缓冲,再由视频控制器读取并输出到物理屏幕,与第二节「铺垫知识」中的流水线一致。

4.6 从应用层到屏幕的完整流水线

将上述各节串联,从「应用 UI」到「屏幕显示」的完整流水线可概括为:

  1. 应用层:ArkUI(或 Native UI)根据状态构建/更新 Component 树 → Render 树,在 VSync 触发下执行 Measure → Layout → Draw
  2. 绘制输出:Draw 阶段将内容绘制到各窗口对应的 Surface,生成**图层(Layer)**缓冲区。
  3. 合成Render Service(Rosen) 收集所有窗口的 Layer,按层级与区域进行 GPU 合成,输出一帧到帧缓冲
  4. 显示视频控制器VSync 同步下读取帧缓冲,经数模转换输出到显示器

整体与第二节给出的「① 获取图层渲染数据 → ② GPU 加工 → ③ 帧缓冲 → ④ 视频控制器 → ⑤ 显示器」一致,HarmonyOS 在「①」环节通过 ArkUI、ArkGraphics 2D、Rosen 等框架与服务实现了从视图到图层的完整链路。

flowchart TB
  subgraph 应用
    A[ArkUI build/update]
    B[Measure / Layout / Draw]
  end
  subgraph 系统图形
    C[Surface / Layer]
    D[Render Service 合成]
    E[帧缓冲]
  end
  subgraph 硬件
    F[VSync]
    G[显示器]
  end
  A --> B --> C --> D --> E --> F --> G

五、总结

通过前面的介绍,我们基本知道了:

  • HarmonyOS 的定位是面向万物互联的分布式操作系统,与 Android 在定位、内核(微内核 vs 宏内核)、运行速度(方舟编译器) 等方面存在差异;底层以 Linux 内核为基石,用户空间通过 JNI 等连通 Java 与 Native。
  • 铺垫知识 部分强调了计算机图形渲染原理与移动端屏幕成像(Vsync、多缓冲)的通用流水线,本文主题聚焦该流水线的第一个环节:视图层、窗口与渲染框架。
  • 视图层与窗口:HarmonyOS 通过窗口子系统(WMS、DMS)管理系统窗口应用窗口(主窗口/子窗口),窗口层级由 WindowType + priority 决定;UIAbility / WindowStage 负责应用侧窗口生命周期;Surface / Layer 是绘制与合成的载体。
  • 渲染框架与流水线:图形栈分为接口层、框架层(含 RS)、引擎层ArkUI 提供声明式 UI 与 Measure–Layout–Draw 管线;2DArkGraphics 2D 为主,3D 通过 XComponent + OpenGL ES 等实现;Rosen(Render Service) 负责图层合成与 VSync,最终与帧缓冲、显示控制器一起完成从应用到屏幕的完整成像链路。

本篇文章,没有解决的问题如下:

  • HarmonyOS 系统事件机制(输入事件从硬件到应用的分发路径、与窗口/焦点的关系)的详细梳理;
  • ArkUI 与 Flutter / SwiftUI 在渲染管线与性能上的对比分析;
  • 更多性能调优卡顿排查在 HarmonyOS 上的具体工具与步骤(如 RS 的 hidumper、ArkUI 的布局与绘制耗时分析)。
  • ……

参考

  • 见文末 参考文献

六、文章推荐


相关阅读(共计 14 篇文章)

iOS 相关专题
webApp 相关专题
跨平台开发方案相关专题
阶段性总结:Native、WebApp、跨平台开发三种方案性能比较
Android、HarmonyOS 页面渲染专题
小程序页面渲染专题
总结

参考文献

[1] 华为开发者. 图形绘制概览 / ArkGraphics 2D(HarmonyOS 文档). developer.huawei.com/consumer/cn…
[2] HarmonyOS 应用窗口管理(Stage 模型)等. 博客园 / 华为云社区.
[3] 深入理解 HarmonyOS UIAbility:生命周期、WindowStage 与启动模式. 华为云社区. bbs.huaweicloud.com/blogs/41689…
[4] OpenHarmony 窗口子系统基本概念与流程分析. 掘金. juejin.cn/post/751099…
[5] 深入解析 HarmonyOS 5 UIAbility 组件:从核心架构到实战应用. CSDN.
[6] 深入解析 OpenHarmony:图层渲染与合成 SurfaceBuffer 实践指南. 百度云. cloud.baidu.com/article/327…
[7] OpenHarmony 实战开发——图形框架解析. 腾讯云开发者. cloud.tencent.com/developer/a…
[8] InfoQ. HarmonyOS ArkUI 框架的实现原理和落地实践. www.infoq.cn/article/tsa…
[9] HarmonyOS 开发者社区 / CSDN. ArkUI 渲染管线、Measure/Layout/Draw、自定义组件 NDK 等.
[10] 掘金. 鸿蒙 HarmonyOS 实战 - 窗口管理. juejin.cn/post/741784…

07-Debug调试@iOS-其它调试方式指导SOP补充

本文在「网络/蓝牙/UI/调试器/崩溃」等专题之外,对 LLDB/GDB 常用操作、Xcode 调试技巧、Chisel/Reveal/FLEX 等其它 iOS 调试方式做 SOP 与要点补充,便于日常查阅与落地使用。


📋 目录


一、LLDB 与 GDB

LLDB 是 Xcode 默认调试器;与 GDB 的命令对应关系可参考:lldb 与 gdb 命令对比

1.1 常用 Debug 快捷键

功能 命令
暂停/继续 Cmd + Ctrl + Y
断点失效/生效 Cmd + Y
控制台显示/隐藏 Cmd + Shift + Y
光标切换到控制台 Cmd + Shift + C
清空控制台 Cmd + K
Step Over F6
Step Into F7
Step Out F8

1.2 技巧一:格式化输出数据

1、封装 log 函数

// Swift 版
func DLog<T>(message: T, file: String = #file, method: String = #function, line: Int = #line) {
    #if DEBUG
        print("\((file as NSString).lastPathComponent) : \(line), \(method)  \(message)")
    #endif
}
// OC 版
#ifdef DEBUG
#define DLog(fmt, ...) NSLog((@"<%s : %d> %s  " fmt), [[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], __LINE__, __PRETTY_FUNCTION__, ##__VA_ARGS__);
#else
#define DLog(...)
#endif

2、代替 NSLog,打印对象的内部属性

在 LLDB 中可使用 po(print object)打印对象描述;若需更细粒度,可结合 exprframe variable。Xcode 控制台在断点停下时,对变量使用「右键 → Print Description of …」或输入 po 变量名 即可查看内部属性。

1.3 技巧二:条件断点(condition)

设置断点后,可为断点添加触发条件,只有条件为真时才暂停,便于在循环或高频调用处精确定位。

注意:在条件表达式中调用 Objective-C 方法时,需强转返回值类型,否则可能报错:

// 正确
(BOOL)[pId isEqualToString:@"short-videopage"]

// 报错:error: no known method '-isEqualToString:'; cast the message send to the method's return type
[pId isEqualToString:@"short-videopage"]

1.4 技巧三:运行中修改变量的值(expr & call)

在断点处可通过 Expression (expr)Debug → Debug Workflow → Evaluate Expression 修改变量或调用方法,无需重新运行。例如:调试登录时临时改 token/登录状态,或调试 UI 时改某控件的颜色、frame。

在调试登录相关的 bug 时,非常方便,不用担心经常输密码,还输错的尴尬

调试 UI,改变指定控件的颜色

1.5 技巧四:符号断点(Add Symbolic Breakpoint)

通过 Add Symbolic Breakpoint 可对符号名(函数/方法)下断点,无需指定具体文件行号。适合在陌生项目中快速了解执行路径,例如对所有 viewDidLoad 下断点,观察页面加载顺序。

Symbol 填写格式

语言/风格 写法说明
C 语言 methodName 只需写函数名,不用写后面的 ()
Objective-C [ClassName methodName],ClassName 为类名,methodName 为方法名(不区分类方法/实例方法)
Swift ClassName.methodName
  • Module:模块筛选,避免不同库中同名方法/函数冲突。
  • Condition:触发条件。可写表达式(如第一个参数不能为 nil);参数可用 $arg3$arg4 等表示(如 $arg3 == nil)。也可调用返回 BOOL 的类方法。
    样例:找出给 [UIImage imageNamed:] 传 nil 的调用。Symbol 设为 [UIImage imageNamed:],Condition 设为 $arg3 == nil,运行中一旦传 nil 就会触发断点。

如何查某个函数的符号:在该函数处打普通断点,运行到断点后,在堆栈信息中查看对应帧的显示格式,即可得到 Symbol 应填的格式。

1.6 技巧五:全局异常断点(Add Exception Breakpoint)

添加 Exception Breakpoint 后,当发生 Objective-C / C++ 异常(或可选 Swift 异常)时,调试器会在抛出处暂停,便于快速定位未捕获异常。

1.7 技巧六:查看整体 UI 层级结构(debug view hierarchy)

Xcode 菜单 Debug → View Debugging → Capture View Hierarchy 可捕获当前界面的视图层级并做 3D 展示与选择。若机器配置较低、卡顿明显,可改用 Chiselpviews 等命令在控制台输出层级文本(参见本文第二节)。

1.8 技巧七:开启僵尸模式(EXC_BAD_ACCESS)

EXC_BAD_ACCESS 常表示向已释放对象发消息。开启 Zombie Objects 后,这类访问会被系统标记,Xcode 可据此在诊断中给出对象类型与释放相关信息,便于定位野指针。

开启步骤Edit Scheme → Run → Diagnostics,勾选 Enable Zombie Objects

1.9 技巧八:查看 frame 的值

在 LLDB 中打印 UIViewframe 等属性时,若直接 p self.view.frame 可能报「property 'frame' not found」。可先 导入 UIKit 模块,再打印:

(lldb) p self.view.frame
error: property 'frame' not found on object of type 'UIView *'
error: 1 errors parsing expression
(lldb) e @import UIKit
(lldb) p self.view.frame
(CGRect) $0 = (origin = (x = 0, y = 0), size = (width = 375, height = 667))

或使用强制转换:

print (CGRect)[view frame]
(CGRect) $1 = (origin = (x = 0, y = 0), size = (width = 200, height = 100))

1.10 技巧九:监听所有点击事件(UIControl、Touch、Gesture)

方法:覆写 UIApplication

通过自定义 UIApplication 子类并重写 sendEvent:,可在事件派发前统一拦截,用于统计、调试或行为分析。

.h 文件:

#import <UIKit/UIKit.h>

NS_ASSUME_NONNULL_BEGIN

@interface CustomApplication : UIApplication

@end

NS_ASSUME_NONNULL_END

.m 文件:

#import "CustomApplication.h"

@implementation CustomApplication
- (void)sendEvent:(UIEvent *)event {
    [super sendEvent:event];
}
@end

main.m 文件:

#import <UIKit/UIKit.h>
#import "AppDelegate.h"
#import "CustomApplication.h"

int main(int argc, char * argv[]) {
    @autoreleasepool {
        return UIApplicationMain(argc,
                                 argv,
                                 NSStringFromClass([CustomApplication class]),
                                 NSStringFromClass([AppDelegate class]));
    }
}

方法执行与事件次数

一次事件可能会执行三次函数:-(void)sendEvent:(UIEvent *)event,三次的 force 有区别


一次事件可能会执行两次函数:-(void)sendEvent:(UIEvent *)event,两次的 force 没区别


响应者链条

1、若是 UIControl 事件,继承自 UIResponder 的控件(如 UIButton)消息传递链(倒序)如下图所示


2、若是 UIGestureRecognizer 手势事件,继承自 UIResponder 的控件(如 UIView)消息传递链(倒序)如下图所示


3、若 UIControl 和 UIGestureRecognizer 同时存在,优先级关系如下图所示


二、其它工具:Chisel

Chisel 是 Facebook(Meta)开源的 LLDB 命令集合,在 Xcode 调试时提供如 pviewspvcfvvisualizebmessage 等高层命令,便于查看视图层级、查找视图、可视化图片、对方法下符号断点等。

安装

具体参考官方 README

使用 Homebrew 安装:

brew update
brew install chisel

安装完成后,将下面一行加入 ~/.lldbinit,Xcode 启动时才会加载 Chisel:

# Intel Mac 常见路径
command script import /usr/local/opt/chisel/libexec/fbchisellldb.py

# Apple Silicon (M1/M2/M3) 常见路径
# command script import /opt/homebrew/opt/chisel/libexec/fbchisellldb.py

若你当前使用的是旧版路径 fblldb.py,且能正常加载,可保留;新版本仓库中入口一般为 fbchisellldb.py,以官方 README 为准。

常用命令

在 LLDB 中查看完整命令列表与说明:

(lldb) help

更完整的 Chisel 命令说明与原理见本目录:05-Debug调试@调试器-Chisel LLDB调试工具:从原理到实践

参考Chisel - LLDB 命令插件,让调试更 Easy


三、其它工具:Reveal

RevealiOS 界面调试 的桌面应用,可连接模拟器或真机,实时查看与修改视图层级、约束、属性等,使用上往往比 Xcode 自带的 View Debugging 更流畅、功能更丰富。软件为商业收费,提供试用(如 30 天),试用期过后需购买授权。

集成方式约有多种(Framework、CocoaPods、Swift Package 等),详情见 Reveal 官网集成指南


四、其它工具:FLEX

FLEX 是 Flipboard 开源的 应用内调试工具集,以第三方库形式集成到 App 中。运行时通过调用 [[FLEXManager sharedManager] showExplorer]; 即可调出调试工具栏,无需连接 Mac,适合真机或脱机场景。

主要功能包括

  • 查看、修改 views
  • 查看任意对象的属性
  • 动态修改属性
  • 动态调用实例方法与类方法
  • 查看网络请求过程
  • 添加模拟的键盘快捷键
  • 查看系统日志
  • 从堆中获取任意对象
  • 查看沙盒中的文件
  • 查看文件系统中的 SQLite / Realm 数据库
  • 在模拟器中触发 3D Touch
  • 查看应用中所有的类
  • 快速获取常用对象(如 [UIApplication sharedApplication]、App Delegate、key window 的 root view controller 等)
  • 动态查看 NSUserDefaults 中的值

参考文献

06-Debug调试@崩溃-iOS崩溃日志分析与反解(符号化):从原理到实践

📋 目录


一、概述与历史演进

1.1 什么是崩溃日志与符号化

当 iOS/macOS 应用因未捕获异常、非法内存访问、系统终止等原因退出时,操作系统会生成一份崩溃报告(crash report),记录进程终止时的状态:异常类型、终止原因、各线程的调用栈(backtrace)、已加载的二进制镜像(binary images)等 [1][2]。其中调用栈以内存地址形式呈现符号化(symbolication) 即把这些地址替换为可读的函数名与源码行号,使开发者能定位到具体代码位置 [2][3]。

  • 未符号化:栈帧显示为 0x1022cbfa80x1022c0000 + 49064 等,难以直接对应源码。
  • 已符号化:栈帧显示为 Line.updateRectForExistingPoint(_:) (in TouchCanvas) + 656ViewController.touchesEstimatedPropertiesUpdated(_:) (in TouchCanvas) + 304,可直接对应到工程中的类与方法 [2]。

符号化依赖与崩溃时运行二进制一一对应的 dSYM(Debug Symbol)文件及正确的加载地址(load address);只有 Build UUID 一致 的二进制与 dSYM 才能正确反解 [3][4]。

1.2 历史与格式演进

时期/变化 说明
传统 .crash 文本格式 早期至 iOS 14,崩溃报告多为纯文本:Incident IdentifierProcessException TypeThread 0 CrashedBinary Images 等字段,便于人工阅读与 grep [1][5]
iOS 15 / macOS 12 起 .ips 系统改为将崩溃数据存为 JSON,文件扩展名为 .ips;首行为 IPS 元数据对象,其余为崩溃报告数据对象。Console 等工具将 JSON 转成可读展示 [6][7]
Xcode Organizer 与自动符号化 从 App Store / TestFlight 收集的崩溃若在上传时包含符号,Xcode 的 Crashes 组织器可自动符号化;本地需自行提供 dSYM [2][8]
TN2151 与现行文档 Apple 早年的 Technical Note TN2151: Understanding and Analyzing Application Crash Reports 仍被广泛引用;现行说明已迁移至 Adding identifiable symbol names to a crash report 等官方文档 [2][3]

1.3 典型应用场景

  • 线上/TestFlight 崩溃定位:用户或测试反馈崩溃,从 Xcode Organizer 或邮件拿到 .ips/.crash,用对应版本的 dSYM 符号化后根据异常类型与栈顶帧排查。
  • 内存与稳定性问题:EXC_BAD_ACCESS、EXC_CRASH (SIGABRT)、Watchdog 等,结合 Exception Type、Termination Reason、Last Exception Backtrace 分析。
  • 审核或论坛反馈:App Review 或用户提供的 .txt/.crash,重命名为 .crash 后在 Xcode 中拖入 Device Logs 或使用 symbolicatecrash/atos 反解 [2][8]。
  • 多版本/多架构管理:为每个分发版本保留 Archive 与 dSYM,用 UUID 匹配正确 dSYM 进行符号化 [3][4]。

二、核心概念与崩溃报告结构

2.1 崩溃报告包含哪些信息

无论 .crash 文本还是 .ips 中的 JSON,一份完整崩溃报告通常包含 [1][6][9]:

部分 含义
Header / 元数据 进程名、Bundle ID、版本、设备/系统、时间、Incident Identifier、CrashReporter Key 等,用于区分环境与用户
Exception / 异常信息 异常类型(如 EXC_BAD_ACCESS、EXC_BREAKPOINT、EXC_CRASH)、信号(SIGSEGV、SIGABRT 等)、Exception Codes、Exception Message/Subtype
Termination 若进程被系统或其它进程终止,会包含 Termination Reason、namespace、code、indicator 等 [6]
Threads / 线程与栈 各线程的 backtrace(frames)、触发崩溃的线程标记、部分场景下的 threadState(寄存器)
Last Exception Backtrace 语言层异常(如 Objective-C/Swift 未捕获异常)时的专用栈,便于区分“谁抛出了异常” [9]
Binary Images 进程内已加载的二进制列表:名称、路径、UUID、加载地址(base)、大小;符号化与 atos 依赖此处的 UUID 与 base

2.2 栈帧(Frame)与 Backtrace

  • Frame 0:崩溃发生时正在执行的函数(或最内层调用)。
  • Frame 1, 2, …:调用者链,从内到外;通常从栈顶向下读,先看 Frame 0 与自家 App 的帧,再结合系统帧理解调用链 [9]。
  • 每帧包含:二进制名运行时地址(或 imageOffset + 对应 image 的 base)、符号化后为 函数名 + 偏移(+ 行号视工具而定) [6][7]。

三、崩溃报告格式:.crash 与 .ips

3.1 传统 .crash 文本格式(概要)

常见字段包括 [1][5]:

  • Incident IdentifierCrashReporter Key
  • ProcessIdentifierVersionCode Type
  • Exception TypeException CodesException SubtypeCrashed Thread
  • Thread 0 Crashed: 下列出各帧:序号 二进制名 地址 符号或 基址+偏移
  • Binary Images: 下列出各镜像的地址范围、名称、UUID(括号内,常为小写无连字符)

Xcode 的 Device Logs 要求文件扩展名为 .crash;若拿到的是 .txt 或其它扩展名,需重命名为 .crash 再拖入,才能正确触发符号化 [2]。

3.2 .ips:JSON 双对象结构(iOS 15+)

.ips 文件由两段 JSON 组成 [6][7]:

  1. 第一行IPS 元数据对象(单行一个 JSON 对象)。
  2. 其余内容崩溃报告数据对象(当 bug_type == "309" 时表示崩溃报告)。

解析逻辑要点(与官方示例一致)[6]:

  • 先读第一行解析 metadata。
  • metadata["bug_type"] == "309",再把剩余部分解析为 report。
  • 报告中的地址、码值等在 JSON 中多为十进制,需按需转为十六进制以便阅读或传给 atos [6][7]。

3.2.1 IPS 元数据常用键

Key 类型 说明
name String 进程可执行文件名
bug_type String 日志类型,309 表示崩溃报告;288 表示 stackshot 等 [6]
bundleID String Bundle 标识符
build_version String 构建版本号
incident_id String 报告唯一 ID
platform Number 平台(1=macOS, 2=iOS, 3=tvOS, 4=watchOS, 6=Mac Catalyst, 7=iOS Simulator 等)[6]
timestamp String 日志系统记录时间

3.2.2 崩溃报告对象常用键

Key 类型 说明
exception Dictionary typesignalcodessubtypemessage 等 [6]
faultingThread Number 崩溃线程在 threads 数组中的下标
threads Array 各线程对象,含 framesidqueuetriggeredthreadState 等 [6][7]
usedImages Array Binary images:basesizenamepathuuidarchsource 等 [7]
captureTimeprocLaunch String 崩溃时间、进程启动时间
lastExceptionBacktrace Array 语言层异常栈 [6]
bundleInfoosVersionstoreInfo Dictionary 包信息、系统版本、商店信息等

3.2.3 Frames 与 Binary Images(用于符号化)

  • frames 中每帧:imageIndex(对应 usedImages 下标)、imageOffset(相对该镜像的偏移)、symbolsymbolLocation(符号化后才有)[7]。
  • usedImages 中每项:base(加载地址)、uuid(Build UUID,用于匹配 dSYM)、namepatharch [7]。
    符号化时:运行时地址 = base + imageOffset;atos 需要 -l base 和该镜像对应的 dSYM [2][3]。

四、dSYM 与符号化原理

4.1 dSYM 是什么

dSYM(Debug Symbol File) 是 Xcode 生成的调试符号包,与编译出的二进制一一对应:包含函数名、行号、变量等 DWARF 调试信息,不随 App 分发,仅用于调试与崩溃反解 [3][4]。每个可执行体(主程序、Extension、Framework)各有自己的 dSYM;二进制与 dSYM 通过 Build UUID 绑定,只有 UUID 完全一致才能正确符号化 [3][4]。

4.2 生成与归档 dSYM

在 Xcode 中 [4]:

  • Build Settings → Debug Information Format 设为 DWARF with dSYM File(Release 与需分析崩溃的构建建议一致)。
  • Generate Debug Symbols 建议保持 YES

归档(Archive)时,Xcode 会把该次构建的所有二进制与 dSYM 收进 .xcarchive;上传 App Store/TestFlight 时可勾选上传符号,便于在 Crashes 组织器中自动符号化 [2][4]。必须为每个对外分发的版本保留对应 Archive,否则无法为该版本崩溃找到匹配 dSYM [4]。

4.3 符号化的本质

  • 崩溃报告里记录的是运行时地址(或 image 的 base + offset)。
  • 编译器在生成二进制时,会把符号与地址的对应关系写入 dSYM(DWARF)。
  • 符号化工具(Xcode、symbolicatecrash、atos)根据 UUID 找到对应 dSYM,再根据 load address(base) 把运行时地址换算成“镜像内偏移”,在 dSYM 中查找函数与行号并写回报告或输出 [2][3]。

因此:UUID 不一致(例如换了 Xcode 版本或编译选项重新构建)、缺少 dSYMload address 错误,都会导致无法符号化或结果错误。


五、获取崩溃报告

5.1 从 Xcode 与 App Store Connect

  • Xcode → Window → Organizer → Crashes:可看到已同步的崩溃报告(来自 TestFlight/App Store 用户且已开启诊断共享)。若上传时包含符号,此处多为已符号化 [2][8]。
  • Xcode → Window → Devices and Simulators → 选中设备 → View Device Logs:可把本机或用户导出的 .crash/.ips 拖入 Device Logs 列表,由 Xcode 自动尝试符号化(需本机有对应 dSYM 或系统符号)[2]。

5.2 从设备本地导出(用户/测试人员操作)

iOS / iPadOS [8]:

  1. 设置 → 隐私与安全性 → 分析与改进 → 分析数据(Analytics Data)。
  2. 找到以应用名为前缀的崩溃日志(名称常以 _ 开头),点进后通过“分享”以邮件等方式发给开发者。

macOS [8]:

  1. 打开 Console.app → 左侧选择本机 → Crash Reports。
  2. 找到对应应用的崩溃报告,右键 → Reveal in Finder,可复制或通过邮件发送。

5.3 调试时生成完整崩溃报告

若在 Xcode 中调试时发生崩溃,调试器会先接管,系统不会立即写盘。需要“完整崩溃报告”时:Debug → Detach(或 LLDB 中执行 detach),让进程继续运行直至退出,系统再生成报告;再按 5.2 方式在设备或 Mac 上找到该报告 [8]。


六、符号化操作 SOP

6.1 前置检查:UUID 一致

符号化前必须确认:崩溃报告里该二进制的 UUIDdSYM 的 UUID 一致。

  • 从报告中找 Binary Images 里该镜像的 UUID(.ips 的 usedImages[].uuid;.crash 常在小括号内,小写无连字符)。
  • 在终端执行 [2][3]:
dwarfdump --uuid <PathToDSYM>/Contents/Resources/DWARF/<BinaryName>
dwarfdump --uuid <PathToBinary>

两者一致才可用该 dSYM 符号化该二进制。

6.2 用 Xcode 符号化(推荐)

  1. 扩展名:确保报告为 .crash(.ips 若 Xcode 支持可直接拖,否则可先导出为 .crash 或保留 .ips 用命令行)。
  2. 打开 Devices and Simulators → 选中设备 → View Device Logs
  3. 将崩溃报告文件拖入左侧日志列表。
  4. 若本机 Spotlight 可搜到对应 UUID 的 dSYM(例如在 ~/Library/Developer/Xcode/Archives 或项目 DerivedData),Xcode 会自动符号化;符号化后栈中会显示函数名与行号 [2]。

若未符号化或仅部分符号化:多为缺少匹配 dSYM系统框架符号缺失(需连接过对应系统版本的设备,让 Xcode 拉取系统符号)[2]。

6.3 用 symbolicatecrash 命令行

位置(随 Xcode 安装)[2][3]:

/Applications/Xcode.app/Contents/SharedFrameworks/DVTFoundation.framework/Versions/A/Resources/symbolicatecrash

环境变量(必须)[2][3]:

export DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer

用法示例 [2][3]:

symbolicatecrash /path/to/crash.crash /path/to/App.dSYM > symbolicated.txt
# 或指定 dSYM 目录
symbolicatecrash -d /path/to/dSYMs -o symbolicated.txt /path/to/crash.crash
  • 支持一次传入多个 dSYM 或目录,工具会按报告中的 UUID 自动匹配。
  • 输入必须是系统生成的完整崩溃报告(含 Binary Images),否则无法解析。

6.4 用 atos 单地址符号化

适用于:只有若干地址、或在 LLDB/脚本中对单帧反解。

公式 [2][3][7]:报告中某帧的运行时地址 = 该镜像在报告中的 base(load address) + 该帧的 imageOffset(.ips 中)或从 “base+offset” 形式中读出。

命令形式 [2][3]:

atos -arch <arch> -o <PathToDSYM>/Contents/Resources/DWARF/<BinaryName> -l <LoadAddress> <Address1> [Address2 ...]

示例(Binary 名为 TouchCanvas,arm64,base 0x1022c0000)[2]:

atos -arch arm64 -o TouchCanvas.app.dSYM/Contents/Resources/DWARF/TouchCanvas -l 0x1022c0000 0x00000001022df754
# 输出示例:ViewController.touchesEstimatedPropertiesUpdated(_:) (in TouchCanvas) + 304
  • -o 必须是 dSYM 包内的 DWARF 文件路径,不能只写 .dSYM 包路径 [2]。
  • -l 必须是该次运行中该镜像的 load address,在 Binary Images 中查。

6.5 用 Spotlight 查找本机 dSYM(按 UUID)

若已知 Binary 在报告中的 Build UUID(如 9cc89c5e55163f4ab40c5821e99f05c6),可转为标准格式(大写、8-4-4-4-12)再查 [2]:

mdfind "com_apple_xcode_dsym_uuids == 9CC89C5E-5516-3F4A-B40C-5821E99F05C6"

若返回路径,说明本机有该 dSYM,可再 dwarfdump --uuid 核对后用于 Xcode 或 symbolicatecrash。

6.6 符号化 SOP 速查

步骤 操作
1 拿到 .ips 或 .crash;若是 .txt,重命名为 .crash 以便 Xcode 识别
2 在报告底部 Binary Images 中确认主程序/Extension 的 UUID 与 arch
3 mdfind "com_apple_xcode_dsym_uuids == <UUID>" 或 Archive 路径找到对应 dSYM,dwarfdump --uuid 核对
4 优先在 Xcode Device Logs 中拖入报告,由 Xcode 自动符号化
5 若需命令行:设置 DEVELOPER_DIR,用 symbolicatecrash 传入报告与 dSYM(或目录),输出到文件
6 若仅有个别地址:从 Binary Images 取 base,用 atos -arch -o -l 反解

七、异常类型与诊断要点

7.1 常见异常类型(Exception Type)

以下为 Apple 文档中常见类型与含义摘要 [10][11]:

异常类型 典型含义与排查方向
EXC_BAD_ACCESS (SIGSEGV) 非法或越界内存访问(野指针、已释放对象、栈溢出等)[10]
EXC_BAD_ACCESS (SIGBUS) 错位访问、指针认证失败等 [10]
EXC_BREAKPOINT (SIGTRAP) 陷阱指令触发;Swift 中常见于强制解包 nil、断言失败、fatalError 等 [10][11]
EXC_CRASH (SIGABRT) 进程调用 abort() 或断言失败;常见于 NSException 未捕获、Objective-C 异常、断言 [10]
EXC_CRASH (SIGKILL) 被系统终止:如 Watchdog、内存压力、用户强退等 [10]
EXC_CRASH (SIGTERM) 软件终止信号 [10]
EXC_GUARD 违反受保护资源(如文件描述符 guard)[10]
EXC_RESOURCE 超过资源限制(CPU 时间、内存等)[10]
EXC_ARITHMETIC 算术异常(如除零、浮点错误)[10]

7.2 诊断时的使用方式

  • 先看 Exception Type / signal 判断大类:内存问题、断言/abort、系统杀进程等。
  • 结合 Exception Message / Termination ReasonLast Exception Backtrace(若有)缩小范围。
  • Crashed ThreadFrame 0 与自家 App 的栈帧是首要关注点;系统库帧可帮助理解调用链(例如是否在 present popover、主线程卡顿等)[9]。

八、崩溃分析流程与解读

8.1 分析顺序建议(基于 Apple 文档 [9])

  1. 确认报告已充分符号化:至少自家 App 的栈帧要有函数名与行号;否则先按第六章完成符号化。
  2. 从用户视角找入口:根据栈中与业务相关的帧,推断用户当时在使用什么功能(例如某个 VC、某个 present)。
  3. 看 Header:设备型号、系统版本、App 版本、启动时间与崩溃时间(运行时长)、是否 TestFlight、主 App 还是 Extension 等,用于复现环境与分组。
  4. 看异常信息:Exception Type、Exception Codes、Termination Reason,判断是内存、断言、Watchdog 等哪一类。
  5. 看崩溃线程 backtrace:从 Frame 0 往上看,先关注自家代码;再结合 Last Exception Backtrace(若有)看“谁抛出了异常”。
  6. 看其它线程:是否有大量相似等待、是否涉及不该在非主线程调用的 API(如 UI)等 [9]。
  7. 复杂内存/寄存器问题:可结合 threadState 与 atos 对 PC/LR 等地址符号化,或参考 [Investigating memory access crashes] 等专项文档。

8.2 分组与复现

  • 多份报告可按 相同 Exception Type + 相同栈顶帧相同 Termination Reason 分组,便于判断是否为同一根因、是否可稳定复现 [9]。
  • 用 Header 中的 CrashReporter Key / Beta Identifier 区分不同用户/设备,评估影响面。

8.3 系统符号与 Binary Images

  • 若系统库帧未符号化,需在与报告系统版本一致的设备上连接 Xcode,让 Xcode 拉取该系统版本的符号;或在本机已有对应版本符号时,Xcode 才能反解系统帧 [2]。
  • Binary Images 可用来确认:主程序与各 Framework/Extension 的 UUID是否缺少预期加载的库(如动态加载的 framework)[9]。

九、关键概念图示与流程

9.1 崩溃报告生成与符号化数据流

flowchart LR
    subgraph 设备
        A[App 崩溃]
        B[系统收集状态]
        C[.ips / .crash]
    end
    subgraph 开发机
        D[dSYM]
        E[Xcode / symbolicatecrash / atos]
        F[符号化报告]
    end
    A --> B --> C
    C --> E
    D --> E
    E --> F

9.2 符号化匹配关系

flowchart TB
    subgraph 崩溃报告
        U1[Binary Images: UUID, base, name]
        F1[Frames: imageIndex, imageOffset]
    end
    subgraph 本地
        DSYM[dSYM: UUID, DWARF]
    end
    U1 -->|UUID 一致| DSYM
    F1 -->|base + imageOffset = 运行时地址| atos
    DSYM --> atos[atos / symbolicatecrash]
    atos --> out[函数名 + 行号]

9.3 从获取到分析的流程

flowchart TD
    A[获取 .ips / .crash] --> B{是否已符号化?}
    B -->|否| C[按 UUID 找 dSYM]
    C --> D[Xcode 拖入 或 symbolicatecrash/atos]
    D --> E[得到符号化报告]
    B -->|是| E
    E --> F[看 Exception Type]
    F --> G[看 Crashed Thread 栈顶与自家帧]
    G --> H[结合 Last Exception / Termination]
    H --> I[定位代码与复现路径]

十、伪代码与算法说明

10.1 判断报告是否已符号化

根据 Apple 文档 [2]:若 backtrace 中每一帧都包含可读函数名(而非“基址+偏移”或纯地址),则视为已完全符号化;若仅部分帧有函数名,为部分符号化;若全是地址或“基址+偏移”,为未符号化

对于报告中的每个线程 thread:
  对于 thread 的每个帧 frame:
    若 frame 仅包含 "0x... + 数字" 或 "基址 + 偏移" 且无函数名:
      返回 "未符号化"
若 存在任一 frame 无函数名:
  返回 "部分符号化"
否则:
  返回 "已符号化"

10.2 atos 使用的地址关系

报告中某帧的运行时地址load address(base)imageOffset 关系 [2][7]:

运行时地址 = base(Binary Images 中该镜像的 base) + imageOffset(该帧相对该镜像的偏移)

atos 内部会用“运行时地址 - base”得到相对偏移,在 dSYM 的 DWARF 中查找对应符号与行号。因此 -l 必须传入该次运行的 base(从同一份报告的 Binary Images 读取)。

10.3 UUID 匹配与 dSYM 查找

1. 从崩溃报告 Binary Images 中取出目标镜像的 uuid 字符串(可能为小写、无连字符)。
2. 转为标准格式:32 字符,8-4-4-4-12,大写,连字符分隔。
3. 使用 mdfind "com_apple_xcode_dsym_uuids == <UUID>" 得到候选 dSYM 路径。
4. 对候选路径执行 dwarfdump --uuid <dSYM内DWARF路径>,与报告中的 uuid(忽略大小写与连字符)比较。
5. 一致则该 dSYM 可用于该二进制;否则需从 Archive 或构建产物中取正确版本。

十一、应用场景与最佳实践

11.1 构建与归档

  • Release/分发构建 统一使用 DWARF with dSYM File,并保留每次分发的 Archive(含 dSYM)[4]。
  • 上传 App Store/TestFlight 时勾选上传符号,便于 Organizer 中自动符号化 [2][4]。

11.2 第三方崩溃统计与符号上传

若使用 Firebase Crashlytics、Bugly、Sentry 等,需按各平台文档在构建阶段上传 dSYM(或符号表),以便其服务端对上报的堆栈做符号化 [12]。例如 Firebase 要求在 Xcode Build Phases 中配置上传脚本与 dSYM 路径 [12]。

11.3 .ips 与脚本化处理

  • .ips 为 JSON,便于用脚本解析:取 bug_type==309threadsusedImagesexception 等,批量提取 UUID、faultingThread、栈顶帧等 [6][7]。
  • 若需对大量报告做“是否可符号化”检查,可解析 usedImages 中的 uuid,与本地或符号服务器中的 dSYM UUID 列表比对。

11.4 常见崩溃模式与专项文档

11.5 官方文档与延伸阅读

资源 用途
Adding identifiable symbol names to a crash report 符号化步骤、Xcode/atos、UUID、mdfind [2]
Analyzing a crash report 分析顺序、Header/Exception/Backtrace/寄存器 [9]
Interpreting the JSON format of a crash report .ips 结构、metadata、report 各键 [6][7]
Understanding the exception types in a crash report 异常类型与信号含义 [10]
Acquiring crash reports and diagnostic logs 获取途径、设备导出、Organizer [8]
Building your app to include debugging information dSYM 生成、上传与归档 [4]
Identifying the cause of common crashes 常见崩溃模式与排查思路
Investigating memory access crashes 内存访问崩溃深入分析

参考文献

[1] Apple. Understanding and Analyzing Application Crash Reports (TN2151).
[2] Apple. Adding identifiable symbol names to a crash report. developer.apple.com/documentati…
[3] Apple. Symbolicating iPhone App Crash Reports (Stack Overflow / 社区实践).
[4] Apple. Building your app to include debugging information. developer.apple.com/documentati…
[5] 阿里云. 苹果官方文档:理解和分析ios应用崩溃日志. developer.aliyun.com/article/239…
[6] Apple. Interpreting the JSON format of a crash report. developer.apple.com/documentati…
[7] Apple. Interpreting the JSON format of a crash report — Binary images, Frames, Convert numeric values.
[8] Apple. Acquiring crash reports and diagnostic logs. developer.apple.com/documentati…
[9] Apple. Analyzing a crash report. developer.apple.com/documentati…
[10] Apple. Understanding the exception types in a crash report. developer.apple.com/documentati…
[11] RY's Blog. EXC_BREAKPOINT when forced unwrapping optional in Swift.
[12] Firebase. 在 Crashlytics 信息中心内获取易于理解的崩溃报告(Apple 平台) / Get deobfuscated crash reports.
[13] Apple. Identifying the cause of common crashes. developer.apple.com/documentati…
[14] Apple. Investigating memory access crashes. developer.apple.com/documentati…

04-Debug调试@UI-Lookin UI调试工具:从原理到实践

Lookin UI 调试工具:从原理到实践

📋 目录


一、概述与历史演进

1.1 工具简介

Lookin 是一款免费的 macOS 端 iOS 视图调试应用,与 LookinServer(嵌入 iOS 工程的 Framework)配合使用,可查看与修改 iOS App 内的 UI 对象——包括视图层级结构、视图与控件属性、布局与约束等,功能定位类似 Xcode 自带的 UI Inspector 或商业软件 Reveal [1][2][3]。

Lookin 由 QMUI 团队(曾隶属微信读书等产品)开源并维护:LookinServer 为 iOS 端 SDK(GitHub: QMUI/LookinServer),Lookin 为 macOS 端桌面应用(GitHub: hughkli/Lookin)。官网为 lookin.work/;集成后支持模拟器与真机,并可在无 Mac 连接时通过 App 内摇一摇等方式使用内置调试界面 [1][2][4][5]。

1.2 历史与版本脉络

时期/版本 事件
开源发布 Lookin / LookinServer 以免费、开源形式发布,填补 Xcode UI Inspector 能力有限、Reveal 收费等需求 [1][2]
仓库与官网 iOS 端 QMUI/LookinServer、Mac 端 hughkli/Lookin;官网 lookin.work 提供集成指南与 FAQ [1][2]
集成方式演进 支持 CocoaPods(ObjC / Swift 子库)、Swift Package Manager手动集成(Framework + Run Script)[1][2][4]
1.0.6+ 安全要求 禁止在 Release/App Store 构建中集成 LookinServer不要使用早于 1.0.6 的版本,旧版存在严重 Bug 可能导致线上事故 [2][6]
文档与技巧 官方与社区提供「自定义信息展示」「更多成员变量」「Swift 优化」等进阶文档(如字节飞书文档汇总)[2]

1.3 典型应用场景

  • 视图层级与结构排查:查看完整 UI 树(含屏幕外、hidden 视图)、UITableViewCell 的 indexPath、嵌套层级与折叠级别,定位视图遮挡、层级错误或约束冲突。
  • 属性查看与修改:实时查看 frame、bounds、backgroundColor、alpha、约束等;在 Mac 端或控制台修改属性并立即在设备上生效,用于快速验证布局与样式。
  • 导出与协作:将当前页面的 UI 信息导出为文件,脱离 Xcode 与设备单独查看或分享给他人分析。
  • 方法监听与堆栈:监听指定方法调用并打印堆栈,辅助定位触发时机与调用链。
  • 无 Mac 场景:在真机上通过摇一摇等触发 App 内 Lookin 界面,不依赖 Mac 连接即可做基础审查。

二、核心原理与架构

2.1 双端架构:LookinServer(iOS)与 Lookin(macOS)

Lookin 采用 「iOS 端 SDK + macOS 端桌面应用」 的 C/S 式架构 [1][2][4][5]:

  • LookinServer(iOS):以 Framework 形式嵌入目标 App(仅 Debug 配置)。在 App 进程内通过 Objective-C Runtime反射 获取当前 UI 层级与视图属性,将数据序列化后通过进程间/网络通信发送给 Mac 端。
  • Lookin(macOS):在 Mac 上运行,发现并连接同一网络或通过 USB 转发的 iOS 设备/模拟器上的 LookinServer,接收序列化数据后反序列化并渲染为 2D 层级树3D 视图,支持属性编辑与指令回传。

因此,不集成 LookinServer 的 App 无法被 Mac 版 Lookin 连接;集成后,模拟器或真机与 Mac 需处于可发现/可通信环境(如本机模拟器、同网段或 USB 连接)[1][2][4]。

2.2 视图信息的获取与序列化(概念)

iOS 的 UI 层级根植于 UIWindow / UIViewController 及其 view 层级。LookinServer 在 App 进程内 [4][5]:

  1. 遍历视图树:从 keyWindow(或指定 window)的 rootViewController 出发,递归访问 view.subviews,得到整棵视图树;可配置折叠深度、是否包含 hidden 视图等。
  2. 提取属性:对每个 UIView(及其子类)利用 Runtime 读取属性(如 frame、bounds、backgroundColor、layer 信息、约束等),以及自定义的 LKS_Config 等扩展属性。
  3. 序列化:将树形结构及属性编码为可在进程间或网络上传输的格式(如自定义二进制或 JSON),并发送给 Mac。
  4. Mac 端反序列化与展示:Lookin 收到数据后重建树结构,在 2D 面板展示层级、在 3D 视图展示空间关系,并支持点击选中、属性面板编辑。

修改回写:用户在 Mac 上修改某视图属性(如 frame、backgroundColor)时,Lookin 将修改指令发回 LookinServer,LookinServer 在 App 主线程对对应视图执行 setter(如 view.frame = ...),实现实时生效 [4][5]。

2.3 三种使用模式:2D、3D、Export

  • Lookin_2D:在 Mac 或 App 内以树形列表形式展示视图层级,点击节点可查看/编辑属性,对应「审查元素」。
  • Lookin_3D:将视图层级以三维空间形式展示,便于观察重叠、遮挡与 z-order。
  • Lookin_Export:将当前 UI 快照(层级与属性)导出为文件,可在未连接设备时用 Lookin 打开查看 [1][4][5]。
    触发方式:除在 Mac 或 App 内点击对应入口外,可通过代码发送通知触发,例如(Objective-C): [[NSNotificationCenter defaultCenter] postNotificationName:@"Lookin_Export" object:nil];
    同理可触发 Lookin_2DLookin_3D [1][5]。

2.4 数据流概览

flowchart LR
    subgraph iOS App
        A[UIWindow / ViewController]
        B[LookinServer]
        C[Runtime / 视图树遍历]
    end
    subgraph 传输
        D[序列化]
        E[IPC / 网络]
    end
    subgraph Mac
        F[Lookin]
        G[反序列化 / 2D·3D 展示]
        H[属性编辑回写]
    end
    A --> C
    C --> B
    B --> D
    D --> E
    E --> F
    F --> G
    G --> H
    H --> E
    E --> B

三、获取、安装与集成

3.1 前置条件

项目 说明
Mac 安装 Lookin 桌面应用(从官网或 GitHub Release 下载)[1][2]
Xcode 用于编译运行 iOS 工程;LookinServer 仅需在 Debug 配置下集成 [1][2]
iOS 项目 支持 Objective-C 或 Swift;Swift 项目需使用 Swift 子库或 SPM [2]

3.2 获取 Lookin 桌面应用

3.3 集成 LookinServer 到 iOS 项目(官方方式 [1][2])

重要仅在 Debug 配置下集成不要使用早于 1.0.6 的版本 [2][6]。

通过 CocoaPods
  • Objective-C 项目:在 Podfile 中增加
    pod 'LookinServer', :configurations => ['Debug']
    然后 pod install
  • Swift 项目
    pod 'LookinServer', :subspecs => ['Swift'], :configurations => ['Debug']

若项目使用自定义 xcconfig,需将所有 Debug 相关配置名列入 configurations,例如:
pod 'LookinServer', :configurations => ['Debug', 'Debug-Staging']
否则 Release 或其它配置可能误链 LookinServer,存在上线风险 [4][7]。

通过 Swift Package Manager
  • 在 Xcode 中:File → Add Package Dependencies,填入
    https://github.com/QMUI/LookinServer
    并选择仅在 Debug 配置下链接该依赖。
手动集成
  • LookinServer 仓库 获取 LookinServer.framework(或源码),加入工程。
  • 通过 Run Script 在构建时按配置条件嵌入;需定义宏(如 SHOULD_COMPILE_LOOKIN_SERVER)确保 Release 不包含。详见 官网集成指南Run Script 说明 [2][4]。

3.4 集成后验证

  1. Debug 配置编译并运行到模拟器真机(真机与 Mac 需同网或通过 USB 等可发现方式)。
  2. 打开 Mac 上的 Lookin,应能自动发现并列出当前运行中的 App。
  3. 选择对应设备与 App,连接成功后即可看到 2D 层级与 3D 视图;若无法发现,请检查网络、防火墙及是否确为 Debug 包且已包含 LookinServer。

四、使用流程与操作步骤

4.1 基本使用流程(Mac + 模拟器/真机)

步骤 操作 说明
1 Debug 配置运行 iOS App 模拟器或真机均可;真机与 Mac 需可通信(同网或 USB)
2 打开 Mac 上的 Lookin 从应用程序或官网下载的 app 启动
3 在 Lookin 中选择设备与 App 列表中选中当前运行中的 App,建立连接
4 选择 2D3D 模式 2D:树形层级与属性面板;3D:空间关系与遮挡
5 在层级树或 3D 视图中选中视图 右侧或面板中显示该视图属性,可编辑并实时生效
6 (可选)使用控制台或方法监听 执行代码或监听方法调用与堆栈
7 (可选)导出 使用 Export 将当前 UI 快照导出为文件,便于离线查看或分享

4.2 无 Mac 连接:App 内使用

  • 在已集成 LookinServer 的 App 中,可通过摇一摇(或配置的其它手势)调起 Lookin 内置的调试界面 [3][5]。
  • 或通过代码发送通知触发 2D/3D/Export:
    • Lookin_2D:审查元素
    • Lookin_3D:3D 视图
    • Lookin_Export:导出文件
      这样可在真机或他人设备上不连 Mac 也能做基础 UI 审查与导出。

4.3 导出(Lookin_Export)

  • 在 Mac 或 App 内触发 Export 后,当前页面的 UI 层级与属性会保存为 Lookin 可识别的文件格式。
  • 导出文件可在未连接设备时用 Lookin 打开,用于归档、协作或问题复现 [1][5]。

五、功能体系与数据表示

5.1 功能总览

功能 说明
视图层级展示 树形结构展示 UI 层级,支持折叠级别、显示 hidden 视图、屏幕外视图;可显示 UITableViewCell 的 indexPath 等 [1][4]
属性查看与编辑 查看 frame、bounds、backgroundColor、alpha、约束等;在 Mac 或控制台修改后实时回写到 App [1][4][5]
2D 审查 对应 Lookin_2D,以列表+属性面板形式审查元素
3D 视图 对应 Lookin_3D,以三维形式展示视图堆叠与遮挡关系
导出 将当前 UI 快照导出为文件,脱离设备与 Xcode 查看 [1][5]
控制台 输入代码访问当前选中视图或类,执行方法或读取属性 [1][4]
方法监听 监听特定方法调用并打印堆栈,辅助定位调用链 [1][4]
自定义展示 通过 LKS_Config 等接口在 Lookin 中展示自定义信息或更多成员变量 [2]

5.2 与 Xcode UI Inspector 的差异(概念)

  • 范围:Lookin 可展示比 Xcode UI Inspector 更大范围的视图(不限于当前屏幕可见区域),且可配置折叠与 hidden 视图 [1][4]。
  • 形态:Lookin 提供独立的 Mac 应用与 2D/3D/Export 多种形态;Xcode 的 UI Inspector 嵌入在 Debug 会话中。
  • 集成:Lookin 需主动集成 LookinServer;Xcode 对任意 Debug 运行中的 App 均可使用 UI Inspector,但功能相对简单。

六、关键概念图示与流程

6.1 双端与数据流

flowchart TB
    subgraph iOS
        APP[App 进程]
        RT[Runtime / 视图树]
        LKS[LookinServer]
    end
    subgraph 传输
        S[序列化]
        C[连接]
    end
    subgraph macOS
        LK[Lookin]
        UI[2D / 3D / 属性面板]
    end
    APP --> RT
    RT --> LKS
    LKS --> S
    S --> C
    C --> LK
    LK --> UI
    UI -->|编辑回写| C
    C --> LKS

6.2 使用流程简图

sequenceDiagram
    participant U as 用户
    participant M as Mac Lookin
    participant I as iOS App + LookinServer

    U->>M: 打开 Lookin,选择设备与 App
    M->>I: 建立连接
    I->>I: 遍历视图树,序列化
    I->>M: 发送 UI 数据
    M->>U: 展示 2D/3D 与属性
    U->>M: 编辑属性或触发 Export
    M->>I: 回写修改或请求导出
    I->>M: 确认或返回导出文件

七、应用场景与最佳实践

7.1 视图层级与布局调试

  • 使用 2D 检查嵌套层级、view 的父子关系与同层顺序,结合 3D 查看重叠与遮挡。
  • 利用「显示 hidden 视图」「折叠级别」减少噪音,快速定位目标 view;通过属性面板查看 frame、constraints、autoresizing 等,判断布局异常原因。

7.2 属性实时修改与验证

  • 在属性面板直接改 frame、backgroundColor、alpha 等,无需改代码重新运行,适合快速验证样式与布局假设。
  • 注意:修改仅对当前运行实例生效,不会写入源码;需将确认后的值同步到代码或约束中。

7.3 导出与协作

  • 对难以复现的 UI 问题,使用 Export 导出当前页面快照,将文件发给同事或在未连接设备时用 Lookin 打开分析。
  • 建议在问题复现后立即导出,避免界面变化导致快照与问题现场不一致。

7.4 官方文档与进阶技巧导读

内容 链接或入口
官网与集成 lookin.work集成指南CocoaPods手动集成 Run Script
LookinServer 仓库 GitHub QMUI/LookinServer(iOS 端)
Lookin Mac 应用 GitHub hughkli/Lookin
演示项目 官网提供的 QMUI-Demo 等,可快速体验
进阶 官方与社区文档:在 Lookin 中展示自定义信息、展示更多成员变量、Swift 优化等(见 LookinServer README 中的飞书/字节文档链接)[2]

7.5 安全与版本规范

  • 仅 Debug 集成:通过 :configurations => ['Debug'] 或 SPM/手动时的配置条件,确保 Release/App Store 包不包含 LookinServer [2][6]。
  • 版本:使用 1.0.6 及以上 版本,避免旧版严重 Bug 导致线上风险 [2][6]。
  • 自定义 xcconfig:若存在多种 Debug 配置,务必在 Pod 的 configurations 中全部列出,防止误打到非 Debug 包 [4][7]。

八、伪代码与算法说明

8.1 视图树遍历与属性收集(概念)

函数 collect_view_hierarchy(root, options):
  nodes = []
  函数 visit(view, depth):
    若 options.include_hidden 为假 且 view.hidden 为真: 返回
    若 depth > options.max_depth: 返回
    node = 新建节点()
    node.view_class = view.class
    node.frame = view.frame
    node.bounds = view.bounds
    node.alpha = view.alpha
    node.hidden = view.hidden
    node.backgroundColor = view.backgroundColor
    // 通过 Runtime 读取更多属性、约束等
    node.children = []
    for subview in view.subviews:
      child = visit(subview, depth + 1)
      if child: node.children.append(child)
    nodes.append(node)
    return node
  visit(root, 0)
   return 根节点

8.2 序列化与连接(概念)

函数 send_to_mac(tree):
  将 tree 编码为可传输格式(如二进制或 JSON)
  通过已建立的连接(如 socket / 本地通信)发送到 Lookin Mac 端
  Mac 端反序列化后重建树结构,渲染 2D 树与 3D 视图

8.3 属性修改回写(概念)

函数 apply_edit(view_id, property_key, value):
  LookinServer 在 App 主线程根据 view_id 找到对应 UIView 实例
  根据 property_key 调用对应 setter,例如 setFrame: / setBackgroundColor:
  视图更新后,可选地再次同步当前状态到 Mac

九、与其它 UI 调试工具的对比

维度 Lookin Xcode UI Inspector Reveal
费用 免费、开源 随 Xcode 免费 商业收费
集成方式 需集成 LookinServer(Debug) 无需集成,Debug 运行即可 需集成 Reveal SDK 或 Reveal Loader
视图范围 可超出一屏、含 hidden、可折叠 以当前层级为主 完整层级、多窗口
2D/3D 2D 树 + 3D 视图 + Export 以层级与属性为主 2D/3D、时间线等
属性修改 支持实时回写 支持部分修改 支持
控制台/方法监听 支持控制台与方法监听 依赖 LLDB/控制台 部分版本支持
无 Mac 使用 支持 App 内摇一摇等 不适用 依赖 Reveal App

Lookin 适合需要免费、开源、可定制视图范围与 2D/3D/Export 能力的团队;Xcode UI Inspector 适合快速随 Debug 使用;Reveal 适合对商业支持与高级功能有需求的场景。


参考文献

[1] Lookin 官网. Lookin - Free macOS app for iOS view debugging. lookin.work/
[2] QMUI. LookinServer. GitHub. github.com/QMUI/Lookin…
[3] hughkli. Lookin (macOS app). GitHub. github.com/hughkli/Loo…
[4] 腾讯云开发者社区 / IM Geek / GitCode 等. Lookin 原理与集成(Runtime、序列化、双端通信、CocoaPods/SPM/手动集成).
[5] 简书. 使用 Lookin 调试 iOS App UI. www.jianshu.com/p/ec5c7e0e7…
[6] LookinServer 官方. 不要使用早于 1.0.6 的版本;不要在 Release 集成. GitHub README 与 Feishu 说明.
[7] GitCode 博客. LookinServer 集成:自定义 xcconfig 配置时的注意事项.
[8] Apple. UI Inspector. Xcode 文档.
[9] Reveal. Reveal - iOS UI Debugger. revealapp.com/

05-Debug调试@调试器-Chisel LLDB调试工具:从原理到实践

📋 目录


一、概述与历史演进

1.1 工具简介

ChiselFacebook(Meta) 开源的 LLDB 命令集合,用于辅助调试 iOS 与 macOS 应用。它通过 Python 脚本 调用 LLDB 的 Scripting Bridge API(SB API) 扩展调试器能力,在不修改 Xcode 或 LLDB 本体的前提下,为开发者提供大量高层调试命令——如递归打印视图/控制器层级、在 Mac 上可视化 UIImage/UIView、按类名查找视图、对方法设置符号断点、查看响应链与约束等 [1][2][3]。

与仅使用 LLDB 内置的 pobtframe variable 等相比,Chisel 的命令更贴近 UIKit/AppKit 与日常 UI 调试场景,可显著减少手写表达式与重复操作。Chisel 与 Derek Selander 的 LLDB 扩展项目齐名,被广泛视为 iOS 开发者的标配调试增强工具 [1][3]。

仓库GitHub - facebook/chisel许可证:MIT。

1.2 历史与版本脉络

时期/事件 说明
Facebook 开源 Chisel 由 Facebook 工程师开发并开源,作为内部 iOS 调试的增强工具集 [1][2]
LLDB 与 Python 依赖 LLDB 的 Python 脚本SB API:通过 command script import 加载 fbchisellldb.py,在调试会话中注册自定义命令 [1][2]
Homebrew 分发 支持 brew install chisel 安装,安装后需在 ~/.lldbinit 中配置 command script import 路径 [1][2]
架构差异 Intel Mac:常见路径为 /usr/local/opt/chisel/libexec/fbchisellldb.pyApple Silicon (M1+):为 /opt/homebrew/opt/chisel/libexec/fbchisellldb.py [2]
objc.io 推荐 Chisel 官方 README 推荐阅读 Ari Grant 的 Dancing in the Debugger — A Waltz with LLDB(objc.io 第 19 期),以理解 LLDB 与 Chisel 的配合 [2]

1.3 典型应用场景

  • 视图/控制器层级排查:断点暂停后使用 pviewspvc 快速查看 keyWindow 的视图树与 ViewController 栈,定位层级或 present 关系问题。
  • 视图定位与可视化:用 fv/fvc 按类名或正则查找视图/控制器并将地址拷到剪贴板;用 visualize 将 UIImage/UIView/CALayer 等在 Mac 的 Preview 中打开,便于检查图片或布局。
  • 临时显示/隐藏与边框show/hideborder/unbordermask/unmaskflicker 在不继续执行的情况下修改视图可见性或描边,辅助确认视图位置与遮挡关系。
  • 断点与监视bmessage 对类或其子类上的方法设置符号断点(无需关心具体实现类);wivar 对实例变量设置 watchpoint,便于追踪成员变化。
  • 响应链、约束与数据presponder 打印响应链;paltracealamborder 等辅助 Auto Layout 调试;pcurlpjsonpdata 等方便网络与数据调试。

二、核心原理与架构

2.1 LLDB 与 Python 脚本扩展

LLDB(Low Level Debugger)是 Apple 在 Xcode 中采用的底层调试器,支持 C、C++、Objective-C、Swift 等。除内置命令外,LLDB 提供 Python 脚本接口:在调试会话中可通过 command script import <path> 加载 Python 模块,该模块可调用 LLDB Python API(SB API) 访问调试目标(进程、线程、帧、变量、表达式求值等),并调用 debugger.HandleCommand()SBCommandInterpreter 注册自定义命令 [2][4][5]。

Chisel 的入口脚本为 fbchisellldb.py:被 import 后,会加载 commands/ 目录下各 Python 模块,每个模块通过 FBCommand 基类(或等价接口)定义命令的 namedescriptionrun 以及可选的参数/选项;最终这些命令被注册到当前 LLDB 的 command interpreter,在 (lldb) 提示符下可直接输入使用 [1][2]。

2.2 Chisel 的代码结构(概念)

  • fbchisellldb.py:入口,负责加载各子模块并注册命令。
  • fbchisellldbbase.py 等:基类与公共逻辑(如 FBCommand、参数解析、raw-input 等)。
  • commands/:按功能拆分的命令实现,例如:
    • FBPrintCommands.py:pviews、pvc、pclass、pmethods、presponder、pcurl、pjson 等打印类命令。
    • FBDisplayCommands.py:border、unborder、show、hide、mask、unmask、caflush、dismiss、present 等显示与视图操作。
    • FBFindCommands.py:fv、fvc、taplog、vs 等查找与交互。
    • FBDebugCommands.py:bmessage、binside、wivar、mwarning 等断点与监视。
    • FBVisualizationCommands.py:visualize。
    • FBAutoLayoutCommands.py:paltrace、alamborder、alamunborder。
    • 以及 Accessibility、Component、Invocation、TextInput 等 [1][2]。

命令实现中通过 LLDB SB API 获取当前 target、frame、变量,并执行表达式(如 [UIApplication sharedApplication]keyWindowsubviews)以遍历视图层级或修改属性;部分命令会将数据(如图像)通过 LLDB 传回 Mac 并在本地用 Preview 等打开 [2][4]。

2.3 数据流与执行位置

Chisel 的命令在 开发机(Mac) 上的 LLDB 进程中执行,但 表达式求值 发生在 被调试进程(iOS 模拟器或真机上的 App)中。例如 pviews 会在目标进程中执行获取 keyWindow 与递归 description 的代码,结果回传到 LLDB 并打印到控制台;visualize 则会把目标进程中的 UIImage 等数据提取出来,在 Mac 上写入临时文件并用 Preview 打开 [2][4]。

flowchart LR
    subgraph Mac
        X[Xcode / LLDB]
        C[Chisel Python]
        P[Preview / 剪贴板]
    end
    subgraph 目标进程
        A[iOS/macOS App]
    end
    X --> C
    C -->|SB API 求值| A
    A -->|返回值/数据| C
    C --> X
    C --> P

三、获取与安装

3.1 前置条件

项目 说明
Mac 运行 macOS,已安装 Xcode 及命令行工具
LLDB 随 Xcode 提供;Chisel 在调试会话中通过 command script import 加载
Python LLDB 内置 Python 绑定,无需单独安装 Python;Homebrew 安装的 Chisel 会使用系统或 LLDB 自带 Python

3.2 通过 Homebrew 安装(推荐 [2])

brew update
brew install chisel

安装后,Chisel 的脚本通常位于:

  • Intel Mac/usr/local/opt/chisel/libexec/fbchisellldb.py
  • Apple Silicon (M1+)/opt/homebrew/opt/chisel/libexec/fbchisellldb.py

3.3 配置 ~/.lldbinit

~/.lldbinit 不存在,可创建并编辑:

touch ~/.lldbinit
open ~/.lldbinit

~/.lldbinit 中增加一行(路径按实际架构二选一):

# Intel Mac
command script import /usr/local/opt/chisel/libexec/fbchisellldb.py

# Apple Silicon (M1+)
# command script import /opt/homebrew/opt/chisel/libexec/fbchisellldb.py

保存后,下次启动 Xcode 并进入调试会话 时,Chisel 命令会自动加载。若已打开 Xcode,可先在 LLDB 中执行 command source ~/.lldbinit 重新加载 [2]。

3.4 从源码安装

facebook/chisel 克隆或下载后,在 ~/.lldbinit 中写:

command script import /path/to/chisel/fbchisellldb.py

/path/to/chisel 替换为本地 Chisel 仓库路径 [2]。

3.5 验证安装

在 Xcode 中运行任意 iOS/macOS 工程,断点命中后,在 LLDB 控制台输入:

(lldb) help

在输出末尾的「user-defined commands」中应能看到 Chisel 提供的命令(如 pviewspvcfvborder 等)。也可直接执行:

(lldb) pviews

若输出了当前 keyWindow 的视图层级,则安装与配置正确 [2]。


四、命令体系与使用流程

4.1 命令分类概览

类别 代表命令 用途
视图/控制器层级 pviews、pvc 递归打印 keyWindow 的 view / view controller 描述
查找 fv、fvc、fa11y、vs 按类名/正则/无障碍标签查找视图或控制器,或交互式搜索
可视化 visualize 在 Mac Preview 中打开 UIImage、UIView、CALayer 等
显示/边框/遮罩 show、hide、border、unborder、mask、unmask、flicker 临时显示/隐藏视图、加边框、加遮罩、闪烁
渲染 caflush、slowanim、unslowanim 刷新 Core Animation、慢速动画
断点与监视 bmessage、binside、wivar 方法符号断点、库内偏移断点、实例变量 watchpoint
打印 presponder、pclass、pmethods、pproperties、pcurl、pjson、pdata、pblock、pinvocation、pivar 等 响应链、继承关系、方法列表、属性、curl、JSON、NSData、Block、调用信息、实例变量
Auto Layout paltrace、alamborder、alamunborder 约束追踪、歧义约束边框
ViewController present、dismiss present / dismiss 指定 VC
其它 mwarning、setinput、settext、taplog、pcomponents、dcomponents、rcomponents 等 模拟内存警告、输入文本、点击日志、Component 相关

完整列表可在 LLDB 中执行 help 查看,或参阅 Chisel Wiki [1][2]。

4.2 基本使用流程

  1. 在 Xcode 中为 iOS 或 macOS 项目设置断点(或运行后点击暂停)。
  2. 断点命中或暂停后,在 LLDB 控制台 输入 Chisel 命令;多数命令支持 raw-input(即命令后可直接写表达式,如 fv UITableViewborder 0x12345678);可执行 help raw-input 查看说明。
  3. 查看输出或效果(控制台打印、剪贴板、Preview 窗口等);若需修改命令行为,可查阅 help <command>
  4. 继续执行(如 continue)或单步调试,结合其它 LLDB 命令(pobtframe variable)完成排查。

五、常用命令详解与 SOP

5.1 视图与控制器层级

命令 语法与说明 典型用法
pviews pviews [--up] [--depth=depth] [view] 无参数时递归打印 keyWindow 的视图层级;--up 只打印从指定 view 到 window 的上层;--depth 限制深度;传入 view 则从该 view 开始 [2][6]
pvc pvc [viewController] 递归打印 keyWindow 的 ViewController 层级(含 present 关系);iOS 常用,macOS 不支持 [2][6]

SOP:布局或层级异常时,先 pviews 看整棵树,再用 fv <ClassName> 找到目标 view 地址,用 border <addr>mask <addr> 在界面上标出位置;若关心 VC 栈则用 pvc

5.2 查找与可视化

命令 语法与说明 典型用法
fv fv <classNameRegex> 在 keyWindow 的视图树中按类名正则查找,第一个匹配的 view 地址会写入剪贴板;后续可用 border (id)[剪贴板] 或直接 border <addr> [2][6]
fvc fvc [--name=classNameRegex] [--view=view] 按 ViewController 类名正则查找,或将拥有某 view 的 VC 打印出来 [2][6]
visualize visualize <expr> UIImage、CGImageRef、UIView、CALayer、NSData(图像)、UIColor、CIColor、CIImage、CGColorRef、CVPixelBuffer 等在 Preview.app 中打开;expr 为对象表达式 [2][6]

SOP:需要确认某视图是否在层级中或位置时:fv MyCustomView → 粘贴地址 → border (id)0x...visualize (UIView *)0x...

5.3 显示、边框与遮罩

命令 语法与说明 典型用法
show / hide show <view/layer>hide <view/layer> 不继续执行即可在设备/模拟器上显示或隐藏该 view/layer,便于确认是谁在遮挡 [2][6]
border / unborder border [--color=] [--width=] [--depth=] <view/layer> 给 view/layer 画边框;color、width、depth 可选;unborder 移除 [2][6]
mask / unmask mask [--color=] [--alpha=] <view/layer> 在 view/layer 上叠加半透明矩形,标出范围;unmask 移除 [2][6]
flicker flicker <view> 快速显示再隐藏一次,用于快速定位视图位置 [2][6]

5.4 断点与监视

命令 语法与说明 典型用法
bmessage bmessage "<expr>" 类或其子类上对方法设符号断点;expr 如 -[MyView setFrame:]+[MyClass sharedInstance]-[0xabcd1234 setFrame:];Chisel 会沿继承链找到实际实现该 selector 的类并设条件断点 [2][6]
wivar wivar <object> <ivarName> 对对象的实例变量watchpoint,该 ivar 被写入时断下 [2][6]

5.5 响应链、约束与数据

命令 语法与说明 典型用法
presponder presponder [responder] 从指定 responder 起向上打印 响应链 [2][6]
paltrace paltrace [view] 打印 Auto Layout 的调试 trace,默认 keyWindow [2][6]
alamborder / alamunborder alamborder [--color=] [--width=]alamunborder 布局歧义的 view 加边框;需 raw-input [2][6]
pcurl pcurl [--embed-data] <NSURLRequest> NSURLRequest 转成 curl 命令,便于在终端重放 [2][6]
pjson pjson [--plain] <NSDictionary/NSArray> JSON 形式打印字典或数组 [2][6]

5.6 命令速查表

场景 推荐命令
看当前界面视图树 pviews
看 ViewController 栈 pvc
按类名找 view 并标出 fv <Regex> → border <addr>
在 Mac 上看图/看 view visualize <expr>
临时隐藏某 view hide <view>
给 view 加边框 border [选项] <view>
对某类方法下断点 bmessage "-[ClassName method:]"
监视某对象 ivar 变化 wivar <obj> <ivarName>
看响应链 presponder [responder]
看约束问题 paltrace;alamborder
把请求变 curl pcurl <request>

六、关键概念图示与流程

6.1 Chisel 在调试会话中的位置

flowchart TB
    subgraph 开发机
        X[Xcode]
        L[LLDB]
        I[~/.lldbinit]
        C[Chisel Python]
    end
    subgraph 目标
        A[iOS/macOS App 进程]
    end
    X --> L
    I -->|command script import| L
    L --> C
    C -->|SB API / 表达式求值| L
    L --> A
    A -->|结果/数据| L
    L --> C

6.2 典型调试流程(视图问题)

sequenceDiagram
    participant D as 开发者
    participant L as LLDB
    participant C as Chisel
    participant A as App

    D->>L: 断点命中 / 暂停
    D->>L: pviews
    L->>C: 执行 pviews
    C->>A: 求值 keyWindow / 递归 description
    A->>C: 返回字符串
    C->>L: 输出到控制台
    D->>L: fv MyView
    C->>A: 查找并取地址
    C->>D: 地址拷到剪贴板
    D->>L: border (id)0x...
    C->>A: 设置 layer border
    A->>D: 界面显示边框

七、自定义命令与开发工作流

7.1 自定义命令接口(概念 [2])

Chisel 支持在本地添加自定义命令,供个人或团队使用。基本方式:

  1. 编写一个 Python 文件,定义继承自 fbchisellldbbase.FBCommand 的类,实现:
    • name(self):命令名
    • description(self):简短描述
    • run(self, arguments, options):命令逻辑;内部可调用 lldb.debugger.HandleCommand() 执行 LLDB 命令,或使用 SB API 获取 frame、变量、求值表达式等。
  2. ~/.lldbinit 中先 command script import Chisel 的 fbchisellldb.py,再调用 loadCommandsInDirectory 加载自定义命令所在目录 [2]。

示例(来自 Chisel README):打印 keyWindow 的 windowLevel:

#!/usr/bin/python
# 示例:自定义命令
import lldb
import fbchisellldbbase as fb

def lldbcommands():
    return [ PrintKeyWindowLevel() ]

class PrintKeyWindowLevel(fb.FBCommand):
    def name(self):
        return 'pkeywinlevel'
    def description(self):
        return 'Print the window level of the key window.'
    def run(self, arguments, options):
        lldb.debugger.HandleCommand('p (CGFloat)[(id)[(id)[UIApplication sharedApplication] keyWindow] windowLevel]')

更多参数与选项可参考 Chisel 内置命令(如 borderpinvocation)的实现;官方 README 的 Custom CommandsContributing 提供了贡献与扩展说明 [2]。

7.2 开发工作流(调试 Chisel 命令本身 [2])

  1. 写好命令脚本并放到某目录。
  2. ~/.lldbinit 中配置 loadCommandsInDirectory 加载该目录。
  3. 启动 LLDB(或 Xcode 调试),断点命中后执行 command source ~/.lldbinit 重新加载。
  4. 运行正在开发的命令,观察行为。
  5. 修改命令代码后,可使用 script reload(modulename) 重载模块,无需重启 Xcode,再重复 4–5 直至满意。

八、伪代码与算法说明

8.1 pviews 类命令的递归描述(概念)

函数 print_view_hierarchy(view, depth, max_depth):
  若 max_depth 已设定且 depth >= max_depth: 返回
  缩进 = 根据 depth 生成
  输出 缩进 + view 的 description(类名、frame 等)
  for subview in view.subviews:
    print_view_hierarchy(subview, depth + 1, max_depth)

实际实现中,Chisel 通过 LLDB 在目标进程中执行 Objective-C 表达式获取 keyWindowrootViewController.viewsubviews 等,并在本地拼接输出 [2][4]。

8.2 fv 查找视图(概念)

函数 find_view_matching(regex):
  window = 求值 "[UIApplication sharedApplication].keyWindow"
  results = 在 window 的子树中递归查找 view.class 与 regex 匹配的 view
  若 results 非空:
    将 results[0] 的地址写入剪贴板
    返回 results[0]
  否则 返回 nil

8.3 bmessage 符号断点(概念)

函数 bmessage(expr):
  # expr 如 "-[MyView setFrame:]"
  解析出 class(或 instance)与 selector
  遍历 class 及其子类(或 instance 的类及其子类),查找实际实现该 selector 的类
  在该类的实现上设置断点(或条件断点,使仅当 receiver 匹配时断下)

这样无需关心 setFrame: 是在 MyView 还是其子类中实现,都能在调用时断下 [2][6]。


九、应用场景与最佳实践

9.1 UI 层级与布局

  • 先用 pviewspvc 把握整体结构;再用 fv + bordermask 在界面上标出目标 view,确认 frame 与遮挡关系。
  • Auto Layout 异常时用 paltrace 看约束冲突/歧义;用 alamborder 在歧义 view 上画边框便于对照。

9.2 图片与渲染

  • visualize 将 UIImage、CALayer、UIView 等导出到 Preview,检查内容与尺寸;配合 pviews 找到持有该 image 的 view。
  • 若界面未刷新,可尝试 caflush 强制 Core Animation 刷新。

9.3 断点与数据

  • 对「谁调用了某方法」不清晰时,用 bmessage 在该方法上设断点,运行到断点后看 btpinvocation(x86)等。
  • 对 NSURLRequest 用 pcurl 转为 curl 在终端重放;对 NSDictionary/NSArray 用 pjson 查看结构。

9.4 官方文档与资源导读

资源 链接 说明
Chisel 仓库 GitHub facebook/chisel 源码、README、CONTRIBUTING、安装与自定义命令
命令列表 Chisel Wiki 各命令的 Syntax、Arguments、Options 与实现文件
LLDB 与 Chisel 综述 Dancing in the Debugger — A Waltz with LLDB(objc.io #19) Ari Grant 撰文,理解 LLDB 与 Chisel 的配合 [2][7]
LLDB Python API LLDB Python API SB API、自定义命令接口
LLDB 自定义命令教程 Writing Custom Commands 官方扩展 LLDB 的教程

9.5 注意事项

  • Chisel 命令依赖当前暂停的 target 与 frame;若未暂停或 target 不对,部分命令会失败。
  • raw-input:多数命令的最后一个参数可直接写表达式(如 view 地址或类名),无需用引号包裹整条表达式;详见各命令 help
  • 真机调试时,visualize 等需要将数据从设备传回 Mac,大图或复杂层级可能略慢。

十、与其它调试工具的对比

维度 Chisel 纯 LLDB (po/bt/expr) Lookin / Reveal
形态 LLDB 命令集合(Python) 调试器内置命令与表达式 独立 Mac 应用 + App 内/网络
集成 配置 ~/.lldbinit 即可,无需改工程 Lookin 需集成 LookinServer;Reveal 需 SDK 或 Loader
视图层级 pviews/pvc 文本输出;fv + border 等辅助 需手写 po 与递归表达式 图形化 2D/3D 树与属性面板
可视化 visualize 在 Preview 中看图/view 在 Lookin/Reveal 内直接看
断点/监视 bmessage、wivar 等 breakpoint set、watchpoint 等需手写 不提供
适用场景 断点调试时快速查层级、改显示、下断点、看数据 通用底层调试 专注 UI 结构审查与属性修改

Chisel 与 LLDB 内置能力互补:在保持「断点 + 控制台」工作流的前提下,用少量命令完成视图、VC、约束、请求等常见调试任务;与 Lookin/Reveal 相比,无需改工程、无需额外进程,但视图展示为文本与简单边框/遮罩,而非完整图形化树 [1][2][3]。


参考文献

[1] 掘金等. LLDB 命令库 Chisel 介绍(Facebook、Python、SB API、与 Derek Selander 对比).
[2] Facebook. Chisel. GitHub. github.com/facebook/ch…
[3] 西门桃桃. LLDB;LearnLLDB 等. Chisel 命令用法总结.
[4] LLDB. Python APIWriting Custom CommandsImplementing Standalone Scripts. lldb.llvm.org/python_api.…lldb.llvm.org/use/tutoria…
[5] LLDB. Scripting Bridge API. lldb.llvm.org/resources/s…
[6] Facebook. Chisel Wiki (Commands). github.com/facebook/ch…
[7] objc.io. Dancing in the Debugger — A Waltz with LLDB (Ari Grant). Issue 19. www.objc.io/issue-19/ll…

02-Debug调试@网络-Wireshark网络抓包工具:从原理到实践

Wireshark 网络抓包工具:从原理到实践

📋 目录


一、概述与历史演进

1.1 工具简介

Wireshark 是一款开源的网络协议分析器(Network Protocol Analyzer),支持实时抓包(Live Capture)离线分析(Offline Analysis),可对数百种协议进行深度解析(Deep Inspection),运行于 Windows、Linux、macOS 等平台,被业界与教育机构广泛用于网络排障、安全分析、协议学习与性能调优 [1][2]。

与 Charles、Fiddler 等应用层代理不同,Wireshark 工作在网卡/驱动层,可捕获本机及经本机转发的原始报文(含二层以太网帧、IP、TCP/UDP 及各类应用层协议),不依赖应用配置代理,适用于全栈协议分析与非 HTTP(S) 流量 [3]。

1.2 历史与版本脉络

时期 事件
1997 年底 Gerald Combs 为解决工作中的网络问题并学习网络知识,开始编写 Ethereal(Wireshark 前身)[1][4]
1998 年 7 月 Ethereal 0.2.0 首次发布;Gilbert Ramirez、Guy Harris、Richard Sharpe 等贡献底层解析器与协议支持 [4]
2006 年 项目迁移基础设施并更名为 Wireshark [1][4]
2008 年 Wireshark 1.0 发布,标志着「最低可用功能」完成;首届 SharkFest 开发者与用户大会举办 [4]
2015 年 Wireshark 2.0 发布,采用全新 UI [4]
2023 年 项目由 Wireshark Foundation(美国 501(c)(3) 非营利组织)接管,负责基础设施、SharkFest 与网络教育推广 [4]

社区贡献模式以「所需协议驱动」为主:开发者复制现有解析器、实现新协议后回馈上游,使 Wireshark 支持的协议数量持续增长(如 4.x 版本已支持数千种协议、数十万字段)[1][2][5]。

1.3 典型应用场景

  • 网络排障:定位连接超时、丢包、重传、RST、DNS 解析失败等,结合协议栈与时间轴分析根因。
  • 协议学习与逆向:查看真实报文结构、字段含义、状态机行为(如 TCP 握手/挥手、TLS 握手)。
  • 安全与取证:检测异常流量、分析攻击载荷、配合 TLS 密钥日志解密 HTTPS 以审计内容(需合规授权)。
  • 性能分析:统计往返时延、重传率、吞吐量,配合 IO 图形化与专家信息系统(Expert Info)。
  • 嵌入式与物联网:抓取串口/蓝牙/BLE 等经适配器转换后的报文,或配合远程抓包(SSH、rpcapd)分析设备侧流量。

二、核心原理与架构

2.1 抓包在 OS 中的位置

抓包需要网卡驱动或内核模块将流经网卡的报文复制一份交给用户态。在 Unix/Linux/macOS 上,Wireshark 使用 libpcap:应用通过 libpcap 打开设备或文件,由 libpcap 与内核交互(如 Linux 的 PF_PACKET、BPF 过滤器),把满足条件的报文拷贝到用户空间 [6][7]。在 Windows 上,早期依赖 WinPcap(基于 libpcap 1.0.0,支持至 Windows 8,已停止维护);现代 Wireshark(3.0+)默认使用 Npcap:由 Nmap 项目维护,采用 NDIS 6 Light-Weight Filter 驱动,支持环回(loopback)抓包、原始 802.11、x86/x64/ARM,并随 Wireshark 安装包分发;相比 WinPcap 性能与安全性更优 [6][8]。

flowchart TB
    subgraph 用户态
        W[Wireshark / tshark]
        L[libpcap / Npcap]
    end
    subgraph 内核
        K[内核网络栈 / NDIS]
        D[抓包驱动]
    end
    subgraph 硬件
        N[网卡]
    end
    N --> K
    K --> D
    D --> L
    L --> W

2.2 抓包过滤器与显示过滤器的分工

  • 抓包过滤器(Capture Filter):在抓包前由驱动/内核或 libpcap 应用,只将符合条件的报文写入捕获文件或交给 Wireshark,未匹配的报文直接丢弃。语法为 Berkeley Packet Filter (BPF),与 tcpdump、WinDump 等一致;抓包过程中不可更改 [5][9]。
  • 显示过滤器(Display Filter):在已抓取的报文上做二次过滤,仅影响界面展示与统计,不改变捕获文件内容;可随时修改,基于 Wireshark 自有的字段与协议树 [5][10]。

因此:抓包过滤器用于减负与聚焦(如只抓某主机或某端口),在抓包前设置且抓包过程中不可修改,可减少落盘与内存占用;显示过滤器用于分析时的精筛(如只看 HTTP 请求、某状态码、某字段值),不改变捕获文件内容,仅隐藏包列表中的报文,可随时修改。二者语法不同:例如「某主机 Telnet」抓包过滤写 tcp port 23 and host 10.0.0.5,显示过滤写 tcp.port == 23 and ip.addr == 10.0.0.5 [9][17][18]。

2.3 协议解析(Dissection)与协议树

每个报文进入 Wireshark 后,由解析器(Dissector)按协议栈逐层解析:先由 Frame 解析器处理捕获元数据(时间戳、长度等),再依次调用数据链路层(如 Ethernet)、网络层(IP/ARP)、传输层(TCP/UDP)、应用层(HTTP、TLS、DNS 等)解析器,形成协议树。解析器可内置或通过插件加载;支持协议与字段的完整列表可通过「View → Internals → Supported Protocols」查看,显示过滤器可基于任意已注册字段 [5][11]。


三、抓包过滤器(Capture Filter)与 BPF

3.1 BPF 语法概述(官方语法 [9][12])

抓包过滤器采用 libpcap 过滤器语言(即 BPF),与 tcpdump、WinDump 等使用同一语法。形式为若干原语(primitive) 通过 and / or 连接,并可加 not

[not] primitive [and|or [not] primitive ...]

原语限定符(qualifier) + ID 组成。根据 pcap-filter man pageWireshark User's Guide §4.10,常见原语包括:

原语 含义 示例
[src|dst] host 按主机 IP 或主机名过滤 host 10.0.0.5src host 192.168.1.1;不写 src/dst 时表示源或目的任一匹配即可
ether [src|dst] host 按以太网(MAC)地址过滤 ether host aa:bb:cc:dd:ee:ff
gateway host 以 host 为网关的报文(以太网源/目的为 host,但 IP 源/目的不是 host) gateway 192.168.1.1
[src|dst] net [mask|len] 按网络号过滤,可写掩码或 CIDR 长度 net 192.168.0.0/24net 192.168.0.0 mask 255.255.255.0
[tcp|udp] [src|dst] port 按 TCP/UDP 端口过滤;tcp/udp 须在 src/dst 前 tcp port 80udp dst port 53
portrange 端口范围(libpcap 0.9.1+) tcp portrange 1501-1549
less | greater length 按报文长度 ≤ 或 ≥ 某值 greater 128less 64
ip | ether proto 按 IP 或以太网层协议类型过滤 ip proto 6(TCP)、ether proto 0x888e(EAPOL)
ether | ip broadcast | multicast 广播或组播 not broadcast and not multicast
relop 按字节或字节范围选择(复杂表达式) 见 pcap-filter man page

注意:抓包过滤器不是显示过滤器;前者在抓包前应用、语法更受限,后者在已抓包上过滤、可随时修改 [17]。

3.2 常用抓包过滤器示例(官方与 Wiki [9][12][17])

host 172.18.5.4                    # 与某 IP 双向流量
src host 192.168.1.1 / dst host 192.168.1.1   # 仅源或仅目的
net 192.168.0.0/24                 # 某网段;或 net 192.168.0.0 mask 255.255.255.0
src net 192.168.0.0/24             # 源网段
tcp port 23 and host 10.0.0.5      # 发往/来自 10.0.0.5 的 Telnet
tcp port 23 and not src host 10.0.0.5  # Telnet 且源非 10.0.0.5
port 53                            # DNS(TCP+UDP)
port not 53 and not arp             # 排除 DNS 与 ARP
tcp portrange 1501-1549             # TCP 端口区间
ether host aa:bb:cc:dd:ee:ff        # 以太网地址
ether proto 0x888e                  # 仅 EAPOL
ip                                # 仅 IPv4,可排除 ARP/STP 等
not broadcast and not multicast     # 仅单播
host www.example.com and not (port 80 or port 25)  # 排除 HTTP/SMTP
dst host ff02::1                   # IPv6 全节点组播(如 RA)

完整语法见 pcap-filter man pageWireshark Wiki CaptureFilters [9][12][17]。

3.3 抓包前设置与 Capture Options 界面(官方 [9])

  • 入口:菜单 Capture → Options…(或主工具栏对应项),打开 「Capture Options」 对话框 [19]。
  • 抓包过滤器输入位置:在 Input 标签页中,Interface 表格里每块网卡有一列 Capture Filter;可双击该列编辑该接口的 BPF;也可在表格上方「Capture filter for selected interfaces」为多块接口统一设置。设置完成后点击 Start 开始抓包。
  • Input 标签页:除 Capture Filter 外,还可配置每块接口的 Promiscuous(混杂模式)、Snaplen(每包捕获字节数)、Buffer(内核缓冲区大小)、Link-layer header type(链路层类型)、Monitor mode(无线 802.11 原始头,可能断网)等;悬停或展开接口可看到其 IPv4/IPv6 地址。
  • Output 标签页:可设置 Capture to a permanent file(保存路径、pcapng 默认格式)、Create a new file automatically(按时间/时长/大小/包数切换文件)、Ring buffer(多文件循环)。
  • Options 标签页Update list of packets in real-time(实时更新包列表)、Automatically scroll during live capture(自动滚动)、Name Resolution(解析 MAC/网络/传输层名称)、Stop capture automatically after…(按时长/大小/包数自动停止)。
  • Compile Selected BPFs:可查看当前 BPF 编译后的字节码,便于理解与排错。
  • 自动排除远程会话流量:当 Wireshark 在远程环境运行(如 SSH、X11、终端服务器)时,会检测环境变量并自动生成一条抓包过滤器以排除远程连接流量,减少无关包。检测变量包括:SSH_CONNECTIONSSH_CLIENTREMOTEHOSTDISPLAY(X11)、SESSIONNAME(终端服务器);Windows 下会检测是否在 Remote Desktop Services 环境 [9][17]。

Linux 提示:开启 BPF JIT 可加速过滤:echo 1 >/proc/sys/net/core/bpf_jit_enable(需 root);持久化可借助 sysfsutils [9]。


四、显示过滤器(Display Filter)

显示过滤器用于在已抓取的报文上精确控制显示哪些包;与抓包过滤器不同,可随时修改且基于协议树字段。完整语法见 User's Guide §6.4;协议与字段列表见 View → Internals → Supported ProtocolsDisplay Filter Reference [10][18][20]。

4.1 按协议/字段过滤与比较运算符(官方 [10])

  • 最简单:在显示过滤器栏输入协议名(如 tcp)或字段名(如 http.request),只显示包含该协议或该字段的报文。
  • 比较运算符User's Guide Table 6.6):
英文/别名 C 风格 含义 示例
eq / any_eq == 相等(多值字段时任一匹配即成立) ip.src == 10.0.0.5
ne / all_ne != 不相等(多值字段时全部不匹配才成立;Wireshark 3.6+ 语义) ip.src != 10.0.0.5
all_eq === 相等(多值字段时全部匹配才成立) ip.src === 10.0.0.5
any_ne !== 不相等(多值字段时任一不匹配即成立) ip.src !== 10.0.0.5
gt / lt / ge / le > < >= <= 大于/小于/大于等于/小于等于 frame.len > 100frame.len le 0x100
contains 协议、字段或切片包含某值 sip.To contains "a1762"udp contains 81:60:03
matches ~ 协议或文本字段匹配 Perl 兼容正则 http.host matches "acme\\.(org|com|net)"

注意ip.addrtcp.port 等为多值字段(同时含源与目的);== 表示「任一匹配」,要排除某地址应写 !(ip.addr == 10.43.54.65) 而非 ip.addr != 10.43.54.65(后者语义为「至少一个不等于」,易误用)[18]。

示例:

ip.addr == 192.168.0.1
ip.src == 10.0.0.5 and tcp.flags.fin
frame.len > 100
http.request.uri contains "api"
http.host matches "acme\.(org|com|net)"
tcp.flags.syn == 1
tcp.flags & 0x02

4.2 字段类型(官方 [10])

类型 说明与示例
无符号/有符号整数 可 8/16/24/32/64 位;可写十进制、八进制(0)、十六进制(0x)、二进制(0b)。例:ip.len le 1500ip.len le 0x5dc
布尔 1 或 True、0 或 False。字段存在即参与过滤;要匹配 SYN 置位须写 tcp.flags.syn == 1
以太网地址 6 字节,分隔符可为 :.-。例:eth.dst == ff:ff:ff:ff:ff:ff
IPv4 ip.addr == 192.168.0.1;支持 CIDR:ip.addr == 129.111.0.0/16
IPv6 ipv6.addr == ::1,也可匹配子网
字符串 双引号;可用 \xhh\ddd 转义。例:http.request.uri == "https://www.wireshark.org/";原始字符串前缀 rR 使反斜杠按字面处理
日期时间 字符串格式,如 frame.time == "Sep 26, 2004 23:18:04.954975"frame.time < "2022-01-01";小数秒可选,无时区后缀

4.3 逻辑、集合与算术

  • 逻辑Table 6.7):and(&&)、or(||)、not(!)、xor(^^);子序列用 []
  • 集合(Membership)field in { 值1, 值2 } 或范围 field in {443, 4430..4434};等价于多个 == 的 or,但集合对单字段求值,避免多值字段歧义。例:tcp.port in {80, 443, 8080}http.request.method in {"HEAD", "GET"}ip.addr in {10.0.0.5..10.0.0.9, 192.168.1.1..192.168.1.9}
  • 算术+-(减号前需空格)、*/%&(按位与)。例:frame.cap_len < { 14 + ip.hdr_len + tcp.hdr_len } 可找被截断的 TCP 选项。

4.4 切片、层操作符与 @ 操作符(官方 [10])

  • 切片(Slice):在字段或协议名后加 [范围]。范围格式:n:m(从偏移 n 起长度 m)、n-m(从 n 到 m inclusive)、:m(从头到 m)、n:(从 n 到结尾)、单字节 [n];负偏移表示从末尾算起。例:eth.src[0:3] == 00:00:83frame[-4:](最后 4 字节)、frame[-4:4] == 0.1.2.3。字符串切片按 UTF-8 码点边界。
  • 层操作符 #:限定到协议栈某一层。例:ip.addr#2 == 192.168.30.40 只匹配第二层 IP(如隧道内层);tcp.port#[2-4] 表示第 2、3、4 层。
  • @ 操作符:用 @ 前缀表示按原始字节比较,不经过解码。例:@browser.comment == 73:74:72:69:6e:67:... 用于有解码错误时的精确匹配。

4.5 函数(官方 [10])

函数 说明 示例
upper / lower 字符串大小写转换 lower(http.server) contains "apache"
len 字符串或字节长度(字节数) len(http.request.uri) > 100
count 帧中某字段出现次数 count(ip.addr) > 2
string 将字段转为字符串(可与 matches 等配合) string(frame.number) matches "[13579]$"
vals 将字段转为「值字符串」(若有定义) 用于与枚举名比较
dec / hex 整数转十进制/十六进制字符串
float / double 转为浮点;double 可处理时间(自 epoch 秒)
max / min 参数中的最大/最小值 max(tcp.srcport, tcp.dstport) <= 1024
abs 绝对值

4.6 字段引用(Field References)

${proto.field} 表示当前选中报文中该字段的值,用于动态过滤。例:自当前包起前 5 分钟:frame.time_relative >= ${frame.time_relative} - 300;或 HTTP 且目的 IP 等于当前帧 DNS A 记录:http && ip.dst eq ${dns.a} [10]。

4.7 正则与多值字段注意点

  • matches 的字符串会先经 Wireshark 解析再交给 PCRE,转义可能需双重(如括号 \\();用原始字符串 r"..." 可减少问题 [10]。
  • 协议名歧义:如 fc 可能被解析为协议 Fibre Channel 或十六进制 0xFC;用 .fc 强制协议名、:fc 强制字节序列 [10]。
  • 协议更名:如 bootp → dhcp,旧名可能仍可用但会提示 deprecated;新写过滤器建议用新名 [10]。

五、关键概念图示与流程

5.1 从网卡到界面的数据流

flowchart LR
    subgraph 捕获
        A[网卡] --> B[驱动/Npcap]
        B --> C[BPF 抓包过滤]
        C --> D[捕获缓冲区/文件]
    end
    subgraph 解析与展示
        D --> E[Frame 解析器]
        E --> F[各层 Dissector]
        F --> G[协议树]
        G --> H[显示过滤器]
        H --> I[包列表/详情/字节]
    end

5.2 抓包过滤器 vs 显示过滤器

flowchart TD
    subgraph 抓包阶段
        P1[所有经过网卡的报文] --> CF{抓包过滤器 BPF}
        CF -->|匹配| P2[写入捕获]
        CF -->|不匹配| P3[丢弃]
    end
    subgraph 分析阶段
        P2 --> DF{显示过滤器}
        DF -->|匹配| Q1[列表中显示]
        DF -->|不匹配| Q2[隐藏,仍存在于文件]
    end

5.3 协议解析栈(概念)

flowchart TB
    F[Frame] --> E[Ethernet]
    E --> I[IP / ARP]
    I --> T[TCP / UDP / ICMP]
    T --> A[HTTP / TLS / DNS / ...]
    A --> B[应用数据]

六、应用场景与实战

6.1 HTTP/HTTPS 调试

  • HTTP:显示过滤 httphttp.requesthttp.response.code == 404;右键报文 → Follow → HTTP Stream 可查看完整请求/响应体 [13]。
  • HTTPS:默认仅能看到 TLS 握手与加密载荷。若需查看明文,需提供会话密钥:在浏览器或 curl 侧设置 SSLKEYLOGFILE 环境变量导出密钥日志,在 Wireshark 中 Edit → Preferences → Protocols → TLS → (Pre)-Master-Secret log filename 指向该文件,重新抓包或重放后即可解密(依赖 TLS 1.2 等支持密钥导出;PFS 场景下必须用密钥日志,仅私钥不足)[14][15]。

6.2 TLS 握手与证书问题

  • 过滤:tlsip.addr == 1.2.3.4 and tls,查看 Client Hello / Server Hello / Certificate / Alert 等。
  • 典型问题:版本或套件不匹配、证书链不完整、主机名不匹配、Alert 告警等,可在 Expert Info 与 TLS 解析树中定位 [14][16]。

6.3 连接与性能问题

  • TCP:过滤 tcp,关注 SYN/ACK/RST/FIN、重传、窗口;统计 → 往返时延、流图,辅助判断延迟与丢包。
  • DNS:过滤 dns,查看请求与响应、响应码与解析结果,排查解析失败或污染。

6.4 TLS 解密配置步骤(摘要)

  1. 导出密钥日志:在客户端(浏览器/curl)设置环境变量 SSLKEYLOGFILE 指向一可写文件;完成 TLS 会话后,该文件会包含 NSS 格式的会话密钥。
  2. Wireshark 配置:Edit → Preferences → Protocols → TLS → 在「(Pre)-Master-Secret log filename」中指定上述文件路径。
  3. 抓包或重放:重新建立 TLS 连接并抓包,或对已有 pcap 重新打开;若密钥匹配,应用层载荷会以明文显示在 TLS 解析树下。
  4. 限制:仅持有服务器私钥无法解密使用 ECDHE/DHE 的会话(PFS);必须依赖客户端导出的密钥日志 [14][15][16]。

6.5 企业与实践参考

  • Cisco 等厂商文档中常推荐使用 Wireshark 进行 TLS 与通用网络故障排查,并说明如何配合密钥日志解密 HTTPS [16]。
  • 实践中常采用「先抓包过滤缩小范围 + 再显示过滤精查 + Follow Stream / 统计 / 专家信息」的组合流程;大流量环境优先用 BPF 减少落盘与内存占用。

6.6 典型通讯场景抓包与数据包分析 SOP

以下针对 Socket TCP、Socket UDP、音视频直播、WebRTC P2P 等典型通讯场景,给出从抓包配置 → 显示过滤 → 关键字段解读 → 调试与排错的完整 SOP,便于按场景落地使用。


6.6.1 Socket TCP 抓包与分析 SOP

场景说明:基于 TCP 的 Socket 通讯(自定义协议、长连接、游戏/IM 等),需观察连接建立、数据传输、重传、挥手与 RST 等。

阶段 操作 说明
1. 抓包前配置 若已知对端 IP 或端口,在 Capture Options → Capture Filter 中设置 BPF,减少无关流量 例:host 192.168.1.100tcp port 9000tcp portrange 8000-8010;未知时可先不设过滤,抓包后用显示过滤器精查
2. 选择接口 选择实际收发流量的网卡(有线/无线/环回) 本机压测选 loopback;真机/远程选对应物理或虚拟接口
3. 开始抓包 启动抓包后,在客户端/服务端触发 TCP 连接与数据收发 建议在问题复现前开始抓,复现后尽快停止,便于定位时间窗口
4. 显示过滤 在显示过滤器栏输入表达式,精确定位目标流 常用:tcp.port == 9000ip.addr == 192.168.1.100tcp.stream eq 0(按流索引);组合示例:tcp and ip.addr == 192.168.1.100 and tcp.port == 9000
5. 定位单条连接 在包列表中选中该连接任意一包 → 右键 → Follow → TCP Stream 弹出窗口显示该连接重组后的双向数据(可看明文或十六进制);窗口内可切换「仅显示/仅请求/仅响应」与编码方式
6. 分析连接状态 查看 TCP 握手与挥手 握手:过滤 tcp.flags.syn == 1 and tcp.flags.ack == 0 找 SYN,再找对应 SYN+ACK、ACK;挥手:过滤 tcp.flags.fin == 1tcp.flags.rst == 1异常:大量 tcp.analysis.retransmissiontcp.analysis.fast_retransmission 表示重传,需结合 RTT 与丢包排查
7. 统计与 RTT Statistics → Flow GraphStatistics → Round-Trip Time Flow Graph 可看时序;RTT 可看往返时延分布;Statistics → Conversations → TCP 可看每条连接的字节数、包数,辅助判断是否有半开、僵死连接

关键字段与调试要点

  • tcp.flags:syn、ack、fin、rst、push 等;RST 表示连接被重置,需结合前后包分析是哪一端发起。
  • tcp.seq / tcp.ack:序列号与确认号,用于判断丢包、乱序与重传。
  • tcp.len: payload 长度;0 表示纯 ACK 或控制包。
  • tcp.window_size_value:接收窗口,过小可能限制吞吐。
  • Expert InfoAnalyze → Expert Information 可汇总重传、重复 ACK、零窗口等,便于快速定位问题。

常见问题排查

  • 连接超时/建连失败:过滤 SYN,看是否有 SYN 无 SYN+ACK(对端未响应或防火墙拦截),或 SYN+ACK 无 ACK(本机未回 ACK)。
  • 数据丢包/应用收不到:看是否有重传(tcp.analysis.retransmission)、对端 RST(tcp.flags.rst == 1)、或中间设备分片/MTU 问题(看 IP 分片与 ICMP 不可达)。
  • 连接被重置:过滤 tcp.flags.rst == 1,看 RST 来自哪一侧、在哪个 seq 之后,结合应用日志判断是服务端主动关闭、超时还是异常断开。

6.6.2 Socket UDP 抓包与分析 SOP

场景说明:基于 UDP 的 Socket 通讯(DNS、QUIC、游戏、音视频 RTP、自定义协议等),无连接状态,需按五元组或 payload 特征过滤。

阶段 操作 说明
1. 抓包前配置 若已知端口或主机,在 Capture Filter 中设置 BPF 例:udp port 53(DNS)、udp port 5000host 10.0.0.1 and udp;UDP 流量大时可加 udp 避免抓过多 TCP
2. 选择接口 同 TCP,选实际收发流量的接口 本机/容器/远程按需选择
3. 开始抓包 触发 UDP 收发后抓包 UDP 无握手,需在业务触发期间抓取
4. 显示过滤 按端口、IP、长度等过滤 常用:udp.port == 5000udp and ip.addr == 192.168.1.100udp.length > 100;若 Wireshark 解析了上层协议(如 DNS、RTP),可用 dnsrtp
5. 按流重组(若支持) 部分协议支持「Follow → UDP Stream」或按 RTP 重组 对裸 UDP 可右键 → Follow → UDP Stream 看该五元组下双向 payload;RTP 可用 Telephony → RTP → Stream Analysis
6. 分析 payload 查看 Packet Bytes 或解析后的应用层字段 UDP 无重传标识,需结合应用逻辑判断丢包;可统计同一目的端口包数/字节与时间间隔,判断发送频率与是否被丢弃

关键字段与调试要点

  • udp.srcport / udp.dstport:源/目的端口,区分服务与流。
  • udp.length:UDP 段总长度(含 8 字节头);大包需关注是否 IP 分片(ip.fragments)。
  • ip.addr:确认五元组,便于区分多路流。
  • 无连接状态:不能像 TCP 那样用「流」概念直接看握手;需通过时间序、端口、payload 模式关联请求与响应(若协议有请求/响应结构)。

常见问题排查

  • 收不到包:确认抓包接口正确、BPF 未过滤掉目标端口;对端是否真的发送(可在对端或中间设备抓包对比)。
  • 丢包:UDP 本身不保证可靠,Wireshark 只能看到「到达本机网卡」的包;若应用层发现丢包,可对比包序号(若协议带序号)或统计包数。
  • 分片:过滤 ip.fragmentsip.flags.mf,看是否有多片;分片丢失会导致重组失败,应用收不到完整报文。

6.6.3 音视频直播场景抓包与分析 SOP

场景说明:音视频直播涉及多种传输方式——基于 TCP 的 HTTP(HLS、HTTP-FLV、DASH 等)、基于 UDP 的 RTP/RTCP、RTSP 控制 + RTP 承载、以及 WebRTC(见 6.6.4)。此处覆盖 RTP/RTCP、RTSP 及 HTTP 直播拉流。

阶段 操作 说明
1. 抓包前配置 按协议类型选用 BPF,缩小范围 RTP/RTCPudp portrange 5000-6000 或已知端口;RTSPtcp port 554udp port 554HLS/HTTP-FLVtcp port 80 or tcp port 443,或先不过滤在显示层再筛
2. 开始抓包 在播放端开始拉流/播放的同时启动抓包 确保从「起播」或「卡顿/花屏发生前」开始,便于做时序与丢包分析
3. 显示过滤 按协议与端口过滤 RTPrtprtp.payload_type == 96(H.264 常见);RTCPrtcpRTSPrtspHLShttp.request.uri contains ".m3u8"http.request.uri contains ".ts"HTTP-FLVhttp.request.uri contains ".flv"
4. RTP 流分析 Telephony → RTP → RTP StreamsStatistics → Flow Graph RTP Streams 可列出所有 RTP 流,选中某流后可 Analyze;可看丢包数、抖动、 delta 等;Follow → RTP Stream 可看 payload 与解码尝试(若支持)
5. RTCP 分析 过滤 rtcp,查看 SR/RR、丢包率与抖动报告 RTCP 携带接收端统计(丢包、抖动),可与 RTP 侧对比,判断是网络丢包还是对端发送问题
6. RTSP 分析 过滤 rtsp,右键 Follow → TCP Stream(若 RTSP 走 TCP) 看 OPTIONS、DESCRIBE、SETUP、PLAY 等信令与 SDP;可确认媒体端口、编码格式与 URL
7. HTTP 直播(HLS/DASH/FLV) 过滤 http,按 URI 或 Host 筛 看 .m3u8/.mpd 请求与 200 响应、.ts/.m4s 分片请求顺序与状态码;Follow → HTTP Stream 看完整请求/响应;关注 4xx/5xx 与超时

关键字段与调试要点

  • RTPrtp.ssrcrtp.seqrtp.timestamprtp.payload_type;丢包会导致 seq 不连续或 RTCP 报告高丢包率。
  • RTCP:SR(Sender Report)含发送端 NTP/RTP 时间与包数/字节数;RR(Receiver Report)含丢包数、最高接收 seq、抖动。
  • RTSP:CSeq、Session、Transport(含端口与 RTP/RTCP 端口对)。
  • HTTP 直播:状态码、Content-Length、Range 请求;分片请求间隔与响应时间可辅助判断卡顿是否与拉流延迟有关。

常见问题排查

  • 花屏/卡顿:先看 RTP 或 HTTP 分片是否有丢包或重传;再看 RTCP RR 的丢包率与抖动;最后看应用层是否频繁重试或切换码率。
  • 无法起播:RTSP 检查 DESCRIBE/SETUP/PLAY 是否均 200、SDP 与 Transport 端口是否可用;HTTP 检查 m3u8/mpd 与首条分片是否 200、CDN 是否可达。
  • 延迟大:看 RTP 时间戳与接收时间差、HTTP 分片请求间隔;缓冲与 GOP 大小也会影响延迟,需结合播放器与服务器配置。

6.6.4 WebRTC P2P 场景抓包与分析 SOP

场景说明:WebRTC 包含 信令(多通过 HTTP/WebSocket)、媒体(SRTP/SRTCP over UDP)、以及 NAT 穿透用的 STUN/TURN。抓包可分析 ICE 候选、DTLS 握手、SRTP 流与信令交互;媒体内容为加密,解密需密钥(见下)。

阶段 操作 说明
1. 抓包前配置 建议先宽抓再显示过滤;若已知端口可收窄 常用 BPF:udp(STUN/RTP 多为 UDP)或 tcp port 443 or tcp port 80(信令);WebRTC 端口动态,常不事先过滤端口
2. 开始抓包 在浏览器或 App 中完成「加入房间/呼叫」至「建立音视频」全过程 从点击「开始」前即开始抓,便于捕获完整 ICE 与 DTLS
3. 显示过滤(信令) 信令多为 HTTPS/WSS httptls 过滤信令域名;若已配 SSLKEYLOGFILE 并解密 TLS,可看到 WebSocket 或 HTTP 上的 SDP/ICE 等
4. 显示过滤(STUN) STUN 用于 NAT 探测与保活 stunstun.type;可看 Binding Request/Response、XOR-MAPPED-ADDRESS(即 NAT 映射地址)
5. 显示过滤(DTLS) WebRTC 媒体使用 DTLS 协商密钥,再以 SRTP 传媒体 dtls;可看 Client Hello/Server Hello、Certificate、Finished;无法仅凭私钥解密 DTLS,需在端点导出 DTLS/SRTP 密钥(见下)
6. 显示过滤(RTP/媒体) 解密前仅能见 SRTP 密文;解密后可识别为 RTP 解密前:udp.port == 9xxx(媒体端口在 SDP 中);解密后:可用 rtp 过滤并做 RTP 流分析
7. 解密 WebRTC 媒体(可选) 在 Chrome/Chromium 中启用 SSL 日志,导出密钥供 Wireshark 解密 SRTP Chrome 启动参数加 --ssl-key-log-file=<path> 并指定路径;Wireshark:Edit → Preferences → Protocols → TLS,在 (Pre)-Master-Secret log filename 填该路径;部分版本需在 Protocols → RTP 中启用「Decrypt SRTP」并依赖 DTLS 密钥;Chrome 的 NSS 格式密钥日志对 DTLS 有效,解密后可见 RTP 流

关键字段与调试要点

  • STUNstun.type(0x0001 Binding Req、0x0101 Binding Resp);stun.att.xor_mapped_address 为服务器看到的客户端公网地址,用于 ICE 候选。
  • SDP(在信令中)m=video/m=audioc=IN IP4a=rtcp-muxa=ice-ufrag/a=ice-pwda=fingerprint(DTLS);可确认媒体端口、ICE 与 DTLS 参数。
  • ICE:在信令中交换 candidate(host/srflx/relay);抓包可验证 candidate 是否与 STUN 响应一致、是否走 TURN(relay)。
  • DTLS:握手成功后才会有 SRTP;若 DTLS 失败,无媒体流或报错。

常见问题排查

  • P2P 不通、仅 TURN 能通:看 STUN Binding 是否有响应;若只有 relay candidate 可用,说明 NAT 对称或策略限制,需 TURN 中继。
  • 无音频/无视频:看信令中 SDP 是否含对应 m= 与 codec;看 DTLS 是否握手成功;看是否有对应端口的 UDP 包(防火墙/安全组可能拦媒体端口)。
  • 媒体解密失败:确认密钥日志在握手已配置、浏览器确实写入了该文件;Wireshark 需同时支持 TLS 密钥日志与 RTP 的 SRTP 解密(部分版本需在 RTP 偏好中勾选解密选项)。

WebRTC 抓包与解密流程简图

flowchart LR
    subgraph 抓包
        A[抓 UDP/TCP] --> B[显示过滤 STUN/DTLS/TLS]
        B --> C[信令看 SDP/ICE]
    end
    subgraph 解密
        D[浏览器 ssl-key-log] --> E[Wireshark TLS 密钥]
        E --> F[DTLS/SRTP 解密]
    end
    C --> G[分析候选与媒体端口]
    F --> G

6.6.5 场景与过滤器速查表
场景 建议抓包过滤(BPF) 常用显示过滤 分析入口
Socket TCP tcp port 端口host IP tcp.port == 端口tcp.stream eq 流索引 Follow TCP Stream、Expert Info、Flow Graph
Socket UDP udp port 端口host IP and udp udp.port == 端口udp.length > 0 Follow UDP Stream、Packet Bytes
音视频 RTP udp portrange 5000-6000 rtprtcprtp.payload_type == 96 Telephony → RTP Streams、RTP Stream Analysis
RTSP tcp port 554udp port 554 rtsp Follow TCP Stream(信令)、RTP 同音视频
HLS/HTTP 直播 tcp port 80 or tcp port 443 http.request.uri contains ".m3u8"http.request.uri contains ".ts" Follow HTTP Stream、看状态码与顺序
WebRTC 信令 tcp port 443 http/tls(解密后看 WSS/SDP) Follow HTTP Stream、看 SDP/ICE
WebRTC STUN/媒体 udp stundtlsrtp(解密后) STUN 看 XOR-MAPPED;RTP 同音视频

七、高级应用与扩展

7.1 官方文档与界面操作导读

内容 官方入口 说明
抓包 Capture → Options;User's Guide Ch.4 接口选择、Capture Filter、Output/Options 标签
抓包过滤语法 §4.10 Filtering while capturingWiki CaptureFilters BPF 原语、自动远程过滤
显示过滤语法 §6.4 Building Display Filter ExpressionsWiki DisplayFilters 比较/逻辑/切片/函数/字段引用
协议与字段列表 View → Internals → Supported ProtocolsDisplay Filter Reference 各协议可过滤字段名
跟随流 右键包 → Follow → TCP/TLS/HTTP Stream 见下
统计 Statistics 菜单 Conversations、Endpoints、Protocol Hierarchy、RTT、IO Graph
专家信息 Analyze → Expert Information 重传、重复 ACK、错误等汇总
开发/解析器 Developer's Guide 编写 Dissector、插件

7.2 跟随流(Follow Stream)

对 TCP、TLS、HTTP 等协议,右键报文选择 Follow → TCP Stream / TLS Stream / HTTP Stream,可在一个窗口中看到该连接上的重组应用数据(明文或解密后),便于分析单会话内容 [13]。

7.3 统计与 IO 图

  • Statistics:Conversations、Endpoints、Protocol Hierarchy、Round-Trip Time 等,用于宏观把握流量与延迟。
  • IO Graphs:按时间轴绘制报文数、字节数或自定义显示过滤器计数,便于观察突发、重传与趋势。

7.4 命令行 tshark

tshark 为 Wireshark 的命令行版本,使用相同的抓包与显示过滤器,适合脚本化与 CI 环境,例如:

tshark -i eth0 -f "tcp port 80" -w capture.pcapng
tshark -r capture.pcapng -Y "http.request" -T fields -e http.request.uri

7.5 自定义解析器与插件

新协议可通过编写 Dissector(C 或 Lua)注册到 Wireshark,实现 proto_register_XXXproto_reg_handoff_XXX,将协议与字段挂入协议树并参与显示过滤;详见 Wireshark Developer's Guide [11]。


八、伪代码与算法说明

8.1 抓包过滤器(BPF)求值概念

BPF 在内核或用户态对每个报文执行布尔表达式求值,仅当结果为真时交付给上层;原语通常对应「偏移 + 长度 + 掩码 + 比较」,例如「IPv4 且目的端口为 80」会编译为对帧内特定偏移处字节的测试。完整语义见 BPF 论文与 man page [12]。

8.2 显示过滤器求值

对每条已解析的报文,根据当前显示过滤器表达式遍历协议树:若字段存在且满足比较/逻辑/集合条件则保留显示,否则隐藏。字段类型与运算符需匹配(如整数用 ==、字符串用 contains/matches),类型不匹配会导致过滤无效或报错。多值字段(如 ip.addr 同时有源与目的)下,== 表示「任一匹配即成立」(any_eq),若需「全部匹配」可使用 ===(all_eq)[10]。

8.3 协议解析器调用顺序(概念)

对每个捕获的 frame:
  1. Frame dissector 写入时间戳、长度等元数据
  2. 根据链路层类型(如 Ethernet type)选择下一层解析器
  3. 递归:每个解析器解析本层头部,根据「下一层协议」字段(如 IP 的 protocol、TCP 的 port)调用子解析器
  4. 直至无子协议或数据结束,协议树与字段注册完成,供显示过滤器使用

参考文献

[1] Wireshark. About Wireshark. www.wireshark.org/about.html
[2] Wireshark. Wireshark User's Guide. www.wireshark.org/docs/wsug_h…
[3] 与 Charles 等代理工具的差异:Charles 为应用层代理,Wireshark 为底层抓包与协议解析。
[4] Wireshark. 1.4. A Brief History Of Wireshark. www.wireshark.org/docs/wsug_h…
[5] Wireshark. Filtering while capturing / Building Display Filter Expressions. User's Guide.
[6] Wireshark Wiki. libpcap. wiki.wireshark.org/libpcap
[7] Wireshark Wiki. Packet capture. wiki.wireshark.org/CaptureSetu…
[8] Npcap. Npcap: Windows Packet Capture Library & Driver. npcap.org/
[9] Wireshark. 4.10. Filtering while capturing. www.wireshark.org/docs/wsug_h…
[10] Wireshark. 6.4. Building Display Filter Expressions. www.wireshark.org/docs/wsug_h…
[11] Wireshark. Chapter 9. Packet Dissection. Developer's Guide. www.wireshark.org/docs/wsdg_h…
[12] tcpdump. pcap-filter man page. www.tcpdump.org/manpages/pc…
[13] Wireshark. Following Protocol Streams. User's Guide.
[14] Wireshark Wiki. TLS. wiki.wireshark.org/TLS
[15] SSLTrust / 第三方. Wireshark troubleshoot network SSL TLS.
[16] Cisco Community. Troubleshoot TLS using Wireshark. community.cisco.com/t5/security…
[17] Wireshark Wiki. CaptureFilters. wiki.wireshark.org/CaptureFilt…
[18] Wireshark Wiki. DisplayFilters. wiki.wireshark.org/DisplayFilt…
[19] Wireshark. 4.5. The "Capture Options" Dialog Box. User's Guide. www.wireshark.org/docs/wsug_h…
[20] Wireshark. Display Filter Reference. www.wireshark.org/docs/dfref/

01-Debug调试@网络-Charles网络抓包工具:从原理到实践

📋 目录


一、概述与历史演进

1.1 工具简介

Charles 是一款面向 Windows、macOS、LinuxWeb 调试代理(Web Debugging Proxy) 应用,由 Karl von Randow 创建,自 2002 年发布至今,由 XK72 维护 [1][2]。其核心能力包括:拦截、记录、修改与重放 HTTP/HTTPS 流量,支持带宽限速、断点调试、请求/响应重写与本地/远程映射,被广泛用于 Web 与移动端接口调试、前后端联调、弱网与异常场景测试 [1][3][4]。

1.2 历史与版本脉络

时期 事件
2002 Charles 首次发布,以 Java 实现,跨平台运行
3.x 引入 SSL Proxying(HTTPS 中间人解密)、各平台根证书安装流程
3.10+ Charles 根证书改为每台安装独立生成,需重新信任
3.11.4+ 支持 iOS App Transport Security (ATS)
2018 Charles for iOS 上架 App Store,支持在设备端抓包 [2]
2024–2025 4.6.x 稳定版;Charles 5.0 发布,新 UI、Apple Silicon/Windows on ARM、新会话格式 .chlz [2][5]

1.3 典型应用场景

  • 接口调试:查看请求 URL、Method、Header、Body 与响应状态、Body(JSON/XML 等),定位参数与返回错误。
  • HTTPS 明文查看:通过 SSL Proxying 将加密流量解密为明文,便于分析 API 内容。
  • 弱网与限速:Throttling 模拟带宽、延迟、丢包,验证加载、超时与降级逻辑。
  • Mock 与联调:Map Local / Map Remote / Rewrite 用本地或备用环境响应替代线上,或修改请求/响应内容。
  • 断点调试:在请求发出前或响应返回前暂停,修改后再放行或中止,用于测试异常与边界。

二、核心原理

2.1 代理与中间人

Charles 作为 HTTP/HTTPS 代理 运行在本机(默认端口 8888)。客户端(浏览器、App)将代理设置为 127.0.0.1:8888 后,发往目标的 HTTP(S) 请求会先发到 Charles,再由 Charles 转发到真实服务器;响应同样经 Charles 再回到客户端。因此 Charles 处于「客户端 ↔ Charles ↔ 服务端」的中间人位置,可完整查看与修改双向流量 [3][4]。

flowchart LR
    subgraph 客户端
        C[Browser / App]
    end
    subgraph 代理层
        P[Charles :8888]
    end
    subgraph 服务端
        S[Origin Server]
    end
    C -->|1. 请求| P
    P -->|2. 转发请求| S
    S -->|3. 响应| P
    P -->|4. 返回响应| C

2.2 数据流与记录

  • 记录:Charles 在转发前后记录请求与响应的 URL、方法、头、体;对 HTTPS 需开启 SSL Proxying 并安装根证书后才能解密并记录明文。
  • 结构视图:按 Host 或 Path 聚合展示会话,便于按接口查看;支持搜索、过滤与导出会话(.chls/.chlz)。
  • 证书与解密:HTTPS 解密依赖「客户端信任 Charles 根证书 + Charles 对指定 Host 启用 SSL Proxying」,详见第三节。

三、HTTPS 与 SSL 代理

3.1 为何 HTTPS 需要特殊处理

HTTPS 在 TCP 之上建立 TLS/SSL 加密通道,端到端加密后,代理若只做「透传」,无法看到应用层明文。Charles 要查看或修改内容,必须作为 TLS 中间人:与客户端建立一条 TLS 连接,与服务器建立另一条 TLS 连接,在中间以明文处理数据 [4][6]。

3.2 SSL Proxying(中间人)原理

Charles 的 SSL Proxying 本质是受控的「中间人」行为 [6][7]:

  1. 客户端 → Charles:客户端发起 HTTPS 请求到 host:443,因系统代理指向 Charles,TCP 连接实际建到 Charles;TLS 握手时,Charles 转发服务器真实证书,而是用 Charles 根证书签发一张「伪造」的站点证书(Subject 等与目标 host 匹配),下发给客户端。
  2. 客户端验证:客户端校验证书链。若未安装/信任 Charles 根证书,会报「不受信任的 CA」;安装并信任 Charles 根证书后,客户端认为该站点证书合法,与 Charles 完成 TLS 握手,后续应用层数据以 Charles 与客户端协商的密钥加密。
  3. Charles → 服务端:Charles 再以真实客户端身份向目标服务器发起 HTTPS,使用服务器真实证书完成 TLS,获得与服务器的明文通信。
  4. 结果:Charles 同时拥有「客户端 ↔ Charles」与「Charles ↔ 服务端」的解密能力,可记录、修改请求与响应后再转发。
    简要对应关系 [16]:客户端向服务器发起 HTTPS 请求 → Charles 拦截并伪装成客户端向服务器请求 → 服务器返回 CA 证书给「客户端」(实为 Charles)→ Charles 用本地根证书签发一张与目标站点匹配的证书,替换后发给客户端 → 客户端用 Charles 公钥加密对称密钥发给 Charles → Charles 用私钥解密得到对称密钥,再用服务器公钥加密发给服务器 → 此后 Charles 同时持有两端密钥,可解密、修改后再转发。关键前提:客户端必须信任 Charles 根证书,否则会报证书不受信任。
sequenceDiagram
    participant C as 客户端
    participant P as Charles
    participant S as 服务器

    C->>P: 建立连接 (代理)
    P->>C: 返回 Charles 签发的站点证书
    Note over C: 校验证书(需信任 Charles 根证书)
    C->>P: 加密请求 (客户端↔Charles 密钥)
    P->>S: 建立 TLS,获取服务器证书
    P->>S: 加密请求 (Charles↔服务器 密钥)
    S->>P: 加密响应
    P->>P: 解密并可选修改
    P->>C: 用客户端密钥加密后返回

3.3 配置要点(官方建议 [6][7][8])

  • 启用 SSL Proxying:Proxy → SSL Proxying Settings,勾选 Enable SSL Proxying,并在列表中加入要解密的主机(Host + Port,如 *:443api.example.com:443)。不在此列表中的 Host,Charles 对 HTTPS 只做透传,不解密。
  • 按地址启用 SSL Proxying(重要):若只做了全局「Enable SSL Proxying」却未把具体要抓的域名加入列表,该域名的 HTTPS 仍会以密文显示。操作方式二选一即可 [15][16]:
    • 方式一:在 Charles 会话列表(Structure/Sequence)中,右键目标 Host 或该域名下的某条请求 → SSL Proxying → Enable SSL Proxying,Charles 会自动将该 Host:443 加入 SSL Proxying 列表。
    • 方式二:Proxy → SSL Proxying Settings → Add,手动填写 Host(如 api.example.com)与 Port(如 443)。
      因此:具体的 HTTPS 抓包,必须在「被抓包的那个地址」上启用 SSL Proxying,否则无法看到明文。
  • 安装并信任根证书:Help → SSL Proxying → Install Charles Root Certificate(或 Save 后手动导入)。安装后需在系统/浏览器中将该证书设为受信任的根 CA(如 macOS 钥匙串中设为「始终信任」),否则客户端仍会报错。
  • 关闭解密:若不需要查看 HTTPS 明文,可在 Proxy Preferences 中关闭 SSL Proxying,Charles 将直接转发 TLS 流量,不进行解密与记录明文。

3.4 HTTPS 解密流程(算法级描述)

算法概念:Charles 作为 TLS 中间人

1. 客户端向 host:443 发起 TLS ClientHello(因系统代理,连接至 Charles)。
2. Charles 向真实服务器发起 TLS 连接,完成与服务器的握手,获得服务器证书与会话密钥 K2。
3. Charles 用本地 Charles 根证书的私钥,为「host」签发一张新证书 cert_fake,Subject 等与服务器证书一致或兼容。
4. Charles 向客户端返回 cert_fake,客户端用已信任的 Charles 根证书验证 cert_fake,通过则与 Charles 完成握手,得到客户端与 Charles 的会话密钥 K1。
5. 客户端发送的 HTTPS 请求用 K1 加密,Charles 用 K1 解密得到明文请求;Charles 用 K2 加密后转发给服务器。
6. 服务器响应用 K2 加密,Charles 用 K2 解密得到明文响应;Charles 可修改后再用 K1 加密返回客户端。
7. 因此 Charles 在「请求」与「响应」两段均具备明文读写能力,用于记录、Breakpoint 修改、Rewrite、Map Local 等。

3.5 证书与安全注意

  • Charles 根证书拥有对任意域签发证书的能力,一旦被信任,可被用于窃听或篡改 HTTPS。因此仅应在本机调试环境安装,不要在生产或个人敏感环境中长期信任。
  • 从 Charles 3.10 起,根证书为每台机器/每次安装独立生成,旧设备导出的根证书不能直接用于新环境,需在新环境重新安装并信任 [8]。

3.6 HTTPS 抓包配置处理(操作清单)

要成功对 HTTPS 流量进行抓包并看到明文,必须同时满足 Charles 端客户端/本机 两处配置;缺一不可。下面给出统一的操作清单与排查要点。

3.6.1 Charles 端必须完成的配置

顺序 操作 说明
打开 Proxy → SSL Proxying Settings 若未打开过,先进入该窗口
勾选 Enable SSL Proxying 不勾选则所有 HTTPS 仅透传,不解密
SSL Proxying Locations 列表中为要抓的域名添加条目 Host:填域名或 *(如 * 表示任意;api.example.com 表示仅该域名);Port:一般为 443。未在列表中的 Host 不会被解密,界面中仍显示为密文

按地址启用的两种方式(任选其一即可):

  • 方式 A(推荐):抓包时在会话列表(Structure / Sequence)中,右键目标 Host 或该域名下任意一条请求 → SSL Proxying → Enable SSL Proxying,Charles 会自动把该 Host:443 加入上述列表。
  • 方式 B:在 SSL Proxying Settings 窗口点击 Add,手动填写 HostPort(443);可用 * 表示任意主机。

3.6.2 客户端/本机必须完成的配置

抓包对象是,就要在的系统或环境中安装并信任 Charles 根证书:

抓包对象 证书安装与信任位置
本机浏览器 本机:Help → SSL Proxying → Install Charles Root Certificate;安装后在系统钥匙串/证书存储中将该证书设为受信任的根 CA(如 macOS 钥匙串访问 → 找到 Charles Proxy CA → 展开「信任」→ 使用此证书时:始终信任
iOS 真机 App/浏览器 手机:Safari 打开 chls.pro/ssl 安装描述文件;设置 → 通用 → 关于本机 → 证书信任设置 中对该 Charles 证书启用「完全信任
Android / HarmonyOS 设备 设备浏览器打开 chls.pro/ssl 安装证书;Android 7+ 自研 App 还需在工程中配置 Network Security Configuration 信任用户证书(见 §6.3)
iOS 模拟器 Charles:Help → SSL Proxying → Install Charles Root Certificate in iOS Simulators(需先关闭模拟器再执行)

未安装或未信任根证书时,客户端会报「证书不受信任」「连接不是私密连接」等错误,HTTPS 握手失败,无法抓包。

3.6.3 配置自检与常见问题

  • Charles 里能看到请求,但 Response 是乱码或显示为加密数据
    → 说明代理已生效,但未对该 Host 启用 SSL Proxying。按 3.6.1 在 SSL Proxying Locations 中添加该 Host:443,或右键该请求/Host → Enable SSL Proxying。

  • 客户端报证书错误、无法打开页面或 App 请求失败
    → 说明未在该客户端环境安装或信任 Charles 根证书。按 3.6.2 在对应设备/本机完成安装并在「证书信任设置」或系统凭据中设为信任。

  • *已添加 :443 仍有个别域名看不到明文
    → 少数情况下需确认该请求确实走了 Charles 代理(系统/App 代理指向 Charles);若为自研 App,检查是否开启了证书锁定(Certificate Pinning),若开启则需在调试版本中关闭或信任 Charles。

  • 换电脑或重装 Charles 后,手机/本机之前装的证书报错
    → Charles 3.10+ 根证书每台机器独立生成,需在当前运行 Charles 的电脑上重新执行「Install Charles Root Certificate on a Mobile Device」,并在设备上重新访问 chls.pro/ssl 安装新证书并信任。

3.6.4 配置处理流程简图

flowchart LR
    subgraph Charles端
        A1[Enable SSL Proxying]
        A2[Add Host:443 或 右键启用]
    end
    subgraph 客户端
        B1[安装 Charles 根证书]
        B2[信任该证书]
    end
    A1 --> A2
    B1 --> B2
    A2 --> C[HTTPS 可解密]
    B2 --> C

总结:HTTPS 抓包 = Charles 端对目标 Host 启用 SSL Proxying + 在抓包对象所在环境安装并信任 Charles 根证书;两者都做对后,即可在 Charles 中看到该域名的请求/响应明文并进行修改、断点等操作。


四、功能体系与工具链

4.1 功能总览

功能 说明 典型用途
Proxy 记录 自动记录经 Charles 的 HTTP(S) 请求与响应 日常抓包、接口排查
SSL Proxying 对指定 Host 解密 HTTPS,以明文展示与修改 查看/改写 API 内容
Breakpoints 按 URL 匹配在请求/响应前后暂停,可编辑后放行或中止 改参数、改响应、模拟失败
Map Local 将匹配的请求的响应替换为本地文件内容 用本地 JSON/HTML 做 Mock
Map Remote 将匹配的请求重定向到另一 Host/Path 将线上接口指到测试/预发
Rewrite 按规则修改请求/响应头或体(如替换字符串) 改 Host、Token、部分 JSON
Throttling 限制带宽、延迟、丢包、MTU 等 弱网、高延迟、不稳定网络
Compose / Repeat 手动编辑请求并发送、重放已有请求 接口重放、压力与回归

4.2 Breakpoints(断点)[9]

  • 作用:在请求发出前或响应返回前拦截,在 Charles 中查看并编辑内容,再选择 Execute(应用修改并继续)、Abort(中止并返回错误)或 Cancel(放弃修改并原样通过)。
  • 配置:Proxy → Breakpoint Settings,添加 Location,用协议、Host、端口、路径模式匹配 URL,支持通配符;每个断点可单独勾选「Request」「Response」或两者。
  • 流程概念
请求发出 → 若匹配 Request 断点 → 暂停 → 编辑 → Execute/Abort/Cancel
         → 若未匹配或已放行 → 转发到服务器
响应返回 → 若匹配 Response 断点 → 暂停 → 编辑 → Execute/Abort/Cancel
         → 若未匹配或已放行 → 返回客户端

4.3 Map Local 与 Map Remote [10][11][15]

  • Map Local:当请求的 URL 与设定规则匹配时,Charles 向服务器发请求,而是用本地文件内容作为响应体返回。适用于静态资源或 JSON 等;服务端动态逻辑不会执行。
    典型用法 [15]:① 用本地 JSON 文件充当某接口的返回值(如难以复现的首充、活动接口);② 用本地 JS 调试线上页面:将线上站点的 https://www.example.com/js/main.js 映射到本机 /Users/xxx/project/js/main.js,在浏览器直接访问线上 URL 即可看到本地修改在「线上环境」下的效果,适合本地环境不完整、必须依赖线上环境联调时。
  • Map Remote:将匹配的请求重定向到另一地址(可不同 Host/Path),例如把 https://api.prod.com/v1/* 映射到 https://api.test.com/v1/*,便于用测试环境替代生产。
    典型用法 [15]:本地开发时接口写为带域名的 https://www.example.com/api/getData(避免跨域),在 Charles 中配置「将 https://localhost/api/* 或本机某路径映射到 https://www.example.com/」,这样本地请求会实际转发到线上或测试环境;配合 Rewrite 注入登录 Cookie 后,可带登录态访问测试/线上接口。

4.4 Rewrite [11][15]

  • 按规则对请求或响应的 Header / Body 做字符串级替换(如键名、域名、Token)。与 Map Local/Remote 相比,不替换整份内容,只做局部修改;规则可基于 URL 匹配与通配符。
    典型用法 [15]:
    • 模拟登录态:在 Tools → Rewrite 中添加规则,对指定 URL 集合做 Add Header,将已登录环境下的 Cookie 填入请求头,即可在本地或无登录环境访问需登录的接口(Cookie 有过期时间,需定期更新)。
    • 解决响应乱码:部分响应使用 Brotli(br) 编码时,Charles 可能无法正确解码导致 Body 乱码;可在 Rewrite 中修改请求头 Accept-Encoding,去掉 br,让服务端返回 gzip/deflate,Charles 即可正常显示 JSON 等内容。
    • 其他:添加/修改请求参数、修改响应状态码或部分 JSON 字段等。

4.5 Throttling(带宽与弱网模拟)[4][12]

  • 作用:模拟慢速、高延迟、丢包等,使客户端「以为」处于弱网环境,用于验证加载、超时、错误提示与降级策略。
  • 启用:Proxy → Start Throttling(或快捷键);Proxy → Throttle Settings 配置。
  • 常见参数
    • Bandwidth:上行/下行带宽上限(如 256 kbps)。
    • Latency:往返延迟(如 500 ms)。
    • Reliability:丢包率。
    • MTU:最大传输单元。
  • 仅限部分 Host:在 Throttle Settings 中勾选「Only for selected hosts」并添加 Host,可只对指定接口限速,避免影响其他操作。

五、配置与使用场景

5.1 本机浏览器抓包(macOS / Windows)

  1. 启动 Charles,默认监听 8888。
  2. 系统代理:Charles 可自动设置系统 HTTP/HTTPS 代理为 127.0.0.1:8888(Proxy → macOS Proxy / Windows Proxy);关闭 Charles 时通常可恢复原设置。请求路径如下:
flowchart LR
    A[浏览器] -->|系统代理 127.0.0.1:8888| B[Charles]
    B --> C[目标服务器]
    C --> B
    B --> A
  1. HTTPS:按第三节安装并信任根证书,在 SSL Proxying Settings 中添加需解密的主机(如 *:443)。
  2. 浏览器访问任意 HTTP(S) 站点,在 Charles 的 Structure 或 Sequence 视图中查看会话。

5.2 仅抓部分域名或接口

  • SSL Proxying Settings:只添加需要解密的 Host,其他 HTTPS 不解密。
  • Proxy → Recording Settings:Include 中只填需要记录的 Host/Path,或 Exclude 排除无关域名,减少噪音。

5.3 Mock 与联调流程(概念)

1. 在 Map Local 中添加规则:例如 Host=api.example.com, Path=/v1/config → 本地文件 config.json
2. 客户端请求 https://api.example.com/v1/config → Charles 匹配规则 → 直接返回 config.json 内容
3. 或使用 Map Remote:将 api.example.com 映射到 api.test.com,请求被转发到测试环境
4. 或使用 Rewrite:将响应体中的 "env":"prod" 替换为 "env":"test"

5.4 弱网测试流程(概念)

1. Proxy → Throttle Settings,设置 Bandwidth / Latency / Reliability 等
2. 可选:Only for selected hosts,添加待测接口的 Host
3. Proxy → Start Throttling
4. 在 App 或页面中触发请求,观察加载时间、超时与错误处理
5. 测试结束后 Stop Throttling

六、各平台网络抓包配置 SOP

以下按 iOS、AOS(Android)、HOS(HarmonyOS)、WebAPP(浏览器/Web 端) 四类平台,给出 Charles 抓包的标准操作步骤(SOP),便于按平台查阅与排错。

6.1 通用前提与平台对照

项目 说明
网络 终端设备与运行 Charles 的电脑处于同一局域网(同一 Wi‑Fi 或同网段)。
端口 电脑防火墙放行 8888 入站,或临时关闭防火墙测试。
Charles 已启动并监听 8888;需抓 HTTPS 时在 Charles 内对目标 Host 启用 SSL Proxying(见 §3.3)。
平台 代理配置位置 证书安装方式 HTTPS 特别说明
iOS 设置 → Wi‑Fi → 当前网络 → 配置代理 浏览器打开 chls.pro/ssl → 安装描述文件 → 证书信任设置 需在「证书信任设置」中勾选 Charles
AOS (Android) 设置 → WLAN → 当前网络 → 代理 浏览器打开 chls.pro/ssl 安装;Android 7+ 自研 App 需 NSC 信任用户证书 见 §6.3
HOS (HarmonyOS) 设置 → WLAN → 当前网络 → 代理 同 AOS,浏览器 chls.pro/ssl;自研应用可能需网络安全配置 与 Android 类似,新系统可能需应用内代理/证书配置
WebAPP 系统代理或浏览器代理指向本机 127.0.0.1:8888 本机安装 Charles 根证书并信任(Help → Install Charles Root Certificate) 依赖系统/浏览器信任 Charles 根证书

6.2 iOS 抓包配置 SOP [8][13]

适用于 iPhone / iPad 真机iOS 模拟器

6.2.1 iOS 真机

步骤 操作 说明
1 电脑:Charles 已启动 → Help → SSL Proxying → Install Charles Root Certificate on a Mobile Device 弹出框内会显示代理地址(如 192.168.x.x:8888)与证书下载页 chls.pro/ssl,记下电脑 IP 与 8888 端口
2 手机:设置 → Wi‑Fi → 点击当前已连接网络右侧 (i) → 配置代理 → 选择 手动 服务器:填电脑 IP;端口:8888;保存
3 手机:用 Safari 打开 chls.pro/ssl 按提示下载并安装「Charles Proxy CA」描述文件,若提示需在设置中确认则前往「设置 → 已下载描述文件」安装
4 手机:设置 → 通用关于本机证书信任设置 找到 Charles Proxy CA,打开「完全信任」开关;未信任则 HTTPS 会报证书错误
5 Charles:Proxy → SSL Proxying Settings → 勾选 Enable,在列表中 Add 需解密的 Host(如 *:443api.xxx.com:443);或抓包时在会话列表右键目标 Host/请求 → SSL Proxying → Enable SSL Proxying 不在此列表的域名 HTTPS 仍为密文 [15][16]
6 在手机中打开要抓的 App 或 Safari,正常发起请求 Charles 的 Structure / Sequence 中应出现对应会话;HTTPS 需完成步骤 4、5 才能看到明文

注意:若 App 启用 ATS 且不信任用户安装的 CA,需在自研 App 的 Info.plist 中配置 ATS 例外或使用已信任 Charles 的调试包。

6.2.2 iOS 模拟器

步骤 操作 说明
1 关闭所有 iOS 模拟器实例 确保证书安装到当前模拟器运行时
2 Charles:Help → SSL Proxying → Install Charles Root Certificate in iOS Simulators 证书会安装到当前已安装的模拟器系统中
3 启动模拟器;在 macOS 上勾选 Proxy → macOS Proxy(或 Windows Proxy) 模拟器继承系统代理,流量走本机 Charles
4 在 Charles 的 SSL Proxying Settings 中为需抓取的 Host 启用 SSL Proxying 同真机步骤 5
5 在模拟器内打开 Safari 或目标 App 发起请求 抓包与真机一致

6.3 AOS(Android)抓包配置 SOP [8]

适用于 Android 手机 / 平板(含 Android 7+ 自研 App 的证书信任配置)。

步骤 操作 说明
1 电脑:Charles 已启动;Help → SSL Proxying → Install Charles Root Certificate on a Mobile Device,记下 电脑 IP8888 同 iOS
2 手机:设置 → WLAN(或 网络和互联网 → Wi‑Fi)→ 长按当前连接网络 → 修改网络 / 高级选项代理手动 主机名:电脑 IP;端口:8888;保存
3 手机:用系统浏览器打开 **chls.pro/ssl**,下载并安装 Charles 根证书 按系统提示完成「安装到凭据存储」等步骤
4 Android 7.0+ (N):系统默认不信任用户安装的 CA。若抓的是自研 App,需在工程中增加 Network Security Configuration,在 debug 下信任用户证书: 仅影响调试包,正式包可不引用或仅 debug 引用

res/xml/network_security_config.xml:

<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
  <debug-overrides>
    <trust-anchors>
      <certificates src="user" />
      <certificates src="system" />
    </trust-anchors>
  </debug-overrides>
</network-security-config>

AndroidManifest.xml<application> 中增加:

android:networkSecurityConfig="@xml/network_security_config"

| 5 | Charles:Proxy → SSL Proxying Settings → 为需抓取的 Host 添加 *:443 或具体域名:443;或右键会话中的 Host → Enable SSL Proxying | 同 iOS | | 6 | 在手机中打开目标 App 或浏览器发起请求 | 若仍报证书错误,检查步骤 3、4 是否完成;第三方 App 无法改 NSC 时可能无法抓其 HTTPS |


6.4 HOS(HarmonyOS)抓包配置 SOP

适用于 华为 / 荣耀等搭载 HarmonyOS 的设备;代理与证书流程与 Android 类似,部分机型路径可能为「设置 → WLAN → 当前网络 → 代理」 [17]。

步骤 操作 说明
1 电脑:Charles 已启动;记下电脑 IP 与 8888 端口(Help → Install Charles Root Certificate on a Mobile Device 可查看) 同 iOS / AOS
2 手机:设置 → WLAN → 当前连接网络 → 代理(或 高级 / 更多)→ 选 手动 主机/服务器:电脑 IP;端口:8888
3 手机:浏览器打开 **chls.pro/ssl**,下载并安装 Charles 根证书 按系统提示安装到「凭据存储」等;部分 HarmonyOS 版本需在「设置 → 安全 → 加密与凭据」中确认用户证书已安装
4 自研 HarmonyOS 应用:若抓包时 HTTPS 仍报证书错误,需在应用内配置信任用户证书(视 SDK/API 版本而定;API 10+ 支持 usingProxycaPath 等)或使用系统提供的网络安全配置能力 与 AOS 的 NSC 思路类似,具体以华为开发者文档为准
5 Charles:SSL Proxying Settings 中为需解密的 Host 添加条目,或右键会话 → Enable SSL Proxying 同其他平台
6 在设备上打开目标 App 或浏览器发起请求 确认代理与证书均生效

6.5 WebAPP(浏览器 / Web 端)抓包配置 SOP

适用于 桌面浏览器(Chrome / Edge / Safari / Firefox) 以及 移动端浏览器 访问的 Web 页面;核心是「本机或当前设备使用 Charles 作为代理 + 信任 Charles 根证书」。

6.5.1 桌面端(本机浏览器)

步骤 操作 说明
1 电脑:启动 Charles,确认监听 8888 默认 Proxy → macOS Proxy / Windows Proxy 会设置系统代理为 127.0.0.1:8888
2 本机证书:Help → SSL Proxying → Install Charles Root Certificate;安装后在系统钥匙串(macOS)或证书管理(Windows)中将 Charles 根证书设为受信任的根 CA 否则浏览器访问 HTTPS 会报不安全
3 Charles:Proxy → SSL Proxying Settings → Enable SSL Proxying,Add 需解密的 Host(如 *:443)或抓包时右键目标 Host → Enable SSL Proxying 同移动端
4 在浏览器中访问目标 Web 或 WebAPP 流量经 Charles,Structure / Sequence 中可查看与修改请求/响应

仅对当前浏览器走代理(不改系统代理)时:安装浏览器代理扩展(如 SwitchyOmega),将 HTTP/HTTPS 代理指向 127.0.0.1:8888,并确保该浏览器信任本机已安装的 Charles 根证书。

6.5.2 移动端浏览器(手机/平板访问 Web)

  • iOS:按 §6.2.1 配置代理与证书后,在 Safari 或其他浏览器中访问的 H5/Web 请求会经 Charles。
  • AOS / HOS:按 §6.3 / §6.4 配置代理与证书后,在系统浏览器或 Chrome 等中访问的页面请求会经 Charles;若仅浏览器抓包、不涉及 App,通常只需系统代理 + 安装并信任 Charles 证书即可。

6.6 流程小结

flowchart TD
    A[设备与电脑同网 + Charles 已启动] --> B[设备端配置代理: 电脑IP:8888]
    B --> C[设备/本机安装并信任 Charles 根证书]
    C --> D[Charles 内对目标 Host 启用 SSL Proxying]
    D --> E[发起请求]
    E --> F[Charles 记录并可选解密/修改]

七、最佳实践与注意事项

  • 仅调试环境使用:Charles 根证书权限极大,只在开发/测试机器上安装并信任,用毕可关闭系统代理或停用 Charles。
  • 最小化 SSL Proxying 范围:只对需要查看的 Host 开启 SSL Proxying,避免不必要的解密与隐私风险。
  • 弱网:优先使用「Only for selected hosts」限速,减少对整机其他请求的影响。
  • 敏感数据:会话中可能包含 Token、Cookie、账号信息,保存 .chls/.chlz 或截图时注意脱敏与保管。
  • 合规:仅对自有或已授权的应用与接口抓包,勿用于未授权的第三方服务或用户数据。

延伸阅读(掘金系列)

以下文章从 iOS/Android 抓包、前端联调、HTTPS 原理与 Charles 功能教程等角度做了补充说明,可按需查阅。

序号 标题 链接 内容概要
01 iOS Charles 抓包 掘金 iOS 端 Charles 抓包配置与证书安装
02 Android 端 Charles 抓包 掘金 Android 代理与证书配置、高版本信任用户 CA
03 Charles 前端应用 掘金 Rewrite 模拟登录 Cookie、Map Remote/Local、去掉 br 解决乱码
04 史上最强 Charles 抓包 掘金 Charles 功能与抓包场景综合介绍
05 Charles 从入门到精通 掘金 入门到进阶功能与操作教程
06 Charles 功能介绍和使用教程 掘金 功能说明与使用步骤
07 HTTPS 与 Charles 掘金 HTTP/HTTPS 安全、TLS 握手与 Charles 中间人原理
08 为了学会 Charles,我拼命了 掘金 简介、iPhone/Chrome 配置、Repeat/Compose/Rewrite/Map 简介
09 最明白的 Charles 教程(一) 掘金 Charles 基础与界面说明
10 最明白的 Charles 教程(二) 掘金 抓包与过滤操作
11 最明白的 Charles 教程(三) 掘金 进阶功能与场景
12 最明白的 Charles 教程(四) 掘金 综合实战与排错

参考文献

[1] Charles Proxy. Overview / Features. www.charlesproxy.com/overview/fe…
[2] Wikipedia. Charles (software). en.wikipedia.org/wiki/Charle…
[3] Charles Proxy. Documentation – Welcome. www.charlesproxy.com/documentati…
[4] XK72. Charles Proxy. www.charlesproxy.com/
[5] Charles Proxy. Version History. www.charlesproxy.com/documentati…
[6] Charles Proxy. SSL Proxying. www.charlesproxy.com/documentati…
[7] Charles Proxy. SSL Certificates. www.charlesproxy.com/documentati…
[8] Charles Proxy. SSL Certificates – iOS / Android / Java / Chrome. 官方文档 Install Charles Root Certificate 各平台说明.
[9] Charles Proxy. Breakpoints Tool. www.charlesproxy.com/documentati…
[10] Charles Proxy. Map Remote. www.charlesproxy.com/documentati…
[11] Charles Proxy. Map Local;Stack Overflow. Charles Proxy Rewrite vs Map Local.
[12] Charles Proxy. Throttling;Donny Wals. Throttle network speeds for a specific host in Charles;Mobot. Charles Proxy for Network Throttling.
[13] Detroit Labs. A Guide To Charles Proxy for Mobile Development;Medium. Setting Up Charles Proxy with iOS Devices and Emulators;Charles. iOS Getting Started.
[14] CSDN / 技术博客. 使用 Charles 抓取 HTTPS 数据及原理分析(中间人、证书链).
[15] 掘金. charles 前端应用. juejin.cn/post/684490… Remote、Map Local 实战).
[16] 掘金. HTTPS 与 Charles为了学会 Charles,我拼命了. juejin.cn/post/684490… 握手与 Charles 证书替换、按地址启用 SSL Proxying).
[17] HarmonyOS 网络抓包与 Charles 代理证书配置(代理 + chls.pro/ssl + 证书信任);华为开发者文档 @ohos.net.http(API 10+ 代理与证书参数).

其它参考

02-编程范式和编程思想学习@iOS |【Effective Objective-C】精华导读

image.png

📋 目录


一、概述与定位

《Effective Objective-C 2.0: 52 Specific Ways to Write Better iOS and OS X Programs》(以下简称「本书」)由 Matt Galloway 撰写,2013 年由 Addison-Wesley Professional 出版,隶属 Effective Software Development Series(Scott Meyers 主编),与《Effective C++》《Effective Java》等同属「以条目化、可操作建议」提升代码质量的经典技术书 [1][2]。

1.1 目标读者与写作方式

  • 目标读者:具备 Objective-C 与 Cocoa/Cocoa Touch 基础的中高级开发者,不侧重语法入门,而侧重在既有知识基础上写出更安全、可维护、符合范式的代码 [2]。
  • 写作方式:全书分为 52 条(Item) 独立建议,每条聚焦一个具体问题或原则,可单独阅读;条目间有交叉引用,便于形成体系 [1]。

1.2 与「编程范式」的关系

本书所涉的编程范式涵盖:

  • 面向对象范式:对象、消息传递、继承与多态在 Objective-C 中的实现方式(动态类型、运行时)。
  • 内存管理范式:从手动引用计数(MRR)到自动引用计数(ARC)的演进,以及所有权与对象图思维。
  • 并发与异步范式:Block 闭包与 Grand Central Dispatch(GCD)所代表的「任务 + 队列」模型。
  • 接口与 API 设计范式:命名、不可变性、委托与协议、分类与扩展等 Cocoa 惯例。

下文从历史演进核心原理图示与算法应用场景四方面系统梳理本书内容,并引用权威文献与业界实践。本文档同时参考了掘金上的「《Effective Objective-C》干货三部曲」(概念篇、规范篇、技巧篇)[13][14][15],对部分条目的示例与归类做了补充。文档兼顾学术严谨性(概念定义、引用来源)与可读性(结构分条、图示与伪代码),便于既作速查又作体系化学习。


二、技术演进与历史脉络

2.1 Objective-C 与 Cocoa 的渊源

Objective-C 在 C 语言之上增加了单继承的面向对象动态消息传递(dynamic messaging)。对象收到「消息」后,由运行时根据**选择子(selector)**查找并执行对应方法实现;这种「发消息」而非「调函数」的模型,使得方法解析、转发、替换(如 method swizzling)均在运行时完成,构成本书所述「对象、消息与运行时」的基础 [3][4]。

2.2 内存管理范式的演进

阶段 时期 范式 说明
MRR 早期至 iOS 4 / Mac OS X 10.6 手动引用计数 开发者显式调用 retain / release / autorelease,所有权由命名约定(如 allocnewcopy 返回持有)约定 [5][6]
ARC iOS 5 / Mac OS X 10.7 起 自动引用计数 编译器在编译期插入合适的 retain/release,仍为引用计数语义,非追踪式 GC;循环引用需开发者用 __weak 等打破 [5][7]
GC 弃用 OS X Mountain Lion 起 垃圾回收在 OS X 上被弃用,macOS Sierra 后从运行时移除,ARC 成为官方推荐 [7]

要点:ARC 与 MRR 共享同一套所有权与引用计数概念;理解「谁拥有对象、何时释放」有助于写出 ARC 下仍正确的代码(尤其 Block、delegate、timer 等易产生循环引用的场景)[5][8]。

2.3 Block 与 GCD 的引入

  • Block:Apple 在 C、Objective-C、C++ 中引入的闭包语法,可捕获上下文变量并延迟执行,是回调、动画、GCD 任务的基础。本书强调 Block 的循环引用(block 捕获 self、self 又持有 block)及 weak–strong dance 的规范写法 [9][10]。
  • Grand Central Dispatch (GCD):基于队列的并发抽象,将任务(block)派发到串行/并发队列,由系统管理线程。与 performSelector: 相比,GCD 支持异步、取消语义与队列层次,成为 iOS/macOS 并发编程的主流范式 [2][11]。

2.4 内存管理范式演进(时间线)

时期 范式/事件
早期 Cocoa MRR:手动 retain / release / autorelease
iOS 5 / Mac OS X 10.7 (Xcode 4.2) ARC 完整支持,编译期插入引用计数调用
OS X Mountain Lion 起 垃圾回收(GC)弃用
macOS Sierra 起 GC 从运行时移除,ARC 为唯一推荐方式

三、全书结构与 52 条建议总览

本书共 7 章、52 条,下表给出每章主题与条目范围,便于按需查阅 [1][2]。

主题 条目 核心内容概要
1 熟悉 Objective-C 1–5 语言根源、头文件与导入、字面量语法、类型常量与枚举
2 对象、消息与运行时 6–14 属性与实例变量、相等性、类簇、关联对象、消息机制、方法转发、method swizzling、类对象
3 接口与 API 设计 15–22 命名、指定初始化器、description、不可变优先、命名一致性、私有方法、错误处理、NSCopying
4 协议与分类 23–28 委托模式、分段实现、分类前缀、分类中避免属性、类扩展、匿名对象
5 内存管理 29–36 引用计数、ARC、dealloc、异常安全、弱引用、autorelease 池、僵尸对象、retainCount
6 Block 与 GCD 37–46 Block 语法与 typedef、handler block、循环引用、dispatch 队列、GCD 与 performSelector、NSOperation、dispatch group、dispatch_once、当前队列
7 系统框架 47–52 框架使用、块枚举、桥接、NSCache、+load/+initialize、NSTimer

四、核心原理与精华条目

4.1 第一章:熟悉 Objective-C

  • 语言根源与运行期组件:Objective-C 采用消息结构,运行时才查找要执行的方法;运行期组件是与开发者代码链接的动态库,包含面向对象所需的数据结构与函数,更新运行期组件即可提升应用性能。对象分配在、指针在;不含 * 的变量可能用栈,结构体保存非对象类型 [13]。
  • 头文件与向前声明:在类的头文件中尽量少引用其他头文件;若仅需声明某类型为属性,使用 向前声明@class EOCEmployer;),在 .m 中再 #import,可减少编译时间并避免循环引用。继承或遵从协议时必须在头文件中引入对应头文件 [14]。
  • 字面量与装箱:使用 @""@[]@{}@() 等字面量可减少冗长代码并降低错误;字面量若含 nil 会立即抛异常,而 arrayWithObjects:nil 会截断,易埋坑。字面量创建的集合为不可变 [2][14]。
  • 常量与枚举:用 static const(编译单元内可见)或 extern const(对外公开)定义常量,避免 #define(无类型、易被改)。对外常量命名建议带类名前缀;枚举用 NS_ENUM / NS_OPTIONSswitch 中不要写 default,以便新增枚举成员时编译器提示未处理 [2][14][15]。

4.2 第二章:对象、消息与运行时

4.2.1 属性与实例变量

属性(@property)是编译器自动生成存取器与(可选)实例变量的语法糖。要点 [2][4]:

  • 读写语义strong(默认对象)、copy(如 NSString/Block 防外部修改)、weak(避免循环引用)、assign(非对象类型)。
  • 原子性atomic(默认)在存取时加锁,多数场景下 nonatomic 更高效且足够;若需线程安全,应结合更高级的同步手段。
  • 属性关键字小结copy 用于 NSString/Block 等需拷贝语义的类型;unsafe_unretained 类似 assign 但用于对象,对象释放后不会清空;在非 setter 中给属性赋值时也需遵循其语义(如 copy 属性在 init 里应对传入值 copy)[13]。

4.2.2 对象相等性与 isEqual / hash

  • 相等性:若逻辑上「相等」需自定义,应实现 isEqual:hashhash 在对象被放入集合(如 NSSet、NSDictionary key)时使用,相等对象必须有相同 hash,反之不要求;hash 应稳定、计算量小 [2]。
  • 类簇(Class Cluster):公开接口是抽象基类(如 NSString、NSArray),实际返回私有子类实例。自定义子类需继承簇的「抽象基类」并实现其工厂方法所依赖的初始器;直接比较类时要注意类簇的多种子类 [2][4]。

4.2.3 关联对象(Associated Objects)

运行时允许在不修改类定义的前提下,给对象关联键值对。常用于:给分类「添加」存储、给系统类绑定上下文数据。需注意键的唯一性与内存语义(如 OBJC_ASSOCIATION_RETAIN_NONATOMIC)[2][4]。

4.2.4 objc_msgSend 与消息查找

[someObject messageName:parameter] 在底层转为 C 函数调用:objc_msgSend(someObject, @selector(messageName:), parameter)。该函数在接收者所属类及父类链的方法列表中查找与选择子相符的 IMP;找到则执行并缓存到类的快速映射表,下次同消息更快;找不到则进入消息转发 [3][13]。

4.2.5 消息转发(Message Forwarding)

当对象收到无法识别的消息时,运行时在报错前会给予二次机会 [3][12][13]:

  1. 动态方法解析+resolveInstanceMethod: / +resolveClassMethod:,可为该类动态添加方法实现(如 class_addMethod);典型应用是 @dynamic 属性 + 内部字典存储(EOCAutoDictionary 模式)。
  2. 快速转发-forwardingTargetForSelector:,返回备援接收者,运行期将消息转给该对象。
  3. 完整转发-methodSignatureForSelector:-forwardInvocation:,将消息封装为 NSInvocation,可修改目标、参数或返回值,实现代理、多继承等。

应用:代理对象、惰性加载大型对象、将未识别消息转发到后备对象等 [12]。

4.2.6 类对象与类型查询

运行期用 objc_class 结构描述类(含 isa、super_class、methodLists、cache 等)。isMemberOfClass: 判断是否为某特定类的实例;isKindOfClass: 判断是否为某类或其派生类的实例。从集合取出对象后往往需做类型判断再调用方法,避免向错误类型发消息 [13]。

4.2.7 Method Swizzling

通过运行时交换两个方法的实现(IMP),从而在不修改原类源码的情况下「注入」或「替换」行为;常用于 AOP、调试、无埋点统计。注意:交换应在 +load 等单次执行路径执行,并考虑继承与多线程安全 [2][4]。

4.3 第三章:接口与 API 设计

  • 命名:方法名应语义清晰、读起来像句子,如 initWithWidth:height: 优于 initWithSize::;布尔 getter 用 is/has 前缀(如 isEqualToString:hasPrefix:)。每个冒号左侧的方法部分最好与右侧参数名对应 [14]。
  • 指定初始化器(Designated Initializer):选定全能初始化方法(参数最多的那个),其他 init 及子类 init 均委托到它;子类若有自己的全能初始化器,需覆写父类的全能初始化器并转调自己的,避免用父类 init 产生非法状态(如 Square 覆写 initWithWidth:andHeight: 转调 initWithDimension:)。实现 initWithCoder: 时也应调用超类对应方法 [2][15]。
  • description:覆写 description 返回类名、地址与关键属性(或字典形式),便于调试时在控制台看到有意义信息 [15]。
  • 不可变优先:对外属性设为 readonly,在类扩展中改为 readwrite;集合对外暴露不可变类型(如 NSSet *friends),内部用 NSMutableSet,通过定制 addFriend:/removeFriend: 等接口修改,getter 返回 [_internalFriends copy],避免外部直接改底层数据 [14]。
  • 私有方法前缀:实现文件中的私有方法加前缀(如 p_privateMethod),便于与公共方法区分;不要用单下划线(与 Apple API 冲突)[14]。
  • NSError:用 NSError 封装错误域(domain)、错误码(code)、用户信息(userInfo);作为「输出参数」传递时用 (NSError **)error,调用方检查 *error;可定义 extern NSString *const EOCErrorDomainNS_ENUM 错误码 [13]。
  • NSCopying:实现 copyWithZone:(及可变版的 mutableCopyWithZone:);Foundation 集合默认浅拷贝,深拷贝需自己遍历并 copyItems:YES 或实现 deepCopy [13][15]。

4.4 第四章:协议与分类

  • 委托(Delegate):用 @protocol 定义回调接口,属性用 weak 避免循环引用;delegate 可选方法用 @optional,调用前先判断 delegate 是否存在再 respondsToSelector:,例如 if (_delegate && [_delegate respondsToSelector:@selector(...)]) { ... } [14]。委托模式与数据源模式:信息从类流向委托者 vs 从数据源流向类。
  • 分类(Category):按逻辑将类方法分散到多个分类(如 Friendship、Work、Play),便于管理;可为「私有方法」建 Private 分类。勿在分类中声明属性(仅 class-continuation 可增加实例变量);为第三方或系统类加分类时,分类名与方法名均加前缀(如 ABC_HTTP),避免覆盖原实现 [2][14]。
  • 类扩展(Class Continuation):在 .m 中的匿名分类,可遵循协议而不暴露、将只读属性改为读写、增加实例变量 [14]。
  • 匿名对象id<EOCDelegate> 表示「遵从某协议的对象」而非「某类的实例」,用作 delegate 属性或方法参数(如 setObject:forKey:(id<NSCopying>)key),强调协议契约 [15]。

4.5 第五章:内存管理

4.5.1 引用计数与 ARC

  • 所有权:谁创建(alloc/new/copy/mutableCopy)、谁持有;谁不再需要,谁释放(在 ARC 下由编译器插入)[5][6]。
  • ARC 规则:不能显式调用 retain/release/autorelease;不能使用 retainCount(仅调试用且不可靠);Core Foundation 与 Objective-C 对象混用需注意桥接(__bridge / __bridge_retained / __bridge_transfer)[5][7]。

4.5.2 循环引用与 weak

典型循环:对象 A 强引用 B,B 强引用 A(或通过 block/delegate 形成环)。解决:将其中一侧改为 weak(如 delegate、block 内对 self 的引用)[8][10]。

4.5.3 其他要点

  • dealloc:在 ARC 下仅用于释放 Core Foundation 对象(如 CFRelease)、移除 KVO/通知(如 removeObserver:self)等;不要在 dealloc 中调用其他方法或属性存取器,可能触发异步回调或 KVO 导致使用已释放对象 [2][5][14]。
  • autorelease 池:对象 autorelease 后在下一次事件循环清空池时才会 release;在循环中创建大量临时对象时,在循环内使用 @autoreleasepool { ... }降低内存峰值 [5][8][15]。
  • 僵尸对象(Zombie):开启后,已释放对象的 isa 被改为指向特殊僵尸类,不回收内存、不覆写;再次向该对象发消息会抛出异常并描述原对象与消息,便于排查野指针 [2][6][15]。
  • retainCount:不应使用;ARC 下已废弃,且其返回值只能反映某一时刻的计数,无法反映自动释放池等后续变化 [14]。
  • 异常安全:MRC 下 try 中 retain 的对象若在 release 前抛异常会泄漏,应在 @finally 中 release;ARC 下需 -fobjc-arc-exceptions 才会在异常路径插入清理代码,会增大体积并影响性能 [15]。

4.6 第六章:Block 与 GCD

4.6.1 Block 类型与循环引用

  • Block 三种类型栈 block(定义时在栈上,离开作用域可能失效);堆 block(对栈 block 发 copy 后拷贝到堆,带引用计数);全局 block(不捕获外部变量时可为全局块)。需长期持有的 block 应 copy 到堆 [13][15]。
  • Block 会捕获其使用的局部变量;对对象默认是强引用。若 block 被当前对象持有(如属性、成员变量),且 block 内又使用了 self_ivar(等价于 self),则形成循环引用 [9][10]。
  • 规范写法:在 block 外先 __weak typeof(self) weakSelf = self;,在 block 内使用 weakSelf;若需在 block 执行过程中保证 self 存活,可在 block 内再 __strong typeof(weakSelf) strongSelf = weakSelf; 后使用 strongSelf(weak–strong dance)。也可在 block 末尾将持有 block 的成员置为 nil 以打破环(如 completion 内 _networkFetcher = nil)[10][15]。
  • handler block 与 typedef:用 completion handler 块替代 delegate 回调可让「发起请求」与「处理结果」写在一起;对常用块签名使用 typedef void(^EOCCompletionHandler)(NSData *data, NSError *error); 便于复用与修改 [15]。

4.6.2 GCD 队列与任务

  • 队列类型:串行队列(同一时间只执行一个任务)、并发队列(可多任务并发);主队列(main queue)为串行,用于 UI 更新。不要使用 dispatch_get_current_queue 判断「当前队列」,因队列有层级关系,结果不可靠 [11][14]。
  • 常用 APIdispatch_asyncdispatch_syncdispatch_afterdispatch_once(单例等)、dispatch_group_async + dispatch_group_notify(多任务完成后汇总)[2][11][15]。
  • 同步与锁:可用串行队列统一读写(读写都 dispatch_sync 到同一队列);或并发队列 + dispatch_barrier_async 写、普通 async/sync 读,保证写互斥、读可并发 [15]。
  • 与 performSelector 对比:GCD 不依赖 selector、可传多参数与返回值;延后执行用 dispatch_after,回主线程用 dispatch_async(main_queue, ^{ ... }),替代 performSelector:withObject:afterDelay:performSelectorOnMainThread: [2][15]。
  • NSOperation 适用场景:需取消任务、设置依赖、指定优先级或 KVO 监听 isFinished/isCancelled 时,用 NSOperationQueue 更合适;GCD 为「fire and forget」[15]。

4.7 第七章:系统框架

  • 块枚举:使用 enumerateObjectsUsingBlock: 可获下标、键值对及 *stop 提前终止;比 for 循环简洁,且可修改块签名以做类型检查。遍历 Dictionary/Set 时无需先 allKeys/allObjects 再遍历,减少临时数组 [2][14]。
  • NSCache:线程安全、不拷贝 key(保留)、内存紧张时自动删减(含「最久未用」策略);可设置 countLimittotalCostLimit。与 NSPurgeableData 配合时,访问前 beginContentAccess、用毕 endContentAccess,便于系统回收内存 [2][14]。
  • +load 与 +initialize+load 在类/分类加入运行期时各调用一次,尽量不要在 load 里调用其他类(加载顺序未定义)。+initialize 在类首次收到消息前调用,子类未实现会调用父类,因此需判断 if (self == [EOCBaseClass class]) 再执行逻辑,避免子类触发父类 initialize [2][4][14]。
  • NSTimer:会强引用 target,若 target 是 self 且 self 又持有 timer,则形成保留环;dealloc 中 invalidate 可能无法执行(因环未打破)。推荐:用 NSTimer 的 block 封装(Category 提供 eoc_scheduledTimerWithTimeInterval:block:repeats:,timer 的 target 为类对象,userInfo 存 [block copy]),在 block 内用 weakSelf/strongSelf 调用业务逻辑,这样 self 释放后 block 中 weakSelf 为 nil,或 dealloc 中 invalidate 即可打破环 [2][14]。
  • 无缝桥接:Foundation 与 Core Foundation 间用 __bridge(不转移所有权)、__bridge_retained__bridge_transfer 转换;创建 CF 集合时可指定回调以自定义内存管理语义,再桥接到 OC 使用 [15]。

五、关键概念图示与流程

5.1 消息发送与查找流程

Objective-C 中 [obj message] 在运行时转化为 objc_msgSend(obj, selector, ...),随后在类的方法表及父类链中查找 IMP;若未找到,进入消息转发 [3][4]。

flowchart TD
    A[obj 收到消息] --> B{在类及父类中查找 IMP}
    B -->|找到| C[调用 IMP]
    B -->|未找到| D[动态方法解析 resolveInstanceMethod:]
    D --> E{添加方法?}
    E -->|是| C
    E -->|否| F[forwardingTargetForSelector:]
    F --> G{返回非 nil 目标?}
    G -->|是| H[向目标转发消息]
    G -->|否| I[methodSignatureForSelector: + forwardInvocation:]
    I --> J[开发者可转发到其他对象或处理]

5.2 消息转发(forwardInvocation)概念

当使用 forwardInvocation: 时,运行时将原始消息封装为 NSInvocation,传给接收者;接收者可修改目标、参数或返回值,实现「代理」「多继承」等 [12]。

sequenceDiagram
    participant C as 调用方
    participant R as 接收者
    participant T as 转发目标

    C->>R: 发送未知消息
    R->>R: methodSignatureForSelector:
    R->>R: forwardInvocation:(invocation)
    R->>T: [invocation invokeWithTarget:T]
    T-->>R: 返回值
    R-->>C: 返回

5.3 引用计数与所有权(概念)

flowchart LR
    subgraph 创建
        A[alloc/new/copy] --> B[引用计数 = 1]
    end
    subgraph 持有
        B --> C[retain +1]
        C --> D[release -1]
    end
    subgraph 释放
        D --> E{计数 = 0?}
        E -->|是| F[dealloc 释放对象]
        E -->|否| G[仍存活]
    end

5.4 Block 循环引用

flowchart LR
    subgraph 循环
        S[self] --> B[block]
        B --> S
    end
    subgraph 打破
        W[weakSelf] --> B2[block]
        S2[self] -.->|弱引用| W
        B2 -.->|捕获 weakSelf| W
    end

5.5 GCD 队列层次(概念)

flowchart TB
    subgraph 主队列
        M[Main Queue - UI]
    end
    subgraph 全局并发队列
        G[Global Concurrent Queue]
    end
    subgraph 自定义
        Q1[Serial Queue]
        Q2[Concurrent Queue]
    end
    M --> G
    G --> Q1
    G --> Q2

六、伪代码与算法说明

6.1 对象相等性与 hash(约定)

约定(Effective Objective-C 与 Cocoa 惯例):
1. 若 [a isEqual:b] 为 YES,则 [a hash] == [b hash] 必须成立。
2. hash 在对象生命周期内应稳定(不变)。
3. hash 不必唯一,但应尽量均匀以减少冲突。

算法(示例,仅说明思路):
- 对关键属性分别求 hash(如 NSString 的 hash、数值的 hash),再组合(如异或、乘质数相加)。
- 避免在 hash 中做重计算或依赖可变状态。

6.2 weak–strong 避免 Block 循环引用(伪代码)

// 错误:block 被 self 持有,block 内又强引用 self
self.block = ^{ [self doSomething]; };  // 循环引用

// 正确:block 外 weak,block 内 strong(可选,防止执行过程中 self 被释放)
__weak typeof(self) weakSelf = self;
self.block = ^{
    __strong typeof(weakSelf) strongSelf = weakSelf;
    if (strongSelf) { [strongSelf doSomething]; }
};

6.3 dispatch_once 单例(典型写法)

+ (instancetype)sharedInstance {
    static MyClass *instance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instance = [[MyClass alloc] init];
    });
    return instance;
}
// dispatch_once 保证块只执行一次,且线程安全。

6.4 forwardInvocation 转发到后备对象(伪代码)

// 根据 Apple 文档 [12],简化实现思路:
- (NSMethodSignature *)methodSignatureForSelector:(SEL)selector {
    NSMethodSignature *sig = [super methodSignatureForSelector:selector];
    if (!sig) sig = [backupObject methodSignatureForSelector:selector];
    return sig;
}
- (void)forwardInvocation:(NSInvocation *)invocation {
    if ([backupObject respondsToSelector:[invocation selector]])
        [invocation invokeWithTarget:backupObject];
    else
        [super forwardInvocation:invocation];
}

七、应用场景与最佳实践

7.1 场景与条目对照

场景 本书建议概要 典型条目
网络/异步回调 使用 Block + GCD,避免 performSelector;在 block 内用 weak–strong 避免循环引用 37–40, 42–43
自定义集合元素 实现 isEqual: 与 hash;若需复制实现 NSCopying 8, 22
为系统类添加方法 用 Category,方法名加前缀;需存储用关联对象或类扩展 25–26
单例或一次性初始化 dispatch_once 45
缓存图片/数据 NSCache,不手写 NSDictionary + 淘汰 50
定时任务 NSTimer 注意与 target 的循环引用,及时 invalidate 或拆开 52
调试内存/野指针 僵尸对象、Instruments、静态分析 35–36
多任务完成后统一处理 dispatch_group + dispatch_group_notify 44

7.2 高级应用场景简述

  • AOP / 无埋点:通过 Method Swizzling 在系统或业务方法前后插入逻辑(如统计、日志),需注意交换时机与线程安全;可与 +load 配合 [2][4]。
  • 跨框架混用(Core Foundation ↔ Objective-C):使用 __bridge(不转移所有权)、__bridge_retained(CF 侧持有)、__bridge_transfer(OC 侧持有)正确管理生命周期,避免重复释放或泄漏 [5][7]。
  • 大循环中的临时对象:在循环内使用 @autoreleasepool { ... } 及时排空自动释放池,降低内存峰值 [5][8]。
  • 委托与数据源:delegate 属性声明为 weak,在 dealloc 中无需显式置 nil(weak 会自动清空);调用可选方法前用 respondsToSelector: 判断 [2]。

八、其它补充

第2条: 在类的头文件中尽量少引用其他头文件

有时,类A需要将类B的实例变量作为它公共API的属性。这个时候,我们不应该引入类B的头文件,而应该使用向前声明(forward declaring)使用class关键字,并且在A的实现文件引用B的头文件。

// EOCPerson.h
#import <Foundation/Foundation.h>

@class EOCEmployer;

@interface EOCPerson : NSObject

@property (nonatomic, copy) NSString *firstName;
@property (nonatomic, copy) NSString *lastName;
@property (nonatomic, strong) EOCEmployer *employer;//将EOCEmployer作为属性

@end

// EOCPerson.m
#import "EOCEmployer.h"

这样做有什么优点呢:

  • 不在A的头文件中引入B的头文件,就不会一并引入B的全部内容,这样就减少了编译时间。
  • 可以避免循环引用:因为如果两个类在自己的头文件中都引入了对方的头文件,那么就会导致其中一个类无法被正确编译。

但是个别的时候,必须在头文件中引入其他类的头文件:

主要有两种情况:

  1. 该类继承于某个类,则应该引入父类的头文件。
  2. 该类遵从某个协议,则应该引入该协议的头文件。而且最好将协议单独放在一个头文件中。

第3条:多用字面量语法,少用与之等价的方法

1. 声明时的字面量语法:

在声明NSNumber,NSArray,NSDictionary时,应该尽量使用简洁字面量语法。

NSNumber *intNumber = @1;
NSNumber *floatNumber = @2.5f;
NSArray *animals =[NSArray arrayWithObjects:@"cat", @"dog",@"mouse", @"badger", nil];
Dictionary *dict = @{@"animal":@"tiger",@"phone":@"iPhone 6"};

2. 集合类取下标的字面量语法:

NSArray,NSDictionary,NSMutableArray,NSMutableDictionary 的取下标操作也应该尽量使用字面量语法。

NSString *cat = animals[0];
NSString *iphone = dict[@"phone"];

使用字面量语法的优点:

  1. 代码看起来更加简洁。
  2. 如果存在nil值,则会立即抛出异常。如果在不用字面量语法定义数组的情况下,如果数组内部存在nil,则系统会将其设为数组最后一个元素并终止。所以当这个nil不是最后一个元素的话,就会出现难以排查的错误。

注意: 字面量语法创建出来的字符串,数组,字典对象都是不可变的。

第4条:多用类型常量,少用#define预处理命令

在OC中,定义常量通常使用预处理命令,但是并不建议使用它,而是使用类型常量的方法。 首先比较一下这两种方法的区别:

  • 预处理命令:简单的文本替换,不包括类型信息,并且可被任意修改。
  • 类型常量:包括类型信息,并且可以设置其使用范围,而且不可被修改。

我们可以看出来,使用预处理虽然能达到替换文本的目的,但是本身还是有局限性的:不具备类型 + 可以被任意修改,总之给人一种不安全的感觉。

知道了它们的长短处,我们再来简单看一下它们的具体使用方法:

预处理命令:

#define W_LABEL (W_SCREEN - 2*GAP)

这里,(W_SCREEN - 2*GAP)替换了W_LABEL,它不具备W_LABEL的类型信息。而且要注意一下:如果替换式中存在运算符号,以笔者的经验最好用括号括起来,不然容易出现错误(有体会)。

类型常量:

static const NSTimeIntervalDuration = 0.3;

这里: const 将其设置为常量,不可更改。 static意味着该变量仅仅在定义此变量的编译单元中可见。如果不声明static,编译器会为它创建一个外部符号(external symbol)。我们来看一下对外公开的常量的声明方法:

对外公开某个常量:

如果我们需要发送通知,那么就需要在不同的地方拿到通知的“频道”字符串,那么显然这个字符串是不能被轻易更改,而且可以在不同的地方获取。这个时候就需要定义一个外界可见的字符串常量。

//header file
extern NSString *const NotificationString;

//implementation file
NSString *const  NotificationString = @"Finish Download";

这里NSString *const NotificationString是指针常量。 extern关键字告诉编译器,在全局符号表中将会有一个名叫NotificationString的符号。

我们通常在头文件声明常量,在其实现文件里定义该常量。由实现文件生成目标文件时,编译器会在“数据段”为字符串分配存储空间。

最后注意一下公开和非公开的常量的命名规范:

公开的常量:常量的名字最好用与之相关的类名做前缀。 非公开的常量:局限于某个编译单元(tanslation unit,实现文件 implementation file)内,在签名加上字母k。

第5条:用枚举表示状态,选项,状态码

我们经常需要给类定义几个状态,这些状态码可以用枚举来管理。下面是关于网络连接状态的状态码枚举:

typedef NS_ENUM(NSUInteger, EOCConnectionState) {
  EOCConnectionStateDisconnected,
  EOCConnectionStateConnecting,
  EOCConnectionStateConnected,
};

需要注意的一点是: 在枚举类型的switch语句中不要实现default分支。它的好处是,当我们给枚举增加成员时,编译器就会提示开发者:switch语句并未处理所有的枚举。对此,笔者有个教训,又一次在switch语句中将“默认分支”设置为枚举中的第一项,自以为这样写可以让程序更健壮,结果后来导致了严重的崩溃。

第21条:理解Objective-C错误类型

在OC中,我们可以用NSError描述错误。 使用NSError可以封装三种信息:

  • Error domain:错误范围,类型是字符串
  • Error code :错误码,类型是整数
  • User info:用户信息,类型是字典

1. NSError的使用

用法:

1.通过委托协议来传递NSError,告诉代理错误类型。

- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error

2.作为方法的“输出参数”返回给调用者

- (BOOL)doSomething:(NSError**)error

使用范例:


NSError *error = nil;
BOOL ret = [object doSomething:&error];

if (error) {
    // There was an error
}

2. 自定义NSError

我们可以设置属于我们自己程序的错误范围和错误码

  • 错误范围可以用全局常量字符串来定义。
  • 错误码可以用枚举来定义。

// EOCErrors.h
extern NSString *const EOCErrorDomain;

//定义错误码
typedef NS_ENUM(NSUInteger, EOCError) {

    EOCErrorUnknown = –1,
    EOCErrorInternalInconsistency = 100,
    EOCErrorGeneralFault = 105,
    EOCErrorBadInput = 500,
};



// EOCErrors.m
NSString *const EOCErrorDomain = @"EOCErrorDomain"; //定义错误范围

第22条:理解NSCopying协议

如果我们想令自己的类支持拷贝操作,那就要实现NSCopying协议,该协议只有一个方法:

- (id)copyWithZone:(NSZone*)zone

作者举了个:


- (id)copyWithZone:(NSZone*)zone {

     EOCPerson *copy = [[[self class] allocWithZone:zone] initWithFirstName:_firstName  andLastName:_lastName];
    copy->_friends = [_friends mutableCopy];
     return copy;
}

之所以是copy->_friends,而不是copy.friends是因为friends并不是属性,而是一个内部使用的实例变量。

1. 复制可变的版本:

遵从协议

而且要执行:

- (id)mutableCopyWithZone:(NSZone*)zone;

注意:拷贝可变型和不可变型发送的是copymutableCopy消息,而我们实现的却是- (id)copyWithZone:(NSZone*)zone- (id)mutableCopyWithZone:(NSZone*)zone 方法。

而且,如果我们想获得某对象的不可变型,统一调用copy方法;获得某对象的可变型,统一调用mutableCopy方法。

例如数组的拷贝:

-[NSMutableArray copy] => NSArray
-[NSArray mutableCopy] => NSMutableArray

2. 浅拷贝和深拷贝

Foundation框架中的集合类默认都执行浅拷贝:只拷贝容器对象本身,而不复制其中的数据。 而深拷贝的意思是连同对象本身和它的底层数据都要拷贝。

作者用一个图很形象地体现了浅拷贝和深拷贝的区别:

图片来自:《Effective Objective-C》

浅拷贝后的内容和原始内容指向同一个对象 深拷贝后的内容所指的对象是原始内容对应对象的拷贝

3. 如何深拷贝?

我们需要自己编写深拷贝的方法:遍历每个元素并复制,然后将复制后的所有元素重新组成一个新的集合。

- (id)initWithSet:(NSArray*)array copyItems:(BOOL)copyItems;

在这里,我们自己提供了一个深拷贝的方法:该方法需要传入两个参数:需要拷贝的数组和是否拷贝元素(是否深拷贝)


- (id)deepCopy {
       EOCPerson *copy = [[[self class] alloc] initWithFirstName:_firstName andLastName:_lastName];
        copy->_friends = [[NSMutableSet alloc] initWithSet:_friends copyItems:YES];
        return copy;
}

第47条:熟悉系统框架

如果我们使用了系统提供的现成的框架,那么用户在升级系统后,就可以直接享受系统升级所带来的改进。

主要的系统框架:

  • Foundation:NSObject,NSArray,NSDictionary等
  • CFoundation框架:C语言API,Foundation框架中的许多功能,都可以在这里找到对应的C语言API
  • CFNetwork框架:C语言API,提供了C语言级别的网络通信能力
  • CoreAudio:C语言API,操作设备上的音频硬件
  • AVFoundation框架:提供的OC对象可以回放并录制音频和视频
  • CoreData框架:OC的API,将对象写入数据库
  • CoreText框架:C语言API,高效执行文字排版和渲染操作

用C语言来实现API的好处:可以绕过OC的运行期系统,从而提升执行速度

第7条: 在对象内部尽量直接访问实例变量

关于实例变量的访问,可以直接访问,也可以通过属性的方式(点语法)来访问。书中作者建议在读取实例变量时采用直接访问的形式,而在设置实例变量的时候通过属性来做。

1. 直接访问属性的特点:

  • 绕过set,get语义,速度快;

2. 通过属性访问属性的特点:

  • 不会绕过属性定义的内存管理语义
  • 有助于打断点排查错误
  • 可以触发KVO

因此,有个关于折中的方案:

设置属性:通过属性 读取属性:直接访问

不过有两个特例:

  1. 初始化方法和dealloc方法中,需要直接访问实例变量来进行设置属性操作。因为如果在这里没有绕过set方法,就有可能触发其他不必要的操作。
  2. 惰性初始化(lazy initialization)的属性,必须通过属性来读取数据。因为惰性初始化是通过重写get方法来初始化实例变量的,如果不通过属性来读取该实例变量,那么这个实例变量就永远不会被初始化。

第15条:用前缀 避免命名空间冲突

Apple宣称其保留使用所有"两字母前缀"的权利,所以我们选用的前缀应该是三个字母的。 而且,如果自己开发的程序使用到了第三方库,也应该加上前缀。

第18条:尽量使用不可变对象

书中作者建议尽量把对外公布出来的属性设置为只读,在实现文件内部设为读写。具体做法是:

在头文件中,设置对象属性为readonly,在实现文件中设置为readwrite。这样一来,在外部就只能读取该数据,而不能修改它,使得这个类的实例所持有的数据更加安全。

而且,对于集合类的对象,更应该仔细考虑是否可以将其设为可变的。

如果在公开部分只能设置其为只读属性,那么就在非公开部分存储一个可变型。这样一来,当在外部获取这个属性时,获取的只是内部可变型的一个不可变版本,例如:

在公共API中:

@interface EOCPerson : NSObject

@property (nonatomic, copy, readonly) NSString *firstName;
@property (nonatomic, copy, readonly) NSString *lastName;
@property (nonatomic, strong, readonly) NSSet *friends //向外公开的不可变集合

- (id)initWithFirstName:(NSString*)firstName lastName:(NSString*)lastName;
- (void)addFriend:(EOCPerson*)person;
- (void)removeFriend:(EOCPerson*)person;

@end

在这里,我们将friends属性设置为不可变的set。然后,提供了来增加和删除这个set里的元素的公共接口。

在实现文件里:

@interface EOCPerson ()

@property (nonatomic, copy, readwrite) NSString *firstName;
@property (nonatomic, copy, readwrite) NSString *lastName;

@end

@implementation EOCPerson {
     NSMutableSet *_internalFriends;  //实现文件里的可变集合
}

- (NSSet*)friends {
     return [_internalFriends copy]; //get方法返回的永远是可变set的不可变型
}

- (void)addFriend:(EOCPerson*)person {
    [_internalFriends addObject:person]; //在外部增加集合元素的操作
    //do something when add element
}

- (void)removeFriend:(EOCPerson*)person {
    [_internalFriends removeObject:person]; //在外部移除元素的操作
    //do something when remove element
}

- (id)initWithFirstName:(NSString*)firstName lastName:(NSString*)lastName {

     if ((self = [super init])) {
        _firstName = firstName;
        _lastName = lastName;
        _internalFriends = [NSMutableSet new];
    }
 return self;
}

我们可以看到,在实现文件里,保存一个可变set来记录外部的增删操作。

这里最重要的代码是:

- (NSSet*)friends {
 return [_internalFriends copy];
}

这个是friends属性的获取方法:它将当前保存的可变set复制了一不可变的set并返回。因此,外部读取到的set都将是不可变的版本。

等一下,有个疑问:

在公共接口设置不可变set 和 将增删的代码放在公共接口中是否矛盾的?

答案:并不矛盾!

因为如果将friends属性设置为可变的,那么外部就可以随便更改set集合里的数据,这里的更改,仅仅是底层数据的更改,并不伴随其他任何操作。 然而有时,我们需要在更改set数据的同时要执行隐秘在实现文件里的其他工作,那么如果在外部随意更改这个属性的话,显然是达不到这种需求的。

因此,我们需要提供给外界我们定制的增删的方法,并不让外部”自行“增删。

第19条:使用清晰而协调的命名方式

在给OC的方法取名字的时候要充分利用OC方法的命名优势,取一个语义清晰的方法名!什么叫语义清晰呢?就是说读起来像是一句话一样。

我们看一个例子:

先看名字取得不好的:

//方法定义
- (id)initWithSize:(float)width :(float)height;

//方法调用
EOCRectangle *aRectangle =[[EOCRectangle alloc] initWithSize:5.0f :10.0f];

这里定义了Rectangle的初始化方法。虽然直观上可以知道这个方法通过传入的两个参数来组成矩形的size,但是我们并不知道哪个是矩形的宽,哪个是矩形的高。 来看一下正确的🌰 :

//方法定义
- (id)initWithWidth:(float)width height:(float)height;

//方法调用
EOCRectangle *aRectangle =[[EOCRectangle alloc] initWithWidth:5.0f height:10.0f];

这个方法名就很好的诠释了该方法的意图:这个类的初始化是需要宽度和高度的。而且,哪个参数是高度,哪个参数是宽度,看得人一清二楚。永远要记得:代码是给人看的

笔者自己总结的方法命名规则:

每个冒号左边的方法部分最好与右边的参数名一致。

对于返回值是布尔值的方法,我们也要注意命名的规范:

  • 获取”是否“的布尔值,应该增加“is”前缀:

- isEqualToString:

获取“是否有”的布尔值,应该增加“has”前缀:

- hasPrefix:

第20条:为私有方法名加前缀

建议在实现文件里将非公开的方法都加上前缀,便于调试,而且这样一来也很容易区分哪些是公共方法,哪些是私有方法。因为往往公共方法是不便于任意修改的。

在这里,作者举了个例子:

#import <Foundation/Foundation.h>

@interface EOCObject : NSObject

- (void)publicMethod;

@end


@implementation EOCObject

- (void)publicMethod {
 /* ... */
}

- (void)p_privateMethod {
 /* ... */
}

@end

注意: 不要用下划线来区分私有方法和公共方法,因为会和苹果公司的API重复。

第23条:通过委托与数据源协议进行对象间通信

如果给委托对象发送消息,那么必须提前判断该委托对象是否实现了该消息:

NSData *data = /* data obtained from network */;

if ([_delegate respondsToSelector: @selector(networkFetcher:didReceiveData:)])
{
        [_delegate networkFetcher:self didReceiveData:data];
}

而且,最好再加上一个判断:判断委托对象是否存在


NSData *data = /* data obtained from network */;

if ( (_delegate) && ([_delegate respondsToSelector: @selector(networkFetcher:didReceiveData:)]))
{
        [_delegate networkFetcher:self didReceiveData:data];
}

对于代理模式,在iOS中分为两种:

  • 普通的委托模式:信息从类流向委托者
  • 信息源模式:信息从数据源流向类

普通的委托 | 信息源

就好比tableview告诉它的代理(delegate)“我被点击了”;而它的数据源(data Source)告诉它“你有这些数据”。仔细回味一下,这两个信息的传递方向是相反的。

第24条:将类的实现代码分散到便于管理的数个分类中

通常一个类会有很多方法,而这些方法往往可以用某种特有的逻辑来分组。我们可以利用OC的分类机制,将类的这些方法按一定的逻辑划入几个分区中。

例子:

无分类的类:

#import <Foundation/Foundation.h>

@interface EOCPerson : NSObject

@property (nonatomic, copy, readonly) NSString *firstName;
@property (nonatomic, copy, readonly) NSString *lastName;
@property (nonatomic, strong, readonly) NSArray *friends;

- (id)initWithFirstName:(NSString*)firstName lastName:(NSString*)lastName;

/* Friendship methods */
- (void)addFriend:(EOCPerson*)person;
- (void)removeFriend:(EOCPerson*)person;
- (BOOL)isFriendsWith:(EOCPerson*)person;


/* Work methods */
- (void)performDaysWork;
- (void)takeVacationFromWork;


/* Play methods */
- (void)goToTheCinema;
- (void)goToSportsGame;


@end

分类之后:

#import <Foundation/Foundation.h>


@interface EOCPerson : NSObject

@property (nonatomic, copy, readonly) NSString *firstName;
@property (nonatomic, copy, readonly) NSString *lastName;
@property (nonatomic, strong, readonly) NSArray *friends;



- (id)initWithFirstName:(NSString*)firstName

lastName:(NSString*)lastName;

@end



@interface EOCPerson (Friendship)

- (void)addFriend:(EOCPerson*)person;
- (void)removeFriend:(EOCPerson*)person;
- (BOOL)isFriendsWith:(EOCPerson*)person;

@end



@interface EOCPerson (Work)

- (void)performDaysWork;
- (void)takeVacationFromWork;

@end



@interface EOCPerson (Play)

- (void)goToTheCinema;
- (void)goToSportsGame;

@end

其中,FriendShip分类的实现代码可以这么写:


// EOCPerson+Friendship.h
#import "EOCPerson.h"


@interface EOCPerson (Friendship)

- (void)addFriend:(EOCPerson*)person;
- (void)removeFriend:(EOCPerson*)person;
- (BOOL)isFriendsWith:(EOCPerson*)person;

@end


// EOCPerson+Friendship.m
#import "EOCPerson+Friendship.h"


@implementation EOCPerson (Friendship)

- (void)addFriend:(EOCPerson*)person {
 /* ... */
}

- (void)removeFriend:(EOCPerson*)person {
 /* ... */
}

- (BOOL)isFriendsWith:(EOCPerson*)person {
 /* ... */
}

@end

注意:在新建分类文件时,一定要引入被分类的类文件。

通过分类机制,可以把类代码分成很多个易于管理的功能区,同时也便于调试。因为分类的方法名称会包含分类的名称,可以马上看到该方法属于哪个分类中。

利用这一点,我们可以创建名为Private的分类,将所有私有方法都放在该类里。这样一来,我们就可以根据private一词的出现位置来判断调用的合理性,这也是一种编写“自我描述式代码(self-documenting)”的办法。

第25条:总是为第三方类的分类名称加前缀

分类机制虽然强大,但是如果分类里的方法与原来的方法名称一致,那么分类的方法就会覆盖掉原来的方法,而且总是以最后一次被覆盖为基准。

因此,我们应该以命名空间来区别各个分类的名称与其中定义的方法。在OC里的做法就是给这些方法加上某个共用的前缀。例如:

@interface NSString (ABC_HTTP)

// Encode a string with URL encoding
- (NSString*)abc_urlEncodedString;

// Decode a URL encoded string
- (NSString*)abc_urlDecodedString;

@end

因此,如果我们想给第三方库或者iOS框架里的类添加分类时,最好将分类名和方法名加上前缀。

第26条:勿在分类中声明属性

除了实现文件里的class-continuation分类中可以声明属性外,其他分类无法向类中新增实例变量。

因此,类所封装的全部数据都应该定义在主接口中,这里是唯一能够定义实例变量的地方。

关于分类,需要强调一点:

分类机制,目标在于扩展类的功能,而不是封装数据。

第27条:使用class-continuation分类 隐藏实现细节

通常,我们需要减少在公共接口中向外暴露的部分(包括属性和方法),而因此带给我们的局限性可以利用class-continuation分类的特性来补偿:

  • 可以在class-continuation分类中增加实例变量。
  • 可以在class-continuation分类中将公共接口的只读属性设置为读写。
  • 可以在class-continuation分类中遵循协议,使其不为人知。

第31条:在dealloc方法中只释放引用并解除监听

永远不要自己调用dealloc方法,运行期系统会在适当的时候调用它。根据性能需求我们有时需要在dealloc方法中做一些操作。那么我们可以在dealloc方法里做什么呢?

  • 释放对象所拥有的所有引用,不过ARC会自动添加这些释放代码,可以不必操心。
  • 而且对象拥有的其他非OC对象也要释放(CoreFoundation对象就必须手动释放)
  • 释放原来的观测行为:注销通知。如果没有及时注销,就会向其发送通知,使得程序崩溃。

举个简单的🌰 :


- (void)dealloc {

     CFRelease(coreFoundationObject);
    [[NSNotificationCenter defaultCenter] removeObserver:self];

}

尤其注意:在dealloc方法中不应该调用其他的方法,因为如果这些方法是异步的,并且回调中还要使用当前对象,那么很有可能当前对象已经被释放了,会导致崩溃。

并且在dealloc方法中也不能调用属性的存取方法,因为很有可能在这些方法里还有其他操作。而且这个属性还有可能处于键值观察状态,该属性的观察者可能会在属性改变时保留或者使用这个即将回收的对象。

第36条:不要使用retainCount

在非ARC得环境下使用retainCount可以返回当前对象的引用计数,但是在ARC环境下调用会报错,因为该方法已经被废弃了 。

它被废弃的原因是因为它所返回的引用计数只能反映对象某一时刻的引用计数,而无法“预知”对象将来引用计数的变化(比如对象当前处于自动释放池中,那么将来就会自动递减引用计数)。

第46条:不要使用dispatch_get_current_queue

我们无法用某个队列来描述“当前队列”这一属性,因为派发队列是按照层级来组织的。

那么什么是队列的层级呢?

队列的层及分布

安排在某条队列中的快,会在其上层队列中执行,而层级地位最高的那个队列总是全局并发队列。

在这里,B,C中的块会在A里执行。但是D中的块,可能与A里的块并行,因为A和D的目标队列是并发队列。

正因为有了这种层级关系,所以检查当前队列是并发的还是非并发的就不会总是很准确。

第48条:多用块枚举,少用for循环

当遍历集合元素时,建议使用块枚举,因为相对于传统的for循环,它更加高效,而且简洁,还能获取到用传统的for循环无法提供的值:

我们首先看一下传统的遍历:

1. 传统的for遍历

NSArray *anArray = /* ... */;
for (int i = 0; i < anArray.count; i++) {
   id object = anArray[i];
   // Do something with 'object'
}



// Dictionary
NSDictionary *aDictionary = /* ... */;
NSArray *keys = [aDictionary allKeys];
for (int i = 0; i < keys.count; i++) {
   id key = keys[i];
   id value = aDictionary[key];
   // Do something with 'key' and 'value'
}


// Set
NSSet *aSet = /* ... */;
NSArray *objects = [aSet allObjects];
for (int i = 0; i < objects.count; i++) {
   id object = objects[i];
   // Do something with 'object'

}

我们可以看到,在遍历NSDictionary,和NSet时,我们又新创建了一个数组。虽然遍历的目的达成了,但是却加大了系统的开销。

2. 利用快速遍历:

NSArray *anArray = /* ... */;
for (id object in anArray) {
 // Do something with 'object'
}

// Dictionary
NSDictionary *aDictionary = /* ... */;
for (id key in aDictionary) {
 id value = aDictionary[key];
 // Do something with 'key' and 'value'

}


NSSet *aSet = /* ... */;
for (id object in aSet) {
 // Do something with 'object'
}

这种快速遍历的方法要比传统的遍历方法更加简洁易懂,但是缺点是无法方便获取元素的下标。

3. 利用基于block的遍历:

NSArray *anArray = /* ... */;
[anArray enumerateObjectsUsingBlock:^(id object, NSUInteger idx, BOOL *stop){

   // Do something with 'object'
   if (shouldStop) {
      *stop = YES; //使迭代停止
  }

}];


“// Dictionary
NSDictionary *aDictionary = /* ... */;
[aDictionary enumerateKeysAndObjectsUsingBlock:^(id key, id object, BOOL *stop){
     // Do something with 'key' and 'object'
     if (shouldStop) {
        *stop = YES;
    }
}];


// Set
NSSet *aSet = /* ... */;
[aSet enumerateObjectsUsingBlock:^(id object, BOOL *stop){
     // Do something with 'object'
     if (shouldStop) {
        *stop = YES;
    }
];

我们可以看到,在使用块进行快速枚举的时候,我们可以不创建临时数组。虽然语法上没有快速枚举简洁,但是我们可以获得数组元素对应的序号,字典元素对应的键值,而且,我们还可以随时令遍历终止。

利用快速枚举和块的枚举还有一个优点:能够修改块的方法签名

for (NSString *key in aDictionary) {
         NSString *object = (NSString*)aDictionary[key];
        // Do something with 'key' and 'object'
}

NSDictionary *aDictionary = /* ... */;

    [aDictionary enumerateKeysAndObjectsUsingBlock:^(NSString *key, NSString *obj, BOOL *stop){

             // Do something with 'key' and 'obj'

}];

第50条:构建缓存时选用NSCache 而非NSDictionary

如果我们缓存使用得当,那么应用程序的响应速度就会提高。只有那种“重新计算起来很费事的数据,才值得放入缓存”,比如那些需要从网络获取或从磁盘读取的数据。

在构建缓存的时候很多人习惯用NSDictionary或者NSMutableDictionary,但是作者建议大家使用NSCache,它作为管理缓存的类,有很多特点要优于字典,因为它本来就是为了管理缓存而设计的。

1. NSCache优于NSDictionary的几点:

  • 当系统资源将要耗尽时,NSCache具备自动删减缓冲的功能。并且还会先删减“最久未使用”的对象。
  • NSCache不拷贝键,而是保留键。因为并不是所有的键都遵从拷贝协议(字典的键是必须要支持拷贝协议的,有局限性)。
  • NSCache是线程安全的:不编写加锁代码的前提下,多个线程可以同时访问NSCache。

2. 关于操控NSCache删减内容的时机

开发者可以通过两个尺度来调整这个时机:

  • 缓存中的对象总数.
  • 将对象加入缓存时,为其指定开销值。

对于开销值,只有在能很快计算出开销值的情况下,才应该考虑采用这个尺度,不然反而会加大系统的开销。

下面我们来看一下缓存的用法:缓存网络下载的数据

// Network fetcher class
typedef void(^EOCNetworkFetcherCompletionHandler)(NSData *data);

@interface EOCNetworkFetcher : NSObject

- (id)initWithURL:(NSURL*)url;
- (void)startWithCompletionHandler:(EOCNetworkFetcherCompletionHandler)handler;

@end

// Class that uses the network fetcher and caches results
@interface EOCClass : NSObject
@end

@implementation EOCClass {
     NSCache *_cache;
}

- (id)init {

     if ((self = [super init])) {
    _cache = [NSCache new];

     // Cache a maximum of 100 URLs
    _cache.countLimit = 100;


     /**
     * The size in bytes of data is used as the cost,
     * so this sets a cost limit of 5MB.
     */
    _cache.totalCostLimit = 5 * 1024 * 1024;
    }
 return self;
}



- (void)downloadDataForURL:(NSURL*)url { 

     NSData *cachedData = [_cache objectForKey:url];

     if (cachedData) {

         // Cache hit:存在缓存,读取
        [self useData:cachedData];

    } else {

         // Cache miss:没有缓存,下载
         EOCNetworkFetcher *fetcher = [[EOCNetworkFetcher alloc] initWithURL:url];      

        [fetcher startWithCompletionHandler:^(NSData *data){
         [_cache setObject:data forKey:url cost:data.length];    
        [self useData:data];
        }];
    }
}
@end

在这里,我们使用URL作为缓存的key,将总对象数目设置为100,将开销值设置为5MB。

3. NSPurgeableData

NSPurgeableData是NSMutableData的子类,把它和NSCache配合使用效果很好。

因为当系统资源紧张时,可以把保存NSPurgeableData的那块内存释放掉。

如果需要访问某个NSPurgeableData对象,可以调用beginContentAccess方发,告诉它现在还不应该丢弃自己所占据的内存。

在使用完之后,调用endContentAccess方法,告诉系统在必要时可以丢弃自己所占据的内存。

上面这两个方法类似于“引用计数”递增递减的操作,也就是说,只有当“引用计数”为0的时候,才可以在将来删去它所占的内存。


- (void)downloadDataForURL:(NSURL*)url { 

      NSPurgeableData *cachedData = [_cache objectForKey:url];

      if (cachedData) {         

            // 如果存在缓存,需要调用beginContentAccess方法
            [cacheData beginContentAccess];

             // Use the cached data
            [self useData:cachedData];

             // 使用后,调用endContentAccess
            [cacheData endContentAccess];


        } else {

                 //没有缓存
                 EOCNetworkFetcher *fetcher = [[EOCNetworkFetcher alloc] initWithURL:url];    

                  [fetcher startWithCompletionHandler:^(NSData *data){                         NSPurgeableData *purgeableData = [NSPurgeableData dataWithData:data];
                         [_cache setObject:purgeableData forKey:url cost:purgeableData.length];

                          // Don't need to beginContentAccess as it begins            
                          // with access already marked
                           // Use the retrieved data
                            [self useData:data];

                             // Mark that the data may be purged now
                            [purgeableData endContentAccess];

            }];
      }
}
复制代码

注意:

在我们可以直接拿到purgeableData的情况下需要执行beginContentAccess方法。然而,在创建purgeableData的情况下,是不需要执行beginContentAccess,因为在创建了purgeableData之后,其引用计数会自动+1;

第51条: 精简initialize 与 load的实现代码

1. load方法

+(void)load;

每个类和分类在加入运行期系统时,都会调用load方法,而且仅仅调用一次,可能有些小伙伴习惯在这里调用一些方法,但是作者建议尽量不要在这个方法里调用其他方法,尤其是使用其他的类。原因是每个类载入程序库的时机是不同的,如果该类调用了还未载入程序库的类,就会很危险。

2. initialize方法

+(void)initialize;

这个方法与load方法类似,区别是这个方法会在程序首次调用这个类的时候调用(惰性调用),而且只调用一次(绝对不能主动使用代码调用)。

值得注意的一点是,如果子类没有实现它,它的超类却实现了,那么就会运行超类的代码:这个情况往往很容易让人忽视。

看一下🌰 :

#import <Foundation/Foundation.h>

@interface EOCBaseClass : NSObject
@end

@implementation EOCBaseClass
+ (void)initialize {
 NSLog(@"%@ initialize", self);
}
@end

@interface EOCSubClass : EOCBaseClass
@end

@implementation EOCSubClass
@end

当使用EOCSubClass类时,控制台会输出两次打印方法:

EOCBaseClass initialize
EOCSubClass initialize

因为子类EOCSubClass并没有覆写initialize方法,那么自然会调用其父类EOCBaseClass的方法。 解决方案是通过检测类的类型的方法:

+ (void)initialize {
   if (self == [EOCBaseClass class]) {
       NSLog(@"%@ initialized", self);
    }
}

这样一来,EOCBaseClass的子类EOCSubClass就无法再调用initialize方法了。 我们可以察觉到,如果在这个方法里执行过多的操作的话,会使得程序难以维护,也可能引起其他的bug。因此,在initialize方法里,最好只是设置内部的数据,不要调用其他的方法,因为将来可能会给这些方法添加其它的功能,那么会可能会引起难以排查的bug。

第52条: 别忘了NSTimer会保留其目标对象

在使用NSTimer的时候,NSTimer会生成指向其使用者的引用,而其使用者如果也引用了NSTimer,那么就会生成保留环。

#import <Foundation/Foundation.h>

@interface EOCClass : NSObject
- (void)startPolling;
- (void)stopPolling;
@end


@implementation EOCClass {
     NSTimer *_pollTimer;
}


- (id)init {
     return [super init];
}


- (void)dealloc {
    [_pollTimer invalidate];
}


- (void)stopPolling {

    [_pollTimer invalidate];
    _pollTimer = nil;
}


- (void)startPolling {
   _pollTimer = [NSTimer scheduledTimerWithTimeInterval:5.0
                                                 target:self
                                               selector:@selector(p_doPoll)
                                               userInfo:nil
                                                repeats:YES];
}

- (void)p_doPoll {
    // Poll the resource
}

@end

在这里,在EOCClass和_pollTimer之间形成了保留环,如果不主动调用stopPolling方法就无法打破这个保留环。像这种通过主动调用方法来打破保留环的设计显然是不好的。

而且,如果通过回收该类的方法来打破此保留环也是行不通的,因为会将该类和NSTimer孤立出来,形成“孤岛”:

孤立了类和它的NSTimer

这可能是一个极其危险的情况,因为NSTimer没有消失,它还有可能持续执行一些任务,不断消耗系统资源。而且,如果任务涉及到下载,那么可能会更糟。。

那么如何解决呢? 通过“块”来解决!

通过给NSTimer增加一个分类就可以解决:

#import <Foundation/Foundation.h>

@interface NSTimer (EOCBlocksSupport)

+ (NSTimer*)eoc_scheduledTimerWithTimeInterval:(NSTimeInterval)interval
                                         block:(void(^)())block
                                         repeats:(BOOL)repeats;
@end



@implementation NSTimer (EOCBlocksSupport)

+ (NSTimer*)eoc_scheduledTimerWithTimeInterval:(NSTimeInterval)interval
                                         block:(void(^)())block
                                        repeats:(BOOL)repeats
{
             return [self scheduledTimerWithTimeInterval:interval
                                                  target:self
                                                selector:@selector(eoc_blockInvoke:)
                                                userInfo:[block copy]
                                                 repeats:repeats];

}


+ (void)eoc_blockInvoke:(NSTimer*)timer {
     void (^block)() = timer.userInfo;
         if (block) {
             block();
        }
}
@end

我们在NSTimer类里添加了方法,我们来看一下如何使用它:

- (void)startPolling {

         __weak EOCClass *weakSelf = self;    
         _pollTimer = [NSTimer eoc_scheduledTimerWithTimeInterval:5.0 block:^{

               EOCClass *strongSelf = weakSelf;
               [strongSelf p_doPoll];
          }

                                                          repeats:YES];
}

在这里,创建了一个self的弱引用,然后让块捕获了这个self变量,让其在执行期间存活。

一旦外界指向EOC类的最后一个引用消失,该类就会被释放,被释放的同时,也会向NSTimer发送invalidate消息(因为在该类的dealloc方法中向NSTimer发送了invalidate消息)。

而且,即使在dealloc方法里没有发送invalidate消息,因为块里的weakSelf会变成nil,所以NSTimer同样会失效。

如果我们可以知道集合里的元素类型,就可以修改签名。这样做的好处是:可以让编译期检查该元素是否可以实现我们想调用的方法,如果不能实现,就做另外的处理。这样一来,程序就能变得更加安全。

九、iOS底层原理精华

书中其它部分和之前研究底层原理的内容有交叉,因此,可以参照 底层原理的精华篇幅和文章:

9.1 前知识

9.2 基于OC语言探索iOS底层原理

9.3 基于Swift语言探索iOS底层原理

关于函数枚举可选项结构体闭包属性方法swift多态原理StringArrayDictionary引用计数MetaData等Swift基本语法和相关的底层原理文章有如下几篇:

9.4底层原理相关专题

9.4 iOS相关专题

9.5 webApp相关专题

9.6 跨平台开发方案相关专题

9.7 阶段性总结:Native、WebApp、跨平台开发三种方案性能比较

9.8 Android、HarmonyOS页面渲染专题

9.9 小程序页面渲染专题


延伸阅读(掘金三部曲)

以下为同一作者(J_Knight_)对《Effective Objective-C》的概念 / 规范 / 技巧三分法总结,与本书 52 条一一对应,配有大量示例代码与图示,可作为按条目深挖的补充阅读。

标题 链接 内容概要
概念篇 《Effective Objective-C》干货三部曲(一):概念篇 掘金 - 概念篇 第 1 条(起源、运行期组件、堆栈)、第 6 条(属性、存取方法、关键字)、第 8 条(等同性、hash)、第 11 条(objc_msgSend)、第 12 条(消息转发、EOCAutoDictionary)、第 14 条(类对象、objc_class、isKindOfClass)、第 21 条(NSError)、第 22 条(NSCopying、浅/深拷贝)、第 29–30 条(引用计数、ARC)、第 37 条(Block 栈/堆/全局)、第 47 条(系统框架)
规范篇 《Effective Objective-C》干货三部曲(二):规范篇 掘金 - 规范篇 第 2 条(向前声明)、第 3–5 条(字面量、类型常量、枚举)、第 7 条(直接访问实例变量)、第 15 条(前缀)、第 18 条(不可变对象、内部可变集合)、第 19–20 条(命名、私有方法前缀)、第 23–27 条(委托、分类分散、分类前缀、勿在分类声明属性、class-continuation)、第 31 条(dealloc)、第 36 条(retainCount)、第 46 条(dispatch_get_current_queue)、第 48 条(块枚举)、第 50 条(NSCache、NSPurgeableData)、第 51 条(load/initialize)、第 52 条(NSTimer 保留环与 block 方案)
技巧篇 《Effective Objective-C》干货三部曲(三):技巧篇 掘金 - 技巧篇 第 9 条(类族模式)、第 10 条(关联对象、UIAlertView+block)、第 13 条(方法调配、lowercaseString 示例)、第 16 条(全能初始化、子类覆写、initWithCoder)、第 17 条(description)、第 28 条(匿名对象)、第 32–35 条(异常安全、弱引用、自动释放池块、僵尸对象)、第 38–45 条(block typedef、handler 块、保留环、串行队列/barrier、GCD vs performSelector、NSOperation、dispatch group、dispatch_once)、第 49 条(无缝桥接)

参考文献

[1] Galloway, M. Effective Objective-C 2.0: 52 Specific Ways to Write Better iOS and OS X Programs. Addison-Wesley Professional, 2013.
[2] O'Reilly. Effective Objective-C 2.0 — Table of Contents and Chapter Summaries. www.oreilly.com/library/vie…
[3] Apple. Objective-C Runtime Programming Guide. Developer Documentation Archive.
[4] Apple. The Objective-C Programming Language (Legacy).
[5] Apple. Advanced Memory Management Programming Guide. developer.apple.com/library/arc…
[6] Apple. About Memory Management. developer.apple.com/library/arc…
[7] Apple. Transitioning to ARC Release Notes. developer.apple.com/library/arc…
[8] Clang. Automatic Reference Counting (ARC). clang.llvm.org/docs/Automa…
[9] Stack Overflow. Block retain cycle, weak-strong dance.
[10] Apple. Working with Blocks. Programming Guide.
[11] Apple. Dispatch (GCD). Concurrency Programming Guide.
[12] Apple. Message Forwarding. Objective-C Runtime Guide. developer.apple.com/library/arc…
[13] J_Knight_. 《Effective Objective-C》干货三部曲(一):概念篇. 掘金,2018-01-08. juejin.cn/post/684490…
[14] J_Knight_. 《Effective Objective-C》干货三部曲(二):规范篇. 掘金,2018-01-10. juejin.cn/post/684490…
[15] J_Knight_. 《Effective Objective-C》干货三部曲(三):技巧篇. 掘金,2018-01-12. juejin.cn/post/684490…

昨天以前首页

02-研究优秀开源框架@图层处理@iOS | Kingfisher 框架:从使用到原理解析

📋 目录


一、Kingfisher 概述与历史演进

1. 框架简介

Kingfisher 是一款面向 Apple 平台(iOS / macOS / tvOS / watchOS)的纯 Swift 异步图片下载与缓存库,由 onevcat(王巍)维护。其「图层处理」相关能力以 ImageProcessor 为核心:在「从数据到图像」以及「从图像到图像」的管线中,完成解码、缩放、圆角、模糊、着色等处理,并与 ImageCache(内存 + 磁盘)、ImageDownloader 协同,形成「请求 → 缓存查询 → 下载 → 处理 → 缓存 → 展示」的完整流程 [1][2]。

与 SDWebImage(Objective-C 为主)相比,Kingfisher 采用协议导向Options 模式,图层处理通过统一的 ImageProcessor 协议和 ImageProcessItem 双态输入抽象,便于扩展与组合。

2. 技术演进与版本脉络

Kingfisher 的图层处理能力随版本逐步增强,并与缓存、下载模块解耦清晰。

阶段 版本/时期 图层处理与相关能力
早期 3.x 基础下载与缓存,简单图片处理
缓存与处理器 3.10 带 ImageProcessor 的缓存策略:先查已处理图,若无再查原图,避免重复下载 [3]
架构升级 5.0 MemoryStorage / DiskStorage 分离,可缓存原始 Data,完善 KingfisherError,处理管线与缓存键绑定 [4]
下采样修复 5.3 下采样 scale 与内存表现修复:从原图加载下采样结果时的 scale 与内存问题 [5]
动图与序列化 7.8 磁盘缓存取回动图时正确使用请求中的 processor [6]
渐进式 JPEG 8.3 SwiftUI KFImage 支持 progressiveJPEG 修饰符 [7]

5.0 是重要分水岭:处理管线与缓存键(含 processorIdentifier)深度结合,使「同一 URL + 不同 Processor」对应不同缓存条目,原图与处理后图可并存。

3. 图层处理在整体架构中的位置

下图概括从「资源(URL / ImageDataProvider)」到「显示到视图」的流程,并标出 ImageProcessor 所在阶段。

flowchart LR
    subgraph 输入
        A[URL / ImageDataProvider]
    end
    subgraph 获取数据
        B[ImageDownloader / Provider.data]
    end
    subgraph 处理层
        C[Data]
        D[ImageProcessor 管线]
        E[KFCrossPlatformImage]
    end
    subgraph 缓存与输出
        F[ImageCache]
        G[ImageView / KFImage]
    end
    A --> B --> C --> D --> E --> F --> G

要点

  • ImageProcessor 的输入可以是 Data(未解码)或 Image(已解码);输出为 Image。因此它同时覆盖「Data → Image」(如 DefaultImageProcessor、DownsamplingImageProcessor)和「Image → Image」(如 RoundCorner、Blur、Resizing)两类操作。
  • 处理在 KingfisherManager 协调下、通常在后台队列执行,避免阻塞主线程,符合 Apple 图像最佳实践 [8]。

二、图像处理管线(ImageProcessor Pipeline)

1. ImageProcessItem 与双态输入

Kingfisher 用 ImageProcessItem 表示处理器的输入,有两种情况 [9]:

public enum ImageProcessItem: Sendable {
    /// 已解码的图像,处理器在其上做几何/像素变换
    case image(KFCrossPlatformImage)
    /// 原始数据,处理器需负责解码(或解码+变换)
    case data(Data)
}

设计意图

  • 统一接口:同一套管线既可处理「仅解码」(Data → Image),也可处理「仅变换」(Image → Image),或「解码 + 变换」(Data 经多个 Processor 最终得到 Image)。
  • 避免重复解码:当管线中第一个 Processor 已将 Data 转为 Image 后,后续 Processor 收到 .image(...),只需做几何/滤镜等操作,无需再次解码。

数据流概念

flowchart LR
    subgraph 管线输入
        I[Data]
    end
    subgraph P1[Processor 1]
        I --> D1[解码/下采样]
        D1 --> O1[Image]
    end
    subgraph P2[Processor 2]
        O1 --> D2[圆角/缩放等]
        D2 --> O2[Image]
    end
    O2 --> Out[输出]

2. ImageProcessor 协议与标识符

ImageProcessor 协议是 Kingfisher 图层处理的核心抽象 [9][10]:

协议 ImageProcessor:
    属性 identifier: String   // 唯一标识,参与缓存键
    方法 process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage?
  • identifier:相同功能/参数的 Processor 应返回相同字符串,用于缓存键。官方建议使用反向域名(如 com.onevcat.Kingfisher.RoundCornerImageProcessor(20)),且不要与 DefaultImageProcessor"" 冲突。
  • process:返回 nil 表示处理失败,管线会报错并中止;若输入已是 .image 且当前步骤可透传,可返回原图以继续后续 Processor。

伪代码:管线执行

函数 runPipeline(item: ImageProcessItem, processors: [ImageProcessor], options) -> Image?:
    current = item
    对每个 p in processors:
        若 current 为 .data 且 p 只支持 .image:
            current = .image(DefaultImageProcessor.default.process(current, options))
        若 current 为 nil: 返回 nil
        next = p.process(current, options)
        若 next 为 nil: 返回 nil
        current = .image(next)
    返回 current

许多内置 Processor(如 RoundCorner、Blur)在收到 .data 时,会先通过 DefaultImageProcessor.default |> self 将 Data 解码为 Image,再对 Image 做自身变换,从而复用同一套协议。

3. 下采样(Downsampling)与 Resizing 的区分

Kingfisher 明确区分两种「变小」的方式,对应不同的内存与 CPU 成本 [10][11]。

3.1 DownsamplingImageProcessor

  • 输入:仅 Data(压缩数据)。在解码阶段直接生成小尺寸位图,而不是先解码全图再缩放。
  • 实现:基于 ImageIO 的 CGImageSourceCreateThumbnailAtIndex,通过 kCGImageSourceThumbnailMaxPixelSize 等选项限制最大边长,在解码器内部只生成缩略图级像素缓冲。
  • 优势:内存占用与目标尺寸相关,避免「先全图解码」的峰值;大图列表、头像等场景推荐使用。

下采样算法步骤(与 Kingfisher / ImageIO 语义一致)

函数 Downsample(data: Data, size: CGSize) -> Image?:
    1. maxDimensionInPixels = max(size.width, size.height) * scale
    2. source = CGImageSourceCreateWithData(data, nil)
    3. options = {
         kCGImageSourceCreateThumbnailFromImageAlways: true,
         kCGImageSourceCreateThumbnailWithTransform: true,
         kCGImageSourceShouldCacheImmediately: true,
         kCGImageSourceThumbnailMaxPixelSize: maxDimensionInPixels
       }
    4. cgImage = CGImageSourceCreateThumbnailAtIndex(source, 0, options)
    5. 由 cgImage 构造 UIImage/NSImage 并返回

注意size 不能为 (0, 0),否则会触发 "Processing image failed. Processor: DownsamplingImageProcessor" [11];在列表 cell 中应使用 cell 或目标视图的 bounds 计算合理 size。

3.2 ResizingImageProcessor

  • 输入:一般为 Image(或通过 DefaultImageProcessor 先解码的 Data)。对已解码的位图做缩放,支持 ContentMode(如 aspectFit、aspectFill)。
  • 实现:在像素缓冲上做几何变换(绘制到目标尺寸),会先占用全图解码的内存,再产生缩放后的新缓冲。
  • 适用:已解码图、或必须对 Image 做精确尺寸/比例控制时使用;若从 Data 缩小,应优先 DownsamplingImageProcessor

对比小结

维度 DownsamplingImageProcessor ResizingImageProcessor
输入 Data Image(或 Data 经 Default 解码)
时机 解码时直接出小图 先解码全图再缩放
内存 与目标尺寸相关 先有全图峰值再缩放
典型场景 列表缩略图、头像 已解码图的尺寸/比例调整

4. 多处理器链式组合

Kingfisher 支持将多个 ImageProcessor 串联成一条管线,按顺序执行:前一个的输出作为后一个的输入(.image(...))[10]。

组合方式:通过 append(another:)|> 运算符(Kingfisher 在 ImageProcessor 扩展中定义 |> 为调用 append(another:)):

// 先模糊,再圆角
let processor = BlurImageProcessor(blurRadius: 4) |> RoundCornerImageProcessor(cornerRadius: 20)
imageView.kf.setImage(with: url, options: [.processor(processor)])

组合后的 identifier"\(p1.identifier)|>\(p2.identifier)",用于缓存键,保证「同一 URL + 同一处理器链」唯一对应一条缓存。

链式执行语义(伪代码)

函数 GeneralProcessor.process(item, options):
    image1 = self.process(item, options)
    若 image1 为 nil: 返回 nil
    返回 another.process(.image(image1), options)

因此,若链中第一个 Processor 能处理 .data(如 DefaultImageProcessor 或 DownsamplingImageProcessor),后续 Processor 将始终收到 .image(...)


三、解码、缓存与处理器的协同

1. 检索流程与缓存键

Kingfisher 的检索顺序可概括为 [2][3]:

  1. 使用 cacheKey + processorIdentifier内存缓存
  2. 若未命中,查磁盘缓存(同样 key + processorIdentifier);
  3. 若仍未命中,通过 ImageDownloaderImageDataProvider 获取 Data;
  4. 对 Data 执行 ImageProcessor 管线,得到 Image;
  5. 将结果写入内存与磁盘缓存,并交给视图或完成回调。

缓存键:缓存的唯一标识是 cacheKey + processorIdentifier(DefaultImageProcessor 的 identifier 为空字符串)。因此:

  • 同一 URL,不同 Processor(或不同链)会得到不同缓存条目
  • 原图(DefaultImageProcessor)与下采样/圆角等版本可并存
  • 判断或读取缓存时若请求中指定了非 Default 的 Processor,需传入相同 processorIdentifier,例如:cache.isCached(forKey: cacheKey, processorIdentifier: processor.identifier)cache.retrieveImage(forKey: cacheKey, options: [.processor(processor)], ...)
flowchart TD
    A[请求: URL + Processor] --> B[构造 cacheKey + processorIdentifier]
    B --> C{内存缓存?}
    C -->|命中| D[返回 Image]
    C -->|未命中| E{磁盘缓存?}
    E -->|命中| F[解码/反序列化]
    F --> D
    E -->|未命中| G[下载 / Provider]
    G --> H[Processor 管线]
    H --> I[写内存+磁盘]
    I --> D

2. CacheSerializer 与磁盘格式

CacheSerializer 负责「Image ↔ Data」在磁盘缓存中的序列化与反序列化 [10]:

  • 存储data(with:original:),将当前要缓存的 Image 转为 Data(可结合 original Data 决定格式);
  • 读取image(with:options:),将磁盘上的 Data 转回 Image。

调用时机(便于理解与扩展):

  • Processor.process:① 网络下载成功或 ImageDataProvider 返回 Data 后,将 Data 加工为 Image;② 从磁盘读取到原始 Data 后,先经 CacheSerializer 反序列化为 Image,再经 Processor 处理(若请求中指定了 Processor)。因此磁盘命中「已处理图」时直接返回,命中「原图」时会再走一次 Processor。
  • CacheSerializer.image:从磁盘读取到 Data 后,用于将 Data 反序列化为 Image。
  • CacheSerializer.data:需要写入磁盘时,将 Image 序列化为 Data 再落盘。

默认行为:尽量保持原始数据格式(如 JPEG 仍存为 JPEG)。但当使用 RoundCornerImageProcessor 等会引入透明通道的处理器时,若原图是 JPEG(无透明通道),直接按 JPEG 存会丢失圆角透明区域。此时可指定 FormatIndicatedCacheSerializer.png,强制以 PNG 缓存处理后的图像:

imageView.kf.setImage(with: url,
    options: [.processor(RoundCornerImageProcessor(cornerRadius: 20)),
              .cacheSerializer(FormatIndicatedCacheSerializer.png)])

3. 内置 Processor 一览

Processor 输入偏好 功能
DefaultImageProcessor Data / Image Data→Image 解码,或 Image 按 scale 缩放
DownsamplingImageProcessor Data 解码时下采样,限制最大尺寸
ResizingImageProcessor Image 按 referenceSize + ContentMode 缩放
RoundCornerImageProcessor Image 圆角(可指定角、背景色、目标尺寸)
CroppingImageProcessor Image 按 size + anchor 裁剪
BlurImageProcessor Image 高斯模糊(Accelerate)
TintImageProcessor / OverlayImageProcessor Image 着色 / 叠色
ColorControlsProcessor / BlackWhiteProcessor Image 亮度对比度饱和度 / 黑白
BorderImageProcessor Image 加边框
BlendImageProcessor (iOS) / CompositingImageProcessor (macOS) Image 混合模式

4. 应用场景与选型

场景 推荐 Processor 说明
列表/表格缩略图 DownsamplingImageProcessor(size:) 从 Data 直接下采样,控制内存;size 取 cell 或目标尺寸
头像/圆角 RoundCornerImageProcessor 可配合 .png serializer 保留透明圆角
占位/毛玻璃 BlurImageProcessor 基于 Accelerate 的高斯模糊
统一尺寸且需等比 ResizingImageProcessor(referenceSize, mode: .aspectFit) 对已解码图做缩放
多步效果 链式:e.g. Blur |> RoundCorner 顺序决定最终效果与缓存键

RoundCornerImageProcessor 指定圆角:除四角统一圆角外,可指定部分角,如仅左上与右下:RoundCornerImageProcessor(cornerRadius: 20, roundingCorners: [.topLeft, .bottomRight])


四、类结构图分析

1. 核心类总览

Kingfisher 的类可按职责分为:入口与协调加载缓存处理管线视图扩展 五类。下表给出核心类/协议及其职责。

模块 核心类 / 协议 职责简述
协调 KingfisherManager 统一入口:协调 ImageDownloader、ImageCache、ImageProcessor 管线,执行「查缓存 → 下载/Provider → 处理 → 写缓存 → 回调」
加载 ImageDataProvider (协议) 定义数据来源接口:根据 URL 或资源标识返回 Data(如 Base64ImageDataProviderLocalFileImageDataProvider
ImageDownloader 默认网络加载:基于 URLSession 下载,支持并发、取消、RequestModifier、SessionDelegate
ImageDownloaderOperation 单次下载任务,封装 URLSessionTask
缓存 ImageCache 内存 + 磁盘二级缓存,提供 retrieve/store/remove,key 含 cacheKey + processorIdentifier
MemoryStorage / DiskStorage 5.0+ 内存层、磁盘层具体实现,可配置 count/cost 限制与过期策略
处理管线 ImageProcessor (协议) 定义 process(item:options:) -> KFCrossPlatformImage?,输入为 ImageProcessItem(.data / .image)
ImageProcessItem (枚举) 双态输入:.data(Data).image(KFCrossPlatformImage),统一「仅解码」「仅变换」「解码+变换」
DefaultImageProcessor / DownsamplingImageProcessor / RoundCornerImageProcessor 内置 Processor 实现,支持 ` >` 链式组合
CacheSerializer (协议) 磁盘格式:Image ↔ Data 序列化/反序列化,如 FormatIndicatedCacheSerializer.png
视图 KingfisherWrapper + ImageView.kf 为 UIImageView/NSImageView 等提供 kf.setImage(with:options:...)kf.cancelDownloadTask()
KFImage (SwiftUI) SwiftUI 图片组件,支持 URL、Processor、progressiveJPEG 等
ImagePrefetcher 预取多张图片,可配合 UICollectionView 的 prefetch

2. 模块划分与依赖关系

下图从「模块」维度表示各层之间的依赖方向:视图扩展与 Prefetcher 依赖 KingfisherManager,Manager 依赖 Downloader/Cache,处理管线在 Manager 内执行(Processor 链与 CacheSerializer 参与缓存键与磁盘格式)。

flowchart TB
    subgraph 视图层
        V1[ImageView.kf / KFImage]
        V2[ImagePrefetcher]
    end
    subgraph 协调层
        M[KingfisherManager]
    end
    subgraph 加载层
        L[ImageDownloader]
        P[ImageDataProvider 实现]
    end
    subgraph 缓存层
        C[ImageCache]
    end
    subgraph 处理管线层
        IP[ImageProcessor 实现]
        CS[CacheSerializer]
    end
    V1 --> M
    V2 --> M
    M --> L
    M --> P
    M --> C
    M --> IP
    M --> CS

3. 加载与缓存类结构

ImageDownloader 负责从网络获取 Data;ImageDataProvider 可提供本地或自定义 Data;ImageCache 负责内存与磁盘的读写。KingfisherManager 持有 cache 与 downloader,在单次请求中先查缓存(key = cacheKey + processorIdentifier),未命中再通过 downloader 或 provider 取数据,经 Processor 管线后写回缓存。

classDiagram
    class KingfisherManager {
        -cache: ImageCache
        -downloader: ImageDownloader
        +retrieveImage(with:options:progressBlock:completionHandler:)
        -loadAndCacheImage(source:options:completionHandler:)
    }
    class ImageCache {
        -memoryStorage: MemoryStorage
        -diskStorage: DiskStorage
        +retrieveImage(forKey:options:callbackQueue:completionHandler:)
        +store(_:forKey:options:toDisk:completionHandler:)
        +removeImage(forKey:fromMemory:fromDisk:completionHandler:)
    }
    class ImageDownloader {
        -session: URLSession
        -downloadQueue: OperationQueue
        +downloadImage(with:options:completionHandler:)
    }
    class ImageDataProvider {
        <<protocol>>
        +data(handler:)
        +cacheKey
    }
    KingfisherManager --> ImageCache : 使用
    KingfisherManager --> ImageDownloader : 使用
    KingfisherManager ..> ImageDataProvider : 支持 Source.provider
  • KingfisherManager:对外通过 retrieveImage(with:...) 接收 Source(.network(URL) 或 .provider(ImageDataProvider)),先查 ImageCache(key 含 processorIdentifier),未命中则调 downloader 或 provider 取 Data,再跑 Processor 管线并写回缓存。
  • ImageCache:5.0+ 将内存与磁盘拆为 MemoryStorage / DiskStorage,可配置 count/cost、过期时间;存储时由 CacheSerializer 决定 Image → Data 的格式(如 PNG 保留圆角透明)。
  • ImageDownloader:基于 URLSession,单次下载封装为 ImageDownloaderOperation,支持并发数、超时、RequestModifier;与 Provider 一起构成「数据来源」的两种方式。

4. 处理管线与 Processor 类结构

ImageProcessor 协议是图层处理的核心:输入为 ImageProcessItem(.data 或 .image),输出为 KFCrossPlatformImage。Manager 在「取得 Data 后」按 options 中的 processor(或链)依次执行;链的 identifier 拼接后参与缓存键,实现「同一 URL + 不同 Processor」对应不同缓存条目。

classDiagram
    class KingfisherManager {
        -runProcessors(_:data:options:)
    }
    class ImageProcessItem {
        <<enumeration>>
        +image(KFCrossPlatformImage)
        +data(Data)
    }
    class ImageProcessor {
        <<protocol>>
        +identifier: String
        +process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo): KFCrossPlatformImage?
    }
    class DefaultImageProcessor {
        +process(item:options:)
    }
    class DownsamplingImageProcessor {
        +size: CGSize
        +process(item:options:)
    }
    class RoundCornerImageProcessor {
        +cornerRadius: CGFloat
        +process(item:options:)
    }
    class ImageProcessorGroup {
        -processors: [ImageProcessor]
        +append(another:)
        +identifier
    }
    class CacheSerializer {
        <<protocol>>
        +data(with:original:)
        +image(with:options:)
    }
    ImageProcessItem --> ImageProcessor : 输入
    ImageProcessor <|.. DefaultImageProcessor : 实现
    ImageProcessor <|.. DownsamplingImageProcessor : 实现
    ImageProcessor <|.. RoundCornerImageProcessor : 实现
    ImageProcessor <|.. ImageProcessorGroup : 链式组合
    KingfisherManager ..> ImageProcessor : 执行管线
    KingfisherManager ..> CacheSerializer : 磁盘序列化
  • ImageProcessItem:双态设计使同一管线既可处理「Data → Image」(解码/下采样),也可处理「Image → Image」(圆角、模糊、缩放),或混合链式处理;收到 .data 的 Processor 可先通过 DefaultImageProcessor.default |> self 解码再变换。
  • ImageProcessor 链:通过 append(another:)|> 组合,链的 identifier 为各子 Processor identifier 用 "|>" 拼接,参与缓存键;执行时前一个输出作为后一个的 .image(...) 输入。
  • CacheSerializer:磁盘存储时由 data(with:original:) 将 Image 转为 Data,读取时由 image(with:options:) 反序列化;圆角等带透明通道的结果可选用 FormatIndicatedCacheSerializer.png 避免 JPEG 丢失透明。

5. View 扩展与调用链

视图扩展(如 ImageView.kf、SwiftUI 的 KFImage)是业务最常接触的入口:内部将 Resource(URL 或 ImageDataProvider)、placeholder、options 交给 KingfisherManager,并把返回的 DownloadTask 与 view 关联,以便在复用时取消。

sequenceDiagram
    participant V as ImageView
    participant KF as ImageView.kf
    participant M as KingfisherManager
    participant C as ImageCache
    participant D as ImageDownloader

    V->>KF: setImage(with: url, options: [.processor(...)])
    KF->>KF: cancelDownloadTask()
    KF->>M: retrieveImage(with: .network(url), options: ...)
    M->>C: retrieveImage(forKey: cacheKey+processorIdentifier)
    alt 缓存命中
        C-->>M: image (memory/disk)
        M-->>KF: completion(image, .memory/.disk)
    else 未命中
        M->>D: downloadImage(with: url, ...)
        D-->>M: data
        M->>M: Processor 管线处理
        M->>C: store(image, forKey: ...)
        M-->>KF: completion(image, .none)
    end
    KF->>V: imageView.image = image
  • kf.setImage(with: placeholder: options: progressBlock: completionHandler:):先对当前 view 取消未完成的 DownloadTask,再调 KingfisherManager.shared.retrieveImage(with: source, options: options, ...);在 completion 中把得到的 image 赋给 imageView.image(并可选执行 transition)。
  • kf.cancelDownloadTask():取消与该 view 绑定的任务,避免 cell 复用时旧请求覆盖新图。
  • KFImage (SwiftUI):通过 KFImage 传入 url、processor、placeholder 等,内部同样走 KingfisherManager,支持 progressiveJPEG(8.3+)等选项。

将上述「核心类总览」「模块依赖」「加载与缓存类图」「Processor 与管线类图」「View 调用链」串联起来,即可形成对 Kingfisher 类结构图 的完整分析:入口在视图扩展(kf / KFImage),核心协调在 KingfisherManager,加载(Downloader/Provider)、缓存(ImageCache + CacheSerializer)、处理(ImageProcessor + ImageProcessItem)均为协议导向的可插拔设计,便于扩展与测试。


五、与系统及业界实践的衔接

1. Apple 图像与图形最佳实践

Apple 在 WWDC 2018「Image and Graphics Best Practices」[8] 中强调:

  • 在后台线程解码与下采样,避免主线程卡顿;
  • 解码时即做下采样,使解码后缓冲与显示尺寸匹配,降低内存峰值;
  • 预取:在列表等场景提前准备即将显示的图像。

Kingfisher 的 DownsamplingImageProcessor 直接对应「解码时下采样」;处理管线在 KingfisherManager 的队列中执行,满足「后台处理」;配合 ImagePrefetcherUICollectionViewDataSourcePrefetching 等可实现预取 [10]。与 SDWebImage 类似,其设计与此类最佳实践一致。

2. 与 SDWebImage 的对比

维度 Kingfisher SDWebImage
语言 纯 Swift Objective-C 为主,Swift 接口
处理抽象 ImageProcessor + ImageProcessItem SDImageTransformer
输入类型 .image / .data 双态 一般为已解码 Image
下采样 DownsamplingImageProcessor(Data→Image) 解码管线内缩略图/limitBytes
链式组合 append / |>,identifier 拼接 SDImagePipelineTransformer 数组
缓存键 cacheKey + processorIdentifier 含 transformer 信息
渐进式 8.3+ KFImage progressiveJPEG Progressive Coder 体系

二者都遵循「解码/下采样 + 变换 + 缓存」的管线思想,Kingfisher 通过 ImageProcessItem 将「解码」与「变换」统一进同一协议,便于从 Data 直接到最终 Image 的一体化处理。

3. 动图加载(GIF)与 AnimatedImageView

Kingfisher 加载 GIF 的两种方式:UIImageViewAnimatedImageView(继承自 UIImageView),调用方式相同,内部行为不同 [12]。

  • UIImageViewshouldPreloadAllAnimation() 扩展返回 true,即 preloadAllAnimationData 被设为 true,GIF 会先解码为所有帧的 UIImage 数组,再通过 UIImage.animatedImage(with:duration:) 展示。适合帧数少的动图。
  • AnimatedImageView:重写 shouldPreloadAllAnimation() 返回 false,不预加载全部帧;通过关联的 CGImageSourceAnimator 按需解码(默认仅预加载前若干帧),用 CADisplayLink 在每帧刷新时更新 layer.contents(重写 display(_ layer:))。更省内存,CPU 略高。

AnimatedImageView 独有runLoopModebackgroundDecodeframePreloadCountautoPlayAnimatedImagerepeatCount 等。若需在列表或详情中播放 GIF 且控制内存,建议使用 AnimatedImageView


六、设计模式与编程思想

1. 设计模式应用

Kingfisher 在架构上大量运用经典设计模式,与纯 Swift、协议导向的风格结合,使扩展与维护成本可控。

模式 在 Kingfisher 中的体现 作用
外观 / 门面(Facade) KingfisherManager 对外提供 retrieveImage(with:options:progressBlock:completionHandler:),内部协调 ImageDownloader、ImageCache、ImageProcessor 管线,调用方无需关心多级缓存与处理顺序 简化使用、隐藏复杂度
策略(Strategy) ImageProcessorCacheSerializerImageDataProvider 均为协议,多种实现可替换(RoundCorner、Downsampling、FormatIndicatedCacheSerializer 等),通过 KingfisherOptionsInfo 传入 算法/行为可插拔,易扩展新处理与存储格式
责任链 / 管道(Chain of Responsibility / Pipeline) ImageProcessor 通过 append(another:)|> 串联成管线;ImageProcessItem 双态(.data / .image)使「解码 → 变换」在同一链中顺序执行 多步处理顺序清晰,便于组合与复用
单例 + 共享依赖(Singleton) KingfisherManager.sharedImageCache.defaultImageDownloader.default 提供默认实例,同时 retrieveImage 等 API 支持传入自定义 cache、downloader,打破单例绑定 全局统一入口,又保留可测试性与多实例能力
观察者 / 回调(Observer / Callback) 通过 progressBlockcompletionHandler 闭包通知进度与结果;Swift 并发下也可用 async/await 异步结果与 UI 解耦
组合 / 装饰(Composite) 多个 ImageProcessor 通过 |> 组合成新 Processor,其 identifier 为子 Processor 的 identifier 拼接,对外仍满足同一 ImageProcessor 协议 链式处理器可当作单一策略使用,参与缓存键一致

类图关系(概念层)

classDiagram
    class KingfisherManager {
        -cache: ImageCache
        -downloader: ImageDownloader
        +retrieveImage(with:options:progressBlock:completionHandler:)
    }
    class ImageCache {
        +retrieveImage(forKey:options:callbackQueue:completionHandler:)
        +store(_:forKey:options:toDisk:completionHandler:)
    }
    class ImageDownloader {
        +downloadImage(with:options:completionHandler:)
    }
    class ImageProcessor {
        <<protocol>>
        +identifier: String
        +process(item: ImageProcessItem, options:): KFCrossPlatformImage?
    }
    class ImageDataProvider {
        <<protocol>>
        +data(handler:)
        +cacheKey
    }
    KingfisherManager --> ImageCache : 使用
    KingfisherManager --> ImageDownloader : 使用
    KingfisherManager ..> ImageProcessor : 处理时选用
    KingfisherManager ..> ImageDataProvider : Source.provider

2. 编程思想精华

Kingfisher 的编程思想可提炼为以下几点,对理解与模仿其设计很有帮助。

2.1 协议导向与「可替换实现」

  • ImageProcessorCacheSerializerImageDataProvider 均以协议呈现,具体实现可替换、可组合。
  • 新增一种图像处理或一种磁盘格式,只需实现对应协议并通过 options 传入(如 .processor(...).cacheSerializer(...)),无需改动 KingfisherManager 核心流程。这体现了开闭原则:对扩展开放,对修改关闭。

2.2 管线化与单一职责

  • 把「从 Source 到屏幕」拆成:获取数据(Downloader/Provider)→ Processor 管线(解码/下采样 + 变换)→ 缓存 → 展示,每一步只做一件事。
  • Processor 只关心 ImageProcessItem → Image,Cache 只关心存储与查找,Downloader 只关心网络 Data。单一职责使每块可独立测试、优化和扩展;管线化则使数据流清晰,便于加日志与监控。

2.3 双态输入与「解码+变换」统一

  • ImageProcessItem.data / .image 双态设计,使同一 ImageProcessor 协议既能表达「Data → Image」(如 Default、Downsampling),也能表达「Image → Image」(如 RoundCorner、Blur),还能通过链式组合在一次管线中完成解码与多步变换。
  • 避免「解码器」与「变换器」两套抽象,降低概念数量,便于链式组合与缓存键一致(整条链一个 identifier 串)。

2.4 缓存键与「同一资源多形态」

  • 通过 cacheKey + processorIdentifier 的设计,同一 URL 可以对应「原图」「下采样图」「圆角图」等多条缓存,避免重复下载,又满足不同场景对尺寸/形态的需求。这体现了用键设计表达业务差异的思想。

2.5 后台处理与主线程回调

  • 下载、Processor 管线、磁盘 I/O 均在后台队列执行,completionHandler 通过 CallbackQueue.mainAsync 等派发到主线程,兼顾性能与 UI 安全。这是移动端异步加载库的通用范式:重活放后台,结果回主线程

2.6 取消与生命周期绑定

  • 视图扩展(如 ImageView.kf)会把「当前正在进行的 DownloadTask」与 view 绑定,当对同一 view 发起新请求时先取消旧任务,避免错位和浪费。这体现了生命周期与请求绑定的思想,在列表 cell 复用时尤为重要。

2.7 配置通过 Options 透传

  • 不通过全局单例属性堆砌配置,而是通过 KingfisherOptionsInfo(如 .processor.cacheSerializer.callbackQueue)在单次请求中传入,使「同一 App 内不同页面/模块」可使用不同 Processor 与缓存策略,且易于单元测试时注入 mock。

Kingfisher 编程思想精华一览

思想 在框架中的体现
协议导向、可替换 ImageProcessor / CacheSerializer / ImageDataProvider 协议化,新处理、新格式仅需实现协议并通过 options 传入
管线化、单一职责 获取数据 → Processor 管线 → 缓存 → 展示,每步职责单一,便于扩展与测试
双态输入、解码+变换统一 ImageProcessItem(.data / .image) + 链式 Processor,一条管线完成解码与多步变换,identifier 参与缓存键
键设计表达多形态 同一 URL 通过 cacheKey + processorIdentifier 支持原图、下采样图、圆角图等多条缓存
后台处理、主线程回调 重 CPU/IO 在后台队列,completion 回主线程(CallbackQueue),兼顾性能与 UI 安全
生命周期绑定取消 View 与 DownloadTask 绑定,新请求自动取消旧请求,避免列表错位
Options 透传配置 单次请求级 options(processor、cacheSerializer、callbackQueue 等),避免全局状态,利于多策略并存与测试注入

七、使用示例与最佳实践

1. 基础加载与圆角

let processor = RoundCornerImageProcessor(cornerRadius: 20)
imageView.kf.setImage(with: url, options: [.processor(processor)])

2. 列表缩略图(下采样)

let size = imageView.bounds.size
let processor = DownsamplingImageProcessor(size: size)
imageView.kf.setImage(with: url, options: [.processor(processor)])
// 注意:size 不可为 .zero

3. 多处理器链与强制 PNG 缓存

let processor = BlurImageProcessor(blurRadius: 4) |> RoundCornerImageProcessor(cornerRadius: 20)
imageView.kf.setImage(with: url, options: [
    .processor(processor),
    .cacheSerializer(FormatIndicatedCacheSerializer.png)
])

4. 自定义 Processor(仅做示意)

struct MyProcessor: ImageProcessor {
    let identifier = "com.example.myprocessor"
    func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
        switch item {
        case .image(let image): return image // 或对 image 做变换
        case .data(let data): return DefaultImageProcessor.default.process(item: item, options: options)
        }
    }
}

5. 预取与列表

// 配合 UICollectionViewDataSourcePrefetching
func collectionView(_ collectionView: UICollectionView, prefetchItemsAt indexPaths: [IndexPath]) {
    let urls = indexPaths.compactMap { URL(string: model(at: $0).imageURL) }
    ImagePrefetcher(urls: urls).start()
}

6. Cell 完整示例(复用、下采样、进度与完成回调)

列表 Cell 中需在 prepareForReuse 中取消任务并清空,在 configure 中按目标尺寸下采样并可选显示进度。

class PhotoCell: UITableViewCell {
    static let reuseId = "PhotoCell"
    @IBOutlet weak var photoImageView: UIImageView!
    @IBOutlet weak var progressView: UIProgressView!

    override func prepareForReuse() {
        super.prepareForReuse()
        photoImageView.kf.cancelDownloadTask()
        photoImageView.image = nil
        progressView.progress = 0
        progressView.isHidden = true
    }

    func configure(with url: URL) {
        let size = photoImageView.bounds.size
        let processor = DownsamplingImageProcessor(size: size.isEmpty ? CGSize(width: 120, height: 120) : size)
        photoImageView.kf.setImage(
            with: url,
            placeholder: UIImage(named: "placeholder"),
            options: [.processor(processor), .scaleFactor(UIScreen.main.scale)],
            progressBlock: { [weak self] received, total in
                guard let self = self, total > 0 else { return }
                DispatchQueue.main.async {
                    self.progressView.isHidden = false
                    self.progressView.progress = Float(received) / Float(total)
                }
            },
            completionHandler: { [weak self] result in
                DispatchQueue.main.async {
                    self?.progressView.isHidden = true
                    if case .failure = result { /* 可设置失败占位图 */ }
                }
            }
        )
    }
}

7. UIButton 设置网络图片

为 UIButton 的不同 state 设置网络图片,可配合 Processor 与完成回调。

// 设置 normal / highlighted 等状态的图片
button.kf.setImage(with: url, for: .normal, placeholder: UIImage(named: "btn_placeholder"))
button.kf.setImage(with: highlightedURL, for: .highlighted)
button.kf.setBackgroundImage(with: backgroundURL, for: .normal)

// 带圆角与完成回调
let processor = RoundCornerImageProcessor(cornerRadius: 8)
button.kf.setImage(
    with: url,
    for: .normal,
    placeholder: nil,
    options: [.processor(processor), .cacheSerializer(FormatIndicatedCacheSerializer.png)],
    completionHandler: { result in
        if case .failure = result { print("加载失败") }
    }
)

8. 占位图、进度与过渡动画

使用占位图、下载进度条,并在图片加载完成后执行淡入等过渡动画。

imageView.kf.setImage(
    with: url,
    placeholder: UIImage(named: "placeholder"),
    options: [
        .transition(ImageTransition.fade(0.3)),
        .retryFailed
    ],
    progressBlock: { [weak progressView] received, total in
        guard let pv = progressView, total > 0 else { return }
        DispatchQueue.main.async {
            pv.progress = Float(received) / Float(total)
            pv.isHidden = false
        }
    },
    completionHandler: { [weak progressView] result in
        DispatchQueue.main.async {
            progressView?.isHidden = true
            if case .failure = result { /* 可显示失败占位或提示 */ }
        }
    }
)

9. 自定义缓存键与请求修饰(RequestModifier)

同一 URL 在不同业务下需要不同缓存键时,可通过 KingfisherOptionsInfo 传入自定义 cacheKey;需要鉴权或自定义 Header 时使用 ImageDownloadRequestModifier

// 自定义缓存键:列表用 thumb key、详情用原图 key
let listResource = ImageResource(downloadURL: url, cacheKey: "list_\(url.absoluteString)")
let detailResource = ImageResource(downloadURL: url, cacheKey: "detail_\(url.absoluteString)")
listImageView.kf.setImage(with: listResource, options: [.processor(DownsamplingImageProcessor(size: thumbSize))])
detailImageView.kf.setImage(with: detailResource)

// 请求修饰:Header、Token、超时
struct AuthModifier: ImageDownloadRequestModifier {
    let token: String
    func modified(for request: URLRequest) -> URLRequest? {
        var r = request
        r.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
        r.setValue("image/webp,image/*,*/*;q=0.8", forHTTPHeaderField: "Accept")
        return r
    }
}
imageView.kf.setImage(with: url, options: [.requestModifier(AuthModifier(token: userToken))])

10. 缓存查询与手动存储

不经过视图加载流程,直接使用 ImageCache 查询、存储或移除缓存。

let cache = ImageCache.default
let key = url.absoluteString  // 或自定义 cacheKey(与 Processor 组合时由框架自动拼接 processorIdentifier)

// 查询是否已缓存
cache.imageCachedType(forKey: key) { result in
    switch result {
    case .success(let cached):
        switch cached {
        case .none:   print("未缓存")
        case .memory: print("在内存")
        case .disk:   print("在磁盘")
        }
    case .failure: break
    }
}

// 从缓存读取(不触发下载)
cache.retrieveImage(forKey: key, options: nil) { result in
    switch result {
    case .success(let value):
        if let image = value.image { imageView.image = image }
    case .failure: break
    }
}

// 手动写入缓存(如本地生成或从相册来的图)
cache.store(image, forKey: key, options: nil, toDisk: true) { _ in }

11. 自定义 Processor 完整示例(加边框)

实现 ImageProcessor 协议,对已解码图像做自定义绘制(如加灰色边框)。

struct GrayBorderProcessor: ImageProcessor {
    let identifier = "com.example.grayborder(\(borderWidth))"
    let borderWidth: CGFloat

    init(borderWidth: CGFloat = 2) { self.borderWidth = borderWidth }

    func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
        switch item {
        case .image(let image):
            let size = image.size
            let renderer = UIGraphicsImageRenderer(size: size)
            return renderer.image { ctx in
                image.draw(at: .zero)
                UIColor.gray.setStroke()
                let rect = CGRect(origin: .zero, size: size).insetBy(dx: borderWidth/2, dy: borderWidth/2)
                ctx.stroke(rect, with: .color(.gray), lineWidth: borderWidth)
            }
        case .data:
            return DefaultImageProcessor.default.process(item: item, options: options)
        }
    }
}

// 使用
imageView.kf.setImage(with: url, options: [.processor(GrayBorderProcessor(borderWidth: 3))])

12. SwiftUI KFImage 与 async/await

在 SwiftUI 中使用 KFImage,并配合渐进式 JPEG、占位与异步加载。

// 基础用法
KFImage(url)
    .placeholder { ProgressView() }
    .fade(duration: 0.25)
    .resizable()
    .aspectRatio(contentMode: .fit)

// 带 Processor 与圆角
KFImage(url)
    .setProcessor(RoundCornerImageProcessor(cornerRadius: 12))
    .placeholder { Color.gray.opacity(0.2) }
    .cacheSerializer(FormatIndicatedCacheSerializer.png)

// 8.3+ 渐进式 JPEG
KFImage(url)
    .progressiveJPEG(ImageProgressive(isBlur: true, isFastestScan: true, scanInterval: 0.1))

// 使用 async/await(Kingfisher 提供的异步 API)
Task {
    let result = await KingfisherManager.shared.retrieveImage(with: url)
    if case .success(let value) = result {
        await MainActor.run { imageView.image = value.image }
    }
}

13. ImageDataProvider(本地与 Base64)用法

不依赖网络 URL 时,可用 ImageDataProvider 从本地文件或 Base64 字符串加载,并同样走缓存与 Processor 管线。

// 本地文件
let fileURL = Bundle.main.url(forResource: "avatar", withExtension: "jpg")!
let provider = LocalFileImageDataProvider(fileURL: fileURL)
imageView.kf.setImage(with: provider)

// Base64 数据(如接口返回的 data URL)
let base64String = "data:image/png;base64,iVBORw0KGgo..."
if let provider = Base64ImageDataProvider(base64String: base64String, cacheKey: "custom_key") {
    imageView.kf.setImage(with: provider, options: [.processor(RoundCornerImageProcessor(cornerRadius: 10))])
}

// 自定义 Provider:从相册、加密存储等获取 Data
struct MyImageDataProvider: ImageDataProvider {
    var cacheKey: String { "my_\(id)" }
    let id: String
    func data(handler: @escaping (Result<Data, Error>) -> Void) {
        // 异步获取 Data 后调用 handler(.success(data)) 或 handler(.failure(...))
    }
}
imageView.kf.setImage(with: MyImageDataProvider(id: "123"))

14. 其他常用选项速览

选项 含义
.forceRefresh 跳过缓存,强制重新下载
.retryFailed 对之前失败的 URL 重试
.onlyFromCache 仅从缓存读取,不发起网络请求
.backgroundDecode 在后台队列解码,减少主线程压力
.callbackQueue(.mainAsync) 指定完成回调的派发队列
.downloadPriority(1.0) 下载任务优先级(iOS)
.scaleFactor(UIScreen.main.scale) 与 @2x/@3x 匹配,避免模糊
.cacheMemoryOnly 仅写内存缓存,不写磁盘
.loadDiskFileSynchronously 从磁盘加载时是否同步(默认异步)
imageView.kf.setImage(with: url, options: [.forceRefresh, .retryFailed, .callbackQueue(.mainAsync)])

15. Options 详解(延伸)

  • targetCache / originalCache:默认为 nil 时使用 ImageCache(name: "default")targetCache 为最终展示图的缓存(含 Processor 处理后的图),originalCache 为原始数据的缓存,可用于「列表用处理图、详情用原图」等分离策略。
  • transition:图片加载完成后的展示动画;forceTransition 为 true 时即使命中缓存也执行 transition,为 false 时仅在不使用缓存(新下载)时执行。
  • callbackQueue / processingQueuecallbackQueue 可选 .mainAsync.mainCurrentOrAsync(当前线程为主线程则直接执行,否则主线程异步)、.untouch.dispatch(DispatchQueue),默认多为 .mainCurrentOrAsyncprocessingQueue 为 Processor 执行所在队列,默认串行子队列。
  • memoryCacheAccessExtendingExpiration:从内存/磁盘取图时是否延长过期时间,可选 .none(不延长)、.cacheTime(当前时间 + 原过期时长)、.expirationTime(StorageExpiration)(延长到指定时长)。

16. 指示器、Placeholder 与 Transition 类型

  • 指示器(Indicator)imageView.kf.indicatorType 可选 .none.activity(UIActivityIndicatorView)、.image(imageData: Data)(GIF 等)、.custom(indicator: Indicator),自定义需实现 Indicator 协议(startAnimatingView / stopAnimatingView)。
  • Placeholder:除 UIImage 外,可实现 Placeholder 协议的自定义 View(如 class MyPlaceholder: UIView, Placeholder {}),设置 imageView.kf.setImage(with: url, placeholder: myPlaceholderView)
  • ImageTransitionnonefade(TimeInterval)flipFromLeft/Right/Top/Bottom(TimeInterval)custom(duration:options:animations:completion:)

17. 缓存配置与清除

内存缓存cache.memoryStorage.config):totalCostLimit(默认约物理内存 1/4)、countLimitexpiration(默认 300 秒)、cleanInterval(清除过期缓存的时间间隔,仅初始化可设)。单张可设 .memoryCacheExpiration(.never);访问时延长策略用 .memoryCacheAccessExtendingExpiration(.cacheTime)

磁盘缓存cache.diskStorage.config):sizeLimitexpiration(默认 7 天)、pathExtensionusesHashedFileName(文件名是否用 key 的 MD5)。超出容量时按最后访问时间排序,删除最旧文件直至低于 sizeLimit 的一半。

清除cache.clearMemoryCache() / cache.cleanExpiredMemoryCache()cache.clearDiskCache() / cache.cleanExpiredDiskCache();删除指定 key 可用 cache.removeImage(forKey:processorIdentifier:fromMemory:fromDisk:completionHandler:)。获取磁盘占用:cache.calculateDiskStorageSize { result in ... }

18. ImagePrefetcher 与请求修饰、重定向

ImagePrefetcher:除 start() 外,提供 completionHandler(参数为 [Resource] 的 skipped/failed/completed)与 completionSourceHandler(参数为 [Source]),分别对应用 URL/Resource 初始化与用 Source 初始化的场景;progressBlock / progressSourceBlock 同理。maxConcurrentDownloads 控制并发数。stop() 会取消当前未完成的下载任务,并将剩余未加载项计入「完成回调」的 skipped;若调用 stop 时已全部完成,则不会再次触发完成回调。

请求修饰:通过 AnyModifier 或实现 ImageDownloadRequestModifier 在请求前添加 Header、Token 等,例如 let modifier = AnyModifier { var r = $0; r.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization"); return r },options 中加 .requestModifier(modifier)超时ImageDownloader.default.downloadTimeout = 60重定向:通过 .redirectHandler(AnyRedirectHandler { ... }) 自定义 302 等重定向后的请求。

19. 扩展 WebP 支持(Processor + CacheSerializer)

Kingfisher 默认不包含 WebP 编解码,可借助 ProcessorCacheSerializer 扩展 [13]。依赖 libwebp 实现 Data ↔ Image 后,定义 WebPProcessor(在 process 中若为 .data 则用 WebP 解码为 Image,若为 .image 则透传)与 WebPCacheSerializerdata(with:original:) 返回 WebP 编码、image(with:options:) 返回 WebP 解码),使用时设置 options: [.processor(WebPProcessor.default), .cacheSerializer(WebPCacheSerializer.default)] 即可对 .webp URL 加载并缓存。


延伸阅读(掘金系列)

以下为同一作者的 Kingfisher 源码解析系列文章,可按需跳转深入阅读(链接与标题保持一致):

主题 链接 内容概要
使用 Kingfisher源码解析之使用 Resource/ImageDataProvider、Placeholder、GIF、Indicator、Transition、Processor 概览、缓存与下载配置、预加载、常用 options
Options 解释 Kingfisher源码解析之Options解释 targetCache/originalCache、downloader、transition/forceTransition、preloadAllAnimationData、callbackQueue/processingQueue、memoryCacheAccessExtendingExpiration
加载流程 Kingfisher源码解析之加载流程 setImage 之后发生了什么、图片加载与缓存查找流程
ImageCache Kingfisher源码解析之ImageCache MemoryStorage(NSCache、StorageObject、Config)、DiskStorage(FileMeta、removeExpiredValues、removeSizeExceededValues)、缓存读写与清理
加载动图 Kingfisher源码解析之加载动图 UIImageView 与 AnimatedImageView 加载 GIF 的差异、preloadAllAnimationData、CGImageSource、Animator、CADisplayLink、display(_ layer:)
Processor 和 CacheSerializer Kingfisher源码解析之Processor和CacheSerializer Processor/ImageProcessItem 定义与调用时机、CacheSerializer 调用时机、使用 Processor+CacheSerializer 扩展 WebP
ImagePrefetcher Kingfisher源码解析之ImagePrefetcher 预加载功能、completionHandler/completionSourceHandler、progressBlock/progressSourceBlock、stop() 行为、Resource 与 Source 两套回调

参考文献

[1] Kingfisher. Cheat Sheet. GitHub Wiki.
[2] Kingfisher. Image Manager Structure. studyraid.com / Agent Docs.
[3] Kingfisher. CHANGELOG / Releases — 3.10.0 cache retrieval with ImageProcessor.
[4] Kingfisher. Release 5.0.0. GitHub.
[5] Kingfisher. Release 5.3.0 — Downsampling scale/memory fix.
[6] Kingfisher. Release 7.8.1 — Animated image from disk cache with processor.
[7] Kingfisher. Release 8.3.0 — Progressive JPEG for KFImage.
[8] Apple. Image and Graphics Best Practices. WWDC 2018, Session 219.
[9] Kingfisher. ImageProcessor.swift. GitHub (onevcat/Kingfisher).
[10] Kingfisher. Cheat Sheet — Processor, Cache, Downloader. GitHub Wiki.
[11] Stack Overflow / Kingfisher Issues. DownsamplingImageProcessor size (0,0) and processing failure.

01-研究优秀开源框架@图层处理@iOS | SDWebImage 框架:从使用到原理解析

📋 目录


一、SDWebImage 概述与历史演进

0. 框架结构概览与功能简介

SDWebImage 的框架结构

SDWebImage的框架结构

SDWebImage 的图片下载分类,只要一行代码就可以实现图片异步下载和缓存功能。

功能简介

  1. 一个添加了 web 图片加载和缓存管理的 UIImageView 分类
  2. 一个异步图片下载器
  3. 一个异步的内存加磁盘综合存储图片并且自动处理过期图片
  4. 支持动态 gif 图
    • 4.0 之前的动图效果并不是太好
    • 4.0 以后基于 FLAnimatedImage 加载动图
  5. 支持 webP 格式的图片
  6. 后台图片解压处理
  7. 确保同样的图片 url 不会下载多次
  8. 确保伪造的图片 url 不会重复尝试下载
  9. 确保主线程不会阻塞

1. 框架简介

SDWebImage 是 Apple 平台(iOS / macOS / watchOS / visionOS)上广泛使用的异步图片下载与缓存库,提供从网络(或自定义 Loader)加载图片、解码、变换、缓存到展示的完整管线。其「图层处理」相关能力主要体现在:解码管线(将压缩数据解码为可渲染的位图)与变换管线(在解码后对位图做缩放、裁剪、滤镜等处理),二者共同构成「从数据到屏幕」的中间处理层。

2. 技术演进与版本脉络

SDWebImage 的图层处理能力并非一蹴而就,而是随版本逐步完善,与系统 API 和业界实践同步演进。

阶段 版本/时期 解码与图层处理相关能力
早期 3.x 及以前 以网络下载 + 简单缓存为主,解码依赖系统默认行为
规范化 4.0 引入 Custom Download Operation、更清晰的职责划分
编解码扩展 4.2 Custom Coder:支持注册自定义编解码器(如 WebP、渐进 JPEG)
统一管线 5.0 Image TransformerAnimated Image 全栈方案(GIF/WebP/APNG)、解码与变换在 Manager 内统一调度
精细化 5.x 后续 缩略图解码、HDR、强制解码策略(Force Decode Policy)、解码尺度与字节限制等

5.0 是重要分水岭:解码(Coder)、变换(Transformer)、缓存(Cache)、加载(Loader)在 SDWebImageManager 中形成一条清晰流水线,便于理解「图层处理」在整体中的位置。

3. 图层处理在整体架构中的位置

下图概括了从「URL 请求」到「显示到视图」的流程,并标出解码与变换所在阶段。

flowchart LR
    subgraph 输入
        A[URL / 自定义 Loader]
    end
    subgraph 加载
        B[SDImageLoader]
    end
    subgraph 解码层
        C[Data]
        D[SDImageCoder 解码]
        E[UIImage/NSImage]
    end
    subgraph 变换层
        F[SDImageTransformer]
        G[变换后图像]
    end
    subgraph 缓存与输出
        H[SDImageCache]
        I[UIImageView 等]
    end
    A --> B --> C --> D --> E --> F --> G --> H --> I

要点

  • 解码(Decoder):将压缩格式数据(JPEG/PNG/WebP/HEIC/AVIF 等)转为内存中的位图(如 UIImage/NSImage),是「数据 → 图层」的第一步。
  • 变换(Transformer):在「已解码的位图」上做几何或像素级处理(缩放、裁剪、圆角、滤镜等),输出仍是位图,再写入缓存或交给视图。
  • 二者均可在后台线程执行,避免阻塞主线程,符合 Apple 在 WWDC 等场合强调的「Image and Graphics Best Practices」[1]。

二、图像解码管线(Decoder Pipeline)

1. 解码的基础概念与双缓冲模型

在操作系统与图形栈中,图像通常以两种形式存在:

  1. 数据缓冲(Data Buffer)
    即磁盘或网络中的压缩编码数据(如 JPEG、PNG 的二进制)。体积小,但不能直接用于渲染。

  2. 图像缓冲(Image Buffer)
    解码后的像素矩阵(如 RGBA 位图),可被 GPU/CPU 渲染。其大小与分辨率(宽×高×通道数)成正比,与压缩格式无关。

因此,解码(Decoding) 的含义是:将 Data Buffer 转换为 Image Buffer。该过程是 CPU 密集型,且解码后的图像缓冲往往远大于原始数据(例如一张 4K 图片可解码为上百 MB 像素数据)。系统会在首次渲染时触发解码,若在主线程进行,易造成卡顿;若不经控制,大图会带来内存峰值与 OOM 风险。

双缓冲概念可归纳为

┌─────────────────┐     decode      ┌─────────────────┐
│  Data Buffer    │  ────────────►  │  Image Buffer   │
│ (JPEG/PNG/…)    │   (CPU 密集)     │  (像素矩阵)      │
└─────────────────┘                 └─────────────────┘
      体积较小                          体积 ∝ 宽×高×4

Apple 在 WWDC 2018「Image and Graphics Best Practices」[1] 中明确指出:解码后的缓冲区大小由图像尺寸决定,而非显示尺寸;因此在解码阶段就做下采样(Downsampling),避免先解码全尺寸再缩放的巨大内存与 CPU 开销。

2. 缩略图与下采样(Downsampling)

下采样指在解码时直接生成较小尺寸的位图,而不是先解码全图再缩放。这样既能减少内存占用,也能减少解码与后续绘制的计算量。

2.1 系统 API:ImageIO 与缩略图

在 iOS/macOS 上,推荐使用 ImageIOCGImageSourceCreateThumbnailAtIndex 在解码阶段就限制最大尺寸,从而在内存中只生成缩略图级别的像素缓冲 [2][3]。

算法思路(伪代码)

函数 DownsampleImage(数据 data, 最大边长 maxPixelSize):
    1. 使用 data 创建 CGImageSourceRef source
    2. 设置选项 options:
       - kCGImageSourceCreateThumbnailFromImageAlways: true
       - kCGImageSourceCreateThumbnailWithTransform: true
       - kCGImageSourceThumbnailMaxPixelSize: maxPixelSize
    3. thumbnail = CGImageSourceCreateThumbnailAtIndex(source, 0, options)
    4. 由 thumbnail 创建 UIImage/NSImage 并返回

这样,解码器内部可以在部分解码低分辨率解码路径上生成缩略图,避免全图解码。SDWebImage 在 5.x 中通过 SDImageCoderDecodeScaleDownLimitBytes 等能力,将「按目标尺寸或字节限制做缩略图解码」纳入其解码管线,与上述思路一致。

2.2 下采样算法与内存估算

算法步骤(与 ImageIO 语义一致)

  1. Data 创建 CGImageSourceRef,不立即解码全图。
  2. 从 source 读取图像属性(宽、高),计算缩放比例,使长边不超过 maxPixelSize
  3. 设置 kCGImageSourceThumbnailMaxPixelSizekCGImageSourceCreateThumbnailFromImageAlwayskCGImageSourceCreateThumbnailWithTransform 等选项。
  4. 调用 CGImageSourceCreateThumbnailAtIndex(source, 0, options) 得到缩略图 CGImage
  5. CGImage 创建 UIImage/NSImage 并返回。

这样解码器在内部只生成目标尺寸的像素缓冲,避免「先全图解码再缩放」的双倍内存与 CPU 开销。

2.3 内存与性能关系

下采样带来的内存节省可近似表示为:

  • 全图解码:memory ≈ width × height × 4(假设 RGBA)。
  • 限制最大边长 L 后:若等比缩放,则 memory ≈ L² × 4,与原始分辨率无关。

因此,在列表、缩略图等场景下,在解码阶段就限制最大尺寸是业界公认的最佳实践,也是 SDWebImage 解码管线优化的核心之一。

3. 渐进式解码(Progressive Decoding)

渐进式编码(如 Progressive JPEG)允许数据分块到达时逐步呈现:先看到模糊全图,再随数据增多逐步变清晰。渐进式解码即在未完整接收数据时,对当前已有数据做解码并显示,以提升感知性能(尤其在弱网环境)[4]。

流程概念

sequenceDiagram
    participant N as 网络
    participant D as 渐进式解码器
    participant V as 视图

    N->>D: 数据块 1
    D->>D: 解码当前数据
    D->>V: 显示低分辨率帧 1
    N->>D: 数据块 2
    D->>D: 更新解码状态,解码
    D->>V: 显示更清晰帧 2
    N->>D: 数据块 n(完成)
    D->>D: 最终解码
    D->>V: 显示最终图像

SDWebImage 通过 SDWebImageProgressiveCoder 协议扩展解码器:支持「增量数据」输入,每次 updateIncrementalData:finished: 时更新内部解码状态并输出当前可用的图像,供上层展示。对动图(如 GIF),还可配合 SDAnimatedImageCoder 在渐进加载时逐帧解码并驱动 SDAnimatedImageView 的渐进动画。

渐进式解码流程(伪代码)

函数 ProgressiveDecode:
    状态: 已接收数据 buffer, 解码器内部状态 decoderState
    当 收到新数据块 chunk:
        append(buffer, chunk)
        decodedFrame = decoder.decodeIncremental(buffer, decoderState)
        若 decodedFrame 非空:
            回调 onPartialImage(decodedFrame)
    当 数据接收完成:
        finalImage = decoder.finalize(buffer, decoderState)
        回调 onComplete(finalImage)

注意:渐进式解码比单次完整解码的 CPU 开销更高 [4],适合「先显示再细化」的体验需求,需在流畅度与电量之间做权衡。

4. 编解码器扩展与多格式支持

SDWebImage 将「解码 / 编码」抽象为 SDImageCoder 协议,通过 SDImageCodersManager 注册多个 Coder,按数据格式(或 MIME 类型)选择对应实现。这样可在不修改核心管线的前提下支持新格式。

解码器选择与解码流程(高层)

flowchart TD
    A[Image Data] --> B{SDImageCodersManager}
    B --> C[遍历已注册 Coder]
    C --> D{canDecodeFromData?}
    D -->|是| E[该 Coder 解码]
    D -->|否| C
    E --> F[UIImage/NSImage]
    F --> G[可选: 缩略图/字节限制]
    G --> H[解码结果]

典型 Coder 职责

方法/能力 含义
decodedImageWithData:options: 将 Data 解码为 UIImage/NSImage
encodedDataWithImage:format:options: 将图像编码为指定格式 Data
canDecodeFromData: / canEncodeToFormat: 是否支持某格式的解码/编码

动图则通过 SDAnimatedImageCoder 扩展:提供按帧解码、帧时长、循环次数等,供 SDAnimatedImage + SDAnimatedImageView 使用。内置支持 GIF、WebP、APNG、HEIC 动图等;用户也可实现自定义 Coder 并注册,从而纳入统一的加载与缓存流程。


三、图像变换管线(Transformer Pipeline)

1. 变换器的设计思想与协议

图像变换在 SDWebImage 中定义为:输入与输出均为图像对象(如 UIImage/NSImage)的运算。与 Coder(Data ↔ Image)不同,Transformer 只做 Image → Image,例如缩放、裁剪、圆角、滤镜等,对应「数字图像处理」中的几何变换与像素操作 [5]。

协议设计(概念)

协议 SDImageTransformer:
    方法 transform(image, key) -> Image?:
        输入: 原始图像、缓存 key(可选,用于生成变换后的 cache key)
        输出: 变换后的图像;失败可返回 nil

这样设计便于:

  • SDWebImageManager 中,在「解码完成」之后、「写入缓存」之前插入变换步骤;
  • 对同一 URL 可因不同变换参数得到不同 cache key,从而分别缓存原图与变换结果。

2. 内置变换器与组合管线

SDWebImage 提供多种内置 Transformer,覆盖常见 UI 需求:

变换器 功能说明
SDImageResizingTransformer 缩放到指定尺寸,支持 scaleMode(fill/aspectFit 等)
SDImageCroppingTransformer 按矩形裁剪
SDImageRoundCornerTransformer 圆角(可带边框)
SDImageRotationTransformer 按角度旋转,可选 fitSize
SDImageFlippingTransformer 水平/垂直翻转
SDImageBlurTransformer 高斯模糊
SDImageTintTransformer 颜色 tint
SDImageFilterTransformer 基于 CIFilter 的滤镜(除 watchOS 外)

组合管线:通过 SDImagePipelineTransformer 将多个 Transformer 按顺序组合,形成链式处理:

图像 → Transformer1 → Transformer2 → … → TransformerN → 最终图像

例如先裁剪再圆角再缩放,只需将三个 Transformer 放入一个 Pipeline 即可。对应伪代码:

pipeline = SDImagePipelineTransformer([CropTransformer(rect), RoundCornerTransformer(radius), ResizingTransformer(size)])
resultImage = pipeline.transform(originalImage, key)

在 Swift/Objective-C 中的用法可参见官方 Advanced Usage - Image Transformer [6]。

3. 变换与缓存的协同

变换发生在 Manager 层:
先由 Loader 得到 Data,由 Coder 解码得到 Image,再经 Transformer 得到最终 Image,最后再写入 Cache 并交给 UI。因此:

  • 原始图变换后的图可以分别缓存:
    • 原图可用 SDWebImageContextOriginalImageCache 指定单独缓存实例;
    • 变换后的图使用默认(或指定)的 Cache,其 cache key 会包含变换信息,避免不同变换结果互相覆盖。
  • 若只关心「下载 + 变换」而不写缓存,可通过 .fromLoaderOnlystoreCacheType = .none 实现,仅走 Loader → 解码 → 变换 → 回调,不读/写缓存。

变换与缓存的整体管线(含解码)

flowchart LR
    subgraph 请求
        U[URL + Context]
    end
    subgraph 缓存查询
        C1{查 Cache}
    end
    subgraph 加载与解码
        L[Loader]
        D[Coder 解码]
    end
    subgraph 变换
        T[Transformer]
    end
    subgraph 写回与展示
        C2[写 Cache]
        V[View]
    end
    U --> C1
    C1 -->|命中| V
    C1 -->|未命中| L --> D --> T --> C2 --> V

4. 应用场景简述

场景 解码侧 变换侧
列表缩略图 使用 scaleDown/limitBytes 做缩略图解码,降低内存 可选 ResizingTransformer 统一尺寸
头像/圆角 常规解码即可 RoundCornerTransformer
弱网/大图 Progressive Coder 渐进显示 可配合 Resizing 限制最终尺寸
相册/大图预览 原图或高分辨率解码 少用或仅做旋转/裁剪
动图(GIF/WebP) SDAnimatedImageCoder + 帧缓冲 一般不做几何变换,或仅对首帧做

四、类结构图分析

1. 核心类总览

SDWebImage 的类可按职责分为:入口与协调加载缓存解码变换视图扩展 六类。下表给出核心类及其职责(名称以 5.x 为主,OC/Swift 可能略有差异)。

模块 核心类 / 协议 职责简述
协调 SDWebImageManager 统一入口:协调 Loader、Cache、Coder、Transformer,执行「查缓存 → 下载 → 解码 → 变换 → 写缓存」
加载 SDImageLoader (协议) 定义加载接口:根据 URL 返回 Data 或 Image
SDWebImageDownloader 默认 Loader 实现:基于 URLSession 下载,支持并发、取消、RequestModifier
SDWebImageDownloaderOperation 单次下载任务,实现 SDWebImageDownloaderOperation 协议
缓存 SDImageCache 内存 + 磁盘二级缓存,提供 query/store/remove,支持自定义 key、过期策略
SDMemoryCache / SDDiskCache 内存层、磁盘层具体实现(5.x 可拆分)
解码 SDImageCoder (协议) 定义 Data ↔ Image 编解码,如 decodedImageWithData:options:
SDImageCodersManager 管理多个 Coder,按数据格式选择可用 Coder
SDWebImageImageIOCoder 内置 Coder 实现(JPEG/PNG/HEIC/…)
变换 SDImageTransformer (协议) 定义 Image → Image 变换,如 transformedImageWithImage:forKey:
SDImagePipelineTransformer 将多个 Transformer 串联为一条管线
SDImageResizingTransformer 内置 Transformer 实现
视图 UIImageView+WebCache 为 UIImageView 提供 sd_setImage(with:...)sd_cancelCurrentImageLoad
SDAnimatedImageView 动图展示,配合 SDAnimatedImage
UIButton+WebCache 其他控件的扩展

2. 模块划分与依赖关系

下图从「模块」维度表示各层之间的依赖方向:视图扩展依赖 Manager,Manager 依赖 Loader/Cache,解码与变换在 Manager 内被调用,Loader 只产出 Data,Cache 只做存取。

flowchart TB
    subgraph 视图层
        V1[UIImageView+WebCache]
        V2[UIButton+WebCache]
        V3[SDAnimatedImageView]
    end
    subgraph 协调层
        M[SDWebImageManager]
    end
    subgraph 加载层
        L[SDWebImageDownloader]
    end
    subgraph 缓存层
        C[SDImageCache]
    end
    subgraph 编解码层
        CM[SDImageCodersManager]
        CO[SDImageCoder 实现]
    end
    subgraph 变换层
        T[SDImageTransformer 实现]
    end
    V1 --> M
    V2 --> M
    V3 --> M
    M --> L
    M --> C
    M --> CM
    M --> T
    CM --> CO

3. 加载与缓存类结构

Loader 负责从网络(或自定义来源)获取数据;Cache 负责内存与磁盘的读写。Manager 持有两者引用,在单次请求中先问 Cache,未命中再调 Loader。

classDiagram
    class SDWebImageManager {
        -imageLoader: SDImageLoader
        -imageCache: SDImageCache
        +loadImage(with:options:context:progress:completed:)
        -callLoadImage(with:options:context:progress:completed:)
    }
    class SDImageLoader {
        <<protocol>>
        +requestImageWithURL:options:context:progress:completed()
        +canRequestImageForURL()
    }
    class SDWebImageDownloader {
        -session: URLSession
        -downloadQueue: NSOperationQueue
        +downloadImageWithURL:options:progress:completed()
    }
    class SDImageCache {
        -memoryCache: SDMemoryCache
        -diskCache: SDDiskCache
        +queryImageForKey:options:context:callback()
        +storeImage:imageData:forKey:completion()
        +removeImageForKey:withCompletion()
    }
    SDWebImageManager --> SDImageLoader : 使用
    SDWebImageManager --> SDImageCache : 使用
    SDWebImageDownloader ..|> SDImageLoader : 实现
  • SDWebImageManager:对外提供 loadImage(with:...),内部先查 imageCache,再根据需要调用 imageLoader,最后根据 context 决定是否解码、变换并写回缓存。
  • SDWebImageDownloader:实现 SDImageLoader 协议,通过 URLSession 下载,支持并发数、超时、RequestModifier;单次下载封装为 SDWebImageDownloaderOperation
  • SDImageCache:内存缓存通常用 NSCache 或自研 LRU,磁盘缓存为文件系统;query/store 的 key 由 Manager 根据 URL + context(含 transformer 等)生成。

4. 解码与变换类结构

Coder 将 Data 转为 Image(或反向);Transformer 将 Image 转为另一 Image。Manager 在「Loader 返回 Data 后」先选 Coder 解码,再按 context 中的 Transformer 做变换,得到最终 Image 再写入 Cache。

classDiagram
    class SDWebImageManager {
        -loadImage(with:...)
    }
    class SDImageCoder {
        <<protocol>>
        +decodedImageWithData:options()
        +encodedDataWithImage:format:options()
        +canDecodeFromData()
        +canEncodeToFormat()
    }
    class SDImageCodersManager {
        -coders: [SDImageCoder]
        +addCoder()
        +removeCoder()
        +canDecodeFromData()
        +decodedImageWithData:options()
    }
    class SDImageTransformer {
        <<protocol>>
        +transformerKey
        +transformedImageWithImage:forKey()
    }
    class SDImagePipelineTransformer {
        -transformers: [SDImageTransformer]
        +transformerKey
        +transformedImageWithImage:forKey()
    }
    SDWebImageManager ..> SDImageCodersManager : 解码时使用
    SDWebImageManager ..> SDImageTransformer : 变换时使用
    SDImageCodersManager --> SDImageCoder : 委托具体 Coder
    SDImagePipelineTransformer ..|> SDImageTransformer : 实现
  • SDImageCodersManager:持有一组 SDImageCoder,按 canDecodeFromData: 选出第一个能处理当前 Data 的 Coder 执行解码;编码同理。
  • SDImagePipelineTransformer:持有一组 SDImageTransformer,按顺序对 Image 依次变换;其 transformerKey 通常由各子 Transformer 的 key 拼接而成,参与缓存 key 生成。

5. View 扩展与调用链

视图扩展(如 UIImageView+WebCache)是业务最常接触的入口:内部将「当前 URL、placeholder、options、context」交给 SDWebImageManager,并把返回的加载任务与 view 关联,以便在复用时取消。

sequenceDiagram
    participant V as UIImageView
    participant Ext as UIImageView+WebCache
    participant M as SDWebImageManager
    participant C as SDImageCache
    participant L as SDWebImageDownloader

    V->>Ext: sd_setImage(with: url, ...)
    Ext->>Ext: sd_cancelCurrentImageLoad()
    Ext->>M: loadImage(with: url, context: [...])
    M->>C: queryImage(forKey:)
    alt 缓存命中
        C-->>M: image
        M-->>Ext: completed(image, .memory/.disk)
    else 未命中
        M->>L: requestImageWithURL:...
        L-->>M: data
        M->>M: 解码 + 变换
        M->>C: storeImage(forKey:)
        M-->>Ext: completed(image, .none)
    end
    Ext->>V: imageView.image = image
  • sd_setImage(with: placeholder: options: context: completed:):先对当前 view 取消未完成任务,再调 SDWebImageManager.shared.loadImage(with: url, options: options, context: context, progress: progress, completed: completed);在 completed 中把得到的 image 赋给 imageView.image(并可选执行 transition 动画)。
  • sd_cancelCurrentImageLoad():取消与该 view 绑定的 load 任务,避免 cell 复用时旧请求覆盖新图片。

将上述「核心类总览」「模块依赖」「Loader/Cache 类图」「Coder/Transformer 类图」「View 调用链」串联起来,即可形成对 SDWebImage 类结构图 的完整分析:入口在视图扩展,核心协调在 Manager,加载与缓存、解码与变换均为可插拔的协议实现,便于扩展与测试。


五、与系统及业界实践的衔接

1. Apple 图像与图形最佳实践

Apple 在 WWDC 2018「Image and Graphics Best Practices」[1] 中强调:

  • 在后台线程进行解码与下采样,避免在主线程做重 CPU 工作导致的卡顿。
  • 解码时即做下采样,使解码后的图像缓冲与显示尺寸匹配,降低内存与 CPU。
  • 预取(Prefetch):在列表等场景提前准备即将显示的图像,避免在滚动时才开始解码。

SDWebImage 的解码与变换均在后台队列执行,且支持按尺寸/字节限制的缩略图解码,与上述建议一致。其 Prefetch 能力(如 UITableView 的 prefetch 结合 sd_setImageWithURL:)可在业务层配合使用,实现「提前解码、避免滚动时卡顿」。

Force Decode 策略(5.17+):SDWebImage 引入 SDImageForceDecodePolicy,用于控制是否在加载管线中强制解码(将延迟解码的图片提前转为位图)。在部分场景下可避免在渲染阶段才触发 CA 的帧缓冲拷贝,从而降低主线程峰值与内存抖动;具体策略可根据「是否使用自定义渲染」「是否配合 Transformer」等选择,详见官方文档与 CHANGELOG。

2. 移动端图像管线研究简述

在移动端部署图像管线(含解码、缩放、轻量级「变换」)方面,业界与学界有大量工作:

  • FlexiViT [7] 等通过可变的 patch 尺寸在训练与推理时平衡精度与速度;
  • NanoFLUX [8]、SnapGen [9] 等关注在移动设备上的高效图像生成与压缩。
    这些工作与「在端侧做高效解码与分辨率控制」的目标一致:在有限算力与内存下,通过解码阶段控制(如缩略图、渐进解码)和管线化处理(解码 → 变换 → 缓存)提升体验。SDWebImage 的 Decoder + Transformer 双管线正是这一思路在「图片加载库」中的具体实现。

六、使用案例与原理分析

0. 框架结构速览

0.1 实现原理

  1. 架构图(UML 类图)

架构图(UML 类图)

  1. 流程图(方法调用顺序图)

1559217862563-364c0d60-3f2a-4db9-b5c5-e81f01cd125e.png

0.2 目录结构

  • Downloader\
    • SDWebImageDownloader\
    • SDWebImageDownloaderOperation
  • Cache\
    • SDImageCache
  • Utils\
    • SDWebImageManager\
    • SDWebImageDecoder\
    • SDWebImagePrefetcher
  • Categories\
    • UIView+WebCacheOperation\
    • UIImageView+WebCache\
    • UIImageView+HighlightedWebCache\
    • UIButton+WebCache\
    • MKAnnotationView+WebCache\
    • NSData+ImageContentType\
    • UIImage+GIF\
    • UIImage+MultiFormat\
    • UIImage+WebP
  • Other\
    • SDWebImageOperation(协议)\
    • SDWebImageCompat(宏定义、常量、通用函数)

0.3 相关类名与功能描述

  • SDWebImageDownloader:是专门用来下载图片和优化图片加载的,跟缓存没有关系
  • SDWebImageDownloaderOperation:继承于 NSOperation,用来处理下载任务的
  • SDImageCache:用来处理内存缓存和磁盘缓存(可选)的,其中磁盘缓存是异步进行的,因此不会阻塞主线程
  • SDWebImageManager:作为 UIImageView+WebCache 背后的默默付出者,主要功能是将图片下载(SDWebImageDownloader)和图片缓存(SDImageCache)两个独立的功能组合起来
  • SDWebImageDecoder:图片解码器,用于图片下载完成后进行解码
  • SDWebImagePrefetcher:预下载图片,方便后续使用,图片下载的优先级低,其内部由 SDWebImageManager 来处理图片下载和缓存
  • UIView+WebCacheOperation:用来记录图片加载的 operation,方便需要时取消和移除图片加载的 operation
  • UIImageView+WebCache:集成 SDWebImageManager 的图片下载和缓存功能到 UIImageView 的方法中,方便调用方的简单使用
  • UIImageView+HighlightedWebCache:跟 UIImageView+WebCache 类似,也是包装了 SDWebImageManager,只不过是用于加载 highlighted 状态的图片
  • UIButton+WebCache:跟 UIImageView+WebCache 类似,集成 SDWebImageManager 的图片下载和缓存功能到 UIButton 的方法中,方便调用方的简单使用
  • MKAnnotationView+WebCache:跟 UIImageView+WebCache 类似
  • NSData+ImageContentType:用于获取图片数据的格式(JPEG、PNG 等)
  • UIImage+GIF:用于加载 GIF 动图
  • UIImage+MultiFormat:根据不同格式的二进制数据转成 UIImage 对象
  • UIImage+WebP:用于解码并加载 WebP 图片

0.4 工作流程

工作流程

  • 入口 setImageWithURL:placeholderImage:options: 会先把 placeholderImage 显示,然后 SDWebImageManager 根据 URL 开始处理图片。
  • 进入 SDWebImageManager-downloadWithURL:delegate:options:userInfo: 交给 SDImageCache 从缓存查找图片是否已经下载 queryDiskCacheForKey:delegate:userInfo:。
  • 先从内存图片缓存查找是否有图片,如果内存中已经有图片缓存,SDImageCacheDelegate 回调 imageCache:didFindImage:forKey:userInfo: 到 SDWebImageManager。
  • SDWebImageManagerDelegate 回调 webImageManager:didFinishWithImage: 到 UIImageView+WebCache 等前端展示图片。
  • 如果内存缓存中没有,生成 NSInvocationOperation 添加到队列开始从硬盘查找图片是否已经缓存。
  • 根据 URLKey 在硬盘缓存目录下尝试读取图片文件。这一步是在 NSOperation 进行的操作,所以回主线程进行结果回调 notifyDelegate:。
  • 如果从硬盘读取到了图片,将图片添加到内存缓存中(如果空闲内存过小,会先清空内存缓存)。SDImageCacheDelegate 回调 imageCache:didFindImage:forKey:userInfo: 进而回调展示图片。
  • 如果从硬盘缓存目录读取不到图片,说明所有缓存都不存在该图片,需要下载图片,回调 imageCache:didNotFindImageForKey:userInfo:。
  • 共享或重新生成一个下载器 SDWebImageDownloader 开始下载图片。
  • 图片下载由 NSURLConnection(3.8.0 之后使用了 NSURLSession),实现相关 delegate 来判断图片下载中、下载完成和下载失败。
  • connection:didReceiveData: 中利用 ImageIO 做了按图片下载进度加载效果。connectionDidFinishLoading: 数据下载完成后交给 SDWebImageDecoder 做图片解码处理。
  • 图片解码处理在一个 NSOperationQueue 完成,不会拖慢主线程 UI。如果有需要对下载的图片进行二次处理,最好也在这里完成,效率会好很多。
  • 在主线程 notifyDelegateOnMainThreadWithInfo: 宣告解码完成,imageDecoder:didFinishDecodingImage:userInfo: 回调给 SDWebImageDownloader。
  • imageDownloader:didFinishWithImage: 回调给 SDWebImageManager 告知图片下载完成。
  • 通知所有的 downloadDelegates 下载完成,回调给需要的地方展示图片。
  • 将图片保存到 SDImageCache 中,内存缓存和硬盘缓存同时保存。写文件到硬盘也在以单独 NSInvocationOperation 完成,避免拖慢主线程。
  • SDImageCache 在初始化的时候会注册一些消息通知,在内存警告或退到后台的时候清理内存图片缓存,应用结束的时候清理过期图片。
  • SDWebImagePrefetcher 可以预先下载图片,方便后续使用。

1. 典型使用案例

1.1 列表 Cell 中加载缩略图(防错位 + 下采样)

UITableView / UICollectionView 的 cell 中,若不限制图片尺寸,大图会带来内存峰值与卡顿;且 cell 复用时需避免「先显示旧图再被新图覆盖」的错位。SDWebImage 通过 URL 绑定取消机制 解决错位,通过 Transformer 限制尺寸 控制内存。

// Cell 内
func configure(with url: URL) {
    imageView.sd_cancelCurrentImageLoad()
    let transformer = SDImageResizingTransformer(
        size: CGSize(width: 120, height: 120),
        scaleMode: .aspectFill
    )
    imageView.sd_setImage(
        with: url,
        placeholderImage: UIImage(named: "placeholder"),
        context: [.imageTransformer: transformer]
    )
}

要点sd_cancelCurrentImageLoad() 会取消该 view 上未完成的请求,新 URL 加载完成后才设置,避免复用时显示错误图片。

1.2 预取(Prefetch)提前解码

利用系统预取 API 在 cell 尚未显示时就开始加载,滚动时直接从缓存读取,减少卡顿。

// 实现 UICollectionViewDataSourcePrefetching
func collectionView(_ collectionView: UICollectionView, prefetchItemsAt indexPaths: [IndexPath]) {
    let urls = indexPaths.compactMap { model(at: $0).imageURL }
    urls.forEach { url in
        SDWebImagePrefetcher.shared.prefetchURLs([url])
    }
}

// 可选:取消不再需要的预取
func collectionView(_ collectionView: UICollectionView, cancelPrefetchingForItemsAt indexPaths: [IndexPath]) {
    let urls = indexPaths.compactMap { model(at: $0).imageURL }
    SDWebImagePrefetcher.shared.cancelPrefetching(for: urls)
}

1.3 多设备/多 Channel 下的加载

在多设备场景(如同一 URL 在不同 Channel 下需要不同尺寸)中,通过 context 传入不同的 Transformer 或 Cache,使同一 URL 对应多条缓存条目。

// 列表用小图
imageView.sd_setImage(with: url, context: [
    .imageTransformer: SDImageResizingTransformer(size: CGSize(width: 80, height: 80), scaleMode: .aspectFill)
])

// 详情用原图或大图
detailImageView.sd_setImage(with: url)  // 不传 transformer,用原图

1.4 占位图 + 加载完成过渡动画

通过 sd_imageTransition 在图片从网络加载完成后做淡入等过渡,提升观感。

imageView.sd_imageTransition = .fade(0.25)
imageView.sd_setImage(with: url, placeholderImage: placeholder)

1.5 仅下载不展示(后台缓存)

希望提前把图片下载并写入缓存,供后续使用,而不绑定到某个 view。

SDWebImageManager.shared.loadImage(
    with: url,
    options: [],
    progress: nil
) { image, data, error, cacheType, finished, url in
    if let image = image, finished {
        // 已缓存,可做后续逻辑
    }
}

1.6 完成回调与错误处理

通过 completed 区分来源(内存/磁盘/网络)并处理失败与取消。

imageView.sd_setImage(with: url, placeholderImage: placeholder) { image, error, cacheType, url in
    if let error = error {
        // 可根据 error 类型提示用户或降级
        return
    }
    switch cacheType {
    case .none:   break // 本次从网络加载
    case .memory: break // 从内存缓存
    case .disk:   break // 从磁盘缓存
    @unknown default: break
    }
}

2. 更多使用案例与代码

2.1 UITableViewCell 完整示例(含复用与尺寸)

class PhotoCell: UITableViewCell {
    static let reuseId = "PhotoCell"
    @IBOutlet weak var photoImageView: UIImageView!
    @IBOutlet weak var progressView: UIProgressView!

    override func prepareForReuse() {
        super.prepareForReuse()
        photoImageView.sd_cancelCurrentImageLoad()
        photoImageView.image = nil
        progressView.progress = 0
    }

    func configure(with url: URL) {
        let size = photoImageView.bounds.size
        let transformer = SDImageResizingTransformer(
            size: size.isEmpty ? CGSize(width: 120, height: 120) : size,
            scaleMode: .aspectFill
        )
        photoImageView.sd_setImage(
            with: url,
            placeholderImage: UIImage(named: "placeholder"),
            context: [.imageTransformer: transformer],
            progress: { [weak self] received, total, _ in
                guard let self = self, total > 0 else { return }
                DispatchQueue.main.async {
                    self.progressView.progress = Float(received) / Float(total)
                }
            },
            completed: { [weak self] image, error, _, _ in
                DispatchQueue.main.async {
                    self?.progressView.isHidden = (image != nil)
                }
            }
        )
    }
}

2.2 UIButton 设置网络图片

// 设置不同 state 的图片
button.sd_setImage(with: url, for: .normal, placeholderImage: UIImage(named: "btn_placeholder"))
button.sd_setImage(with: highlightedURL, for: .highlighted)
button.sd_setBackgroundImage(with: backgroundURL, for: .normal)

// 带圆角与完成回调
let transformer = SDImageRoundCornerTransformer(radius: 8, corners: .allCorners, borderWidth: 0, borderColor: nil)
button.sd_setImage(with: url, for: .normal, placeholderImage: nil, context: [.imageTransformer: transformer]) { _, error, _, _ in
    if error != nil { print("加载失败") }
}

2.3 自定义缓存键(同一 URL 多用途)

当同一 URL 在不同业务下需要不同缓存(例如列表用缩略图、详情用原图)时,可用 cacheKeyFilter 或自定义 key。

// 方式一:通过 context 的 cacheKeyFilter 生成不同 key
let listKeyFilter: SDWebImageCacheKeyFilter = { url in
    return "list_\(url?.absoluteString ?? "")" as NSString
}
imageView.sd_setImage(with: url, context: [.cacheKeyFilter: listKeyFilter])

let detailKeyFilter: SDWebImageCacheKeyFilter = { url in
    return "detail_\(url?.absoluteString ?? "")" as NSString
}
detailImageView.sd_setImage(with: url, context: [.cacheKeyFilter: detailKeyFilter])

// 方式二:在业务层用不同 URL 或 query 区分(如服务端支持 ?size=thumb)
let listURL = url.appendingPathComponent("?size=thumb")
let detailURL = url
imageView.sd_setImage(with: listURL, context: [.cacheKeyFilter: listKeyFilter])
detailImageView.sd_setImage(with: detailURL, context: [.cacheKeyFilter: detailKeyFilter])

2.4 请求修饰(Header、Token、超时)

需要带鉴权或自定义 Header 时,使用 requestModifier

let modifier = SDWebImageDownloaderRequestModifier { request in
    var r = request
    r.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
    r.setValue("image/webp,image/*,*/*;q=0.8", forHTTPHeaderField: "Accept")
    r.timeoutInterval = 30
    return r
}
imageView.sd_setImage(
    with: url,
    context: [.requestModifier: modifier]
)

2.5 下载进度条 + 占位 + 过渡动画

imageView.sd_imageTransition = .fade(0.3)
imageView.sd_setImage(
    with: url,
    placeholderImage: UIImage(named: "placeholder"),
    options: [.retryFailed],
    progress: { [weak progressView] received, total, _ in
        guard let pv = progressView, total > 0 else { return }
        DispatchQueue.main.async {
            pv.progress = Float(received) / Float(total)
            pv.isHidden = false
        }
    },
    completed: { [weak progressView] image, _, cacheType, _ in
        DispatchQueue.main.async {
            progressView?.isHidden = true
            if image == nil { /* 显示失败占位 */ }
        }
    }
)

2.6 动图 GIF(SDAnimatedImageView)

// 使用 SDAnimatedImageView 播放 GIF/WebP/APNG
let animatedImageView = SDAnimatedImageView()
animatedImageView.sd_setImage(with: gifURL, placeholderImage: nil)

// 仅加载动图第一帧作为封面(节省内存)
animatedImageView.sd_setImage(with: gifURL, placeholderImage: nil, options: [.decodeFirstFrameOnly])

// 渐进式加载动图(边下边播)
animatedImageView.sd_setImage(with: gifURL, placeholderImage: nil, options: [.progressiveLoad])

2.7 缓存查询与手动存储

let cache = SDImageCache.shared
let key = url.absoluteString

// 查询是否已缓存
cache.containsImage(forKey: key) { cacheType in
    switch cacheType {
    case .none:   print("未缓存")
    case .memory: print("在内存")
    case .disk:   print("在磁盘")
    @unknown default: break
    }
}

// 从缓存读取(不触发下载)
cache.queryImage(forKey: key, options: nil, context: nil) { image, data, cacheType in
    if let image = image {
        imageView.image = image
    }
}

// 手动写入缓存(例如本地生成或从相册来的图)
cache.store(image, forKey: key, completion: nil)

2.8 自定义 Transformer 示例

实现 SDImageTransformer 协议,对已解码图像做自定义绘制或滤镜(以下方法名以 SDWebImage 5.x 协议为准,实际请参照当前版本头文件)。

// 实现协议:为图片加灰色边框
class GrayBorderTransformer: NSObject, SDImageTransformer {
    var transformerKey: String { "GrayBorder(\(borderWidth))" }
    let borderWidth: CGFloat

    init(borderWidth: CGFloat = 2) { self.borderWidth = borderWidth }

    func transformedImage(with image: UIImage, forKey key: String) -> UIImage? {
        let size = image.size
        UIGraphicsBeginImageContextWithOptions(size, false, image.scale)
        defer { UIGraphicsEndImageContext() }
        image.draw(at: .zero)
        UIColor.gray.setStroke()
        let path = UIBezierPath(rect: CGRect(origin: .zero, size: size).insetBy(dx: borderWidth/2, dy: borderWidth/2))
        path.lineWidth = borderWidth
        path.stroke()
        return UIGraphicsGetImageFromCurrentImageContext()
    }
}

// 使用
let transformer = GrayBorderTransformer(borderWidth: 3)
imageView.sd_setImage(with: url, context: [.imageTransformer: transformer])

2.9 强制刷新与仅从缓存读取

// 忽略缓存,强制重新下载(适用于需要刷新内容的场景)
imageView.sd_setImage(with: url, options: [.forceRefresh])

// 仅从缓存读取,没有则显示占位或报错(离线/省流量场景)
imageView.sd_setImage(with: url, options: [.onlyFromCache]) { image, error, _, _ in
    if image == nil { print("缓存中无此图") }
}

2.10 Objective-C 常用写法

// 基础加载
[imageView sd_setImageWithURL:url placeholderImage:[UIImage imageNamed:@"placeholder"]];

// 带 context 的 Transformer
id<SDImageTransformer> transformer = [SDImagePipelineTransformer transformerWithTransformers:@[
    [SDImageResizingTransformer transformerWithSize:CGSizeMake(100, 100) scaleMode:SDImageScaleModeFill],
    [SDImageRoundCornerTransformer transformerWithRadius:10 corners:SDRectCornerAllCorners borderWidth:0 borderColor:nil]
]];
[imageView sd_setImageWithURL:url placeholderImage:nil context:@{SDWebImageContextImageTransformer: transformer}];

// 取消当前加载
[imageView sd_cancelCurrentImageLoad];

// 完成回调
[imageView sd_setImageWithURL:url completed:^(UIImage * _Nullable image, NSError * _Nullable error, SDImageCacheType cacheType, NSURL * _Nullable imageURL) {
    if (error) { NSLog(@"加载失败: %@", error); }
}];

3. 核心流程原理分析

3.1 Manager 协调的完整链路

SDWebImageManager 是整条「加载 → 解码 → 变换 → 缓存」的协调者,其内部逻辑可概括为:

flowchart TD
    A[loadImageWithURL] --> B{查缓存 key}
    B --> C[先查内存]
    C --> D{命中?}
    D -->|是| E[回调 .memory]
    D -->|否| F[再查磁盘]
    F --> G{命中?}
    G -->|是| H[解码/反序列化]
    H --> I[写回内存]
    I --> E
    G -->|否| J[构造 Loader 任务]
    J --> K[Loader 返回 Data]
    K --> L[Coder 解码]
    L --> M{有 Transformer?}
    M -->|是| N[Transformer 变换]
    M -->|否| O[得到 Image]
    N --> O
    O --> P[写内存+磁盘缓存]
    P --> Q[回调 .none 或 .disk]

要点

  • 缓存 key 由 URL(或自定义 key)与 context(如 transformer、cacheKeyFilter)共同决定,同一 URL 不同 transformer 会得到不同 key。
  • 解码与变换均在 Manager 持有的串行/并发队列 中执行,回调通过 dispatch_async(main_queue) 回到主线程,便于更新 UI。

3.2 回调与线程模型

  • progress:在下载进度回调所在线程(多为 URLSession 回调线程),若需更新 UI 需自行切主线程。
  • completed:SDWebImage 内部会派发到主线程再调用,因此 completed 里可直接操作 UI。
  • 取消:当再次对同一 view 调用 sd_setImage(with: newURL) 时,会取消该 view 上此前由 SDWebImage 发起的任务,completed 仍可能被调用一次(cancel 语义),可通过 SDWebImageOption 或检查 finished 区分。

3.3 缓存键与 Transformer 的关系

变换后的图片会以「新 key」写入缓存:通常为 key + transformerIdentifier 或等价组合。因此:

  • 原图:key = url.absoluteString(或自定义)。
  • 变换图:key = f(url, transformer),例如 url.absoluteString + "_" + transformer.identifier

这样同一 URL 可同时存在「原图」与「缩放版」「圆角版」等多份缓存,互不覆盖;原图也可通过 SDWebImageContextOriginalImageCache 写入单独缓存实例,供大图页等使用。


七、设计模式与编程思想

1. 设计模式应用

SDWebImage 在架构上大量运用经典设计模式,使扩展与维护成本可控。

模式 在 SDWebImage 中的体现 作用
外观 / 门面(Facade) SDWebImageManager 对外提供 loadImage(with:options:progress:completed:),内部协调 Loader、Cache、Coder、Transformer,调用方无需关心多级缓存与管线顺序 简化使用、隐藏复杂度
策略(Strategy) SDImageTransformerSDImageCoder 均为协议,多种实现可替换(Resizing、RoundCorner、WebP Coder 等),通过 context 或注册表注入 算法/行为可插拔,易扩展新格式与新变换
责任链 / 管道(Chain of Responsibility / Pipeline) SDImagePipelineTransformer 将多个 Transformer 串联;解码管线中 Coder 的选取也可视为「按责任链匹配 canDecodeFromData」 多步处理顺序清晰,便于组合与复用
单例 + 共享依赖(Singleton) SDWebImageManager.sharedSDImageCache.sharedSDWebImageDownloader.shared 提供默认实例,同时支持传入自定义 Cache/Loader 以打破单例 全局统一入口,又保留可测试性与多实例能力
观察者 / 回调(Observer / Callback) 通过 progresscompleted 闭包通知进度与结果;部分能力通过 delegate 扩展 异步结果与 UI 解耦
工厂思想(Factory) SDImageCodersManager 根据 Data 格式选择 Coder;Loader 根据 URL 或 scheme 选择具体 Loader 实现 创建逻辑集中,便于支持新协议与新格式

类图关系(概念层)

classDiagram
    class SDWebImageManager {
        -cache: SDImageCache
        -loader: SDImageLoader
        +loadImage(with:options:progress:completed:)
    }
    class SDImageCache {
        +store(_:forKey:)
        +queryImage(forKey:options:callback:)
    }
    class SDImageLoader {
        +loadImage(with:options:progress:completed:)
    }
    class SDImageCoder {
        <<protocol>>
        +decodedImageWithData:options:
        +canDecodeFromData:
    }
    class SDImageTransformer {
        <<protocol>>
        +transform(image:key:)
    }
    SDWebImageManager --> SDImageCache : 使用
    SDWebImageManager --> SDImageLoader : 使用
    SDWebImageManager ..> SDImageCoder : 解码时选用
    SDWebImageManager ..> SDImageTransformer : 变换时选用

2. 编程思想精华

SDWebImage 的编程思想可提炼为以下几点,对理解与模仿其设计很有帮助。

2.1 协议导向与「可替换实现」

  • CoderTransformerLoaderCache 均以协议或抽象接口呈现,具体实现可替换、可组合。
  • 新增一种图片格式或一种变换,只需实现对应协议并注册,无需改动 Manager 核心流程。这体现了开闭原则:对扩展开放,对修改关闭。

2.2 管线化与单一职责

  • 把「从 URL 到屏幕」拆成:加载 → 解码 → 变换 → 缓存 → 展示,每一步只做一件事。
  • 解码只关心 Data → Image,变换只关心 Image → Image,缓存只关心存储与查找。单一职责使每块可独立测试、优化和扩展;管线化则使数据流清晰,便于加日志、监控和插桩。

2.3 缓存键与「同一资源多形态」

  • 通过 key = f(URL, context) 的设计,同一 URL 可以对应「原图」「缩略图」「圆角图」等多条缓存,避免重复下载,又满足不同场景对尺寸/形态的需求。这体现了用键设计表达业务差异的思想。

2.4 后台处理与主线程回调

  • 解码、变换、磁盘 I/O 均在后台队列执行,completed 回调派发到主线程,兼顾性能与 UI 安全。这是移动端异步加载库的通用范式:重活放后台,结果回主线程

2.5 取消与生命周期绑定

  • View 扩展(如 UIImageView+WebCache)会把「当前正在进行的任务」与 view 绑定,当对同一 view 发起新请求时自动取消旧请求,避免错位和浪费。这体现了生命周期与请求绑定的思想,在列表场景中尤为重要。

2.6 配置通过 Context 透传

  • 不通过全局单例属性堆砌配置,而是通过 SDWebImageContext 在单次请求中传入 Cache、Transformer、Loader、CacheKeyFilter 等,使「同一 App 内不同页面/模块」可使用不同策略,且易于单元测试时注入 mock。

SDWebImage 编程思想精华一览

思想 在框架中的体现
协议导向、可替换 Coder / Transformer / Loader 协议化,新格式、新变换仅需实现协议并注册
管线化、单一职责 加载 → 解码 → 变换 → 缓存 → 展示,每步职责单一,便于扩展与测试
键设计表达多形态 同一 URL 通过 key = f(URL, context) 支持原图、缩略图、圆角图等多条缓存
后台处理、主线程回调 重 CPU/IO 在后台队列,completed 回主线程,兼顾性能与 UI 安全
生命周期绑定取消 View 与当前任务绑定,新请求自动取消旧请求,避免列表错位
Context 透传配置 单次请求级配置,避免全局状态,利于多策略并存与测试注入

八、使用示例与最佳实践

1. 使用内置变换器(缩放 + 圆角)

let transformer = SDImagePipelineTransformer(transformers: [
    SDImageResizingTransformer(size: CGSize(width: 300, height: 300), scaleMode: .fill),
    SDImageRoundCornerTransformer(radius: 20, corners: .allCorners, borderWidth: 0, borderColor: nil)
])
imageView.sd_setImage(with: url, placeholderImage: nil, context: [.imageTransformer: transformer])

2. 仅下载并变换、不写缓存

SDWebImageManager.shared.loadImage(
    with: url,
    options: [.fromLoaderOnly],
    context: [.storeCacheType: SDImageCacheType.none.rawValue, .imageTransformer: transformer],
    progress: nil
) { image, _, _, _, _, _ in
    // 使用变换后的 image
}

3. 渐进式加载(渐进解码)

imageView.sd_setImage(with: url, placeholderImage: nil, options: [.progressiveLoad])

4. 自定义 Coder 注册(以 WebP 为例)

SDImageCodersManager.shared.addCoder(SDImageWebPCoder.shared)

5. 最佳实践小结

  • 列表/网格:cell 内先 sd_cancelCurrentImageLoad(),再 sd_setImage,并配合 Transformer 限制尺寸或使用下采样选项,减少内存与错位。
  • 预取:用 SDWebImagePrefetcher 或系统 prefetch API 提前加载即将出现的图片,滚动时优先命中缓存。
  • 大图/详情:列表用缩小版 Transformer,详情页用原图或单独 OriginalImageCache,避免重复下载。
  • 动图:使用 SDAnimatedImageView + SDAnimatedImage,并视情况注册 GIF/WebP/APNG 等 Coder。
  • 扩展与测试:自定义 Coder/Transformer 通过协议实现并注册;通过 context 注入自定义 Cache/Loader 便于单测与多策略并存。

九、常见面试题

1. 图片文件缓存的时间有多长?

一周。_maxCacheAge = kDefaultCacheMaxCacheAge

2. SDWebImage 的内存缓存是用什么实现的?

NSCache

3. SDWebImage 的最大并发数是多少?

maxConcurrentDownloads = 6(程序固定,可通过属性调整)

4. SDWebImage 支持动图吗?GIF

支持。示例:

#import <ImageIO/ImageIO.h>
[UIImage animatedImageWithImages:images duration:duration];

5. SDWebImage 是如何区分不同格式的图像的?

  • 根据图像数据第一个字节来判断
  • PNG:压缩比没有 JPG 高,但无损压缩,解压缩性能高,苹果推荐的图像格式
  • JPG:压缩比最高的一种图片格式,有损压缩,最多使用的场景如照相机,解压缩性能不好
  • GIF:序列帧动图,只支持 256 种颜色,曾流行于 1998~1999,有专利

6. SDWebImage 缓存图片的名称是怎么确定的?

  • 使用 md5 对完整 URL 做散列,得到 32 位字符串作为文件名;若单纯用文件名保存,重名几率高

7. SDWebImage 的内存警告是如何处理的?

  • 利用通知中心观察:
    • UIApplicationDidReceiveMemoryWarningNotification:接收到内存警告后执行 clearMemory,清理内存缓存
    • UIApplicationWillTerminateNotification:接收到应用将要终止后执行 cleanDisk,清理磁盘缓存
    • UIApplicationDidEnterBackgroundNotification:接收到应用进入后台后执行 backgroundCleanDisk,后台清理磁盘
  • 通过以上通知监听,保证缓存文件大小在控制范围内;clearDisk 可清空磁盘缓存,删除缓存目录中全部文件

参考文献

[1] Apple. Image and Graphics Best Practices. WWDC 2018, Session 219.
[2] Stack Overflow / Apple. Creating a thumbnail from UIImage using CGImageSourceCreateThumbnailAtIndex.
[3] Apple. Image decompression strategies for performance. developer.apple.com/forums/thread/653738.
[4] Ctrl.blog. Progressive JPEG loading; Google 研究:渐进解码约 3 倍于 baseline 的 CPU 开销.
[5] Wikipedia. Digital image processing.
[6] SDWebImage. Advanced Usage - Image Transformer, Custom Coder. GitHub Wiki.
[7] Beyer et al. FlexiViT: One Model for All Patch Sizes. CVPR 2023.
[8] NanoFLUX. Distillation-Driven Compression of Large Text-to-Image Generation Models for Mobile Devices. arXiv.
[9] SnapGen. Taming High-Resolution Text-to-Image Models for Mobile Devices. arXiv 2024.

04-研究优秀开源框架@响应式编程@iOS | RxSwift框架:从使用到源码解析

📋 目录


一、RxSwift框架使用详解

1. RxSwift框架概述

RxSwift 是 ReactiveX(Reactive Extensions)的 Swift 实现,是一个用于处理异步事件流的函数式响应式编程框架。

1.1 什么是RxSwift

RxSwift 基于观察者模式,允许你通过组合不同的操作符来处理异步事件序列。它提供了声明式的 API 来处理时间序列数据。

核心特点:

  • 响应式编程:基于观察者模式的事件驱动编程
  • 函数式编程:使用高阶函数和操作符组合
  • 类型安全:充分利用 Swift 的类型系统
  • 跨平台:基于 ReactiveX 标准,与其他平台一致
  • 丰富的操作符:提供大量操作符处理各种场景

1.2 RxSwift vs Combine

特性 RxSwift Combine
平台 跨平台(iOS、macOS、watchOS、tvOS) Apple 生态(iOS 13+)
语言 Swift Swift
官方支持 ❌ 第三方(ReactiveX) ✅ Apple 官方
最低版本 iOS 8.0+ iOS 13.0+
API风格 ReactiveX 标准 Apple 风格
学习曲线 陡峭 中等
生态 丰富(RxCocoa、RxDataSources等) 官方集成(SwiftUI)

1.3 RxSwift生态系统

  • RxSwift:核心框架
  • RxCocoa:UIKit/AppKit 集成
  • RxDataSources:TableView/CollectionView 数据源
  • RxTest:测试工具
  • RxBlocking:阻塞操作符(用于测试)

1.4 安装方式

CocoaPods:

pod 'RxSwift', '~> 6.0'
pod 'RxCocoa', '~> 6.0'

SPM:

dependencies: [
    .package(url: "https://github.com/ReactiveX/RxSwift.git", from: "6.0.0")
]

1.5 编程思想(背后的范式与理念)

为什么要先谈编程思想?
会用 RxSwift 的 API(ObservablesubscribemapflatMap 等)不等于能写好响应式架构。很多「看起来能跑」的代码其实仍是用响应式语法写命令式逻辑(例如在 subscribe 里写满 if-else、嵌套请求),难以测试、难以复用。先理解背后的范式与理念,再写代码,才能做到「用对场景、写对抽象、边界清晰」。RxSwift 与 Combine 同属 ReactiveX 一脉,背后的编程思想高度一致;理解这些思想有助于写出更清晰、可维护的响应式代码。

范式定位:FRP(函数式响应式编程)
RxSwift 是 FRP(Functional Reactive Programming) 的一种实现:用函数式组合与不可变方式,处理响应式事件流。不是「要么函数式要么响应式」,而是两者结合——流用操作符做纯变换(函数式),用订阅对事件做出反应(响应式)。了解这一点,就不会把 Rx 单纯当成「另一种回调封装」,而是从「流 + 变换 + 订阅」的视角设计数据与 UI 的边界。


(1)响应式编程(Reactive Programming)

  • 核心:将「数据与事件」视为随时间发生的事件序列,通过订阅对序列中的每一项做出反应,而不是主动轮询或层层回调。
  • 在 RxSwift 中Observable 表示一条事件流,Observer 通过 subscribe 订阅后,在 onNext / onError / onCompleted 中响应;按钮点击、网络返回、定时器都可统一为 Observable,用同一套操作符处理。
  • 思维转变:从「先调 A,等回调再调 B」变为「当流里出现某类事件时,执行 B」,逻辑由数据/事件驱动。

(2)声明式 vs 命令式

维度 命令式(Imperative) 声明式(Declarative)
关注点 「怎么做」:显式控制顺序与分支 「做什么」:描述结果与数据变换关系
典型写法 for 循环、if-else、嵌套回调 链式操作符:map / filter / flatMap / combineLatest
在 RxSwift 中 手写「请求 → 回调里解析 → 再请求」 observable.map(...).flatMap(...).subscribe(...) 描述整条流水线

声明式让「数据从哪来、怎么变、到哪去」一目了然,便于阅读和单元测试。

从 OOP/命令式到响应式的思维转变:传统写法习惯「谁持有谁、谁调谁」——对象持有状态,方法里 if-else 控制流程,异步靠回调或 delegate。响应式则把「谁在什么时候产生什么」抽象成流,把「对数据的处理」抽象成操作符链,把「最终消费」放在订阅里。习惯后,你会先想「有哪些事件源」「它们如何组合、变换」,再写具体订阅逻辑,而不是一上来就写一堆属性和回调。

同一需求的两种写法对比(搜索框防抖 + 请求 + 只取非空):
命令式常见写法是:在文本回调里设 Timer、取消上一次请求、判断非空再发请求、在回调里更新 UI,逻辑分散在多处。用 RxSwift 可以写成一条「流」:

// 响应式:一条链描述「输入 → 防抖 → 非空过滤 → 请求 → 主线程更新」
searchTextField.rx.text.orEmpty
    .debounce(.milliseconds(300), scheduler: MainScheduler.instance)
    .filter { !$0.isEmpty }
    .flatMapLatest { query in api.search(query) }
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { results in self.updateUI(results) })
    .disposed(by: disposeBag)

这样,「防抖」「过滤空串」「只保留最后一次请求」「切回主线程」都体现在操作符上,阅读时一眼能看出数据流;单元测试时可以对 Observable 链单独测,而不必依赖 UI。

(3)函数式思想(组合与不可变)

  • 组合(Composition):每个操作符只做一件事,通过 .map().filter().distinctUntilChanged() 等组合成完整逻辑,而不是在一个闭包里写尽所有逻辑。
  • 不可变(Immutability):操作符不修改原 Observable,而是返回新的 Observable;原流不变,便于复用和推理。
  • 副作用边界:纯变换放在操作符链中,副作用(UI 更新、写库、弹窗)集中在 subscribe 的闭包里,便于测试和并发安全。

(4)流与时间(Streams & Time)

  • 把所有「会随时间产生的事件」都视为时间序列:next、next、…、completed/error。
  • 时间相关操作符:debounce(静默一段时间后取最新)、throttle(间隔内只取第一个/最后一个)、delay(延后发射),统一表达「何时」而不只是「何值」。

(5)观察者与发布-订阅

  • 观察者模式:Observer 订阅 Observable,在事件发生时被通知。RxSwift 的 subscribe(onNext:onError:onCompleted:) 就是在注册观察者。
  • 发布-订阅:生产端(Observable)与消费端(Observer)解耦,通过 Disposable 表示一次订阅的生命周期;Rx 的「热/冷」流、背压(部分算子)都是在这一模型上的扩展。

(6)设计原则在 Rx 中的体现

原则 在 RxSwift 中的体现
单一职责 每个操作符只做一种变换(map 只做映射,filter 只做过滤),复杂逻辑由链式组合完成。
关注点分离 数据获取与变换在 Observable 链中,线程切换用 subscribeOn/observeOn,副作用集中在 subscribe
依赖倒置 业务依赖「Observable 流」的抽象,而不依赖具体如何产生事件(网络、本地、Mock 都可替换)。
开闭原则 通过新操作符或新 Observable 扩展行为,而不必修改已有链;原流不可变,易于复用。

小结:RxSwift 用声明式事件流(Observable)和可组合操作符,在观察者/发布-订阅模型下做响应式的异步与事件处理,并用 Scheduler 控制线程与时机。掌握这些思想后,再写「为什么用 map 而不是在 subscribe 里写一大段」「为什么需要 observeOn/subscribeOn」会更自然。


2. 核心概念

2.1 Observable(可观察序列)

Observable 是 RxSwift 的核心,表示可以观察的事件序列。

protocol ObservableType {
    associatedtype Element
    func subscribe<Observer: ObserverType>(_ observer: Observer) -> Disposable
        where Observer.Element == Element
}

特点:

  • 可以发出零个或多个事件
  • 可能以完成或错误结束
  • 是值类型(struct)
  • 不可变(每次操作返回新的 Observable)

事件类型:

enum Event<Element> {
    case next(Element)      // 下一个元素
    case error(Swift.Error) // 错误
    case completed          // 完成
}

示例:

// 创建一个简单的 Observable
let observable = Observable<String>.just("Hello, RxSwift!")

observable.subscribe(onNext: { value in
    print(value)  // 输出: Hello, RxSwift!
}, onError: { error in
    print("错误: \(error)")
}, onCompleted: {
    print("完成")
})
.disposed(by: disposeBag)

// 使用数组创建 Observable
let arrayObservable = Observable.from([1, 2, 3, 4, 5])

arrayObservable.subscribe(onNext: { value in
    print(value)  // 依次输出: 1, 2, 3, 4, 5
})
.disposed(by: disposeBag)

2.2 Observer(观察者)

Observer 是接收 Observable 事件的协议。

protocol ObserverType {
    associatedtype Element
    func on(_ event: Event<Element>)
}

内置 Observer:

  • onNext:接收下一个元素
  • onError:接收错误
  • onCompleted:接收完成事件

示例:

let observable = Observable.from([1, 2, 3])

observable.subscribe(
    onNext: { value in
        print("收到值: \(value)")
    },
    onError: { error in
        print("错误: \(error)")
    },
    onCompleted: {
        print("完成")
    }
)
.disposed(by: disposeBag)

2.3 Disposable(可释放资源)

Disposable 表示订阅关系,用于取消订阅和释放资源。

protocol Disposable {
    func dispose()
}

DisposeBag:

class ViewController: UIViewController {
    private let disposeBag = DisposeBag()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        Observable.just("Hello")
            .subscribe(onNext: { print($0) })
            .disposed(by: disposeBag)  // 自动管理生命周期
    }
}

3. Observable与Observer

3.1 创建Observable

just

创建只发出一个元素的 Observable。

let observable = Observable.just("Hello")
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
from

从数组或序列创建 Observable。

let observable = Observable.from([1, 2, 3])
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
of

从多个元素创建 Observable。

let observable = Observable.of(1, 2, 3)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
create

自定义创建 Observable。

let observable = Observable<String>.create { observer in
    observer.onNext("A")
    observer.onNext("B")
    observer.onCompleted()
    return Disposables.create()
}

observable.subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
empty

创建不发出任何元素的 Observable。

let observable = Observable<Int>.empty()
    .subscribe(
        onNext: { print($0) },
        onCompleted: { print("完成") }
    )
    .disposed(by: disposeBag)
// 输出: 完成
never

创建永不发出事件也永不完成的 Observable。

let observable = Observable<Int>.never()
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 无输出
error

创建立即发出错误的 Observable。

enum MyError: Error {
    case customError
}

let observable = Observable<Int>.error(MyError.customError)
    .subscribe(
        onNext: { print($0) },
        onError: { print("错误: \($0)") }
    )
    .disposed(by: disposeBag)
// 输出: 错误: customError
range

创建发出指定范围内整数的 Observable。

let observable = Observable.range(start: 1, count: 5)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 1, 2, 3, 4, 5
repeatElement

重复发出指定元素。

let observable = Observable.repeatElement("Hello")
    .take(3)  // 只取前3个
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: Hello, Hello, Hello
interval

按指定时间间隔发出整数。

let observable = Observable<Int>.interval(
    .seconds(1),
    scheduler: MainScheduler.instance
)
.take(5)
.subscribe(onNext: { print($0) })
.disposed(by: disposeBag)
// 每秒输出: 0, 1, 2, 3, 4
timer

延迟指定时间后发出元素。

let observable = Observable<Int>.timer(
    .seconds(2),
    scheduler: MainScheduler.instance
)
.subscribe(onNext: { print($0) })
.disposed(by: disposeBag)
// 2秒后输出: 0

3.2 自定义Observable

struct CustomObservable<Element>: ObservableType {
    typealias Element = Element
    
    private let _subscribe: (AnyObserver<Element>) -> Disposable
    
    init(_ subscribe: @escaping (AnyObserver<Element>) -> Disposable) {
        self._subscribe = subscribe
    }
    
    func subscribe<Observer: ObserverType>(_ observer: Observer) -> Disposable
        where Observer.Element == Element {
        let anyObserver = AnyObserver(observer)
        return _subscribe(anyObserver)
    }
}

// 使用
let custom = CustomObservable<Int> { observer in
    observer.onNext(1)
    observer.onNext(2)
    observer.onCompleted()
    return Disposables.create()
}

custom.subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)

4. Operators操作符

4.1 转换操作符

map

转换每个元素。

Observable.from([1, 2, 3])
    .map { $0 * 2 }
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 2, 4, 6
flatMap

将 Observable 发出的元素转换为 Observable,然后合并。

Observable.from(["A", "B", "C"])
    .flatMap { letter in
        Observable.from([1, 2]).map { "\(letter)\($0)" }
    }
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: A1, A2, B1, B2, C1, C2
flatMapLatest

只保留最新的内部 Observable。

Observable.from(["A", "B", "C"])
    .flatMapLatest { letter in
        Observable.just(letter).delay(.seconds(1), scheduler: MainScheduler.instance)
    }
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 只输出: C(A和B被取消)
scan

累积值。

Observable.from([1, 2, 3, 4, 5])
    .scan(0, accumulator: +)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 1, 3, 6, 10, 15
buffer

缓冲元素。

Observable.from([1, 2, 3, 4, 5, 6, 7, 8])
    .buffer(timeSpan: .seconds(1), count: 3, scheduler: MainScheduler.instance)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: [1, 2, 3], [4, 5, 6], [7, 8]
window

将 Observable 分割为多个 Observable。

Observable.from([1, 2, 3, 4, 5, 6])
    .window(timeSpan: .seconds(1), count: 2, scheduler: MainScheduler.instance)
    .flatMap { $0 }
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)

4.2 过滤操作符

filter

过滤元素。

Observable.from([1, 2, 3, 4, 5])
    .filter { $0 % 2 == 0 }
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 2, 4
distinctUntilChanged

移除连续重复的元素。

Observable.from([1, 1, 2, 2, 3, 3])
    .distinctUntilChanged()
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 1, 2, 3
elementAt

获取指定索引的元素。

Observable.from([1, 2, 3, 4, 5])
    .elementAt(2)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 3
first / last

获取第一个或最后一个元素。

Observable.from([1, 2, 3, 4, 5])
    .first()
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 1

Observable.from([1, 2, 3, 4, 5])
    .last()
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 5
take / takeLast

获取前几个或后几个元素。

Observable.from([1, 2, 3, 4, 5])
    .take(3)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 1, 2, 3

Observable.from([1, 2, 3, 4, 5])
    .takeLast(3)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 3, 4, 5
skip / skipLast

跳过前几个或后几个元素。

Observable.from([1, 2, 3, 4, 5])
    .skip(2)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 3, 4, 5
debounce

防抖,等待指定时间后发出最新值。

let subject = PublishSubject<String>()

subject
    .debounce(.milliseconds(500), scheduler: MainScheduler.instance)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)

subject.onNext("H")     // 不输出
subject.onNext("He")    // 不输出
subject.onNext("Hel")   // 不输出
subject.onNext("Hell")  // 不输出
subject.onNext("Hello") // 0.5秒后输出: Hello
throttle

节流,在指定时间间隔内只发出第一个值。

let subject = PublishSubject<String>()

subject
    .throttle(.seconds(1), scheduler: MainScheduler.instance)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)

subject.onNext("A")  // 立即输出: A
subject.onNext("B")  // 不输出(1秒内)
subject.onNext("C")  // 不输出(1秒内)
// 1秒后
subject.onNext("D")  // 输出: D

4.3 组合操作符

startWith

在序列开始前插入元素。

Observable.from([1, 2, 3])
    .startWith(0)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 0, 1, 2, 3
merge

合并多个 Observable。

let subject1 = PublishSubject<Int>()
let subject2 = PublishSubject<Int>()

Observable.merge(subject1, subject2)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)

subject1.onNext(1)  // 输出: 1
subject2.onNext(2)  // 输出: 2
subject1.onNext(3)  // 输出: 3
combineLatest

组合多个 Observable 的最新值。

let subject1 = PublishSubject<String>()
let subject2 = PublishSubject<Int>()

Observable.combineLatest(subject1, subject2)
    .subscribe(onNext: { value1, value2 in
        print("\(value1): \(value2)")
    })
    .disposed(by: disposeBag)

subject1.onNext("A")  // 无输出(等待 subject2)
subject2.onNext(1)    // 输出: A: 1
subject1.onNext("B")  // 输出: B: 1
subject2.onNext(2)    // 输出: B: 2
zip

按顺序组合多个 Observable。

let subject1 = PublishSubject<String>()
let subject2 = PublishSubject<Int>()

Observable.zip(subject1, subject2)
    .subscribe(onNext: { value1, value2 in
        print("\(value1): \(value2)")
    })
    .disposed(by: disposeBag)

subject1.onNext("A")  // 等待 subject2
subject1.onNext("B")  // 等待 subject2
subject2.onNext(1)    // 输出: A: 1
subject2.onNext(2)    // 输出: B: 2
withLatestFrom

当源 Observable 发出元素时,使用另一个 Observable 的最新值。

let button = PublishSubject<Void>()
let textField = PublishSubject<String>()

button
    .withLatestFrom(textField)
    .subscribe(onNext: { text in
        print("按钮点击,文本: \(text)")
    })
    .disposed(by: disposeBag)

textField.onNext("Hello")  // 无输出
textField.onNext("World")  // 无输出
button.onNext(())          // 输出: 按钮点击,文本: World
switchLatest

切换到最新的内部 Observable。

let subject1 = PublishSubject<Int>()
let subject2 = PublishSubject<Int>()
let source = PublishSubject<Observable<Int>>()

source
    .switchLatest()
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)

source.onNext(subject1)
subject1.onNext(1)  // 输出: 1
subject1.onNext(2)  // 输出: 2

source.onNext(subject2)
subject1.onNext(3)  // 不输出(已切换)
subject2.onNext(4)  // 输出: 4

4.4 错误处理操作符

catchError

捕获错误并返回备用 Observable。

enum MyError: Error {
    case failure
}

let observable = Observable<String>.error(MyError.failure)
    .catchError { error -> Observable<String> in
        print("捕获错误: \(error)")
        return Observable.just("备用值")
    }
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 捕获错误: failure, 备用值
catchErrorJustReturn

用默认值替换错误。

let observable = Observable<String>.error(MyError.failure)
    .catchErrorJustReturn("默认值")
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: 默认值
retry

重试失败的 Observable。

var attempts = 0

let observable = Observable<String>.create { observer in
    attempts += 1
    if attempts < 3 {
        observer.onError(MyError.failure)
    } else {
        observer.onNext("成功")
        observer.onCompleted()
    }
    return Disposables.create()
}
.retry(2)  // 最多重试 2 次
.subscribe(
    onNext: { print($0) },
    onError: { print("错误: \($0)") }
)
.disposed(by: disposeBag)
// 输出: 成功
retryWhen

根据条件重试。

let observable = Observable<String>.error(MyError.failure)
    .retryWhen { errors in
        errors.enumerated().flatMap { index, error -> Observable<Int> in
            if index < 2 {
                return Observable<Int>.timer(.seconds(index + 1), scheduler: MainScheduler.instance)
            } else {
                return Observable.error(error)
            }
        }
    }
    .subscribe(
        onNext: { print($0) },
        onError: { print("最终错误: \($0)") }
    )
    .disposed(by: disposeBag)

4.5 工具操作符

do

执行副作用操作。

Observable.from([1, 2, 3])
    .do(onNext: { print("即将发出: \($0)") },
        onError: { print("错误: \($0)") },
        onCompleted: { print("完成") },
        onSubscribe: { print("订阅") },
        onDispose: { print("释放") })
    .subscribe(onNext: { print("收到: \($0)") })
    .disposed(by: disposeBag)
delay

延迟发出元素。

Observable.from([1, 2, 3])
    .delay(.seconds(1), scheduler: MainScheduler.instance)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 1秒后依次输出: 1, 2, 3
delaySubscription

延迟订阅。

Observable.from([1, 2, 3])
    .delaySubscription(.seconds(1), scheduler: MainScheduler.instance)
    .subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 1秒后开始输出: 1, 2, 3
materialize / dematerialize

将事件序列化/反序列化。

Observable.from([1, 2, 3])
    .materialize()
    .subscribe(onNext: { event in
        print(event)  // 输出: next(1), next(2), next(3), completed
    })
    .disposed(by: disposeBag)
timeout

超时处理。

Observable<Int>.never()
    .timeout(.seconds(2), scheduler: MainScheduler.instance)
    .subscribe(
        onNext: { print($0) },
        onError: { print("超时: \($0)") }
    )
    .disposed(by: disposeBag)
// 2秒后输出: 超时: RxError.timeout

5. Subjects

Subjects 既是 Observable 又是 Observer,可以手动发送事件。

5.1 PublishSubject

不保存当前值,只向订阅者发送订阅后的事件。

let subject = PublishSubject<String>()

// 订阅1
subject.subscribe(onNext: { print("订阅1: \($0)") })
    .disposed(by: disposeBag)

subject.onNext("A")  // 输出: 订阅1: A

// 订阅2
subject.subscribe(onNext: { print("订阅2: \($0)") })
    .disposed(by: disposeBag)

subject.onNext("B")  // 输出: 订阅1: B, 订阅2: B
subject.onCompleted()

5.2 BehaviorSubject

保存当前值,新订阅者会立即收到当前值。

let subject = BehaviorSubject<String>(value: "初始值")

// 订阅1
subject.subscribe(onNext: { print("订阅1: \($0)") })
    .disposed(by: disposeBag)
// 输出: 订阅1: 初始值

subject.onNext("新值")  // 输出: 订阅1: 新值

// 订阅2
subject.subscribe(onNext: { print("订阅2: \($0)") })
    .disposed(by: disposeBag)
// 输出: 订阅2: 新值(立即收到当前值)

5.3 ReplaySubject

保存指定数量的最近值,新订阅者会收到这些值。

let subject = ReplaySubject<String>.create(bufferSize: 2)

subject.onNext("A")
subject.onNext("B")
subject.onNext("C")

// 订阅
subject.subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)
// 输出: B, C(最近2个值)

5.4 AsyncSubject

只发出最后一个值(在完成时)。

let subject = AsyncSubject<String>()

subject.subscribe(onNext: { print($0) })
    .disposed(by: disposeBag)

subject.onNext("A")  // 不输出
subject.onNext("B")  // 不输出
subject.onNext("C")  // 不输出
subject.onCompleted()  // 输出: C

6. Schedulers调度器

Schedulers 决定操作在哪个线程执行。

6.1 内置Scheduler

MainScheduler

主线程调度器。

Observable.just(1)
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { value in
        // 在主线程执行
        print(Thread.isMainThread)  // true
    })
    .disposed(by: disposeBag)
SerialDispatchQueueScheduler

串行队列调度器。

let scheduler = SerialDispatchQueueScheduler(
    qos: .userInitiated,
    internalSerialQueueName: "custom.queue"
)

Observable.just(1)
    .observeOn(scheduler)
    .subscribe(onNext: { value in
        // 在后台线程执行
    })
    .disposed(by: disposeBag)
ConcurrentDispatchQueueScheduler

并发队列调度器。

let scheduler = ConcurrentDispatchQueueScheduler(
    qos: .background
)

Observable.from([1, 2, 3])
    .observeOn(scheduler)
    .subscribe(onNext: { value in
        // 在后台线程执行
    })
    .disposed(by: disposeBag)
OperationQueueScheduler

操作队列调度器。

let queue = OperationQueue()
queue.maxConcurrentOperationCount = 2

let scheduler = OperationQueueScheduler(operationQueue: queue)

Observable.from([1, 2, 3, 4, 5])
    .observeOn(scheduler)
    .subscribe(onNext: { value in
        // 在操作队列执行
    })
    .disposed(by: disposeBag)

6.2 subscribeOn vs observeOn

  • subscribeOn:指定订阅在哪个线程执行
  • observeOn:指定后续操作在哪个线程执行
Observable.create { observer in
    print("订阅线程: \(Thread.current)")
    observer.onNext(1)
    observer.onCompleted()
    return Disposables.create()
}
.subscribeOn(ConcurrentDispatchQueueScheduler(qos: .background))
.observeOn(MainScheduler.instance)
.subscribe(onNext: { value in
    print("接收线程: \(Thread.current)")
})
.disposed(by: disposeBag)

7. 错误处理

7.1 错误类型

enum RxError: Swift.Error {
    case unknown
    case disposed
    case timeout
    case noElements
    case moreThanOneElement
}

enum NetworkError: Error {
    case invalidURL
    case noData
    case decodingError
}

7.2 错误处理策略

func fetchData() -> Observable<String> {
    return Observable.create { observer in
        // 模拟网络请求
        DispatchQueue.global().asyncAfter(deadline: .now() + 1) {
            observer.onError(NetworkError.noData)
        }
        return Disposables.create()
    }
}

fetchData()
    .catchError { error -> Observable<String> in
        // 捕获错误,返回备用 Observable
        return Observable.just("默认数据")
    }
    .retry(3)  // 重试 3 次
    .subscribe(
        onNext: { print($0) },
        onError: { print("最终错误: \($0)") }
    )
    .disposed(by: disposeBag)

8. 内存管理

8.1 DisposeBag

自动管理订阅的生命周期。

class ViewController: UIViewController {
    private let disposeBag = DisposeBag()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        Observable.just("Hello")
            .subscribe(onNext: { print($0) })
            .disposed(by: disposeBag)  // 自动管理
    }
    
    // viewController 释放时,disposeBag 会自动释放所有订阅
}

8.2 避免循环引用

class ViewModel {
    private let disposeBag = DisposeBag()
    
    func setup() {
        Observable.just("Data")
            .subscribe(onNext: { [weak self] value in
                // 使用 weak self 避免循环引用
                self?.process(value)
            })
            .disposed(by: disposeBag)
    }
    
    private func process(_ value: String) {
        // 处理数据
    }
}

8.3 takeUntil

在指定条件满足时自动取消订阅。

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        
        Observable.interval(.seconds(1), scheduler: MainScheduler.instance)
            .takeUntil(self.rx.deallocated)  // viewController 释放时自动取消
            .subscribe(onNext: { print($0) })
            .disposed(by: disposeBag)
    }
}

9. 与UIKit集成

9.1 RxCocoa基础

RxCocoa 提供了 UIKit 的 Rx 扩展。

import RxSwift
import RxCocoa

class ViewController: UIViewController {
    @IBOutlet weak var textField: UITextField!
    @IBOutlet weak var button: UIButton!
    @IBOutlet weak var label: UILabel!
    
    private let disposeBag = DisposeBag()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        // 文本输入绑定
        textField.rx.text
            .bind(to: label.rx.text)
            .disposed(by: disposeBag)
        
        // 按钮点击
        button.rx.tap
            .subscribe(onNext: { [weak self] in
                self?.handleButtonTap()
            })
            .disposed(by: disposeBag)
    }
}

9.2 常用绑定

// UILabel
label.rx.text.onNext("Hello")
label.rx.attributedText.onNext(attributedString)

// UITextField
textField.rx.text
    .subscribe(onNext: { text in
        print("文本: \(text ?? "")")
    })
    .disposed(by: disposeBag)

// UIButton
button.rx.tap
    .subscribe(onNext: {
        print("按钮点击")
    })
    .disposed(by: disposeBag)

// UISwitch
switch.rx.isOn
    .subscribe(onNext: { isOn in
        print("开关: \(isOn)")
    })
    .disposed(by: disposeBag)

// UISlider
slider.rx.value
    .subscribe(onNext: { value in
        print("值: \(value)")
    })
    .disposed(by: disposeBag)

9.3 TableView绑定

import RxDataSources

class ViewController: UIViewController {
    @IBOutlet weak var tableView: UITableView!
    
    private let disposeBag = DisposeBag()
    private let items = BehaviorSubject<[String]>(value: ["Item 1", "Item 2", "Item 3"])
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        let dataSource = RxTableViewSectionedReloadDataSource<String> { dataSource, tableView, indexPath, item in
            let cell = tableView.dequeueReusableCell(withIdentifier: "Cell", for: indexPath)
            cell.textLabel?.text = item
            return cell
        }
        
        items
            .map { [SectionModel(model: "", items: $0)] }
            .bind(to: tableView.rx.items(dataSource: dataSource))
            .disposed(by: disposeBag)
    }
}

10. 实际应用场景

10.1 网络请求

struct API {
    static func fetchUser(id: Int) -> Observable<User> {
        let url = URL(string: "https://api.example.com/users/\(id)")!
        
        return URLSession.shared.rx.data(request: URLRequest(url: url))
            .map { data in
                try JSONDecoder().decode(User.self, from: data)
            }
            .observeOn(MainScheduler.instance)
    }
}

API.fetchUser(id: 1)
    .subscribe(
        onNext: { user in
            print("用户: \(user)")
        },
        onError: { error in
            print("错误: \(error)")
        }
    )
    .disposed(by: disposeBag)

10.2 用户输入处理

class SearchViewModel {
    private let disposeBag = DisposeBag()
    let searchText = BehaviorSubject<String>(value: "")
    let results = BehaviorSubject<[String]>(value: [])
    
    init() {
        searchText
            .debounce(.milliseconds(500), scheduler: MainScheduler.instance)
            .distinctUntilChanged()
            .filter { !$0.isEmpty }
            .flatMapLatest { query -> Observable<[String]> in
                return self.search(query: query)
                    .catchErrorJustReturn([])
            }
            .bind(to: results)
            .disposed(by: disposeBag)
    }
    
    private func search(query: String) -> Observable<[String]> {
        // 实现搜索逻辑
        return Observable.just(["结果1", "结果2"])
    }
}

10.3 组合多个数据源

class DashboardViewModel {
    private let disposeBag = DisposeBag()
    let user = BehaviorSubject<User?>(value: nil)
    let posts = BehaviorSubject<[Post]>(value: [])
    let isLoading = BehaviorSubject<Bool>(value: false)
    
    func loadData() {
        isLoading.onNext(true)
        
        let userObservable = API.fetchUser(id: 1)
        let postsObservable = API.fetchPosts()
        
        Observable.zip(userObservable, postsObservable)
            .observeOn(MainScheduler.instance)
            .subscribe(
                onNext: { [weak self] user, posts in
                    self?.user.onNext(user)
                    self?.posts.onNext(posts)
                    self?.isLoading.onNext(false)
                },
                onError: { [weak self] error in
                    self?.isLoading.onNext(false)
                    print("错误: \(error)")
                }
            )
            .disposed(by: disposeBag)
    }
}

10.4 表单验证(多字段实时校验)

多字段表单:用户名、密码、确认密码实时校验,用 combineLatest 聚合多流,用 map 产出错误文案或是否可提交。

class FormViewModel {
    private let disposeBag = DisposeBag()

    let username = BehaviorRelay<String>(value: "")
    let password = BehaviorRelay<String>(value: "")
    let confirmPassword = BehaviorRelay<String>(value: "")

    let usernameError = BehaviorRelay<String?>(value: nil)
    let isFormValid = BehaviorRelay<Bool>(value: false)

    init() {
        // 用户名:非空 + 长度
        username
            .map { name in
                if name.isEmpty { return "请输入用户名" }
                if name.count < 3 { return "至少 3 个字符" }
                return nil
            }
            .bind(to: usernameError)
            .disposed(by: disposeBag)

        // 三字段 combineLatest,任一变化都重新计算表单是否有效
        Observable.combineLatest(username, password, confirmPassword)
            .map { name, pwd, confirm in
                if name.isEmpty || pwd.isEmpty { return false }
                if pwd != confirm { return false }
                if pwd.count < 6 { return false }
                return true
            }
            .bind(to: isFormValid)
            .disposed(by: disposeBag)
    }
}

// VC 中绑定
viewModel.isFormValid
    .bind(to: submitButton.rx.isEnabled)
    .disposed(by: disposeBag)
viewModel.usernameError
    .bind(to: usernameErrorLabel.rx.text)
    .disposed(by: disposeBag)

10.5 NotificationCenter 转 Observable

系统通知或自定义通知转为 Observable,便于在链中 mapfilterobserveOn

// 键盘即将显示:取键盘 frame
let keyboardWillShow = NotificationCenter.default.rx
    .notification(UIResponder.keyboardWillShowNotification)
    .map { notification -> CGRect in
        (notification.userInfo?[UIResponder.keyboardFrameEndUserInfoKey] as? NSValue)?.cgRectValue ?? .zero
    }
    .observeOn(MainScheduler.instance)

keyboardWillShow
    .subscribe(onNext: { frame in
        print("键盘高度: \(frame.height)")
    })
    .disposed(by: disposeBag)

// 自定义通知
extension Notification.Name {
    static let myCustomEvent = Notification.Name("MyCustomEvent")
}
let customObservable = NotificationCenter.default.rx.notification(.myCustomEvent)

10.6 Timer 与周期任务

Observable.interval 做定时轮询,或用 Observable.timer 做延迟/单次任务。

// 每 1 秒发一个递增整数,主线程接收
let timerObservable = Observable<Int>.interval(.seconds(1), scheduler: MainScheduler.instance)
    .take(10)  // 只取 10 次
    .subscribe(onNext: { tick in
        print("tick: \(tick)")
    })
    .disposed(by: disposeBag)

// 延迟 2 秒后执行一次
Observable<Int>.timer(.seconds(2), scheduler: MainScheduler.instance)
    .subscribe(onNext: { _ in
        print("2 秒后执行")
    })
    .disposed(by: disposeBag)

// 轮询接口:每 5 秒请求一次,直到满足条件
Observable<Int>.interval(.seconds(5), scheduler: MainScheduler.instance)
    .flatMapLatest { _ in API.pollStatus() }
    .takeWhile { !$0.isDone }
    .subscribe(onNext: { status in
        print("状态: \(status)")
    })
    .disposed(by: disposeBag)

10.7 请求重试与超时

retry 在失败时重新订阅上游;timeout 超时未完成则发 error;配合 catchError 做兜底。

URLSession.shared.rx.data(request: request)
    .timeout(.seconds(10), scheduler: MainScheduler.instance)
    .retry(3)
    .map { data in try JSONDecoder().decode(User.self, from: data) }
    .catchError { _ in Observable.just(User.placeholder) }
    .observeOn(MainScheduler.instance)
    .subscribe(
        onNext: { user in
            // 更新 UI
        },
        onError: { error in
            print("错误: \(error)")
        }
    )
    .disposed(by: disposeBag)

10.8 多源竞速(主备 / race)

主接口失败时切到备用接口,用 catchError 切流;或 merge + take(1) 实现「谁先完成用谁」。

// 主接口失败时用备用接口
func loadFromPrimaryOrFallback() -> Observable<Data> {
    let primary = URLSession.shared.rx.data(request: primaryRequest)
    let fallback = URLSession.shared.rx.data(request: fallbackRequest)
    return primary.catchError { _ in fallback }
}

// 显式 race:两个请求谁先完成用谁
func race<Element>(_ a: Observable<Element>, _ b: Observable<Element>) -> Observable<Element> {
    Observable.merge(a, b).take(1)
}

10.9 节流与防抖组合(搜索 + 按钮防重复点击)

搜索框用 debounce 减少请求频率;提交按钮用 throttle 防止连续点击重复提交。

// 搜索:防抖 + 去重 + 非空 + flatMapLatest 只保留最后一次请求
searchBar.rx.text.orEmpty
    .debounce(.milliseconds(400), scheduler: MainScheduler.instance)
    .distinctUntilChanged()
    .filter { !$0.isEmpty }
    .flatMapLatest { query in
        API.search(query: query).catchErrorJustReturn([])
    }
    .observeOn(MainScheduler.instance)
    .bind(to: results)
    .disposed(by: disposeBag)

// 提交按钮:节流 1 秒内只响应一次
submitButton.rx.tap
    .throttle(.seconds(1), scheduler: MainScheduler.instance)
    .subscribe(onNext: { [weak self] in
        self?.submit()
    })
    .disposed(by: disposeBag)

10.10 RxCocoa 进阶:UISearchBar、RefreshControl、DelegateProxy

UISearchBarrx.textrx.searchButtonClicked 组合做「点击搜索」或「实时搜索」。

// 点击搜索按钮时用当前文本请求
searchBar.rx.searchButtonClicked
    .withLatestFrom(searchBar.rx.text.orEmpty)
    .filter { !$0.isEmpty }
    .flatMapLatest { API.search(query: $0) }
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { [weak self] results in
        self?.updateResults(results)
    })
    .disposed(by: disposeBag)

UIRefreshControl:下拉刷新与 isRefreshing 绑定。

refreshControl.rx.controlEvent(.valueChanged)
    .flatMapLatest { [weak self] _ in
        self?.loadData() ?? Observable.never()
    }
    .observeOn(MainScheduler.instance)
    .subscribe(
        onNext: { [weak self] _ in
            self?.refreshControl.endRefreshing()
        },
        onError: { [weak self] _ in
            self?.refreshControl.endRefreshing()
        }
    )
    .disposed(by: disposeBag)

DelegateProxy 示例(UITableView 点击):RxCocoa 已为常用控件提供 rx 扩展,如需自定义可继承 DelegateProxy

// 使用 RxCocoa 内置的 itemSelected
tableView.rx.itemSelected
    .subscribe(onNext: { indexPath in
        print("选中: \(indexPath)")
    })
    .disposed(by: disposeBag)

tableView.rx.modelSelected(Item.self)
    .subscribe(onNext: { item in
        print("选中项: \(item)")
    })
    .disposed(by: disposeBag)

10.11 页面生命周期与 takeUntil

在 VC 中让订阅随页面消失而自动取消:用 rx.deallocatingtakeUntil(self.rx.deallocated),避免重复订阅和泄漏。

class ViewController: UIViewController {
    private let disposeBag = DisposeBag()

    override func viewDidLoad() {
        super.viewDidLoad()

        // 方式一:统一丢进 disposeBag,VC 释放时一起 dispose
        someObservable
            .subscribe(onNext: { })
            .disposed(by: disposeBag)

        // 方式二:显式「直到某事件发生就结束」(如直到页面即将消失)
        someObservable
            .takeUntil(rx.deallocated)
            .subscribe(onNext: { })
            .disposed(by: disposeBag)
    }
}

10.12 CollectionView 与 RxDataSources

使用 RxDataSources 的 Section 模型驱动 UICollectionView,与 TableView 用法类似(Item 为业务模型类型,需与 Cell 一致)。

import RxDataSources

typealias Section = SectionModel<String, Item>  // Item 为业务模型
let dataSource = RxCollectionViewSectionedReloadDataSource<Section> { dataSource, collectionView, indexPath, item in
    let cell = collectionView.dequeueReusableCell(withReuseIdentifier: "Cell", for: indexPath) as! ItemCell
    cell.configure(with: item)
    return cell
}

items
    .map { [Section(model: "列表", items: $0)] }
    .bind(to: collectionView.rx.items(dataSource: dataSource))
    .disposed(by: disposeBag)

10.13 双向绑定与 ControlProperty

RxCocoa 的 ControlProperty 支持双向绑定:一方是「用户输入」,一方是「模型/ViewModel」。

// 将 TextField 与 BehaviorRelay 双向绑定(需自己写绑定逻辑,或使用 RxCocoa 的 bind)
// 单向:ViewModel -> UI
viewModel.username
    .bind(to: textField.rx.text)
    .disposed(by: disposeBag)

// 单向:UI -> ViewModel
textField.rx.text.orEmpty
    .bind(to: viewModel.username)
    .disposed(by: disposeBag)

// 若需「初始值 + 用户修改都同步」,两行都写即可(Relay 与控件类型匹配时)

10.14 错误流与用户提示

将网络/业务错误统一转为「可展示的提示」,用 materialize()catchError 转成另一种元素类型,再在 UI 层订阅。

API.fetchUser(id: 1)
    .materialize()
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { [weak self] event in
        switch event {
        case .next(let user):
            self?.showUser(user)
        case .error(let error):
            self?.showToast("加载失败: \(error.localizedDescription)")
        case .completed:
            break
        }
    })
    .disposed(by: disposeBag)

二、RxSwift框架源码解析

1. 架构设计

1.1 整体架构

RxSwift 采用协议导向的设计,核心是三个协议:

ObservableType (可观察类型)
    ↓
ObserverType (观察者类型)
    ↓
Disposable (可释放资源)

数据流:

Observable → Observer
     ↑          ↓
     └── 反馈 ──┘

1.2 核心协议层次

// 第一层:ObservableType 协议
protocol ObservableType {
    associatedtype Element
    func subscribe<Observer: ObserverType>(_ observer: Observer) -> Disposable
        where Observer.Element == Element
}

// 第二层:ObserverType 协议
protocol ObserverType {
    associatedtype Element
    func on(_ event: Event<Element>)
}

// 第三层:Disposable 协议
protocol Disposable {
    func dispose()
}

1.3 事件类型

enum Event<Element> {
    case next(Element)
    case error(Swift.Error)
    case completed
}

2. Observable协议实现

2.1 ObservableType协议定义

public protocol ObservableType {
    associatedtype Element
    
    func subscribe<Observer: ObserverType>(_ observer: Observer) -> Disposable
        where Observer.Element == Element
}

2.2 Observable实现

public class Observable<Element>: ObservableType {
    public typealias Element = Element
    
    internal init() {}
    
    public func subscribe<Observer: ObserverType>(_ observer: Observer) -> Disposable
        where Observer.Element == Element {
        rxAbstractMethod()
    }
    
    public func asObservable() -> Observable<Element> {
        return self
    }
}

关键点:

  • Observable 是抽象类
  • subscribe 方法需要子类实现
  • 使用 rxAbstractMethod() 防止直接实例化

2.3 Just实现分析

final private class Just<Element>: Producer<Element> {
    private let element: Element
    
    init(element: Element) {
        self.element = element
    }
    
    override func run<Observer: ObserverType>(_ observer: Observer, cancel: Cancelable) -> (sink: Disposable, subscription: Disposable)
        where Observer.Element == Element {
        let sink = JustSink(parent: self, observer: observer, cancel: cancel)
        let subscription = sink.run()
        return (sink: sink, subscription: subscription)
    }
}

final private class JustSink<Observer: ObserverType>: Sink<Observer>, ObserverType {
    typealias Element = Observer.Element
    typealias Parent = Just<Element>
    
    private let parent: Parent
    
    init(parent: Parent, observer: Observer, cancel: Cancelable) {
        self.parent = parent
        super.init(observer: observer, cancel: cancel)
    }
    
    func on(_ event: Event<Element>) {
        switch event {
        case .next:
            forwardOn(.next(parent.element))
            forwardOn(.completed)
            self.dispose()
        case .error, .completed:
            forwardOn(event)
            self.dispose()
        }
    }
    
    func run() -> Disposable {
        forwardOn(.next(parent.element))
        forwardOn(.completed)
        return Disposables.create()
    }
}

关键点:

  • Just 继承自 Producer
  • 使用 JustSink 处理订阅逻辑
  • 立即发出元素并完成

2.4 Create实现分析

final private class AnonymousObservable<Element>: Producer<Element> {
    typealias SubscribeHandler = (AnyObserver<Element>) -> Disposable
    
    private let subscribeHandler: SubscribeHandler
    
    init(_ subscribeHandler: @escaping SubscribeHandler) {
        self.subscribeHandler = subscribeHandler
    }
    
    override func run<Observer: ObserverType>(_ observer: Observer, cancel: Cancelable) -> (sink: Disposable, subscription: Disposable)
        where Observer.Element == Element {
        let sink = AnonymousObservableSink(observer: observer, cancel: cancel)
        let subscription = sink.run(self)
        return (sink: sink, subscription: subscription)
    }
}

final private class AnonymousObservableSink<Observer: ObserverType>: Sink<Observer>, ObserverType {
    typealias Element = Observer.Element
    typealias Parent = AnonymousObservable<Element>
    
    private let parent: Parent
    
    init(observer: Observer, cancel: Cancelable) {
        self.parent = AnonymousObservable(subscribeHandler: { observer in
            // 包装观察者
            return Disposables.create()
        })
        super.init(observer: observer, cancel: cancel)
    }
    
    func on(_ event: Event<Element>) {
        switch event {
        case .next:
            forwardOn(event)
        case .error, .completed:
            forwardOn(event)
            self.dispose()
        }
    }
    
    func run(_ parent: Parent) -> Disposable {
        return parent.subscribeHandler(AnyObserver(self))
    }
}

关键点:

  • AnonymousObservable 使用闭包创建
  • AnyObserver 包装观察者
  • 支持自定义订阅逻辑

3. Observer协议实现

3.1 ObserverType协议定义

public protocol ObserverType {
    associatedtype Element
    
    func on(_ event: Event<Element>)
}

3.2 AnyObserver实现

public struct AnyObserver<Element>: ObserverType {
    public typealias Element = Element
    
    private let observer: AnyObserverBase<Element>
    
    public init<Observer: ObserverType>(_ observer: Observer)
        where Observer.Element == Element {
        self.observer = ObserverBox(observer)
    }
    
    public func on(_ event: Event<Element>) {
        observer.on(event)
    }
}

private class AnyObserverBase<Element>: ObserverType {
    func on(_ event: Event<Element>) {
        rxAbstractMethod()
    }
}

private final class ObserverBox<Observer: ObserverType>: AnyObserverBase<Observer.Element> {
    private let observer: Observer
    
    init(_ observer: Observer) {
        self.observer = observer
    }
    
    override func on(_ event: Event<Observer.Element>) {
        observer.on(event)
    }
}

关键点:

  • AnyObserver 是类型擦除包装器
  • 使用 ObserverBox 存储具体观察者
  • 实现观察者的多态

3.3 Sink实现

class Sink<Observer: ObserverType>: Disposable {
    typealias Element = Observer.Element
    
    private let observer: Observer
    private let cancel: Cancelable
    private var disposed = false
    
    init(observer: Observer, cancel: Cancelable) {
        self.observer = observer
        self.cancel = cancel
    }
    
    final func forwardOn(_ event: Event<Element>) {
        if isDisposed {
            return
        }
        observer.on(event)
    }
    
    final func forwardOn(_ event: Event<Element>, _ disposeHandler: @escaping () -> Void) {
        if isDisposed {
            return
        }
        observer.on(event)
        disposeHandler()
    }
    
    func dispose() {
        if !disposed {
            disposed = true
            cancel.dispose()
        }
    }
    
    var isDisposed: Bool {
        return disposed
    }
}

关键点:

  • Sink 是观察者的基类
  • 提供 forwardOn 方法转发事件
  • 管理订阅的生命周期

4. Operators实现原理

4.1 Map操作符实现

extension ObservableType {
    public func map<Result>(_ transform: @escaping (Element) -> Result) -> Observable<Result> {
        return Map(source: self.asObservable(), transform: transform)
    }
}

final private class Map<SourceType, ResultType>: Producer<ResultType> {
    typealias Transform = (SourceType) -> ResultType
    
    private let source: Observable<SourceType>
    private let transform: Transform
    
    init(source: Observable<SourceType>, transform: @escaping Transform) {
        self.source = source
        self.transform = transform
    }
    
    override func run<Observer: ObserverType>(_ observer: Observer, cancel: Cancelable) -> (sink: Disposable, subscription: Disposable)
        where Observer.Element == ResultType {
        let sink = MapSink(transform: transform, observer: observer, cancel: cancel)
        let subscription = source.subscribe(sink)
        return (sink: sink, subscription: subscription)
    }
}

final private class MapSink<SourceType, Observer: ObserverType>: Sink<Observer>, ObserverType {
    typealias ResultType = Observer.Element
    typealias Transform = (SourceType) -> ResultType
    
    private let transform: Transform
    
    init(transform: @escaping Transform, observer: Observer, cancel: Cancelable) {
        self.transform = transform
        super.init(observer: observer, cancel: cancel)
    }
    
    func on(_ event: Event<SourceType>) {
        switch event {
        case .next(let element):
            do {
                let mappedElement = try transform(element)
                forwardOn(.next(mappedElement))
            } catch {
                forwardOn(.error(error))
                dispose()
            }
        case .error(let error):
            forwardOn(.error(error))
            dispose()
        case .completed:
            forwardOn(.completed)
            dispose()
        }
    }
}

关键点:

  • Map 是新的 Observable,包装源 Observable
  • 创建 MapSink 进行转换
  • 错误处理:转换失败时发出错误

4.2 Filter操作符实现

extension ObservableType {
    public func filter(_ predicate: @escaping (Element) -> Bool) -> Observable<Element> {
        return Filter(source: self.asObservable(), predicate: predicate)
    }
}

final private class Filter<Element>: Producer<Element> {
    typealias Predicate = (Element) -> Bool
    
    private let source: Observable<Element>
    private let predicate: Predicate
    
    init(source: Observable<Element>, predicate: @escaping Predicate) {
        self.source = source
        self.predicate = predicate
    }
    
    override func run<Observer: ObserverType>(_ observer: Observer, cancel: Cancelable) -> (sink: Disposable, subscription: Disposable)
        where Observer.Element == Element {
        let sink = FilterSink(predicate: predicate, observer: observer, cancel: cancel)
        let subscription = source.subscribe(sink)
        return (sink: sink, subscription: subscription)
    }
}

final private class FilterSink<Observer: ObserverType>: Sink<Observer>, ObserverType {
    typealias Element = Observer.Element
    typealias Predicate = (Element) -> Bool
    
    private let predicate: Predicate
    
    init(predicate: @escaping Predicate, observer: Observer, cancel: Cancelable) {
        self.predicate = predicate
        super.init(observer: observer, cancel: cancel)
    }
    
    func on(_ event: Event<Element>) {
        switch event {
        case .next(let element):
            do {
                let satisfies = try predicate(element)
                if satisfies {
                    forwardOn(.next(element))
                }
            } catch {
                forwardOn(.error(error))
                dispose()
            }
        case .error, .completed:
            forwardOn(event)
            dispose()
        }
    }
}

关键点:

  • 不满足条件时不转发事件
  • 满足条件时才传递给下游

4.3 FlatMap操作符实现

extension ObservableType {
    public func flatMap<Source: ObservableConvertibleType>(
        _ selector: @escaping (Element) -> Source
    ) -> Observable<Source.Element> {
        return FlatMap(source: self.asObservable(), selector: selector)
    }
}

final private class FlatMap<SourceElement, SourceSequence: ObservableConvertibleType>: Producer<SourceSequence.Element> {
    typealias Selector = (SourceElement) -> SourceSequence
    
    private let source: Observable<SourceElement>
    private let selector: Selector
    
    init(source: Observable<SourceElement>, selector: @escaping Selector) {
        self.source = source
        self.selector = selector
    }
    
    override func run<Observer: ObserverType>(_ observer: Observer, cancel: Cancelable) -> (sink: Disposable, subscription: Disposable)
        where Observer.Element == SourceSequence.Element {
        let sink = FlatMapSink(selector: selector, observer: observer, cancel: cancel)
        let subscription = sink.run(source)
        return (sink: sink, subscription: subscription)
    }
}

final private class FlatMapSink<SourceElement, SourceSequence: ObservableConvertibleType, Observer: ObserverType>: MergeSink<SourceSequence, Observer>
    where Observer.Element == SourceSequence.Element {
    
    typealias Selector = (SourceElement) -> SourceSequence
    
    private let selector: Selector
    
    init(selector: @escaping Selector, observer: Observer, cancel: Cancelable) {
        self.selector = selector
        super.init(observer: observer, cancel: cancel)
    }
    
    override func on(_ event: Event<SourceElement>) {
        switch event {
        case .next(let element):
            do {
                let innerObservable = try selector(element).asObservable()
                subscribeInner(innerObservable, group: group)
            } catch {
                forwardOn(.error(error))
                dispose()
            }
        case .error(let error):
            forwardOn(.error(error))
            dispose()
        case .completed:
            groupCompleted()
        }
    }
}

关键点:

  • 管理多个内部 Observable 订阅
  • 使用 MergeSink 合并结果
  • 需要复杂的生命周期管理

5. Subjects实现原理

5.1 PublishSubject实现

public final class PublishSubject<Element>: Observable<Element>, SubjectType, Cancelable, ObserverType, SynchronizedUnsubscribeType {
    public typealias SubjectObserverType = PublishSubject<Element>
    
    typealias Observers = AnyObserver<Element>.s
    typealias DisposeKey = Observers.KeyType
    
    private let lock = RecursiveLock()
    private var observers: Observers = Observers()
    private var isDisposed = false
    private var stopped = false
    private var stoppedEvent: Event<Element>?
    
    public override init() {
        super.init()
    }
    
    public func on(_ event: Event<Element>) {
        dispatch(synchronized_on(event), event)
    }
    
    func synchronized_on(_ event: Event<Element>) -> Observers {
        lock.lock()
        defer { lock.unlock() }
        
        switch event {
        case .next:
            if isDisposed || stopped {
                return Observers()
            }
            return observers
        case .completed, .error:
            if stoppedEvent == nil {
                stoppedEvent = event
                stopped = true
                let observers = self.observers
                self.observers.removeAll()
                return observers
            }
            return Observers()
        }
    }
    
    public override func subscribe<Observer: ObserverType>(_ observer: Observer) -> Disposable
        where Observer.Element == Element {
        lock.lock()
        defer { lock.unlock() }
        
        if let stoppedEvent = stoppedEvent {
            observer.on(stoppedEvent)
            return Disposables.create()
        }
        
        if isDisposed {
            observer.on(.error(RxError.disposed))
            return Disposables.create()
        }
        
        let key = observers.insert(observer.on)
        return SubscriptionDisposable(owner: self, key: key)
    }
    
    func synchronizedUnsubscribe(_ disposeKey: DisposeKey) {
        lock.lock()
        defer { lock.unlock() }
        observers.removeKey(disposeKey)
    }
}

关键点:

  • 使用锁保护 observers 集合
  • 不保存当前值,新订阅者不会收到历史值
  • 使用 SubscriptionDisposable 管理订阅

5.2 BehaviorSubject实现

public final class BehaviorSubject<Element>: Observable<Element>, SubjectType, ObserverType, SynchronizedUnsubscribeType {
    public typealias SubjectObserverType = BehaviorSubject<Element>
    
    typealias Observers = AnyObserver<Element>.s
    typealias DisposeKey = Observers.KeyType
    
    private let lock = RecursiveLock()
    private var observers: Observers = Observers()
    private var isDisposed = false
    private var stoppedEvent: Event<Element>?
    private var element: Element
    
    public init(value: Element) {
        self.element = value
        super.init()
    }
    
    public var value: Element {
        lock.lock()
        defer { lock.unlock() }
        return element
    }
    
    public func on(_ event: Event<Element>) {
        dispatch(synchronized_on(event), event)
    }
    
    func synchronized_on(_ event: Event<Element>) -> Observers {
        lock.lock()
        defer { lock.unlock() }
        
        if stoppedEvent != nil || isDisposed {
            return Observers()
        }
        
        switch event {
        case .next(let element):
            self.element = element
        case .error, .completed:
            stoppedEvent = event
        }
        
        return observers
    }
    
    public override func subscribe<Observer: ObserverType>(_ observer: Observer) -> Disposable
        where Observer.Element == Element {
        lock.lock()
        defer { lock.unlock() }
        
        if let stoppedEvent = stoppedEvent {
            observer.on(stoppedEvent)
            return Disposables.create()
        }
        
        if isDisposed {
            observer.on(.error(RxError.disposed))
            return Disposables.create()
        }
        
        let key = observers.insert(observer.on)
        observer.on(.next(element))  // 立即发送当前值
        
        return SubscriptionDisposable(owner: self, key: key)
    }
}

关键点:

  • 保存当前值 element
  • 新订阅者立即收到当前值
  • 使用锁保护状态

6. Schedulers实现原理

6.1 SchedulerType协议

public protocol SchedulerType {
    var now: RxTime { get }
    
    func schedule<StateType>(_ state: StateType, action: @escaping (StateType) -> Disposable) -> Disposable
    
    func scheduleRelative<StateType>(_ state: StateType, dueTime: RxTimeInterval, action: @escaping (StateType) -> Disposable) -> Disposable
    
    func schedulePeriodic<StateType>(_ state: StateType, startAfter: RxTimeInterval, period: RxTimeInterval, action: @escaping (StateType) -> StateType) -> Disposable
}

6.2 MainScheduler实现

public final class MainScheduler: SerialDispatchQueueScheduler {
    private let mainQueue: DispatchQueue
    
    public static let instance = MainScheduler()
    
    public static let asyncInstance = SerialDispatchQueueScheduler(
        serialQueue: DispatchQueue.main
    )
    
    private init() {
        mainQueue = DispatchQueue.main
        super.init(serialQueue: mainQueue)
    }
    
    public static func ensureExecutingOnScheduler(errorMessage: String? = nil) {
        if !DispatchQueue.isMain {
            rxFatalError(errorMessage ?? "Executing on background thread. Please use `MainScheduler.instance.schedule` to schedule work on main thread.")
        }
    }
}

关键点:

  • 使用 DispatchQueue.main
  • 提供单例实例
  • 提供线程检查方法

6.3 SerialDispatchQueueScheduler实现

public class SerialDispatchQueueScheduler: SchedulerType {
    public typealias TimeInterval = Foundation.TimeInterval
    public typealias Time = Date
    
    private let configuration: DispatchQueueConfiguration
    private let serialQueue: DispatchQueue
    
    public var now: RxTime {
        return Date()
    }
    
    public init(serialQueue: DispatchQueue, leeway: DispatchTimeInterval = DispatchTimeInterval.nanoseconds(0)) {
        self.serialQueue = serialQueue
        self.configuration = DispatchQueueConfiguration(
            queue: serialQueue,
            leeway: leeway
        )
    }
    
    public final func schedule<StateType>(_ state: StateType, action: @escaping (StateType) -> Disposable) -> Disposable {
        return self.scheduleInternal(state, action: action)
    }
    
    func scheduleInternal<StateType>(_ state: StateType, action: @escaping (StateType) -> Disposable) -> Disposable {
        let cancel = SingleAssignmentDisposable()
        
        serialQueue.async {
            if cancel.isDisposed {
                return
            }
            cancel.setDisposable(action(state))
        }
        
        return cancel
    }
    
    public final func scheduleRelative<StateType>(_ state: StateType, dueTime: RxTimeInterval, action: @escaping (StateType) -> Disposable) -> Disposable {
        return scheduleRelativeInternal(state, dueTime: dueTime, action: action)
    }
    
    func scheduleRelativeInternal<StateType>(_ state: StateType, dueTime: RxTimeInterval, action: @escaping (StateType) -> Disposable) -> Disposable {
        let deadline = now.addingTimeInterval(dueTime)
        
        let cancel = SingleAssignmentDisposable()
        
        serialQueue.asyncAfter(deadline: deadline) {
            if cancel.isDisposed {
                return
            }
            cancel.setDisposable(action(state))
        }
        
        return cancel
    }
}

关键点:

  • 使用 DispatchQueue 执行任务
  • 支持立即和延迟调度
  • 使用 SingleAssignmentDisposable 管理取消

7. 背压处理机制

7.1 背压问题

当生产者产生数据的速度快于消费者处理数据的速度时,会产生背压问题。

7.2 背压处理策略

RxSwift 主要通过以下方式处理背压:

  1. 请求机制:Observer 可以控制请求的数据量
  2. 缓冲:使用 buffer 操作符缓冲数据
  3. 节流:使用 throttledebounce 控制数据流速度
  4. 采样:使用 sample 采样数据

7.3 背压处理示例

class BackpressureObserver: ObserverType {
    typealias Element = Int
    
    private var buffer: [Int] = []
    private let bufferSize: Int
    private var subscription: Subscription?
    
    init(bufferSize: Int = 10) {
        self.bufferSize = bufferSize
    }
    
    func on(_ event: Event<Int>) {
        switch event {
        case .next(let element):
            buffer.append(element)
            
            // 处理缓冲区
            processBuffer()
            
            // 如果缓冲区未满,可以继续接收
            if buffer.count < bufferSize {
                // 继续接收
            }
        case .error, .completed:
            // 处理完成
            processRemaining()
        }
    }
    
    private func processBuffer() {
        while !buffer.isEmpty {
            let value = buffer.removeFirst()
            print("处理: \(value)")
        }
    }
    
    private func processRemaining() {
        processBuffer()
    }
}

8. 性能优化策略

8.1 值类型优化

RxSwift 大量使用值类型(struct),避免堆分配:

// 值类型,零成本抽象
struct Just<Element>: ObservableType { }
struct Map<SourceType, ResultType>: ObservableType { }
struct Filter<Element>: ObservableType { }

8.2 类型擦除

使用 asObservable() 隐藏具体类型:

extension ObservableType {
    public func asObservable() -> Observable<Element> {
        return Observable.create { observer in
            return self.subscribe(observer)
        }
    }
}

8.3 延迟执行

使用 deferred 延迟创建 Observable:

let deferred = Observable.deferred {
    // 只在订阅时执行
    return expensiveOperation()
}

8.4 共享订阅

使用 share() 共享 Observable:

let shared = expensiveObservable()
    .share()  // 多个订阅者共享同一个 Observable

shared.subscribe(onNext: { })  // 订阅1
shared.subscribe(onNext: { })  // 订阅2(共享执行)

8.5 内存优化

  • 使用 DisposeBag 自动管理订阅
  • 使用 weak self 避免循环引用
  • 及时取消不需要的订阅

📚 总结

RxSwift 框架的核心优势

  1. 跨平台标准:基于 ReactiveX 标准,与其他平台一致
  2. 丰富的操作符:提供大量操作符处理各种场景
  3. 类型安全:充分利用 Swift 类型系统
  4. 性能优化:值类型、零成本抽象
  5. 生态丰富:RxCocoa、RxDataSources 等扩展

学习建议

  1. 从基础开始:理解 Observable、Observer、Disposable
  2. 实践操作符:熟悉常用操作符的使用
  3. 理解调度器:掌握 subscribeOnobserveOn
  4. 阅读源码:深入理解实现原理
  5. 实际应用:在项目中应用 RxSwift

RxSwift vs Combine

  • RxSwift:适合需要支持 iOS 8+ 的项目,API 更丰富
  • Combine:适合 iOS 13+ 项目,与系统深度集成

文档版本:v1.0
最后更新:2026年1月15日
参考文献:RxSwift GitHub Repository, ReactiveX Documentation

03-研究优秀开源框架@响应式编程@iOS | ReactiveCocoa框架:从使用到源码解析

📋 目录


一、ReactiveCocoa框架使用详解

1. ReactiveCocoa框架概述

ReactiveCocoa(简称 RAC)是一个基于 ReactiveSwift 的响应式编程框架,用于处理异步事件流和状态管理。它是 GitHub 开源的项目,提供了声明式的 API 来处理时间序列数据。

1.1 什么是ReactiveCocoa

ReactiveCocoa 是一个函数式响应式编程(FRP)框架,允许你通过组合不同的操作符来处理异步事件序列。它提供了声明式的 API 来处理时间序列数据。

核心特点:

  • 函数式响应式编程:基于函数式编程和响应式编程的结合
  • 类型安全:充分利用 Swift 的类型系统
  • 状态管理:提供 Property 和 MutableProperty 管理状态
  • Action模式:提供 Action 处理用户交互
  • UIKit集成:深度集成 UIKit 控件

1.2 ReactiveCocoa vs RxSwift vs Combine

特性 ReactiveCocoa RxSwift Combine
平台 iOS、macOS 跨平台 Apple 生态(iOS 13+)
语言 Swift Swift Swift
官方支持 ❌ GitHub 开源 ❌ 第三方 ✅ Apple 官方
核心类型 Signal、SignalProducer Observable Publisher
状态管理 Property、MutableProperty BehaviorSubject @Published
Action模式 ✅ Action
学习曲线 陡峭 陡峭 中等
生态 ReactiveSwift、ReactiveObjC RxCocoa SwiftUI

1.3 ReactiveCocoa生态系统

  • ReactiveSwift:核心框架,提供 Signal、SignalProducer 等
  • ReactiveCocoa:UIKit/AppKit 集成,提供控件绑定
  • ReactiveObjC:Objective-C 版本

1.4 安装方式

CocoaPods:

pod 'ReactiveSwift', '~> 7.0'
pod 'ReactiveCocoa', '~> 12.0'

SPM:

dependencies: [
    .package(url: "https://github.com/ReactiveCocoa/ReactiveSwift.git", from: "7.0.0"),
    .package(url: "https://github.com/ReactiveCocoa/ReactiveCocoa.git", from: "12.0.0")
]

1.5 编程思想(背后的范式与理念)

ReactiveCocoa 明确标榜函数式响应式编程(FRP),将函数式与响应式结合;理解其背后的编程思想,能更好地区分 Signal / SignalProducer、Property、Action 的适用场景。

(1)函数式响应式编程(FRP)

  • 核心:在「响应式」的事件流之上,用函数式的方式组合与变换——把「随时间发生的事件」视为可映射、可过滤、可合并的值,通过纯函数组合成新流,而不是在观察者闭包里写满副作用。
  • 在 RAC 中Signal / SignalProducer 表示事件流,mapfilterflatMap 等操作符对流做纯变换,observestart 才真正消费并产生副作用;流与副作用边界清晰。
  • 与「仅响应式」的对比:FRP 强调「流即数据」,用转换与组合表达业务逻辑,观察者只做「最后一步」的响应,便于测试和复用。

(2)声明式 vs 命令式

维度 命令式(Imperative) 声明式(Declarative)
关注点 「怎么做」:显式顺序与分支 「做什么」:描述数据/事件如何变换与约束
典型写法 回调嵌套、状态变量、if-else 链式操作符:map / filter / combineLatest
在 RAC 中 手写「请求 → 回调里判断 → 再请求」 signal.map(...).flatMap(...).observeValues(...) 描述整条流水线

声明式让「事件从哪来、如何变换、到哪去」一目了然,便于阅读和单元测试。

(3)函数式思想(组合与不可变)

  • 组合(Composition):每个操作符只做一件事,通过 .map().filter().flatMap(.latest) 等组合成完整逻辑;小能力组合成大能力,避免巨型闭包。
  • 不可变(Immutability):操作符不修改原 Signal/SignalProducer,而是返回新的;原流不变,便于复用和推理。
  • 副作用边界:纯变换放在操作符链中,副作用(UI 更新、写库、弹窗)集中在 observeValues / startWithValuesAction 的 execution 中,便于测试和并发安全。

(4)流与时间(Streams & Time)

  • 把所有「会随时间产生的事件」都视为时间序列:value、value、…、completed/failed/interrupted。
  • RAC 区分热信号(Signal)冷信号(SignalProducer):热信号有订阅即开始发送、多订阅者共享同一时间线;冷信号每次 start 才执行、每次订阅独立。时间相关操作符如 debouncethrottle 表达「何时」而不只是「何值」。

(5)观察者与「推」「拉」

  • 观察者模式:Observer 通过 observe 订阅 Signal,或通过 start 启动 SignalProducer,在事件发生时被通知。
  • 推模型:Signal 是「推」——事件由发送端推动,观察者被动接收;SignalProducer 是「按需拉」——只有 start 时才创建并执行,适合表示「一次异步操作」或「延迟计算」。

(6)Action 与「意图-执行」分离

  • 思想:用户操作(点击、下拉)是意图,网络请求、校验、弹窗是执行;将「意图」与「执行」分离,便于禁用、重试、统一错误处理。
  • 在 RAC 中Action 接收输入(如按钮 tap 或输入值),内部用 SignalProducer 描述一次执行,输出与错误统一由 Action 暴露;UI 只绑定「能否执行」与「执行结果」,不写一堆 isLoadingerror 状态。

小结:ReactiveCocoa 用声明式事件流(Signal/SignalProducer)和可组合操作符,在函数式响应式的范式下做异步与事件处理;用 Property 管理可变状态、用 Action 封装「意图-执行」,并用 Scheduler 控制线程。掌握这些思想后,再区分「用 Signal 还是 SignalProducer」「何时用 Property、何时用 Action」会更自然。


2. 核心概念

2.1 Signal(信号)

Signal 是 ReactiveCocoa 的核心类型,表示一个可以观察的事件流。

protocol SignalProtocol {
    associatedtype Value
    associatedtype Error: Swift.Error
    
    func observe(_ observer: Observer<Value, Error>) -> Disposable?
}

特点:

  • 可以发出零个或多个值
  • 可能以完成或错误结束
  • 是引用类型(class)
  • 热信号(Hot Signal):有订阅者时立即开始发送事件

事件类型:

enum Event<Value, Error: Swift.Error> {
    case value(Value)      // 值事件
    case failed(Error)    // 错误事件
    case completed        // 完成事件
    case interrupted      // 中断事件
}

示例:

let (signal, observer) = Signal<String, Never>.pipe()

signal.observeValues { value in
    print("收到值: \(value)")
}

observer.send(value: "Hello")
observer.send(value: "World")
observer.sendCompleted()

2.2 SignalProducer(信号生产者)

SignalProducer 是延迟创建 Signal 的类型,类似于 RxSwift 的 Observable。

struct SignalProducer<Value, Error: Swift.Error> {
    private let startHandler: (Observer<Value, Error>, Lifetime) -> Void
    
    func start(_ observer: Observer<Value, Error>) -> Disposable
}

特点:

  • 冷信号(Cold Signal):只有在被订阅时才开始发送事件
  • 每次订阅都会创建新的 Signal
  • 适合表示异步操作

示例:

let producer = SignalProducer<String, Never> { observer, lifetime in
    observer.send(value: "Hello")
    observer.send(value: "World")
    observer.sendCompleted()
}

producer.startWithValues { value in
    print("收到值: \(value)")
}

2.3 Observer(观察者)

Observer 是接收 Signal 事件的类型。

final class Observer<Value, Error: Swift.Error> {
    func send(value: Value)
    func send(error: Error)
    func sendCompleted()
    func sendInterrupted()
}

示例:

let (signal, observer) = Signal<Int, Never>.pipe()

signal.observe { event in
    switch event {
    case .value(let value):
        print("值: \(value)")
    case .completed:
        print("完成")
    case .failed(let error):
        print("错误: \(error)")
    case .interrupted:
        print("中断")
    }
}

observer.send(value: 1)
observer.send(value: 2)
observer.sendCompleted()

2.4 Disposable(可释放资源)

Disposable 表示订阅关系,用于取消订阅和释放资源。

protocol Disposable {
    func dispose()
}

CompositeDisposable:

let disposable = CompositeDisposable()

disposable += signal.observeValues { value in
    print(value)
}

disposable += anotherSignal.observeValues { value in
    print(value)
}

// 释放所有订阅
disposable.dispose()

3. Signal与SignalProducer

3.1 Signal创建方式

pipe

创建 Signal 和 Observer。

let (signal, observer) = Signal<String, Never>.pipe()

signal.observeValues { print($0) }
observer.send(value: "Hello")
never

创建永不发出事件的 Signal。

let signal = Signal<Int, Never>.never()
signal.observeValues { print($0) }  // 永远不会执行
empty

创建立即完成的 Signal。

let signal = Signal<Int, Never>.empty()
signal.observeCompleted { print("完成") }
failed

创建立即失败的 Signal。

enum MyError: Error {
    case failure
}

let signal = Signal<Int, MyError>.failed(.failure)
signal.observeFailed { print("错误: \($0)") }

3.2 SignalProducer创建方式

init

使用闭包创建 SignalProducer。

let producer = SignalProducer<String, Never> { observer, lifetime in
    observer.send(value: "A")
    observer.send(value: "B")
    observer.sendCompleted()
}

producer.startWithValues { print($0) }
value

创建发出单个值的 SignalProducer。

let producer = SignalProducer<String, Never>(value: "Hello")
producer.startWithValues { print($0) }
values

从序列创建 SignalProducer。

let producer = SignalProducer<String, Never>(values: ["A", "B", "C"])
producer.startWithValues { print($0) }
error

创建立即失败的 SignalProducer。

let producer = SignalProducer<Int, MyError>(error: .failure)
producer.startWithFailed { print("错误: \($0)") }
empty

创建立即完成的 SignalProducer。

let producer = SignalProducer<Int, Never>.empty
producer.startWithCompleted { print("完成") }
never

创建永不发出事件的 SignalProducer。

let producer = SignalProducer<Int, Never>.never
producer.startWithValues { print($0) }  // 永远不会执行

3.3 Signal vs SignalProducer

Signal(热信号):

  • 立即开始发送事件
  • 多个观察者共享同一个事件流
  • 适合表示已经发生的事件

SignalProducer(冷信号):

  • 延迟创建,只有在订阅时才开始
  • 每个观察者获得独立的事件流
  • 适合表示异步操作

转换:

// SignalProducer -> Signal
let producer = SignalProducer<String, Never>(value: "Hello")
let signal = producer.promoteToSignal()

// Signal -> SignalProducer
let (signal, observer) = Signal<String, Never>.pipe()
let producer = SignalProducer(signal)

4. Property与MutableProperty

4.1 Property

Property 是不可变的状态容器,表示一个随时间变化的值。

protocol PropertyProtocol {
    associatedtype Value
    
    var value: Value { get }
    var signal: Signal<Value, Never> { get }
    var producer: SignalProducer<Value, Never> { get }
}

特点:

  • 只读属性
  • 提供当前值
  • 提供 Signal 和 SignalProducer 观察变化

示例:

let property = Property(value: "初始值")

// 获取当前值
print(property.value)  // 输出: 初始值

// 观察变化
property.signal.observeValues { value in
    print("值变化: \(value)")
}

4.2 MutableProperty

MutableProperty 是可变的状态容器。

final class MutableProperty<Value>: MutablePropertyProtocol {
    var value: Value { get set }
    var signal: Signal<Value, Never> { get }
    var producer: SignalProducer<Value, Never> { get }
    
    init(_ value: Value)
}

特点:

  • 可读写属性
  • 修改值时会发出事件
  • 新观察者会立即收到当前值

示例:

let property = MutableProperty("初始值")

// 观察变化
property.signal.observeValues { value in
    print("值变化: \(value)")
}
// 立即输出: 值变化: 初始值

// 修改值
property.value = "新值"  // 输出: 值变化: 新值
property.value = "另一个值"  // 输出: 值变化: 另一个值

4.3 Property绑定

双向绑定:

let property1 = MutableProperty("")
let property2 = MutableProperty("")

// 双向绑定
property1 <~ property2
property2 <~ property1

property1.value = "Hello"  // property2.value 也变为 "Hello"
property2.value = "World"  // property1.value 也变为 "World"

单向绑定:

let source = MutableProperty("源")
let target = MutableProperty("目标")

// 单向绑定:source -> target
target <~ source

source.value = "新值"  // target.value 也变为 "新值"
target.value = "修改"  // source.value 不变

5. Action

Action 是 ReactiveCocoa 特有的类型,用于处理用户交互和异步操作。

5.1 Action基本使用

let action = Action<String, String, Never> { input in
    return SignalProducer { observer, lifetime in
        // 执行异步操作
        DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
            observer.send(value: "结果: \(input)")
            observer.sendCompleted()
        }
    }
}

// 执行 Action
action.apply("输入").startWithValues { result in
    print(result)  // 输出: 结果: 输入
}

5.2 Action状态

Action 提供多个状态 Signal:

let action = Action<String, String, Never> { input in
    return SignalProducer(value: "结果: \(input)")
}

// 观察执行状态
action.isExecuting.signal.observeValues { isExecuting in
    print("执行中: \(isExecuting)")
}

// 观察值
action.values.observeValues { value in
    print("值: \(value)")
}

// 观察错误
action.errors.observeValues { error in
    print("错误: \(error)")
}

// 执行
action.apply("输入").start()

5.3 Action与UIButton绑定

let action = Action<Void, String, Never> {
    return SignalProducer(value: "按钮点击")
}

// 绑定到按钮
button.reactive.pressed = CocoaAction(action) { _ in }

// 观察结果
action.values.observeValues { result in
    print(result)
}

6. Operators操作符

6.1 转换操作符

map

转换每个值。

SignalProducer(values: [1, 2, 3])
    .map { $0 * 2 }
    .startWithValues { print($0) }
// 输出: 2, 4, 6
flatMap

将 Signal 发出的值转换为 SignalProducer,然后合并。

SignalProducer(values: ["A", "B", "C"])
    .flatMap(.latest) { letter in
        SignalProducer(values: [1, 2]).map { "\(letter)\($0)" }
    }
    .startWithValues { print($0) }
// 输出: A1, A2, B1, B2, C1, C2
scan

累积值。

SignalProducer(values: [1, 2, 3, 4, 5])
    .scan(0, +)
    .startWithValues { print($0) }
// 输出: 1, 3, 6, 10, 15

6.2 过滤操作符

filter

过滤值。

SignalProducer(values: [1, 2, 3, 4, 5])
    .filter { $0 % 2 == 0 }
    .startWithValues { print($0) }
// 输出: 2, 4
skip

跳过前几个值。

SignalProducer(values: [1, 2, 3, 4, 5])
    .skip(first: 2)
    .startWithValues { print($0) }
// 输出: 3, 4, 5
take

获取前几个值。

SignalProducer(values: [1, 2, 3, 4, 5])
    .take(first: 3)
    .startWithValues { print($0) }
// 输出: 1, 2, 3
distinctUntilChanged

移除连续重复的值。

SignalProducer(values: [1, 1, 2, 2, 3, 3])
    .distinctUntilChanged()
    .startWithValues { print($0) }
// 输出: 1, 2, 3

6.3 组合操作符

combineLatest

组合多个 Signal 的最新值。

let (signal1, observer1) = Signal<String, Never>.pipe()
let (signal2, observer2) = Signal<Int, Never>.pipe()

signal1.combineLatest(with: signal2)
    .observeValues { value1, value2 in
        print("\(value1): \(value2)")
    }

observer1.send(value: "A")  // 无输出(等待 signal2)
observer2.send(value: 1)    // 输出: A: 1
observer1.send(value: "B")  // 输出: B: 1
observer2.send(value: 2)    // 输出: B: 2
merge

合并多个 Signal。

let (signal1, observer1) = Signal<Int, Never>.pipe()
let (signal2, observer2) = Signal<Int, Never>.pipe()

signal1.merge(with: signal2)
    .observeValues { print($0) }

observer1.send(value: 1)  // 输出: 1
observer2.send(value: 2)  // 输出: 2
observer1.send(value: 3)  // 输出: 3
zip

按顺序组合多个 Signal。

let (signal1, observer1) = Signal<String, Never>.pipe()
let (signal2, observer2) = Signal<Int, Never>.pipe()

signal1.zip(with: signal2)
    .observeValues { value1, value2 in
        print("\(value1): \(value2)")
    }

observer1.send(value: "A")  // 等待 signal2
observer1.send(value: "B")  // 等待 signal2
observer2.send(value: 1)    // 输出: A: 1
observer2.send(value: 2)    // 输出: B: 2

6.4 时间操作符

debounce

防抖,等待指定时间后发出最新值。

let (signal, observer) = Signal<String, Never>.pipe()

signal.debounce(0.5, on: QueueScheduler.main)
    .observeValues { print($0) }

observer.send(value: "H")     // 不输出
observer.send(value: "He")    // 不输出
observer.send(value: "Hel")   // 不输出
observer.send(value: "Hell")  // 不输出
observer.send(value: "Hello") // 0.5秒后输出: Hello
throttle

节流,在指定时间间隔内只发出第一个值。

let (signal, observer) = Signal<String, Never>.pipe()

signal.throttle(1.0, on: QueueScheduler.main)
    .observeValues { print($0) }

observer.send(value: "A")  // 立即输出: A
observer.send(value: "B")  // 不输出(1秒内)
observer.send(value: "C")  // 不输出(1秒内)
// 1秒后
observer.send(value: "D")  // 输出: D
delay

延迟发出值。

SignalProducer(values: [1, 2, 3])
    .delay(1.0, on: QueueScheduler.main)
    .startWithValues { print($0) }
// 1秒后依次输出: 1, 2, 3

7. Schedulers调度器

7.1 内置Scheduler

QueueScheduler

队列调度器。

// 主队列
let mainScheduler = QueueScheduler.main

// 后台队列
let backgroundScheduler = QueueScheduler(
    qos: .background,
    name: "background.queue"
)

SignalProducer(value: 1)
    .start(on: backgroundScheduler)
    .observe(on: mainScheduler)
    .startWithValues { value in
        print(Thread.isMainThread)  // true
    }
UIScheduler

UI 调度器(主线程)。

let uiScheduler = UIScheduler()

SignalProducer(value: 1)
    .observe(on: uiScheduler)
    .startWithValues { value in
        print(Thread.isMainThread)  // true
    }

7.2 start vs observe

  • start:指定 SignalProducer 在哪个调度器上开始执行
  • observe:指定观察者在哪个调度器上接收事件
SignalProducer { observer, lifetime in
    print("执行线程: \(Thread.current)")
    observer.send(value: 1)
    observer.sendCompleted())
}
.start(on: QueueScheduler(qos: .background))
.observe(on: UIScheduler())
.startWithValues { value in
    print("接收线程: \(Thread.current)")
}

8. 错误处理

8.1 错误类型

enum NetworkError: Error {
    case invalidURL
    case noData
    case decodingError
}

8.2 错误处理操作符

catch

捕获错误并返回备用 SignalProducer。

SignalProducer<String, NetworkError>(error: .noData)
    .catch { error -> SignalProducer<String, Never> in
        print("捕获错误: \(error)")
        return SignalProducer(value: "备用值")
    }
    .startWithValues { print($0) }
retry

重试失败的 SignalProducer。

var attempts = 0

SignalProducer<String, NetworkError> { observer, lifetime in
    attempts += 1
    if attempts < 3 {
        observer.send(error: .noData)
    } else {
        observer.send(value: "成功")
        observer.sendCompleted()
    }
}
.retry(upTo: 2)  // 最多重试 2 次
.start(
    value: { print($0) },
    failed: { print("错误: \($0)") }
)
flatMapError

将错误转换为值。

SignalProducer<String, NetworkError>(error: .noData)
    .flatMapError { error in
        SignalProducer(value: "错误: \(error)")
    }
    .startWithValues { print($0) }

9. 内存管理

9.1 Lifetime

Lifetime 用于管理 SignalProducer 的生命周期。

let producer = SignalProducer<String, Never> { observer, lifetime in
    let timer = Timer.scheduledTimer(withTimeInterval: 1.0, repeats: true) { _ in
        observer.send(value: "Tick")
    }
    
    lifetime.observeEnded {
        timer.invalidate()
    }
}

let disposable = producer.startWithValues { print($0) }

// 取消订阅时,timer 会自动失效
disposable.dispose()

9.2 避免循环引用

class ViewModel {
    private let property = MutableProperty("")
    
    func setup() {
        property.signal.observeValues { [weak self] value in
            self?.process(value)
        }
    }
    
    private func process(_ value: String) {
        // 处理数据
    }
}

10. 与UIKit集成

10.1 Reactive扩展

ReactiveCocoa 为 UIKit 控件提供了 Reactive 扩展。

import ReactiveSwift
import ReactiveCocoa

class ViewController: UIViewController {
    @IBOutlet weak var textField: UITextField!
    @IBOutlet weak var button: UIButton!
    @IBOutlet weak var label: UILabel!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        // 文本输入绑定
        label.reactive.text <~ textField.reactive.continuousTextValues
        
        // 按钮点击
        button.reactive.pressed = CocoaAction(Action { [weak self] _ in
            return SignalProducer(value: "按钮点击")
        })
    }
}

10.2 常用绑定

// UILabel
label.reactive.text <~ property.producer.map { $0 }

// UITextField
textField.reactive.text <~ property.producer.map { $0 }
property <~ textField.reactive.continuousTextValues

// UIButton
button.reactive.pressed = CocoaAction(action)

// UISwitch
switch.reactive.isOn <~ property.producer.map { $0 }
property <~ switch.reactive.isOnValues

// UISlider
slider.reactive.value <~ property.producer.map { Float($0) }
property <~ slider.reactive.values.map { Int($0) }

11. 实际应用场景

11.1 网络请求

struct API {
    static func fetchUser(id: Int) -> SignalProducer<User, NetworkError> {
        let url = URL(string: "https://api.example.com/users/\(id)")!
        
        return URLSession.shared.reactive.data(with: URLRequest(url: url))
            .attemptMap { data, _ in
                try JSONDecoder().decode(User.self, from: data)
            }
            .observe(on: UIScheduler())
    }
}

API.fetchUser(id: 1)
    .start(
        value: { user in
            print("用户: \(user)")
        },
        failed: { error in
            print("错误: \(error)")
        }
    )

11.2 用户输入处理

class SearchViewModel {
    let searchText = MutableProperty("")
    let results = MutableProperty<[String]>([])
    
    init() {
        results <~ searchText.producer
            .debounce(0.5, on: QueueScheduler.main)
            .skipRepeats()
            .filter { !$0.isEmpty }
            .flatMap(.latest) { query -> SignalProducer<[String], Never> in
                return self.search(query: query)
                    .flatMapError { _ in SignalProducer(value: []) }
            }
    }
    
    private func search(query: String) -> SignalProducer<[String], NetworkError> {
        // 实现搜索逻辑
        return SignalProducer(value: ["结果1", "结果2"])
    }
}

二、ReactiveCocoa框架源码解析

1. 架构设计

1.1 整体架构

ReactiveCocoa 采用协议导向的设计,核心是 Signal 和 SignalProducer。

Signal (热信号)
    ↓
Observer
    ↓
Event (value/failed/completed/interrupted)

SignalProducer (冷信号)
    ↓
Observer
    ↓
Signal

1.2 核心协议层次

// Signal 协议
protocol SignalProtocol {
    associatedtype Value
    associatedtype Error: Swift.Error
    
    func observe(_ observer: Observer<Value, Error>) -> Disposable?
}

// SignalProducer 协议
protocol SignalProducerProtocol {
    associatedtype Value
    associatedtype Error: Swift.Error
    
    func start(_ observer: Observer<Value, Error>) -> Disposable
}

2. Signal实现原理

2.1 Signal类实现

public final class Signal<Value, Error: Swift.Error>: SignalProtocol {
    private let generator: (Observer<Value, Error>) -> Disposable?
    private var observers: Bag<Observer<Value, Error>> = Bag()
    private let lock = NSRecursiveLock()
    
    public init(_ generator: @escaping (Observer<Value, Error>) -> Disposable?) {
        self.generator = generator
    }
    
    public func observe(_ observer: Observer<Value, Error>) -> Disposable? {
        lock.lock()
        defer { lock.unlock() }
        
        let token = observers.insert(observer)
        
        // 如果是第一个观察者,开始生成事件
        if observers.count == 1 {
            let disposable = generator(Observer { [weak self] event in
                self?.send(event)
            })
            
            return CompositeDisposable(
                disposable,
                Disposable { [weak self] in
                    self?.lock.lock()
                    self?.observers.remove(using: token)
                    self?.lock.unlock()
                }
            )
        }
        
        return Disposable { [weak self] in
            self?.lock.lock()
            self?.observers.remove(using: token)
            self?.lock.unlock()
        }
    }
    
    private func send(_ event: Event<Value, Error>) {
        lock.lock()
        let currentObservers = observers
        lock.unlock()
        
        for observer in currentObservers {
            observer.send(event)
        }
        
        // 如果是终止事件,清理观察者
        if event.isTerminating {
            lock.lock()
            observers.removeAll()
            lock.unlock()
        }
    }
}

关键点:

  • Signal 是引用类型(class)
  • 使用 Bag 存储多个观察者
  • 使用锁保护共享状态
  • 第一个观察者订阅时开始生成事件

2.2 pipe实现

extension Signal {
    public static func pipe() -> (Signal<Value, Error>, Observer<Value, Error>) {
        let observer = Observer<Value, Error>()
        let signal = Signal<Value, Error> { observer in
            // 将外部 observer 的事件转发给内部 observer
            return observer.observe { event in
                observer.send(event)
            }
        }
        
        return (signal, observer)
    }
}

关键点:

  • pipe 创建 Signal 和 Observer 对
  • Observer 可以手动发送事件
  • 适合将命令式代码转换为响应式代码

3. SignalProducer实现原理

3.1 SignalProducer结构

public struct SignalProducer<Value, Error: Swift.Error>: SignalProducerProtocol {
    private let startHandler: (Observer<Value, Error>, Lifetime) -> Void
    
    public init(_ startHandler: @escaping (Observer<Value, Error>, Lifetime) -> Void) {
        self.startHandler = startHandler
    }
    
    public func start(_ observer: Observer<Value, Error>) -> Disposable {
        let lifetime = Lifetime()
        let compositeDisposable = CompositeDisposable()
        
        lifetime.observeEnded {
            compositeDisposable.dispose()
        }
        
        startHandler(observer, lifetime)
        
        return compositeDisposable
    }
}

关键点:

  • SignalProducer 是值类型(struct)
  • 每次 start 都会创建新的 Signal
  • 使用 Lifetime 管理资源生命周期

3.2 SignalProducer转换

extension SignalProducer {
    public var signal: Signal<Value, Error> {
        return Signal { observer in
            return self.start(observer)
        }
    }
}

extension Signal {
    public var producer: SignalProducer<Value, Error> {
        return SignalProducer { observer, lifetime in
            let disposable = self.observe(observer)
            lifetime.observeEnded {
                disposable?.dispose()
            }
        }
    }
}

关键点:

  • SignalProducer 可以转换为 Signal
  • Signal 可以转换为 SignalProducer
  • 转换是延迟的,不会立即执行

4. Property实现原理

4.1 Property协议

public protocol PropertyProtocol {
    associatedtype Value
    
    var value: Value { get }
    var signal: Signal<Value, Never> { get }
    var producer: SignalProducer<Value, Never> { get }
}

4.2 MutableProperty实现

public final class MutableProperty<Value>: MutablePropertyProtocol {
    private let lock = NSRecursiveLock()
    private var _value: Value
    private let observer: Observer<Value, Never>
    private let signal: Signal<Value, Never>
    
    public var value: Value {
        get {
            lock.lock()
            defer { lock.unlock() }
            return _value
        }
        set {
            lock.lock()
            let oldValue = _value
            _value = newValue
            lock.unlock()
            
            if oldValue != newValue {
                observer.send(value: newValue)
            }
        }
    }
    
    public init(_ value: Value) {
        _value = value
        let (signal, observer) = Signal<Value, Never>.pipe()
        self.signal = signal
        self.observer = observer
        
        // 立即发送初始值
        observer.send(value: value)
    }
    
    public var producer: SignalProducer<Value, Never> {
        return SignalProducer { observer, lifetime in
            // 立即发送当前值
            observer.send(value: self.value)
            
            // 观察后续变化
            let disposable = self.signal.observe(observer)
            lifetime.observeEnded {
                disposable?.dispose()
            }
        }
    }
}

关键点:

  • MutableProperty 是引用类型
  • 使用锁保护 _value
  • 值变化时发出事件
  • producer 会立即发送当前值

4.3 绑定操作符实现

infix operator <~ : BindingPrecedence

public func <~ <Source: SignalProducerProtocol, Destination: BindingTargetProtocol>(
    destination: Destination,
    source: Source
) -> Disposable
where Source.Value == Destination.Value, Source.Error == Never {
    return source.startWithValues { value in
        destination.consume(value)
    }
}

public func <~ <Source: SignalProtocol, Destination: BindingTargetProtocol>(
    destination: Destination,
    source: Source
) -> Disposable?
where Source.Value == Destination.Value, Source.Error == Never {
    return source.observeValues { value in
        destination.consume(value)
    }
}

关键点:

  • <~ 操作符实现单向绑定
  • 自动管理订阅生命周期
  • 支持 Signal 和 SignalProducer

5. Action实现原理

5.1 Action结构

public final class Action<Input, Output, Error: Swift.Error> {
    private let executeClosure: (Input) -> SignalProducer<Output, Error>
    private let isEnabledProperty: MutableProperty<Bool>
    private let eventsObserver: Observer<Event<Output, Error>, Never>
    
    public let isEnabled: Property<Bool>
    public let isExecuting: Property<Bool>
    public let values: Signal<Output, Never>
    public let errors: Signal<Error, Never>
    public let events: Signal<Event<Output, Error>, Never>
    
    public init(enabledIf: Property<Bool> = Property(value: true),
                execute: @escaping (Input) -> SignalProducer<Output, Error>) {
        self.executeClosure = execute
        self.isEnabledProperty = MutableProperty(true)
        self.isEnabled = Property(capturing: isEnabledProperty)
        
        let (eventsSignal, eventsObserver) = Signal<Event<Output, Error>, Never>.pipe()
        self.events = eventsSignal
        self.eventsObserver = eventsObserver
        
        self.values = events.map { $0.value }.skipNil()
        self.errors = events.map { $0.error }.skipNil()
        
        let isExecutingProperty = MutableProperty(false)
        self.isExecuting = Property(capturing: isExecutingProperty)
        
        // 监听执行状态
        events.observeValues { event in
            switch event {
            case .value:
                isExecutingProperty.value = true
            case .completed, .failed, .interrupted:
                isExecutingProperty.value = false
            }
        }
    }
    
    public func apply(_ input: Input) -> SignalProducer<Output, Error> {
        return SignalProducer { observer, lifetime in
            guard self.isEnabled.value else {
                observer.sendInterrupted()
                return
            }
            
            let producer = self.executeClosure(input)
            let disposable = producer.start { event in
                self.eventsObserver.send(value: event)
                observer.send(event)
            }
            
            lifetime.observeEnded {
                disposable.dispose()
            }
        }
    }
}

关键点:

  • Action 封装异步操作
  • 提供执行状态(isEnabled、isExecuting)
  • 提供值、错误、事件流
  • 可以禁用 Action

6. Operators实现原理

6.1 map实现

extension SignalProducer {
    public func map<U>(_ transform: @escaping (Value) -> U) -> SignalProducer<U, Error> {
        return SignalProducer { observer, lifetime in
            self.start { event in
                switch event {
                case .value(let value):
                    observer.send(value: transform(value))
                case .failed(let error):
                    observer.send(error: error)
                case .completed:
                    observer.sendCompleted()
                case .interrupted:
                    observer.sendInterrupted()
                }
            }
        }
    }
}

关键点:

  • map 创建新的 SignalProducer
  • 转换每个值事件
  • 保持其他事件不变

6.2 filter实现

extension SignalProducer {
    public func filter(_ predicate: @escaping (Value) -> Bool) -> SignalProducer<Value, Error> {
        return SignalProducer { observer, lifetime in
            self.start { event in
                switch event {
                case .value(let value):
                    if predicate(value) {
                        observer.send(value: value)
                    }
                case .failed(let error):
                    observer.send(error: error)
                case .completed:
                    observer.sendCompleted()
                case .interrupted:
                    observer.sendInterrupted()
                }
            }
        }
    }
}

关键点:

  • filter 创建新的 SignalProducer
  • 只转发满足条件的值
  • 保持其他事件不变

6.3 flatMap实现

extension SignalProducer {
    public func flatMap<U>(_ strategy: FlattenStrategy, _ transform: @escaping (Value) -> SignalProducer<U, Error>) -> SignalProducer<U, Error> {
        return SignalProducer { observer, lifetime in
            let flattenProducer = self.map(transform).flatten(strategy)
            let disposable = flattenProducer.start(observer)
            lifetime.observeEnded {
                disposable.dispose()
            }
        }
    }
}

关键点:

  • flatMap 支持多种策略(.latest、.merge、.concat)
  • 管理多个内部 SignalProducer
  • 需要复杂的生命周期管理

7. Schedulers实现原理

7.1 Scheduler协议

public protocol Scheduler {
    func schedule(_ action: @escaping () -> Void) -> Disposable?
    func schedule(after date: Date, action: @escaping () -> Void) -> Disposable?
    func schedule(after date: Date, interval: TimeInterval, action: @escaping () -> Void) -> Disposable?
}

7.2 QueueScheduler实现

public final class QueueScheduler: Scheduler {
    public let queue: DispatchQueue
    
    public init(qos: DispatchQoS = .default, name: String = "org.reactivecocoa.ReactiveSwift.QueueScheduler") {
        self.queue = DispatchQueue(label: name, qos: qos)
    }
    
    public static let main = QueueScheduler(queue: .main, name: "org.reactivecocoa.ReactiveSwift.QueueScheduler.main")
    
    public func schedule(_ action: @escaping () -> Void) -> Disposable? {
        let disposable = SimpleDisposable()
        queue.async {
            if !disposable.isDisposed {
                action()
            }
        }
        return disposable
    }
    
    public func schedule(after date: Date, action: @escaping () -> Void) -> Disposable? {
        let disposable = SimpleDisposable()
        let timeInterval = date.timeIntervalSinceNow
        queue.asyncAfter(deadline: .now() + timeInterval) {
            if !disposable.isDisposed {
                action()
            }
        }
        return disposable
    }
}

关键点:

  • QueueScheduler 使用 DispatchQueue
  • 支持立即和延迟调度
  • 支持取消调度

8. 生命周期管理

8.1 Lifetime实现

public final class Lifetime {
    private let token: Token
    private var observers: Bag<() -> Void> = Bag()
    private let lock = NSRecursiveLock()
    
    public init() {
        token = Token()
    }
    
    public func observeEnded(_ action: @escaping () -> Void) {
        lock.lock()
        let isEnded = token.isEnded
        if !isEnded {
            observers.insert(action)
        }
        lock.unlock()
        
        if isEnded {
            action()
        }
    }
    
    deinit {
        token.markEnded()
        lock.lock()
        let currentObservers = observers
        observers.removeAll()
        lock.unlock()
        
        for observer in currentObservers {
            observer()
        }
    }
}

关键点:

  • Lifetime 管理资源生命周期
  • 对象释放时自动执行清理操作
  • 使用 observeEnded 注册清理回调

8.2 Disposable管理

public final class CompositeDisposable: Disposable {
    private var disposables: [Disposable] = []
    private let lock = NSRecursiveLock()
    private var isDisposed = false
    
    public init(_ disposables: Disposable...) {
        self.disposables = disposables
    }
    
    public func add(_ disposable: Disposable?) {
        guard let disposable = disposable else { return }
        
        lock.lock()
        if isDisposed {
            lock.unlock()
            disposable.dispose()
            return
        }
        
        disposables.append(disposable)
        lock.unlock()
    }
    
    public func dispose() {
        lock.lock()
        guard !isDisposed else {
            lock.unlock()
            return
        }
        
        isDisposed = true
        let currentDisposables = disposables
        disposables.removeAll()
        lock.unlock()
        
        for disposable in currentDisposables {
            disposable.dispose()
        }
    }
}

关键点:

  • CompositeDisposable 管理多个 Disposable
  • 线程安全
  • 一次性释放所有资源

9. 性能优化策略

9.1 值类型优化

SignalProducer 是值类型,避免堆分配:

// 值类型,零成本抽象
struct SignalProducer<Value, Error: Swift.Error> { }

9.2 延迟执行

SignalProducer 延迟创建 Signal:

let producer = SignalProducer<String, Never> { observer, lifetime in
    // 只在 start 时执行
    observer.send(value: "Hello")
}

9.3 共享执行

使用 share() 共享 SignalProducer:

let shared = expensiveProducer().share()

shared.startWithValues { }  // 订阅1
shared.startWithValues { }  // 订阅2(共享执行)

9.4 内存优化

  • 使用 weak 引用避免循环引用
  • 使用 Lifetime 自动管理资源
  • 及时释放不需要的订阅

📚 总结

ReactiveCocoa 的核心优势

  1. Property 状态管理:提供 Property 和 MutableProperty 管理状态
  2. Action 模式:提供 Action 处理用户交互和异步操作
  3. 类型安全:充分利用 Swift 类型系统
  4. 生命周期管理:使用 Lifetime 自动管理资源
  5. UIKit 集成:深度集成 UIKit 控件

学习建议

  1. 理解 Signal vs SignalProducer:掌握热信号和冷信号的区别
  2. 理解 Property:掌握状态管理
  3. 理解 Action:掌握用户交互处理
  4. 阅读源码:深入理解实现原理
  5. 实际应用:在项目中应用 ReactiveCocoa

文档版本:v1.0
最后更新:2026年1月15日
参考文献:ReactiveCocoa GitHub Repository, ReactiveSwift Source Code

02-研究优秀开源框架@响应式编程@iOS | Combine框架:源码解析


二、Combine框架源码解析

1. 架构设计

1.1 整体架构

Combine 采用协议导向的设计,核心是三个协议:

Publisher (发布者)
    ↓
Subscription (订阅关系)
    ↓
Subscriber (订阅者)

数据流:

Publisher → Subscription → Subscriber
     ↑                          ↓
     └────────── 反馈 ──────────┘

1.2 核心协议层次

// 第一层:Publisher 协议
protocol Publisher {
    associatedtype Output
    associatedtype Failure: Error
    func receive<S: Subscriber>(subscriber: S)
}

// 第二层:Subscription 协议
protocol Subscription: Cancellable {
    func request(_ demand: Subscribers.Demand)
}

// 第三层:Subscriber 协议
protocol Subscriber: CustomCombineIdentifierConvertible {
    associatedtype Input
    associatedtype Failure: Error
    func receive(subscription: Subscription)
    func receive(_ input: Input) -> Subscribers.Demand
    func receive(completion: Subscribers.Completion<Failure>)
}

1.3 内部架构分层(三层视图)

Combine 从内到外可以理解为协议层 → 实现层 → 调度层,三者共同决定「谁在何时、何地、以何种方式」传递事件。

架构分层示意:

┌─────────────────────────────────────────────────────────────────────────────┐
│ 调度层 (Scheduler)                                                           │
│  · 决定事件在哪个线程/队列执行                                                 │
│  · subscribe(on:) / receive(on:) / 时间类操作符(debounce, delay) 依赖调度器     │
└─────────────────────────────────────────────────────────────────────────────┘
                                      │
                                      ▼
┌─────────────────────────────────────────────────────────────────────────────┐
│ 实现层 (Concrete Types)                                                       │
│  · Just / Future / PassthroughSubject / Publishers.Map / Sink / Assign ...   │
│  · 每个操作符 = 新 Publisher + 中间 Subscriber,形成链式实现                    │
└─────────────────────────────────────────────────────────────────────────────┘
                                      │
                                      ▼
┌─────────────────────────────────────────────────────────────────────────────┐
│ 协议层 (Protocols)                                                            │
│  · Publisher:定义「可被订阅」的契约                                           │
│  · Subscription:定义「请求/取消」的契约                                       │
│  · Subscriber:定义「接收值/完成」的契约                                       │
└─────────────────────────────────────────────────────────────────────────────┘
  • 协议层:只规定接口(Output/Failure、receive(subscription/input/completion)、request(demand)),不关心具体类型。
  • 实现层:所有 JustMapFilterSink 等具体类型都遵循上述协议,并通过「包装上游 + 向下游转发」组成链条。
  • 调度层:由 Scheduler 协议抽象(如 DispatchQueueRunLoop),操作符在需要时把回调投递到指定调度器执行,从而控制线程与时机。

1.4 响应者链(订阅链)

一次 publisher.map(...).filter(...).sink(...) 会在内部形成一条从上游到下游的订阅链:每一环都是一个 Publisher,下游订阅上游,最末端是真正的 Subscriber(如 Sink)。值沿这条链自上而下传递,Demand 可自下而上反馈。

响应者链结构图:

  [上游]          [操作符]           [操作符]          [终端]
   Just    →    Map<Int,String>  →  Filter<String>  →   Sink
    │                 │                    │               │
    │  subscribe      │  subscribe         │  subscribe    │
    │ ◄───────────────┼────────────────────┼───────────────┤
    │                 │                    │               │
    │  receive(S)     │  receive(S)        │  receive(S)   │
    │  创建 Subscription                    │               │
    │  向下游传 subscription                │               │
    │                 │  request(demand)   │               │
    │                 │ ◄──────────────────┼───────────────┤
    │  receive(1)     │  receive("1")       │  receive("1") │
    │                 │  receive(2)        │  (若通过)     │
    │                 │  receive("2")      │  receive("2") │
    │                 │  ...               │  ...          │
    │  receive(.finished)                   │               │
    │                 │  receive(completion)                │
    │                 │                    │  receive(completion)
    │                 │                    │               │
    ▼                 ▼                    ▼               ▼

要点:

  • 谁是谁的上游/下游:例如 Just(1).map { "\($0)" } 中,Just 是上游,Publishers.Map<Just<Int>, String> 是下游;.sink 时,Sink 是整条链的最终下游。
  • 订阅方向:下游调用 upstream.receive(subscriber: self),即「下游作为 Subscriber 被上游接收」,从而建立订阅。
  • 值传递方向:上游通过 subscriber.receive(value) 把值交给下游;若下游是另一个操作符的包装 Subscriber,该 Subscriber 会做变换后再调用自己的下游的 receive,形成链式传递。
  • Demand 反馈receive(_ input:) 返回 Subscribers.Demand,上游(或中间层)根据该返回值决定是否继续发送、发送多少,实现背压。

1.5 信息流流转(从订阅到结束)

从调用 subscribe(如 .sink(...))到收到完成,整条链上的调用顺序是固定的,可归纳为建立订阅 → 请求 Demand → 多次下发值 → 下发完成

阶段一:建立订阅(自上而下)

  sink(...) 被调用
       │
       ▼
  Sink 作为 Subscriber 被传给最下游 Publisher(如 Filter)
       │
       ▼
  Filter.receive(subscriber: Sink)  →  创建 FilterSubscriber,包装 Sink
       │
       ▼
  FilterSubscriber 作为 Subscriber 被传给上游(Map)
       │
       ▼
  Map.receive(subscriber: FilterSubscriber)  →  创建 MapSubscriber,包装 FilterSubscriber
       │
       ▼
  MapSubscriber 作为 Subscriber 被传给上游(Just)
       │
       ▼
  Just.receive(subscriber: MapSubscriber)  →  创建 Subscription(如 SimpleSubscription)
       │
       ▼
  subscriber.receive(subscription:)  从 Just 一路向下传递到 Sink
       │
       ▼
  Sink 保存 subscription,并调用 subscription.request(.unlimited)  [或 .max(n)]

阶段二:请求与下发(上游 → 下游)

  Subscription.request(demand)  [由 Sink 发起]
       │
       ▼
  上游(如 Just)开始向 MapSubscriber 发送值:subscriber.receive(1)
       │
       ▼
  MapSubscriber.receive(1)  →  transform(1)  →  downstream.receive("1")
       │
       ▼
  FilterSubscriber.receive("1")  →  若通过,downstream.receive("1");否则 return .max(1)
       │
       ▼
  Sink.receive("1")  →  执行 sink 的 receiveValue 闭包;返回 .none 或新 Demand
       │
       ▼
  (可选)Demand 沿链返回,上游据此决定是否继续 send

阶段三:完成

  上游发送 subscriber.receive(completion: .finished) 或 .failure(e)
       │
       ▼
  沿链向下传递 completion,每一层收到后转发给 downstream
       │
       ▼
  Sink.receive(completion:)  →  执行 receiveCompletion 闭包;置空 subscription
       │
       ▼
  订阅结束,链上各层可释放资源

信息流总览图(时序):

  Subscriber (Sink)               中间层 (Map/Filter)              Publisher (Just)
        │                                  │                              │
        │  receive(subscriber:)            │                              │
        │ ◄─────────────────────────────────────────────────────────────┤
        │                                  │  receive(subscriber:)        │
        │                                  │ ◄────────────────────────────┤
        │                                  │                              │
        │  receive(subscription:)         │  receive(subscription:)      │  create
        │ ◄─────────────────────────────────────────────────────────────┤
        │                                  │                              │
        │  request(.unlimited)            │  request(...)                 │
        │ ─────────────────────────────────────────────────────────────► │
        │                                  │                              │
        │  receive(1)                      │  receive(1) → "1"            │  send 1
        │ ◄─────────────────────────────────────────────────────────────┤
        │  receive("1")  [若经 Map]        │                              │
        │ ◄─────────────────────────────────────────────────────────────┤
        │  receive(completion:)            │  receive(completion:)        │  send completion
        │ ◄─────────────────────────────────────────────────────────────┤
        │                                  │                              │

1.6 核心协议关系小结

角色 职责 在链中的位置
Publisher 提供 receive(subscriber:),被订阅时创建 Subscription 并下发给 Subscriber 链中每一环(含操作符)都是 Publisher
Subscription 响应 request(_ demand) 向上游要数据;实现 cancel() 结束订阅 通常由最上游(如 Just)创建,引用传给下游
Subscriber 接收 receive(subscription:)receive(_ input:)receive(completion:);通过返回值反馈 Demand 链中每一环的「下游」都是 Subscriber;终端是 Sink/Assign

理解上述内部架构、响应者链、信息流后,再看任意操作符的源码,都可以套用「新 Publisher 包装上游 + 新 Subscriber 包装下游,在 receive(_ input:) 里做变换再转发」这一模式。

Mermaid 数据流图(可选渲染):

sequenceDiagram
    participant S as Sink(Subscriber)
    participant F as Filter
    participant M as Map
    participant J as Just(Publisher)

    S->>F: receive(subscriber: S)
    F->>M: receive(subscriber: FilterSub)
    M->>J: receive(subscriber: MapSub)
    J->>M: receive(subscription)
    M->>F: receive(subscription)
    F->>S: receive(subscription)
    S->>S: subscription.request(.unlimited)
    S->>F: request 向上传递
    F->>M: request
    M->>J: request
    J->>M: receive(1)
    M->>F: receive("1")
    F->>S: receive("1")
    J->>M: receive(completion)
    M->>F: receive(completion)
    F->>S: receive(completion)

2. Publisher协议实现

2.1 Publisher协议定义

public protocol Publisher {
    /// 发布的值类型
    associatedtype Output
    
    /// 错误类型
    associatedtype Failure: Error
    
    /// 接收订阅者
    func receive<S>(subscriber: S) 
        where S: Subscriber, 
              S.Input == Output, 
              S.Failure == Failure
}

2.2 Just实现分析

public struct Just<Output>: Publisher {
    public typealias Failure = Never
    
    public let output: Output
    
    public init(_ output: Output) {
        self.output = output
    }
    
    public func receive<S>(subscriber: S) 
        where S: Subscriber, S.Input == Output, S.Failure == Never {
        // 创建订阅
        let subscription = Subscriptions.SimpleSubscription(
            subscriber: subscriber,
            output: output
        )
        subscriber.receive(subscription: subscription)
    }
}

关键点:

  • Just 是值类型(struct)
  • 立即发布值并完成
  • 错误类型是 Never(不会失败)

2.3 Future实现分析

public struct Future<Output, Failure: Error>: Publisher {
    public typealias Output = Output
    public typealias Failure = Failure
    
    private let promise: (@escaping (Result<Output, Failure>) -> Void) -> Void
    
    public init(_ attemptToFulfill: @escaping (@escaping (Result<Output, Failure>) -> Void) -> Void) {
        self.promise = attemptToFulfill
    }
    
    public func receive<S>(subscriber: S) 
        where S: Subscriber, S.Input == Output, S.Failure == Failure {
        let subscription = FutureSubscription(
            subscriber: subscriber,
            promise: promise
        )
        subscriber.receive(subscription: subscription)
    }
}

private final class FutureSubscription<Output, Failure: Error, S: Subscriber>: Subscription 
    where S.Input == Output, S.Failure == Failure {
    
    private var subscriber: S?
    private let promise: (@escaping (Result<Output, Failure>) -> Void) -> Void
    private var hasFulfilled = false
    
    init(subscriber: S, promise: @escaping (@escaping (Result<Output, Failure>) -> Void) -> Void) {
        self.subscriber = subscriber
        self.promise = promise
    }
    
    func request(_ demand: Subscribers.Demand) {
        guard !hasFulfilled else { return }
        hasFulfilled = true
        
        promise { [weak self] result in
            guard let self = self, let subscriber = self.subscriber else { return }
            
            switch result {
            case .success(let value):
                _ = subscriber.receive(value)
                subscriber.receive(completion: .finished)
            case .failure(let error):
                subscriber.receive(completion: .failure(error))
            }
            
            self.subscriber = nil
        }
    }
    
    func cancel() {
        subscriber = nil
    }
}

关键点:

  • Future 是值类型,但内部使用引用类型 FutureSubscription
  • 只执行一次 promise
  • 使用 hasFulfilled 防止重复执行

3. Subscriber协议实现

3.1 Subscriber协议定义

public protocol Subscriber: CustomCombineIdentifierConvertible {
    associatedtype Input
    associatedtype Failure: Error
    
    func receive(subscription: Subscription)
    func receive(_ input: Input) -> Subscribers.Demand
    func receive(completion: Subscribers.Completion<Failure>)
}

3.2 Sink实现分析

public struct Sink<Input, Failure: Error>: Subscriber, Cancellable {
    public typealias Input = Input
    public typealias Failure = Failure
    
    private let receiveValue: (Input) -> Void
    private let receiveCompletion: (Subscribers.Completion<Failure>) -> Void
    private var subscription: Subscription?
    
    public init(
        receiveCompletion: @escaping (Subscribers.Completion<Failure>) -> Void,
        receiveValue: @escaping (Input) -> Void
    ) {
        self.receiveCompletion = receiveCompletion
        self.receiveValue = receiveValue
    }
    
    public func receive(subscription: Subscription) {
        self.subscription = subscription
        subscription.request(.unlimited)  // 请求无限值
    }
    
    public func receive(_ input: Input) -> Subscribers.Demand {
        receiveValue(input)
        return .none  // 不再请求更多值(因为已经请求了 .unlimited)
    }
    
    public func receive(completion: Subscribers.Completion<Failure>) {
        receiveCompletion(completion)
        subscription = nil
    }
    
    public func cancel() {
        subscription?.cancel()
        subscription = nil
    }
}

关键点:

  • Sink 是值类型,但内部持有 Subscription 引用
  • 默认请求 .unlimited
  • 完成或取消时清理 subscription

3.3 Assign实现分析

public struct Assign<Root, Input>: Subscriber, Cancellable {
    public typealias Input = Input
    public typealias Failure = Never
    
    public let object: Root
    public let keyPath: ReferenceWritableKeyPath<Root, Input>
    private var subscription: Subscription?
    
    public init(object: Root, keyPath: ReferenceWritableKeyPath<Root, Input>) {
        self.object = object
        self.keyPath = keyPath
    }
    
    public func receive(subscription: Subscription) {
        self.subscription = subscription
        subscription.request(.unlimited)
    }
    
    public func receive(_ input: Input) -> Subscribers.Demand {
        object[keyPath: keyPath] = input
        return .none
    }
    
    public func receive(completion: Subscribers.Completion<Never>) {
        subscription = nil
    }
    
    public func cancel() {
        subscription?.cancel()
        subscription = nil
    }
}

关键点:

  • 使用 ReferenceWritableKeyPath 修改对象属性
  • 错误类型是 Never(不会失败)

4. Operators实现原理

4.1 Map操作符实现

extension Publisher {
    public func map<T>(_ transform: @escaping (Output) -> T) -> Publishers.Map<Self, T> {
        return Publishers.Map(upstream: self, transform: transform)
    }
}

extension Publishers {
    public struct Map<Upstream: Publisher, Output>: Publisher {
        public typealias Failure = Upstream.Failure
        
        public let upstream: Upstream
        public let transform: (Upstream.Output) -> Output
        
        public init(upstream: Upstream, transform: @escaping (Upstream.Output) -> Output) {
            self.upstream = upstream
            self.transform = transform
        }
        
        public func receive<S>(subscriber: S) 
            where S: Subscriber, S.Input == Output, S.Failure == Failure {
            let mapSubscriber = MapSubscriber(
                downstream: subscriber,
                transform: transform
            )
            upstream.receive(subscriber: mapSubscriber)
        }
    }
    
    private struct MapSubscriber<Upstream: Publisher, Downstream: Subscriber>: Subscriber {
        typealias Input = Upstream.Output
        typealias Failure = Upstream.Failure
        
        let downstream: Downstream
        let transform: (Upstream.Output) -> Downstream.Input
        
        func receive(subscription: Subscription) {
            downstream.receive(subscription: subscription)
        }
        
        func receive(_ input: Upstream.Output) -> Subscribers.Demand {
            let transformed = transform(input)
            return downstream.receive(transformed)
        }
        
        func receive(completion: Subscribers.Completion<Failure>) {
            downstream.receive(completion: completion)
        }
    }
}

关键点:

  • Map 是新的 Publisher,包装上游 Publisher
  • 创建中间 Subscriber 进行转换
  • 保持错误类型不变

4.2 Filter操作符实现

extension Publisher {
    public func filter(_ predicate: @escaping (Output) -> Bool) -> Publishers.Filter<Self> {
        return Publishers.Filter(upstream: self, predicate: predicate)
    }
}

extension Publishers {
    public struct Filter<Upstream: Publisher>: Publisher {
        public typealias Output = Upstream.Output
        public typealias Failure = Upstream.Failure
        
        public let upstream: Upstream
        public let predicate: (Output) -> Bool
        
        public init(upstream: Upstream, predicate: @escaping (Output) -> Bool) {
            self.upstream = upstream
            self.predicate = predicate
        }
        
        public func receive<S>(subscriber: S) 
            where S: Subscriber, S.Input == Output, S.Failure == Failure {
            let filterSubscriber = FilterSubscriber(
                downstream: subscriber,
                predicate: predicate
            )
            upstream.receive(subscriber: filterSubscriber)
        }
    }
    
    private struct FilterSubscriber<Upstream: Publisher, Downstream: Subscriber>: Subscriber {
        typealias Input = Upstream.Output
        typealias Failure = Upstream.Failure
        
        let downstream: Downstream
        let predicate: (Input) -> Bool
        
        func receive(subscription: Subscription) {
            downstream.receive(subscription: subscription)
        }
        
        func receive(_ input: Input) -> Subscribers.Demand {
            if predicate(input) {
                return downstream.receive(input)
            } else {
                return .max(1)  // 请求下一个值
            }
        }
        
        func receive(completion: Subscribers.Completion<Failure>) {
            downstream.receive(completion: completion)
        }
    }
}

关键点:

  • 不满足条件时返回 .max(1) 继续请求
  • 满足条件时才传递给下游

4.3 FlatMap操作符实现

extension Publisher {
    public func flatMap<T, P: Publisher>(
        maxPublishers: Subscribers.Demand = .unlimited,
        _ transform: @escaping (Output) -> P
    ) -> Publishers.FlatMap<P, Self> 
        where P.Failure == Failure {
        return Publishers.FlatMap(
            upstream: self,
            maxPublishers: maxPublishers,
            transform: transform
        )
    }
}

extension Publishers {
    public struct FlatMap<NewPublisher: Publisher, Upstream: Publisher>: Publisher 
        where NewPublisher.Failure == Upstream.Failure {
        
        public typealias Output = NewPublisher.Output
        public typealias Failure = Upstream.Failure
        
        public let upstream: Upstream
        public let maxPublishers: Subscribers.Demand
        public let transform: (Upstream.Output) -> NewPublisher
        
        public init(
            upstream: Upstream,
            maxPublishers: Subscribers.Demand,
            transform: @escaping (Upstream.Output) -> NewPublisher
        ) {
            self.upstream = upstream
            self.maxPublishers = maxPublishers
            self.transform = transform
        }
        
        public func receive<S>(subscriber: S) 
            where S: Subscriber, S.Input == Output, S.Failure == Failure {
            let flatMapSubscriber = FlatMapSubscriber(
                downstream: subscriber,
                maxPublishers: maxPublishers,
                transform: transform
            )
            upstream.receive(subscriber: flatMapSubscriber)
        }
    }
    
    private final class FlatMapSubscriber<Upstream: Publisher, NewPublisher: Publisher, Downstream: Subscriber>: Subscriber {
        typealias Input = Upstream.Output
        typealias Failure = Upstream.Failure
        
        private let downstream: Downstream
        private let maxPublishers: Subscribers.Demand
        private let transform: (Input) -> NewPublisher
        private var activeSubscriptions: [AnyCancellable] = []
        private var subscription: Subscription?
        private var demand: Subscribers.Demand = .none
        
        init(
            downstream: Downstream,
            maxPublishers: Subscribers.Demand,
            transform: @escaping (Input) -> NewPublisher
        ) {
            self.downstream = downstream
            self.maxPublishers = maxPublishers
            self.transform = transform
        }
        
        func receive(subscription: Subscription) {
            self.subscription = subscription
            downstream.receive(subscription: InnerSubscription(parent: self))
        }
        
        func receive(_ input: Input) -> Subscribers.Demand {
            let newPublisher = transform(input)
            let cancellable = newPublisher.sink(
                receiveCompletion: { [weak self] completion in
                    self?.handleCompletion(completion)
                },
                receiveValue: { [weak self] value in
                    _ = self?.downstream.receive(value)
                }
            )
            activeSubscriptions.append(cancellable)
            return .none
        }
        
        func receive(completion: Subscribers.Completion<Failure>) {
            // 处理完成
        }
        
        private func handleCompletion(_ completion: Subscribers.Completion<Failure>) {
            // 处理内部 Publisher 完成
        }
    }
}

关键点:

  • 管理多个内部 Publisher 订阅
  • 使用 maxPublishers 限制并发数
  • 需要复杂的生命周期管理

5. Subjects实现原理

5.1 PassthroughSubject实现

public final class PassthroughSubject<Output, Failure: Error>: Subject {
    private var subscribers: [AnySubscriber<Output, Failure>] = []
    private let lock = NSRecursiveLock()
    
    public func send(_ value: Output) {
        lock.lock()
        defer { lock.unlock() }
        
        let currentSubscribers = subscribers
        for subscriber in currentSubscribers {
            _ = subscriber.receive(value)
        }
    }
    
    public func send(completion: Subscribers.Completion<Failure>) {
        lock.lock()
        defer { lock.unlock() }
        
        let currentSubscribers = subscribers
        subscribers.removeAll()
        
        for subscriber in currentSubscribers {
            subscriber.receive(completion: completion)
        }
    }
    
    public func send(subscription: Subscription) {
        // 实现 Subject 协议
    }
    
    public func receive<S>(subscriber: S) 
        where S: Subscriber, S.Input == Output, S.Failure == Failure {
        lock.lock()
        defer { lock.unlock() }
        
        let anySubscriber = AnySubscriber(subscriber)
        subscribers.append(anySubscriber)
        
        subscriber.receive(subscription: PassthroughSubscription(
            subject: self,
            subscriber: anySubscriber
        ))
    }
    
    private func removeSubscriber(_ subscriber: AnySubscriber<Output, Failure>) {
        lock.lock()
        defer { lock.unlock() }
        
        subscribers.removeAll { $0 === subscriber }
    }
}

private final class PassthroughSubscription<Output, Failure: Error>: Subscription {
    weak var subject: PassthroughSubject<Output, Failure>?
    let subscriber: AnySubscriber<Output, Failure>
    var demand: Subscribers.Demand = .none
    
    init(
        subject: PassthroughSubject<Output, Failure>,
        subscriber: AnySubscriber<Output, Failure>
    ) {
        self.subject = subject
        self.subscriber = subscriber
    }
    
    func request(_ demand: Subscribers.Demand) {
        self.demand += demand
    }
    
    func cancel() {
        subject?.removeSubscriber(subscriber)
        subject = nil
    }
}

关键点:

  • 使用锁保护 subscribers 数组
  • 不保存当前值,新订阅者不会收到历史值
  • 使用 weak 引用避免循环引用

5.2 CurrentValueSubject实现

public final class CurrentValueSubject<Output, Failure: Error>: Subject {
    private var subscribers: [AnySubscriber<Output, Failure>] = []
    private let lock = NSRecursiveLock()
    private var _value: Output
    
    public var value: Output {
        get {
            lock.lock()
            defer { lock.unlock() }
            return _value
        }
        set {
            send(newValue)
        }
    }
    
    public init(_ value: Output) {
        self._value = value
    }
    
    public func send(_ value: Output) {
        lock.lock()
        defer { lock.unlock() }
        
        _value = value
        let currentSubscribers = subscribers
        for subscriber in currentSubscribers {
            _ = subscriber.receive(value)
        }
    }
    
    public func receive<S>(subscriber: S) 
        where S: Subscriber, S.Input == Output, S.Failure == Failure {
        lock.lock()
        defer { lock.unlock() }
        
        let anySubscriber = AnySubscriber(subscriber)
        subscribers.append(anySubscriber)
        
        subscriber.receive(subscription: CurrentValueSubscription(
            subject: self,
            subscriber: anySubscriber
        ))
        
        // 立即发送当前值
        _ = subscriber.receive(_value)
    }
}

关键点:

  • 保存当前值 _value
  • 新订阅者立即收到当前值
  • 使用锁保护状态

6. Schedulers实现原理

6.1 Scheduler协议

public protocol Scheduler {
    associatedtype SchedulerTimeType: Strideable where SchedulerTimeType.Stride: SchedulerTimeIntervalConvertible
    associatedtype SchedulerOptions
    
    var now: SchedulerTimeType { get }
    var minimumTolerance: SchedulerTimeType.Stride { get }
    
    func schedule(options: SchedulerOptions?, _ action: @escaping () -> Void)
    func schedule(
        after date: SchedulerTimeType,
        tolerance: SchedulerTimeType.Stride,
        options: SchedulerOptions?,
        _ action: @escaping () -> Void
    )
    func schedule(
        after date: SchedulerTimeType,
        interval: SchedulerTimeType.Stride,
        tolerance: SchedulerTimeType.Stride,
        options: SchedulerOptions?,
        _ action: @escaping () -> Void
    ) -> Cancellable
}

6.2 DispatchQueue Scheduler实现

extension DispatchQueue: Scheduler {
    public struct SchedulerOptions {
        public var qos: DispatchQoS
        public var flags: DispatchWorkItemFlags
        public var group: DispatchGroup?
    }
    
    public struct SchedulerTimeType: Strideable {
        public let dispatchTime: DispatchTime
        
        public func distance(to other: SchedulerTimeType) -> Stride {
            return Stride(dispatchTime.uptimeNanoseconds - other.dispatchTime.uptimeNanoseconds)
        }
        
        public func advanced(by n: Stride) -> SchedulerTimeType {
            return SchedulerTimeType(
                dispatchTime: DispatchTime(uptimeNanoseconds: dispatchTime.uptimeNanoseconds + n.magnitude)
            )
        }
    }
    
    public var now: SchedulerTimeType {
        return SchedulerTimeType(dispatchTime: .now())
    }
    
    public var minimumTolerance: SchedulerTimeType.Stride {
        return SchedulerTimeType.Stride(0)
    }
    
    public func schedule(options: SchedulerOptions?, _ action: @escaping () -> Void) {
        if let options = options {
            async(group: options.group, qos: options.qos, flags: options.flags, execute: action)
        } else {
            async(execute: action)
        }
    }
    
    public func schedule(
        after date: SchedulerTimeType,
        tolerance: SchedulerTimeType.Stride,
        options: SchedulerOptions?,
        _ action: @escaping () -> Void
    ) {
        let deadline = date.dispatchTime
        if let options = options {
            asyncAfter(deadline: deadline, qos: options.qos, flags: options.flags, execute: action)
        } else {
            asyncAfter(deadline: deadline, execute: action)
        }
    }
}

关键点:

  • DispatchQueue 适配为 Scheduler
  • 使用 DispatchTime 作为时间类型
  • 支持 QoS 和 DispatchGroup

7. 背压处理机制

7.1 Demand系统

extension Subscribers {
    public struct Demand: Equatable, Hashable {
        public static let unlimited: Demand
        public static let max: (Int) -> Demand
        public static let none: Demand
        
        public static func + (lhs: Demand, rhs: Demand) -> Demand
        public static func - (lhs: Demand, rhs: Demand) -> Demand
        public static func += (lhs: inout Demand, rhs: Demand)
        public static func -= (lhs: inout Demand, rhs: Demand)
    }
}

Demand 的作用:

  • 控制 Publisher 发送值的速度
  • 实现背压(backpressure)
  • 防止内存溢出

7.2 背压处理示例

class BackpressureSubscriber: Subscriber {
    typealias Input = Int
    typealias Failure = Never
    
    private var subscription: Subscription?
    private let bufferSize: Int
    private var buffer: [Int] = []
    
    init(bufferSize: Int = 10) {
        self.bufferSize = bufferSize
    }
    
    func receive(subscription: Subscription) {
        self.subscription = subscription
        // 初始请求 bufferSize 个值
        subscription.request(.max(bufferSize))
    }
    
    func receive(_ input: Int) -> Subscribers.Demand {
        buffer.append(input)
        
        // 处理缓冲区
        processBuffer()
        
        // 如果缓冲区未满,请求更多值
        if buffer.count < bufferSize {
            return .max(1)
        } else {
            return .none  // 暂停请求
        }
    }
    
    func receive(completion: Subscribers.Completion<Never>) {
        // 处理完成
    }
    
    private func processBuffer() {
        // 处理缓冲区中的数据
        while !buffer.isEmpty {
            let value = buffer.removeFirst()
            print("处理: \(value)")
        }
        
        // 处理完后请求更多值
        subscription?.request(.max(bufferSize - buffer.count))
    }
}

8. 性能优化策略

8.1 值类型优化

Combine 大量使用值类型(struct),避免堆分配:

// 值类型,零成本抽象
struct Just<Output>: Publisher { }
struct Map<Upstream, Output>: Publisher { }
struct Filter<Upstream>: Publisher { }

8.2 类型擦除(eraseToAnyPublisher)

eraseToAnyPublisher() 是 Combine 中非常重要的方法,用于隐藏 Publisher 的具体类型,只暴露 OutputFailure 类型信息。这在需要统一返回类型、简化接口、避免类型泄露等场景中非常有用。

8.2.1 为什么需要类型擦除

问题:类型泄露(Type Leakage)

Combine 的操作符链式调用会产生复杂的嵌套类型,这些类型信息会"泄露"到函数签名中:

// ❌ 问题:类型过于复杂,难以维护
func fetchUserData() -> Publishers.Map<
    Publishers.FlatMap<
        Publishers.Catch<
            Publishers.Map<
                URLSession.DataTaskPublisher,
                User
            >,
            Just<User>
        >,
        Publishers.Map<
            Publishers.Debounce<
                PassthroughSubject<String, Never>,
                RunLoop
            >,
            URLSession.DataTaskPublisher
        >
    >,
    String
> {
    // 实现...
}

// ✅ 解决:使用 eraseToAnyPublisher() 简化类型
func fetchUserData() -> AnyPublisher<String, Never> {
    // 实现...
    return publisher.eraseToAnyPublisher()
}

类型擦除的优势:

  1. 简化接口:隐藏内部实现细节,只暴露必要的类型信息(Output 和 Failure)
  2. 统一返回类型:不同分支可以返回不同的具体 Publisher,但统一为 AnyPublisher
  3. 避免类型泄露:防止复杂的嵌套类型污染 API
  4. 提高可维护性:修改内部实现不影响外部接口
8.2.2 eraseToAnyPublisher 的基本用法

基本语法:

extension Publisher {
    /// 将 Publisher 转换为 AnyPublisher,隐藏具体类型
    public func eraseToAnyPublisher() -> AnyPublisher<Output, Failure> {
        return AnyPublisher(self)
    }
}

使用示例:

// 示例1:函数返回类型简化
func loadData() -> AnyPublisher<String, Error> {
    return URLSession.shared.dataTaskPublisher(for: url)
        .map(\.data)
        .compactMap { String(data: $0, encoding: .utf8) }
        .mapError { $0 as Error }
        .eraseToAnyPublisher()  // 隐藏 URLSession.DataTaskPublisher 等具体类型
}

// 示例2:条件分支统一返回类型
func fetchData(useCache: Bool) -> AnyPublisher<Data, Error> {
    if useCache {
        return loadFromCache()
            .eraseToAnyPublisher()  // Just<Data, Error> -> AnyPublisher
    } else {
        return loadFromNetwork()
            .eraseToAnyPublisher()  // URLSession.DataTaskPublisher -> AnyPublisher
    }
}

func loadFromCache() -> Just<Data> {
    return Just(Data())
}

func loadFromNetwork() -> URLSession.DataTaskPublisher {
    return URLSession.shared.dataTaskPublisher(for: url)
}
8.2.3 AnyPublisher 的内部实现

AnyPublisher 使用类型擦除模式(Type Erasure Pattern),通过包装具体 Publisher 来隐藏类型信息:

public struct AnyPublisher<Output, Failure: Error>: Publisher {
    // 使用内部 Box 类型来存储具体的 Publisher
    private let box: _AnyPublisherBox<Output, Failure>
    
    /// 初始化:接受任何符合 Publisher 协议的类型
    public init<P: Publisher>(_ publisher: P) 
        where P.Output == Output, P.Failure == Failure {
        // 将具体 Publisher 包装到 Box 中
        self.box = _AnyPublisherBox(publisher)
    }
    
    /// 实现 Publisher 协议:转发给内部 Box
    public func receive<S>(subscriber: S) 
        where S: Subscriber, S.Input == Output, S.Failure == Failure {
        box.receive(subscriber: subscriber)
    }
}

// 内部 Box 类(简化版实现)
private class _AnyPublisherBox<Output, Failure: Error> {
    private let _receive: (AnySubscriber<Output, Failure>) -> Void
    
    init<P: Publisher>(_ publisher: P) 
        where P.Output == Output, P.Failure == Failure {
        // 保存 publisher 的 receive 方法
        self._receive = { subscriber in
            publisher.receive(subscriber: subscriber)
        }
    }
    
    func receive<S: Subscriber>(_ subscriber: S) 
        where S.Input == Output, S.Failure == Failure {
        let anySubscriber = AnySubscriber(subscriber)
        _receive(anySubscriber)
    }
}

实现原理:

  • AnyPublisher 是值类型(struct),但内部持有引用类型的 Box
  • Box 存储具体 Publisher 的 receive 方法
  • 通过闭包捕获和转发,实现类型擦除
8.2.4 常见使用场景

场景1:函数返回类型统一

class DataService {
    // 不同方法返回不同的具体 Publisher,但统一为 AnyPublisher
    func fetchUser() -> AnyPublisher<User, Error> {
        return URLSession.shared.dataTaskPublisher(for: userURL)
            .map(\.data)
            .decode(type: User.self, decoder: JSONDecoder())
            .eraseToAnyPublisher()
    }
    
    func fetchPosts() -> AnyPublisher<[Post], Error> {
        return URLSession.shared.dataTaskPublisher(for: postsURL)
            .map(\.data)
            .decode(type: [Post].self, decoder: JSONDecoder())
            .eraseToAnyPublisher()
    }
    
    func fetchComments() -> AnyPublisher<[Comment], Never> {
        return Just([])  // 示例:返回 Just
            .eraseToAnyPublisher()
    }
}

场景2:条件分支统一类型

func loadData(source: DataSource) -> AnyPublisher<Data, Error> {
    switch source {
    case .network:
        return URLSession.shared.dataTaskPublisher(for: url)
            .map(\.data)
            .eraseToAnyPublisher()
            
    case .cache:
        return loadFromCache()
            .setFailureType(to: Error.self)
            .eraseToAnyPublisher()
            
    case .mock:
        return Just(mockData)
            .setFailureType(to: Error.self)
            .eraseToAnyPublisher()
    }
}

enum DataSource {
    case network
    case cache
    case mock
}

场景3:操作符链中的类型擦除

class SearchViewModel: ObservableObject {
    @Published var searchText: String = ""
    
    var searchResults: AnyPublisher<[String], Never> {
        $searchText
            .debounce(for: .milliseconds(500), scheduler: RunLoop.main)
            .removeDuplicates()
            .flatMap { query -> AnyPublisher<[String], Never> in
                if query.isEmpty {
                    return Just([])
                        .eraseToAnyPublisher()
                } else {
                    return self.performSearch(query: query)
                        .catch { _ in Just([]) }
                        .eraseToAnyPublisher()
                }
            }
            .eraseToAnyPublisher()  // 最终统一类型
    }
    
    private func performSearch(query: String) -> AnyPublisher<[String], Error> {
        // 搜索实现
        return URLSession.shared.dataTaskPublisher(for: searchURL)
            .map(\.data)
            .decode(type: [String].self, decoder: JSONDecoder())
            .eraseToAnyPublisher()
    }
}

场景4:协议中的类型擦除

protocol DataRepository {
    func fetchData() -> AnyPublisher<Data, Error>
}

class NetworkRepository: DataRepository {
    func fetchData() -> AnyPublisher<Data, Error> {
        return URLSession.shared.dataTaskPublisher(for: url)
            .map(\.data)
            .eraseToAnyPublisher()
    }
}

class MockRepository: DataRepository {
    func fetchData() -> AnyPublisher<Data, Error> {
        return Just(mockData)
            .setFailureType(to: Error.self)
            .eraseToAnyPublisher()
    }
}
8.2.5 何时使用 eraseToAnyPublisher

应该使用的情况:

  1. 函数返回类型:公开 API 需要返回 Publisher 时
  2. 协议要求:协议方法需要返回 Publisher 时
  3. 条件分支:不同分支返回不同类型,需要统一时
  4. 存储属性:需要存储 Publisher 但不想暴露具体类型时
  5. 简化接口:避免类型泄露到外部时

不应该使用的情况:

  1. 内部实现:只在内部使用的 Publisher,不需要擦除
  2. 性能敏感:类型擦除有轻微性能开销(包装和转发)
  3. 需要具体类型:需要访问具体 Publisher 的特殊方法时

示例对比:

// ✅ 正确:公开 API 使用类型擦除
class API {
    static func fetchUser(id: Int) -> AnyPublisher<User, Error> {
        return URLSession.shared.dataTaskPublisher(for: url)
            .map(\.data)
            .decode(type: User.self, decoder: JSONDecoder())
            .eraseToAnyPublisher()
    }
}

// ❌ 不必要:内部实现不需要类型擦除
class ViewModel {
    private func setupBinding() {
        // 不需要 eraseToAnyPublisher,因为只在内部使用
        $searchText
            .debounce(for: .milliseconds(500), scheduler: RunLoop.main)
            .sink { [weak self] text in
                self?.performSearch(text)
            }
            .store(in: &cancellables)
    }
}
8.2.6 类型擦除的性能考虑

性能开销:

  1. 内存开销AnyPublisher 需要额外的 Box 包装,增加一个间接层
  2. 调用开销:方法调用需要通过 Box 转发,有轻微的性能损失
  3. 优化机会:编译器无法对擦除后的类型进行特殊优化

性能对比:

// 直接使用具体类型(性能更好)
let publisher: Publishers.Map<URLSession.DataTaskPublisher, Data> = ...

// 使用类型擦除(有轻微开销)
let publisher: AnyPublisher<Data, Error> = ...
    .eraseToAnyPublisher()

建议:

  • 在公开 API 中使用类型擦除,简化接口
  • 在内部实现中尽量保持具体类型,获得更好的性能
  • 性能敏感的场景谨慎使用
8.2.7 与其他类型擦除方法对比

Combine 提供了多种类型擦除方法:

方法 用途 示例
eraseToAnyPublisher() 擦除 Publisher 类型 publisher.eraseToAnyPublisher()
AnySubscriber 擦除 Subscriber 类型 AnySubscriber(subscriber)
AnyCancellable 擦除 Cancellable 类型 AnyCancellable(cancellable)

统一使用模式:

// Publisher 类型擦除
let anyPublisher: AnyPublisher<String, Error> = publisher
    .eraseToAnyPublisher()

// Subscriber 类型擦除(内部使用)
let anySubscriber = AnySubscriber(subscriber)

// Cancellable 类型擦除(存储订阅)
let cancellable = AnyCancellable(subscription)
8.2.8 常见错误与注意事项

错误1:忘记类型擦除导致编译错误

// ❌ 错误:类型不匹配
func fetchData() -> AnyPublisher<Data, Error> {
    if condition {
        return Just(data)  // 类型是 Just<Data, Never>,不匹配
    } else {
        return URLSession.shared.dataTaskPublisher(for: url)
            .map(\.data)  // 类型是 Publishers.Map<...>,不匹配
    }
}

// ✅ 正确:使用 eraseToAnyPublisher 统一类型
func fetchData() -> AnyPublisher<Data, Error> {
    if condition {
        return Just(data)
            .setFailureType(to: Error.self)
            .eraseToAnyPublisher()
    } else {
        return URLSession.shared.dataTaskPublisher(for: url)
            .map(\.data)
            .eraseToAnyPublisher()
    }
}

错误2:过度使用类型擦除

// ❌ 不必要:每个操作符都擦除
let publisher = [1, 2, 3].publisher
    .map { $0 * 2 }
    .eraseToAnyPublisher()  // 不必要
    .filter { $0 > 2 }
    .eraseToAnyPublisher()  // 不必要
    .sink { print($0) }

// ✅ 正确:只在最后需要时擦除
let publisher = [1, 2, 3].publisher
    .map { $0 * 2 }
    .filter { $0 > 2 }
    .eraseToAnyPublisher()  // 只在需要统一类型时使用

错误3:类型擦除后无法访问具体方法

// ❌ 错误:AnyPublisher 没有具体 Publisher 的特殊方法
let publisher: AnyPublisher<String, Error> = ...
publisher.someSpecificMethod()  // 编译错误:AnyPublisher 没有此方法

// ✅ 正确:在擦除前使用具体方法
let publisher = specificPublisher
    .someSpecificMethod()  // 先使用具体方法
    .eraseToAnyPublisher()  // 再擦除类型
8.2.9 最佳实践总结
  1. 公开 API 使用类型擦除:简化接口,隐藏实现细节
  2. 内部实现保持具体类型:获得更好的性能和类型信息
  3. 条件分支统一类型:使用 eraseToAnyPublisher() 统一返回类型
  4. 避免过度使用:只在必要时使用,不要每个操作符都擦除
  5. 注意性能影响:性能敏感场景谨慎使用

代码示例:

// 最佳实践示例
class DataManager {
    // ✅ 公开方法:使用类型擦除
    func fetchData() -> AnyPublisher<Data, Error> {
        return internalFetchData()
            .eraseToAnyPublisher()
    }
    
    // ✅ 内部方法:保持具体类型
    private func internalFetchData() -> URLSession.DataTaskPublisher {
        return URLSession.shared.dataTaskPublisher(for: url)
    }
    
    // ✅ 条件分支:统一返回类型
    func loadData(from source: DataSource) -> AnyPublisher<Data, Error> {
        switch source {
        case .network:
            return networkFetch()
                .eraseToAnyPublisher()
        case .cache:
            return cacheFetch()
                .eraseToAnyPublisher()
        }
    }
}

通过 eraseToAnyPublisher(),我们可以在保持类型安全的同时,简化 API 接口,提高代码的可维护性和可读性。

8.3 延迟执行

使用 Deferred 延迟创建 Publisher:

let deferred = Deferred {
    // 只在订阅时执行
    return expensiveOperation()
}

8.4 共享订阅

使用 share() 共享 Publisher:

let shared = expensivePublisher()
    .share()  // 多个订阅者共享同一个 Publisher

shared.sink { }  // 订阅1
shared.sink { }  // 订阅2(共享执行)

📚 总结

Combine 框架的核心优势

  1. 类型安全:充分利用 Swift 类型系统
  2. 性能优化:值类型、零成本抽象
  3. 声明式编程:代码更简洁、易读
  4. 异步处理:优雅处理异步操作
  5. 系统集成:与 SwiftUI、Foundation 深度集成

学习建议

  1. 从基础开始:理解 Publisher、Subscriber、Subscription
  2. 实践操作符:熟悉常用操作符的使用
  3. 理解背压:掌握 Demand 系统
  4. 阅读源码:深入理解实现原理
  5. 实际应用:在项目中应用 Combine

01-研究优秀开源框架@响应式编程@iOS | Combine框架:使用介绍

📋 目录


一、Combine框架使用详解

1. Combine框架概述

Combine 是 Apple 在 WWDC 2019 推出的响应式编程框架,用于处理异步事件流。它基于 ReactiveX 的设计思想,提供了声明式的 API 来处理时间序列数据。

1.1 什么是Combine

Combine 是一个声明式的 Swift 框架,用于处理随时间变化的值。它允许你通过组合(combine)不同的操作符来创建复杂的数据处理管道。

核心特点:

  • 声明式编程:描述"做什么"而不是"怎么做"
  • 函数式编程:使用高阶函数和操作符组合
  • 类型安全:充分利用 Swift 的类型系统
  • 异步处理:优雅地处理异步操作
  • 错误处理:统一的错误处理机制

1.2 Combine vs 其他框架

特性 Combine RxSwift ReactiveSwift
平台 Apple 生态(iOS 13+) 跨平台 跨平台
语言 Swift Swift Swift
官方支持 ✅ Apple 官方 ❌ 第三方 ❌ 第三方
性能 高度优化 良好 良好
学习曲线 中等 陡峭 陡峭
与系统集成 深度集成 需要适配 需要适配

1.3 适用场景

  • 网络请求:处理 API 响应
  • 用户输入:处理文本输入、按钮点击
  • 数据绑定:UI 与数据模型的双向绑定
  • 状态管理:管理应用状态变化
  • 事件处理:处理通知、定时器等事件

1.4 编程思想(背后的范式与理念)

Combine 的 API 和设计深受几种编程思想影响,理解这些思想能更快抓住「为什么这样写」而不是「怎么背 API」。

(1)响应式编程(Reactive Programming)

  • 核心:把「数据与事件」抽象成随时间推进的流,通过订阅对流中的每个值做出反应,而不是轮询或回调嵌套。
  • 在 Combine 中Publisher 就是一条流,Subscriber 订阅后对每个 receive(_ input:) 做出反应;用户输入、网络结果、定时器都可以统一成同一种「流」,用同一套操作符处理。
  • 与命令式的对比:命令式是「先做 A,再做 B,再根据结果做 C」;响应式是「当流里出现满足某条件的数据时,做 C」,逻辑由数据驱动。

(2)声明式 vs 命令式

维度 命令式(Imperative) 声明式(Declarative)
关注点 「怎么做」:一步步写清执行顺序与分支 「做什么」:描述期望的结果与约束
典型写法 循环、if-else、回调里再调回调 链式操作符:map / filter / combineLatest
在 Combine 中 手写「请求 → 等回调 → 解析 → 再请求」 publisher.map(...).flatMap(...).sink(...) 描述数据如何变换与消费

声明式让「数据流」一目了然,可读性和可测试性更好;Combine 的链式调用就是声明式的一种体现。

(3)函数式思想(Composition & Immutability)

  • 组合(Composition):小能力组合成大能力。每个操作符只做一件事(map 只做变换、filter 只做过滤),通过 .map(...).filter(...) 组合成完整管道,而不是写一个巨大的闭包。
  • 不可变(Immutability):操作符不修改上游 Publisher,而是返回新的 Publisher;上游保持不变,便于推理和复用。
  • 纯函数倾向:变换用无副作用的闭包(给定相同输入得到相同输出),副作用集中在 sinkassign 等「终端」处,便于测试和并发。

(4)流与时间序列(Streams & Time)

  • 把一切可观测的「变化」都看成时间上的序列:第 1 个值、第 2 个值、……、完成或错误。
  • 操作符可以针对「时间」语义:debounce(等一段时间再发)、throttle(间隔内只发一次)、delay(延后发射),从而统一处理「何时」而不只是「何值」。

(5)观察者与发布-订阅(Observer & Pub-Sub)

  • 观察者模式:观察者订阅被观察对象,在状态变化时得到通知。Combine 里 Subscriber 观察 Publisher。
  • 发布-订阅:发布者与订阅者解耦,通过「订阅」建立连接;Combine 用 Subscription 表示这次连接,用 request(Demand) 控制拉取节奏,是带背压的发布-订阅。

把以上几点串起来:Combine 用声明式(Publisher)和组合式操作符,在发布-订阅模型下做响应式的数据与事件处理,并借 Scheduler 控制时间与线程。理解这些思想后,再看到「为什么用 map 而不是在 sink 里写一坨」「为什么要 subscribe(on:) / receive(on:)」就会更自然。

1.5 原理概览(为何这样设计)

Combine 的核心理念可以概括为以下几点,便于后续理解「架构」与「信息流」:

理念 说明
发布-订阅 Publisher 不主动推数据,只有 Subscriber 通过 Subscription.request(demand) 请求后,才按需发送;这样下游可以控制节奏,避免被上游淹没。
背压(Backpressure) Subscriber.receive(_ input:) 的返回值类型是 Subscribers.Demand,表示「还能再要多少」;上游根据 Demand 决定是否继续发送,实现流控。
链式不可变 每个操作符(map、filter 等)都返回新的 Publisher,不修改原 Publisher;整条链是值类型组合,易于推理和测试。
调度与线程 谁在哪个线程执行由 Scheduler 决定;subscribe(on:) 指定「上游与订阅建立」所在线程,receive(on:) 指定「下游收值」所在线程,便于 UI 与后台分离。

后续「二、源码解析」中的内部架构、响应者链、信息流会与上述四点一一对应。


2. 核心概念

2.1 Publisher(发布者)

Publisher 是 Combine 的核心协议,表示可以发布值的类型。

protocol Publisher {
    associatedtype Output
    associatedtype Failure: Error
    
    func receive<S>(subscriber: S) where S: Subscriber, 
        S.Input == Output, S.Failure == Failure
}

特点:

  • 可以发布零个或多个值
  • 可能以完成或错误结束
  • 是值类型(struct)
  • 不可变(每次操作返回新的 Publisher)

示例:

// 创建一个简单的 Publisher:Just 发布单个值后立即完成
let publisher = Just("Hello, Combine!")
    .sink { value in
        print(value)  // 输出: Hello, Combine!
    }

// 使用 Sequence 的 publisher 扩展,将数组转为发布者,按序发布每个元素
let arrayPublisher = [1, 2, 3, 4, 5].publisher
    .sink { value in
        print(value)  // 依次输出: 1, 2, 3, 4, 5
    }

2.2 Subscriber(订阅者)

Subscriber 是接收 Publisher 发布值的协议。

protocol Subscriber: CustomCombineIdentifierConvertible {
    associatedtype Input
    associatedtype Failure: Error
    
    func receive(subscription: Subscription)
    func receive(_ input: Input) -> Subscribers.Demand
    func receive(completion: Subscribers.Completion<Failure>)
}

内置 Subscriber:

  • sink:最简单的订阅方式
  • assign:将值赋给对象的属性

示例:

// 使用 sink 订阅:同时处理「值」与「完成/错误」
let cancellable = [1, 2, 3].publisher
    .sink(
        receiveCompletion: { completion in
            // 流结束时的回调:.finished 或 .failure(error)
            switch completion {
            case .finished:
                print("完成")
            case .failure(let error):
                print("错误: \(error)")
            }
        },
        receiveValue: { value in
            print("收到值: \(value)")
        }
    )

// 使用 assign 订阅:将每个发布的值赋给对象的某个属性(KeyPath)
class ViewModel {
    @Published var count: Int = 0
}

let viewModel = ViewModel()
let cancellable = [1, 2, 3].publisher
    .assign(to: \.count, on: viewModel)  // 最终 viewModel.count == 3

2.3 Subscription(订阅)

Subscription 表示订阅关系,控制数据流的生命周期。

protocol Subscription: Cancellable, CustomCombineIdentifierConvertible {
    func request(_ demand: Subscribers.Demand)
}

关键点:

  • 控制数据流的开始和结束
  • 实现背压(backpressure)控制
  • 可以取消订阅

示例:

// 自定义 Subscriber,演示背压:通过 request(.max(3)) 只拉取 3 个值
class CustomSubscriber: Subscriber {
    typealias Input = Int
    typealias Failure = Never
    
    func receive(subscription: Subscription) {
        // 建立订阅后,主动请求最多 3 个值(背压控制)
        subscription.request(.max(3))
    }
    
    func receive(_ input: Int) -> Subscribers.Demand {
        print("收到: \(input)")
        // 返回 .none 表示本轮不再请求更多;上游最多只会发 3 个
        return .none
    }
    
    func receive(completion: Subscribers.Completion<Never>) {
        print("完成")
    }
}

let subscriber = CustomSubscriber()
// 数组有 5 个元素,但只会收到 1、2、3
[1, 2, 3, 4, 5].publisher.subscribe(subscriber)

3. Publisher与Subscriber

3.1 内置Publisher类型

Just

发布单个值然后完成。

// Just:有订阅时发布一个值并立即发送 .finished
let just = Just("Hello")
    .sink { value in
        print(value)  // 输出: Hello
    }
Future

异步执行操作并发布结果。

// Future:封装异步回调,只执行一次,结果通过 promise 发布
func fetchData() -> Future<String, Error> {
    return Future { promise in
        DispatchQueue.global().asyncAfter(deadline: .now() + 1) {
            promise(.success("数据加载完成"))
        }
    }
}

fetchData()
    .sink(
        receiveCompletion: { completion in
            if case .failure(let error) = completion {
                print("错误: \(error)")
            }
        },
        receiveValue: { value in
            print(value)  // 输出: 数据加载完成
        }
    )
Deferred

延迟创建 Publisher,直到有订阅者。

// Deferred:闭包在「第一次被订阅」时才执行,避免创建时就产生副作用
let deferred = Deferred {
    Future { promise in
        print("开始执行")
        promise(.success("结果"))
    }
}

// 此时不会执行(只创建了 Deferred,未订阅)
print("创建完成")

// 订阅时才执行内部 Future,并收到 "结果"
deferred.sink { value in
    print(value)  // 输出: 开始执行, 结果
}
Empty

不发布任何值,可选择立即完成或永不完成。Empty 是 Combine 中非常有用的占位符 Publisher,常用于条件分支、错误处理、以及保持订阅活跃。

基本用法:

// 立即完成:不发送任何 value,只发送 completion
let empty = Empty<String, Never>(completeImmediately: true)
    .sink(
        receiveCompletion: { _ in print("完成") },
        receiveValue: { _ in }
    )

// 永不完成:既不发值也不发 completion,常用于测试或「占位」
let never = Empty<String, Never>(completeImmediately: false)

Empty 的占位操作:

Empty 最常见的用途是作为占位符 Publisher,在条件不满足时提供一个"空"的 Publisher,避免返回 Optional 或处理 nil 的情况。

1. 条件分支中的占位

// 场景:根据条件返回不同的 Publisher
func fetchData(shouldFetch: Bool) -> AnyPublisher<String, Never> {
    if shouldFetch {
        return URLSession.shared.dataTaskPublisher(for: url)
            .map(\.data)
            .compactMap { String(data: $0, encoding: .utf8) }
            .replaceError(with: "")
            .eraseToAnyPublisher()
    } else {
        // 使用 Empty 作为占位,不执行任何操作
        return Empty(completeImmediately: true)
            .eraseToAnyPublisher()
    }
}

// 使用:无论条件如何,返回类型都是 AnyPublisher<String, Never>
fetchData(shouldFetch: true)
    .sink { print($0) }  // 正常接收数据

fetchData(shouldFetch: false)
    .sink { print($0) }  // 立即完成,不接收任何值

2. 错误处理中的占位

// 在 catch 中使用 Empty 作为备用 Publisher
func loadUserData() -> AnyPublisher<User, Error> {
    return URLSession.shared.dataTaskPublisher(for: userURL)
        .map(\.data)
        .decode(type: User.self, decoder: JSONDecoder())
        .catch { error -> AnyPublisher<User, Error> in
            if error is DecodingError {
                // 解码错误时返回空 Publisher,不发送任何值
                return Empty(completeImmediately: true)
                    .eraseToAnyPublisher()
            } else {
                // 其他错误继续传播
                return Fail(error: error)
                    .eraseToAnyPublisher()
            }
        }
        .eraseToAnyPublisher()
}

3. flatMap 中的条件占位

// 在 flatMap 中根据条件决定是否执行操作
class SearchViewModel: ObservableObject {
    @Published var searchText: String = ""
    @Published var results: [String] = []
    
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        $searchText
            .flatMap { query -> AnyPublisher<[String], Never> in
                if query.isEmpty {
                    // 空查询时返回 Empty,不执行搜索
                    return Empty(completeImmediately: true)
                        .eraseToAnyPublisher()
                } else {
                    // 执行搜索
                    return self.search(query: query)
                        .catch { _ in Just([]) }
                        .eraseToAnyPublisher()
                }
            }
            .assign(to: \.results, on: self)
            .store(in: &cancellables)
    }
    
    private func search(query: String) -> AnyPublisher<[String], Error> {
        // 搜索实现
        return Just(["结果1", "结果2"])
            .setFailureType(to: Error.self)
            .eraseToAnyPublisher()
    }
}

4. 使用 Empty 保持订阅活跃(常驻任务)

Empty 的 completeImmediately: false 模式可以创建一个永不完成的 Publisher,这在需要保持订阅活跃、贯穿整个程序生命周期的场景中非常有用。

场景1:常驻的后台任务

class BackgroundTaskManager {
    private var cancellables = Set<AnyCancellable>()
    
    // 创建一个永不完成的 Empty 作为基础流
    private let keepAlive = Empty<Never, Never>(completeImmediately: false)
        .eraseToAnyPublisher()
    
    func startBackgroundTask() {
        // 使用 flatMap 将 Empty 转换为周期性的任务流
        keepAlive
            .flatMap { _ -> AnyPublisher<Date, Never> in
                // 每 5 秒执行一次任务
                return Timer.publish(every: 5.0, on: .main, in: .common)
                    .autoconnect()
                    .map { _ in Date() }
                    .eraseToAnyPublisher()
            }
            .sink { [weak self] date in
                self?.performBackgroundTask(at: date)
            }
            .store(in: &cancellables)
    }
    
    private func performBackgroundTask(at date: Date) {
        print("执行后台任务: \(date)")
        // 执行实际的后台任务,如数据同步、状态检查等
    }
    
    func stopBackgroundTask() {
        cancellables.removeAll()  // 取消所有订阅
    }
}

场景2:常驻的事件监听

class AppLifecycleManager {
    private var cancellables = Set<AnyCancellable>()
    
    func startMonitoring() {
        // 使用 Empty 作为基础流,保持订阅活跃
        Empty<Never, Never>(completeImmediately: false)
            .flatMap { _ -> AnyPublisher<Notification, Never> in
                // 监听多个通知
                let appWillEnterForeground = NotificationCenter.default
                    .publisher(for: UIApplication.willEnterForegroundNotification)
                
                let appDidEnterBackground = NotificationCenter.default
                    .publisher(for: UIApplication.didEnterBackgroundNotification)
                
                // 合并多个通知流
                return Publishers.Merge(appWillEnterForeground, appDidEnterBackground)
                    .eraseToAnyPublisher()
            }
            .sink { [weak self] notification in
                self?.handleAppLifecycleEvent(notification)
            }
            .store(in: &cancellables)
    }
    
    private func handleAppLifecycleEvent(_ notification: Notification) {
        switch notification.name {
        case UIApplication.willEnterForegroundNotification:
            print("应用即将进入前台")
        case UIApplication.didEnterBackgroundNotification:
            print("应用进入后台")
        default:
            break
        }
    }
}

场景3:常驻的心跳/保活机制

class HeartbeatManager {
    private var cancellables = Set<AnyCancellable>()
    private let heartbeatInterval: TimeInterval = 30.0
    
    func startHeartbeat() {
        // 使用 Empty 保持订阅,然后转换为心跳流
        Empty<Never, Never>(completeImmediately: false)
            .flatMap { [weak self] _ -> AnyPublisher<Void, Never> in
                guard let self = self else {
                    return Empty(completeImmediately: true).eraseToAnyPublisher()
                }
                
                // 创建心跳定时器
                return Timer.publish(every: self.heartbeatInterval, on: .main, in: .common)
                    .autoconnect()
                    .map { _ in () }
                    .eraseToAnyPublisher()
            }
            .sink { [weak self] _ in
                self?.sendHeartbeat()
            }
            .store(in: &cancellables)
    }
    
    private func sendHeartbeat() {
        // 发送心跳请求
        print("发送心跳: \(Date())")
        // 实际实现:发送网络请求保持连接活跃
    }
    
    func stopHeartbeat() {
        cancellables.removeAll()
    }
}

场景4:常驻的数据同步任务

class DataSyncManager {
    private var cancellables = Set<AnyCancellable>()
    private let syncInterval: TimeInterval = 60.0
    
    func startAutoSync() {
        // 使用 Empty 作为基础流,保持订阅贯穿应用生命周期
        Empty<Never, Never>(completeImmediately: false)
            .flatMap { [weak self] _ -> AnyPublisher<SyncResult, Never> in
                guard let self = self else {
                    return Empty(completeImmediately: true).eraseToAnyPublisher()
                }
                
                // 创建周期性同步流
                return Timer.publish(every: self.syncInterval, on: .main, in: .common)
                    .autoconnect()
                    .flatMap { _ -> AnyPublisher<SyncResult, Never> in
                        return self.performSync()
                            .catch { _ in Just(SyncResult.failure) }
                            .eraseToAnyPublisher()
                    }
                    .eraseToAnyPublisher()
            }
            .sink { [weak self] result in
                self?.handleSyncResult(result)
            }
            .store(in: &cancellables)
    }
    
    private func performSync() -> AnyPublisher<SyncResult, Error> {
        // 执行数据同步
        return Just(SyncResult.success)
            .setFailureType(to: Error.self)
            .eraseToAnyPublisher()
    }
    
    private func handleSyncResult(_ result: SyncResult) {
        print("同步结果: \(result)")
    }
    
    enum SyncResult {
        case success
        case failure
    }
}

场景5:更优雅的常驻任务实现(推荐方式)

虽然 Empty 可以用来保持订阅,但更推荐使用 Timer.publish().autoconnect()PassthroughSubject 来实现常驻任务:

class BetterBackgroundTaskManager {
    private var cancellables = Set<AnyCancellable>()
    
    func startBackgroundTask() {
        // 方式1:直接使用 Timer(推荐)
        Timer.publish(every: 5.0, on: .main, in: .common)
            .autoconnect()
            .sink { [weak self] _ in
                self?.performTask()
            }
            .store(in: &cancellables)
        
        // 方式2:使用 PassthroughSubject 控制(更灵活)
        let taskTrigger = PassthroughSubject<Void, Never>()
        
        taskTrigger
            .sink { [weak self] _ in
                self?.performTask()
            }
            .store(in: &cancellables)
        
        // 可以手动触发或结合 Timer
        Timer.publish(every: 5.0, on: .main, in: .common)
            .autoconnect()
            .sink { _ in taskTrigger.send() }
            .store(in: &cancellables)
    }
    
    private func performTask() {
        print("执行任务")
    }
}

Empty 占位操作的最佳实践:

  1. 类型一致性:使用 Empty 时确保类型匹配(Output 和 Failure)
  2. 立即完成 vs 永不完成
    • completeImmediately: true:用于条件分支,表示"跳过此分支"
    • completeImmediately: false:用于保持订阅活跃,但更推荐使用 Timer 或 Subject
  3. 结合 eraseToAnyPublisher():在使用 Empty 时通常需要类型擦除,以保持类型一致性
  4. 避免过度使用:对于常驻任务,优先考虑 Timer 或 PassthroughSubject,Empty 更适合作为占位符

Empty 的常见使用模式总结:

使用场景 completeImmediately 说明
条件分支占位 true 条件不满足时返回空流
错误处理占位 true 某些错误情况下不发送值
测试占位 false 测试中模拟永不完成的流
保持订阅(不推荐) false 可用但更推荐 Timer/Subject

注意事项:

  • Empty 是值类型(struct),每次创建都是新实例
  • completeImmediately: false 的 Empty 会保持订阅活跃,但不会发送任何值
  • 对于常驻任务,虽然可以用 Empty 实现,但使用 Timer 或 PassthroughSubject 更直观和高效
Fail

立即发布错误。

// Fail:有订阅时立即发送 .failure(error),不发送任何正常值
enum MyError: Error {
    case customError
}

let fail = Fail<String, MyError>(error: .customError)
    .sink(
        receiveCompletion: { completion in
            if case .failure(let error) = completion {
                print("错误: \(error)")
            }
        },
        receiveValue: { _ in }
    )
Sequence

从序列创建 Publisher。

// 符合 Sequence 的类型都有 .publisher,按顺序发布元素
let sequence = (1...5).publisher
    .sink { value in
        print(value)  // 输出: 1, 2, 3, 4, 5
    }

3.2 自定义Publisher

// 自定义 Publisher:从数组按需发布元素,遵循背压
struct CustomPublisher: Publisher {
    typealias Output = Int
    typealias Failure = Never
    
    let values: [Int]
    
    func receive<S>(subscriber: S) where S: Subscriber, 
        S.Input == Output, S.Failure == Failure {
        // 收到订阅者时,创建自定义 Subscription 并下发给订阅者
        let subscription = CustomSubscription(
            subscriber: subscriber,
            values: values
        )
        subscriber.receive(subscription: subscription)
    }
}

// 自定义 Subscription:根据 request(demand) 按需从 values 取数并下发
class CustomSubscription<S: Subscriber>: Subscription 
    where S.Input == Int, S.Failure == Never {
    
    var subscriber: S?
    let values: [Int]
    var currentIndex = 0
    var requested: Subscribers.Demand = .none
    
    init(subscriber: S, values: [Int]) {
        self.subscriber = subscriber
        self.values = values
    }
    
    func request(_ demand: Subscribers.Demand) {
        requested += demand
        
        // 在 demand 允许且还有数据时,逐个下发
        while requested > .none && currentIndex < values.count {
            let value = values[currentIndex]
            currentIndex += 1
            requested -= .max(1)
            
            _ = subscriber?.receive(value)
        }
        
        if currentIndex >= values.count {
            subscriber?.receive(completion: .finished)
            cancel()
        }
    }
    
    func cancel() {
        subscriber = nil
    }
}

// 使用自定义 Publisher:行为等价于 [1,2,3].publisher
let custom = CustomPublisher(values: [1, 2, 3])
    .sink { value in
        print(value)  // 输出: 1, 2, 3
    }

4. Operators操作符

4.1 转换操作符

map

转换每个值。

// map:对每个元素做变换,类型可改变
[1, 2, 3].publisher
    .map { $0 * 2 }
    .sink { print($0) }  // 输出: 2, 4, 6
flatMap

将多个 Publisher 扁平化。

// flatMap:每个元素映射为一个新 Publisher,再把这些 Publisher 的输出「压平」成一条流
["A", "B", "C"].publisher
    .flatMap { letter in
        (1...2).publisher.map { "\(letter)\($0)" }
    }
    .sink { print($0) }  // 输出: A1, A2, B1, B2, C1, C2
compactMap

过滤 nil 值。

// compactMap:类似 map,但闭包返回 Optional;nil 会被丢弃,不往下游发
["1", "2", "abc", "3"].publisher
    .compactMap { Int($0) }
    .sink { print($0) }  // 输出: 1, 2, 3
scan

累积值。

// scan:给定初始值,每收到一个元素就与当前累积值做运算,并下发新的累积值
[1, 2, 3, 4, 5].publisher
    .scan(0, +)
    .sink { print($0) }  // 输出: 1, 3, 6, 10, 15

4.2 过滤操作符

filter

过滤值。

// filter:只下发谓词为 true 的值
[1, 2, 3, 4, 5].publisher
    .filter { $0 % 2 == 0 }
    .sink { print($0) }  // 输出: 2, 4
removeDuplicates

移除重复值。

// removeDuplicates:连续相同只发第一个,相当于「相邻去重」
[1, 1, 2, 2, 3, 3].publisher
    .removeDuplicates()
    .sink { print($0) }  // 输出: 1, 2, 3
first / last

获取第一个或最后一个值。

// first:只取第一个元素,取到后发完成
[1, 2, 3, 4, 5].publisher
    .first()
    .sink { print($0) }  // 输出: 1

// last:必须等上游完成,再发最后一个元素
[1, 2, 3, 4, 5].publisher
    .last()
    .sink { print($0) }  // 输出: 5
dropFirst / dropLast

丢弃前几个或后几个值。

// dropFirst(n):跳过前 n 个,只发后面的
[1, 2, 3, 4, 5].publisher
    .dropFirst(2)
    .sink { print($0) }  // 输出: 3, 4, 5

4.3 组合操作符

combineLatest

组合多个 Publisher 的最新值。

// combineLatest:两边都至少发过一个值后,每次任一边发新值就组合「两边当前最新值」下发
let publisher1 = PassthroughSubject<String, Never>()
let publisher2 = PassthroughSubject<Int, Never>()

publisher1
    .combineLatest(publisher2)
    .sink { value1, value2 in
        print("\(value1): \(value2)")
    }

publisher1.send("A")  // 无输出(publisher2 尚未发过值)
publisher2.send(1)    // 输出: A: 1
publisher1.send("B")  // 输出: B: 1(用 B 与 2 的最新值 1 组合)
publisher2.send(2)    // 输出: B: 2
merge

合并多个 Publisher。

// merge:多个流合并成一条,哪个先发就先收到哪个,类型必须相同
let publisher1 = PassthroughSubject<Int, Never>()
let publisher2 = PassthroughSubject<Int, Never>()

publisher1
    .merge(with: publisher2)
    .sink { print($0) }

publisher1.send(1)  // 输出: 1
publisher2.send(2)  // 输出: 2
publisher1.send(3)  // 输出: 3
zip

按顺序组合多个 Publisher。

// zip:按「第 n 个与第 n 个」配对,凑齐一对才下发,顺序严格
let publisher1 = PassthroughSubject<String, Never>()
let publisher2 = PassthroughSubject<Int, Never>()

publisher1
    .zip(publisher2)
    .sink { value1, value2 in
        print("\(value1): \(value2)")
    }

publisher1.send("A")  // 等待 publisher2 的第一个值
publisher1.send("B")  // 等待 publisher2 的第二个值
publisher2.send(1)    // 输出: A: 1
publisher2.send(2)    // 输出: B: 2

4.4 时间操作符

debounce

防抖,等待指定时间后发布最新值。

// debounce:在一段时间内没有新值时,才把「最后一次收到的值」发出去(适合搜索框)
let subject = PassthroughSubject<String, Never>()

subject
    .debounce(for: .seconds(0.5), scheduler: DispatchQueue.main)
    .sink { print($0) }

subject.send("H")     // 不输出(等待 0.5s)
subject.send("He")    // 重置等待
subject.send("Hel")   // 重置等待
subject.send("Hell")  // 重置等待
subject.send("Hello") // 0.5 秒内无新值,输出: Hello
throttle

节流,在指定时间间隔内只发布第一个值。

// throttle:在时间窗口内只取一个值;latest: false 取窗口内第一个,true 取最后一个
let subject = PassthroughSubject<String, Never>()

subject
    .throttle(for: .seconds(1), scheduler: DispatchQueue.main, latest: false)
    .sink { print($0) }

subject.send("A")  // 立即输出: A,开启 1 秒窗口
subject.send("B")  // 不输出(1 秒内)
subject.send("C")  // 不输出(1 秒内)
// 1 秒后
subject.send("D")  // 输出: D
delay

延迟发布值。

// delay:每个元素都延后指定时间再下发,相对顺序不变
[1, 2, 3].publisher
    .delay(for: .seconds(1), scheduler: DispatchQueue.main)
    .sink { print($0) }  // 1 秒后依次输出: 1, 2, 3

4.5 错误处理操作符

catch

捕获错误并返回备用 Publisher。

// catch:上游失败时用闭包返回一个备用 Publisher,流继续用备用流
enum MyError: Error {
    case failure
}

let publisher = Fail<String, MyError>(error: .failure)
    .catch { error -> Just<String> in
        print("捕获错误: \(error)")
        return Just("备用值")
    }
    .sink { print($0) }  // 输出: 捕获错误: failure, 备用值
retry

重试失败的 Publisher。

// retry(n):失败时重新订阅上游最多 n 次(这里是 2 次,共最多 3 次执行)
var attempts = 0

let publisher = Future<String, Error> { promise in
    attempts += 1
    if attempts < 3 {
        promise(.failure(NSError(domain: "test", code: 1)))
    } else {
        promise(.success("成功"))
    }
}
.retry(2)  // 最多重试 2 次,第 3 次成功
.sink(
    receiveCompletion: { print($0) },
    receiveValue: { print($0) }  // 输出: 成功
)
replaceError

用默认值替换错误。

// replaceError:失败时不发错误,改为发一个默认值并正常结束
let publisher = Fail<String, MyError>(error: .failure)
    .replaceError(with: "默认值")
    .sink { print($0) }  // 输出: 默认值

5. Subjects

Subjects 既是 Publisher 又是 Subscriber,可以手动发送值。

5.1 PassthroughSubject

直接传递值,不保存当前值。

// PassthroughSubject:只转发 send 的值,不存当前值,后订阅的收不到之前的值
let subject = PassthroughSubject<String, Never>()

// 订阅1
let cancellable1 = subject.sink { print("订阅1: \($0)") }

subject.send("A")  // 输出: 订阅1: A

// 订阅2:之后 send 的值两个订阅都会收到
let cancellable2 = subject.sink { print("订阅2: \($0)") }

subject.send("B")  // 输出: 订阅1: B, 订阅2: B

5.2 CurrentValueSubject

保存当前值,新订阅者会立即收到当前值。

// CurrentValueSubject:持有当前 value,新订阅者会先收到当前值再收后续 send
let subject = CurrentValueSubject<String, Never>("初始值")

// 订阅1:立即收到初始值
let cancellable1 = subject.sink { print("订阅1: \($0)") }
// 输出: 订阅1: 初始值

subject.value = "新值"  // 输出: 订阅1: 新值

// 订阅2:一订阅就收到当前值 "新值"
let cancellable2 = subject.sink { print("订阅2: \($0)") }
// 输出: 订阅2: 新值(立即收到当前值)

5.3 @Published 属性包装器

自动创建 Publisher。

// @Published:属性变化时自动发值;$name 是该属性的 Publisher
class ViewModel: ObservableObject {
    @Published var name: String = ""
    @Published var age: Int = 0
    
    init() {
        // 监听 name 的变化,防抖后处理
        $name
            .debounce(for: .seconds(0.5), scheduler: DispatchQueue.main)
            .sink { [weak self] newName in
                print("名称变化: \(newName)")
            }
            .store(in: &cancellables)
    }
    
    private var cancellables = Set<AnyCancellable>()
}

let viewModel = ViewModel()
viewModel.name = "张三"  // 0.5 秒后输出: 名称变化: 张三

5.4 把属性变成 Publisher 的使用案例

在 Combine 中,有多种方式可以将属性转换为 Publisher,每种方式适用于不同的场景。理解这些方式有助于更好地使用 Combine 进行响应式编程。

5.4.1 使用 @Published 属性包装器(推荐)

@Published 是 Combine 中最常用和推荐的方式,特别适合在 ViewModel 或 ObservableObject 中使用。

基本用法:

class UserViewModel: ObservableObject {
    @Published var name: String = ""
    @Published var age: Int = 0
    @Published var isLoggedIn: Bool = false
    
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        // 使用 $name 访问 Publisher
        $name
            .debounce(for: .milliseconds(500), scheduler: RunLoop.main)
            .sink { [weak self] newName in
                print("名称变化: \(newName)")
                // 可以触发其他操作,如搜索、验证等
            }
            .store(in: &cancellables)
        
        // 监听多个属性
        Publishers.CombineLatest($name, $age)
            .sink { [weak self] name, age in
                print("用户信息: \(name), \(age)")
            }
            .store(in: &cancellables)
    }
}

特点:

  • ✅ 自动创建 Publisher(通过 $属性名 访问)
  • ✅ 类型安全,编译时检查
  • ✅ 与 SwiftUI 深度集成
  • ✅ 自动发送初始值(可通过 dropFirst() 跳过)
5.4.2 使用 CurrentValueSubject

CurrentValueSubject 适合需要手动控制发布时机的场景,或者需要将非 @Published 属性转换为 Publisher。

基本用法:

class SettingsManager {
    // 方式1:直接使用 CurrentValueSubject 作为存储属性
    private let _theme = CurrentValueSubject<String, Never>("light")
    var theme: String {
        get { _theme.value }
        set { _theme.value = newValue }
    }
    
    // 暴露 Publisher
    var themePublisher: AnyPublisher<String, Never> {
        _theme.eraseToAnyPublisher()
    }
    
    // 方式2:将普通属性包装为 CurrentValueSubject
    private var _userName: String = ""
    private let userNameSubject = CurrentValueSubject<String, Never>("")
    
    var userName: String {
        get { _userName }
        set {
            _userName = newValue
            userNameSubject.send(newValue)
        }
    }
    
    var userNamePublisher: AnyPublisher<String, Never> {
        userNameSubject.eraseToAnyPublisher()
    }
}

实际应用场景:

class NetworkManager {
    private let _connectionStatus = CurrentValueSubject<ConnectionStatus, Never>(.disconnected)
    
    var connectionStatus: ConnectionStatus {
        get { _connectionStatus.value }
    }
    
    var connectionStatusPublisher: AnyPublisher<ConnectionStatus, Never> {
        _connectionSubject.eraseToAnyPublisher()
    }
    
    func connect() {
        // 网络连接逻辑
        _connectionStatus.send(.connecting)
        // ... 连接成功后
        _connectionStatus.send(.connected)
    }
    
    enum ConnectionStatus {
        case disconnected
        case connecting
        case connected
    }
}

// 使用
let networkManager = NetworkManager()
networkManager.connectionStatusPublisher
    .sink { status in
        print("连接状态: \(status)")
    }
    .store(in: &cancellables)
5.4.3 使用 PassthroughSubject(不保存当前值)

PassthroughSubject 适合事件类型的属性,不需要保存当前值,只关注变化事件。

基本用法:

class ButtonViewModel {
    // 按钮点击事件
    let buttonTap = PassthroughSubject<Void, Never>()
    
    // 用户操作事件
    let userAction = PassthroughSubject<UserAction, Never>()
    
    enum UserAction {
        case login
        case logout
        case refresh
    }
}

// 使用
let viewModel = ButtonViewModel()
viewModel.buttonTap
    .sink { print("按钮被点击") }
    .store(in: &cancellables)

viewModel.userAction
    .sink { action in
        switch action {
        case .login: print("用户登录")
        case .logout: print("用户登出")
        case .refresh: print("刷新数据")
        }
    }
    .store(in: &cancellables)

// 触发事件
viewModel.buttonTap.send()
viewModel.userAction.send(.login)
5.4.4 使用 KVO(Key-Value Observing)

对于 NSObject 的子类,可以使用 KVO 将属性转换为 Publisher。

基本用法:

import Combine

class Person: NSObject {
    @objc dynamic var name: String = ""
    @objc dynamic var age: Int = 0
}

// 使用
let person = Person()

// 将 KVO 属性转换为 Publisher
person.publisher(for: \.name, options: [.initial, .new])
    .sink { name in
        print("姓名变化: \(name)")
    }
    .store(in: &cancellables)

person.publisher(for: \.age, options: [.initial, .new])
    .sink { age in
        print("年龄变化: \(age)")
    }
    .store(in: &cancellables)

// 修改属性会触发 Publisher
person.name = "张三"  // 输出: 姓名变化: 张三
person.age = 25      // 输出: 年龄变化: 25

KVO Options 说明:

  • .initial:订阅时立即发送当前值
  • .new:属性变化时发送新值
  • .old:属性变化时发送旧值
  • .prior:变化前发送旧值,变化后发送新值
5.4.5 使用 NotificationCenter

将系统通知或自定义通知转换为 Publisher。

基本用法:

// 系统通知
let keyboardWillShow = NotificationCenter.default
    .publisher(for: UIResponder.keyboardWillShowNotification)
    .map { notification -> CGRect in
        (notification.userInfo?[UIResponder.keyboardFrameEndUserInfoKey] as? CGRect) ?? .zero
    }

keyboardWillShow
    .sink { frame in
        print("键盘高度: \(frame.height)")
    }
    .store(in: &cancellables)

// 自定义通知
extension Notification.Name {
    static let userDidLogin = Notification.Name("userDidLogin")
    static let dataDidUpdate = Notification.Name("dataDidUpdate")
}

let userLoginPublisher = NotificationCenter.default
    .publisher(for: .userDidLogin)
    .compactMap { $0.userInfo?["user"] as? User }

userLoginPublisher
    .sink { user in
        print("用户登录: \(user.name)")
    }
    .store(in: &cancellables)

// 发送通知
NotificationCenter.default.post(
    name: .userDidLogin,
    object: nil,
    userInfo: ["user": currentUser]
)
5.4.6 使用 Timer 将时间属性转换为 Publisher

将定时器转换为 Publisher,用于周期性更新。

基本用法:

class ClockViewModel {
    // 方式1:使用 Timer.publish
    var currentTime: AnyPublisher<Date, Never> {
        Timer.publish(every: 1.0, on: .main, in: .common)
            .autoconnect()
            .eraseToAnyPublisher()
    }
    
    // 方式2:创建可控制的定时器
    private var timerCancellable: AnyCancellable?
    
    func startTimer() {
        timerCancellable = Timer.publish(every: 1.0, on: .main, in: .common)
            .autoconnect()
            .sink { [weak self] date in
                self?.updateTime(date)
            }
    }
    
    func stopTimer() {
        timerCancellable?.cancel()
        timerCancellable = nil
    }
    
    private func updateTime(_ date: Date) {
        // 更新时间
    }
}
5.4.7 组合多个属性 Publisher

使用 Combine 操作符组合多个属性 Publisher。

场景1:表单验证

class FormViewModel: ObservableObject {
    @Published var username: String = ""
    @Published var password: String = ""
    @Published var confirmPassword: String = ""
    
    // 组合多个属性,实时验证表单
    var isFormValid: AnyPublisher<Bool, Never> {
        Publishers.CombineLatest3($username, $password, $confirmPassword)
            .map { username, password, confirmPassword in
                !username.isEmpty &&
                password.count >= 6 &&
                password == confirmPassword
            }
            .eraseToAnyPublisher()
    }
    
    // 用户名验证
    var usernameValidation: AnyPublisher<String?, Never> {
        $username
            .debounce(for: .milliseconds(500), scheduler: RunLoop.main)
            .map { username in
                if username.isEmpty {
                    return "用户名不能为空"
                } else if username.count < 3 {
                    return "用户名至少3个字符"
                }
                return nil
            }
            .eraseToAnyPublisher()
    }
}

场景2:搜索功能

class SearchViewModel: ObservableObject {
    @Published var searchText: String = ""
    @Published var selectedCategory: String = "all"
    @Published var sortOrder: SortOrder = .ascending
    
    enum SortOrder {
        case ascending
        case descending
    }
    
    // 组合多个条件,触发搜索
    var searchTrigger: AnyPublisher<(String, String, SortOrder), Never> {
        Publishers.CombineLatest3($searchText, $selectedCategory, $sortOrder)
            .debounce(for: .milliseconds(500), scheduler: RunLoop.main)
            .eraseToAnyPublisher()
    }
    
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        searchTrigger
            .sink { [weak self] text, category, order in
                self?.performSearch(text: text, category: category, order: order)
            }
            .store(in: &cancellables)
    }
    
    private func performSearch(text: String, category: String, order: SortOrder) {
        // 执行搜索
    }
}

场景3:实时计算属性

class ShoppingCartViewModel: ObservableObject {
    @Published var items: [CartItem] = []
    @Published var discount: Double = 0.0
    @Published var shippingFee: Double = 0.0
    
    // 实时计算总价
    var totalPrice: AnyPublisher<Double, Never> {
        Publishers.CombineLatest3($items, $discount, $shippingFee)
            .map { items, discount, shippingFee in
                let subtotal = items.reduce(0) { $0 + $1.price * Double($1.quantity) }
                let discounted = subtotal * (1 - discount)
                return discounted + shippingFee
            }
            .eraseToAnyPublisher()
    }
    
    // 商品数量变化时自动更新
    var itemCount: AnyPublisher<Int, Never> {
        $items
            .map { $0.reduce(0) { $0 + $1.quantity } }
            .eraseToAnyPublisher()
    }
}

struct CartItem {
    let id: String
    var quantity: Int
    let price: Double
}
5.4.8 属性转换的最佳实践

1. 选择合适的转换方式

场景 推荐方式 原因
ViewModel/ObservableObject @Published 与 SwiftUI 集成,自动管理
需要手动控制发布时机 CurrentValueSubject 更灵活的控制
事件类型(不保存状态) PassthroughSubject 只关注事件,不保存值
NSObject 子类 KVO .publisher(for:) 利用现有 KVO 机制
系统通知 NotificationCenter.publisher 系统级事件
定时更新 Timer.publish 周期性更新

2. 避免内存泄漏

// ✅ 正确:使用 weak self
class ViewModel: ObservableObject {
    @Published var data: String = ""
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        $data
            .sink { [weak self] value in
                self?.processData(value)
            }
            .store(in: &cancellables)
    }
    
    private func processData(_ value: String) {
        // 处理数据
    }
}

// ❌ 错误:强引用循环
class ViewModel: ObservableObject {
    @Published var data: String = ""
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        $data
            .sink { [self] value in  // 强引用 self
                self.processData(value)
            }
            .store(in: &cancellables)
    }
}

3. 使用 dropFirst() 跳过初始值

class ViewModel: ObservableObject {
    @Published var searchText: String = ""
    
    init() {
        // 跳过初始值,只在用户输入时触发
        $searchText
            .dropFirst()  // 跳过初始的 ""
            .debounce(for: .milliseconds(500), scheduler: RunLoop.main)
            .sink { [weak self] text in
                self?.performSearch(text)
            }
            .store(in: &cancellables)
    }
}

4. 类型擦除保持接口简洁

class DataManager {
    private let _data = CurrentValueSubject<[String], Never>([])
    
    // ✅ 暴露类型擦除的 Publisher
    var dataPublisher: AnyPublisher<[String], Never> {
        _data.eraseToAnyPublisher()
    }
    
    // ❌ 不推荐:直接暴露 CurrentValueSubject
    // var dataPublisher: CurrentValueSubject<[String], Never> { _data }
}

5. 组合多个属性的模式

// 模式1:CombineLatest(所有属性都变化时触发)
Publishers.CombineLatest($name, $age)
    .sink { name, age in
        // name 或 age 任一变化都会触发
    }

// 模式2:Zip(需要成对变化)
Publishers.Zip($name, $age)
    .sink { name, age in
        // name 和 age 必须都变化一次才触发
    }

// 模式3:Merge(任一变化时触发)
Publishers.Merge($name.map { "name: \($0)" }, $age.map { "age: \($0)" })
    .sink { message in
        // name 或 age 变化都会触发
    }

6. Schedulers调度器

Schedulers 决定操作在哪个线程执行。

6.1 内置Scheduler

DispatchQueue
// subscribe(on:):订阅与上游工作在哪个调度器;receive(on:):下游收值在哪个调度器(常用主线程更新 UI)
[1, 2, 3].publisher
    .subscribe(on: DispatchQueue.global())  // 在后台线程执行订阅与上游
    .receive(on: DispatchQueue.main)        // 在主线程接收并执行 sink
    .sink { print($0) }
RunLoop
// RunLoop 也符合 Scheduler,可在当前 RunLoop 上调度
[1, 2, 3].publisher
    .subscribe(on: RunLoop.current)
    .sink { print($0) }
OperationQueue
// OperationQueue 可作为 Scheduler,可限制并发数
let queue = OperationQueue()
queue.maxConcurrentOperationCount = 2

[1, 2, 3, 4, 5].publisher
    .subscribe(on: queue)
    .sink { print($0) }

6.2 ImmediateScheduler

立即执行,用于测试。

// ImmediateScheduler:不延迟,立即在当前上下文执行,常用于测试
let scheduler = ImmediateScheduler.shared

[1, 2, 3].publisher
    .receive(on: scheduler)
    .sink { print($0) }

7. 错误处理

7.1 错误类型

// 定义领域错误类型,便于在 Publisher 链中统一处理
enum NetworkError: Error {
    case invalidURL
    case noData
    case decodingError
}

func fetchData() -> AnyPublisher<String, NetworkError> {
    // setFailureType:把 Never 等改成指定 Failure 类型;eraseToAnyPublisher 隐藏具体类型
    return Just("数据")
        .setFailureType(to: NetworkError.self)
        .eraseToAnyPublisher()
}

7.2 错误处理策略

// 组合使用:先 catch 兜底、再 retry、最后 replaceError 保证 sink 只收到值
fetchData()
    .catch { error -> Just<String> in
        return Just("默认数据")
    }
    .retry(3)  // 失败时最多重试 3 次
    .replaceError(with: "错误时的默认值")  // 若仍失败,发默认值并正常结束
    .sink { value in
        print(value)
    }

8. 内存管理

8.1 AnyCancellable

保存订阅,防止提前释放。

// 订阅返回 Cancellable,不保存会被立即释放导致订阅断开;用 Set 集中管理
class ViewController {
    private var cancellables = Set<AnyCancellable>()
    
    func setupBinding() {
        $name
            .sink { print($0) }
            .store(in: &cancellables)  // 把订阅存进集合,生命周期与 ViewController 一致
    }
}

8.2 Store 内容管理机制

Store 的作用与原理

store(in:) 方法是 Combine 中管理订阅生命周期的核心机制。理解其工作原理对于正确使用 Combine 至关重要。

8.2.1 AnyCancellable 的本质
// AnyCancellable 是类型擦除的 Cancellable 包装器
public struct AnyCancellable: Cancellable, Hashable {
    private let _cancel: () -> Void
    
    public init(_ cancel: @escaping () -> Void) {
        self._cancel = cancel
    }
    
    public func cancel() {
        _cancel()
    }
    
    // 当 AnyCancellable 被释放时,自动调用 cancel()
    deinit {
        cancel()
    }
}

关键特性:

  • AnyCancellable 是值类型(struct),但内部持有取消操作的闭包
  • AnyCancellable 实例被释放时,会自动调用 cancel() 方法
  • 这确保了订阅在持有者释放时能够正确清理
8.2.2 store(in:) 方法的工作原理
extension Cancellable {
    /// 将 Cancellable 存储到 Set 中,延长其生命周期
    public func store(in set: inout Set<AnyCancellable>) {
        set.insert(AnyCancellable(self))
    }
    
    /// 将 Cancellable 存储到 AnyCancellable 中(单个订阅场景)
    public func store(in cancellable: inout AnyCancellable?) {
        cancellable = AnyCancellable(self)
    }
}

工作流程:

1. 调用 .sink(...) 或 .assign(...) 返回 Cancellable
   ↓
2. 调用 .store(in: &cancellables)
   ↓
3. 将 Cancellable 包装成 AnyCancellable
   ↓
4. 插入到 Set<AnyCancellable> 中
   ↓
5. Set 持有 AnyCancellable,延长订阅生命周期
   ↓
6. 当对象(如 ViewController)释放时,Set 也被释放
   ↓
7. Set 中所有 AnyCancellable 的 deinit 被调用
   ↓
8. 每个 AnyCancellable 的 cancel() 被调用
   ↓
9. 订阅被取消,资源被清理
8.2.3 Set<AnyCancellable> 的管理策略

为什么使用 Set?

// Set 的优势:
// 1. 自动去重(AnyCancellable 实现了 Hashable)
// 2. 高效的插入和查找
// 3. 批量管理多个订阅

class ViewModel: ObservableObject {
    @Published var name: String = ""
    @Published var age: Int = 0
    @Published var email: String = ""
    
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        // 多个订阅可以统一管理
        $name
            .sink { print("Name: \($0)") }
            .store(in: &cancellables)
        
        $age
            .sink { print("Age: \($0)") }
            .store(in: &cancellables)
        
        $email
            .sink { print("Email: \($0)") }
            .store(in: &cancellables)
    }
    
    // 当 ViewModel 释放时,所有订阅自动取消
}

生命周期管理示例:

class ViewController: UIViewController {
    private var cancellables = Set<AnyCancellable>()
    private let viewModel = ViewModel()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        setupBindings()
    }
    
    func setupBindings() {
        // 订阅1:监听数据变化
        viewModel.$data
            .receive(on: DispatchQueue.main)
            .sink { [weak self] data in
                self?.updateUI(with: data)
            }
            .store(in: &cancellables)
        
        // 订阅2:监听错误
        viewModel.$error
            .compactMap { $0 }
            .sink { [weak self] error in
                self?.showError(error)
            }
            .store(in: &cancellables)
        
        // 订阅3:网络请求
        viewModel.fetchData()
            .sink(
                receiveCompletion: { [weak self] completion in
                    if case .failure(let error) = completion {
                        self?.handleError(error)
                    }
                },
                receiveValue: { [weak self] data in
                    self?.handleData(data)
                }
            )
            .store(in: &cancellables)
    }
    
    // 当 ViewController 被释放时:
    // 1. cancellables Set 被释放
    // 2. Set 中所有 AnyCancellable 的 deinit 被调用
    // 3. 所有订阅自动取消,避免内存泄漏
}
8.2.4 手动管理 vs 自动管理

手动管理(不推荐):

class ViewController: UIViewController {
    private var cancellable: AnyCancellable?
    
    func setupBinding() {
        // 需要手动保存,容易忘记
        cancellable = $name
            .sink { print($0) }
        
        // 如果忘记保存,订阅会立即被释放
        $age
            .sink { print($0) }  // ❌ 立即释放,不会收到任何值
    }
    
    // 需要手动取消
    deinit {
        cancellable?.cancel()
    }
}

自动管理(推荐):

class ViewController: UIViewController {
    private var cancellables = Set<AnyCancellable>()
    
    func setupBinding() {
        // 自动管理,无需手动 cancel
        $name
            .sink { print($0) }
            .store(in: &cancellables)
        
        $age
            .sink { print($0) }
            .store(in: &cancellables)
        
        // 对象释放时自动清理所有订阅
    }
}
8.2.5 条件性订阅管理

场景:需要动态添加/移除订阅

class ViewModel: ObservableObject {
    @Published var isEnabled: Bool = false
    @Published var data: String = ""
    
    private var cancellables = Set<AnyCancellable>()
    private var dataSubscription: AnyCancellable?
    
    init() {
        // 监听启用状态,动态管理数据订阅
        $isEnabled
            .sink { [weak self] enabled in
                if enabled {
                    self?.startDataSubscription()
                } else {
                    self?.stopDataSubscription()
                }
            }
            .store(in: &cancellables)
    }
    
    private func startDataSubscription() {
        // 创建新的订阅
        dataSubscription = $data
            .sink { print("Data: \($0)") }
        
        // 手动管理单个订阅
        // 注意:这里不使用 store(in: &cancellables),因为需要单独控制
    }
    
    private func stopDataSubscription() {
        // 手动取消订阅
        dataSubscription?.cancel()
        dataSubscription = nil
    }
}

更好的方式:使用条件操作符

class ViewModel: ObservableObject {
    @Published var isEnabled: Bool = false
    @Published var data: String = ""
    
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        // 使用 filter 或 flatMap 实现条件订阅,统一管理
        $isEnabled
            .filter { $0 }  // 只在启用时继续
            .flatMap { [weak self] _ -> AnyPublisher<String, Never> in
                guard let self = self else {
                    return Empty().eraseToAnyPublisher()
                }
                return self.$data.eraseToAnyPublisher()
            }
            .sink { print("Data: \($0)") }
            .store(in: &cancellables)
    }
}
8.2.6 Store 的最佳实践

1. 统一管理位置

class ViewModel: ObservableObject {
    // ✅ 推荐:在类的顶部声明,统一管理
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        setupSubscriptions()
    }
    
    private func setupSubscriptions() {
        // 所有订阅都在这里设置
        setupDataSubscription()
        setupErrorSubscription()
    }
}

2. 避免在闭包中创建新的 Set

// ❌ 错误:每次调用都创建新的 Set
func loadData() {
    var cancellables = Set<AnyCancellable>()
    API.fetchData()
        .sink { }
        .store(in: &cancellables)  // 函数返回后立即释放
}

// ✅ 正确:使用实例属性
class ViewModel {
    private var cancellables = Set<AnyCancellable>()
    
    func loadData() {
        API.fetchData()
            .sink { }
            .store(in: &cancellables)  // 生命周期与 ViewModel 一致
    }
}

3. 在 SwiftUI 中的使用

struct ContentView: View {
    @StateObject private var viewModel = ViewModel()
    
    var body: some View {
        Text(viewModel.text)
            .onAppear {
                // SwiftUI 中,使用 @StateObject 或 @ObservedObject
                // 订阅会自动管理,但也可以手动管理
                viewModel.$text
                    .sink { print($0) }
                    .store(in: &viewModel.cancellables)
            }
    }
}

class ViewModel: ObservableObject {
    @Published var text: String = ""
    var cancellables = Set<AnyCancellable>()  // 注意:在 SwiftUI 中可能需要 internal
}

4. 测试中的管理

class ViewModelTests: XCTestCase {
    func testSubscription() {
        let viewModel = ViewModel()
        var cancellables = Set<AnyCancellable>()
        var receivedValues: [String] = []
        
        viewModel.$data
            .sink { receivedValues.append($0) }
            .store(in: &cancellables)
        
        viewModel.data = "test"
        
        // 测试完成后,cancellables 会自动清理
        XCTAssertEqual(receivedValues, ["test"])
    }
}
8.2.7 Store 的内部实现细节

AnyCancellable 的 Hashable 实现:

extension AnyCancellable: Hashable {
    public func hash(into hasher: inout Hasher) {
        // 使用对象标识符(ObjectIdentifier)作为哈希值
        // 这确保了每个 AnyCancellable 实例都是唯一的
        hasher.combine(ObjectIdentifier(self))
    }
    
    public static func == (lhs: AnyCancellable, rhs: AnyCancellable) -> Bool {
        // 使用对象标识符比较
        return ObjectIdentifier(lhs) == ObjectIdentifier(rhs)
    }
}

为什么 Set 可以自动去重:

// 每个 AnyCancellable 实例都有唯一的对象标识符
// 即使包装相同的 Cancellable,也是不同的 AnyCancellable 实例
let cancellable1 = publisher.sink { }
let cancellable2 = publisher.sink { }

var set = Set<AnyCancellable>()
set.insert(AnyCancellable(cancellable1))  // 插入成功
set.insert(AnyCancellable(cancellable2))  // 插入成功(不同的实例)

// 但如果尝试插入相同的 AnyCancellable:
let anyCancellable = AnyCancellable(cancellable1)
set.insert(anyCancellable)  // 插入成功
set.insert(anyCancellable)  // 插入失败(已存在)
8.2.8 常见错误与解决方案

错误1:忘记 store

// ❌ 错误:订阅立即被释放
func setupBinding() {
    $name.sink { print($0) }  // 立即释放,不会收到任何值
}

// ✅ 正确:使用 store
func setupBinding() {
    $name
        .sink { print($0) }
        .store(in: &cancellables)
}

错误2:在局部作用域中 store

// ❌ 错误:函数返回后 Set 被释放
func loadData() {
    var cancellables = Set<AnyCancellable>()
    API.fetchData()
        .sink { }
        .store(in: &cancellables)
    // 函数返回后,cancellables 被释放,订阅被取消
}

// ✅ 正确:使用实例属性
class ViewModel {
    private var cancellables = Set<AnyCancellable>()
    
    func loadData() {
        API.fetchData()
            .sink { }
            .store(in: &cancellables)
    }
}

错误3:循环引用导致无法释放

// ❌ 错误:强引用循环
class ViewModel {
    private var cancellables = Set<AnyCancellable>()
    
    func setup() {
        $data.sink { [self] value in  // 强引用 self
            self.process(value)
        }
        .store(in: &cancellables)
        // self → cancellables → AnyCancellable → 闭包 → self(循环)
    }
}

// ✅ 正确:使用 weak self
class ViewModel {
    private var cancellables = Set<AnyCancellable>()
    
    func setup() {
        $data.sink { [weak self] value in  // 弱引用
            self?.process(value)
        }
        .store(in: &cancellables)
    }
}

8.3 避免循环引用

// 在 sink 里用到 self 时用 [weak self],避免 self → cancellables → 闭包 → self 的循环
class ViewModel {
    @Published var data: String = ""
    
    func setup() {
        $data
            .sink { [weak self] value in
                self?.process(value)
            }
            .store(in: &cancellables)
    }
    
    private func process(_ value: String) {
        // 处理数据
    }
    
    private var cancellables = Set<AnyCancellable>()
}

9. 实际应用场景

9.1 网络请求

// 使用 dataTaskPublisher 将请求转为 Publisher,再 map/decode 成模型
struct API {
    static func fetchUser(id: Int) -> AnyPublisher<User, Error> {
        let url = URL(string: "https://api.example.com/users/\(id)")!
        
        return URLSession.shared.dataTaskPublisher(for: url)
            .map(\.data)
            .decode(type: User.self, decoder: JSONDecoder())
            .eraseToAnyPublisher()
    }
}

API.fetchUser(id: 1)
    .receive(on: DispatchQueue.main)  // 回到主线程再更新 UI
    .sink(
        receiveCompletion: { completion in
            if case .failure(let error) = completion {
                print("错误: \(error)")
            }
        },
        receiveValue: { user in
            print("用户: \(user)")
        }
    )
    .store(in: &cancellables)

9.2 用户输入处理

// 搜索框:防抖 + 去重 + 非空过滤 + flatMap 发请求,结果用 assign 写回 @Published
class SearchViewModel: ObservableObject {
    @Published var searchText: String = ""
    @Published var results: [String] = []
    
    private var cancellables = Set<AnyCancellable>()
    
    init() {
        $searchText
            .debounce(for: .milliseconds(500), scheduler: RunLoop.main)
            .removeDuplicates()
            .filter { !$0.isEmpty }
            .flatMap { query -> AnyPublisher<[String], Never> in
                return self.search(query: query)
                    .catch { _ in Just([]) }  // 失败时给空数组,保持 Never
                    .eraseToAnyPublisher()
            }
            .assign(to: \.results, on: self)
            .store(in: &cancellables)
    }
    
    private func search(query: String) -> AnyPublisher<[String], Error> {
        return Just(["结果1", "结果2"])
            .setFailureType(to: Error.self)
            .eraseToAnyPublisher()
    }
}

9.3 组合多个数据源

// Zip 等两个请求都完成后再一起处理,适合「同时拉用户与帖子」再更新 UI
class DashboardViewModel: ObservableObject {
    @Published var user: User?
    @Published var posts: [Post] = []
    @Published var isLoading: Bool = false
    
    private var cancellables = Set<AnyCancellable>()
    
    func loadData() {
        isLoading = true
        
        let userPublisher = API.fetchUser(id: 1)
        let postsPublisher = API.fetchPosts()
        
        Publishers.Zip(userPublisher, postsPublisher)
            .receive(on: DispatchQueue.main)
            .sink(
                receiveCompletion: { [weak self] completion in
                    self?.isLoading = false
                    if case .failure(let error) = completion {
                        print("错误: \(error)")
                    }
                },
                receiveValue: { [weak self] user, posts in
                    self?.user = user
                    self?.posts = posts
                }
            )
            .store(in: &cancellables)
    }
}

10. 更多使用案例

10.1 表单验证(多字段实时校验)

// 用 map 生成错误文案 / 是否有效,assign 到 @Published,实现实时校验
class FormViewModel: ObservableObject {
    @Published var username: String = ""
    @Published var password: String = ""
    @Published var confirmPassword: String = ""
    @Published var isFormValid: Bool = false
    @Published var usernameError: String?
    @Published var passwordError: String?

    private var cancellables = Set<AnyCancellable>()

    init() {
        // 用户名:非空 + 长度,错误信息写回 usernameError
        $username
            .map { name in
                if name.isEmpty { return "请输入用户名" }
                if name.count < 3 { return "至少 3 个字符" }
                return nil
            }
            .assign(to: \.usernameError, on: self)
            .store(in: &cancellables)

        // 三字段 combineLatest,任一变化都重新计算表单是否有效
        Publishers.CombineLatest3($username, $password, $confirmPassword)
            .map { name, pwd, confirm in
                if name.isEmpty || pwd.isEmpty { return false }
                if pwd != confirm { return false }
                if pwd.count < 6 { return false }
                return true
            }
            .assign(to: \.isFormValid, on: self)
            .store(in: &cancellables)
    }
}

10.2 NotificationCenter 转 Publisher

// 系统通知转成 Publisher,再 map 出需要的 payload(如键盘 frame)
let keyboardWillShow = NotificationCenter.default.publisher(for: UIResponder.keyboardWillShowNotification)
    .map { notification in
        (notification.userInfo?[UIResponder.keyboardFrameEndUserInfoKey] as? CGRect) ?? .zero
    }
    .receive(on: DispatchQueue.main)

keyboardWillShow
    .sink { frame in
        print("键盘高度: \(frame.height)")
    }
    .store(in: &cancellables)

// 自定义通知名同样用 publisher(for:)
extension Notification.Name {
    static let myCustomEvent = Notification.Name("MyCustomEvent")
}
let customPublisher = NotificationCenter.default.publisher(for: .myCustomEvent)

10.3 Timer 与周期任务

// Timer.publish + autoconnect:按间隔持续发当前日期,需手动 cancel 停止
let timerPublisher = Timer.publish(every: 1.0, on: .main, in: .common)
    .autoconnect()
    .sink { date in
        print("tick: \(date)")
    }
// 5 秒后断开
DispatchQueue.main.asyncAfter(deadline: .now() + 5) {
    timerPublisher.cancel()
}

// 或用 delay + flatMap 递归实现「间隔重复任务」
func repeatingTask(interval: TimeInterval) -> AnyPublisher<Date, Never> {
    Just(Date())
        .delay(for: .seconds(interval), scheduler: DispatchQueue.main)
        .flatMap { _ in repeatingTask(interval: interval) }
        .eraseToAnyPublisher()
}

10.4 SwiftUI 与 @Published 深度绑定

// @Published 变化时同步到 UserDefaults;dropFirst 避免 init 时的初始值触发写入
class SettingsViewModel: ObservableObject {
    @Published var isDarkMode: Bool = false
    @Published var fontSize: Double = 14

    private var cancellables = Set<AnyCancellable>()

    init() {
        $isDarkMode
            .dropFirst()
            .sink { UserDefaults.standard.set($0, forKey: "darkMode") }
            .store(in: &cancellables)

        $fontSize
            .dropFirst()
            .debounce(for: .milliseconds(300), scheduler: RunLoop.main)
            .sink { UserDefaults.standard.set($0, forKey: "fontSize") }
            .store(in: &cancellables)
    }
}

// SwiftUI 通过 @ObservedObject 与 $ 绑定,自动刷新
struct SettingsView: View {
    @ObservedObject var viewModel: SettingsViewModel
    var body: some View {
        Toggle("深色模式", isOn: $viewModel.isDarkMode)
        Slider(value: $viewModel.fontSize, in: 10...24)
    }
}

10.5 多源竞速(先到先用)

// 主源失败时用 catch 切到备用源,实现主/备切换
func loadFromPrimaryOrFallback() -> AnyPublisher<Data, Error> {
    let primary = URLSession.shared.dataTaskPublisher(for: primaryURL)
        .map(\.data)
        .mapError { $0 as Error }
    let fallback = URLSession.shared.dataTaskPublisher(for: fallbackURL)
        .map(\.data)
        .mapError { $0 as Error }

    return primary
        .catch { _ in fallback }
        .eraseToAnyPublisher()
}

// 显式 race:merge 后取 first(),即「谁先完成用谁」
extension Publishers {
    static func race<A: Publisher, B: Publisher>(_ a: A, _ b: B) -> AnyPublisher<A.Output, A.Failure>
    where A.Output == B.Output, A.Failure == B.Failure {
        a.merge(with: b)
            .first()
            .eraseToAnyPublisher()
    }
}

10.6 KVO 替代(观察对象属性)

// NSObject + @objc dynamic 可用 .publisher(for:options:) 转成 Combine 流,替代 KVO
class Person: NSObject {
    @objc dynamic var name: String = ""
}

let person = Person()
let namePublisher = person.publisher(for: \.name, options: [.initial, .new])
    .compactMap { $0 as? String }
    .sink { print("name: \($0)") }

person.name = "张三"  // 输出: name: 张三

10.7 请求重试与超时

// timeout:超时未完成则发失败;retry + catch 实现重试与最终兜底
URLSession.shared.dataTaskPublisher(for: url)
    .timeout(.seconds(10), scheduler: DispatchQueue.main)
    .retry(3)
    .map(\.data)
    .decode(type: User.self, decoder: JSONDecoder())
    .catch { error -> Just<User> in
        return Just(User.placeholder)
    }
    .receive(on: DispatchQueue.main)
    .sink(
        receiveCompletion: { _ in },
        receiveValue: { user in
            // 更新 UI
        }
    )
    .store(in: &cancellables)

10.8 节流与防抖组合(搜索 + 连续点击)

// 搜索:防抖,避免每次按键都请求;失败时用 catch 给空数组
$searchText
    .debounce(for: .milliseconds(400), scheduler: RunLoop.main)
    .removeDuplicates()
    .flatMap { query in
        searchAPI(query: query).catch { _ in Just([]) }.eraseToAnyPublisher()
    }
    .receive(on: DispatchQueue.main)
    .assign(to: \.results, on: self)
    .store(in: &cancellables)

// 按钮:节流 1 秒内只响应一次,防止重复提交
buttonTapPublisher
    .throttle(for: .seconds(1), scheduler: DispatchQueue.main, latest: false)
    .sink { submit() }
    .store(in: &cancellables)

04-研究优秀开源框架@UI布局@iOS | SwiftUI 布局:从使用到原理解析与编程思想

本文以严格论证的方式系统介绍 SwiftUI 的布局体系:设计哲学、声明式语法与核心容器(Stack、Frame、padding、alignment、Spacer 等)、布局流程中的提议(Proposal)与响应(Response)机制、iOS 16+ 的 Layout 协议与自定义布局,以及与 Auto Layout / Frame 的对比;文末提炼 SwiftUI 布局中所蕴含的设计模式编程思想,形成可复用的知识体系。内容参考 Apple 官方文档与 WWDC 技术 session。


目录


一、SwiftUI 布局概述与设计哲学

1.1 定位与历史

SwiftUI 是 Apple 于 2019 年推出的声明式 UI 框架,随 iOS 13 / macOS 10.15 发布。其布局系统不再基于 Auto Layout 的约束,而是基于视图树 + 父向子传递提议、子向父返回尺寸与位置的“协商”模型,最终由系统在底层将结果映射为渲染所需的 frame(或等价表示)。

  • 声明式:开发者描述“视图是什么、如何组合”,而非“如何设置 frame 或约束”;布局由框架根据视图树与修饰符推导。
  • 单一数据源:视图由状态驱动;状态变化触发视图树更新,布局随之重算,无需手写 layoutSubviews 或更新约束。

1.2 核心思想:提议与响应

SwiftUI 的布局可抽象为两阶段:

  1. 父 → 子:提议(Proposal)
    父视图向子视图提供一个提议尺寸(如“可用空间是 300×200”“请给出你的理想尺寸”),即 LayoutProposal 或等价概念(不同版本 API 名称可能不同)。

  2. 子 → 父:响应(Response)
    子视图根据提议返回自己的尺寸(以及可选的对齐锚点等);父视图根据所有子视图的响应,决定子视图的位置与自身尺寸,并可能再次上报给更上层。

因此,布局是自上而下提议、自下而上响应的递归过程;最终每个视图获得一个在父坐标系中的位置与尺寸,用于渲染。这与 Auto Layout 的“全局约束求解”不同,也与 Frame 的“直接赋值”不同。

1.3 与 Auto Layout 的关系

在 Apple 的实现中,SwiftUI 视图在底层仍会映射为 UIKit/AppKit 的视图或图层;部分场景下会生成约束或等价几何,但对开发者不可见。开发者只需面对 SwiftUI 的声明式 API;理解“提议与响应”即可推理布局行为,无需关心底层是否使用约束。


二、SwiftUI 布局使用详解

2.1 容器与堆叠:VStack、HStack、ZStack

  • VStack:垂直排列子视图;可指定 alignment(如 .leading、.center)、spacing
  • HStack:水平排列子视图;同样支持 alignment 与 spacing。
  • ZStack:重叠排列(类似图层叠加);可指定 alignment 与层叠顺序。

子视图的尺寸由自身内容与约束(如 frame、fixedSize)决定;容器根据子视图的尺寸与 spacing 计算自身尺寸,并在可用空间内对齐。

VStack(alignment: .leading, spacing: 8) {
    Text("Title")
    Text("Subtitle")
}

2.2 Frame 与尺寸修饰符

  • frame(width:height:alignment:)
    指定视图的建议尺寸或固定尺寸。例如 frame(width: 100, height: 50) 表示希望该视图占 100×50;若子视图有更大内在需求,可能被裁剪或与布局行为结合(取决于具体约束)。

  • frame(minWidth:idealWidth:maxWidth:minHeight:idealHeight:maxHeight:alignment:)
    提供最小/理想/最大宽高,布局系统在可用空间内在此范围内选择。

  • fixedSize()
    视图“理想尺寸”优先,不受父视图提议的压缩;等价于强烈表达内在尺寸,可能导致溢出或需要滚动。

2.3 Padding 与 Spacer

  • padding(_:)
    在视图四周增加内边距;布局时视为该视图需要“额外空间”,父视图会为其预留。

  • Spacer()
    在 Stack 中占据剩余空间,将其他子视图推向一侧或两端;最小尺寸为 0,会随可用空间伸缩。

2.4 对齐与 alignment

  • alignment 在 Stack 中决定子视图在交叉轴上的对齐方式(如 VStack 中为水平方向)。
  • alignmentGuide
    可自定义视图的“对齐基准”(如让文字按基线对齐),供父视图在对齐时使用。

2.5 安全区域与边距

  • safeAreaInsetignoresSafeArea
    控制内容是否延伸进安全区(刘海、Home Indicator 等);布局时安全区会影响可用空间。

2.6 列表与滚动

  • ListScrollView
    内容可滚动;内部子视图的布局仍遵循提议-响应,但容器会提供“可滚动区域”的尺寸与内容尺寸,驱动滚动视图的 contentSize 与偏移。

2.7 GeometryReader 与几何信息

  • GeometryReader
    在布局时向子视图提供父视图给出的提议空间的尺寸与局部坐标信息(GeometryProxy:size、safeAreaInsets 等)。子视图可根据这些信息决定自身布局;注意 GeometryReader 会尽可能占据父视图提供的全部空间(表现为“贪婪”),常需配合 frame 限制其尺寸。几何信息是自上而下在布局阶段传递的,与“提议→响应”一致。

2.8 提议类型(Proposal)简述

系统在布局时使用的提议通常包含多种“意图”:

  • 未指定(unspecified):子视图可返回任意合理尺寸。
  • 固定尺寸:父视图要求子视图占满给定宽高。
  • 最小/最大:在范围内由子视图选择;与 frame(minWidth:maxWidth:...) 等修饰符对应。

子视图的 sizeThatFits(proposal:)(或等价 API)根据提议返回尺寸;容器再根据子视图的响应进行摆放。理解提议类型有助于正确实现自定义 Layout 与预测系统容器行为。


三、SwiftUI 布局原理解析

3.1 布局流程(提议与响应)的递归

形式化地,设父视图为 (P),子视图为 (C_1, \ldots, C_n):

  1. (P) 根据自身获得的父级提议与自身约束,计算可分配给子视图的空间
  2. (P) 向每个 (C_i) 发送提议(如可用空间或未指定)。
  3. 每个 (C_i) 返回尺寸(及可选对齐信息)。
  4. (P) 根据子视图的尺寸与 spacing、alignment,计算每个 (C_i) 的位置与 (P) 的总尺寸
  5. (P) 将自身总尺寸作为响应返回给其父视图。

根视图(如 Window 的根 ContentView)获得的提议通常来自窗口/屏幕的可用区域;最终递归完成后,每个视图都有确定的位置与尺寸,用于渲染。

3.2 Layout 协议(iOS 16+)

iOS 16 引入 Layout 协议,允许开发者自定义布局容器,显式参与“提议-响应”流程:

  • sizeThatFits(proposal:subviews:cache:)
    根据提议与子视图的尺寸,返回容器自身尺寸。内部需对每个子视图调用 subview.sizeThatFits(proposal) 获取其尺寸,再按自定义规则汇总。

  • placeSubviews(in:proposal:subviews:cache:)
    在给定 bounds 内,为每个子视图指定位置(通过 subview.place(at:anchor:proposal:))。位置与尺寸需与 sizeThatFits 阶段的逻辑一致,否则会出现布局错位。

示例(水平均分三列):容器收到提议后,将宽度均分给三个子视图,分别用固定宽度提议询问子视图高度,取最大高度作为容器高度;在 placeSubviews 中按三列放置,垂直居中。这体现了“先问尺寸、再放位置”的两阶段一致性。

3.3 视图树与值类型

SwiftUI 的 View 是值类型;视图树由 body 的递归求值构成,每次状态变化可能产生新的视图树。布局系统对当前视图树执行提议-响应,因此布局是纯函数式的:相同视图树与相同提议得到相同布局结果,无隐式全局状态(与 Auto Layout 的全局约束池不同)。

3.4 PreferenceKey 与自下而上的几何传递

除“父→子提议、子→父尺寸”外,SwiftUI 提供 PreferenceKey:子视图可向上传递任意值(如自身尺寸、偏移),父视图通过 .onPreferenceChangebackground(GeometryReader { ... }) 等读取。这实现了自下而上的几何信息回传,常用于“根据子视图尺寸调整父视图”或实现依赖子视图尺寸的滚动、标注等,与布局阶段的“响应”互补。


四、与 Auto Layout / Frame 的对比

维度 Frame Auto Layout SwiftUI
表达方式 命令式赋值 声明式约束 声明式视图树 + 修饰符
计算方式 手写计算 约束求解(Cassowary) 提议-响应递归
适配 手写 约束随容器变化 提议随空间与状态变化
平台 UIKit/AppKit UIKit/AppKit SwiftUI(底层可桥接 UIKit)

SwiftUI 与 Auto Layout 都属“声明式”,但 SwiftUI 不暴露约束概念,而是通过容器 + 修饰符 + 提议-响应表达布局,更贴近“从外到内分配空间、从内到外汇报尺寸”的直觉,适合声明式 UI 的组件化与组合。


五、设计模式与编程思想提炼

5.1 设计模式

模式 体现
组合模式 视图树是“组合”结构:容器(VStack/HStack)与叶子(Text/Image)统一为 View 协议;容器对子视图执行布局,与 Masonry 的“单条与复合同一接口”思想一致。
策略模式 不同容器(VStack、HStack、自定义 Layout)是不同的布局策略;同一组子视图在不同容器中呈现不同排列。
模板方法 布局流程由框架定义(提议 → 子响应 → 放置);Layout 协议的 sizeThatFitsplaceSubviews 是子类/实现类填充的“步骤”。
单一数据源 视图由状态驱动;布局由当前视图树与提议唯一决定,无二次手写 frame 或约束,避免状态不一致。

5.2 编程思想

思想 体现
声明式 描述“是什么”而非“怎么做”;布局意图通过容器与修饰符表达,由框架执行。
组合优于继承 复杂界面由简单视图与容器组合而成,而非通过继承重写 layoutSubviews。
单向数据流 状态 → 视图树 → 布局 → 渲染;布局是状态的派生,无反向“布局写回状态”(除显式回调)。
可组合性 小视图组合成大视图,布局规则随组合自然形成;与 Auto Layout 的“约束可组合”异曲同工。

5.3 思维导图

mindmap
  root((SwiftUI 布局))
    使用
      VStack HStack ZStack
      frame padding Spacer
      alignment safeArea
    原理
      提议 父向子提供空间
      响应 子向父回报尺寸
      Layout 协议 自定义容器
    设计模式
      组合 视图树 容器与叶子
      策略 不同布局策略
      模板方法 sizeThatFits placeSubviews
    编程思想
      声明式 描述是什么
      组合优于继承
      单向数据流

5.4 可复用设计清单(按“想实现什么”选模式)

目标 推荐模式/思想 说明
统一处理容器与叶子视图的布局 组合模式 容器与叶子都遵从 View;容器负责向子视图提议并放置,与 Masonry 的“单条与复合同一接口”思想一致。
支持多种排列方式(竖排、横排、网格等) 策略模式 不同布局容器(VStack、HStack、自定义 Layout)即不同策略;同一组子视图换容器即换布局。
在系统布局流程中插入自定义规则 模板方法 实现 Layout 协议的 sizeThatFits 与 placeSubviews,在框架规定的两阶段中填入自己的逻辑。
布局结果由状态唯一决定、可复现 单一数据源 视图树由状态派生,布局由视图树与提议唯一决定;不手写 frame,避免双源。
子视图尺寸/位置影响父视图决策 PreferenceKey + 自下而上传递 布局阶段外的“几何回传”,用于依赖子尺寸的父级逻辑。

5.5 小结

  • SwiftUI 布局:基于提议-响应的递归,由容器与修饰符表达意图;iOS 16+ 的 Layout 协议支持自定义布局容器;GeometryReader、PreferenceKey 提供几何信息与自下而上传递。
  • 与 Auto Layout / Frame:SwiftUI 同属声明式,但以“空间分配与尺寸回报”替代“约束求解”;与 Frame 的“直接赋值”差异更大。
  • 设计模式:组合(视图树)、策略(布局策略)、模板方法(Layout 协议)、单一数据源(状态驱动布局)。
  • 编程思想:声明式、组合优于继承、单向数据流、可组合性。理解这些有助于在 SwiftUI 中正确使用与扩展布局,并在自研声明式 UI 中复用上述思想。

参考文献

[1] Apple. SwiftUI Documentation. Developer Documentation.
[2] Apple. Layout and presentation. WWDC / SwiftUI sessions.
[3] Apple. Creating custom layouts with Layout protocol. iOS 16+ Developer Documentation.
[4] 本系列《06-Auto Layout与Frame:原理、使用与编程思想》— 传统布局体系对比。
[5] 本系列《05-Masonry框架:从使用到源码解析》《04-SnapKit框架:从使用到源码解析》— Auto Layout DSL 与编程思想。


延伸阅读

  • Auto Layout 与 Frame:本系列《06-Auto Layout与Frame:原理、使用与编程思想》— 传统两套布局体系与编程思想对照。
  • Masonry / SnapKit:本系列《05-Masonry框架》《04-SnapKit框架》— 约束 DSL 与组合、工厂、流式接口等模式在布局中的体现。

文档版本:基于 SwiftUI 公开 API 与 Apple 技术文档整理,具体行为以当前系统版本为准。

03-研究优秀开源框架@UI布局@iOS | Auto Layout 与 Frame:原理、使用与编程思想

本文以严格论证的方式系统介绍 iOS/macOS 下的两套核心布局体系:Frame 布局(基于几何矩形与手动计算)与 Auto Layout(基于约束与 Cassowary 求解)。涵盖历史演进、数学与系统原理、API 使用、适用场景对比,并在文末提炼布局系统中所蕴含的设计模式编程思想,形成可复用的知识体系。内容参考 Apple 官方文档、Cassowary 论文及业界实践。


目录


一、布局问题的形式化与两套体系的定位

1.1 布局问题在 UI 中的抽象

在图形界面中,布局(Layout) 指在给定容器与子元素的前提下,确定每个子元素在屏幕上的位置与尺寸,使界面满足设计意图且能适配不同屏幕与方向。形式化地,可表述为:

  • 输入:视图树(父子关系)、设计约束(如“按钮居中”“列表填满”)、可用空间(如 safe area、窗口大小)。
  • 输出:每个视图的 frame(或等价几何描述),即 ( (x, y, width, height) ) 或 CGRect。

因此,无论采用何种布局体系,最终落地的仍是每个视图的 frame;差异在于“由谁、以何种规则”计算这些 frame。

1.2 两套体系的核心区分

维度 Frame 布局 Auto Layout
决策主体 开发者显式设置或计算每个视图的 frame(或 bounds/center)。 开发者声明约束(线性等式/不等式),由系统求解器计算满足约束的 frame。
数学本质 直接赋值;无全局方程组。 约束系统 → 线性方程组(Cassowary)→ 求唯一解或按优先级松弛。
适配方式 需手写逻辑(如根据 superview.bounds 计算子 view 的 frame)。 通过约束关系与优先级自动随容器与内在尺寸变化而重算。
典型 API view.frame = CGRect(...)view.boundsview.center NSLayoutConstraint、约束激活、Content Hugging / Compression Resistance。

结论:Frame 是“命令式、一次一视图”的几何赋值;Auto Layout 是“声明式、全局约束”的求解。二者可并存(同一 app 中不同视图用不同方式),但同一视图不应混用(若使用 Auto Layout,则不应再直接改其 frame,应由约束驱动)。


二、Frame 布局体系详解

2.1 历史与定位

在 Auto Layout 引入之前,iOS/macOS 应用普遍采用 Frame 布局:通过设置 UIView.frame(或 boundscenter)直接指定视图在父视图坐标系中的位置与大小。其思想来源于早期桌面与移动 GUI 的“绝对/相对坐标”模型,与 Cocoa 的视图层级(view hierarchy)紧密相关。

  • 坐标系:每个视图拥有自己的 bounds(以自身为原点的矩形)和在其父视图坐标系中的 frame。子视图的 frame 是相对于父视图的 bounds 的。
  • 布局时机:开发者通常在 layoutSubviews(或 viewDidLayoutSubviews)中根据当前 bounds 计算并设置子视图的 frame,或直接在业务逻辑中赋值。

2.2 核心概念与 API

2.2.1 frame、bounds、center

  • frame:视图在父视图坐标系中的矩形(origin + size);修改 frame 会改变视图在父视图中的位置与大小。
  • bounds:视图自身坐标系中的矩形,通常 origin 为 (0,0),size 与 frame.size 一致;修改 bounds 可做滚动、缩放等(如 UIScrollView 的 contentSize 通过 bounds 等概念体现)。
  • center:视图在父视图坐标系中的中心点;与 frame 等价描述,满足 center = frame.origin + (frame.size.width/2, frame.size.height/2)

关系式(以 CGRect 表示):

[ \text{frame.origin} = \text{center} - (\text{frame.size.width}/2,\ \text{frame.size.height}/2) ]

因此指定 frame 与指定 center + size 在信息上等价;不同 API 仅便于不同表达意图。

2.2.2 布局流程中的参与时机

在 UIKit/AppKit 中,与 Frame 布局相关的关键调用链包括:

  1. setNeedsLayout / layoutIfNeeded:标记需要重新布局或立即触发布局。
  2. layoutSubviews(子类重写):在此处根据当前视图的 bounds 计算并设置子视图的 frame。
  3. viewDidLayoutSubviews(控制器):布局已完成后回调,可在此做依赖 frame 的后续逻辑。

伪代码(典型 Frame 布局子类)

override func layoutSubviews() {
    super.layoutSubviews()
    let w = bounds.width
    let h = bounds.height
    // 例如:左侧 1/3 放 label,右侧 2/3 放 button
    label.frame = CGRect(x: 0, y: 0, width: w / 3, height: h)
    button.frame = CGRect(x: w / 3, y: 0, width: 2 * w / 3, height: h)
}

2.3 坐标系统与变换

  • 坐标系:父视图的 bounds 决定其坐标空间;子视图的 frame 在该空间中定义。根视图(如 UIWindow 的 rootViewController.view)的 frame 通常与 window 的 bounds 一致(除状态栏等)。
  • 变换transform(如旋转、缩放)不改变 frame 的“逻辑”含义,但改变渲染形状;布局时若依赖 frame,需注意 transform 对 hitTesting 与布局计算的影响。Auto Layout 与 transform 可共存,但约束描述的是“未变换”的几何。

2.4 优点与局限(严格论证)

优点

  • 可预测性:每帧的几何由当前代码唯一决定,无隐式求解,便于推理与调试。
  • 性能:无约束求解与迭代,仅算术与赋值,适合对性能敏感的列表或动画。
  • 完全控制:可实现任意自定义布局逻辑(如环形排布、不规则网格)。

局限

  • 适配成本:不同屏幕尺寸、方向、安全区、动态类型需手写分支,易遗漏或重复。
  • 可维护性:复杂界面中“谁在何时改了什么 frame”难以追踪,易产生耦合。
  • 与系统特性脱节:无法直接利用 Content Hugging / Compression Resistance、约束优先级等,需自行实现等价逻辑。

因此,Frame 布局更适合:布局规则简单、对性能要求高、或需完全自定义几何的场景;复杂、多适配的 UI 更推荐 Auto Layout 或上层 DSL(如 Masonry/SnapKit)。


三、Auto Layout 约束布局体系详解

3.1 历史与理论基础

Auto Layout 于 2011 年在 macOS Lion 引入,iOS 6 起支持;其数学基础是 Cassowary 约束求解算法(Badros et al., UIST 1997)。核心思想:将“布局意图”表述为关于几何变量的线性等式与不等式,由求解器在满足约束层次(优先级)的前提下,得到唯一确定的 frame。

3.1.1 约束的线性形式

设视图 (V) 的几何变量为 (x, y, w, h)(如 left, top, width, height)。一条约束可写为:

  • 等式:( a_1 x_1 + a_2 x_2 + \cdots = b )
  • 不等式:( a_1 x_1 + a_2 x_2 + \cdots \leq b ) 或 (\geq b)

例如:“视图 A 的左边 = 视图 B 的右边 + 8”即 ( A.\text{left} = B.\text{right} + 8);“视图宽度 = 100”即 (w = 100)。系统将整套约束表示为线性方程组(或带不等式与松弛变量),由 Cassowary 增量求解,得到每个变量的值,进而得到各视图的 frame。

松弛变量(Slack Variables)与可行性:不等式约束在求解时常引入松弛变量,将 (\leq) 转为等式参与单纯形法;Cassowary 通过对偶单纯形在约束层次下最小化违反量。当 Required 约束无法同时满足时系统无解,会报错;非 Required 约束在冲突时被松弛,保证解的存在性。这一数学性质保证了“优先级 + 松弛”的语义与实现一致性。

3.1.2 约束层次(Constraint Hierarchy)

Cassowary 支持强弱约束:高优先级约束必须满足,低优先级在冲突时可被松弛(违反),从而避免无解。Apple 将优先级映射为 UILayoutPriority(0–1000);Required(1000)必须满足,其余为可选,冲突时低优先级被打破。

3.1.3 增量求解与布局传递

约束系统支持增量更新:增删或修改约束后,求解器仅重新求解受影响部分,而非全量重算,适合交互式 UI(窗口缩放、动画中更新 constant)。布局时,引擎先求解根视图的约束,再向下传递尺寸与位置,最终各视图的 frame 被写入;layoutSubviews 在此时被调用,但 Auto Layout 管理的子视图 frame 已由引擎设置。

3.2 核心概念与 API

3.2.1 约束的组成

一条约束可抽象为五元组(及扩展):

  • Item1, Attribute1:第一个对象与属性(如 view.left)。
  • Relation:Equal / LessThanOrEqual / GreaterThanOrEqual。
  • Item2, Attribute2:第二个对象与属性(可为 nil,表示与常量比较)。
  • Multiplier, Constant:线性关系中的系数与常数,即 ( \text{attr1} = \text{attr2} \times \text{multiplier} + \text{constant} )。

系统 API 示例(Swift):

NSLayoutConstraint(
    item: subview,
    attribute: .left,
    relatedBy: .equal,
    toItem: superview,
    attribute: .left,
    multiplier: 1,
    constant: 20
)

表示:subview.left = superview.left × 1 + 20。

3.2.2 内在尺寸(Intrinsic Content Size)与 CHCR

部分视图(如 UILabel、UIButton)有内在尺寸:根据内容(文字、图片)可计算出“理想”宽高。布局引擎将内在尺寸视为一组约束参与求解;Content Hugging(抗拉伸)与 Compression Resistance(抗压缩)的优先级决定在空间不足或过剩时,视图是否愿意被压缩或拉大。二者与显式约束共同决定最终 frame。

3.2.3 布局流程中的参与时机

  1. 约束被激活(isActive = true)后加入引擎。
  2. 当视图需要布局时(如 bounds 变化、约束变化),引擎重新求解约束系统,得到新 frame。
  3. 视图的 layoutSubviews 仍会被调用,但子视图的 frame 由引擎写入,开发者通常不再在 layoutSubviews 中改子视图 frame(否则与约束冲突)。

因此,使用 Auto Layout 时,约束是唯一真实来源;直接改 frame 会被后续布局覆盖,不推荐。

3.3 make / remake / update 的语义(与 Masonry/SnapKit 一致)

在使用 DSL(如 Masonry/SnapKit)时,常见三种入口:

  • make:追加约束,不移除已有约束。
  • remake:先移除该视图上由 DSL 管理的约束,再按闭包重新添加。
  • update:仅更新已存在约束的 constant(或 multiplier/priority),不增删约束条数。

系统原生 API 中对应为:添加新约束(activate)、移除约束(deactivate)、修改 constraint.constant。理解三者差异有助于正确选用,避免约束重复或遗漏。

3.4 安全区与布局边距

  • Safe Area:iOS 11+ 引入 safeAreaLayoutGuide,约束可相对于安全区(避开刘海、Home Indicator 等)而非视图边。将子视图约束到 view.safeAreaLayoutGuide 可自动适配不同设备与方向。
  • Layout MarginslayoutMarginsGuide 提供可配置的内边距参考,约束可相对于 margins 以统一留白;与 safe area 结合可表达“在安全区内再留 margin”的语义。

3.5 约束冲突与调试

当约束过多或相互矛盾时,引擎按优先级从高到低尝试满足;无法同时满足时,低优先级约束被打破,并在控制台报错(或 Xcode 中标红)。调试时可为约束设置 identifier,便于在报错与约束列表中定位。Ambiguous Layout 表示约束不足,存在多解,引擎会选其一但行为不可依赖,需补全约束。


四、Frame 与 Auto Layout 的对比与选型

维度 Frame Auto Layout
表达方式 命令式,直接赋值几何 声明式,声明关系与常数
适配 手写逻辑 约束随容器与内在尺寸自动重算
性能 无求解开销 有求解与布局传递开销
复杂度 简单界面简单,复杂界面易失控 简单界面略重,复杂界面更清晰
与系统集成 需手动处理安全区、CHCR 等 安全区、CHCR、优先级等原生支持

选型建议

  • 以 Auto Layout 为主:常规 UI、多尺寸适配、与 IB 与 SwiftUI 混用场景。
  • 以 Frame 为辅:列表 cell 内高度计算、自定义绘制视图、对性能极敏感的路径。
  • 同一视图不混用:一旦使用 Auto Layout 管理某视图,则不再直接改其 frame,由约束驱动。

五、设计模式与编程思想提炼

5.1 布局系统中的设计模式

模式 体现 说明
策略模式 Frame 与 Auto Layout 是两种不同的“布局策略”;同一视图树可选用不同策略(不同子视图用不同方式)。 将“如何计算 frame”从“何时触发布局”中分离,便于扩展新布局策略(如 SwiftUI 的布局协议)。
模板方法 layoutSubviews 是布局流程中的“钩子”;子类重写以插入自定义布局逻辑(Frame),或依赖系统在 Auto Layout 中写入 frame。 框架定义布局流程骨架,子类或系统填充具体步骤。
观察者与响应链 bounds 变化、约束变化会触发 setNeedsLayout → layoutIfNeeded → layoutSubviews;约束激活/失效会通知引擎。 变更驱动重算,避免轮询。
单一数据源 Auto Layout 中约束是 frame 的唯一真实来源;直接改 frame 与约束冲突,违背单一数据源。 减少状态不一致与难以复现的 bug。

5.2 编程思想

思想 体现
声明式 vs 命令式 Auto Layout 声明“关系与常数”,由引擎求解;Frame 命令式地“赋值”。声明式更利于适配与维护,命令式更直接、可控。
关注点分离 “要什么布局”(约束或计算式)与“何时、以何顺序布局”(引擎或 layoutSubviews)分离;业务代码描述意图,框架负责执行。
约束与松弛 Cassowary 的约束层次与松弛变量体现“必须满足”与“尽量满足”的层次化需求,对应到 API 即优先级与 CHCR。
可组合性 约束可独立添加、移除、激活、失效;子视图的约束与父视图的约束组合成全局系统,体现可组合设计。

5.3 思维导图:布局体系与编程思想

mindmap
  root((布局体系))
    Frame
      直接赋值 frame/bounds/center
      命令式 一次一视图
      layoutSubviews 中计算
    Auto Layout
      约束 线性等式/不等式
      Cassowary 求解
      声明式 全局一致
    设计模式
      策略 两种布局策略
      模板方法 layoutSubviews 钩子
      单一数据源 约束即真相
    编程思想
      声明式 vs 命令式
      关注点分离 意图与执行
      约束层次 优先级与松弛

5.4 可复用设计清单(按“想实现什么”选模式)

目标 推荐模式/思想 说明
支持多种布局方式并存(如部分视图用 Frame、部分用约束) 策略模式 将“如何计算 frame”抽象为策略,按视图或层级选用。
在固定流程中插入自定义布局逻辑 模板方法 重写 layoutSubviews,在系统布局流程的“钩子”中写入 frame 计算。
保证布局结果唯一、可复现 单一数据源 约束或 frame 计算为唯一真相来源,避免多处修改同一视图几何。
适配多尺寸、多设备 声明式约束 + 优先级 用约束表达关系与常数,用优先级处理冲突与可选约束。
高性能、完全自定义几何 Frame + layoutSubviews 无求解开销,逻辑完全可控。

5.5 小结

  • Frame:命令式、几何直接赋值,适合简单或高性能、强自定义场景;适配与逻辑需手写。
  • Auto Layout:声明式、约束驱动,由 Cassowary 求解;适合复杂 UI、多适配与系统特性集成。
  • 设计模式:策略(布局策略)、模板方法(layoutSubviews)、单一数据源(约束为真来源)。
  • 编程思想:声明式与命令式取舍、关注点分离、约束层次与可组合性。理解二者原理与适用边界,有助于在业务中正确选型并在自研布局库中复用上述思想。

参考文献

[1] Apple. Auto Layout Guide. Developer Documentation.
[2] Apple. View Programming Guide for iOS. Developer Documentation.
[3] Badros, G. J., Borning, A., & Marriott, K. (1997). Solving Linear Arithmetic Constraints for User Interface Applications. UIST 1997.
[4] Cassowary. Constraint Solving Toolkit. constraints.cs.washington.edu/cassowary/
[5] 本系列《05-Masonry框架:从使用到源码解析》— Auto Layout 与 Cassowary 在 DSL 中的运用。


延伸阅读

  • SwiftUI 布局:本系列《07-SwiftUI布局:从使用到原理解析与编程思想》— 声明式布局的提议-响应模型与 Layout 协议。
  • Masonry / SnapKit:本系列《05-Masonry框架》《04-SnapKit框架》— Auto Layout 的链式 DSL 与设计模式在布局 API 中的体现。

文档版本:基于 Apple 官方文档与 Cassowary 理论整理,实现细节以当前系统为准。

02-研究优秀开源框架@UI布局@iOS | SnapKit 框架:从使用到源码解析

本文系统介绍 iOS/macOS 下的 Auto Layout DSL 库 SnapKit:技术演进、核心原理、应用场景与源码结构,并引用约束求解理论与业界实践。


📋 目录


一、SnapKit 使用详解

1. 框架概述

SnapKit 是面向 Swift 的 Auto Layout DSL(领域特定语言),用于在代码中以声明式、链式语法描述视图的布局约束,替代冗长的 NSLayoutConstraint 手写与 Visual Format 字符串。其设计目标可概括为:

  • 可读性:约束意图接近自然语言(如“左边等于父视图左边”“宽度等于父视图一半”)。
  • 类型安全与简洁:利用 Swift 的类型与闭包,减少样板代码。
  • 可维护性:链式调用便于增删约束、设置优先级与标识,便于调试冲突。

SnapKit 是 Masonry(Objective-C 时代同类型库)在 Swift 生态中的继任者,二者同属 SnapKit 组织 维护,在 GitHub 上均获得大量 Star(SnapKit 约 20k+),被广泛应用于 iOS/macOS 应用的纯代码布局场景 [1]


2. 历史演进

技术演进可概括为:手写约束 → Visual Format → Masonry(OC DSL)→ SnapKit(Swift DSL),并与 Apple 布局技术的演进并行。

┌─────────────────────────────────────────────────────────────────────────┐
│                    布局方式演进(示意)                                    │
├─────────────────────────────────────────────────────────────────────────┤
│  1997       2006–2011        2011           2014           2015+        │
│  Cassowary  手写             引入           Masonry        SnapKit      │
│  算法论文    NSLayoutConstraint  Auto Layout  (OC DSL)      (Swift DSL)  │
│  发表       (Mac)             (iOS 6+)      链式语法       闭包+链式     │
└─────────────────────────────────────────────────────────────────────────┘
阶段 代表 特点
手写约束 NSLayoutConstraint(item:attribute:relatedBy:toItem:attribute:multiplier:constant:) 冗长、易出错、难以阅读。
Visual Format V:|[a]-[b]| 字符串描述,类型不安全,复杂布局难表达。
Masonry Objective-C,Block 链式 链式 DSL、可读性高,成为 OC 时代事实标准。
SnapKit Swift,Closure 链式 延续 Masonry 思想,利用 Swift 语法与类型,支持 labeled() 等调试与快捷 API。

SnapKit 与 Masonry 的对应关系可理解为:同一套“用链式 DSL 描述约束”的设计哲学,从 Objective-C 迁移到 Swift,并针对 Swift 做了 API 与实现上的优化 [2]


3. 理论基础:Auto Layout 与 Cassowary

SnapKit 的约束最终仍通过 Auto Layout 交给系统布局引擎执行。Auto Layout 的数学基础是 Cassowary 约束求解算法,理解其思想有助于理解“约束冲突”“优先级”“内在尺寸”等概念。

3.1 Cassowary 算法简述

Cassowary 是一种 增量式线性约束求解算法,基于对偶单纯形法(dual simplex),用于求解由 线性等式与不等式 组成的约束系统 [[3]][[4]]。其特点包括:

  • 线性:约束可写成形如 (a_1 x_1 + a_2 x_2 + \cdots = b) 或 (\le/\ge) 的形式,与“视图 A 的左边 = 视图 B 的右边 + 常数”等布局关系一致。
  • 增量:可动态增删约束并高效重新求解,适合交互式 UI(窗口缩放、动画中更新约束)。
  • 约束层次(constraint hierarchy):支持 requiredpreferred(优先级),在约束冲突时按优先级舍弃或松弛部分约束,避免无解。

参考文献

  • 原始论文:Solving Linear Arithmetic Constraints for User Interface Applications,UIST 1997 [[5]]。
  • 扩展与实现:The Cassowary Linear Arithmetic Constraint Solving Algorithm,ACM TOCHI;Washington 大学 Cassowary 工具包 [[6]]。

3.2 从约束描述到线性关系(概念)

Auto Layout 将每条约束映射为关于视图几何变量(如 left, right, width, centerX)的线性等式或不等式。SnapKit 所写的“左边等于父视图左边 + 20”即对应:

  • 变量:view.leftsuperview.left
  • 关系:view.left = superview.left + 20

多约束组成方程组,由 Cassowary 求解得到每个变量的值,从而得到各视图的 frame。优先级 对应 Cassowary 的强弱约束:高优先级必须满足,低优先级在冲突时可被违反。

3.3 流程图:从 SnapKit 到屏幕像素(概念层)

flowchart LR
  A[SnapKit API 调用] --> B[ConstraintMaker 等 DSL]
  B --> C[Constraint 描述对象]
  C --> D[NSLayoutConstraint]
  D --> E[Auto Layout 引擎]
  E --> F[Cassowary 求解]
  F --> G[布局结果 / frame]
  G --> H[渲染到屏幕]

4. 核心概念

4.1 约束的组成

在 Auto Layout 中,一条约束可抽象为:

Item1.Attribute1 Relation Item2.Attribute2 * Multiplier + Constant

例如:“视图 A 的右边 = 视图 B 的左边 - 8”即 A.right = B.left - 8。SnapKit 的链式 API 就是对这五元组(Item1, Attribute1, Relation, Item2, Attribute2, Multiplier, Constant)的封装,并增加 优先级(Priority)标识(Identifier) 等元数据。

4.2 优先级与内在尺寸

概念 说明
约束优先级 UILayoutPriority(0–1000),数值越大越优先;系统在冲突时打破低优先级约束。
Content Hugging “抗拉伸”:视图不愿比其内在内容尺寸更大;优先级高则更易保持紧凑。
Compression Resistance “抗压缩”:视图不愿比其内在内容尺寸更小;优先级高则更不易被压缩。

Label、Button 等有 intrinsicContentSize 的控件依赖 CHCR 与其它约束共同决定最终尺寸;SnapKit 可通过 .contentCompressionResistancePriority / .contentHuggingPriority 等设置(若 API 支持)或直接操作 UIView 的对应属性。

4.3 思维导图:SnapKit 概念关系

mindmap
  root((SnapKit))
    使用入口
      makeConstraints / remakeConstraints / updateConstraints
      removeConstraints
    描述对象
      ConstraintMaker
      ConstraintItem
      Constraint
    约束属性
      left right top bottom
      width height centerX centerY
      edges size margins
    关系与修饰
      equalTo offset multipliedBy priority
    底层
      NSLayoutConstraint
      Auto Layout / Cassowary

5. API 与使用模式

5.1 基本用法

// 示例:子视图填满父视图边距
view.addSubview(subview)
subview.snp.makeConstraints { make in
    make.edges.equalToSuperview()
}

// 等价于四条约束:left/top/right/bottom 分别等于 superview
// 示例:水平居中,宽度为父视图一半,距顶 20
subview.snp.makeConstraints { make in
    make.centerX.equalToSuperview()
    make.width.equalToSuperview().multipliedBy(0.5)
    make.top.equalToSuperview().offset(20)
}

5.2 常用 API 对照(伪代码语义)

SnapKit 写法 含义(伪代码)
make.left.equalToSuperview() self.left = superview.left
make.width.equalTo(100) self.width = 100
make.top.equalTo(other.snp.bottom).offset(8) self.top = other.bottom + 8
make.size.equalTo(CGSize(width: 80, height: 80)) self.width = 80, self.height = 80
make.edges.equalToSuperview() 四边与 superview 对齐
make.center.equalToSuperview() centerX/Y 与 superview 对齐
make.width.equalToSuperview().multipliedBy(0.5) self.width = superview.width * 0.5
make.priority(.high).priority(750) 为该条约束设置优先级

5.3 make / remake / update

  • makeConstraints:在已有约束基础上追加新约束,不删除旧约束。
  • remakeConstraints先移除该视图上由 SnapKit 管理的约束,再按闭包重新添加,适合布局整体变化。
  • updateConstraints仅更新闭包中涉及到的约束的 constant(或部分属性),不改变约束条数或关系,适合仅改“间距/常量”的动画或响应式布局。
// 伪代码:remake 的语义
func remakeConstraints(_ closure: (ConstraintMaker) -> Void) {
    removeSnapKitConstraints()
    makeConstraints(closure)
}

5.4 SnapKit 与 Masonry 对照

维度 Masonry(OC) SnapKit(Swift)
语法载体 Block ^(MASConstraintMaker *make){} Closure { make in }
链式返回 返回 MASConstraint 等 返回 ConstraintMakerExtendable 等
多属性快捷 edgessize edgessizemargins
调试 无内置标识 labeled("xxx") 设置 constraint identifier
维护 SnapKit 组织,OC 项目常用 SnapKit 组织,Swift 项目主流

6. 应用场景与最佳实践

场景 建议
纯代码 UI 用 SnapKit 替代手写 NSLayoutConstraint,可读性和维护性更好。
动态布局 remakeConstraintsupdateConstraints 配合 UIView.animate 更新 constant,实现动画。
列表 Cell prepareForReuse 中避免重复添加约束,可 remake 或复用约束并只更新 constant。
多分辨率/多设备 multipliedBy、比例、优先级与 CHCR 适配不同宽度与安全区域。
约束冲突调试 使用 labeled() 为约束设置 identifier,便于在控制台或 Xcode 中识别。

7. 使用案例详解

以下案例覆盖常见 UI 场景,便于直接套用或改编。

7.1 单视图:居中与尺寸

// 场景:一个头像视图,居中显示,固定 80x80
let avatarView = UIImageView()
view.addSubview(avatarView)
avatarView.snp.makeConstraints { make in
    make.center.equalToSuperview()
    make.size.equalTo(CGSize(width: 80, height: 80))
}
// 场景:宽度为父视图 60%,高度 44,水平居中,距顶 100
let button = UIButton(type: .system)
view.addSubview(button)
button.snp.makeConstraints { make in
    make.centerX.equalToSuperview()
    make.top.equalToSuperview().offset(100)
    make.width.equalToSuperview().multipliedBy(0.6)
    make.height.equalTo(44)
}

7.2 多视图垂直/水平排列

// 场景:标题 + 副标题垂直排列,整体居中,间距 8
let titleLabel = UILabel()
let subtitleLabel = UILabel()
view.addSubview(titleLabel)
view.addSubview(subtitleLabel)

titleLabel.snp.makeConstraints { make in
    make.centerX.equalToSuperview()
    make.top.equalToSuperview().offset(60)
}
subtitleLabel.snp.makeConstraints { make in
    make.centerX.equalTo(titleLabel)
    make.top.equalTo(titleLabel.snp.bottom).offset(8)
}
// 场景:三个等宽按钮水平排列,填满父视图左右边距,间距 12
let leftBtn = UIButton()
let midBtn = UIButton()
let rightBtn = UIButton()
[leftBtn, midBtn, rightBtn].forEach { view.addSubview($0) }

leftBtn.snp.makeConstraints { make in
    make.left.equalToSuperview().offset(16)
    make.centerY.equalToSuperview()
    make.height.equalTo(44)
}
midBtn.snp.makeConstraints { make in
    make.left.equalTo(leftBtn.snp.right).offset(12)
    make.centerY.equalTo(leftBtn)
    make.width.height.equalTo(leftBtn)
}
rightBtn.snp.makeConstraints { make in
    make.left.equalTo(midBtn.snp.right).offset(12)
    make.right.equalToSuperview().offset(-16)
    make.centerY.equalTo(midBtn)
    make.width.height.equalTo(midBtn)
}

7.3 安全区域与边距

// 场景:内容贴安全区域,四边留 16pt
let contentView = UIView()
view.addSubview(contentView)
contentView.snp.makeConstraints { make in
    make.top.equalTo(view.safeAreaLayoutGuide.snp.top).offset(16)
    make.left.equalTo(view.safeAreaLayoutGuide.snp.left).offset(16)
    make.right.equalTo(view.safeAreaLayoutGuide.snp.right).offset(-16)
    make.bottom.equalTo(view.safeAreaLayoutGuide.snp.bottom).offset(-16)
}
// 使用 edges 的等价写法(SnapKit 对 safeArea 的封装)
contentView.snp.makeConstraints { make in
    make.edges.equalTo(view.safeAreaLayoutGuide).inset(UIEdgeInsets(top: 16, left: 16, bottom: 16, right: 16))
}

7.4 卡片式布局(内边距 + 圆角容器)

// 场景:卡片内有一个标题和一段正文,整体有内边距
let card = UIView()
let titleLabel = UILabel()
let bodyLabel = UILabel()
card.addSubview(titleLabel)
card.addSubview(bodyLabel)
view.addSubview(card)

card.snp.makeConstraints { make in
    make.left.right.equalToSuperview().inset(20)
    make.top.equalToSuperview().offset(100)
    // 高度由内容撑起,不写 bottom,由子视图约束反推
}
titleLabel.snp.makeConstraints { make in
    make.top.left.right.equalToSuperview().inset(16)
}
bodyLabel.snp.makeConstraints { make in
    make.top.equalTo(titleLabel.snp.bottom).offset(8)
    make.left.right.equalToSuperview().inset(16)
    make.bottom.equalToSuperview().offset(-16)  // 决定 card 的底部
}

7.5 UIScrollView 内容布局

// 场景:ScrollView 内纵向堆叠内容,可滚动
let scrollView = UIScrollView()
let contentView = UIView()
scrollView.addSubview(contentView)
view.addSubview(scrollView)

scrollView.snp.makeConstraints { make in
    make.edges.equalToSuperview()
}
contentView.snp.makeConstraints { make in
    make.edges.equalToSuperview()
    make.width.equalTo(scrollView)  // 宽度与 scrollView 一致,避免横向滚动
    // 高度由子视图约束决定,最后子视图的 bottom 约束到 contentView.bottom
}

// 在 contentView 内继续添加子视图,最后一个子视图的 bottom 约束到 contentView
let lastView = UIView()
contentView.addSubview(lastView)
lastView.snp.makeConstraints { make in
    make.left.right.top.equalToSuperview()
    make.height.equalTo(200)
    make.bottom.equalToSuperview().offset(-20)  // 关键:撑开 contentView 高度
}

7.6 TableView Cell 内约束

// 在 UITableViewCell 子类中
override init(style: UITableViewCell.CellStyle, reuseIdentifier: String?) {
    super.init(style: style, reuseIdentifier: reuseIdentifier)
    contentView.addSubview(titleLabel)
    contentView.addSubview(iconView)

    titleLabel.snp.makeConstraints { make in
        make.left.equalToSuperview().offset(16)
        make.centerY.equalToSuperview()
        make.right.lessThanOrEqualTo(iconView.snp.left).offset(-8)
    }
    iconView.snp.makeConstraints { make in
        make.right.equalToSuperview().offset(-16)
        make.centerY.equalToSuperview()
        make.size.equalTo(CGSize(width: 24, height: 24))
    }
}

override func prepareForReuse() {
    super.prepareForReuse()
    // 不要在这里再次 makeConstraints,否则会重复添加;若需更新内容用 updateConstraints 或只改 constant
}

7.7 动态布局:remake 与 update

// 场景:根据状态切换“展开/收起”,用 remake 重做约束
func setExpanded(_ expanded: Bool) {
    contentView.snp.remakeConstraints { make in
        make.left.right.top.equalToSuperview()
        if expanded {
            make.height.equalTo(200)
        } else {
            make.height.equalTo(60)
        }
    }
    UIView.animate(withDuration: 0.3) {
        self.layoutIfNeeded()
    }
}
// 场景:只改间距,用 update 更新 constant,适合动画
var topOffset: Constraint?
view.snp.makeConstraints { make in
    topOffset = make.top.equalToSuperview().offset(20).constraint
    make.left.right.equalToSuperview()
    make.height.equalTo(100)
}
// 后续
topOffset?.update(offset: 80)
UIView.animate(withDuration: 0.25) {
    view.superview?.layoutIfNeeded()
}

7.8 优先级与可选的“最大宽度”

// 场景:标签最大宽度为父视图 70%,但若内容更短则保持 intrinsic 宽度
label.snp.makeConstraints { make in
    make.left.equalToSuperview().offset(16)
    make.centerY.equalToSuperview()
    make.width.lessThanOrEqualToSuperview().multipliedBy(0.7).priority(.high)
    // 不写 right,由 CHCR 与 lessThanOrEqualTo 共同决定
}

7.9 约束标识与调试

view.snp.makeConstraints { make in
    make.top.equalToSuperview().offset(20).labeled("headerTop")
    make.left.right.equalToSuperview().labeled("headerHorizontal")
}
// 约束冲突时,在控制台或 Xcode 中可根据 "headerTop" 等快速定位视图与约束

7.10 小结表

场景 推荐 API 要点
单视图居中/尺寸 makeConstraints + center / size / equalToSuperview() addSubview 再约束
多视图排列 先定一个基准视图,其余 equalTo(基准.snp.xxx) 注意谁决定总高度/总宽度
安全区域 view.safeAreaLayoutGuide.snp.xxxedges.equalTo(safeArea).inset() 适配刘海与 Home Indicator
卡片/内边距 父视图不设高度,子视图 bottom.equalToSuperview() 撑开 避免固定高度,利于多行文本
ScrollView contentView.width.equalTo(scrollView) + 最底部子视图 bottom 约束到 contentView 撑开 contentSize
Cell makeConstraints 在 init 中只做一次,prepareForReuse 不重复添加 可配合 remake 或只更新 constant
动态/动画 remakeConstraints 整体重做,updateConstraints 只改 constant 动画前改约束,动画内 layoutIfNeeded()
优先级/可选约束 .priority(.high)lessThanOrEqualTo 与 CHCR 配合,避免冲突

二、SnapKit 源码解析

1. 整体架构

SnapKit 的代码结构可分层为:DSL 入口层约束描述层约束实体层系统桥接层

flowchart TB
  subgraph 入口
    A[View.snp.makeConstraints]
  end
  subgraph DSL
    B[ConstraintMaker]
    C[ConstraintDescription]
    D[ConstraintItem]
  end
  subgraph 约束实体
    E[Constraint]
    F[ConstraintViewAttributes]
  end
  subgraph 系统
    G[NSLayoutConstraint]
    H[LayoutConstraint]
  end
  A --> B
  B --> C
  C --> D
  C --> E
  E --> F
  E --> G
  G --> H
  • 入口View.snp 返回 ConstraintViewDSL,其上提供 makeConstraints / remakeConstraints / updateConstraints 等方法,接收 (ConstraintMaker) -> Void 闭包。
  • ConstraintMaker:闭包中的 make 对象,持有当前视图(ConstraintItem)及一组 ConstraintDescription;每次调用 make.left.equalTo(...) 等会生成或更新一条 ConstraintDescription。
  • ConstraintDescription:描述“某属性 与 某目标 的 关系、倍数、常量、优先级”,可生成多条 Constraint(例如 edges 生成四条)。
  • Constraint:封装最终要安装的 NSLayoutConstraint(或其子类),负责 install() / uninstall() 与状态管理。

1.1 关键类型与职责(对照源码)

类型 文件/模块 职责简述
ConstraintViewDSL View+DSL 通过 view.snp 暴露,提供 makeConstraints / remakeConstraints / updateConstraints,持有 view。
ConstraintMaker ConstraintMaker 闭包参数 make,持有 ConstraintItem(当前视图)和 [ConstraintDescription],提供 left/right/top/bottom 等入口。
ConstraintDescription ConstraintDescription 描述单条或多条约束(如 edges 对应 4 条),持有 relation、target、multiplier、constant、priority,可生成 Constraint。
ConstraintItem ConstraintItem 对 UIView/ UILayoutGuide 的抽象,提供 layoutConstraintItem(用于 NSLayoutConstraint 的 firstItem/secondItem)。
Constraint Constraint 对应一条 NSLayoutConstraint,实现 install() 时创建并激活,uninstall() 时 deactivate 并置空引用。
LayoutConstraint LayoutConstraint NSLayoutConstraint 子类,用于在 install 时做兼容或扩展(如与 SnapKit 的关联标记)。

1.2 约束的生命周期(创建 → 安装 → 更新/移除)

makeConstraints { make in
    make.left.equalToSuperview().offset(20)   // 1. 生成 ConstraintDescription,加入 maker
}
// 2. 闭包返回后,maker 将 description 转为 Constraint,再对每个 Constraint 调用 install()
// 3. install() 内部:new NSLayoutConstraint(...); constraint.isActive = true
// 4. 若后续调用 remakeConstraints,先 uninstall 所有已安装的 Constraint,再重新执行闭包并 install

2. DSL 链与构建器模式

SnapKit 的链式 API 采用 流式接口(Fluent Interface)构建器思想:每次调用返回可继续链式调用的对象,逐步补全“属性、关系、目标、倍数、常量、优先级”。

典型调用链在概念上可拆成:

make.left          → 选定“左边界”为当前约束属性
  .equalTo(superview)  → 关系为 equal,目标为 superview(默认同属性 left)
  .offset(20)       → constant = 20
  .priority(.high) → 优先级

对应到源码中的角色(名称可能随版本略有差异):

类型/协议 作用
ConstraintMaker 入口,提供 left/right/top/bottom/width/height/centerX/centerY/edges/size 等,返回可继续链式的对象。
ConstraintMakerExtendable 扩展 edgessizemargins 等组合属性。
ConstraintMakerRelatable 提供 equalTolessThanOrEqualTogreaterThanOrEqualTo,确定“关系 + 目标”。
ConstraintMakerEditable 提供 offsetmultipliedBydividedBy 等,设置 constant 与 multiplier。
ConstraintMakerPriortizable 提供 priority(...),设置约束优先级。
ConstraintMakerFinalizable 结束链,可能返回 Constraint 供后续引用或批量操作。

因此,像 make.width.equalToSuperview().dividedBy(2).priority(100) 的调用会依次经过:选定属性 → 设关系与目标 → 设倍数 → 设优先级,最终生成一条 Constraint 描述并加入 Maker 的列表,在闭包结束后统一 install

2.1 链式调用的返回类型(协议串联)

链的每一步返回不同协议类型,使下一句只能调用合法方法,形成“约束描述”的逐步补全:

make.width                    → ConstraintMakerExtendable (可继续 .equalTo / .lessThanOrEqualTo 等)
  .equalToSuperview()         → ConstraintMakerEditable (可继续 .offset / .multipliedBy 等)
  .dividedBy(2)               → ConstraintMakerPriortizable (可继续 .priority)
  .priority(100)              → ConstraintMakerFinalizable (可 .constraint 取引用或结束)

源码中通过协议 + 泛型实现:例如 ConstraintMakerExtendableequalTo(_:) 返回 ConstraintMakerEditable,这样就不能在未设置目标前写 offset,保证调用顺序正确。

2.2 组合属性(edges / size / center)的展开

当写 make.edges.equalToSuperview() 时,内部会展开为四条约束描述:

  • make.left.equalToSuperview()
  • make.right.equalToSuperview()
  • make.top.equalToSuperview()
  • make.bottom.equalToSuperview()

每条仍走完整的链(equalTo → offset → priority),最终得到 4 个 Constraint 对象。sizecenter 同理,分别对应 2 条约束。因此一个 ConstraintDescription 可以对应多个 Constraint,在 collect 阶段会全部加入 Maker 的列表,在 install 阶段逐一安装。


3. 约束的生成与安装

3.1 安装流程(泳道图)

sequenceDiagram
  participant U as 开发者
  participant V as View.snp
  participant M as ConstraintMaker
  participant C as Constraint
  participant S as 系统 Auto Layout

  U->>V: makeConstraints { make in ... }
  V->>M: 创建 Maker(view)
  V->>M: 执行闭包(make)
  loop 每条约束描述
    U->>M: make.xxx.equalTo(...).offset(...)
    M->>M: 添加 ConstraintDescription
  end
  M->>C: 生成 Constraint 并 collect
  V->>C: install()
  loop 每条 Constraint
    C->>S: 创建/激活 NSLayoutConstraint
  end
  S-->>V: 布局更新

3.2 算法说明(约束收集与安装)

约束安装可简化为两阶段:

  1. 收集阶段:闭包执行过程中,不立即创建 NSLayoutConstraint,而是将“视图、属性、关系、目标、multiplier、constant、priority”存入 ConstraintDescription,再在适当时机(如访问 constraint 或闭包结束)生成 Constraint 对象并加入列表。
  2. 安装阶段:对列表中每个 Constraint 调用 install(),其内部根据描述创建 NSLayoutConstraint,并调用 isActive = true(或旧版 addConstraint)将约束加入视图层级,由系统布局引擎求解。

伪代码(安装逻辑概念)

function Constraint.install():
    if alreadyInstalled then return
    let c = NSLayoutConstraint(
        item: self.view, attribute: self.attr,
        relatedBy: self.relation,
        toItem: self.targetView, attribute: self.targetAttr,
        multiplier: self.multiplier, constant: self.constant
    )
    c.priority = self.priority
    c.isActive = true
    self.layoutConstraint = c
    mark as installed

3.3 ConstraintDescription → Constraint 的生成时机

  • 单属性(如 make.width.equalTo(100)):在链结束(闭包内该句执行完)时,Maker 根据当前 Description 生成一个 Constraint,加入内部数组;若链上有 .constraint,则同时返回给调用方保存。
  • 组合属性(如 make.edges.equalToSuperview()):一条 Description 会展开成多个 Constraint(edges → 4 个),全部加入数组。
  • 闭包整体结束:Maker 的 install() 被调用,遍历所有已收集的 Constraint,依次执行各自的 install(),此时才创建并激活 NSLayoutConstraint

因此“生成 Constraint”与“安装到系统”是分离的:先收集、后统一安装,便于支持 remake(先 uninstall 再重新 make)和批量操作。

3.4 uninstall 与 remake 的配合

remakeConstraints 的语义等价于:

1. 取出该 view 上由 SnapKit 管理的所有 Constraint(通过关联对象或 view 上的标记)
2. 对每个 Constraint 调用 uninstall():layoutConstraint.isActive = false,并清空对 NSLayoutConstraint 的引用
3. 再执行 makeConstraints(closure),重新收集并 install

这样可避免旧约束残留导致的冲突或多余约束。


4. 与系统 Auto Layout 的衔接

SnapKit 不实现自己的布局引擎,而是 生成并激活 NSLayoutConstraint,完全依赖系统 Auto Layout(及底层 Cassowary 求解器)。因此:

  • 性能:约束求解与布局计算由系统完成,SnapKit 只影响“约束的创建与组织方式”。
  • 兼容性:与 Interface Builder、手写约束、其他第三方布局库生成的约束可混用,只要约束系统一致(无冲突或冲突可被优先级解决)。
  • 调试:约束冲突、无法满足的约束等仍由系统报错;SnapKit 的 labeled() 可为生成的 NSLayoutConstraint.identifier 赋值,便于在 Xcode 中识别。

4.1 SnapKit 属性与 NSLayoutConstraint.Attribute 的对应

SnapKit 的 ConstraintAttribute(left, right, top, bottom, width, height, centerX, centerY 等)在 install 时会被映射为系统的 NSLayoutConstraint.Attribute

SnapKit 概念 NSLayoutConstraint.Attribute
left .left
right .right
top .top
bottom .bottom
leading .leading
trailing .trailing
width .width
height .height
centerX .centerX
centerY .centerY
leftMargin / rightMargin 等 .leftMargin, .rightMargin, ...

multiplier、constant、relation、priority 则直接传给 NSLayoutConstraint 的对应参数;toItemsecondAttribute 来自 ConstraintDescription 的 target(ConstraintItem),若目标为常数(如 equalTo(100)),则 toItem 为 nil,secondAttribute.notAnAttribute


5. 关键数据结构与约束映射

5.1 ConstraintItem:视图与 LayoutGuide 的统一抽象

系统 API 中,约束的 firstItem / secondItem 可以是 UIViewUILayoutGuide。SnapKit 用 ConstraintItem 封装二者,对外只暴露“某个对象 + 其 snp 描述”,这样 equalToSuperview()equalTo(view.safeAreaLayoutGuide.snp.top) 可以走同一套链式 API。内部在生成 NSLayoutConstraint 时,从 ConstraintItem 取出真正的 layoutConstraintItem(UIView 或 UILayoutGuide)作为 firstItem/secondItem。

5.2 约束描述到 NSLayoutConstraint 的构造(概念代码)

一条 Constraint 在 install() 时大致等价于:

// 概念代码,非逐字源码
func install() {
    guard layoutConstraint == nil else { return }
    let firstItem = description.view.layoutConstraintItem!
    let secondItem = description.target?.layoutConstraintItem  // 可为 nil
    let c = NSLayoutConstraint(
        item: firstItem,
        attribute: description.attribute.layoutAttribute,
        relatedBy: description.relation,
        toItem: secondItem,
        attribute: secondItem != nil ? description.targetAttribute.layoutAttribute : .notAnAttribute,
        multiplier: description.multiplier,
        constant: description.constant
    )
    c.priority = description.priority
    c.identifier = description.label
    c.isActive = true
    self.layoutConstraint = c
}

理解这一点即可知道:SnapKit 不参与求解,只负责“描述 → NSLayoutConstraint → isActive = true”,布局结果完全由系统 Auto Layout(及 Cassowary)决定。

5.3 updateConstraints 的“只改 constant”实现

updateConstraintsmakeConstraints 共用同一套收集逻辑,但语义是“更新已存在的约束”。实现上通常通过约束匹配:根据“视图 + 属性”(以及可选的 target)找到之前由 SnapKit 安装的 Constraint,只调用其 update(offset:) / update(inset:) 等,修改底层 NSLayoutConstraint.constant,而不新增或删除约束。因此适合“布局关系不变、只改间距或尺寸常量”的动画或响应式更新。


三、设计模式与延伸

与 Masonry 一脉相承,SnapKit 在架构中同样运用了多种设计模式与编程思想;因采用 Swift 与协议导向设计,部分实现方式与 Masonry(OC)不同,但目标一致:可读的链式 DSL、统一的约束抽象、先描述后安装。下表对照 SnapKit 与 Masonry,便于与《05-Masonry框架:从使用到源码解析》对照学习。

模式/技巧 在 SnapKit 中的体现 与 Masonry 对照
组合思想 单条约束(如 make.left)与复合约束(如 make.edges)对外同一套链式 API;edges / size / center 在内部展开为多条 Constraint,统一通过 ConstraintMaker 收集、再逐一 install。无显式 Composite 类,但“单条与复合同一接口”的思想一致。 Masonry 用 MASConstraint 协议 + MASViewConstraint(叶子)+ MASCompositeConstraint(组合)形成约束树;SnapKit 用协议链 + 一条 Description 对应多条 Constraint 实现类似效果。
工厂/构建器思想 ConstraintMaker 根据访问的属性(left、width、edges…)创建或填充 ConstraintDescription,调用方不直接 Constraint(...);闭包内“描述”、闭包外统一 install,符合“构建器 + 两阶段”的模式。 Masonry 的 MASConstraintMaker 按属性创建 MASViewConstraint / MASCompositeConstraint,形态上更接近简单工厂;SnapKit 的 Maker 更突出“分步填写再构建”的构建器角色。
链式/流式接口 每一步返回不同协议类型(ConstraintMakerExtendable → Relatable → Editable → Priortizable → Finalizable),既形成链式调用,又用类型约束“先设目标再设 offset/priority”,避免错误顺序。 Masonry 用 Block 属性 getter 返回“带返回值的 Block”,Block 内 return self 形成链;SnapKit 用 Swift 协议与泛型在编译期保证链的顺序。
类型安全与多态入口 Swift 泛型与重载实现 equalTo(100)equalTo(CGSize)equalTo(view) 等统一入口,无需 OC 的“装箱”;编译器区分类型,无运行时 BoxValue。 Masonry 用 MASBoxValue 将标量/结构体装箱为 id,再走 equalTo:;SnapKit 用语言特性替代,思想一致(统一入口、多类型支持)。
两阶段处理 闭包内只向 Maker 追加 ConstraintDescription / Constraint,不立即创建 NSLayoutConstraint;闭包结束后再统一 install,便于 remake(先 uninstall 再 make)与批量操作。 与 Masonry 的“block(maker) 只登记,[maker install] 再创建并激活”完全一致。

提炼与串联:上述模式与思想在 SnapKit 中的协作关系、与 Masonry 的异同,以及可复用要点,见 §六、编程思想与设计模式提炼总结。更详细的模式定义与伪代码可参考本系列《05-Masonry框架:从使用到源码解析》中的“简单工厂 | 工厂方法 | 抽象工厂”“组合模式与约束树”“链式语法完整解析”等小节。


四、SnapKit 中的优秀编程思想

SnapKit 能成为 iOS 布局 DSL 的事实标准,不仅因为功能完善,更因为其背后一系列可复用的编程思想。理解这些思想有助于在业务代码或自研库中写出更易读、可维护的 API。

1. DSL(领域特定语言):用“布局语言”说话

思想:不暴露通用编程语言的细枝末节,而是提供一套贴近领域(这里是“布局约束”)的词汇和语法,让代码读起来像在描述布局本身。

对比:系统 API 是“给引擎传参数”;SnapKit 是“用布局语言写句子”。

// 系统 API:面向“约束引擎”,不直观
NSLayoutConstraint(
    item: subview,
    attribute: .left,
    relatedBy: .equal,
    toItem: superview,
    attribute: .left,
    multiplier: 1,
    constant: 20
)

// SnapKit:面向“布局意图”,读即懂
subview.snp.makeConstraints { make in
    make.left.equalToSuperview().offset(20)
}

可复用的点:在业务里遇到“一坨参数、含义不清”的 API 时,可以封装一层 DSL:用类型 + 闭包 + 链式方法,把“做什么”说清楚,把“怎么做”藏进实现。


2. 流式接口(Fluent Interface):链式调用表达顺序

思想:每一步方法返回“可继续操作”的对象,让多步操作写成一串链,顺序即逻辑,无需临时变量。

代码示例

// 链式:属性 → 关系与目标 → 常量/倍数 → 优先级,一气呵成
label.snp.makeConstraints { make in
    make.top.equalToSuperview().offset(16)
         .labeled("titleTop")           // 链上可继续加修饰
    make.left.equalToSuperview().offset(20)
    make.right.lessThanOrEqualToSuperview().offset(-20)
         .priority(.high)
}

设计要点:返回值类型随链变化(如 equalTo 后返回支持 offset 的类型),编译器保证“先设目标再设 offset”,避免错误顺序。这种思想在构建查询、配置对象时同样适用。


3. 构建器模式(Builder):分步构建复杂对象

思想:约束是一个“复杂对象”(属性、关系、目标、倍数、常量、优先级)。不一次性传 7 个参数,而是用多个小方法分步填写,最后统一“安装”。

代码示例

// 构建器:先描述,后安装
view.snp.makeConstraints { make in
    // 步骤 1:选属性
    make.width
        // 步骤 2:设关系与目标
        .equalToSuperview()
        // 步骤 3:设倍数与常量
        .multipliedBy(0.5)
        .offset(0)
        // 步骤 4:设优先级(可选)
        .priority(.medium)
}
// 闭包结束后统一 install,而非每写一句就加一条系统约束

可复用的点:任何“多参数、多可选、有顺序”的配置,都可以用 Builder:一个入口方法接收闭包,闭包里对“builder 对象”调用多个 setter,最后在闭包外统一执行(如网络请求的 Builder、配置文件的 Builder)。


3.5 组合模式统一接口:单条与复合用同一套 API(对照 Masonry)

思想:调用方不区分“单条约束”还是“多条约束的集合”,都通过同一套链式 API 操作;复合约束(如 edgessize)在内部展开为多条 Constraint,但对外呈现一致。

在 SnapKit 中的体现make.leftmake.edges 都返回可继续链式的类型(如 ConstraintMakerExtendable / Relatable),都可继续 .equalTo(...).offset(...).priority(...)make.edges.equalToSuperview() 内部会展开为 left/right/top/bottom 四条 Constraint 并加入 Maker,与 Masonry 的 MASCompositeConstraint(edges 对应四条 MASViewConstraint)思想一致。详见 二、2.2 组合属性(edges / size / center)的展开

与 Masonry 对照:Masonry 用 MASConstraint 协议 + MASViewConstraint(叶子)+ MASCompositeConstraint(组合)形成显式约束树;SnapKit 用“一条 Description 对应多条 Constraint”实现同一语义,无单独 Composite 类,但“单条与复合同一接口”的用法一致。


3.6 两阶段处理:先描述,再安装(对照 Masonry)

思想:闭包执行阶段只“收集意图”,不立刻产生副作用(不立刻创建或激活 NSLayoutConstraint);等闭包结束后再统一 install,便于去重、批量激活、remake(先 uninstall 再 make)。

在 SnapKit 中的体现view.snp.makeConstraints { make in ... } 中,闭包内 make.xxx 只向 ConstraintMaker 追加 ConstraintDescription 或生成 Constraint 并加入列表;闭包返回后,框架再对列表中每个 Constraint 调用 install(),此时才创建并激活 NSLayoutConstraint。与 Masonry 的“block(maker) 只登记,[maker install] 再创建并激活”完全一致。详见 二、3. 约束的生成与安装


4. 类型安全与协议拆分:用类型约束“能写什么”

思想:通过协议 + 泛型把“当前能调用的方法”限定在类型里。例如:只有调用了 equalTo 之后才允许调用 offset;只有调用了 offset 之后才允许调用 priority。这样错误顺序在编译期就会报错。

概念示例(对应 SnapKit 的协议链):

// 伪代码:协议链保证“先选目标再设常量”
protocol ConstraintMakerExtendable {
    var left: ConstraintMakerRelatable { get }
    var width: ConstraintMakerRelatable { get }
}
protocol ConstraintMakerRelatable {
    func equalTo(_ other: ConstraintItem) -> ConstraintMakerEditable
    func equalTo(_ constant: CGFloat) -> ConstraintMakerEditable
}
protocol ConstraintMakerEditable {
    func offset(_ c: CGFloat) -> ConstraintMakerPriortizable
    func multipliedBy(_ m: CGFloat) -> ConstraintMakerPriortizable
}
protocol ConstraintMakerPriortizable {
    func priority(_ p: UILayoutPriority) -> ConstraintMakerFinalizable
}
// 因此:make.left.offset(20) 会编译错误,因为 left 之后必须先 equalTo

业务中的用法:例如“配置请求”时,可以设计成:只有设置了 URL 才能设置 Method,只有设置了 Method 才能设置 Body,避免漏配或顺序错乱。


5. 闭包与延迟执行:描述与执行分离

思想:约束的描述(闭包内的 make.xxx)和执行(真正创建并激活 NSLayoutConstraint)分离。闭包负责“声明要什么”,框架在闭包返回后统一“收集、生成、安装”。

代码示例

// 闭包内只“描述”,不立刻生效
view.snp.makeConstraints { make in
    make.edges.equalToSuperview()
}
// 这里才真正 install;若内部用 remake,会先 uninstall 再根据闭包重新 install

好处:可以统一做“去重、校验、批量安装、与旧约束对比”等逻辑,而不让调用方关心。在其他场景里,例如“先收集所有配置再一次性提交”“先构建命令再执行”,也适合“闭包描述 + 闭包外执行”的模式。


6. 单一职责与分层:谁只做一件事

思想

  • ConstraintMaker:只负责“收集约束描述”。
  • ConstraintDescription:只负责“一条/多条约束的参数”。
  • Constraint:只负责“对应一条 NSLayoutConstraint 的安装/卸载”。
  • View + snp:只负责“入口和闭包调度”。

每一层只做一件事,便于测试和替换;例如以后要支持“约束预览”或“导出为 IB 约束”,只需在描述层或安装层加一层,而不必改 DSL 写法。

代码层面的体现

  • 改 constant 用 Constraint.update(offset:),不碰 Maker。
  • 改约束集合用 remakeConstraints,由 Maker 重新收集再安装,Constraint 只负责单条的生命周期。

7. 可读性与“表达意图”:命名即文档

思想:API 命名直接表达意图,而不是实现细节。例如 equalToSuperview()equalTo(view.superview!) 更贴近“与父视图对齐”的意图;labeled("headerTop") 直接表达“方便调试时识别”。

代码示例

// 意图明确:居中、宽度为父视图一半、距顶 20
avatar.snp.makeConstraints { make in
    make.centerX.equalToSuperview()
    make.width.equalToSuperview().multipliedBy(0.5)
    make.top.equalToSuperview().offset(20)
}

// 意图明确:四边与安全区域对齐并留内边距
content.snp.makeConstraints { make in
    make.edges.equalTo(view.safeAreaLayoutGuide).inset(16)
}

可复用的点:对外 API 尽量用“业务/领域术语”命名(如 equalToSuperviewinset),内部实现可以用技术术语(如 layoutConstraintItemconstant),让调用方代码即文档。


8. 小结:思想与可复用场景

编程思想 SnapKit 中的体现 可复用场景举例
DSL 布局专用词汇与语法 配置、查询、脚本类 API
流式接口 链式 make.xxx.equalTo().offset() 配置对象、查询构建器
构建器模式 分步填约束再统一 install 多参数配置、请求/命令构建
组合模式统一接口 单条(make.left)与复合(make.edges)同一套 API,内部展开多条 Constraint 树形结构、批量操作、配置项分组
两阶段处理 闭包内只描述,闭包外统一 install 批量提交、事务、布局、表单校验
类型安全与协议拆分 不同链阶段返回不同协议 有顺序的配置、状态机式 API
闭包 + 延迟执行 闭包内描述,闭包外安装 批量提交、事务式操作
单一职责与分层 Maker / Description / Constraint 各管一事 任何多步骤的领域逻辑
表达意图的命名 equalToSuperview、labeled、inset 所有对外 API 设计

五、高级应用与注意点

5.1 动画中更新约束

// 仅更新 constant,不增删约束
view.snp.updateConstraints { make in
    make.top.equalToSuperview().offset(newOffset)
}
UIView.animate(withDuration: 0.3) {
    view.superview?.layoutIfNeeded()
}

5.2 约束的引用与批量操作

部分场景需要保留对某条约束的引用(例如单独改 constant 或 priority),SnapKit 支持在闭包中返回或捕获约束:

var widthConstraint: Constraint?
view.snp.makeConstraints { make in
    widthConstraint = make.width.equalTo(100).constraint
}
// 后续可修改
widthConstraint?.update(offset: 200)

5.3 安全区域与可读区域

在 iOS 11+ 中,应结合 safeAreaLayoutGuide 做刘海与 Home Indicator 适配;SnapKit 通过 make.top.equalTo(view.safeAreaLayoutGuide.snp.top) 或封装好的安全区 API(视版本而定)与系统安全区对齐,避免内容被遮挡。


六、编程思想与设计模式提炼总结

本节对 SnapKit 中使用的设计模式编程思想做统一提炼,并与 Masonry 做简要对照,便于在其它 DSL、配置类 API 或自研框架中复用。更详细的模式定义、伪代码与“按目标选模式”清单可参考本系列《05-Masonry框架:从使用到源码解析》中的 五、编程思想与设计模式提炼总结

6.1 思维导图:SnapKit 设计模式与编程思想总览

mindmap
  root((SnapKit 思想与模式))
    设计模式
      组合思想
        单条与复合同一 API
        edges/size 展开为多条 Constraint
      工厂/构建器思想
        ConstraintMaker 按属性创建 Description
        闭包内描述 闭包外 install
      链式/流式接口
        协议链 ConstraintMakerExtendable → Editable → Priortizable
        每步返回可继续链的类型
    编程思想
      DSL
        布局词汇 left equalTo offset
        代码即文档
      两阶段处理
        阶段一 闭包内收集描述
        阶段二 闭包外统一 install
      类型安全
        泛型与重载 equalTo(CGFloat)/equalTo(View)
        无需装箱 编译期区分
      单一职责与分层
        Maker / Description / Constraint 各管一事
    与 Masonry 对照
      同一套“链式 DSL + 两阶段”哲学
      Swift 协议链 vs OC Block 返回 self
      无显式 Composite 类 语义一致

6.2 设计模式与编程思想提炼表(与 Masonry 对照)

模式/思想 SnapKit 中的体现 Masonry 对照
组合思想 单条与复合(edges/size)同一套链式 API;一条 Description 可对应多条 Constraint。 MASConstraint 协议 + MASViewConstraint(叶子)+ MASCompositeConstraint(组合)形成约束树。
工厂/构建器 ConstraintMaker 根据访问属性创建/填充 ConstraintDescription;分步填写再统一 install。 MASConstraintMaker 按属性创建 MASViewConstraint / MASCompositeConstraint(简单工厂形态)。
流式接口 协议链保证每步返回可链类型,编译期约束顺序。 Block getter 返回“带返回值的 Block”,Block 内 return self。
两阶段 闭包内只描述,闭包外统一 install。 block(maker) 只登记,[maker install] 再创建并激活。
类型/多态入口 Swift 泛型与重载,equalTo(100)/equalTo(CGSize)/equalTo(view)。 MASBoxValue 装箱,mas_equalTo 宏统一走 equalTo:。

6.3 小结:一句话提炼

  • 组合:单条与复合同一接口,复合在内部展开为多条 Constraint。
  • 构建器:Maker 分步收集描述,闭包外统一 install。
  • 流式:协议链每步返回可链类型,顺序即逻辑。
  • 两阶段:先描述后执行,便于 remake、批量与扩展。
  • 类型安全:Swift 泛型与重载替代 OC 装箱,思想一致。

SnapKit 与 Masonry 在“链式 DSL + 两阶段 + 组合式约束抽象”上保持同一套设计哲学,差异主要来自语言特性(Swift 协议与泛型 vs OC Block 与 id)。理解并提炼后,可在任意“配置型、构建型、DSL 型”的 API 设计中按需复用;与 Masonry 的对照有助于在 OC 与 Swift 项目间迁移或做技术选型。


附录:参考文献与延伸阅读

参考文献

[1] SnapKit. SnapKit. GitHub. github.com/SnapKit/Sna…

[2] Larder. What's in your Larder: iOS layout DSLs. larder.io/blog/larder…

[3] Cassowary. Solving constraint systems. cassowary.readthedocs.io/en/latest/t…

[4] Apple. Auto Layout Guide. Developer Documentation.

[5] Badros, G. J., Borning, A., & Marriott, K. (1997). Solving Linear Arithmetic Constraints for User Interface Applications. Proceedings of the 1997 ACM Symposium on User Interface Software and Technology (UIST).

[6] University of Washington. Cassowary Constraint Solving Toolkit. constraints.cs.washington.edu/cassowary/

[7] Vasarhelyi, A. Behind the Scenes with Auto Layout or How to Solve Constraints with the Cassowary Algorithm. iOSConfSG. speakerdeck.com/vasarhelyia…

延伸阅读

  • Masonry:SnapKit 的 Objective-C 前身。本系列《05-Masonry框架:从使用到源码解析》中的三、设计模式与延伸四、优秀编程思想五、编程思想与设计模式提炼总结详细展开组合模式、工厂/链式、两阶段、装箱等,与本文 §三、§四、§六 对照可加深对“链式 DSL + 两阶段”设计哲学的理解。
  • Auto Layout 内在尺寸:Content Hugging 与 Compression Resistance 在 Apple《Auto Layout Guide》中的说明。
  • Cassowary 论文与技术报告:深入理解约束层次与增量求解,便于分析复杂布局冲突与性能。

01-研究优秀开源框架@UI布局@iOS | Masonry 框架:从使用到源码解析

本文结合科技文献、学术论文与业界实践,系统介绍 iOS/macOS 下的 Auto Layout DSL 库 Masonry:技术演进、核心原理(含 Cassowary 约束求解)、应用场景、源码架构与设计模式,并配有流程图、泳道图与思维导图。内容涵盖库的源码剖析及大厂使用心得,从基础概念到高级应用形成完整知识体系。


目录


一、Masonry 使用详解

1. 框架概述

Masonry 是面向 Objective-CAuto Layout DSL(领域特定语言),用于在代码中以声明式、链式语法描述视图的布局约束,替代冗长的 NSLayoutConstraint 手写与 Visual Format 字符串 [[1]]。其设计目标可概括为:

  • 可读性:约束意图接近自然语言(如“左边等于父视图左边”“宽度等于 100”)。
  • 简洁性:用 Block 链式调用替代多参数、多行的系统 API。
  • 可维护性:链式调用便于增删约束、设置优先级与调试冲突。

Masonry 由 SnapKit 组织 在 GitHub 上维护,采用 MIT 协议;其 Swift 继任者为 SnapKit,二者共享同一套“链式 DSL 描述约束”的设计哲学 [[2]]。在 Objective-C 时代,Masonry 成为纯代码 Auto Layout 的事实标准之一,被广泛应用于 iOS/macOS 项目。


2. 历史演进

布局方式的演进与 Apple 布局技术、学术成果及开源生态并行,可概括为如下时间线。

flowchart LR
  subgraph 学术与系统
    A[1997 Cassowary 论文]
    B[2011 Auto Layout 引入]
    C[iOS 6 正式支持]
  end
  subgraph 开发方式
    D[手写 NSLayoutConstraint]
    E[Visual Format]
    F[2014 Masonry]
    G[2015+ SnapKit]
  end
  A --> B
  B --> C
  C --> D
  D --> E
  E --> F
  F --> G
阶段 代表 特点
手写约束 NSLayoutConstraint(item:attribute:relatedBy:toItem:attribute:multiplier:constant:) 冗长、易出错、难以阅读 [[3]]。
Visual Format V:|[a]-[b]| 字符串描述,类型不安全,复杂布局难表达。
Masonry Objective-C,Block 链式 链式 DSL、可读性高,成为 OC 时代事实标准 [[1]]。
SnapKit Swift,Closure 链式 延续 Masonry 思想,面向 Swift 生态。

Apple 于 2011 年在 macOS Lion(及后续 iOS 6)中采用 Cassowary 作为布局引擎 [[4]][[5]],将约束转化为线性方程组求解;第三方 DSL 如 Masonry 正是在系统 API 仍显冗长的背景下流行起来的 [[6]]。


3. 理论基础:Auto Layout 与 Cassowary

Masonry 的约束最终仍通过 Auto Layout 交给系统布局引擎执行。Auto Layout 的数学基础是 Cassowary 约束求解算法,理解其思想有助于理解“约束冲突”“优先级”“内在尺寸”等概念。

3.1 Cassowary 算法简述

Cassowary 是一种 增量式线性约束求解算法,基于对偶单纯形法(dual simplex),用于求解由 线性等式与不等式 组成的约束系统 [[7]][[8]]。其特点包括:

  • 线性:约束可写成形如 (a_1 x_1 + a_2 x_2 + \cdots = b) 或 (\le/\ge) 的形式,与“视图 A 的左边 = 视图 B 的右边 + 常数”等布局关系一致。
  • 增量:可动态增删约束并高效重新求解,适合交互式 UI(窗口缩放、动画中更新约束)。
  • 约束层次(constraint hierarchy):支持 requiredpreferred(优先级),在约束冲突时按优先级舍弃或松弛部分约束,避免无解。

约束层次与松弛原理(简述):Cassowary 将约束按优先级分层(如 required=1000,high=750,low=250)。求解时先满足最高层;若存在冲突则引入松弛变量,允许低优先级约束在“尽量满足”的意义下被违反,从而得到唯一解 [[9]]。例如“宽度 = 父视图一半”与“宽度 ≥ 100”冲突时,若前者优先级较低,则在小屏上会优先保证 width ≥ 100。

参考文献

  • 原始论文:Solving Linear Arithmetic Constraints for User Interface Applications,UIST 1997 [[9]]。
  • 扩展与实现:Washington 大学 Cassowary 工具包 [[10]]。

3.2 从约束描述到线性关系(概念)

Auto Layout 将每条约束映射为关于视图几何变量(如 left, right, width, centerX)的线性等式或不等式。Masonry 所写的“左边等于父视图左边 + 20”即对应:

  • 变量:view.leftsuperview.left
  • 关系:view.left = superview.left + 20

多约束组成方程组,由 Cassowary 求解得到每个变量的值,从而得到各视图的 frame。优先级 对应 Cassowary 的强弱约束:高优先级必须满足,低优先级在冲突时可被违反。

约束的线性形式(概念):单条约束可写为线性等式或不等式,例如
( \text{view.left} = \text{superview.left} + 20 )
或带倍数:( \text{view.width} = \text{superview.width} \times 0.5 )。Cassowary 将整套约束表示为 ( A\bm{x} = \bm{b} )(或 (\le/\ge)),在满足约束层次的前提下求 (\bm{x})(各几何变量)[[9]]。

约束求解顺序(概念):系统在布局时并非“从左到右”或“从顶到底”逐视图计算,而是将所有约束汇总为全局线性系统,由 Cassowary 一次性求解;因此修改任意一条约束或某个视图的 intrinsicContentSize,都可能触发整棵视图树的布局重算。Masonry 只负责生成约束,不参与求解顺序。

3.3 流程图:从 Masonry 到屏幕像素(概念层)

flowchart LR
  A[Masonry API 调用] --> B[MASConstraintMaker]
  B --> C[MASConstraint 描述]
  C --> D[NSLayoutConstraint]
  D --> E[Auto Layout 引擎]
  E --> F[Cassowary 求解]
  F --> G[布局结果 / frame]
  G --> H[渲染到屏幕]

4. 核心概念

4.1 约束的组成

在 Auto Layout 中,一条约束可抽象为:

Item1.Attribute1 Relation Item2.Attribute2 * Multiplier + Constant

例如:“视图 A 的右边 = 视图 B 的左边 - 8”即 A.right = B.left - 8Relation 常见为 Equal、LessThanOrEqual、GreaterThanOrEqual,在 Masonry 中对应 equalTolessThanOrEqualTogreaterThanOrEqualTo。Masonry 的链式 API 就是对这五元组(Item1, Attribute1, Relation, Item2, Attribute2, Multiplier, Constant)的封装,并增加 优先级(Priority)标识(Identifier) 等元数据。

4.2 优先级与内在尺寸

概念 说明
约束优先级 UILayoutPriority(0–1000),数值越大越优先;系统在冲突时打破低优先级约束。
Content Hugging “抗拉伸”:视图不愿比其内在内容尺寸更大。
Compression Resistance “抗压缩”:视图不愿比其内在内容尺寸更小。

Label、Button、ImageView 等有 intrinsicContentSize 的控件依赖 CHCR 与其它约束共同决定最终尺寸;Masonry 可通过 mas_remakeConstraints 等配合系统 API 设置 CHCR。在 Xcode 中可在 Size Inspector 中为视图设置 Content Hugging / Compression Resistance 的优先级(数值越大越“坚持”)。

CHCR 与显式约束的配合原理:布局引擎在确定视图尺寸时,会同时考虑(1)显式约束(如 width = 100)、(2)内在尺寸(如 Label 根据文字算出的宽高)、(3)CHCR 优先级。当“显式约束 + 内在尺寸”存在冗余或冲突时,CHCR 决定谁“让步”:Content Hugging 高则视图不易被拉大,Compression Resistance 高则不易被压小。例如两 Label 横向排列且未固定宽度时,会按 CHCR 分配剩余空间。

flowchart LR
  A[显式约束] --> C[布局引擎]
  B[内在尺寸 + CHCR] --> C
  C --> D[最终 frame]

4.3 约束冲突与满足(概念)

当约束过多或相互矛盾时,系统会按优先级从高到低尝试满足;无法同时满足的约束中,低优先级的会被打破并报错(或在调试时标红)。Masonry 通过 .priority(...) 设置单条约束的优先级,便于在“理想布局”与“保底布局”之间做权衡。

4.4 思维导图:Masonry 概念关系

mindmap
  root((Masonry))
    使用入口
      mas_makeConstraints
      mas_remakeConstraints
      mas_updateConstraints
    描述对象
      MASConstraintMaker
      MASViewAttribute
      MASConstraint
    约束属性
      left right top bottom
      width height centerX centerY
      edges size margins
    关系与修饰
      equalTo mas_equalTo offset multipliedBy priority
    底层
      NSLayoutConstraint
      Auto Layout / Cassowary

5. API 与使用模式

5.1 基本用法(Objective-C)

// 示例:子视图填满父视图边距
[view addSubview:subview];
[subview mas_makeConstraints:^(MASConstraintMaker *make) {
    make.edges.equalTo(view);
}];
// 示例:水平居中,宽度 100,距顶 20
[subview mas_makeConstraints:^(MASConstraintMaker *make) {
    make.centerX.equalTo(self.view);
    make.width.mas_equalTo(100);
    make.top.equalTo(self.view.mas_top).offset(20);
}];

5.2 常用 API 对照(伪代码语义)

Masonry 写法 含义(伪代码)
make.left.equalTo(superview) self.left = superview.left
make.width.mas_equalTo(100) self.width = 100
make.top.equalTo(other.mas_bottom).offset(8) self.top = other.bottom + 8
make.size.mas_equalTo(CGSizeMake(80, 80)) self.width = 80, self.height = 80
make.edges.equalToSuperview() 四边与 superview 对齐
make.center.equalTo(superview) centerX/Y 与 superview 对齐
make.width.equalTo(superview).multipliedBy(0.5) self.width = superview.width * 0.5
make.priority(MASLayoutPriorityDefaultHigh) 为该条约束设置优先级

5.3 make / remake / update

  • mas_makeConstraints:在已有约束基础上追加新约束,不删除旧约束。入口内部会将 translatesAutoresizingMaskIntoConstraints 设为 NO,无需手动设置。
  • mas_remakeConstraints先移除该视图上由 Masonry 管理的约束,再按 Block 重新添加,适合布局整体变化。
  • mas_updateConstraints仅更新Block 中涉及到的约束的 constant(或部分属性),不改变约束条数或关系,适合仅改“间距/常量”的动画或响应式布局。

伪代码(remake 的语义)

function mas_remakeConstraints(block):
    uninstallAllMasonryConstraints()
    mas_makeConstraints(block)

5.4 使用案例集

以下案例覆盖常见布局需求,便于对照理解 API 与约束语义。

案例 1:内边距与四边对齐

// 子视图相对父视图四周各留 20pt
[subview mas_makeConstraints:^(MASConstraintMaker *make) {
    make.edges.equalTo(superview).with.insets(UIEdgeInsetsMake(20, 20, 20, 20));
}];
// 等价于:left = superview.left+20, right = superview.right-20, top/bottom 同理

案例 2:居中 + 固定尺寸

[avatarView mas_makeConstraints:^(MASConstraintMaker *make) {
    make.center.equalTo(self.view);
    make.size.mas_equalTo(CGSizeMake(80, 80));
}];

案例 3:两视图水平排列,等分宽度

[viewA mas_makeConstraints:^(MASConstraintMaker *make) {
    make.left.equalTo(container.mas_left);
    make.top.bottom.equalTo(container);
    make.width.equalTo(viewB);
}];
[viewB mas_makeConstraints:^(MASConstraintMaker *make) {
    make.left.equalTo(viewA.mas_right).offset(8);
    make.right.equalTo(container.mas_right);
    make.top.bottom.equalTo(container);
}];

案例 4:安全区域与 LayoutGuide(避免被导航栏/标签栏遮挡)

[self.scrollView mas_makeConstraints:^(MASConstraintMaker *make) {
    make.top.equalTo(self.mas_topLayoutGuideBottom);  // 在导航栏下方
    make.left.right.equalTo(self.view);
    make.bottom.equalTo(self.mas_bottomLayoutGuideTop); // 在标签栏上方
}];

案例 5:动画中更新约束 constant

// 先 make 建立约束,并保存对某条约束的引用
__block MASConstraint *topConstraint;
[box mas_makeConstraints:^(MASConstraintMaker *make) {
    topConstraint = make.top.equalTo(self.view.mas_top).offset(100);
    make.centerX.equalTo(self.view);
    make.size.mas_equalTo(CGSizeMake(100, 100));
}];
// 后续动画中只改 constant,用 update
[box mas_updateConstraints:^(MASConstraintMaker *make) {
    make.top.equalTo(self.view.mas_top).offset(200);
}];
[UIView animateWithDuration:0.3 animations:^{ [self.view layoutIfNeeded]; }];

案例 6:列表 Cell 内多子视图(避免重复添加)

- (void)setupConstraints {
    [_iconView mas_makeConstraints:^(MASConstraintMaker *make) {
        make.left.equalTo(self.contentView).offset(16);
        make.centerY.equalTo(self.contentView);
        make.size.mas_equalTo(CGSizeMake(44, 44));
    }];
    [_titleLabel mas_makeConstraints:^(MASConstraintMaker *make) {
        make.left.equalTo(_iconView.mas_right).offset(12);
        make.centerY.equalTo(self.contentView);
        make.right.lessThanOrEqualTo(self.contentView).offset(-16);
    }];
}
- (void)prepareForReuse {
    [super prepareForReuse];
    // 不在此重复 mas_makeConstraints;若布局需随数据巨变,可 mas_remakeConstraints
}

案例 7:优先级与比例(宽度为父视图一半,但最低 100)

[subview mas_makeConstraints:^(MASConstraintMaker *make) {
    make.centerX.equalTo(self.view);
    make.width.equalTo(self.view).multipliedBy(0.5).priorityHigh();
    make.width.mas_greaterThanOrEqualTo(100).priorityRequired();
    make.top.equalTo(self.view).offset(20);
}];

案例 8:与原生 NSLayoutConstraint 对比

// 原生:一条“左边等于父视图左边+20”需整行多参数
[NSLayoutConstraint constraintWithItem:subview
                             attribute:NSLayoutAttributeLeft
                             relatedBy:NSLayoutRelationEqual
                                toItem:superview
                             attribute:NSLayoutAttributeLeft
                            multiplier:1.0
                              constant:20];

// Masonry:语义相同,一行表达
[subview mas_makeConstraints:^(MASConstraintMaker *make) {
    make.left.equalTo(superview).offset(20);
}];

6. 应用场景与最佳实践

场景 建议
纯代码 UI 用 Masonry 替代手写 NSLayoutConstraint,可读性和维护性更好。
动态布局 mas_remakeConstraintsmas_updateConstraints 配合动画更新约束。
列表 Cell prepareForReuse 中避免重复添加约束,可 mas_remakeConstraints 或复用约束并只更新 constant。
UIScrollView 内子视图 子视图约束需相对 scrollView 的 contentLayoutGuide(或四边 + 明确宽/高以确定 contentSize),避免约束不足导致布局歧义。
多分辨率/多设备 multipliedBy、比例、优先级与 CHCR 适配不同宽度与安全区域。
约束冲突调试 为约束设置 identifier(若使用支持该特性的版本),便于在 Xcode 中识别。

7. 业界实践与大厂使用心得

Masonry 自 2013 年由 Jonas Budelmann 创建以来 [[14]],在 iOS 社区被广泛采用,其设计影响了后续 SnapKit、SwiftUI 等布局思路;业界总结的实践与“大厂”级项目的使用方式,可作为理论之外的补充参考。

7.1 开发效率与代码量

  • 代码量对比:相比原生 NSLayoutConstraint 多参数、多行写法,使用 Masonry 可将布局代码量减少约 60%–80%;原本需 20 余行的约束描述,用 Masonry 往往 3–5 行即可表达相同意图 [[14]][[15]]。
  • 可读性与错误率:链式语法使“左边等于某视图右边 + 间距”等意图一目了然,强类型接口减少参数顺序错误;新成员更容易理解现有布局逻辑 [[15]][[16]]。

7.2 三个核心 API 的选型(结合源码语义)

方法 行为(结合源码) 典型场景
mas_makeConstraints: 不移除已有 Masonry 约束,在 Maker 中追加新约束并 install 初始布局、逐步添加约束
mas_remakeConstraints: 先 uninstall 该视图上所有由 Masonry 管理的约束,再执行 block 重新 make 并 install 布局整体变化(如横竖屏、显隐导致结构变化)
mas_updateConstraints: 只更新已存在约束的 constant(或部分可更新字段),不增删约束条数 动画中改间距、响应式微调

选型原则:能 update 就不 remake,能 remake 就不在外部手动移除再 make,以降低遗漏或重复约束的风险 [[16]]。

7.3 常见实践场景(来自社区与项目总结)

  • 相对父视图edgescentersize 配合 insets/offset 实现内边距与居中;安全区域可用 mas_topLayoutGuide/mas_bottomLayoutGuide 或 Safe Area API 避免视图穿透导航栏/标签栏 [[16]][[17]]。
  • 相对兄弟视图equalTo(other.mas_left)equalTo(other.mas_bottom).offset(8) 等明确描述视图间关系;列表 Cell 内多视图约束建议在 prepareForReuse 中统一 remake 或只更新 constant,避免重复添加 [[17]]。
  • 复合约束edges(四边)、size(宽高)、center(中心)一次生成多条约束,既减少重复代码又保证语义一致 [[14]]。

7.4 思维导图:API 选型与场景

mindmap
  root((Masonry 实践))
    初始布局
      mas_makeConstraints
      只增不减
    布局巨变
      mas_remakeConstraints
      先卸后建
    微调/动画
      mas_updateConstraints
      只改 constant
    适配与安全
      LayoutGuide / Safe Area
      multipliedBy 比例

二、Masonry 源码解析

Masonry框架的类结构

1. 整体架构与类结构

Masonry 的代码结构可分层为:DSL 入口层约束描述层(Maker + 组合约束)约束实体层(MASConstraint)系统桥接层(NSLayoutConstraint)

flowchart TB
  subgraph 入口
    A[View.mas_makeConstraints]
  end
  subgraph DSL
    B[MASConstraintMaker]
    C[MASCompositeConstraint]
    D[MASViewAttribute]
  end
  subgraph 约束实体
    E[MASViewConstraint]
    F[MASLayoutConstraint]
  end
  subgraph 系统
    G[NSLayoutConstraint]
  end
  A --> B
  B --> C
  B --> E
  C --> E
  E --> D
  E --> F
  F --> G
  • 入口UIView+MASAdditions 为视图提供 mas_makeConstraints: / mas_remakeConstraints: / mas_updateConstraints:,接收 (MASConstraintMaker *) Block。
  • MASConstraintMaker:Block 中的 make 对象,持有当前视图及一组约束描述;调用 make.leftmake.edges 等会返回 MASConstraint(可能是复合或单条)。Maker 提供基础属性(left、top、right、bottom、leading、trailing)、尺寸(width、height)、居中(centerX、centerY、baseline)、边距(*Margin)及复合属性(edges、size、center)[[18]]。
  • MASCompositeConstraint:组合多条 MASViewConstraint(如 edges 对应 left/right/top/bottom 四条),形成树状结构,对应组合模式
  • MASViewConstraint:描述单条约束(某属性 与 某目标 的 关系、倍数、常量、优先级),最终生成 MASLayoutConstraint(NSLayoutConstraint 子类)并安装。

1.2 源码级调用链:从 make.left 到约束创建

所有“单属性”约束(如 left、width)在 Maker 中最终都通过 addConstraintWithLayoutAttribute: 统一入口创建;复合属性(如 edges)则在该方法上层按多个 NSLayoutAttribute 分别调用。流程可概括为:

flowchart LR
  A[make.left] --> B[addConstraintWithLayoutAttribute: Left]
  B --> C[constraint: addConstraintWithLayoutAttribute:]
  C --> D[MASViewConstraint 创建]
  D --> E[加入 Maker 的约束数组]
  E --> F[install 时生成 NSLayoutConstraint]

对应源码逻辑(伪代码) [[18]]:

// MASConstraintMaker
- (MASConstraint *)left {
    return [self addConstraintWithLayoutAttribute:NSLayoutAttributeLeft];
}
- (MASConstraint *)addConstraintWithLayoutAttribute:(NSLayoutAttribute)attr {
    return [self constraint:nil addConstraintWithLayoutAttribute:attr];
}
// 若为复合属性(如 edges),则创建 MASCompositeConstraint 并为其添加多条 MASViewConstraint;
// 否则创建单条 MASViewConstraint,存入 constraintMaker 的约束列表,供 install 时统一安装。

1.3 结合掘金文章:从 make 到 install 的完整链路

以下内容综合自掘金文章《Masonry实现原理并没有那么可怕》[[19]],与源码对照便于理解 Maker、链式多属性及 install 的细节。

(1)mas_makeConstraints: 入口与两阶段

- (NSArray *)mas_makeConstraints:(void(^)(MASConstraintMaker *))block {
    self.translatesAutoresizingMaskIntoConstraints = NO;  // 手写约束前必须关闭 autoresizing 转约束
    MASConstraintMaker *constraintMaker = [[MASConstraintMaker alloc] initWithView:self];
    block(constraintMaker);   // 阶段一:Block 内 make.xxx 只往 maker 里“登记”约束
    return [constraintMaker install];  // 阶段二:统一创建 NSLayoutConstraint 并添加到视图
}

make 即传入 Block 的 MASConstraintMaker 实例,负责约束的创建与最终的 install [[19]]。

(2)make.left 的三步到 MASViewConstraint

  • Step 1make.left 调用 addConstraintWithLayoutAttribute:NSLayoutAttributeLeft
  • Step 2addConstraintWithLayoutAttribute: 内部调 constraint:nil addConstraintWithLayoutAttribute:layoutAttribute(单属性时第一个参数为 nil)。
  • Step 3constraint:addConstraintWithLayoutAttribute: 中创建 MASViewAttribute(封装 View + NSLayoutAttribute)、MASViewConstraint(firstViewAttribute + 后续 secondViewAttribute);若当前 constraint 为 nil,则将 newConstraint 加入 maker 的 constraints 数组并返回。

MASViewAttribute 可理解为“视图 + 布局属性”的可变元组;MASViewConstraint 即一条约束描述,持有 firstViewAttribute 与 secondViewAttribute [[19]]。

(3)make.top.left 的链式多属性:委托与复合替换

make.top 返回的是 MASViewConstraint,而 MASViewConstraint 的父类 MASConstraint 同样定义了 left、right、top 等属性。这些属性的实现会委托回 Maker

// MASViewConstraint 中
- (MASConstraint *)addConstraintWithLayoutAttribute:(NSLayoutAttribute)layoutAttribute {
    NSAssert(!self.hasLayoutRelation, @"Attributes should be chained before defining the constraint relation");
    return [self.delegate constraint:self addConstraintWithLayoutAttribute:layoutAttribute];  // delegate 即 Maker
}

此时传入的 constraint 不再为 nil(是当前的 MASViewConstraint)。在 Maker 的 constraint:addConstraintWithLayoutAttribute: 里会创建 MASCompositeConstraint,把“已有约束 + 新约束”包成组合,并调用 constraint:shouldBeReplacedWithConstraint:,在 constraints 数组中找到原约束的位置,用 composite 替换,从而 make.top.left 在数组中表现为一条“组合约束”而非两条独立项 [[19]]。

小结(与掘金文章总结一致):MASConstraintMaker 作为工厂,生产并管理 MASViewConstraint(单条)与 MASCompositeConstraint(组合);二者均遵循 MASConstraint 抽象,对外统一接口;View+MASAdditions 作为与外界交互的入口,把复杂的约束创建与安装封装在内部,仅暴露简单的 mas_makeConstraints: 等 API [[19]]。

(4)equalTo 与 equalToWithRelation

equalTo(...) 内部对应 equalToWithRelation。若传入的是数组(多目标),会复制当前 MASViewConstraint 并为每个目标设置 secondViewAttribute,包装成 MASCompositeConstraint,同样通过 shouldBeReplacedWithConstraint 替换进 maker;若传入单个对象,则设置 secondViewAttributereturn self,支持继续 .offset().priority() [[19]]。


2. 组合模式与约束树

Masonry 采用 组合设计模式(Composite Pattern):将对象组合成树状结构以表示“部分-整体”的层次结构,使客户端对叶子节点(单条约束)和组合节点(如 edges、size)的使用方式一致 [[11]]。

注意:此处的“组合”指结构型设计模式中的 Composite,而非“组合优于继承”的泛称。

2.1 组合模式三要素

Masonry 采用了经典的 组合设计模式(Composite Pattern)。

2.1.1 定义

将对象组合成树状结构以表示“部分-整体”的层次结构。组合模式使得用户对单个对象(Leaf)和组合对象(Composite)的使用具有一致性。 注意:这个组合模式不是“组合优于继承”的那种组合,是狭义的指代一种特定的场景(树状结构)

2.1.2 三个设定
  • Component 协议:树中的组件(Leaf、Composite)都实现同一协议,使客户端可统一对待。
  • Leaf:无子节点的叶子组件,对应单条约束。
  • Composite:容器组件,持有子节点(Leaf 或其他 Composite),操作时递归子节点。

结构关系见下方 Mermaid 图与角色对照表。

角色 在 Masonry 中的对应
Component 协议 MASConstraint 协议,树中所有节点(叶子与组合)都实现该协议。
Leaf MASViewConstraint:无子约束,对应单条 NSLayoutConstraint。
Composite MASCompositeConstraint:持有多个 MASConstraint(可再为叶子或组合),如 edges 包含 left/right/top/bottom。
flowchart TB
  subgraph Composite
    A[MASCompositeConstraint edges]
    A --> B[MASViewConstraint left]
    A --> C[MASViewConstraint right]
    A --> D[MASViewConstraint top]
    A --> E[MASViewConstraint bottom]
  end
  subgraph Leaf
    B
    C
    D
    E
  end

2.2 在 Cocoa Touch 中的类比

UIView 的层级本身也是组合结构:子视图可包含更多子视图,形成树;Masonry 的约束树与视图树解耦,但都采用“统一接口处理单点与集合”的思想。

2.3 Swift 实现示例(组合模式)

import Foundation

// 一:Component协议:树中的组件(Leaf、Composite)都需要实现这个协议
protocol File {
    var name: String { get set }
    func showInfo()
}

// 二:Leaf:树结构中的一个没有子元素的组件
class TextFile: File {
    var name: String
    init(name: String) {
        self.name = name
    }
    func showInfo() {
        print("(name) is TextFile")
    }
}

class ImageFile: File {
    var name: String
    init(name: String) {
        self.name = name
    }
    func showInfo() {
        print("(name) is ImageFile")
    }
}

class VideoFile: File {
    var name: String
    init(name: String) {
        self.name = name
    }
    func showInfo() {
        print("(name) is VideoFile")
    }
}

// 三:Composite:容器,与Leaf不同的是有子元素,用来存储Leaf和其他Composite
class Fold: File {
    var name: String
    private(set) var files: [File] = []
    init(name: String) {
        self.name = name
    }
    func showInfo() {
        print("(name) is Fold")
        files.forEach { (file) in
            file.showInfo()
        }
    }
    func addFile(file: File)  {
        files.append(file)
    }
}

class Client {
    init() {
    }
    func test() {
        let fold1: Fold = Fold.init(name: "fold1")
        let fold2: Fold = Fold.init(name: "fold2")
        let text1: TextFile = TextFile.init(name: "text1")
        let text2: TextFile = TextFile.init(name: "text2")
        let image1: ImageFile = ImageFile.init(name: "image1")
        let image2: ImageFile = ImageFile.init(name: "image2")
        let video1: VideoFile = VideoFile.init(name: "video1")
        let video2: VideoFile = VideoFile.init(name: "video2")
        fold1.addFile(file: text1)
        fold2.addFile(file: text2)
        fold1.addFile(file: image1)
        fold2.addFile(file: image2)
        fold1.addFile(file: video1)
        fold2.addFile(file: video2)
        fold1.addFile(file: fold2)
        fold1.showInfo()
    }
}

2.4 参考资料


3. 工厂模式与链式语法

本节单独展开 Masonry 中工厂模式链式语法的设计与实现:前者负责“按需创建约束对象”,后者负责“让约束描述可连续书写、易读易维护”。


扩展:简单工厂 | 工厂方法 | 抽象工厂 三种模式辨析

在分析 Masonry 的“工厂”角色之前,先对 GoF 及业界常说的三类工厂型创建模式做一统一定义与对比,便于理解 Masonry 更贴近哪一种、以及为何不采用另一种。

1)简单工厂模式(Simple Factory)

定义:由一个具体工厂类根据参数/类型决定创建哪一种具体产品,并返回产品的抽象类型给调用方。不属于 GoF 23 种设计模式之一,但实践中极为常见。

核心特征

  • 一个工厂类:无抽象工厂接口、无工厂子类,所有创建逻辑集中在一个类的一个方法(或若干静态/实例方法)里。
  • 根据参数分支:如 create(type) 内部用 if/switch 或字典映射,type == "A"new ProductA(),否则 new ProductB()
  • 返回抽象类型:方法签名返回抽象产品(接口或基类),调用方只依赖抽象,不依赖 ConcreteProductA/B。

结构示意

flowchart LR
  C[Client] --> F[SimpleFactory]
  F --> P1[ProductA]
  F --> P2[ProductB]
  F --> P3[ProductC]
  P1 --> I[Product 接口]
  P2 --> I
  P3 --> I
  C --> I

伪代码

// 抽象产品
interface Product { void doSomething(); }

// 具体产品
class ProductA : Product { ... }
class ProductB : Product { ... }

// 简单工厂:一个类,一个方法,根据参数创建
class SimpleFactory {
    Product create(String type) {
        if (type == "A") return new ProductA();
        if (type == "B") return new ProductB();
        throw new UnsupportedTypeException(type);
    }
}

// 调用方
Product p = factory.create("A");
p.doSomething();

优点:实现简单、调用方与具体产品解耦(只依赖 Product)。缺点:新增产品必须修改工厂类内部分支,违反开闭原则;工厂类职责随产品增多而膨胀。


2)工厂方法模式(Factory Method,GoF)

定义:定义用于创建对象的抽象方法(工厂方法),由子类决定实例化哪一个具体产品类。将“创建哪种产品”的决策推迟到子类,符合开闭原则。

核心特征

  • 抽象 Creator + 多个 ConcreteCreator:抽象工厂(或基类)声明 createProduct() 抽象方法;每个具体产品对应一个具体工厂子类,在子类中 return new ConcreteProduct()
  • 一厂一产品:通常一个 ConcreteCreator 只生产一种 ConcreteProduct(或一个产品族中的一种)。
  • 调用方依赖抽象:依赖抽象 Creator 和抽象 Product,通过多态获得具体产品,扩展时只需新增子类,无需改原有类。

结构示意

flowchart TB
  subgraph 调用方
    Client
  end
  subgraph 抽象层
    Creator["Creator\n+ factoryMethod()"]
    Product["Product"]
  end
  subgraph 具体层
    CreatorA["ConcreteCreatorA\n+ factoryMethod() → ProductA"]
    CreatorB["ConcreteCreatorB\n+ factoryMethod() → ProductB"]
    ProductA[ProductA]
    ProductB[ProductB]
  end
  Client --> Creator
  Creator --> CreatorA
  Creator --> CreatorB
  CreatorA --> ProductA
  CreatorB --> ProductB
  ProductA --> Product
  ProductB --> Product

伪代码

// 抽象产品
interface Product { void doSomething(); }
class ProductA : Product { ... }
class ProductB : Product { ... }

// 抽象创建者:声明工厂方法
abstract class Creator {
    abstract Product factoryMethod();
    void someOperation() { Product p = factoryMethod(); p.doSomething(); }
}

// 具体创建者:各负责一种产品
class ConcreteCreatorA : Creator {
    Product factoryMethod() { return new ProductA(); }
}
class ConcreteCreatorB : Creator {
    Product factoryMethod() { return new ProductB(); }
}

// 调用方依赖 Creator 抽象,由外部注入 ConcreteCreatorA 或 B
Creator c = new ConcreteCreatorA();
c.someOperation();

与简单工厂对比:扩展新产品时,简单工厂要工厂类内部代码;工厂方法是新增一个 Creator 子类和一个 Product 子类,原有代码不动,符合开闭原则。


3)抽象工厂模式(Abstract Factory,GoF)

定义:为创建一组相关或相互依赖的产品提供一个接口,而不指定具体类。每个具体工厂负责生产一整族产品(如“现代风椅子+现代风桌子”),不同工厂生产不同族(如“古典风椅子+古典风桌子”)。

核心特征

  • 产品族:多个抽象产品(如 Chair、Table),每个抽象产品有多个具体实现(ModernChair、ClassicChair…)。抽象工厂接口中为每个产品提供一个创建方法(如 createChair()createTable())。
  • 一族一起换:ConcreteFactory1 生产 ModernChair + ModernTable,ConcreteFactory2 生产 ClassicChair + ClassicTable;客户端依赖抽象工厂与抽象产品,通过切换具体工厂即可切换整族风格。
  • 解决“系列产品”的创建:适合 UI 主题、跨平台控件族、数据库/连接池族等“多产品、多风格/多实现”的场景。

结构示意

flowchart TB
  subgraph 调用方
    Client
  end
  subgraph 抽象工厂与产品
    AF["AbstractFactory\n+ createChair()\n+ createTable()"]
    Chair["Chair"]
    Table["Table"]
  end
  subgraph 具体工厂与产品族
    CF1["ConcreteFactory1\n→ ModernChair, ModernTable"]
    CF2["ConcreteFactory2\n→ ClassicChair, ClassicTable"]
    MCh[ModernChair]
    MTable[ModernTable]
    CCh[ClassicChair]
    CTable[ClassicTable]
  end
  Client --> AF
  AF --> CF1
  AF --> CF2
  CF1 --> MCh
  CF1 --> MTable
  CF2 --> CCh
  CF2 --> CTable
  MCh --> Chair
  MTable --> Table
  CCh --> Chair
  CTable --> Table

伪代码

// 抽象产品族
interface Chair { void sit(); }
interface Table { void put(); }
class ModernChair : Chair { ... }
class ModernTable : Table { ... }
class ClassicChair : Chair { ... }
class ClassicTable : Table { ... }

// 抽象工厂:一族产品的创建接口
interface AbstractFactory {
    Chair createChair();
    Table createTable();
}

// 具体工厂:生产一族产品
class ModernFactory : AbstractFactory {
    Chair createChair() { return new ModernChair(); }
    Table createTable() { return new ModernTable(); }
}
class ClassicFactory : AbstractFactory {
    Chair createChair() { return new ClassicChair(); }
    Table createTable() { return new ClassicTable(); }
}

// 调用方:通过换工厂切换整族
AbstractFactory f = new ModernFactory();
Chair c = f.createChair();
Table t = f.createTable();

与工厂方法对比:工厂方法通常是“一个方法生产一种产品”;抽象工厂是“一个工厂接口里多个方法,每个方法生产一种产品,且这一组产品是相关的一族”。抽象工厂可理解为多产品族的工厂方法组合


4)三种模式对比表
维度 简单工厂 工厂方法 抽象工厂
工厂形态 一个具体工厂类,无子类 抽象 Creator + 多个 ConcreteCreator 子类 抽象 AbstractFactory + 多个 ConcreteFactory 子类
创建方式 同一方法内根据参数 if/switch 分支 子类重写工厂方法,各返回一种产品 子类实现多个创建方法,各返回一族中的一种产品
产品数量 可多种产品,由参数决定 通常一厂一种产品 一厂一族产品(多个相关产品)
扩展方式 新增产品需工厂类内部 新增产品 = 新增 Creator 子类 + Product 子类 新增产品族 = 新增 Factory 子类 + 该族各 Product 子类
开闭原则 对扩展不友好(需改工厂) 对扩展开放(加子类即可) 对扩展开放(加新工厂子类与产品族)
典型场景 产品种类少、变化少、图简单 框架/插件:由子类决定具体产品 主题/风格/平台:整族产品一起换

5)Masonry 与三种模式的关系
  • Masonry 的 Maker:只有一个具体类 MASConstraintMaker,根据“请求的属性”(left、top、edges、size…)在同一类内部分支,创建 MASViewConstraintMASCompositeConstraint,并统一以 MASConstraint 抽象返回。形态上最接近简单工厂(一个工厂类、多种产品、参数即“布局属性”)。
  • 为何不是典型工厂方法:没有“抽象 Maker + 多个 ConcreteMaker 子类”,也没有“一个子类只生产一种约束”。创建逻辑集中在 Maker 内部,没有把“创建哪种约束”推迟到子类。
  • 为何不是抽象工厂:Masonry 不涉及“一族多产品”的切换(如多套 UI 主题、多平台控件族)。只有一类“产品”——约束描述对象(单条/复合),只是根据属性不同产生不同具体类,不涉及多产品族的抽象工厂接口。

结论:Masonry 采用的主要是简单工厂的形态(集中在一个 Maker 内、按属性分支创建),同时吸收了工厂方法的“调用方只依赖抽象产品(MASConstraint)”的优点,便于阅读和扩展约束类型时在 Maker 内增加分支或复合封装,而无需引入 Maker 子类。


3.1 工厂模式在 Masonry 中的完整映射

3.1.1 工厂方法模式(Factory Method)回顾

上文扩展小节已给出简单工厂、工厂方法、抽象工厂三种模式的定义与对比;§3.2 给出 GoF 工厂方法的标准定义与优缺点。此处仅列出 Masonry 中“工厂”角色的直接对应

GoF 角色

  • Product(抽象产品):约束对象的抽象,对应 MASConstraint 协议。
  • ConcreteProduct(具体产品):单条约束 → MASViewConstraint;复合约束 → MASCompositeConstraint
  • Creator(创建者):负责“生产”约束的工厂,对应 MASConstraintMaker
  • Factory Method(工厂方法):Creator 中根据“请求类型”创建具体产品的方法;在 Masonry 中体现为 addConstraintWithLayoutAttribute: 及复合属性的封装(如 edgessize)。

Masonry 并未采用“抽象 Creator + 多个 ConcreteCreator 子类”的经典工厂方法结构,而是在一个 Maker 类内根据请求的布局属性(left、top、edges、size 等)决定创建“单条约束”还是“组合约束”,因此更贴近简单工厂 + 工厂方法思想的融合:创建逻辑集中在 Maker 内部,对外只暴露 make.leftmake.edges 等统一入口,调用方完全依赖 MASConstraint 抽象,不关心具体是 MASViewConstraint 还是 MASCompositeConstraint

3.1.2 Masonry 中的“工厂”是谁、生产什么
角色 Masonry 中的对应 说明
工厂 / 创建者 MASConstraintMaker Block 中的 make,持有 view 和约束数组;根据访问的属性创建约束。
工厂方法 addConstraintWithLayoutAttribute:constraint:addConstraintWithLayoutAttribute: 根据 NSLayoutAttribute(Left、Top、Width、Height…)或复合键(edges、size、center)创建并返回 MASConstraint
抽象产品 MASConstraint 协议 对外统一接口:equalTooffsetpriorityinstall 等,调用方只依赖该协议。
具体产品(单条) MASViewConstraint 对应一条 NSLayoutConstraint,如 make.leftmake.width
具体产品(复合) MASCompositeConstraint 内部持有多条 MASViewConstraint,如 make.edgesmake.size

创建时机:调用方写 make.left 时,Maker 并不立刻创建 NSLayoutConstraint,而是先创建一条“约束描述对象”(MASViewConstraint),加入 Maker 的约束数组;等 Block 执行完毕、执行 [maker install] 时,再遍历这些描述对象,逐个生成并激活 NSLayoutConstraint。因此“工厂”生产的是约束描述对象,真正的系统约束在 install 阶段 才生成。

3.1.3 工厂流程示意(从 make.left 到约束对象)
flowchart LR
  A[make.left] --> B[MASConstraintMaker]
  B --> C{单属性 or 复合?}
  C -->|单属性 Left| D[addConstraintWithLayoutAttribute: Left]
  C -->|复合 edges| E[创建 left/right/top/bottom 四条]
  D --> F[新建 MASViewConstraint]
  E --> G[新建 MASCompositeConstraint]
  F --> H[加入 maker.constraints]
  G --> H
  H --> I[返回 MASConstraint 给调用方]

单属性源码级逻辑(伪代码)

// MASConstraintMaker
- (MASConstraint *)left {
    return [self addConstraintWithLayoutAttribute:NSLayoutAttributeLeft];
}

- (MASConstraint *)addConstraintWithLayoutAttribute:(NSLayoutAttribute)attr {
    return [self constraint:nil addConstraintWithLayoutAttribute:attr];
}

- (MASConstraint *)constraint:(MASConstraint *)constraint addConstraintWithLayoutAttribute:(NSLayoutAttribute)attr {
    MASViewAttribute *firstViewAttribute = [[MASViewAttribute alloc] initWithView:self.view layoutAttribute:attr];
    if (!constraint) {
        // 当前无“正在组装的约束”,创建新的 MASViewConstraint 并加入数组
        MASViewConstraint *newConstraint = [[MASViewConstraint alloc] initWithFirstViewAttribute:firstViewAttribute];
        [self.constraints addObject:newConstraint];
        newConstraint.delegate = self;
        return newConstraint;  // 返回给调用方,继续链式 .equalTo(...).offset(...)
    }
    // 已有约束(如 make.top 返回的),再链 .left:创建复合约束并替换
    // ... 创建 MASCompositeConstraint,用 composite 替换数组中原来的 constraint
}

复合属性“edges”的工厂行为(伪代码)

// MASConstraintMaker
- (MASConstraint *)edges {
    return [self addConstraintWithLayoutAttribute:NSLayoutAttributeLeft]
        .addConstraintWithLayoutAttribute(NSLayoutAttributeRight)
        .addConstraintWithLayoutAttribute(NSLayoutAttributeTop)
        .addConstraintWithLayoutAttribute(NSLayoutAttributeBottom);
    // 内部会创建 MASCompositeConstraint,包含 left/right/top/bottom 四条 MASViewConstraint
}

因此:工厂思想在 Masonry 中的体现 = Maker 根据“请求的属性”创建相应类型的约束对象(单条或复合),调用方只通过 make.xxx 获取 MASConstraint,不直接 alloc/init 任何具体约束类,符合“将对象创建推迟到专门工厂、调用方依赖抽象”的思想 [[12]]。

3.1.4 工厂模式与“简单工厂”的对比
对比项 经典工厂方法模式 Masonry 的 Maker
创建者 抽象 Creator + 多个 ConcreteCreator 子类 单一类 MASConstraintMaker,无子类
工厂方法 子类重写 createProduct,返回抽象 Product 同一类内根据 layoutAttribute 分支,返回 MASViewConstraint 或 MASCompositeConstraint
扩展方式 新增产品时新增 ConcreteCreator 子类 新增布局语义时在 Maker 内增加属性或复合封装(如 edges、size)
客户端 依赖抽象 Product,不依赖具体类 同样只依赖 MASConstraint 协议,不依赖 MASViewConstraint / MASCompositeConstraint

Masonry 把“创建哪种约束”的逻辑收口在 Maker 的 addConstraintWithLayoutAttribute: 及复合属性里,没有为每种约束单独建工厂子类,因此更接近**简单工厂(Simple Factory)**的“一个工厂类、多种产品”的形态;同时返回的是抽象类型 MASConstraint,又具备工厂方法模式“依赖抽象”的优点。


3.2 GoF 工厂方法模式标准定义(对照理解)

工厂方法模式(Factory Method Pattern)

实质:定义一个用于创建对象的接口(或抽象方法),但让实现该接口的子类来决定实例化哪一个类。工厂方法模式将对象的实例化过程**推迟(defer)**到了子类中。

核心解决的问题: 它解决了客户端代码与具体产品类之间的耦合问题。当系统在编译时无法确定需要创建哪个具体类的对象,或者希望将具体类的实例化逻辑封装在子类中时,该模式尤为适用。

设计优势

  1. 符合开闭原则(Open-Closed Principle):系统对扩展开放,对修改关闭。当需要引入新的具体产品时,只需创建一个新的具体工厂子类,而无需修改现有的客户端代码或工厂接口
  2. 统一接口编程:客户端仅依赖于产品的抽象接口(或抽象基类),而不依赖具体实现。这确保了无论工厂返回哪种具体产品,客户端都能以一致的方式处理。

结论: 相比于在客户端直接使用 new 关键字硬编码具体类,工厂方法模式提供了一种更灵活、更易维护的对象创建策略,特别适用于框架开发或产品族经常变化的场景。

工厂方法模式通过将实例化逻辑推迟到子类,实现创建者与使用者的解耦。要点如下:

3.3 ✅ 主要优点

  • 开闭原则:新增产品时只需新增具体工厂子类与产品子类,无需修改现有客户端与抽象接口。
  • 单一职责:创建逻辑与业务逻辑分离,客户端只关心“用产品”,不关心“如何造”。
  • 低耦合:客户端依赖抽象 Creator 与 Product,便于替换具体实现(如切换数据库驱动)。
  • 统一入口:所有创建经工厂方法,便于做日志、权限、缓存等集中控制。

3.4 ❌ 主要缺点

  • 类数量增加:每增加一种产品通常需增加一个具体工厂类,产品线大时易产生“类爆炸”。
  • 抽象层次加深:调用链变长(客户端 → 具体工厂 → 抽象工厂 → 具体产品),理解成本上升。
  • 多参数/多产品族:若需根据多参数动态选产品,或需一次创建一族产品,更适合用抽象工厂或建造者。

3.5 ⚖️ 总结与适用场景建议

维度 评价
灵活性 ⭐⭐⭐⭐⭐ (极高,易于扩展新产品)
可维护性 ⭐⭐⭐⭐ (高,职责分离清晰)
复杂度 ⭐⭐ (较低,类数量随产品线性增长)
性能开销 ⭐⭐⭐ (中等,主要是类加载开销,运行时影响小)
3.5.1 💡 什么时候应该使用?
  1. 当你不知道确切需要哪个具体类的对象时:例如,框架开发中,框架本身不知道用户会具体使用哪种控件,由用户子类化框架来指定。
  2. 当你希望将对象的创建逻辑委托给专门的子类时:不同子类可能需要不同的初始化逻辑或上下文环境。
  3. 当系统需要遵循开闭原则,频繁增加新产品时:这是最典型的场景。
3.5.2 💡 什么时候应该使用?
  1. 产品种类非常固定,且几乎不会变化:此时引入工厂模式是过度设计(Over-engineering),直接 new 更简单。
  2. 一个工厂需要负责创建多种差异巨大的产品:此时可能更适合使用抽象工厂模式(Abstract Factory)或建造者模式(Builder)。
  3. 项目规模很小,追求极致的代码简洁性:简单的脚本或小型工具类应用中,工厂模式带来的类膨胀可能弊大于利。
3.5.3 代码视角对比

不用工厂:客户端用 if/switch + new 具体类,每增加一种产品都要改此处,违反开闭原则。用工厂方法:客户端依赖抽象工厂与产品,factory.createShape() 由具体工厂子类决定实例化哪种产品;新增产品时只需加新子类,客户端不变。详见上文扩展小节伪代码。

3.6 链式语法(Fluent Interface)完整解析

学习三、链式语法

实现的核心:重写Block属性的Get方法,在Block里返回对象本身

#import "ChainProgramVC.h"

@class ChainAnimal;
typedef void(^GeneralBlockProperty)(int count);
typedef ChainAnimal* (^ChainBlockProperty)(int count);

@interface ChainAnimal : NSObject
@property (nonatomic, strong) GeneralBlockProperty eat1;
@property (nonatomic, strong) ChainBlockProperty eat2;
@end
@implementation ChainAnimal
/**
 函数返回一个block,block返回void
 */
-(GeneralBlockProperty)eat1 {
    return ^(int count) {
        NSLog(@"%s count = %d", __func__, count);
    };
}
/**
 函数返回一个block,block返回ChainAnimal对象
 */
- (ChainBlockProperty)eat2 {
    return ^(int count){
        NSLog(@"%s count = %d", __func__, count);
        return self;
    };
}
@end

@interface ChainProgramVC ()
@property (nonatomic, strong) ChainAnimal *dog;
@end
@implementation ChainProgramVC
- (ChainAnimal *)dog {
    if (!_dog) {
        _dog = [[ChainAnimal alloc] init];
    }
    return _dog;
}
- (void)viewDidLoad {
    [super viewDidLoad];
    [super viewDidLoad];
    self.dog.eat1(1);
    self.dog.eat2(2).eat2(3).eat2(4).eat1(5);
}
@end

学习四、接口简洁

把复杂留给自己,把简单留给别人

学习五、抽象方法小技巧

#define MASMethodNotImplemented() \
    @throw [NSException exceptionWithName:NSInternalInconsistencyException \
                                   reason:[NSString stringWithFormat:@"You must override %@ in a subclass.", NSStringFromSelector(_cmd)] \
                                 userInfo:nil]

- (MASConstraint *)addConstraintWithLayoutAttribute:(NSLayoutAttribute __unused)layoutAttribute {
    MASMethodNotImplemented();
}

自己实现类似需求的时候,可以采用这个技巧阻止直接使用抽象方法。

实践:实现一个自定义转场动画的基类
#import <UIKit/UIKit.h>

NS_ASSUME_NONNULL_BEGIN

@interface BaseAnimatedTransiton : NSObject<UIViewControllerAnimatedTransitioning>
@property (nonatomic, assign) NSTimeInterval p_transitionDuration;
+(instancetype)initWithTransitionDuration:(NSTimeInterval)transitionDuration;
-(instancetype)initWithTransitionDuration:(NSTimeInterval)transitionDuration NS_DESIGNATED_INITIALIZER;
@end

#pragma mark - (Abstract)
@interface BaseAnimatedTransiton (Abstract)
// 子类实现,父类NSException
-(void)animate:(nonnull id<UIViewControllerContextTransitioning>)transitionContext;
@end

NS_ASSUME_NONNULL_END
#import "BaseAnimatedTransiton.h"

@implementation BaseAnimatedTransiton
+(instancetype)initWithTransitionDuration:(NSTimeInterval)transitionDuration {
    BaseAnimatedTransiton* obj = [[BaseAnimatedTransiton alloc] init];
    obj.p_transitionDuration = transitionDuration;
    return obj;
}
-(instancetype)initWithTransitionDuration:(NSTimeInterval)transitionDuration {
    if (self = [super init]) {
        self.p_transitionDuration = transitionDuration;
    }
    return self;
}
-(instancetype)init {
    return [self initWithTransitionDuration:0.25];
}
-(void)animateTransition:(nonnull id<UIViewControllerContextTransitioning>)transitionContext {
    [self animate:transitionContext];
}
-(NSTimeInterval)transitionDuration:(nullable id<UIViewControllerContextTransitioning>)transitionContext {
    return self.p_transitionDuration;
}
-(void)animate:(nonnull id<UIViewControllerContextTransitioning>)transitionContext {
    [self throwException:_cmd];
}
/**
 在Masonry的源码中使用的是宏(感觉宏不是很直观)

 @param aSelector 方法名字
 */
-(void)throwException:(SEL)aSelector {
    @throw [NSException exceptionWithName:NSInternalInconsistencyException
                                   reason:[NSString stringWithFormat:@"You must override %@ in a subclass.", NSStringFromSelector(aSelector)]
                                 userInfo:nil];
}
@end

学习六、包装任何值类型为一个对象

我们添加约束的时候使用equalTo传入的参数只能是id类型的,而mas_equalTo可以任何类型的数据。

[view mas_makeConstraints:^(MASConstraintMaker *make) {
    make.size.mas_equalTo(CGSizeMake(100, 100));
    make.center.equalTo(self.view);
    // 下面这句效果与上面的效果一样
    //make.center.mas_equalTo(self.view);
}];
#define mas_equalTo(...)                 equalTo(MASBoxValue((__VA_ARGS__)))
/**
 *  Given a scalar or struct value, wraps it in NSValue
 *  Based on EXPObjectify: https://github.com/specta/expecta
 */
static inline id _MASBoxValue(const char *type, ...) {
    va_list v;
    va_start(v, type);
    id obj = nil;
    if (strcmp(type, @encode(id)) == 0) {
        id actual = va_arg(v, id);
        obj = actual;
    } else if (strcmp(type, @encode(CGPoint)) == 0) {
        CGPoint actual = (CGPoint)va_arg(v, CGPoint);
        obj = [NSValue value:&actual withObjCType:type];
    } else if (strcmp(type, @encode(CGSize)) == 0) {
        CGSize actual = (CGSize)va_arg(v, CGSize);
        obj = [NSValue value:&actual withObjCType:type];
    } else if (strcmp(type, @encode(MASEdgeInsets)) == 0) {
        MASEdgeInsets actual = (MASEdgeInsets)va_arg(v, MASEdgeInsets);
        obj = [NSValue value:&actual withObjCType:type];
    } else if (strcmp(type, @encode(double)) == 0) {
        double actual = (double)va_arg(v, double);
        obj = [NSNumber numberWithDouble:actual];
    } else if (strcmp(type, @encode(float)) == 0) {
        float actual = (float)va_arg(v, double);
        obj = [NSNumber numberWithFloat:actual];
    } else if (strcmp(type, @encode(int)) == 0) {
        int actual = (int)va_arg(v, int);
        obj = [NSNumber numberWithInt:actual];
    } else if (strcmp(type, @encode(long)) == 0) {
        long actual = (long)va_arg(v, long);
        obj = [NSNumber numberWithLong:actual];
    } else if (strcmp(type, @encode(long long)) == 0) {
        long long actual = (long long)va_arg(v, long long);
        obj = [NSNumber numberWithLongLong:actual];
    } else if (strcmp(type, @encode(short)) == 0) {
        short actual = (short)va_arg(v, int);
        obj = [NSNumber numberWithShort:actual];
    } else if (strcmp(type, @encode(char)) == 0) {
        char actual = (char)va_arg(v, int);
        obj = [NSNumber numberWithChar:actual];
    } else if (strcmp(type, @encode(bool)) == 0) {
        bool actual = (bool)va_arg(v, int);
        obj = [NSNumber numberWithBool:actual];
    } else if (strcmp(type, @encode(unsigned char)) == 0) {
        unsigned char actual = (unsigned char)va_arg(v, unsigned int);
        obj = [NSNumber numberWithUnsignedChar:actual];
    } else if (strcmp(type, @encode(unsigned int)) == 0) {
        unsigned int actual = (unsigned int)va_arg(v, unsigned int);
        obj = [NSNumber numberWithUnsignedInt:actual];
    } else if (strcmp(type, @encode(unsigned long)) == 0) {
        unsigned long actual = (unsigned long)va_arg(v, unsigned long);
        obj = [NSNumber numberWithUnsignedLong:actual];
    } else if (strcmp(type, @encode(unsigned long long)) == 0) {
        unsigned long long actual = (unsigned long long)va_arg(v, unsigned long long);
        obj = [NSNumber numberWithUnsignedLongLong:actual];
    } else if (strcmp(type, @encode(unsigned short)) == 0) {
        unsigned short actual = (unsigned short)va_arg(v, unsigned int);
        obj = [NSNumber numberWithUnsignedShort:actual];
    }
    va_end(v);
    return obj;
}

#define MASBoxValue(value) _MASBoxValue(@encode(__typeof__((value))), (value))

其中@encode()是一个编译时特性,其可以将传入的类型转换为标准的OC类型字符串

学习七、Block避免循环应用

Masonry中,Block持有View所在的ViewController,但是ViewController并没有持有Blcok,因此不会导致循环引用。

[self.view mas_makeConstraints:^(MASConstraintMaker *make) {
    make.centerY.equalTo(self.otherView.mas_centerY);
}];

源码:仅仅是block(constrainMaker),没有被self持有

- (NSArray *)mas_makeConstraints:(void(^)(MASConstraintMaker *))block {
    self.translatesAutoresizingMaskIntoConstraints = NO;
    MASConstraintMaker *constraintMaker = [[MASConstraintMaker alloc] initWithView:self];
    block(constraintMaker);
    return [constraintMaker install];
}

参考资料

读 SnapKit 和 Masonry 自动布局框架源码

iOS开发之Masonry框架源码解析

Masonry 源码解读

Masonry源码解析

链式语法使“多步配置”可以写成一行连贯的调用,如 make.left.equalTo(superview).offset(20).priorityHigh(),读起来接近自然语言。下面从构成要素、实现原理、与 Builder 的关系、多属性链式四方面展开。

3.6.1 链式语法的三要素
要素 说明 在 Masonry 中的体现
统一返回类型 每一步方法返回的类型与“可继续调用的对象”一致,通常是 self 或协议类型。 equalTooffsetpriority 等均返回 MASConstraint *(或 id<MASConstraint>),调用方可持续 .xxx
返回 self 或当前对象 方法内部完成“设置”后,返回当前对象本身,而不是 void 或无关类型。 offset(CGFloat) 内部设置 layoutConstant,然后 return selfequalTo(id) 设置 secondViewAttributereturn self
可选的 Block 封装 若参数需要延迟求值或复杂逻辑,可用 Block 作为 getter 的返回值,Block 内再 return self。 offsetmultipliedBy 等用“返回 Block 的 getter”,调用方写 .offset(20) 即调用该 Block(20),Block 内设置后 return self。

因此链式语法的实现核心可归纳为:Getter 返回 Block 或直接返回 self;Block 的返回值是当前对象,使每次调用后仍可继续点语法调用。

3.6.2 链式调用与 Builder / 流式接口

链式 API 在《领域驱动设计》等文献中常被称为 流式接口(Fluent Interface):通过方法链使调用读起来像一句“句子”,降低认知负担。与 建造者模式(Builder) 的关系:

  • Builder:通常有一个“最终步骤”(如 build()install()),前面步骤只配置内部状态,不产生最终产品;链式调用用于配置。
  • Masonry:前面步骤(leftequalTooffsetpriority)都是配置,最终“产出”发生在 install 阶段(Block 执行完后由 Maker 统一 install)。因此 Masonry 的链式 + 两阶段(描述 → install)与 Builder 的思想一致。

区别在于:Masonry 的“产品”是约束描述对象(MASConstraint),真正的 NSLayoutConstraint 在 install 时由 Maker 遍历描述对象再生成;Builder 模式里通常是 Director 调用 Builder 的 build 得到产品。共同点都是:链式写配置,最后一步才真正“构建”

3.6.3 完整调用链示意(一步一返回)

make.left.equalTo(superview).offset(20).priorityHigh() 为例,每一步的“谁在返回”如下:

sequenceDiagram
  participant C as 调用方
  participant M as MASConstraintMaker
  participant V as MASViewConstraint

  C->>M: make.left
  M->>M: addConstraintWithLayoutAttribute(Left)
  M->>V: 创建并加入 constraints
  M-->>C: 返回 V (MASConstraint)

  C->>V: .equalTo(superview)
  V->>V: 设置 secondViewAttribute
  V-->>C: return self (V)

  C->>V: .offset(20)
  V->>V: 设置 layoutConstant = 20
  V-->>C: return self (V)

  C->>V: .priorityHigh()
  V->>V: 设置 priority
  V-->>C: return self (V)

因此:make.left 返回的是 MASViewConstraint(单条约束描述);之后的 equalTooffsetpriorityHigh 都是这条 MASViewConstraint 的方法,每次返回 self,形成链。

3.6.4 多属性链式(make.top.left)与委托机制

当写成 make.top.left 时,表示“两条独立约束”:top 一条、left 一条。流程是:

  1. make.top:Maker 创建一条 MASViewConstraint(top),加入 constraints 数组,返回这条 MASViewConstraint
  2. 调用方继续 .left:此时是 MASViewConstraint 的 .left 被调用(因为 MASConstraint 协议也声明了 left、right、top 等属性)。
  3. MASViewConstraint 的 left 实现:在自身再绑一条 left,而是委托回 Maker[self.delegate constraint:self addConstraintWithLayoutAttribute:NSLayoutAttributeLeft]。Maker 发现传入的 constraint 非 nil(即当前已有一条 top),会创建 MASCompositeConstraint,把“原来的 top”和“新的 left”包在一起,并在 constraints 数组里用 composite 替换原来的 single constraint

因此 make.top.left 在 Maker 内部表现为:数组里有一条 MASCompositeConstraint,其内部有两条 MASViewConstraint(top、left)。这样既满足“链式写法”,又保证语义是“两条约束”而不是“一条约束有两个属性”。

3.6.5 链式语法的实现核心(代码级)

核心思路:Getter 返回一个 Block,Block 的返回值是当前对象(或约束对象),从而形成链。

// 概念示例:链式 Block 属性
typedef MASConstraint * (^ChainBlock)(CGFloat value);

- (ChainBlock)offset {
    return ^MASConstraint *(CGFloat value) {
        self.layoutConstant = value;
        return self;  // 返回自身,支持继续 .priority(...) 等
    };
}

调用顺序示例:make.left.equalTo(superview).offset(20).priority(High) → 先确定“左、等于、目标”,再设 constant,再设优先级,每一步返回可链式对象。

与“非链式”的对比(同一语义):

// 非链式:每步无返回值或返回 void,无法连续写
[constraint setSecondViewAttribute:...];
[constraint setLayoutConstant:20];
[constraint setPriority:MASLayoutPriorityDefaultHigh];

// 链式:每步返回 self,可连续写
[[[constraint equalTo:superview] offset:20] priorityHigh];
// 或写成点语法:constraint.equalTo(superview).offset(20).priorityHigh();
3.6.6 自实现简易链式 API 模板(Objective-C)

若在业务中需要类似 Masonry 的链式配置,可参考以下模板(思想与 Masonry 一致):

// 1. 协议或抽象类型:所有“可链”方法返回自身类型
@protocol Chainable <NSObject>
- (id<Chainable>)offset:(CGFloat)value;
- (id<Chainable>)priority:(UILayoutPriority)priority;
@end

// 2. 实现类:每个方法设置后 return self
@interface MyConstraint : NSObject <Chainable>
@end
@implementation MyConstraint
- (id<Chainable>)offset:(CGFloat)value {
    self.layoutConstant = value;
    return self;
}
- (id<Chainable>)priority:(UILayoutPriority)priority {
    self.priorityValue = priority;
    return self;
}
@end

// 3. 使用:链式调用
MyConstraint *c = [[MyConstraint alloc] init];
[[c offset:20] priority:UILayoutPriorityDefaultHigh];
// 或若用 Block 属性:c.offset(20).priority(High);

3.7 equalTo / offset 的链式返回原理(源码级)

链式得以成立的前提是:每一步方法返回的都是“可继续调用的对象”。在 Masonry 中:

  • equalTo(id):在 MASViewConstraint 中,会设置 secondViewAttribute(目标视图与属性),并 return self(即当前 MASConstraint),因此可继续写 .offset(20)
  • offset(CGFloat):内部设置 constraint 的 layoutConstant,同样 return self,故可再写 .priority(...)
  • priority(...):设置优先级后仍 return self,便于需要时再链其他修饰。

因此 make.left 返回的是一条“未完成”的 MASViewConstraint;.equalTo(superview) 补全“关系与目标”并仍返回这条约束;.offset(20) 补全 constant 并仍返回同一条约束。同一条约束对象在 Block 执行过程中被逐步“填满”,最后在 Maker 的 install 阶段统一生成 NSLayoutConstraint。若 secondItem 为 nil(如 make.width.mas_equalTo(100)),则对应系统约束的 toItem 为 nil、secondAttribute 为 NSLayoutAttributeNotAnAttribute,表示“与常量比较”。


4. 约束的生成与安装

4.1 安装流程(泳道图)

sequenceDiagram
  participant U as 开发者
  participant V as View
  participant M as MASConstraintMaker
  participant C as MASConstraint
  participant S as 系统 Auto Layout

  U->>V: mas_makeConstraints:
  V->>V: translatesAutoresizingMaskIntoConstraints = NO
  V->>M: 创建 Maker(view)
  V->>M: 执行 block(maker)
  loop 每条约束描述
    U->>M: make.xxx.equalTo(...).offset(...)
    M->>C: 添加/创建 MASConstraint
  end
  M->>C: install
  loop 每条 MASConstraint
    C->>S: 创建并激活 NSLayoutConstraint
  end
  S-->>V: 布局更新

4.2 约束收集与安装算法(伪代码)

阶段一:收集(Block 执行过程中不立即创建 NSLayoutConstraint,只记录描述)

// UIView+MASAdditions
function mas_makeConstraints(block):
    self.translatesAutoresizingMaskIntoConstraints = NO
    maker = [[MASConstraintMaker alloc] initWithView:self]
    block(maker)   // 执行过程中,make.left 等向 maker 内部数组追加 MASConstraint
    return [maker install]

// MASConstraintMaker -install
function install:
    constraints = 本 Maker 已收集的 MASConstraint 列表(单条 + 复合展开后的叶子)
    for each constraint in constraints:
        constraint.install   // 复合约束递归调用子约束的 install
    return constraints

阶段二:安装(将每条 MASViewConstraint 转为系统约束并激活)

// MASViewConstraint -install
function install:
    if alreadyInstalled then return
    layoutConstraint = [NSLayoutConstraint constraintWithItem: firstViewAttribute.view
        attribute: firstViewAttribute.layoutAttribute
        relatedBy: self.layoutRelation
        toItem: secondViewAttribute.view
        attribute: secondViewAttribute.layoutAttribute
        multiplier: self.layoutMultiplier
        constant: self.layoutConstant]
    layoutConstraint.priority = self.priority
    layoutConstraint.active = YES   // 或 addConstraint: 到公共 ancestor
    self.installedConstraint = layoutConstraint

说明:复合约束(如 edges)在 install 时遍历其子 MASViewConstraint 并逐一执行上述安装逻辑,保证与单条约束同一套路径,符合组合模式“统一接口”的语义。

4.3 mas_updateConstraints 只更新 constant 的原理

mas_updateConstraints:mas_makeConstraints: 共用同一个 Maker 类型,但行为不同:

  • make:每次在 Block 里调用 make.xxx 都会新增一条 MASConstraint 并加入列表,install 时全部新建 NSLayoutConstraint 并激活。
  • update:Masonry 会为当前视图维护“已由 Masonry 安装的约束”的引用;执行 update 的 Block 时,对 make.xxx 的调用会匹配到已有约束(按布局属性等匹配),仅修改该约束的 constant(以及 multiplier/priority 等可写字段),而再创建新的 NSLayoutConstraint。

因此“只改 constant”的语义在源码层体现为:根据 Block 中访问的属性(如 make.top)找到之前 install 时生成的那条 MASViewConstraint,调用其 setLayoutConstant: 或等价方法,并同步到已存在的 NSLayoutConstraint 的 constant 属性。若 Block 里写了之前 make 时从未出现过的属性,部分版本会新建一条约束(行为以官方实现为准)。这也解释了为何“布局结构不变、只改间距或动画”时推荐用 update,可避免重复约束或多余约束对象。

4.4 与系统 Auto Layout 的衔接

Masonry 不实现自己的布局引擎,而是 生成并激活 NSLayoutConstraint(或其子类 MASLayoutConstraint),完全依赖系统 Auto Layout(及底层 Cassowary 求解器)。约束在 install 时会被添加到合适的视图上:若约束涉及两个视图(firstItem、secondItem),通常添加到二者的公共祖先或 firstItem 的父视图上,以便布局引擎正确参与计算。因此与 Interface Builder、手写约束可混用;约束冲突、无法满足等仍由系统报错。调试时可为约束设置 identifier,在 Xcode 的约束列表与控制台报错中会显示该标识,便于定位冲突约束。

4.5 约束挂载视图与 install 细节(据掘金等源码分析)

结合掘金文章 [[19]] 与源码,install 阶段还有以下要点,便于理解“约束到底加在哪个 view 上”。

Maker 的 install 入口

  • 若为 remake(removeExisting = YES),会先通过 [MASViewConstraint installedConstraintsForView:self.view] 取出该视图上已由 Masonry 安装的约束,逐个 uninstall,再执行后续 install。
  • 遍历 maker 的 constraints 数组,对每条 MASConstraint 调用 constraint.install;install 完成后会清空 maker 的数组,避免重复使用。

MASViewConstraint 的 install:决定 installedView

  • 仅尺寸约束(width/height):约束只涉及当前视图自身,没有 secondItem。此时将 当前视图的父视图 作为约束的“关联视图”(secondLayoutItem),以便系统正确解析;约束会添加到当前视图或父视图上(源码中 firstViewAttribute.isSizeAttribute 时 installedView = firstViewAttribute.view)。
  • 存在相对视图(如 equalTo(otherView.mas_top)):会求两个视图的 最近公共父视图(closestCommonSuperview),把 NSLayoutConstraint 添加在该公共祖先 上,这样布局引擎才能同时约束到两个子视图。
  • 其他情况(如只与 superview 某边对齐):通常将约束添加在 firstViewAttribute.view.superview 上。

伪代码(installedView 的选取逻辑) [[19]]:

if (self.secondViewAttribute.view != nil) {
    installedView = [firstView mas_closestCommonSuperview:secondView];
    NSAssert(installedView, @"couldn't find a common superview for %@ and %@", firstView, secondView);
} else if (firstViewAttribute.isSizeAttribute) {
    installedView = firstViewAttribute.view;
} else {
    installedView = firstViewAttribute.view.superview;
}
// 最后将创建的 NSLayoutConstraint 添加到 installedView,并记录到 mas_installedConstraints

update 与 add:若是更新已有约束(updateExisting = YES),会先查找已安装的约束中匹配的那条,只修改其 constant(或 multiplier/priority 等),不新增;否则创建新的 NSLayoutConstraint 并 add 到 installedView,同时记录到视图的 mas_installedConstraints 以便后续 update/uninstall 使用。


5. 关键实现技巧

5.1 包装标量与结构体:mas_equalTo 与 MASBoxValue

系统 API 的 equalTo: 等往往需要 id 类型;而开发中常需传入 CGFloat、CGSize、CGPoint 等。Masonry 通过 mas_equalTo(...) 宏将标量/结构体装箱为 NSValue/NSNumber,再交给内部 equalTo:

#define mas_equalTo(...)  equalTo(MASBoxValue((__VA_ARGS__)))

MASBoxValue 利用 @encode(__typeof__(value)) 获取类型编码,再根据类型将 C 标量或结构体包装为 NSNumber/NSValue,从而统一走 id 接口。这样即可写出:

make.size.mas_equalTo(CGSizeMake(100, 100));
make.center.mas_equalTo(CGPointZero);

5.2 Block 与循环引用

Masonry 的 Block 会捕获外部变量(如 selfotherView),但 Block 本身并未被 self 长期持有:仅在 mas_makeConstraints: 执行期间调用一次 block(maker),执行完毕即结束,因此不会形成 self → Block → self 的循环引用 [[13]]。

// 源码中仅是 block(constraintMaker),没有被 self 持有
- (NSArray *)mas_makeConstraints:(void(^)(MASConstraintMaker *))block {
    self.translatesAutoresizingMaskIntoConstraints = NO;
    MASConstraintMaker *constraintMaker = [[MASConstraintMaker alloc] initWithView:self];
    block(constraintMaker);
    return [constraintMaker install];
}

5.3 抽象方法小技巧:MASMethodNotImplemented

基类中“必须由子类实现”的方法,若直接空实现容易导致静默错误。Masonry 使用宏在未重写时抛异常,明确约定子类必须重写:

#define MASMethodNotImplemented() \
    @throw [NSException exceptionWithName:NSInternalInconsistencyException \
        reason:[NSString stringWithFormat:@"You must override %@ in a subclass.", NSStringFromSelector(_cmd)] \
        userInfo:nil]

三、设计模式与延伸

模式/技巧 在 Masonry 中的体现
组合模式 MASConstraint 协议 + MASViewConstraint(叶子)+ MASCompositeConstraint(组合),形成约束树。详见 §2。
工厂思想 Maker 根据属性(left/edges/…)创建对应约束对象,调用方不直接 new;角色映射、单属性/复合创建流程见 §3.1;与简单工厂对比见 §3.1.4。
链式/流式接口 Block 属性 getter 返回“带返回值的 Block”,Block 内 return self,形成链式调用;三要素、多属性链式与自实现模板见 §3.6。
装箱(BoxValue) 标量/结构体通过 @encode 与 va_arg 统一装箱为 id,供 equalTo 使用。
抽象方法 MASMethodNotImplemented 宏在基类中抛异常,强制子类重写。

提炼与串联:上述模式与思想在 Masonry 中的协作关系、伪代码模板及“按目标选模式”的清单,见 §五、编程思想与设计模式提炼总结(思维导图、流程图、可复用伪代码)。


四、Masonry 中的优秀编程思想

Masonry 在 API 设计与源码实现中体现了一系列可复用的编程思想,理解这些思想有助于在业务代码或自研 DSL 中借鉴其设计。

1. 流式接口(Fluent Interface):把复杂留给自己,把简单留给调用方

思想:每次调用返回“可继续操作的对象”,使多步操作在调用方看来像一句连贯的“句子”,读起来接近自然语言,写起来不易漏参数、不易顺序错。

在 Masonry 中的体现make.left.equalTo(superview).offset(20).priorityHigh() 中,每一步都返回 MASConstraint(或 self),从而可以持续链下去。链式语法的三要素、完整调用链与多属性链式(如 make.top.left)的委托机制详见 §3.6 链式语法完整解析

代码案例:自实现简易链式 API(思想与 Masonry 一致)

// 思想:getter 返回 Block,Block 内完成“设置 + 返回 self”,调用方即可继续链
@interface MyConstraint : NSObject
@property (nonatomic, assign) CGFloat constant;
- (MyConstraint * (^)(CGFloat))offset;
@end
@implementation MyConstraint
- (MyConstraint * (^)(CGFloat))offset {
    return ^MyConstraint *(CGFloat value) {
        self.constant = value;
        return self;  // 返回自身,支持 .priority(...) 等后续调用
    };
}
@end
// 使用方式与 Masonry 一致:make.left.equalTo(sv).offset(20).priority(High);

2. 领域特定语言(DSL):用“业务语言”描述约束

思想:不暴露底层概念(如 NSLayoutAttribute、multiplier、constant),而是提供贴近“布局意图”的词汇(left、equalTo、offset),让代码即文档。

在 Masonry 中的体现:开发者写的是“左边等于某视图”“偏移 20”“优先级高”,而不是“item1.attributeLeft relation item2.attributeLeft multiplier 1 constant 20”。

代码案例:Masonry 写法 vs 系统写法

// 系统 API:意图被冗长参数淹没
[NSLayoutConstraint constraintWithItem:subview
                             attribute:NSLayoutAttributeLeft
                             relatedBy:NSLayoutRelationEqual
                                toItem:superview
                             attribute:NSLayoutAttributeLeft
                            multiplier:1.0
                              constant:20];

// Masonry DSL:意图一目了然
[subview mas_makeConstraints:^(MASConstraintMaker *make) {
    make.left.equalTo(superview).offset(20);
}];

3. 组合模式统一接口:单条与复合用同一套 API

思想:调用方不区分“单条约束”还是“多条约束的集合”,都通过同一类型(MASConstraint)操作;复合约束(如 edges)在内部展开为多条,但对外呈现一致。

在 Masonry 中的体现make.left 返回 MASConstraint,make.edges 也返回 MASConstraint(实为 MASCompositeConstraint),都可继续 .equalTo(...).offset(...)。组合模式在 Masonry 中的角色与树状结构见 二、2. 组合模式与约束树;可复用伪代码见 五、5.3 伪代码 ①


4. 延迟执行与两阶段处理:先描述,再安装

思想:Block 执行阶段只“收集意图”,不立刻产生副作用(不立刻 addConstraint);等 Block 结束后再统一 install。这样便于做约束去重、批量激活、与系统 API 的对接。

在 Masonry 中的体现block(maker) 时只往 Maker 内部数组追加 MASConstraint;[maker install] 时才创建 NSLayoutConstraint 并激活。

代码案例:两阶段伪代码

// 阶段一:描述(无副作用)
- (NSArray *)mas_makeConstraints:(void (^)(MASConstraintMaker *))block {
    self.translatesAutoresizingMaskIntoConstraints = NO;
    MASConstraintMaker *maker = [[MASConstraintMaker alloc] initWithView:self];
    block(maker);   // 仅填充 maker 的约束数组,未修改视图层级
    return [maker install];  // 阶段二:统一安装
}

5. 装箱与类型擦除:统一标量与对象入口

思想:系统 API 往往只接受 id(对象),而业务中大量使用 CGFloat、CGSize、CGPoint 等值类型。通过“装箱”把值类型包成对象,对外提供统一接口(如 mas_equalTo),内部再根据类型解码。

在 Masonry 中的体现mas_equalTo(100)mas_equalTo(CGSizeMake(80, 80)) 通过 MASBoxValue 转为 NSNumber/NSValue,再走 equalTo:。

代码案例:MASBoxValue 思想简化版

// 宏:任意类型都先装箱再交给 equalTo
#define mas_equalTo(...)  equalTo(MASBoxValue((__VA_ARGS__)))

// 使用:调用方无需区分“传对象”还是“传标量”
[view mas_makeConstraints:^(MASConstraintMaker *make) {
    make.size.mas_equalTo(CGSizeMake(100, 100));  // 结构体
    make.width.mas_equalTo(200);                   // 标量
    make.center.equalTo(otherView);                // 对象
}];

6. 抽象基类与“必须重写”的明确约定

思想:基类定义模板方法,子类必须实现某一步;若子类未实现就调用,应立刻失败并给出清晰原因,而不是静默错误或未定义行为。

在 Masonry 中的体现:MASConstraint 的抽象方法用 MASMethodNotImplemented 宏,在未重写时抛异常并指明“必须在子类中重写 xxx”。

代码案例:自实现基类中的“必须重写”

#define MASMethodNotImplemented() \
    @throw [NSException exceptionWithName:NSInternalInconsistencyException \
        reason:[NSString stringWithFormat:@"You must override %@ in a subclass.", NSStringFromSelector(_cmd)] \
        userInfo:nil]

@interface MASAbstractConstraint : NSObject
- (void)install;  // 子类实现
@end
@implementation MASAbstractConstraint
- (void)install {
    MASMethodNotImplemented();  // 若子类未重写,调用此处即崩溃并提示
}
@end

7. 编程思想小结(可复用清单)

思想 核心要点 可复用于
流式接口 每步返回 self/可链对象,形成连贯调用 构建器、配置 API、链式校验
DSL 用领域词汇封装底层概念,代码即文档 配置、查询、布局、路由
组合统一接口 单元素与集合同一类型,透明展开 树形结构、批量操作
两阶段 先收集描述再统一执行,便于优化与扩展 批量网络请求、事务、布局
装箱/类型擦除 值类型统一为对象接口,内部再解码 跨类型容器、序列化、API 兼容
抽象方法显式失败 未重写时抛异常并说明,避免静默错误 模板方法、插件、子类契约

五、编程思想与设计模式提炼总结

本节对 Masonry 中使用的编程思想设计模式做统一提炼:用思维导图总览、用流程图串联协作关系、用伪代码与模板固化“可迁移”的写法,便于在其它 DSL、配置类 API 或自研框架中复用。


5.1 思维导图:Masonry 编程思想与设计模式总览

mindmap
  root((Masonry 思想与模式))
    设计模式
      组合模式
        Component: MASConstraint 协议
        Leaf: MASViewConstraint
        Composite: MASCompositeConstraint
        统一接口 单条与复合一致
      工厂思想
        Creator: MASConstraintMaker
        Product: MASConstraint
        工厂方法: addConstraintWithLayoutAttribute
        按需创建 调用方不 new
      建造者思想
        两阶段: 描述 → install
        链式配置 最后统一构建
    编程思想
      流式接口
        每步 return self
        Block 返回自身 形成链
      领域特定语言 DSL
        业务词汇 隐藏底层概念
        left equalTo offset
      两阶段处理
        阶段一 收集描述
        阶段二 统一安装
      装箱与类型擦除
        mas_equalTo MASBoxValue
        标量/结构体 → id
      抽象方法显式失败
        MASMethodNotImplemented
        未重写即抛异常
    协作关系
      入口: mas_makeConstraints
      Maker 工厂 生产 Constraint
      Constraint 链式 配置 再 install

5.2 流程图:从 API 调用到约束生效(模式协作)

下图展示“一次完整布局”中,各模式与思想如何串联:入口工厂创建链式配置两阶段 install组合展开系统约束

flowchart TB
  subgraph 入口与两阶段
    A[开发者 mas_makeConstraints block]
    A --> B[阶段一: block maker]
    B --> C[阶段二: maker install]
  end

  subgraph 工厂与产品
    B --> D[Maker 工厂]
    D --> E{请求属性?}
    E -->|单属性 left/width| F[创建 MASViewConstraint]
    E -->|复合 edges/size| G[创建 MASCompositeConstraint]
    F --> H[返回 MASConstraint]
    G --> H
  end

  subgraph 链式与组合
    H --> I[链式 equalTo offset priority]
    I --> J[每步 return self]
    J --> C
    C --> K[遍历 constraints]
    K --> L{当前项类型?}
    L -->|Leaf| M[单条 install → NSLayoutConstraint]
    L -->|Composite| N[递归子约束 逐一 install]
    N --> M
  end

  subgraph 系统层
    M --> O[添加到公共祖先 / view]
    O --> P[Auto Layout 引擎]
    P --> Q[布局生效]
  end

提炼要点

  • 两阶段:描述(block)与执行(install)分离,便于批量、去重、与系统 API 对接。
  • 工厂:Maker 根据“请求”生产单条或组合约束,调用方只依赖 MASConstraint
  • 链式:配置过程每步返回 self,形成一句“句子”。
  • 组合:install 时对 Leaf 与 Composite 统一调用 install,Composite 内部递归子约束。

5.3 设计模式与编程思想提炼表(含伪代码)

下表将每种模式/思想抽象为:解决的问题核心做法Masonry 对应可复用伪代码适用场景,便于直接迁移到其它项目。

模式/思想 解决的问题 核心做法 Masonry 对应 伪代码骨架 适用场景
组合模式 单条与集合使用方式不一致 定义统一 Component 接口,Leaf 与 Composite 都实现;Composite 持有子节点,操作时递归 MASConstraint / MASViewConstraint / MASCompositeConstraint 见下文伪代码 ① 树形结构、批量操作、配置项分组
工厂思想 调用方与具体产品类耦合 由“工厂”根据请求创建具体产品,调用方只依赖抽象产品 Maker + addConstraintWithLayoutAttribute 见下文伪代码 ② 多种产品、按参数/类型创建、隐藏构造细节
流式接口 多步配置冗长、易漏参数 每步方法返回 self(或可链对象),形成链式调用 equalTo / offset / priority 均 return self 见下文伪代码 ③ 构建器、配置 API、校验链、DSL
两阶段处理 边描述边执行难以优化、易产生重复副作用 阶段一仅收集描述(不执行),阶段二统一执行 block(maker) 只填充数组;install 时再创建并添加 见下文伪代码 ④ 批量请求、事务、布局、表单校验
DSL 底层概念暴露、意图不直观 用领域词汇封装底层 API,让“写什么像什么” left、equalTo、offset、edges 见下文伪代码 ⑤ 配置、查询、布局、路由、规则引擎
装箱/类型擦除 系统 API 只接受 id,业务多用值类型 将标量/结构体装箱为对象,统一入口,内部再解码 mas_equalTo、MASBoxValue 见下文伪代码 ⑥ 跨类型容器、序列化、多态参数
抽象方法显式失败 子类未重写导致静默错误 基类“必须重写”的方法内抛异常并说明 MASMethodNotImplemented 见下文伪代码 ⑦ 模板方法、插件接口、子类契约

伪代码 ① 组合模式

protocol Component { func install() }
class Leaf: Component { func install() { /* 执行单条逻辑 */ } }
class Composite: Component {
    var children: [Component]
    func install() { children.forEach { $0.install() } }
}
// 调用方:component.install(),不关心是 Leaf 还是 Composite

伪代码 ② 工厂思想

class Maker {
    func left() -> Product { return create(.left) }
    func edges() -> Product { return composite([.left, .right, .top, .bottom]) }
    private func create(_ attr: Attribute) -> Product {
        let p = ConcreteProduct(attr)
        constraints.append(p)
        return p
    }
}
// 调用方:let c = maker.left(); 不 new ConcreteProduct

伪代码 ③ 流式接口

func offset(_ value: T) -> Self {
    self.value = value
    return self
}
func priority(_ p: P) -> Self {
    self.priority = p
    return self
}
// 调用:obj.offset(20).priority(high)

伪代码 ④ 两阶段处理

func make(block: (Maker) -> Void) -> Result {
    let maker = Maker()
    block(maker)      // 阶段一:只填充 maker 内部结构
    return maker.build()  // 阶段二:统一执行、产生副作用
}

伪代码 ⑤ DSL 封装

// 底层:setAttribute(Left, relation: Equal, to: view, attribute: Left, constant: 20)
// DSL:make.left.equalTo(view).offset(20)
// 实现:left 返回约束描述对象,equalTo 设目标,offset 设 constant,均 return self

伪代码 ⑥ 装箱

func box(_ value: Any) -> Id {
    if value is CGFloat { return NSNumber(value) }
    if value is CGSize { return NSValue(value) }
    // ...
}
func equalTo(_ id: Id) { /* 内部根据类型解码 */ }

伪代码 ⑦ 抽象方法显式失败

func mustOverride() {
    throw Exception("You must override \(method) in a subclass.")
}
// 基类中:func install() { mustOverride() }

5.4 流程图:六大思想在“一句话布局”中的分工

以一句 make.left.equalTo(superview).offset(20) 为例,下图标出每一步对应的思想或模式,便于记忆与迁移。

flowchart LR
  A[make] --> B[left]
  B --> C[equalTo]
  C --> D[offset]
  D --> E[install]

  subgraph 对应思想
    A1[两阶段入口]
    B1[工厂: 按 left 创建约束]
    C1[DSL: 业务语汇]
    D1[流式: return self]
    E1[两阶段: 统一 install]
  end

  A -.-> A1
  B -.-> B1
  C -.-> C1
  D -.-> D1
  E -.-> E1

5.5 可复用设计清单(按“想实现什么”选模式)

若要在业务中实现类似 Masonry 的体验,可按目标选择对应模式与伪代码模板。

目标 推荐模式/思想 参考伪代码
让“单条”与“一组”用同一套 API 组合模式 §5.3 伪代码 ①
根据“请求类型”创建不同对象,调用方不 new 工厂思想 §5.3 伪代码 ②
多步配置写成一句链式调用 流式接口 §5.3 伪代码 ③
先收集再统一执行(批量、事务、布局) 两阶段处理 §5.3 伪代码 ④
用业务词汇隐藏底层 API DSL §5.3 伪代码 ⑤
值类型与对象统一入口 装箱/类型擦除 §5.3 伪代码 ⑥
基类要求子类必须实现某方法 抽象方法显式失败 §5.3 伪代码 ⑦

5.6 小结:提炼后的编程思想一句话

  • 组合:单条与复合同一接口,操作时递归子节点。
  • 工厂:谁要谁造,调用方只拿抽象产品。
  • 流式:每步 return self,链成一句“话”。
  • 两阶段:先描述后执行,便于优化与扩展。
  • DSL:用领域词汇说话,代码即文档。
  • 装箱:值类型进“盒子”,统一走对象接口。
  • 显式失败:该子类实现的没实现,立刻报错不隐瞒。

上述思想与模式在 Masonry 中同时存在、相互配合:入口用两阶段,Maker 用工厂,约束用流式与组合,标量用装箱,基类用显式失败。理解并提炼后,可在任意“配置型、构建型、DSL 型”的 API 设计中按需复用。


参考文献

[1] SnapKit. Masonry. GitHub. github.com/SnapKit/Mas…

[2] SnapKit. SnapKit. GitHub. github.com/SnapKit/Sna…

[3] Apple. Auto Layout Guide. Developer Documentation.

[4] Sarunw. History of Auto Layout constraints. sarunw.com/posts/histo…

[5] Wikipedia. Cassowary (software). en.wikipedia.org/wiki/Cassow…

[6] Larder. What's in your Larder: iOS layout DSLs. larder.io/blog/larder…

[7] Cassowary. Solving constraint systems. cassowary.readthedocs.io/en/latest/t…

[8] University of Washington. Cassowary Constraint Solving Toolkit. constraints.cs.washington.edu/cassowary/

[9] Badros, G. J., Borning, A., & Marriott, K. (1997). Solving Linear Arithmetic Constraints for User Interface Applications. Proceedings of the 1997 ACM Symposium on User Interface Software and Technology (UIST).

[10] University of Washington. Cassowary TOCHI. constraints.cs.washington.edu/solvers/cas…

[11] 设计模式:组合模式(Composite Pattern). Runoob. www.runoob.com/design-patt…

[12] 设计模式:工厂方法. Runoob. www.runoob.com/design-patt…

[13] 读 SnapKit 和 Masonry 自动布局框架源码. 戴铭. ming1016.github.io/2018/04/07/…

[14] Masonry:iOS AutoLayout的革命性简化框架. CSDN. blog.csdn.net/gitblog_005…

[15] 源码解读——Masonry. 楚权的世界. chuquan.me/2019/10/02/…

[16] iOS中Masonry的使用总结. 星星的博客. smileasy.github.io/2019/04/01/…

[17] iOS自动布局框架之Masonry. 腾讯云开发者社区. cloud.tencent.com/developer/a…

[18] 浅析Masonry. HelloBit. www.hellobit.com.cn/doc/2020/6/…

[19] Mcyboy. Masonry实现原理并没有那么可怕. 掘金. juejin.cn/post/684490…

[20] 掘金. Masonry 相关文章. juejin.cn/post/684490…


延伸阅读

  • SnapKit:Masonry 的 Swift 继任者,本系列《04-SnapKit框架:从使用到源码解析》可对照学习。
  • Auto Layout 内在尺寸:Content Hugging 与 Compression Resistance 在 Apple《Auto Layout Guide》中的说明。
  • Cassowary 论文:深入理解约束层次与增量求解,便于分析复杂布局冲突与性能。
  • iOS 设计模式 Swift 实现(组合模式、工厂模式):可参考开源仓库如 iOS_Design_Patterns_Swift 等。
  • Masonry 官方源码github.com/SnapKit/Mas… ,建议结合本文“源码解析”章节对照阅读 MASConstraintMaker、MASViewConstraint、MASCompositeConstraint 等实现。
  • 掘金《Masonry实现原理并没有那么可怕》 [[19]]:从 makeConstraints、make(Maker)、install、equalTo 四条线梳理原理,含链式多属性(make.top.left)的委托与复合替换、约束挂载视图(closestCommonSuperview)等,可与本文 §1.3、§4.5 对照阅读。
❌
❌