为什么使用Sails?

http://www.jianshu.com/p/ac2da4142259

前言

入手Node.js半年,从用Express开发自己的博客到用Sails开发公司项目,深深被Sails震撼了。Sails是Balderdash团队的产品,快速的项目构建、优秀的框架结构还有众多的扩展,让我有种相见恨晚的感觉。在Koa流行之前,个人认为Sails的用户量还是挺可观的。今天,我想写一写Sails那些让我感动的地方,顺便理顺一下Sails的架构。

目录

  • 一步搭建项目
  • 项目架构
  • ORM
  • MVC的实现
  • 路由
  • 安全
  • 日志
  • 单元测试
  • WebSocket

一步搭建项目

在安装了Node.js 和 Sails的环境下,只需要一条命令,就能够搭建一个拥有完整架构的项目,尽管这很简单,我还是觉得有必要说一下。

在已经安装了Node.js和npm的前提下,首先你需要全局下安装Sails
$ sudo npm install sails -g

其次在一个空路径下,新建一个项目
$ sails new newApp

最后,只需要前往项目路径,把项目运行起来
$ cd testProject
$ sails lift

访问 http://localhost:1337就能看到一个新的项目

new app

项目架构

.
├── api
│   ├── controllers
│   ├── models
│   ├── policies
│   ├── responses
│   └── services
├── views
├── assets
├── config
├── tasks
├── node_modules
├── package.json
├── Gruntfile.js
├── README.md
└── app.js

api/

api 目录下是你要构建应用的核心所在,常说的MVC的设计结构就体现在这里
api/controllers :控制层,该层是Http请求的入口。Sails官方建议该层只处理请求的转发和页面的渲染,具体的逻辑实现应该交给Service层。
api/models:模型层,在Sails中,对于Model采用的是充血模型,除了可以在模型中定于属性之外,还可以定义包含逻辑处理的函数。在Sails中,所有Model都可以全局性访问。
api/policies:过滤层,该层在Controller层之前对Http请求做处理,在这一层中,可以定于一些规则来过滤Http请求,比如身份认证什么的。
api/responses:http响应的方法都放这里,例如服务器错误、请求错误、404错误等,定义在responses文件夹里面的方法,都会赋值到controller层的req对象中。
api/services:服务层,该层包含逻辑处理的方法,在Sails中,所有Service都可以全局性访问。

views/

视图层,存放视图模版文件的地方,Sails默认是提供ejs模版引擎的,如果你愿意,你可以换成jade、handlebars或者任何你喜欢的模版引擎。

assets/

资源文件夹,在Sails启动的时候,会启动某一个Grunt任务,把assets文件夹里的内容或压缩或编译或复制到根目录下的.tmp目录,这是前端可以直接通过路由访问的资源,HTML、JS、CSS以及图片等静态资源都放在这里了。

config/

配置文件夹,在Sails启动的时候,会加载该文件夹里的文件,并赋值在全局对象sails.config中,所以能够在任何一个地方都能用到。在用Sails开发,会经常跟这个文件夹里的文件打交道,从config的构成很容易知道Sails都提供哪方面的功能。

tasks/

Sails自带的项目自动化工具是Grunt,而Grunt的配置和任务注册都放在这个文件夹里了。这里已经提供了通常会用到的CSS编译、JS压缩、文件合并,更改检测等等任务,当然如果没有自己需要的,还能扩展。

app.js

Sails的启动文件,无论是$ sails lift命令或者$ npm start命令都会运行该文件。

ORM

开发了Sails的团队Balderdash,还开发了一套ORM框架:Waterline。
Waterline在Sails主要的舞台是在/api/models目录里,在这里定义的模型文件,在Sails启动的时候,都要经由Waterline的洗礼。
Waterline 是通过Adapter关联数据库的,不同的Adapter关联不同的数据库。
Waterline 能适配绝对部分数据库,大致分类两类,一类是官方团队开发的 Adapter适配的,一类是民间开发者开发的Adapter适配的:
官方支持的:

  • PostgreSQL
  • MySQL
  • MongoDB
  • Redis
  • Disk
  • Memory

民间开发的:

  • SQLServer
  • OrientDB
  • Oracle
  • Cassandra

关于Waterline的更多信息可以关注:
github:waterline
github:waterline-docs

MVC的实现

在这一段我想不仅仅要谈论到Model层、View层和Controller层,我认为还有必要谈到Service层、和Policy层。

Model层

模型文件定义到/api/models中,由Waterline驱动,所有model都能全局访问。Sails提供命令行创建model的命令:$ sails generate model MODEL_NAME

View层

实现在/views中,除了默认提供的ejs模版引擎之外,还能更换成jade、handlebars等模版引擎

Controller层

/api/controller目录里,Sails中提供创建controller的命令:$ sails generate controller CONTROLLER_NAME。Sails也提供同时创建model和对应的Controller的命令:$ sails generate api API_NAME

Service层

/api/services目录里,存放自定义的服务,所有service都能够全局访问,Sails官方的建议是把逻辑处理都放在该层中,Controller层只做路由的分发和轻逻辑的处理。

Policy层

/api/policies目录里,存放自定义的过滤器。该层是一条请求在到达Controller之前根据需求过滤请求的中间层。在/api/policies目录中定义的文件,还需要在config/policies.js文件中为需求应用到某一过滤器的Action配置。

路由

Sails中要理解路由,首先要记得这个名词blueprint,中文翻译为:蓝图。我不知道官方是否解释过为什么要用个单词,但以我的理解,Sails的blueprint是负责指挥每一条客户端请求应该分配到服务器端的哪个Action去,所以叫蓝图吧。
blueprint主要分为三种:RESTful routesShortcut routesAction routes

RESTful routes

当路径诸如:/:modelIdentity 或者 /:modelIdentity/:id的时候,blueprint会根据HTTP的动作(GET、POST、DELETE、PUT等)来分配到相应的Controller下相应的Action来处理。例如一个POST请求/user会创建一个用户,一个DELETE请求/user/123会删除id为123的用户。

Shortcut routes

这种路由主要是方便开发,请求的参数可以直接写在请求路径中,例如/user/create?name=joe会创建一个新的用户,/user/update/1?name=mike会更新id为1的用户的名字。shortcut routes在开发环境很便利,但是在生产环境下需要关闭。

Action routes

这种路由会自动的为Controller层的每一个Action创建一个路由,例如你的Controller层有一个FooController.js,里面有一个Actionbar,那么请求/foo/bar就会分配到barAction。

当然Sails也会提供自定义的路由,用户可以在config/routes.jsconfig/polices.js这两个配置文件中选择关闭或者打开blueprint提供的路由,和定义自己的路由。

安全

要确保产品的安全性,要对几种常见的攻击和安全策略了如指掌,诸如CORS、CSRF、DDOS、XSS等。Sails对于常见的安全策略都有提供支持,且只需要通过相关的配置文件就可以控制安全策略的等级。深入探讨Web的安全策略,并不在本文的范畴内,日后我会以这个为题写一篇文章聊聊Web的安全。
想要了解更多Sails的安全策略可以看看这里:sails: security

日志

Sails提供了一个全局对象sails.log用来处理日志信息的输出,日志是分level的,在config/log.js中配置日志输出的level,而level的作用看下表:

Priority level Log fns visible
0 silent N/A
1 error .error()
2 warn .warn(), .error()
3 debug .debug(), .warn(), .error()
4 info .info(), .debug(), .warn(), .error()
5 verbose .verbose(), .info(), .debug(), .warn(), .error()
6 silly .silly(), .verbose(), .info(), .debug(), .warn(), .error()

Sails的日志管理默认是info层的,既会输出.info(), .debug(), .warn(), .error()的信息。

单元测试

Sails使用了mocha进行单元测试,在新建Sails项目的时候,没有创建单元测试的文件夹,需要自己手动构造单元测试目录,官方建议的目录是这样的:

.
├── api
├── assets
├── ...
├── test
│  ├── unit
│  │  ├── controllers
│  │  │  └── UsersController.test.js
│  │  ├── models
│  │  │  └── Users.test.js
│  │  └── ...
│  ├── fixtures
│  ├── ...
│  ├── bootstrap.test.js
│  └── mocha.opts
└── views

而我在单元测试常用的组合是:mochashouldsupertest、 istanbul
其中should是提供断言,supertest是用于测试Controller层的时候伪造http请求的,而istanbul则是提供测试代码覆盖率的。
关于怎么在Sails中编写测试代码,可以参考 sails:testing

WebSocket

对于有即时性通讯需求的Web应用,我们会用Socket,Sails也为这方面提供了支持。在客户端提供js文件:sails.io.js,而在服务器端提供全局对象:sails.sockets。通过这两个对象,就可以进行客户端和服务器端即时性通讯的开发了。
Sails默认会启动WebSocket功能,在客户端访问服务器端的时候,会自动尝试在同域名下连接socket。
值得注意的是,这样会对AngularJS、EmberJS等前端MVVC开发产生一些障碍。
比如进行AngularJS开发的时候,我们在http://localhost:9000跑AngularJS项目,而服务器端却跑在http://localhost:1337
当访问http://localhost:9000的时候,sails.io.js会尝试于当前路径下进行socket连接,也就是http://localhost:9000,这时会出错,因为服务器是跑在http://localhost:1337的。
在开发的时候要解决这样的问题的时候,我们只需要在AngularJS这边引入sails.io.js之后定义连接路径就行了:

<script src="scripts/lib/sails.io.js"></script>
<script>io.sails.url = "http://localhost:1337";</script>

结语

可以说Sails涵盖了Web开发中会遇到的绝大部分需求和问题,如果深入研究Sails的话,是受益匪浅的。

时间: 2024-10-02 05:06:34

为什么使用Sails?的相关文章

Node.js与Sails~redis组件的使用

有段时间没写关于NodeJs的文章了,今天也是为了解决高并发的问题,而想起了这个东西,IIS的站点在并发量达到200时有了一个瓶颈,于是想到了这个对高并发支持比较好的框架,nodeJs在我之前写出一些文章,主要为sails框架为主,介绍了一些使用方法,今天主要说下redis组件! 项目:SailsMvc 开发工具:webstorm 语言:nodejs 框架:sails 包:redis 主要介绍几个用法,为string,set,hash和list的使用 测试redis组件的代码 index: fu

sails中创建和使用services

从sails官方在线文档查知 // EmailService.js - in api/services module.exports = { sendInviteEmail: function(options) { var opts = {"type":"messages","call":"send","message": { "subject": "YourIn!"

Sails.js 之 concepts Assets

Sails.js 我从没用过,只学过一点nodejs的皮毛.还好Sails.js的文档比较详细,可都是英文的.我用我自己的语言做一下翻译,对应的Sails.js版本是v0.11 Assets 概览 Assets是指你像让外界访问的静态文件,例如js,css,images. 在Sails程序中Assets文件在assets文件夹中,在启动程序的时候,这些文件会被处理,同步到.tmp/public中..tmp/public 里的内容是Sails实际使用的,就好比熟悉的express的public文件

sails route(1) -用户定义路由

sails支持两种类型的路由: custom(or "explicit") andautomatic(or "implicit"). 先来看一下custom 即用户定义路由吧,以下是学习笔记. 用户定义路由 在config/routes.js中定义如下类似的路由: module.exports.routes={ 'get/signup': { view: 'conversion/signup' }, 'post /signup':'AuthController.pr

老web换新枝----Sails.js移动设备的全新生产力(二)

选择 Sails.js 一个明显的 Node.js 风格.具体来讲,Sails 使用分层开发和约定优于配置(convention over configuration),这两种开发技术已被 Rails 和类似的框架普及.Sails 还集成了其他一些 Node.js 包作为关键组件,这意味着不需要从头学习该框架.另一个优势是,事实上 Sails.js 的文档在不断改进,这是任何开源项目中都要寻找的一个关键指标. 在第一部分中,重点介绍 Sails 如何实现分层开发.未来的几部分将介绍约定优于配置和

与你相遇好幸运,Sails.js安装

官网: http://sailsjs.org Github:https://github.com/balderdashy/sails 开发文档: http://sailsjs.org/documentation/concepts 中文文档:https://github.com/linxiaowu66/sails-docs-zh-cn ORM组件:https://github.com/balderdashy/waterline ORM文档:https://github.com/balderdash

Node.js与Sails~Model和ORM的持久化

回到目录 上一讲说了在sails里定义model及相关参数的说明,这一讲主要说一下如何将你的Model持久化到文件,关系数据库和Nosql数据库里,在持久化这点上,sails是统一管理的,这是优势,也是劣势:优势就是入口统一,用哪种介质持久化,一个设置就OK了:劣势也很明显,就是在一个sails项目里,只能存在一种持久化的方法,你想让mysql和mongodb并存,那是不行的,呵呵! 对于数据的持久化主要分为以下几个步骤,下面一一讲解 1 安装缺失的驱动,默认来说mongodb和sqlserve

Node.js与Sails~项目结构与Mvc实现

Sails是一个Node.js的中间件架构,帮助我们很方便的构建WEB应用程序,网址:http://www.sailsjs.org/,它主要是在Express框架的基础上发展起来的,扩展了新的功能组件,下面我们来看一下安装方法 一 安装Sails npm -g install sails 二 建立一个Sails的项目 sails new testProject 三 启动项目 cd testProject sails lift 四 项目的结构,基于MVC理念 我们可以看到它与是由model,vie

Sails入门指南

1.全局观:sails理念,框架结构 2.试用sails的scaffolding工具,创建model,创建controller, 3.启动server,试用blueprint, 4.进阶: 4.0 数据库config 4.1 model关系规则, 4.2 sails console, 操纵model数据,了解sails运行期状态 4.3 自定义controller,controller的运行期context,如何编写逻辑 4.4 sails的policy,访问控制 4.5 view的使用逻辑 l