React Relay项目目录结构组织

时间:2017-03-25 12:34:12

标签: javascript reactjs relayjs

我开始使用Relay构建项目,我对项目结构感到有点困惑(我使用同构方法)。

这是我正常的React项目结构:

-- project
     |-----src
     |       |---components (React components with their respective .css styles)
     |       |---containers (React/Redux containers)
     |       |---helpers (Helpers, common to components and containers)
     |       |---redux (Redux stores)
     |       server.js (node server code)
     |       client.js (client code)
     |       routes.js (routes)
     |       config.js (application config)
     |
     |-----static
     |       |-- ... (static files)
     |-----webpack 
     |       |-- ... (webpack configuration files)

在React / Redux中,容器在概念上是一个“智能组件”(参见this link,有意义的是在组件(纯React组件)和容器(带有redux数据的“智能组件”)中区分它们

现在,当我转向Relay时,容器在概念上仅与数据相关,与React组件有关(请参阅here),这会稍微改变上面的目录结构。

问题:

a)我应该将组件和容器保存为单独的目录吗?

b)我应该将它们称为所有组件并将其构造为:

  src
   |------ containers
               |-------- itemcontainer.js (relay container)
               |-------- itemcomponent.js (react component)
               |-------- itemcomponent.css (react component styling)

在这种情况下,如何处理没有数据关联的组件?

c)我会做些不同的事吗?

在React / Relay架构中组织组件,容器和样式的最佳方法是什么?

组织React / Relay项目结构的最佳方法是什么?

1 个答案:

答案 0 :(得分:1)

您的问题确实是一个偏好问题,但如果您想最大限度地提高开发者体验:

最好不要把你的“容器”和“组件”分开,这样可以方便地改变组件的数据需求。无论您是使用终端还是 GUI(如文件资源管理器、Finder 或 VSCode)来导航您的项目,将有关组件的所有内容都放在一个目录中可以轻松进行更改,尤其是在长期和大型团队中,你想限制摩擦的地方。只需考虑遍历文件结构,可能会阻止“懒惰”的开发人员修复错误或执行简单任务。

我建议采用这种结构,但请稍加保留:

src
   |------ components
         |-------- ComponentName
               |-------- index.js          (relay container)
               |-------- ComponentNameUI.js  (react component)
               |-------- ComponentName.css (react component styling)
   |------ ui
         |-------- ComponentName
               |-------- index.js          (react component)
               |-------- ComponentName.css (react component styling)

你所有的“智能”中继组件(“容器”+“演示”,你称之为“组件”)都在 components/ 目录中,而你的“哑”组件没有任何东西与 Relay 相关的,例如您的设计系统的组件(如 ButtonAvatar 等),将位于 ui/ 目录中(您可以随意命名) .

如果您想要一种简单的方法来放置和实施上述结构,我创建了一个 CLI relay-butler,它接受​​ GraphQL fragments 并在其中输出 Relay 组件结构体。默认情况下它是 TypeScript,但您可以根据需要自定义模板并将其更改为 JavaScript。

我还建议您阅读 Thinking in Relay 文档中有关 relay.dev 的页面,该页面并未告诉您如何构建项目,但可以让您了解您可能希望如何进行.

但最重要的是,正如 create-react-app 的合著者之一丹·阿布拉莫夫 (Dan Abramov) 所说:“移动文件直到感觉合适为止”(https://twitter.com/dan_abramov/status/1042364018848145408)。