React文件名和目录规范最佳实践记录(总结篇)
React在使用时非常灵活，如果没有一个规范约束项目，在开发过程中会非常混乱，本文将介绍几个优秀的规范。
文件类型
介绍文件名和目录前，需要先简述一下几种通用的类型，用来区分文件的功能。
- component 组件文件
- page 如果有路由(React Router、NextJS等)，则有页面文件
- util 需要复用的工具函数
- helper 一段特定逻辑，不是通用工具，可复用也可仅作为代码拆分片段
- hook 自定义React Hook
- constant 定义常量，大写+下划线命名
CONSTANT_VALUE
处理index文件
在做组件或者页面的时候，你可能会划分组件，并把主组件用index.tsx导出。这样做的时候有一个好处就是可以按照文件夹名引入，从结构上看是很清晰的。
但是事实上，在编辑器中会有多个index.tsx文件，开发时需要看文件所在的文件夹，非常难受。
我的解决方案是，你的主组件应该和原来一样导出，index.ts 文件二次导出主组件。
你的 index.ts 应该这样写：
export * from './MainComponent';
export { default } from './MainComponent';虽然把一个文件变成了两个文件，但是有效地减少了开发时的心智负担。
接下来规范中所有的
index.ts都是这个作用
规范
类型文件夹
这应该是一个比较官方的规范，很多项目都在使用。
此处使用大驼峰命名组件（component）和页面（page），其他文件通常用小驼峰
如果你有路由，那么此时component中的组件应为通用组件。
src/ ├── components/ │ ├── MyHeader.tsx │ └── MyFooter.tsx ├── pages/ │ ├── Home.tsx │ ├── About.tsx │ └── Widget/ │ ├── components/ │ │ ├── Tool.tsx │ │ └── Option.tsx │ ├── helpers/ │ │ └── setOptionStorage.ts │ ├── Widget.tsx │ └── index.ts ├── hooks/ │ └── useTheme.ts ├── utils/ │ └── getRamdomNumber.ts └── constants.ts
这个规范在小项目中尚可实行。但是如果相对复杂的项目，由于文件夹层数多，会导致引入混乱。接下来会推荐特性分类的规范。
示例项目：Ant Design Pro
特性文件夹
特性文件夹分类很好地解决了层数过多的问题，增加平铺的可能。并更直观地展示了代码逻辑，方便维护。
大驼峰命名
这种命名规范中，除了组件和页面以外，所有的文件都需要添加类型后缀。
并且在一个特性中，可以将类型相同的函数放在一个文件内。
例如 Widget.helper.ts Widget.util.ts
如果是通用的或复用的代码，都建议放到 common 文件夹统一管理，其余特性文件夹均大写。
非组件或页面的独立的文件，请使用烧烤串命名（中划线分割）
同一个特性的组件可以不另设 components 文件夹
src/
├── common/
│ ├── components/
│ │ ├── MyHeader.tsx
│ │ └── MyFooter.tsx
│ ├── utils/
│ │ └── get-random-number.util.ts
│ ├── hooks/
│ │ └── use-theme.hook.ts
│ └── constants.ts
├── Home/
│ └── Home.tsx
├── Widget/
│ ├── Tool.tsx
│ ├── Option.tsx
│ ├── Widget.helpers.ts
│ ├── Widget.utils.ts
│ ├── Widget.constants.ts
│ ├── Widget.tsx
│ └── index.ts
└── About/
└── About.tsx参考文章：Delightful React File/Directory Structure
烧烤串命名
这个实际上是参考了Angular规范，如果你对上面这个规范的大小写命名强迫症，不妨试试这个更严苛的规范。
- 所有文件名、文件夹名都小写，使用烧烤串命名（中划线分割）。
- 所有的文件都需要添加类型后缀。
- 只有主要的页面组件可以放在特性文件夹底层，其余文件都需要在特性文件夹中再设置类型文件夹。
- 每个函数都应该是一个文件，不要把相同功能的函数放在一个文件内。
- 移除
index.ts导出，因为文件名变长且有类型后缀，引入方便判断类型
src/
├── common/
│ ├── components/
│ │ ├── my-header.component.tsx
│ │ └── my-footer.component.tsx
│ ├── utils/
│ │ └── get-random-number.util.ts
│ ├── hooks/
│ │ └── use-theme.hook.ts
│ └── constants.ts
├── home/
│ └── home.page.tsx
├── widget/
│ ├── components/
│ │ ├── tool.component.tsx
│ │ └── option.component.tsx
│ ├── helpers/
│ │ └── set-option-storage.helper.ts
│ └── widget.page.tsx
└── about/
└── about.page.tsx到此这篇关于几种React文件名和目录规范最佳实践的文章就介绍到这了,更多相关React文件名和目录实践内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要为大家介绍了styled-components 的性能示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-01-01
在使用React Native开发的时，当我们快速滑动应用的时候，可能会出现误触，导致我们会点击到页面中的某一些点击事件，误触导致页面元素响应从而进行其他操作,表现出非常不好的用户体验。2023-05-05
这篇文章主要介绍了react跳转后路由变了页面没刷新的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-03-03
React中hook函数与useState及useEffect的使用
这篇文章主要介绍了React中hook函数与useState及useEffect的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧2022-10-10
这篇文章主要介绍了React路由跳转的几种方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-07-07
react函数组件useState异步,数据不能及时获取到的问题
这篇文章主要介绍了react函数组件useState异步,数据不能及时获取到的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-08-08
这篇文章主要介绍了useState第二个参数的"第二个参数",具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-03-03
最近在使用react开发项目，遇到这样一个需求实现一个带有动效的 React 弹窗组件，如果不考虑动效，很容易实现，接下来小编通过本文给大家介绍React实现动效弹窗组件的实现代码，一起看看吧2021-06-06
在React中,我们经常在子组件中调用父组件的方法,一般用props回调即可,这篇文章主要介绍了React父组件如何调用子组件的方法推荐,需要的朋友可以参考下2023-11-11
这篇文章主要介绍了React 如何拿时间戳计算得到开始和结束时间戳,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2023-09-09
最新评论