使用 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");
相关推荐
Y1nhl6 分钟前
Pyspark学习一:概述
数据库·人工智能·深度学习·学习·spark·pyspark·大数据技术
能来帮帮蒟蒻吗8 分钟前
Go语言学习(15)结构体标签与反射机制
开发语言·笔记·学习·golang
懒大王95278 分钟前
echarts+HTML 绘制3d地图,加载散点+散点点击事件
前端·html·echarts
陈皮话梅糖@2 小时前
使用 Provider 和 GetX 实现 Flutter 局部刷新的几个示例
开发语言·javascript·flutter
Aphelios3803 小时前
Java全栈面试宝典:线程机制与Spring IOC容器深度解析
java·开发语言·jvm·学习·rbac
日暮南城故里4 小时前
Java学习------源码解析之StringBuilder
java·开发语言·学习·源码
Yolo@~6 小时前
个人网站:基于html、css、js网页开发界面
javascript·css·html
斯~内克6 小时前
Electron 菜单系统深度解析:从基础到高级实践
前端·javascript·electron
安全方案6 小时前
精心整理-2024最新网络安全-信息安全全套资料(学习路线、教程笔记、工具软件、面试文档).zip
笔记·学习·web安全
士别三日&&当刮目相看6 小时前
JAVA学习*Object类
java·开发语言·学习