在前端开发中，使用 npm 来管理依赖包已经是一种非常流行的方式。而其中有一个 node.js 的 web 框架，它就是 express。在 express 的基础之上，还有一个比较好用的扩展包，它就是 express-stonefish。本文将为大家详细地介绍 npm 包 express-stonefish 的使用教程。
express-stonefish
express-stonefish 是一个基于 express 的 web 框架。它可以帮助我们更快速、更高效地构建和开发 web 应用。
特点：
- 支持使用各种模板引擎
- 支持使用 restful 风格的 url
- 支持使用 express 的中间件
- 支持异步编程风格的编写控制器
- 支持编写 socket.io 服务端
安装：
npm install express-stonefish
使用教程
初始化项目
在使用 express-stonefish 进行开发之前，我们需要先创建一个 express 项目。
express myapp
进入 myapp 目录，执行安装命令：
npm install
引入 express-stonefish
在实际开发中，我们可以通过以下几种方式来引入 express-stonefish：
全局引入
在 app.js 中，这样引入：
var express = require('express'); var app = express(); require('express-stonefish')(app);局部引入
在需要使用 express-stonefish 模块的地方，可以这样引入：
var stonefish = require('express-stonefish');
配置路由
在使用 express-stonefish 开发 web 应用的过程中，我们需要配置路由来处理客户端发来的请求。
基本使用
使用 express-stonefish 配置路由的基本步骤如下：
在 routes 目录下新建一个文件，例如 index.js。
在文件中，可以这样写：
exports.index = function(req, res){ res.send('Hello World'); };在 app.js 文件中，可以这样使用：
var index = require('./routes/index'); // 引入路由文件 app.get('/', index.index); // 监听 '/'
使用 restful 风格
在接口开发中，我们一般推荐使用 restful 风格的接口，方便开发和维护。使用 express-stonefish 可以轻松地实现 restful 风格的接口。
例如，我们需要实现一个获取博客文章列表的接口，可以这样编写路由：
-- -------------------- ---- -------
--- --------- - -----------------------------
--- ---- - --------------------------
--- ---- - --- -------
-- ----
----------------------- --------- ------ -
-- -- ----- -----------
--- -------- - ----- -------------------
-- -----
--------- - -
----- --------
--
---- 接口地址为 '/blogs'
- 使用了 restful 风格的 get 方法
- 在方法中使用 next 参数，来实现异步编程的效果
使用模板引擎
在 web 应用中，我们经常需要使用模板引擎来渲染页面。使用 express-stonefish 可以轻松地实现模板引擎的集成。
集成模板引擎
可以使用以下方式集成模板引擎：
在 app.js 中，加入如下代码：
app.set('views', path.join(__dirname, 'views')); // 设置模板文件存放路径 app.set('view engine', 'ejs'); // 设置模板引擎为 ejs在 routes 中，渲染模板：
exports.index = function(req, res) { res.render('index', { title: 'Express' }); };在模板文件中，使用模板引擎：
<html> <head> <title><%= title %></title> </head> <body> <h1><%= title %></h1> </body> </html>
使用模板引擎实现接口
我们可以将数据直接渲染到模板中，然后响应给客户端，达到返回数据的目的。
例如，我们需要实现一个获取热门博客文章列表的接口，可以这样编写路由：
-- -------------------- ---- ------- --- --------- - ----------------------------- --- ---- - -------------------------- --- ---- - --- ------- -- ---- --------------------------- --------- ------ - -- -- ----- ------------- --- ----------- - ----- ---------------------- -- -------------- ----- ----------------------- - ------------ ----------- --- ---
- 接口地址为 '/blogs/hot'
- 使用了 restful 风格的 get 方法
- 在方法中使用 next 参数，来实现异步编程的效果
- 在方法内部使用 yield，来等待获取到 hotBlogList 数据
- 最后将数据渲染到模板中，响应给客户端
使用 express 中间件
express-stonefish 支持使用 express 中间件。使用中间件可以实现一些非常方便的功能，例如日志记录、参数校验等等。
自定义中间件
我们可以在路由中使用自定义中间件，例如：
-- -------------------- ---- -------
--- --------- - -----------------------------
--- ---- - --------------------------
--- ------ - ---------------------
--- ---- - --- -------
-- ------
-------- ----------------- -
------ --------- ----- ----- -
------------------------
--- -------- - ----- -------------------
------------ - ---------
----- -------
--
-
-- ----
----------------------- -------------- --------- ------ -
-- --------------
----- ----------------------- - --------- ------------- ---
---使用第三方中间件
我们还可以使用第三方中间件，例如 body-parser 来处理 post 请求的请求体。使用方式如下：
在 app.js 中，加入如下代码：
var bodyParser = require("body-parser"); app.use(bodyParser.urlencoded({ extended: false })); app.use(bodyParser.json());在路由中获取表单值：
stonefish.post('/login', function* (next) { var username = this.request.body.username; var password = this.request.body.password; // 后续处理逻辑 ... });
使用 socket.io
express-stonefish 还支持编写 socket.io 服务端的代码。
在 app.js 中，加入如下代码：
var socket = require('express-stonefish/socket');
var server = require('http').createServer(app);
var io = require('socket.io')(server);
socket(io);然后，我们就可以在路由中使用 socket.io 来发送和接收消息了，例如：
-- -------------------- ---- -------
--- --------- - -----------------------------
-- ----
------------------------ --------- ------ -
--- ---- - -----
-- -- -- --
---------------------- -------- ------ -
------------------- ------
-- ----
--------------------------- --- - - --------- - - -------
---
-- -- -- --
------------------------- -------- ------ -
---------------------- ------
-- ----
--------------------------- --- - - --------- - - ----- - ----------
---
----- -----
---##总结
本文介绍了 npm 包 express-stonefish 的使用教程，包括初始化项目、路由的基本使用、使用 restful 风格、使用模板引擎、使用 express 中间件、使用 socket.io 等内容。希望对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055d3e81e8991b448db091