关于FSD架构的思考
介绍
在我的公司,我们使用FSD架构构建前端。这是我的第二个FSD架构项目。在实际实现之前,大家都认为分层架构可以分离角色,确保依赖关系单向流动,方便任何团队成员快速找到文件,并简化维护工作。
然而,一如既往,在实践中决定“图层放置位置”本身就非常困难。本文是一篇回顾性文章,如实总结了我判断上的变化。
问题
问题 1. 卡片组件的请求取消层
我创建了一个卡片组件,它承担着[显示支付请求信息]和[取消请求]两个功能。在这种情况下,将支付请求信息的显示功能放在实体层,将取消请求的功能放在要素层似乎是比较合适的。但是,我认为最好将卡片组件本身也放在实体层,因此我也在实体层实现了取消请求的功能。
entities/ payment-request/ ui/ PaymentRequestCard.tsx ← 取消按钮在这里。 model/ api/
上述结构的问题在于它偏离了功能集设计(FSD)原则。 (如果您对此有异议,我完全同意架构不必严格按照固定格式使用!我也认为应该这样使用。不过,我这里只是在原则上提出异议。)更好的做法是,在功能层中专注于处理用户操作,并在实体层中表示业务模型单元。
所以我修改了它以符合这些原则。
features/ cancel-payment-request/ ui/ CancelPaymentRequestButton.tsx model/ useCancelPaymentRequest.tsentities/ payment-request/ ui/ PaymentRequestCard.tsx ← 接收按钮作为属性的结构体// 小部件中的组合<PaymentRequestCard data={data} action={<CancelPaymentRequestButton id={data.id} />} // 外注射/>做出这些更改后,PaymentRequestCard 组件中“取消”按钮的位置由布局决定,布局信息通过 props 传递,并在 {action} 插槽中渲染。由于实体本身已经存在依赖关系(因为它们预先知道将要执行的操作及其位置),这在 FSD 架构层级中显得有些矛盾。
所以我觉得把卡片组件移到控件层会更自然,于是我就这么做了。因为这样既代表了操作,也代表了实体。
const PaymentRequestCard = ({ data }) => { const { cancel } = usePaymentRequest(data.id); return ( <Card> <CardContent>{data.title}</CardContent> <Button onClick={cancel}>取消请求</Button> </Card> );};最终结果是
更改前:entities/payment-request/ui/PaymentRequestCard.tsx
修改后:widgets/payment-request-card/ui/PaymentRequestCard.tsx
它已经变成了这样。我认为当“数据表示+操作”结合在一起时,将其移到组件层是正确的。
如果你在使用某种架构时感觉代码布局很奇怪,很可能是因为你的思路没有遵循该架构的设计意图。毋庸置疑,如果是分区架构,你应该根据功能和角色进行分区。
问题二:API应该放在哪里?(还在考虑中)
FSD 文档(虽然我不确定它是否是官方文档,因为我个人并不认同其中的很多内容,它似乎过于侧重架构)提供了指导原则,将 API 放置在每一层中与其最密切相关的功能上。然而,
与FSD文档中的解释不同,我将API分组到了实体中。这是因为所有CRUD API都与实体密切相关,我认为如果将它们放在关系更加紧密的地方,会使它们更难查找。
entities/ credit/ api/ index.ts fetchCreditXXX.ts postCreditXXX.ts keys/ getCreditOptions.ts ← queryOptions chargeCreditOptions.ts ← mutationOptions useCreditOptions.ts ← mutationOptions此外,API 层还负责将所有 DTO 转换为应用程序内部使用的实体类型。我认为这样更容易管理,因为 DTO 到实体的转换过程可以整合到一个单独的实体层中。
然而,仅仅将 API 整合到实体层而没有任何功能连接似乎与 FSD 架构理念不太相符,所以我想知道是否有更好的方法。
因此,我考虑将 DTO 转换为实体的职责移交给 `queryOptions` 和 `queryMutation`,并将所有纯 API 调用函数和端点移到 `/shared/api`。我认为这样既能保持原有的依赖关系,又能进一步确保单一职责原则和 `fetch` 函数的可重用性。
shared/ api/ credits/ fetchCredit.ts ← 纯 HTTP 函数 postChargeCredit.ts postUseCredit.tsentities/ credit/ api/ getCreditOptions.ts ← queryOptionsfeatures/ charge-credit/ api/ chargeCreditOptions.ts ← mutationOptions use-credit/ api/ useCreditOptions.ts ← mutationOptions// entities/credit/api/getCreditOptions.tsexport const getCreditOptions = queryOptions({ queryFn: async () => { const dto = await fetchCredit(); return toCreditEntity(dto); // ← 转换在此 }});这种实现方式显然遵循了 FSD 的原则。然而,作为适配器的代码分散在各处,其逻辑隐藏在 `queryOptions` 中。此外,追踪依赖关系的方向也变得复杂。
所以现在我陷入了两难境地。我认为不便之处在于代码库还不够大,无法拆分成 FSD。我需要再仔细考虑一下,看看如何才能更好地适应当前的代码库。
总而言之,我的思考过程如下。
最初,所有内容都被整合到 entities/credit/api 中 → 领域内聚性高,但与 FSD 架构理念不兼容。
如果将纯 HTTP 通信功能提取到 shared/api 中,按层分离选项,并分配实体职责,这样如何?→ 这接近了初衷,但 DTO 转换的位置会变得分散。
我们每解决一个问题,就会出现另一个问题,所以我们始终处于一种权衡关系中。鉴于目前将所有内容整合到实体中似乎没有任何问题,方案 1 看起来是正确的答案。但是,随着代码库的增长,方案 2 会不会最终成为正确的答案呢?
问题 3. 真的需要将看起来只会在单个页面上使用的代码放入实体中吗?
FSD架构教程还明确指出,仅在一个页面上使用的代码应放在页面层。然而,令人恼火的是,该教程还要求将领域模型放在实体层,将动作放在特征层。虽然将代码分离成实体和特征在概念上更清晰,但实际上,真正简洁且可验证的代码应该正确地分离并放在页面层。
例如,假设“余额横幅”仅用于“信用”页面。但是,它与“信用”实体关系最为密切。因此,我将其安排如下。
entities/ credit/ ui/ CreditBalanceBanner.tsx ← 平衡横幅 CreditHistoryHeader.tsx ← 历史记录标题然而,余额横幅实际上只在一个页面上使用,而且从未被重复使用过。看起来也不太可能在其他页面上重复使用。因此,我把余额横幅的 UI 从实体移到了页面。我认为这是一种更好的方法。没有必要特意为不会重复使用的“自动完成”代码公开 API,对吧?
pages/ credit/ ui/ CreditPage.tsx CreditBalanceBanner.tsx ← 因为我只在这里使用它。 CreditHistoryHeader.tsx所以,我认为这种代码风格更好。我甚至觉得必要时可以加入 API 或 hooks。但是,我最终还是没有这样做,因为我觉得 API 或 hooks 分散在各处会让代码更难理解。
问题结论
在思考这些问题的过程中,我意识到,过于执着于建筑本身、强迫自己将事物割裂开来,或者过于执着于单一职责,都会极大地限制我的思考自由。重要的是要着眼于全局。此外,我们需要理解FSD诞生的初衷,以及如何有效地利用它来解决问题。我认为我应该更关注其背后的意图,而不是纠结于具体的方法。我们总是会过度关注手段,而忽略了手段本身并非目的,即便使用手段本身并非最终目标。
组织
情况 | 初步判断 | 结果 |
|---|---|---|
带有取消按钮的卡片 | 在实体上放置卡片 | 转到组件。如果数据表示和操作在一起,则将其移动到比组件更高的层级。 |
功能按钮注入 | 通过丙烷喷射分离 | → 相反,它会变得更加复杂,降低可读性。 |
域 API 位置 | 计划将所有来自 entities/credit/api 的 CRUD 操作分离到 shared/api 目录下。 | 解决这个问题会引出DTO转换位置的问题。正确的答案似乎会根据代码库的规模而有所不同。 |
专用于特定页面的用户界面 | 放置在 entities/credit/ui 中 | 实体中堆积了许多无法重用的组件。或许将它们放在页面中会更好。 |
结束
我其实并不喜欢FSD架构。我看过一些FSD架构的教程,感觉它们像是在强加一种结构。也许正因如此,过去几年里,我甚至完全从这个架构中移除了一些层。此外,人们常常只是照搬FSD架构的理念,然后根据自己公司的代码或理念,随意更改层的名称、编号和用途。
FSD架构看起来确实像是会严重影响初学者体验的架构。你需要能够灵活地借鉴架构的部分内容,才能发挥其优势或将其适配到自己的代码中,但初学者往往缺乏这种能力。因此,它看起来像是为专家设计的架构。专家不会总是严格遵守这些架构规则;相反,他们会在必要时借鉴其理念,并根据自身或组织的偏好进行修改,从而实现更灵活的使用。
