nodejs篇 express(1)
文章目录
-
- 前言
- express介绍
- 安装
- RESTful接口规范
- express的简单使用
-
- 一个最简单的服务器，仅仅只需要几行代码便可以实现。
- restful规范的五种接口类型
- 请求信息req的获取
- 响应信息res的设置
- 中间件的使用
- 自定义中间件
- 解决跨域
- nodejs相关其它内容
前言
express作为nodejs必学的模块之一，从这篇文章开始，介绍express一些基础内容，express的安装，restful接口规范，express的接口开发，express的跨域处理，express的中间件使用，请求信息req常见处理，请求头res常见处理等。为接下来真正的项目框架下开发一个express服务器做准备。
express介绍
express是在nodejs内置模块http的基础上开发，也就是说http模块有的api，express全都有，并且它们的用法也很类似。
express.js的优点在于，它封装了一些常用的，接口处理方法，更有利于中间件的扩展，让接口的开发更加规范合理等。
安装
express不是nodejs的内置模块，属于第三方开源模块，想要使用需要下载安装。
将来要部署到服务器，在开发环境和生产环境都需要使用，输入命令行
npm install express --save 或者 yarn add express
在开发过程中，会发现，我们一直在编写服务端的代码，每次修改后，都需要关掉原来的服务器，重启 node express.js才能生效。
为此，再安装一个辅助npm包nodemon，nodemon能自动监听文件的更新，并自动重启。
npm install -g nodemon 或者 yarn global add nodemon
安装好了之后，我们重启一下服务器，就再也不需要每次更改代码后都要重启了
nodemon express.js
RESTful接口规范
既然要开发服务器，我们就要遵循接口开发规范，这里简单介绍RESTful接口设计规范。
- 尽量使用
https协议，如果条件不支持，就只能http协议 - 应该尽量将所有的api都放在专有域名之下，比如
https://api.dengxi.com，当然，如果你的接口比较简单，业务也不复杂，你就可以 主域名 +'/api'，比如网站的域名为http://dxyx-together.cn,那所有的api都放在http://dxyx-together.cn/api/xxx,后面的xxx就是api具体的path。 - 版本号，如果是专有域名
https://api.dengxi.com，当前版本为v1，那对应的就是https://api.dengxi.com/v1,如果不是专有域名，就将版本信息放在响应头中，这样可能不如直接放在url上直观。 - 路径名称，又称为终点endpoint，命名要求不允许出现英文的动词，而应该是名词复数。比如有一个接口返回许多用户的信息，就应该设计为
xxx/api/users。如果返回的数据直接就是某个数据库表格的内容，那就直接以数据库表格名称命名即可。 - 常用的有五种接口
get(获取数据)，post(创建数据)，delete(删除数据)，put(完整更新数据)，patch(某一数据部分更新)，不常用的有两种（head，options），很多时候这几种接口类型可以混用，但按照规范，它们有属于自己的使用场景。 - 身份认证。部分接口涉及账户信息，比如常见的中后台管理系统，c端也有购物车、会员中心、钱包等场景，基于JWT的接口权限认证。
- 跨域处理，在服务端设置cors跨域处理，允许客户端跨域请求资源，特别是当接口放在专有域名下时。
- 每一个接口的每一次请求，服务器都必须给予http状态码回应和数据两个部分。
- http状态码分为五类
1xx(相关信息) 2xx(操作成功) 3xx(重定向) 4xx(客户端错误) 5xx(服务器错误)一共有一百多种状态码，常用的也就二十多种。 - 返回的数据部分，通常是JSON对象，因此，服务器返回头需要将
Content-Type属性设置为application/json - 错误处理主要是需要正确使用http状态码，主要是4xx和5xx，并且返回的信息尽可能详尽，以便更快速的排查。
express的简单使用
一个最简单的服务器，仅仅只需要几行代码便可以实现。
//express.js
var express = require("express");
var app = express();
var port = 3000;
app.get("/", function (req, res) {
res.send("hello world");
});
app.listen(port, function () {
console.log("server runing at 3000");
});
再输入命令行，服务器就成功启动
nodemon express.js
restful规范的五种接口类型
var express = require("express");
var app = express();
var port = 3000;
app.get("/", function (req, res) {
var query = req.query
console.log(query)
res.send("hello world");
});
app.post("/", function (req, res) {
res.send("post hello world");
});
app.put("/users",function(req,res) {
res.send("put hello world");
})
app.delete("/users",function(req,res) {
res.send("delete hello world");
})
app.patch("/users",function(req,res) {
res.send("delete hello world");
})
app.listen(port, function () {
console.log("server runing at 3000");
});
请求信息req的获取
比如我们获取get请求的参数 req.query
//express.js
var express = require("express");
var app = express();
var port = 3000;
app.get("/api", function (req, res) {
console.log(req.query)
res.status('200')
});
app.listen(port, function () {
console.log("server runing at 3000");
});
关于req的所有属性和方法，你可以在这里找到
http://expressjs.com/en/5x/api.html#req
中文版本的
http://expressjs.com/zh-cn/4x/api.html#req
响应信息res的设置
var express = require("express");
var app = express();
var port = 3000;
app.get("/api", function (req, res) {
var query = req.query
console.log(query)
res.set('Content-Type', 'application/json')
res.status('200')
res.json({code:200,data: '请求成功了'})
});
app.listen(port, function () {
console.log("server runing at 3000");
});
关于res的所有属性和方法，你可以在这里找到
http://expressjs.com/en/5x/api.html#res
中文版本
http://expressjs.com/zh-cn/4x/api.html#res
中间件的使用
express官方提供了几个比较重要的中间件
http://expressjs.com/en/5x/api.html#express
比如express.json() ，当客户端发送的数据是json数据时，req.body是取不到正常的数据的，所以，我们需要通过这个中间件处理一下才可以。
我用http模块，来请求一下我express服务器
const http = require("http");
// 请求刚刚创建的服务器
const options = {
hostname: "localhost",
port: 3000,
path: "/api",
method: "post",
headers: {
"Content-Type": "application/json",
},
};
const req = http.request(options, (res) => {
console.log(`状态码: ${res.statusCode}`);
console.log(`响应头: ${JSON.stringify(res.headers)}`);
res.setEncoding("utf8");
res.on("data", (chunk) => {
console.log(`响应主体: ${chunk}`);
});
res.on("end", () => {
console.log("响应中已无数据。");
});
});
req.write(JSON.stringify({ name: "dx" })) // 发送了一个json数据
req.end();
通过app.use 来调用中间件，达到全局使用的目的
var express = require("express");
var app = express();
var port = 3000;
app.use(express.json())
app.post("/api", function (req, res) {
console.log(req.body)
res.set('Content-Type', 'application/json')
res.status('200')
res.json({code:200,data: '请求成功了'})
});
app.listen(port, function () {
console.log("server runing at 3000");
});
也可以在某个接口中单独使用中间件，只对这一个接口生效。
var express = require("express");
var app = express();
var port = 3000;
// app.use(express.json())
app.post("/api", express.json(), function (req, res) {
// var query = req.query
console.log(req.body)
res.set('Content-Type', 'application/json')
res.status('200')
res.json({code:200,data: '请求成功了'})
});
app.listen(port, function () {
console.log("server runing at 3000");
});
自定义中间件
中间件的本质，其实就是一个函数，express的中间件函数呢，有三个参数，req，res，next
创造一个中间件，用来打印日志，让每一次客户端请求的body都能在日志中看到，用来简化之前的方案。
function (req, res, next) {
console.log(req.body);
// 执行下一个中间件，必须调用，否则请求会被拦截在这里
next();
}
再创造一个中间件，用来满足响应，总是返回status 200 并且返回相同的json
function (req, res, next) {
res.set("Content-Type", "application/json");
res.status("200");
res.json({ code: 200, data: "请求成功了" });
// 执行下一个中间件，必须调用，否则请求会被拦截在这里
next();
}
使用这两个中间件
var express = require("express");
var app = express();
var port = 3000;
app.use(express.json());
app.use(function (req, res, next) {
console.log(req.body);
next();
});
app.use(function (req, res, next) {
res.set("Content-Type", "application/json");
res.status("200");
res.json({ code: 200, data: "请求成功了" });
next();
});
// app.post 里面啥也没干
app.post("/api", express.json(), function (req, res) {
});
app.listen(port, function () {
console.log("server runing at 3000");
});
左边是服务器接口，打印了客户端传过来的name:dx,右边是客户端请求，同样拿到了状态码200和json数据。
中间件的执行顺序就是从上往下依次执行，执行的顺序也很重要。
如果是某一个单独的接口的中间件，中间件1比中间件2先执行性。
app.post("/api", 中间件1, 中间件2, function (req, res) {
});
解决跨域
一 用一种粗暴的方式，任意域名都能成功请求。
var express = require("express");
var app = express();
var port = 3000;
//设置允许跨域访问该服务.
app.all("*", function (req, res, next) {
res.header("Access-Control-Allow-Origin", "*"); // *表示所有域名，你也可以指定某个特别的域名 "www.dxyx-together.cn"
res.header("Access-Control-Allow-Headers", "Content-Type");
res.header("Access-Control-Allow-Methods", "*"); // *表示所有请求方式都可以跨域，你也可以设置 比如只允许get和post "GET;POST"
res.header("Content-Type", "application/json;charset=utf-8");
next();
});
app.use(express.json());
app.use(function (req, res, next) {
console.log(req.body);
next();
});
app.use(function (req, res, next) {
res.set("Content-Type", "application/json");
res.status("200");
res.json({ code: 200, data: "请求成功了" });
next();
});
app.post("/api", express.json(), function (req, res) {});
app.listen(port, function () {
console.log("server runing at 3000");
});
二 express 的 cors跨域
cors 是 Express 的一个第三方中间件，通过安装和配置 cors 中间件，可以很方便地解决跨域问题
使用步骤分为三步
- 运行
npm install cors安装中间件 - 使用
const cors = require('cors')导入中间件 - 在路由之前调用
app.use(cors())配置中间件
var express = require("express");
var cors = require('cors')
var app = express();
var port = 3000;
//设置允许跨域访问该服务.
app.use(cors())
app.use(express.json());
app.use(function (req, res, next) {
console.log(req.body);
next();
});
app.use(function (req, res, next) {
res.set("Content-Type", "application/json");
res.status("200");
res.json({ code: 200, data: "请求成功了" });
next();
});
app.post("/api", express.json(), function (req, res) {});
app.listen(port, function () {
console.log("server runing at 3000");
});
cors的更多使用方式，详见cors插件官方介绍
https://www.npmjs.com/package/cors
nodejs相关其它内容
nodejs commonjs介绍
nodejs fs模块介绍
nodejs path模块介绍
nodejs events模块介绍
nodejs http模块介绍
nodejs net模块介绍
nodejs url模块介绍
nodejs process模块介绍
nodejs buffer模块介绍
nodejs stream 模块介绍