使用 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");
相关推荐
烛阴1 分钟前
Babel 完全上手指南:从零开始解锁现代 JavaScript 开发的超能力!
前端·javascript
AntBlack19 分钟前
拖了五个月 ,不当韭菜体验版算是正式发布了
前端·后端·python
315356691322 分钟前
一个简单的脚本,让pdf开启夜间模式
前端·后端
大苏打seven27 分钟前
Docker学习笔记:Docker网络
笔记·学习·docker
尘心cx27 分钟前
前端-CSS-day1
前端·css
知否技术34 分钟前
前端常说的 SCSS是个啥玩意?一篇文章给你讲的明明白白!
前端·scss
CN-Dust39 分钟前
[FMZ][JS]第一个回测程序--让时间轴跑起来
javascript
幼儿园技术家1 小时前
Uniapp简易使用canvas绘制分享海报
前端
开开心心就好1 小时前
免费PDF处理软件,支持多种操作
运维·服务器·前端·spring boot·智能手机·pdf·电脑
全宝2 小时前
🎨前端实现文字渐变的三种方式
前端·javascript·css