Express快速入门
安装Express
npm i express -g
使用时还会用到postman,建议先安装再食用(正常的postman为全英文版,想汉化可自行查找postman汉化包)
postman简单介绍
Express
Express是一个自身功能极简,完全是有路由和中间件构成的一个web开发框架:本质上说,一个express的应用就是在调用各种中间件。
nodemon
在调试node.js项目,修改了项目的代码以后,需要频繁的手动停掉
但是使用nodemon就可以在监测到我们修改了代码以后自动帮我们重启项目(类似于java的热部署)
使用npm安装nodemon
npm i -g nodemon
res.end()
结束响应流程。用于在没有任何数据的情况下快速结束响应。
- 参数可以是buffer对象、字符串
res.send()
发送HTTP响应
- 参数可以是buffer对象、字符串、对象、数组
创建一个最基本的web服务器
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
// 启动web服务器,调用 app.listen(端口号,成功后的回调函数)
app.listen(80,()=> {
console.log('serve running at http://127.0.0.1');
})
启动后在vscode中ctrl+点击http://127.0.0.1
此处本来是http://127.0.0.1:80 但是由于80可以省略就变成了http://127.0.0.1
使用express监听GET和POST请求
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
// 监听客户端的get和post请求,并向客户端相应具体的内容
app.get('/user',(req,res)=> {
// 调用express提供res.send()方法,向客户端相应一个json对象
res.send({name:'zs',age:20 , gender: '男'})
})
app.post('/user',(req,res)=> {
// 调用express提供res.send()方法,向客户端相应一个文本字符串
res.send('请求成功')
})
app.get('/',(req,res)=> {
// 调用express提供res.send()方法,向客户端相应一个json对象
console.log(req);
res.send(req.query)
})
// 启动web服务器
app.listen(80,()=> {
console.log('serve running at http://127.0.0.1');
})
使用postman
Express路由
路由是指服务器端如何响应特定端口的客户端请求。由一个URI(路径标识)和一个特定的HTTP方法(GET、POST等)组成的。
路由的定义结构:
app.METHOD(PATH, HANDLER)
路由的匹配机制
路由基础代码
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
// 挂载路由
app.get('/',(req,res)=> {
res.send('get')
})
app.post('/',(req,res)=> {
res.send('post')
})
// 启动web服务器
app.listen(80,()=> {
console.log('serve running at http://127.0.0.1');
})
使用postman测试
发送状态码和状态信息
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
app.get('/', (req,res) => {
res.statusCode = 200; // 设置响应状态码
res.statusMessage = "ooookkkk"; // 设置响应状态信息
res.end(); // 结束响应
})
app.listen(80, () => {
console.log('serve running at http://localhost:80/');
})
postman测试
cookie
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
app.get('/', (req,res) => {
res.cookie('name', 'ddd'); // 设置cookie
res.end(); // 结束响应
})
app.listen(80, () => {
console.log('serve running at http://localhost:80/');
})
postman测试
Express中间件
中间件和路由的区别就是有无next()参数
有点像vue的路由守卫里面的next()放行的意思
全局生效的中间件
app.use(function (req, res, next) {/*表示匹配任何路由*/
console.log('简单中间件函数')
next()/*表示匹配完成这个中间件就继续往下执行,转交给下一个中间件*/
})
局部生效的中间件
const nw = function (req, res,next) {
console.log("我是中间件");
next()
}
// nw中间件会影响这个路由
app.get('/', nw , (req,res) => {
console.log('调用了/ ');
res.send('homepage')
})
// nw中间件不会影响这个路由
app.get('/user', (req,res) => {
console.log('调用了/user ');
res.send('userpage')
})
路由中间件
app.get("/", function (req, res,next) {
console.log("匹配成功");
next()
})
错误级别的中间件
错误级别中间件作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃
app.get('/',function(){ //路由
throw new Error('服务器内部错误')//自己抛出一个自定义错误
res.send('home')
})
app.use(function (err, req, res, next) {
console.log('错误'+err.message)
res.send('错误'+err.message)
})
内置中间件
express.static
静态路由匹配或快速托管静态资源的内置中间件
app.use('/static',express.static("public"));
express.json()
解析表单中的json格式的数据
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
//通过express.json()这个中间件,解析表单中的json格式的数据
app.use(express.json())
app.post('/', (req,res) => {
// 如果没有配置解析表单数据的中间件,则req.body默认等于underfined
console.log(req.body);
res.send('ok')
})
app.listen(80, () => {
console.log('serve running at http://localhost:80/');
})
express.urlencoded()
解析url-encoded格式的请求体数据
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
//默认情况下,如果不配置解析表单数据的中间件,则req.body默认于undefined
app.use(express.urlencoded({extended:false}))
app.post('/book', (req,res) => {
// 在服务器端,可以通过req.body 来获取json格式的表单数据和url-encoded格式的数据
console.log(req.body);
res.send('ok')
})
app.listen(80, () => {
console.log('serve running at http://localhost:80/');
})
中间件的使用
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
app.use(function (req, res, next) {/*表示匹配任何路由*/
console.log('简单中间件函数')
next()/*表示匹配完成这个中间件就继续往下执行,转交给下一个中间件*/
})
app.get('/', (req,res) => {
console.log('调用了/ ');
res.send('homepage')
})
app.listen(80, () => {
console.log('serve running at http://localhost:80/');
})
postman调试
中间件的作用
特性:多个中间件之间共享同一份req和res
为方便使用,可在上游的中间件中统一为req或res添加自定义属性或方法,供下游中间件或路由使用
注意事项
要在路由之前注册中间件
中间件最后一定要调用next()
next()后面不能再写代码
连续调用多个中间件时,多个中间件之间共享req和res
Express编写接口
例子:
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
//导入路由模块
const router = require('./16apirouter')
//把路由注册到app
app.use('/api',router)
app.listen(80, () => {
console.log('serve running at http://127.0.0.1:80/');
})
16apirouter.js
// 导入express
const express = require('express')
const router = express.Router()
//挂载对应路由
router.get('/get', (req,res) => {
//通过req.query获取客户端通过查询字符串,发送到服务器的数据
const query = req.query
res.send({
state:0,
msg:'gey请求成功',
data:query
})
})
module.exports = router
基于CORS 跨域资源共享
解决接口跨域问题的方案主要有两种
① CORS(主流的解决方案,推荐使用)
② JSONP(有缺陷的解决方案:只支持 GET 请求)
使用 cors 中间件解决跨域问题
cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题。
使用步骤分为如下 3 步:
①运行 npm install cors 安装中间件
npm i cors
②使用 const cors = require(‘cors’) 导入中间件
const cors = require(‘cors’)
③在路由之前调用 app.use(cors()) 配置中间件
app.use(cors())
CORS 响应头部 - Access-Control-Allow-Origin
响应头部中可以携带一个 Access-Control-Allow-Origin 字段,其语法如下:
Access-Control-Allow-Origin:<origin> | *
其中,origin 参数的值指定了允许访问该资源的外域 URL。
例如,下面的字段值将只允许来自http://goodluck.cn的请求:
res.setHeader('Access-Control-Allow-Origin','http://goodluck.cn')
如果指定了 Access-Control-Allow-Origin 字段的值为通配符 *,表示允许来自任何域的请求,示例代码如下:
res.setHeader('Access-Control-Allow-Origin','*')
CORS 响应头部 - Access-Control-Allow-Headers
默认情况下,CORS 仅支持客户端向服务器发送如下的 9 个请求头:
Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、Content-Type (值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一)
如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过 Access-Control-Allow-Headers 对额外的请求头进行声明,否则这次请求会失败!
res.setHeader('Access-Control-Allow-Headers','Content-Type,X-Custom-Header'); //多个请求头之间使用英文逗号进行分割
CORS 响应头部 - Access-Control-Allow-Methods
默认情况下,CORS 仅支持客户端发起 GET、POST、HEAD 请求。
如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP 方法。
示例代码如下:
// 只允许 POST、GET、DELETE、HEAD 请求方法
res.setHeader('Access-Control-Alow-Methods','POST,GET,DELETE,HEAD');
// 允许所有的 HTTP 请求方法
res.setHeader('Access-Control-Alow-Methods','*');
CORS请求分类
客户端在请求 CORS 接口时,根据请求方式和请求头的不同,可以将 CORS 的请求分为两大类,分别是:
①简单请求
②预检请求
简单请求
同时满足以下两大条件的请求,就属于简单请求:
① 请求方式:GET、POST、HEAD 三者之一
② HTTP 头部信息不超过以下几种字段:无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、Content-Type(只有三个值application/x-www-form-urlencoded、multipart/form-data、text/plain)
预检请求
只要符合以下任何一个条件的请求,都需要进行预检请求:
① 请求方式为 GET、POST、HEAD 之外的请求 Method 类型
② 请求头中包含自定义头部字段
③ 向服务器发送了 application/json 格式的数据
在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。
简单请求和预检请求的区别
简单请求的特点:客户端与服务器之间只会发生一次请求。
预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求
JSONP 接口
回顾 JSONP 的概念与特点
概念:浏览器端通过
特点
①JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。
②JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求。
创建 JSONP 接口的注意事项
如果项目中已经配置了 CORS 跨域资源共享,为了防止冲突,必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口。
示例代码如下:
// 要先创建 JSONP 接口(这个接口不会被处理成 CORS 接口)
app.get('/api/jsonp',(req,res)=>{
});
// 在配置 CORS 中间件(后续的所有接口,都会被处理成 CORS 接口)
app.use(cors());
// 此处开启了 CORS 的接口
app.get('/api/get',(req,res)=>{
});
配置 JSONP代码
// 配置 JSONP 的接口
app.get('/api/jsonp', (req, res) => {
// 定义 JSONP 接口具体实现的过程
// 1.得到函数的名称
const funcName = req.query.callback;
// 2.定义要发送到客户端的数据对象
const data = { name: 'DDD', age: 20 };
// 3.拼接出一个函数调用
const scriptStr = `${funcName}(${JSON.stringify(data)})`;
// 4.把拼接的字符串,想要给客户端
res.send(scriptStr);
});
拓展
1、把字符串转成JSON对象
JSON.parse(data);
2、把JavaScript 对象转换为 JSON 字符串
JSON.stringify()