前后端交互-Express框架

作者: Imkata | 来源:发表于2022-04-15 08:59 被阅读0次

一. Express框架简介及初体验

1 - Express框架是什么

Express是一个基于Node平台的web应用开发框架，它提供了一系列的强大特性，帮助你创建各种Web应用。我们可以使用npm install express命令进行下载。

基于原生 node.js 实现网站应用的缺点：

比如实现路由功能，需要对请求地址进行解析，还要进行各种判断，代码繁琐
实现静态资源访问功能，还需要使用文件读取模块对文件内容进行读取，还需要设置响应内容的类型
接受POST请求参数的代码，需要对请求对象添加事件，手动拼接请求参数，对请求参数的格式进行转换比较复杂

基于原生node.js实现网站应用比较困难，所以Express框架就诞生了，Express框架内部提供了一系列强大的功能，能够让我们使用各种简洁的代码创建各种网站应用，而且Express框架已经成为企业中创建网站应用的标准。

2 - Express框架特性

提供了方便简洁的路由定义方式（实际上就是上文我们说的第三方模块router，因为router就是从Express中抽取出来的）
对获取HTTP请求参数进行了简化处理
对模板引擎支持程度高，方便渲染动态HTML页面
提供了中间件机制有效控制HTTP请求
拥有大量第三方中间件对功能进行扩展

3 - 原生Node.js与Express框架对比之路由

app.on('request', (req, res) => {
    // 获取客户端的请求路径
    let { pathname } = url.parse(req.url);
    // 对请求路径进行判断 不同的路径地址响应不同的内容
    if (pathname == '/' || pathname == 'index') {
       res.end('欢迎来到首页');
    } else if (pathname == '/list') {
       res.end('欢迎来到列表页页');
    } else if (pathname == '/about') {
       res.end('欢迎来到关于我们页面')
    } else {
       res.end('抱歉, 您访问的页面出游了');
    }
});

// 当客户端以get方式访问/时
app.get('/', (req, res) => {
    // 对客户端做出响应
    res.send('Hello Express');
});

// 当客户端以post方式访问/add路由时
app.post('/add', (req, res) => {
   res.send('使用post方式请求了/add路由');
});

4 - 原生Node.js与Express框架对比之获取请求参数

app.on('request', (req, res) => {
   // 获取GET参数
   let {query} = url.parse(req.url, true);
   // 获取POST参数
   let postData = '';
   req.on('data', (chunk) => {
       postData += chunk;
   });
   req.on('end', () => {
       console.log(querystring.parse(postData)
   }));
});

app.get('/', (req, res) => {
   // 获取GET参数
   console.log(req.query);
});

app.post('/', (req, res) => {
   // 获取POST参数
   console.log(req.body);
})

5 - Express初体验

使用Express框架创建web服务器非常简单，调用express模块返回的函数即可。

// 引入Express框架
const express = require('express');
// 使用框架创建web服务器
const app = express();
// 当客户端以get方式访问/路由时
// 当什么都不写的时候，默认的请求地址就是/
app.get('/', (req, res) => {
   // 对客户端做出响应
     // 1. send方法会自动设置http状态码
     // 2. send方法内部会检测响应内容的类型，并帮我们自动设置响应的内容类型及文件编码
   res.send('Hello Express'); // <h2>Hello Express</h2> {say: 'hello'}
});
// 程序监听3000端口
app.listen(3000);
console.log('网站服务器启动成功');

二. Express中间件

1 - 什么是中间件

中间件就是一堆方法，可以接收客户端发来的请求、可以对请求做出响应，也可以将请求继续交给下一个中间件继续处理。

中间件主要由两部分构成，中间件方法以及请求处理函数。
中间件方法由Express提供，负责拦截请求（下面的 get、post），请求处理函数由开发人员提供，负责处理请求（下面的处理函数）。

app.get('请求路径', '处理函数')   // 接收并处理get请求
app.post('请求路径', '处理函数')  // 接收并处理post请求

可以针对同一个请求设置多个中间件，对同一个请求进行多次处理。
默认情况下，请求从上到下依次匹配中间件，一旦匹配成功，终止匹配。
可以调用next()方法将请求的控制权交给下一个中间件，直到遇到结束请求的中间件。

app.get('/request', (req, res, next) => { //这里加个next
    req.name = "张三";
    next(); //调用next()方法将请求的控制权交给下一个中间件
});
app.get('/request', (req, res) => {
    res.send(req.name); // "张三"
});

2 - app.use中间件

app.use 匹配所有的请求方式，可以直接传入请求处理函数，代表接收所有的请求。

app.use((req, res, next) => { //这里加个next
    console.log(req.url);
    next(); //调用next()方法将请求的控制权交给下一个中间件
});

app.use 第一个参数也可以传入请求地址，代表不论什么请求方式（无论是GET还是POST），只要是这个请求地址就接收这个请求。

app.use('/admin', (req, res, next) => {
    console.log(req.url);
    next();
});

3 - 中间件的应用

路由保护，客户端在访问需要登录的页面时，可以先使用中间件判断用户登录状态，用户如果未登录，则拦截请求，直接响应，禁止用户进入需要登录的页面。
网站维护公告，在所有路由的最上面定义接收所有请求的中间件，直接为客户端做出响应，网站正在维护中。
自定义404页面

// 引入express框架
const express = require('express');
// 创建网站服务器
const app = express();

// 由于没有next,所以是拦截所有请求,比如:网站公告
// app.use((req, res, next) => {
//  res.send('当前网站正在维护...')
// })

app.use('/admin', (req, res, next) => {
    // 用户没有登录 
    let isLogin = true;
    // 如果用户登录
    if (isLogin) {
        // 让请求继续向下执行
        next()
    } else {
        // 如果用户没有登录 直接对客户端做出响应
        res.send('您还没有登录 不能访问/admin这个页面')
    }
})

app.get('/admin', (req, res) => {
    res.send('您已经登录 可以访问当前页面')
})

// 因为中间件的匹配是有顺序的,所以404页面的中间件在最后面
app.use((req, res, next) => {
    // 为客户端响应404状态码以及提示信息,是可以链式调用的
    res.status(404).send('当前访问的页面是不存在的')
})

// 监听端口
app.listen(3000);
console.log('网站服务器启动成功');

4 - 错误处理中间件

在程序执行的过程中，不可避免的会出现一些无法预料的错误，比如文件读取失败，数据库连接失败。
错误处理中间件是一个集中处理错误的地方。当程序出现错误时，调用next()方法，并且将错误信息通过参数的形式传递给next()方法，即可触发错误处理中间件。

// 引入express框架
const express = require('express');
const fs = require('fs');
// 创建网站服务器
const app = express();

app.get('/index', (req, res, next) => {
  
    // 下面是同步代码抛出错误,错误处理中间件只能捕获同步代码抛出错误
    // throw new Error('程序发生了未知错误')
  
    // 当有下面的异步代码抛出错误时,错误处理中间件捕获不了,这时候需要用next(err),手动触发
    fs.readFile('./01.js', 'utf8', (err, result) => {
        if (err != null) {
            next(err)
        } else {
            res.send(result)
        }
    })
})

// 错误处理中间件
app.use((err, req, res, next) => { //四个参数
    res.status(500).send(err.message); // 服务器错误,状态码500
})

// 监听端口
app.listen(3000);
console.log('网站服务器启动成功');

5 - 捕获错误

在node.js中，异步API的错误信息都是通过回调函数获取的（比如上面的读取文件），支持Promise对象的异步API发生错误可以通过catch方法捕获。

异步函数写成了同步代码的形式，发生错误要如何捕获错误呢？

try catch 可以捕获异步函数错误、同步代码错误（比如：throw new Error('程序发生了未知错误')），但是不能捕获其他类型的API发生的错误（比如回调函数的错误，Promise对象的错误）。

// 引入express框架
const express = require('express');
const fs = require('fs');
const promisify = require('util').promisify;
const readFile = promisify(fs.readFile); // 将readFile方法promisify化
// 创建网站服务器
const app = express();
  
app.get('/index', async (req, res, next) => {
    try {
        await readFile('./aaa.js')
    } catch (ex) { //ex错误对象
        next(ex); // 将错误传递给错误处理中间件
    }
})

// 错误处理中间件
app.use((err, req, res, next) => {
    res.status(500).send(err.message);
})

// 监听端口
app.listen(3000);
console.log('网站服务器启动成功');

三. Express框架请求处理

1 - 构建模块化路由

示例代码：

// 引入express框架
const express = require('express');
// 创建网站服务器
const app = express();
// 创建路由对象
const home = express.Router();
// 为路由对象匹配请求路径
app.use('/home', home);
// 创建二级路由
home.get('/index', (req, res) => {
    //  /home/index
    res.send('欢迎来到博客首页页面')
})

// 端口监听
app.listen(3000);

home路由模块：

// home.js
const express = require('express');
const home = express.Router();
home.get('/index', () => {
    res.send('欢迎来到博客展示页面');
});
module.exports = home;

admin路由模块：

// admin.js
const express = require('express');
const admin = express.Router();
admin.get('/index', () => {
    res.send('欢迎来到博客管理页面');
});
module.exports = admin;

在app.js中为路由对象匹配请求路径：

// 引入express框架
const express = require('express');
// 创建网站服务器
const app = express();

const home = require('./route/home');
const admin = require('./route/admin');

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

// 端口监听
app.listen(3000);

2 - GET参数的获取

Express框架中使用req.query即可获取GET参数，框架内部会将GET参数转换为对象并返回（就不用我们引用url模块手动处理了）。

// 接收地址栏中问号后面的参数
// 例如: http://localhost:3000/?name=zhangsan&age=30
app.get('/', (req, res) => {
   // 接收get请求参数
   res.send(req.query)// {"name": "zhangsan", "age": "30"}
});

3 - POST参数的获取

Express中接收post请求参数需要借助第三方模块body-parser，这个模块是Express官方提供的。首先使用命令：npm install body-parser 下载这个第三方模块。

// 引入express框架
const express = require('express');
const bodyParser = require('body-parser');
// 创建网站服务器
const app = express();
// 拦截所有请求
// extended: false 方法内部使用querystring模块处理请求参数的格式  推荐
// extended: true 方法内部使用第三方模块qs处理请求参数的格式  更强大
app.use(bodyParser.urlencoded({extended: false}))

app.post('/add', (req, res) => {
    // 接收post请求参数
    res.send(req.body)
})

// 端口监听
app.listen(3000);

补充：以前我们的 app.use 参数是直接传入请求处理函数，上面的为什么传入一个方法调用呢？

其实上面的方法调用返回的结果就是我们需要的函数，这样写的好处就是我们可以在方法调用中传入参数，然后在方法内部使用，如下：

// 引入express框架
const express = require('express');
const bodyParser = require('body-parser');
// 创建网站服务器
const app = express();

app.use(fn ({a: 2}))

function fn (obj) {
    return function (req, res, next) {
        if (obj.a == 1) {
            console.log(req.url)
        }else {
            console.log(req.method)
        }
        next()
    }
}

app.get('/', (req, res) => {
    res.send('ok')
})

// 端口监听
app.listen(3000);

4 - Express路由参数

服务端这么写：

app.get('/find/:id', (req, res) => {
    console.log(req.params); // {id: 123}
});

客户端如下这么写，就不用写localhost:3000/find?id=123&name=lishi。

localhost:3000/find/123

比如：

// 引入express框架
const express = require('express');
const bodyParser = require('body-parser');
// 创建网站服务器
const app = express();

app.get('/index/:id/:name/:age', (req, res) => {
  // 接收get请求参数
    res.send(req.params) // {id: 123, name: 'zhangsan', age: 20}
})

// 端口监听
app.listen(3000);

客户端可以在浏览器中通过如下方式访问：

localhost:3000/index/123/zhangsan/20

注意：这是第二种传递和获取GET参数的方式，和上面的那种GET参数的获取方式等价，没有谁好谁不好。

5 - 静态资源的处理

通过Express内置的express.static可以方便地托管静态文件，例如img、CSS、JavaScript 文件等。

// 参数为静态资源的目录
app.use(express.static(path.join(__dirname, 'public')));

首先使用app.use拦截所有的请求，然后把静态资源的目录告诉express，express内部会判断当前请求是不是静态资源，如果是，直接返回静态资源，如果不是，往下走next()。

现在，使用如下方式就可以访问public目录下面的文件了。

http://localhost:3000/images/kitten.jpg
http://localhost:3000/css/style.css
http://localhost:3000/js/app.js
http://localhost:3000/images/bg.png
http://localhost:3000/hello.html

补充：我们也可以再传一个参数，指定虚拟路径。

// /static为虚拟路径
app.use('/static',express.static(path.join(__dirname, 'public')))

指定虚拟路径之后，我们访问静态资源就要加上虚拟路径了，如下：

http://localhost:3000/static/images/kitten.jpg
http://localhost:3000/static/css/style.css
http://localhost:3000/static/js/app.js
http://localhost:3000/static/images/bg.png
http://localhost:3000/static/hello.html

四. express-art-template模板引擎

1 - 模板引擎

为了使art-template模板引擎能够更好的和Express框架配合，模板引擎官方在原art-template模板引擎的基础上封装了express-art-template。使用 npm install art-template express-art-template 命令进行安装。

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

// 1.告诉express框架使用什么模板引擎渲染什么后缀的模板文件
//  参数1:模板后缀 参数2:使用的模板引擎
app.engine('art', require('express-art-template'))
// 2.告诉express框架模板存放的位置是什么  参数1:配置项的名字 参数2:路径
app.set('views', path.join(__dirname, 'views'))
// 3.告诉express框架模板的默认后缀是什么  参数1:配置项的名字 参数2:后缀
app.set('view engine', 'art');

app.get('/index', (req, res) => {
  // 前面我们使用res.end(html)方法将拼接好的字符串响应给客户端，现在我们使用render方法，更强大
  
    // render方法做了下面一些事
    // 1. 拼接模板路径
    // 2. 拼接模板后缀
    // 3. 哪一个模板和哪一个数据进行拼接
    // 4. 将拼接结果响应给了客户端
    // 参数1:模板名称 参数2:向模板中传递的数据
    res.render('index', {
        msg: 'message'
    })
});

app.get('/list', (req, res) => {
    res.render('list', {
        msg: 'list page'
    })
})

// 端口监听
app.listen(3000);

// 客户端访问：http://localhost:3000/index 或者 http://localhost:3000/list 即可拿到相应的数据。

2 - app.locals对象

将数据设置到app.locals对象下面，这个数据在所有的模板中都可以获取到，不需要添加到res.render的第二个参数中了。

app.js文件：

const express = require('express');
const path = require('path');
const app = express();
// 模板配置
app.engine('art', require('express-art-template'))
app.set('views', path.join(__dirname, 'views'))
app.set('view engine', 'art');

// 公共数据
app.locals.users = [{
    name: 'zhangsan',
    age: 20
},{
    name: '李四',
    age: 30
}]

app.get('/index', (req, res) => {
    res.render('index', {
        msg: '首页'
    })
});

app.get('/list', (req, res) => {
    res.render('list', {
        msg: '列表页'
    });
})

// 端口监听
app.listen(3000);

index.art模板：

{{ msg }}

<ul>
    {{each users}}
    <li>
        {{$value.name}}
        {{$value.age}}
    </li>
    {{/each}}
</ul>

list.art模板：

{{ msg }}

<ul>
    {{each users}}
    <li>
        {{$value.name}}
        {{$value.age}}
    </li>
    {{/each}}
</ul>

这时候客户端访问：http://localhost:3000/index 或者 http://localhost:3000/list 即可拿到公共数据了，不需要每次都添加到res.render的第二个参数中了。