美文网首页
React 项目目录结构优化

React 项目目录结构优化

作者: VioletJack | 来源:发表于2020-07-22 22:29 被阅读0次

随着项目功能越来越多,代码量越来越庞大。随之而来的就是项目本身变得有点难以维护和理解了。比如:

  • 一开始没有定开发规范,每个人都有自己不同的写法。
  • 创建和存放代码文件的方式不同,导致目录结构开始混乱。
  • 为了适应某些需求,写了一些临时代码。这种代码一多后期维护就变得难以理解。
  • 页面、组件都有业务逻辑,到处是业务逻辑导致后期看代码就像是捉迷藏。
  • 页面、组件之间耦合性太强。比如通过十几个 props 和十几个 event 来连接某个组件。

这些问题在项目初期还好。但是如果功能越堆越多。于是我就在想,如何去维护好这个项目呢。我想到了一句话:

高内聚、低耦合

所以,我对于我现在的 React 项目,做了以下设计。

  • assets 目录里面放所有的资源文件。虽然在某些页面里面放上一些图片资源引用起来很方便,但是页面一多就会发现有很多图片是一样的。这时候统一存放资源文件就可以复用一些文件。避免不必要的重复文件占空间。
  • components 目录里存放公共的组件。我对于组件的定义是尽量只实现 UI 呈现方面的事情,业务逻辑可以通过事件传递出去,交给 page 和 module 来实现。
  • pages 目录里存放路由级别的页面。
    • 由于项目中使用了 redux,所以每个页面会有一个 container 用来获取 redux 数据和定义 dispatch 事件。
    • index 里面承载了大部分页面逻辑的处理,以及页面结构的呈现。
    • model 用于定义 redux state 以及数据操作方式。
    • components 目录用于存放仅仅在本页面中会用到的组件。
  • modules 目录里面存放了非路由级别的功能模块。它的目录结构和 pages 目录完全一致。只不过这个目录下的模块不能被路由直接访问到。
  • service 目录用于配置和定义 API 接口。
  • utils 用于定义公共工具函数。

并且,想了一些原则:

  • 所有资源都要存放在同一 assets 目录下,方便复用和查找。
  • component 组件(不管是公共的还是页面私有的)尽量不接触业务,仅仅用于 UI 展现。
  • page 和 module 通过 container 和 model 来连接 redux 数据,通过 index 来处理大多数页面逻辑。
  • 通过 props 和回调函数传递数据尽量不要超过三层。如果一个 prop 属性会存在 A -> B -> C -> D -> E,并且回调函数是从 E 到 A 的,这必然不合理。
  • 为了低耦合,尽量少的使用 props 和 events。定义 events 的参数也是也少越好。
  • page 不存在 props,module 尽量少定义 props,降低耦合性。
  • 一般只在 page 中使用 module,避免 module 中使用其他 module 形成套娃。

最后

以上都是我自己基于高内聚、低耦合的一些项目优化的想法。我去网上找也没有找到太适合我当前项目的方案。暂且一试。
如果有更好的最佳实践,欢迎留言交流沟通。

相关文章

  • React 项目目录结构优化

    随着项目功能越来越多,代码量越来越庞大。随之而来的就是项目本身变得有点难以维护和理解了。比如: 一开始没有定开发规...

  • ReactNative模块植入iOS 原生项目经验总结

    项目文件目录结构如下图所示:项目文件目录结构.png 目录结构解释: ReactNative目录:React Na...

  • React

    使用 create-react-app 快速构建 React 开发环境 项目的目录结构如下: React JSX ...

  • React Native - 12 - 现有APP接入

    在原有的项目中支持 React Native 关键概念 设置React Native项目依赖和目录结构。 了解Re...

  • iOS老项目使用pods集成ReactNative

    老项目集成ReactNative,目录结构肯定和react-native init 出来的项目结构不同了,用coc...

  • react学习资料七

    写一个bootstrap项目 目录结构index.html文件,项目的起始文件js目录react.jsreact-...

  • react-native 项目的结构

    初始化一个项目 react-native的项目的目录结构: react-native 项目添加新的依赖库: 在终端...

  • 2018-03-21

    react webpack 多页面应用的配置 项目的目录结构 webpack 配置文件 目录 webpack....

  • 23.路由

    官方链接:http://reacttraining.com/react-router/web 目录结构 初始化项目...

  • 项目优化---工程结构/目录优化(二)

      上一篇文章《项目优化---工程结构/目录优化(一)》主要就MVC模式下的工程目录做了一个简要分析,本文主要总结...

网友评论

      本文标题:React 项目目录结构优化

      本文链接:https://www.haomeiwen.com/subject/xycxlktx.html