×
¥
查看详情
🔥 会员专享 文生文 开发

iOS类功能描述生成器

👁️ 75 次查看
📅 Dec 5, 2025
💡 核心价值: 本提示词专为iOS开发场景设计,能够根据输入的类名和功能需求,生成专业、准确、结构清晰的iOS类描述文档。它采用技术文档写作风格,确保描述内容精确客观、逻辑严密,同时避免无关信息和技术误导。该工具适用于iOS应用开发过程中的类文档编写、代码注释生成、技术方案说明等多种场景,帮助开发者快速创建高质量的类功能描述,提升开发效率和代码可维护性。

🎯 可自定义参数(4个)

类名称
需要描述的iOS类名称
主要功能
类的主要功能概述
详细说明
类的详细功能说明
技术框架
类使用的技术框架或架构

🎨 效果示例

UserSessionManager

类概述

UserSessionManager 用于统一管理应用的用户登录会话与令牌生命周期,围绕 accessToken/refreshToken 的获取、持久化、安全存储、自动刷新和登出进行封装。类通过串行队列控制并发刷新,配合 Combine 事件流广播会话变更,确保接口调用在授权失败(401)时能够自动刷新并重试一次,从而保障网络请求的安全性与稳定性。支持多环境切换(如开发/测试/生产),并提供单点登出能力。

主要功能

  • 登录与令牌获取
    • 提供 signIn(credentials):完成凭证校验与令牌交换,持久化并发布会话就绪事件。
    • 维护 accessToken/refreshToken 及其过期时间,并在 App 冷启动时从 Keychain 恢复会话状态。
  • 令牌自动刷新与重试
    • 提供 refreshIfNeeded():在访问受保护资源前/或收到 401 后,按需刷新 accessToken。
    • 当服务端返回 401 时,自动执行一次刷新并对原请求重试一次;若刷新失败,则不再二次重试,按错误分类处理。
  • 授权头生成
    • 提供 authorizationHeader():返回当前可用 accessToken 对应的 HTTP 授权头(Authorization: Bearer …);在调用方需要时与 refreshIfNeeded() 组合使用,确保令牌有效。
  • 登出与单点登出
    • 提供 signOut():清除内存与 Keychain 中的令牌并广播登出事件;支持单点登出策略(例如统一触发全局登出,联动各数据层与界面层统一清理状态)。
  • 多环境切换
    • 针对不同环境维护独立的 Keychain 命名空间或键前缀,切换环境时自动清理当前环境令牌并广播需要重新登录的状态。
  • 事件发布/订阅
    • 通过 Combine 事件流广播会话状态变化(如已登录、将过期、已刷新、已登出、刷新失败)。外部订阅者(ViewModel/Repository/拦截器)可据此做 UI 与请求层联动。
  • 并发控制
    • 刷新流程由内部私有串行队列串行化,确保同一时间仅有一次刷新操作在进行;并发触发的刷新请求会排队等待同一结果,避免“惊群效应”与多次无效刷新。
  • 错误分类与处理策略
    • 区分“凭证无效类错误”(如刷新令牌失效、账号被注销)与“网络/服务不可用类错误”(如超时、断网、5xx)。
    • 暴露重试间隔(如读取服务器 Retry-After 或内部退避策略)与上报钩子,便于埋点监控、故障告警与容量观测。

技术特点

  • 语言与架构
    • 基于 Swift 5.9,符合 MVVM + Repository 分层。UserSessionManager 聚焦会话域,依赖 Repository 承担具体网络交互(URLSession)与数据编解码(Codable)。
  • 并发模型与刷新串行化
    • 对外接口采用 Swift Concurrency(async/await)以简化调用方的异步流程。
    • 内部通过私有串行队列保证刷新流程的互斥执行;并将并发触发的刷新请求汇聚为单次刷新,其他调用挂起等待结果,刷新完成后统一恢复。
  • 网络与请求重试
    • 使用 URLSession 发起认证/刷新请求;对 401 响应执行一次性刷新与原请求单次重试,严格限制重试次数以防循环调用。
  • 安全与持久化
    • 使用 Keychain 安全存储 accessToken/refreshToken 及相关元数据(含过期时间、环境标识);数据序列化采用 Codable,便于结构化存储与向后兼容。
    • Keychain 可按业务需求配置可访问性与访问分组;环境切换采用独立键空间,避免跨环境交叉读取。
  • 事件机制
    • 暴露 Combine Publisher(例如 sessionStatePublisher/eventsPublisher)用于广播关键状态:SignedIn、TokenRefreshed、SignedOut、RefreshFailed 等,支持 UI 与网络层订阅。
  • 扩展与可测试性
    • 通过协议抽象依赖(如 AuthRepository、Clock/DateProvider、Logger/Reporter),便于单元测试注入假实现与模拟场景(过期、断网、401/5xx、无效刷新令牌)。

使用场景

  • 应用冷启动
    • 从 Keychain 读取上次会话;若令牌临期或已过期,在首个受保护请求前调用 refreshIfNeeded() 以主动续签。
  • 发起受保护 API 请求
    • 请求前调用 refreshIfNeeded(),随后从 authorizationHeader() 取 Authorization 头并附加到 URLRequest。
    • 若服务器仍返回 401,网络层拦截器触发一次刷新并对原请求重试一次;刷新失败则向上抛出错误并发出会话事件。
  • 用户登录/注销
    • 登录:调用 signIn(credentials) 完成令牌交换、持久化并广播已登录事件。
    • 注销:调用 signOut() 清空令牌、取消后续自动刷新并广播登出事件,实现单点登出。
  • 多环境切换(如 Dev/Staging/Prod)
    • 设置目标环境后,清理当前环境令牌并广播需重新登录的状态;新的登录与令牌将持久化到对应环境命名空间。
  • 风险与异常治理
    • 订阅刷新失败与登出事件,对应拉起重新登录、展示用户态提示,或触发上报钩子进行监控与报警。

注意事项

  • 刷新互斥
    • 仅允许一次刷新在串行队列中进行;并发触发会等待相同刷新结果。调用方避免在外层再引入并发锁,防止死锁或双重等待。
  • 401 重试边界
    • 每个请求最多因 401 触发一次刷新与一次重试;若仍失败,需由上层决定是否提示重新登录或执行降级策略,避免无限重试。
  • 授权头与时序
    • authorizationHeader() 默认假设当前 accessToken 可用;若需要确保有效性,请在调用前执行 refreshIfNeeded() 或通过网络拦截器在 401 时补救。
  • 错误分类与上报
    • 凭证无效类错误(如无效 refreshToken)应触发强制登出并清除令牌;网络类错误可结合重试间隔进行延迟重试或提示稍后重试。
    • 使用上报钩子记录关键事件(登录成功/失败、刷新成功/失败、登出、环境切换),并包含错误分类与重试间隔信息,便于监控与追踪。
  • Keychain 与环境隔离
    • 确保为不同环境使用独立的 Key 标识或命名空间;环境切换需清理旧环境令牌,避免跨环境污染。
    • 按需配置 Keychain 可访问性与访问分组;不在日志或崩溃上报中输出明文令牌。
  • 线程与取消
    • 对外 async 接口可能在内部切换至私有串行队列执行;调用方如需取消等待的刷新,应通过结构化并发的 Task 取消机制处理。
  • 跨模块一致性
    • 单点登出需与网络拦截器、页面路由、缓存层达成一致行为:收到强制下线或凭证无效时,统一清理态并跳转登录。
  • 限制条件
    • UserSessionManager 管理的是客户端令牌状态,无法绕过服务端策略(如令牌撤销、强制下线);若服务端判定不可刷新,客户端只能终止会话并提示重新登录。

OfflineCacheCoordinator

类概述

OfflineCacheCoordinator 用于统一管理网络数据在本地的内存/磁盘两级缓存与过期策略,核心目标是实现离线可读与稳定的性能表现。类内置 stale-while-revalidate 语义:当缓存过期时优先返回旧数据以保障响应,再在后台触发数据刷新;同时支持 LRU 淘汰、按业务域限额、TTL/标签清理、批量清除等策略,并提供后台清理与容量控制能力。

主要功能

  • 两级缓存管理
    • 内存层:基于 NSCache,按对象成本与数量限制缓存热点数据,进程内快速命中。
    • 磁盘层:基于 FileManager,将数据以文件形式持久化,支持离线可读与冷启动恢复。
  • stale-while-revalidate
    • read(key) 在命中过期数据时立即返回旧数据,并在后台触发上游数据源刷新与回写,确保低延迟与一致性渐进收敛。
    • 无网络时维持离线可读;网络恢复后自动回收并更新。
  • 统一读写接口
    • read(key):读取指定 Key 的数据;区分内存/磁盘命中与过期态,并按策略触发后台刷新。
    • write(key, value, ttl):写入或更新缓存数据,并设置 TTL;同时更新索引与访问时间。
    • prefetch(keys):批量预取一组 Key,对列表等滚动场景提前升温缓存。
  • 过期与清理策略
    • TTL 到期清理:按条目到期时间回收;支持标签清理(按标签维度清除)与正则清理(按 Key 模式批量清除)。
    • LRU 淘汰:当容量阈值达到时按最近最少使用回收。
    • 业务域配额:按 domain/namespace 设定容量上限,避免单域占满整体资源。
    • 支持按 Key、集合与正则表达式进行批量清除。
  • 性能优化
    • 大对象分片写入:对大体积数据分块落盘,降低单次 I/O 压力。
    • 后台压缩与清理:在后台线程对磁盘数据进行压缩与碎片清理,减少占用。
    • 冷启动异步恢复:应用启动时异步恢复磁盘索引,不阻塞首屏。
  • 可靠性与统计
    • 异常落盘保护与校验:临时文件写入、原子替换与校验(如长度/哈希)避免部分写入导致的数据损坏。
    • 命中率/容量统计:采集内存/磁盘命中率、对象大小分布、域内使用率,用于调优。
    • 指标与通知:结合 MetricKit 获取系统级 I/O/内存等运行指标,内部自采计数用于命中率与容量统计;通过 Combine 发布缓存事件(命中、写入、失效、清理)。

技术特点

  • 架构模式
    • Repository 模式:将缓存访问与上游数据源(网络/数据库)解耦。Coordinator 只负责缓存与刷新策略,上游数据通过协议注入,便于替换与测试。
  • 存储与编码
    • 编码解码:基于 Codable/JSONEncoder/JSONDecoder 序列化/反序列化,支持自定义策略(日期、数据精度等)。
    • 目录布局:按业务域/Key 哈希分层存储,避免单目录文件过多;缓存索引持久化保存元数据(TTL、标签、大小、最后访问时间)。
    • 原子写入:先写入临时文件并 fsync,再原子替换目标文件,降低崩溃/中断导致的数据不一致。
    • 压缩策略:在后台线程对大对象或冷数据进行压缩以节省空间;小对象可跳过压缩以降低 CPU 开销。
  • 缓存索引与 LRU
    • 维护内存索引(Key→元数据)与访问顺序结构;索引与文件系统定期校验以防漂移。
    • 按域/全局分别维持容量与 LRU 队列,触发阈值时逐步回收。
  • 并发与线程安全
    • 读多写少优化:读操作支持并发访问,写与清理通过串行队列或 Actor 序列化,避免元数据竞争与破坏 LRU 顺序。
    • I/O 全部在后台队列执行,避免阻塞主线程。
  • 后台任务与清理
    • 使用 BackgroundTasks(BGProcessingTask)在合适时机执行批量过期清理、LRU 回收、压缩与索引重建;前台访问也会按需触发轻量清理作为兜底。
  • 监控与通知
    • Combine 发布缓存事件流(例如 CacheHit、CacheMiss、StaleHit、Write、Invalidate、Trim),便于上层做 UI 或策略联动。
    • 指标采集:内部维护命中率与容量等业务指标;结合 MetricKit 的系统级指标(如磁盘写入、内存压力)进行综合调优。注意:MetricKit 不提供自定义业务计数,需要内部统计与上报机制配合。

使用场景

  • 列表/详情离线可读场景:新闻流、商品列表与详情、用户资料等,保障弱网/离线下的可用性。
  • 高并发读、偶发写的内容池:首页推荐流、配置与字典数据、搜索建议等。
  • 需要 stale-while-revalidate 的数据:在确保低时延返回的同时,实现后台一致性恢复。
  • 预取优化:滚动列表提前预热首屏外数据,降低滑动延迟与网络抖动影响。
  • 受限存储环境:按业务域配额与 LRU 淘汰,避免单域数据挤占全局资源。

注意事项

  • Key 设计
    • 建议包含业务域、版本号与参数归一化,避免同义不同 Key;禁止包含敏感信息。
    • 版本变更或数据模型变更时应通过域/命名空间升级隔离旧数据。
  • TTL 与一致性
    • TTL 应与业务容忍度匹配;过期立即返回旧数据的语义需对调用方明确(可能出现短暂的“旧数据”)。
    • 对同一 Key 的重复刷新应合并/去抖,避免过期瞬间的请求风暴。
  • 清理策略
    • 正则清理可能较慢,建议预编译正则并限制匹配范围;标签清理优先用于批量失效。
    • BackgroundTasks 的调度不保证即时执行,需保留前台访问触发的按需清理作为补充。
  • 性能与资源
    • 大对象分片与压缩会增加 CPU/I/O,需按设备与场景启用或阈值控制。
    • NSCache 的 totalCostLimit/countLimit 需要结合对象大小估算并动态调优。
  • 线程与死锁
    • 磁盘 I/O 与编码解码避免在主线程执行;对外接口若提供同步调用,应明确潜在阻塞。
  • 数据可靠性
    • 解码失败视为数据损坏,应记录并清除受影响条目,同时避免反复读取损坏文件。
    • 建议将磁盘目录标记为不参与 iCloud 备份(isExcludedFromBackup);若数据为关键离线资产且不希望系统清理,可使用 Application Support 而非 Caches。
  • 监控与上报
    • MetricKit 仅提供系统级指标;命中率、容量等业务指标需要内部统计并通过自有上报或日志系统采集。
  • 权限与配置
    • 使用 BackgroundTasks 需要在工程中声明任务标识并按要求上报调度;需要在合适时机提交任务请求,避免过度调度导致系统拒绝。

示例详情

📖 如何使用

30秒出活:复制 → 粘贴 → 搞定
与其花几十分钟和AI聊天、试错,不如直接复制这些经过千人验证的模板,修改几个 {{变量}} 就能立刻获得专业级输出。省下来的时间,足够你轻松享受两杯咖啡!
加载中...
💬 不会填参数?让 AI 反过来问你
不确定变量该填什么?一键转为对话模式,AI 会像资深顾问一样逐步引导你,问几个问题就能自动生成完美匹配你需求的定制结果。零门槛,开口就行。
转为对话模式
🚀 告别复制粘贴,Chat 里直接调用
无需切换,输入 / 唤醒 8000+ 专家级提示词。 插件将全站提示词库深度集成于 Chat 输入框。基于当前对话语境,系统智能推荐最契合的 Prompt 并自动完成参数化,让海量资源触手可及,从此彻底告别"手动搬运"。
即将推出
🔌 接口一调,提示词自己会进化
手动跑一次还行,跑一百次呢?通过 API 接口动态注入变量,接入批量评价引擎,让程序自动迭代出更高质量的提示词方案。Prompt 会自己进化,你只管收结果。
发布 API
🤖 一键变成你的专属 Agent 应用
不想每次都配参数?把这条提示词直接发布成独立 Agent,内嵌图片生成、参数优化等工具,分享链接就能用。给团队或客户一个"开箱即用"的完整方案。
创建 Agent

✅ 特性总结

一键生成结构化iOS类描述文档,涵盖概述、功能、技术特点、场景与注意事项。
基于类名与需求智能理解设计意图,自动提炼核心职责与边界,避免遗漏关键信息。
自动润色与术语统一,保持客观专业文风,让跨团队成员轻松读懂并迅速对齐理解。
同时产出功能列表与使用说明,支持直接转为代码注释或知识库页面,便于共享与检索。
模板化参数输入,按需定制结构与重点,让不同项目阶段都能快速得到合适的文档。
自动生成使用场景与注意事项,提前暴露风险与限制,减少返工和沟通时间与成本。
支持新类设计、方案评审、交付整理等场景,一次生成即可复用,打造标准化文档资产。
清晰可落地的功能拆解,帮助测试设计用例与开发拆任务,让协作范围与交付边界更明确。

🎯 解决的问题

让iOS团队在“输入类名+功能需求”的轻量操作下,快速生成标准化、可直接投用的类功能描述文档,覆盖新类设计说明、代码注释补全、方案评审材料、知识库条目与交付文档。通过清晰结构与客观表述,显著提升协作效率与代码可维护性,减少沟通偏差与返工成本,缩短迭代周期。鼓励试用以直观感受:从数小时的手工写作,缩短到几分钟的高质量产出;并引导升级解锁自定义模板、团队术语库、多语言输出与质量校验清单等增强能力,帮助团队建立统一文档标准与可复制的方法论。

🕒 版本历史

当前版本
v2.1 2024-01-15
优化输出结构,增强情节连贯性
  • ✨ 新增章节节奏控制参数
  • 🔧 优化人物关系描述逻辑
  • 📝 改进主题深化引导语
  • 🎯 增强情节转折点设计
v2.0 2023-12-20
重构提示词架构,提升生成质量
  • 🚀 全新的提示词结构设计
  • 📊 增加输出格式化选项
  • 💡 优化角色塑造引导
v1.5 2023-11-10
修复已知问题,提升稳定性
  • 🐛 修复长文本处理bug
  • ⚡ 提升响应速度
v1.0 2023-10-01
首次发布
  • 🎉 初始版本上线
COMING SOON
版本历史追踪,即将启航
记录每一次提示词的进化与升级,敬请期待。

💬 用户评价

4.8
⭐⭐⭐⭐⭐
基于 28 条评价
5星
85%
4星
12%
3星
3%
👤
电商运营 - 张先生
⭐⭐⭐⭐⭐ 2025-01-15
双十一用这个提示词生成了20多张海报,效果非常好!点击率提升了35%,节省了大量设计时间。参数调整很灵活,能快速适配不同节日。
效果好 节省时间
👤
品牌设计师 - 李女士
⭐⭐⭐⭐⭐ 2025-01-10
作为设计师,这个提示词帮我快速生成创意方向,大大提升了工作效率。生成的海报氛围感很强,稍作调整就能直接使用。
创意好 专业
COMING SOON
用户评价与反馈系统,即将上线
倾听真实反馈,在这里留下您的使用心得,敬请期待。
加载中...
📋
提示词复制
在当前页面填写参数后直接复制: