03月28, 2018

express 框架学习

Express 是一个简洁而灵活的 node.js Web应用框架, 提供了一系列强大特性帮助你创建各种 Web 应用,和丰富的 HTTP 工具。简单来说它就是一个基于nodejs http 模块简单封装的js库。

Express 框架核心特性:

  • 可以设置中间件来响应 HTTP 请求。
  • 定义了路由表用于执行不同的 HTTP 请求动作。
  • 可以通过向模板传递参数来动态渲染 HTML 页面。

Express 对象

本文所有用例皆基于express-v4.16.3,nodejs-v9.6.1 本文中所探讨的类容在node-study皆有可运行的代码。

静态方法 static(root, [options])

static 用于指定静态文件的路径。root 表示路径,相对路径。options 是具体的配置信息. 官方文档

属性 描述 类型 默认值
dotfiles 是否响应点文件。供选择的值有"allow","deny"和"ignore" String "ignore"
etag 使能或者关闭etag Boolean true
extensions 设置文件延期回退 Boolean true
index 发送目录索引文件。设置false将不发送。 Mixed "index.html"
lastModified 设置文件在系统中的最后修改时间到Last-Modified头部。可能的取值有false和true。 Boolean true
maxAge 在Cache-Control头部中设置max-age属性,精度为毫秒(ms)或则一段ms format的字符串 Number 0
redirect 当请求的pathname是一个目录的时候,重定向到尾随"/" Boolean true
setHeaders 当响应静态文件请求时设置headers的方法 Funtion

restfull 方法

Express 提供了构建 restfull 服务的四个基本方法,用来接收不同的请求方法

  • app.get(path,callback);
  • app.post(path,callback);
  • app.put(path,callback);
  • app.delete(path,callback);

同时,它也提供一个app.all(path,callback);可以接收所有的请求类型。 path 中也提供了从路径中取参数,正则匹配等功能。

详细例子参考 node-study/express

//app.js
const express = require("express");

const app = express();

app.get("/",function (req, res) {
    res.send(`get`)
});
app.post("/",function (req, res) {
    res.send(`post`)
});
app.put("/",function (req, res) {
    res.send(`put`)
});
app.delete("/",function (req, res) {
    res.send(`delete`)
});
app.all("/all",function (req, res) {
    res.send(`all`)
})


let port = 3000;
app.listen(port);
console.log(`statt with ${port}`);
//test.js
const fetch = require('node-fetch');
fetch('http://localhost:3000/', {method: 'get'})
    .then(res => res.text())
    .then(body => console.log(body));
fetch('http://localhost:3000/', {method: 'post'})
    .then(res => res.text())
    .then(body => console.log(body));

fetch('http://localhost:3000/', {method: 'put'})
    .then(res => res.text())
    .then(body => console.log(body));

fetch('http://localhost:3000/', {method: 'delete'})
    .then(res => res.text())
    .then(body => console.log(body));

fetch('http://localhost:3000/all', {method: 'post'})
    .then(res => res.text())
    .then(body => console.log(body));

属性 Properties

app.locals

app的全局上下文对象,类似与JavaEE中的 ApplicationContext,生命周期同服务的生命周期。可以通过req.app.locals获取它。

app.mountpath

app.mountpath属性是子程序挂载的路径模式。这里说得不太清楚,直接上代码。

//app.js
var express = require('express');
var app = express(); // the main app
var admin = express(); // the sub app
admin.get('/', function(req, res) {
    console.log(admin.mountpath); // /admin
    res.send('sub app');
});
app.get("/",function (req, res) {
    res.send("main app")
})
app.use('/admin', admin); // mount the sub app

app.listen(3000);
admin.listen(3001);
console.log("start")
//test.js
const fetch = require('node-fetch');
fetch('http://localhost:3000/', {method: 'get'})
    .then(res => res.text())
    .then(body => console.log(body));//main app
fetch('http://localhost:3001/', {method: 'get'})
    .then(res => res.text())
    .then(body => console.log(body));////main app
fetch('http://localhost:3000/admin', {method: 'get'})
    .then(res => res.text())
    .then(body => console.log(body));////main app

可以看到,当我们访问http://localhost:3001/http://localhost:3000/admin时,是访问到了sub app/路径了。express提供一个子程序的概念。

事件 Events

app.on('mount', callback(parent))

当子程序被挂载到父程序时,mount事件被发射。父程序对象作为参数,传递给回调方法。

var admin = express();
admin.on('mount', function(parent) {
    console.log('Admin Mounted');
    console.log(parent); // refers to the parent app
});
admin.get('/', function(req, res) {
    res.send('Admin Homepage');
});
app.use('/admin', admin);

方法

app.listen(port, [hostname], [backlog], [callback])

设置app监听的端口,并启动app.

  • port 端口号 必填
  • [hostname] 监听host地址 选填
  • [callback] 启动后的回调 选填

app.render(view, [locals], [callback])

返回渲染视图的方法

  • view 视图的路径
  • [locals] 视图中需要的参数
  • callback 视图渲染完毕后的回调函数
let express = require("express");
const app = express();

app.set('views', '../../../public/views')
app.set('view engine', 'jade')

app.get('/', function (req, res) {
    res.render('index', { title: 'Hey', message: 'Hello there views!'},function (err, html) {
        res.send(html);
    });
});

let port = 3000;
app.listen(port);
console.log(`start with ${port}`)

app.set(name, value)配置 app 属性

给 name 设置项赋 value 值,name 是 Application settings 中属性的一项。

Application Settings

属性 类型 描述 默认
case sensitive routing Boolean 启用路径区分大小写。 不启用。对/Foo和/foo处理是一样。
env String 环境模型。 process.env.NODEENV(NODEENV环境变量)或者"development"
etag Varied 设置ETag响应头。可取的值,可以查阅etag options table。更多关于HTTP ETag header。 weak
jsonp callback name String 指定默认JSONP回调的名称。 ?callback=
json replacer String JSON替代品回调 null
json spaces Number 当设置了这个值后,发送缩进空格美化过的JSON字符串。 Disabled
query parser Varied 设置值为false来禁用query parser,或者设置simple,extended,也可以自己实现query string解析函数。simple基于Node原生的query解析,querystring。 "extend"
strict routing Boolean 启用严格的路由。 不启用。对/foo和/foo/的路由处理是一样。
subdomain offset Number 用来删除访问子域的主机点分部分的个数 2
trust proxy Varied 指示app在一个反向代理的后面,使用x-Forwarded-来确定连接和客户端的IP地址。注意:X-Forwarded-头部很容易被欺骗,所有检测客户端的IP地址是靠不住的。trust proxy默认不启用。当启用时,Express尝试通过前端代理或者一系列代理来获取已连接的客户端IP地址。req.ips属性包含了已连接客户端IP地址的一个数组。为了启动它,需要设置在下面trust proxy options table中定义的值。trust proxy的设置实现使用了proxy-addr包。如果想获得更多的信息,可以查阅它的文档 Disable
views String or Array view所在的目录或者目录数组。如果是一个数组,将按在数组中的顺序来查找view。 process.cwd() + '/views'
view cache Boolean 启用视图模板编译缓存。 在生成环境默认开启。
view engine String 省略时,默认的引擎被扩展使用。 默认
x-powered-by Boolean 启用X-Powered-By:ExpressHTTP头部 true

app.disable(name)

app.disable(name)的作用和app.set(name,false)一致

app.enable(name)

app.disable(name)的作用和app.set(name,true)一致

app.engine(ext, callback)

注册给定引擎的回调,用来渲染处理ext文件。 默认情况下,Express需要使用require()来加载基于文件扩展的引擎。例如,如果你尝试渲染一个foo.jade文件,Express在内部调用下面的内容,同时缓存require()结果供随后的调用,来加速性能。

app.engine('jade', require('jade').__express);

app.engine('html', require('ejs').renderFile);


var engines = require('consolidate');
app.engine('haml', engines.haml);
app.engine('html', engines.hogan);

app.get(name)获取 app 的boolean类型属性

app.set(name,true)对应,取值

app.use([path,], function [, function...])

使用中间件的方法

const express = require('express');
const app = express();

const middleware = function (req,res,next) {
    console.log()
    console.log("********我是全局请求拦截器********")
    console.log(`* req.url: ${req.url}`)
    console.log("***************************")
    console.log()
    next();
}

const middleware2 = function (req,res,next) {
    console.log("********我是home请求拦截器********")
    console.log(`* req.url: ${req.url}`)
    console.log("***************************")

    res.send("middleware2")
    next();
}

const hello = function (req,res,next) {
    res.write("hello ")
    next();
}

const world = function (req,res,next) {
    res.write("world")
    next();
}

app.use(middleware)
app.get('/index',function (req, res) {
    console.log("index")
    res.send("index");
});

app.use('/home',middleware2);

app.get("/hello",[hello,world],function (req, res) {
    res.end("!");
})

let port = 3000;
app.listen(port);
console.log(`start with ${port}`);

app.route(path) 路由

express已经提供了五个restfull方法对请求经行路由。但是在实际项目开发中路由往往是很多层的。比如:

 /needLogin/success //登录成功的地址
 /needLogin/failure //登录失败的地址

此时可以使用路由来简化我们的地址。/needLogin 为一个路由,这个路由下边又有两个地址。学过SpringMVC会很容易理解这点,就和类上的注解@RequestMapping和方法上的@RequestMapping一样的关系

let express = require("express");
const Morgan = require('morgan');
const app = express();
const session = require('express-session');
const bodyParser = require('body-parser');

// logger
let morgan = Morgan('dev');
app.use(morgan)

// 静态文件
const options = {
    extensions: ['htm', 'html'],
};
app.use(express.static('../../../public/static',options));

// 使用 bodyParser 中间件
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended: true}));

// 使用 session 中间件
app.use(session({
    secret: 'secret', // 对session id 相关的cookie 进行签名
    resave: true,
    saveUninitialized: false, // 是否保存未初始化的会话
    cookie: {
        maxAge: 1000 * 60 * 30, // 设置 session 的有效时间,单位毫秒
    },
}));

//路由中间件
let router = express.Router();
router.use(function(req, res, next) {
    console.log(req.url)
    next();
});
router.get("/success",function (req, rsp) {
    rsp.end(`登录成功 ${req.url}<br> 当前登录用户: ${req.session.username}`)
});
router.get("/failure",function (req, rsp) {
    rsp.end(`登录失败 ${req.url}`)
});
app.use('/needLogin',router)


app.get("/needLogin/longinSucess",function (req, rsp) {
    if (!req.session.username) {
        rsp.redirect('../needLogin/failure');
    } else {
        rsp.redirect('../needLogin/success');
    }
})

app.post('/login', function (req, rsp) {
    let body = req.body;
    let session = req.session;
    session.username = body.username;
    session.password = body.password;
    rsp.redirect('../loginSuccess.html')
});


let port = 3000;
app.listen(port);
console.log(`start with ${port}`)

Request 请求对象

  1. req.app:当callback为外部文件时,用req.app访问express的实例
  2. req.baseUrl:获取路由当前安装的URL路径
  3. req.body / req.cookies:获得「请求主体」/ Cookies
  4. req.fresh / req.stale:判断请求是否还「新鲜」
  5. req.hostname / req.ip:获取主机名和IP地址
  6. req.originalUrl:获取原始请求URL
  7. req.params:获取路由的parameters
  8. req.path:获取请求路径
  9. req.protocol:获取协议类型
  10. req.query:获取URL的查询参数串
  11. req.route:获取当前匹配的路由
  12. req.subdomains:获取子域名
  13. req.accepts():检查可接受的请求的文档类型
  14. req.acceptsCharsets / req.acceptsEncodings /
  15. req.acceptsLanguages:返回指定字符集的第一个可接受字符编码
  16. req.get():获取指定的HTTP请求头
  17. req.is():判断请求头Content-Type的MIME类型

Response 响应对象

  1. res.app:同req.app一样
  2. res.append():追加指定HTTP头
  3. res.set():在res.append()后将重置之前设置的头
  4. res.cookie(name,value [,option]):设置Cookie option:cookie的设置
    • domain: 设置cookie的域名。默认是你本app的域名。
    • expires: cookie的过期时间,GMT格式。如果没有指定或者设置为0,则产生新的cookie。
    • httpOnly: 这个cookie只能被web服务器获取的标示。
    • maxAge: 是设置过去时间的方便选项,其为过期时间到当前时间的毫秒值。
    • path: cookie的路径。默认值是/。
    • secure: 标示这个cookie只用被HTTPS协议使用。
    • signed: 指示这个cookie应该是签名的。
  5. res.clearCookie():清除Cookie
  6. res.download():传送指定路径的文件
  7. res.get():返回指定的HTTP头
  8. res.json():传送JSON响应
  9. res.jsonp():传送JSONP响应
  10. res.location():只设置响应的Location HTTP头,不设置状态码或者close response
  11. res.redirect():设置响应的Location HTTP头,并且设置状态码302
  12. res.render(view,[locals],callback):渲染一个view,同时向callback传递渲染后的字符串,如果在渲染过程中有错误发生next(err)将会被自动调用。callback将会被传入一个可能发生的错误以及渲染后的页面,这样就不会自动输出了。
  13. res.send():传送HTTP响应
  14. res.sendFile(path [,options] [,fn]):传送指定路径的文件,path一定是关于文件的绝对路径;会自动根据文件extension设定Content-Type; options:配置
  15. maxAge: 设置Cache-Control的max-age属性,格式为毫秒数,或者是ms format的一串字符串
  16. root: 相对文件名的根目录
  17. lastModified: 设置Last-Modified头部为此文件在系统中的最后一次修改时间。设置false来禁用它
  18. headers: 一个对象,包含了文件相关的HTTP头部。
  19. dotfiles: 是否支持点开头文件名的选项。可选的值"allow","deny","ignore"
  20. res.set():设置HTTP头,传入object可以一次设置多个头
  21. res.status():设置HTTP状态码
  22. res.type():设置Content-Type的MIME类型

session 会话管理

multer 文件上传

express4.x把原先自带的bodyParser模块,分离成了body-parser,multer两个中间件

//app.js
const express = require("express");
const multer = require('multer');
const upload = multer();
const fs = require("fs");
const app = express();
const options = {
    extensions: ['htm', 'html'],//设置文件扩展名备份选项
};

//静态文件
app.use(express.static('../../../public/static',options));

//使用 multer 处理文件上传
app.post("/upload",upload.single('file'),function (req, rsp) {
    console.log(req.file)
    console.log('========接收文件成功========')
    let file = req.file;
    fs.writeFile(file.originalname,file.buffer,function (err) {
        if(err){
            rsp.send("文件写入失败")
        }else {
            rsp.send("文件写入成功")
        }
    })
});

let port = 3000;
app.listen(port);
console.log(`start with ${port}`)
<!--upload.html-->
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>upload</title>
</head>
<body>
    <form id="form" method="post" action="/upload" enctype="multipart/form-data">
        <input type="file" name="file">
        <br>
        <button type="submit">上传图片</button>
    </form>
</body>
</html>

Express 4.x API

本文链接:https://www.qiangshuidiyu.xin/post/express.html

-- EOF --

Comments