React 项目目录结构优化

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

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

最后

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,198评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,663评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,985评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,673评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,994评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,399评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,717评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,407评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,112评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,371评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,891评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,255评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,881评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,010评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,764评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,412评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,299评论 2 260