原创作者:波多马克河畔,京程一灯特邀作者 波多马克河畔,留学海外对编程充满热情的高中生
写过 node.js 应用的小伙伴们应该都知道 express 应用框架,它让我们在开发时候的路由设计简化,直接方便我们快速的开发,然而,因为版本更新的太快,导致像这类的API都没什么人愿意去翻译,哪怕翻译出来一段时间后,新的API又出来了。于是乎间接的让许多英语不好的小伙伴都不能好好的玩耍了。
express 5 overview
作为一名身在海外的高中生,为了提升英语阅读(我刚出来时候英语真的不咋的,但只有读才是提升阅读水平的最好方法),我也只好好好的翻译翻译啦~ 除了为帮助自己,也间接帮助一些需要中文API的小伙伴们。
该 Express 4.X 中文手册我讲以官网的目录形式来发布文章,共5章,分别为:
express() Application Reques Response Router
Express's menu
如果有什么翻译不对的地方~ 欢迎在下方评论告诉我奥~ enjoy your express API.
express()
建立一个Express的应用程序,express() 函数是一个由express模型导出的高级入口函数。
var express = require('express'); var app = express();
方法:
express.static(root, [options])
express.static 函数是Express中唯一一个内置的中间件 (middleware) 函数。该函数提供了静态文件功能并基于server-static开发。
其中,root 参数是指向需要提供静态资源服务的根目录,需要提供的静态文件将会通过req.url 和提供的根目录的组合来确定。当一个文件找不到时,该模型不会发送404响应,而是将其代替为调用 next() 来移动到下一个中间件,并允许堆积与后退。
下面的表格描述了 options 可选对象的属性。
options of express.static()
dotfiles
该选项可能用到的值有:
“ allow ” - 不特别处理点文件 " deny " - 拒绝点文件的请求,用403响应,然后调用 next(); “ ignore ” - 如果dotfile不存在,用404响应,然后调用 next();
注意:使用默认值时,它将不会忽视以点开头的文件或者文件夹。
fallthrough
当该选项为 true 时,客户端的错误例如一个不好的请求或者一个不存在文件的请求都将导致这个中间件去简单的调用 next() 来调用栈中的下一个中间件。当该选项为 false 时,这些错误(甚至是404错误)都将调用 next(err)。
将此选项的值设置为 true 以便于你可以将多个物理目录映射到同一个Web地址或路由以填充不存在的文件。
如果已将此中间件安装在严格为单个文件系统目录的路径上,则可以使用false。这样允许让404短路从而减少开销。 这个中间件也将回复所有的方法。
setHeaders
对于该选项,请指定一个函数去设置自定义响应标头。 对标头的更改必须同步进行。
该函数的签名为:
fn ( res, path, stat );
参数:
res, 响应的对象 path, 要发送的文件路劲 stat, 要发送的文件的 stat 对象
express.Router([options])
创建一个新的路由对象
var router = express.Router( [ options ] );
下表中的可选 options 参数指定了路由器的行为:
options of express.Router()
你可以像路由应用一样向路由器中添加中间件和HTTP方法路由(例如 get,put,post 等方法)。