使用 typescript + express 创建 NodeJs 后端服务

使用 typescript + express 创建 NodeJs 后端服务

初始化 NodeJs 程序

bash 复制代码
npm init -y

安装依赖

bash 复制代码
pnpm add express
pnpm add ts-node nodemon @types/node @types/express -D

配置 nodemon

在根目录创建nodemon.json来配置 nodemon:

json 复制代码
{
  "watch": ["./"],
  "ext": ".ts,",
  "exec": "ts-node app.ts"
}

配置启动脚本

package.json 中配置启动脚本:

json 复制代码
{
  // /
  "scripts": {
    "dev": "nodemon"
  }
  ///
}

由此,一个 typescript 版本的 NodeJs 工程就搭建好了。然后就开始安装 express 等依赖,来写业务代码了。

错误处理

根据官方文档的描述,express 是自带错误处理的逻辑的。当然如果 express 的错误处理逻辑不满足我们的业务规范,我们可以通过自定义 errorHandler 来统一处理错误,比如:

ts 复制代码
export const errorHandler: ErrorRequestHandler = function (
  err,
  req,
  res,
  next
) {
  try {
    res.status(500).send({ err: err.stack });
  } catch (error) {
    res.status(500).send(err);
  }
};

app.use(errorHandler);

**注意:**这里需要注意,我们自定义的错误处理 handler 需要放在其他的中间件和路由后面(You define error-handling middleware last, after other app.use() and routes calls;)

404 处理

编写 404 处理 handler 并且在其他的路由后面 use:

ts 复制代码
export const notFoundHandler: Router = Router().use((req, res) => {
  res.status(404).sendFile(resolve(__dirname, "../../public/404.html"));
});

app.use(mainHandler);
app.use(authHandler);
app.use("/api/auth", authRouter);
app.use("/api/user", userRouter);
app.use("/api", indexRouter);
// *
// *
// *
// *
app.use("*", notFoundHandler);
app.use(errorHandler);

问题记录

使用 express-async-errors 处理异步错误

描述:如果我们用 async 和 await 去拦截代码错误,需要使用 try catch 去拦截错误,每个接口都这样去做太麻烦了,因此使用 express 本身的错误处理加上第三方库 express-async-errors 来处理:

使用文档:官方文档, CSDN

ts 复制代码
// app.ts
require("express-async-errors");
相关推荐
智能化咨询7 分钟前
【Linux】【实战向】Linux 进程替换避坑指南:从理解 bash 阻塞等待,到亲手实现能执行 ls/cd 的 Shell
前端·chrome
Anson Jiang10 分钟前
浏览器标签页管理:使用chrome.tabs API实现新建、切换、抓取内容——Chrome插件开发从入门到精通系列教程06
开发语言·前端·javascript·chrome·ecmascript·chrome devtools·chrome插件
掘金安东尼13 分钟前
黑客劫持:周下载量超20+亿的NPM包被攻击
前端·javascript·面试
剑亦未配妥1 小时前
移动端触摸事件与鼠标事件的触发机制详解
前端·javascript
Hello_Embed7 小时前
STM32HAL 快速入门(二十):UART 中断改进 —— 环形缓冲区解决数据丢失
笔记·stm32·单片机·学习·嵌入式软件
咸甜适中7 小时前
rust语言 (1.88) 学习笔记:客户端和服务器端同在一个项目中
笔记·学习·rust
人工智能训练师7 小时前
Ubuntu22.04如何安装新版本的Node.js和npm
linux·运维·前端·人工智能·ubuntu·npm·node.js
Seveny077 小时前
pnpm相对于npm,yarn的优势
前端·npm·node.js
Magnetic_h8 小时前
【iOS】设计模式复习
笔记·学习·ios·设计模式·objective-c·cocoa
yddddddy8 小时前
css的基本知识
前端·css