Express 的基本使用 + nodemon

邓季

2023-12-01

学习目标

◆ 能够使用 express.static() 快速托管静态资源

◆ 能够使用 express 路由精简项目结构

◆ 能够使用常见的 express 中间件

◆ 能够使用 express 创建 API 接口

◆ 能够在 express 中启用 cors 跨域资源共享

一、初识 express

express 简介

官方给出的概念：Express 是基于 Node.js 平台，快速、开放、极简的 Web 开发框架官网
通俗的理解：Express 的作用和 Node.js 内置的 http 模块类似，是专门用来创建 Web 服务器的
Express 的本质：就是一个 npm 上的第三方包，提供了快速创建 Web 服务器的便捷方法
使用 Express，我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器

1. Express 的基本使用

① 安装
在项目所处的目录中，运行如下的终端命令，即可将 express 安装到项目中使用

npm i express

② 创建基本的 Web 服务器

// 1.导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()

// 3. 调用 app.listen(端口号, 启动后的回调函数), 启动服务器
app.listen(3000, () => {
  console.log('running……')
})

2. 监听 GET 和 POST 请求，并影响客户端

监听 get 请求
通过 app.get() 方法，可以监听客户端的 get 请求

// 参数1 客户端请求的 URL 地址
// 参数2 请求对应的处理函数
// req 请求对象 包含了与请求相关的属性和方法
// res 响应对象 包含了与响应相关的属性和方法
app.get('请求URL', function(req, res){处理函数})

监听 post 请求
通过 app.get() 方法，可以监听客户端的 get 请求

// 参数1 客户端请求的 URL 地址
// 参数2 请求对应的处理函数
// req 请求对象 包含了与请求相关的属性和方法
// res 响应对象 包含了与响应相关的属性和方法
app.post('请求URL', function(req, res){处理函数})

把内容响应给客户端
通过 res.send() 方法，可以把处理好的内容，发送给客户端

app.get('/user',(req, res)=>{
	// 向客户端发送 JSON 对象
	res.send({name: 'zs', age: 20, gender: '男'})
})

app.post('/user', (req, res)=>{
	// 向客户端发送文本内容
	res.send('请求成功')
})

完整代码

// 1.导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()

// 4. 监听客户端的 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('请求成功')
})

// 3. 调用 app.listen(端口号, 启动后的回调函数), 启动服务器
app.listen(3000, () => {
  console.log('running……')
})

3. 获取 URL 中携带的查询参数

通过 req.query 对象，可以访问到客户端通过查询字符串的形式，发送到服务器的参数

app.get('/', (req,res)=>{
	// req.query 默认是一个空对象
	// 客户端使用 ?name=zs&age=20 这种查询字符串形式，发送到服务器
	// 可以通过 req.query 对象访问到，例如
	// req.query.name req.query.age
	console.log(req.query)
})

完整代码

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

app.get('/', (req, res) => {
  // 通过 req.query 可以获取到客户端发送过来的，查询参数
  // 注意：默认情况下， req.query 是一个空对象
  console.log(req.query)
  res.send(req.query)
})

app.listen(3000, () => {
  console.log('running……')
})

4. 获取 URL 中的动态参数

通过 req.params 对象，可以访问到 URL 中，通过 : 匹配到的动态参数

// URL 地址中，可以通过：参数名的形式，匹配动态参数值
app.get('/user/:id', (req, res)=>{
	// req.params 默认是一个空对象
	// 里面存放着通过 : 动态匹配到的参数值
	console.log(req.params)
})

补充知识点

/:id – id 值不是固定的，可以自己定义，例如： /:ids
展示到页面中的 id 键，是自定义的变量值
参数可以有多个，例如： /:ids/:name

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

// 注意：这里的 :id 是一个动态的参数
app.get('/user/:id', (req, res) => {
  // req.params 是动态匹配到的 URL 参数，默认也会是一个空对象
  console.log(req.params)
  res.send(req.params)
})

app.listen(3000, () => {
  console.log('running……')
})

5. 托管静态资源

express.static()

1. express 提供了一个非常好用的函数，叫做 express.static()，通过它，我们可以非常方便地创建一个静态资源服务器

例如，通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了

app.use(express.static('piblic'))

2. 注意：Express 在指定的静态目录中查找文件，并对外提供资源的访问路径。因此，存放静态文件的目录名不会出现在 URL 中

3. 完整代码

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

// 在这里，调用 express.static() 方法，快速的对外提供静态资源
app.use(express.static('public'))

app.listen(3000, () => {
  console.log('running……')
})

托管多个静态资源目录

如果要托管多个静态资源目录，请多次调用 express.static() 函数，访问静态资源文件时，express.static() 函数会根据目录的添加顺序查找所需的文件

app.use(express.static('piblic'))
app.use(express.static('files'))

完整代码

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

// 在这里，调用 express.static() 方法，快速的对外提供静态资源
app.use(express.static('public'))
app.use(express.static('static'))

app.listen(3000, () => {
  console.log('running……')
})

挂载路径前缀

如果希望在托管的静态资源访问路径之前，挂载路径前缀，则可以使用如下的方式

app.use('/public', express.static('piblic'))

完整代码

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

// 在这里，调用 express.static() 方法，快速的对外提供静态资源
app.use('/static', express.static('public'))

app.listen(3000, () => {
  console.log('running……')
})

二、安装 nodemon

1. 为什么要使用 `nodemon

在编写调试 Node.js 项目的时候，如果修改了项目的代码，则需要频繁的手动 close 掉，然后再重新启动，非常繁琐。现在，我们可以使用 [nodemon] 这个工具，它能够监听项目文件的变动，当代码被修改后，nodemon 会自动帮我们重启项目，极大方便了开发和调试

2. 安装 nodemon

npm i nodemon -g

3. 使用 nodemon 实现后台项目的重启

当基于 Node.js 编写了一个网站应用的时候，传统的方式，是运行 node app.js 命令，来启动项目
这样做的坏处是：代码被修改之后，需要手动重启项目
将 node 命令替换为 nodemon 命令，使用 nodemon app.js 来启动项目
这样做的好处是：代码被修改之后，会被 nodemon 监听到，从而实现自动重启项目的效果

// 使用 node 运行项目
node app.js

// 使用 nodemon 运行项目
nodemon index.js