Swift OpenAPI Generator 中处理带毫秒的 ISO8601 日期时间格式

在 Swift 开发中，处理日期时间格式是一个常见但容易出错的任务。当使用 Swift OpenAPI Generator 生成的客户端与服务端交互时，经常会遇到日期时间解析的问题，特别是当服务端返回包含毫秒的 ISO8601 格式日期时。

问题背景

许多现代 API 会返回类似 2023-12-28T11:08:38.303+01:00 这样的日期时间字符串，其中包含了毫秒部分。然而，Swift 基础库中的默认 JSONDecoder 并不能正确解析这种带有毫秒的 ISO8601 格式，这会导致日期解析失败。

解决方案

Swift OpenAPI Generator 提供了一个灵活的配置选项来解决这个问题。在创建客户端实例时，可以通过 OpenAPIRuntime.Configuration 参数指定一个自定义的日期转换器。

默认情况下，系统使用的是 DateTranscoder.iso8601，它基于 Foundation 的默认设置，不支持解析带毫秒的时间戳。要解决这个问题，可以使用 .iso8601WithFractionalSeconds 替代，这个转换器专门用于处理包含毫秒的 ISO8601 格式。

实现示例

以下是如何在客户端初始化时配置日期转换器的代码示例：

let client = Client(
    serverURL: URL(string: "http://localhost:8080/api")!,
    configuration: .init(dateTranscoder: .iso8601WithFractionalSeconds),
    transport: URLSessionTransport()
)

通过这样的配置，客户端就能够正确解析服务端返回的包含毫秒的 ISO8601 日期时间字符串了。

技术细节

这种解决方案的优势在于：

1. 不需要修改 OpenAPI 规范文件
2. 保持了 API 契约的稳定性
3. 不需要手动进行字符串到日期的转换
4. 保持了代码的整洁性和一致性

对于需要处理国际化日期时间格式的应用程序，这种方法提供了一种标准化的解决方案，确保不同服务端实现返回的日期时间格式都能被正确解析。

总结

在 Swift 开发中正确处理日期时间格式对于构建健壮的应用程序至关重要。通过 Swift OpenAPI Generator 提供的配置选项，开发者可以灵活地处理各种日期时间格式，包括带毫秒的 ISO8601 格式，从而避免了常见的日期解析问题，提高了代码的可靠性和可维护性。