AppAuth-iOS 中 OIDAuthState 反序列化问题的深度解析

问题背景

在 iOS 应用开发中，使用 AppAuth-iOS 库进行 OAuth 2.0 授权时，开发者经常会遇到需要持久化授权状态（OIDAuthState）的场景。近期有开发者反馈，在使用新版 NSKeyedUnarchiver API 进行反序列化时遇到了返回 nil 的问题，而旧版 API 却能正常工作。

核心问题分析

新旧 API 差异

旧版序列化方式：

OIDAuthState *authState = [NSKeyedUnarchiver unarchiveObjectWithData:archivedAuthState];

新版安全编码方式：

NSError *errRet1;
OIDAuthState *authState1 = [NSKeyedUnarchiver unarchivedObjectOfClass:[OIDAuthState class]
           fromData:archivedAuthState error:&errRet1];

问题根源

1. 安全编码要求：新版 API 要求显式声明所有可能的数据类型，而旧版 API 则较为宽松。

2. 嵌套对象问题：OIDAuthState 内部包含 OIDServiceDiscovery 等复杂对象，这些对象又可能包含 NSDictionary、NSArray 等集合类型。

3. NSNull 处理：当服务端返回 JSON 中包含 null 值时，系统会转换为 NSNull 对象，而默认的安全编码类集合中不包含 NSNull。

技术解决方案

1. 服务发现配置解码修正

在 OIDServiceConfiguration.m 中，需要扩展可解码的类集合：

OIDServiceDiscovery *discoveryDocument = [aDecoder decodeObjectOfClasses:
    [NSSet setWithObjects:[OIDServiceDiscovery class], [NSDictionary class], [NSArray class], nil]
    forKey:kDiscoveryDocumentKey];

2. 服务发现文档解码优化

在 OIDServiceDiscovery.m 中，实现更完善的解码逻辑：

- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder {
  NSError *error;
  NSSet *codingClasses = [NSSet setWithArray:@[ [NSDictionary class], [NSArray class] ]];
  NSDictionary *dictionary = [aDecoder decodeObjectOfClasses:codingClasses forKey:kDiscoveryDictionary];
  self = [self initWithDictionary:dictionary error:&error];
  if (error) {
    return nil;
  }
  return self;
}

3. Token 响应中的 NSNull 处理

根据 OAuth 2.0 规范，服务端不应返回 null 值，而是应该直接省略该字段。开发者应确保：

1. 服务端遵循规范，不返回包含 null 的 JSON
2. 在客户端处理时，可以过滤掉 NSNull 值

最佳实践建议

1. 编码时：使用新版 API 并启用安全编码

NSData *archivedAuthState = [NSKeyedArchiver archivedDataWithRootObject:_authState 
    requiringSecureCoding:YES error:&error];

2. 解码时：指定所有可能的类

NSSet *classes = [NSSet setWithArray:@[
    [OIDAuthState class],
    [OIDServiceConfiguration class],
    [OIDServiceDiscovery class],
    [NSDictionary class],
    [NSArray class],
    [NSString class],
    [NSNumber class]
]];
OIDAuthState *authState = [NSKeyedUnarchiver unarchivedObjectOfClasses:classes 
    fromData:archivedAuthState error:&error];

3. 服务端交互：确保服务端响应符合 OAuth 2.0 规范，不返回 null 值字段

总结

在 AppAuth-iOS 中使用安全编码进行序列化/反序列化时，开发者需要注意完整声明所有可能的类类型，并确保数据符合规范。这个问题不仅涉及 API 的正确使用，也反映了前后端协作中遵循协议规范的重要性。通过本文的解决方案，开发者可以构建更健壮的授权状态持久化机制。