构建良好结构的Express应用

首先Express是什么?了解Nodejs的同学应该都很知道,这是一个基于Nodejs的Web框架。

Fast, unopinionated, minimalist web framework for Node.js       ---- 引自expressjs.com

Nodejs和Express都没有对项目结构进行约束,你可以很随意的构建应用,而不用考虑结构是否符合规范。这种无拘无束的方式很好,特别是对于小型应用,很容易上手,不用遵循各种约定。But,当应用规模越来越大时,良好的结构就很重要,特别是多人协同开发时,没有好的结构,你会感觉暗无天日。

代码组织没有固定的模式,有很多好的模式可以遵循,那么选择哪一种组织方式也是我们要面临的问题。未必是选择大家认为最好的,而是选择一个适合你的。

写了一堆废话,终于进入正文~

我们要说的这种结构是基于MVC设计模式的。

这种模式按照职责将应用的不同部分进行分离解耦,使得我们的代码更容易扩展、维护。这里我们不讨论MVC本身的优缺点,我们将精力集中在如何基于MVC模式建立良好结构的Express应用。实践证明,对于不同规模的项目和多人协同开发,这种结构都有良好的表现。

下面我们以一个示例开始,假设有这样一个应用:用户可以登录,注册,评论。接着我们建立如下的目录结构:

目录结构

我们来解释看下这个结构:

controllers/– 定义路由以及相关逻辑

helpers/– 定义一些应用中公用的工具类

middlewares/– 存放Express的中间件,如可以在请求到达Controller前最一些自定义的操作

models/– 实现业务逻辑和数据访问

public/– 存放所有的静态文件,如图片,css,js等

views/– 存放表现层模板

tests/– 存放测试代码

app.js– 用于应用初始化

package.json – 记录应用信息,如版本、依赖的库等


Models

Model是用来与数据库交互的,这里除了增删改查外,也包含业务逻辑。比如,我们有一个Model叫Car,我们可以提供一个mountTyres方法,通过调用mountTyres方法来给汽车(car)安装轮胎。

你应该为每一个数据类型创建至少一个model文件,比如我们这个例子中有用户和评论model。有时,model文件变得非常大时,我们可以根据内部的业务逻辑,将它分离成多个小文件。


你应该让model独立于其他模块,它不需要知道其他model,不需要知道controller,不需要知道有哪些模块在使用它,不需要接受请求或返回响应。

这么做的目的是为了提高你的Model的可维护性。它们方便进行测试,因为它们对外界几乎没有什么依赖。对它们进行修改也不会影响其他部分。

让我们看下示例中的Model的实现,下面是评论(Comment)的Model:


评论Model


用户Model (1)
用户Model (2)


Views

views目录用来存放网页模板,通常前端工程师的工作都是在这个目录进行的。

我们也可以会建立一些子目录,对应于我们创建的Controller。这样,我们把相同功能的代码组织到一起。

对于模板语言有很多选择,比较流行的如Jade和Mustache。对于模板的使用上,尽量少得在模板中处理逻辑,如果在呈现数据前需要进行一些逻辑处理,我们需要把逻辑移到Controller中。


Controllers

这个目录我们用来存放所有的路由信息。Controller需要处理请求,调用model获取数据,使用数据渲染对应的模板返回给用户。Controller控制着应用流程。

通常,应用的每个功能需要有至少一个Controller,比如,CommentController用来处理Comment相关的请求,UserController用于处理用户相关的请求。相同的Controller中的路由地址采用相同的前缀是一种很好的做法,比如:/comments/all  ,  /comments/new

有时我们很难决定哪些代码应该放在Controller,哪些应该放在model中。这是,你要记住Controller永远不要直接访问数据库,Controller中不应该出现write,update,fetch等dao层应该提供的方法。需要访问数据,应该调用model来获取。


评论Controller

在controller目录我们还有一个index.js文件,它是用来读取所有controller并且定义它们的访问前缀。代码如下:


index.js


Middlewares

这个目录中我们存放Express的中间件。中间件可以看作是controller的通用代码,会做用于多个请求,可以在中间件中修改请求(request)或者修改响应(response)。

和Controller类似,中间件不应该直接访问数据库,而是调用model来访问数据源。下面是 middlewares/users.js文件,它的作用是从数据源读取用户信息,并添加到请求中:


middlewares/users.js

接着,我们再定义一个认证中间件,用来判断请求中是否有user,如果没有,返回401错误:


认证中间件


Helpers

这个目录用来存放一些通用的工具类。


Public

存放静态文件。通常包含子目录,如images, css , js 等。

应用部署时,使用Nginx或Apache服务器来管理静态文件要好过使用Node,它们可以提供更好的性能。


Tests

这里存放所有的测试文件,可以创建子目录如: controllers, helpers , models等分别用来存放各个模块的测试文件。


写在最后

为了让大家能更快速搭建新项目,我会稍后补充一份按照这个结构搭建的基础项目供大家下载,如果你等不及了,请丧心病狂的打赏~

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,662评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,167评论 25 707
  • Express是Node社区里的超级明星,他的作者TJ Holowaychuk也因此成为了社区里大红大紫的开发者。...
    2MuchT阅读 3,007评论 1 30
  • 孤独的草啊 你要明白你的生根是为自己而扎根 含苞的花啊 你要明白你的开放是为自己而怒放 挺拔的树啊 你要明白你的生...
    烛下的眷恋阅读 397评论 0 0
  • 这是缅甸的一个传说: 有一条恶龙,每年要求村庄献祭一个处女,每年这个村庄都会有一个少年英雄去与恶龙搏斗,但无人生还...
    邴越阅读 9,642评论 1 6