SuperAPI AI 工具集

experience-lds-best-practices-apply

编程与开发

查看项目

更新于 10-16 08:47

技能介绍

用途:为 Lightning Web Component 应用 Lightning Data Service(LDS)最佳实践,围绕数据一致性、引用完整性和 UIAPI 与 Apex 取舍三方面进行审查或实施。适用场景包括:审查组件数据层的 LDS 合规性(手写表单、字符串式字段名、Apex 与 LDS 未同步、Apex 滥用);为标准或自定义对象实现 CRUD;在 getRecord、getRecords、createRecord、updateRecord、deleteRecord、基础记录表单组件与 Apex 之间做选择;修复记录变更后的数据陈旧问题;用 @salesforce/schema 导入替换硬编码的对象/字段名。不适用于 GraphQL 查询/变更生成、上游数据需求发现、SLDS 类与设计令牌(应使用 design-systems-slds-apply),以及无障碍、安全、RTL 审查。

核心原则:标准与自定义对象的 CRUD 优先使用 LDS/UIAPI,仅当业务逻辑或批量操作超出 LDS 能力时使用 Apex;任何变更后必须用 refreshApex(wiredResult) 或 notifyRecordUpdateAvailable([{ recordId }]) 保持数据新鲜;对象与字段引用从 @salesforce/schema 导入而非字符串字面量;单记录 UI 优先使用 lightning-record-form、lightning-record-edit-form、lightning-record-view-form,它们自带校验、SLDS 样式、无障碍与字段级安全。

使用方式:先盘点组件数据层(@wire、命令式调用、读写目标、刷新路径),再按四节检查清单(手写表单、未导入引用、Apex 与 LDS 未同步、Apex 过度使用)逐项判定,每节须出现一次,或以问题形式列于 LDS Best Practices,或以合规形式列于 Sections checked (no issue),最后给出 Summary 计数与叙述;修复引用完整性时用 import NAME_FIELD from '@salesforce/schema/Account.Name';修复数据一致性时在 updateRecord/createRecord/deleteRecord 后调用 refreshApex 或 notifyRecordUpdateAvailable;能用 UIAPI 替代 Apex 时优先替代(单记录读 getRecord、更新 updateRecord、创建 createRecord、关联记录 getRelatedListRecords、选项值 getPicklistValues、对象元数据 getObjectInfo / getObjectInfos)。

限制与前置条件:需要组件路径、了解组件数据操作与是否涉及 Apex、以及访问组织的 schema(Setup → Object Manager → <Object> → Details → API Name)。权威细节需查阅 references/lds-expert.md、references/lds-data-consistency.md、references/lds-referential-integrity.md、references/adapter-apis.md、references/wire-adapter-types.md。GraphQL 与上游数据需求分析当前为带外处理;无障碍、安全、RTL 为独立审查流程。验证时需确认无硬编码 API 名、每个写路径都有刷新路径、无 Apex 与 UIAPI 重复读取同一记录,并让现有 Jest 测试通过、为刷新流程补充覆盖。收费、价格、平台等信息暂未提供。