Ts.ED框架入门指南：从零开始构建TypeScript后端应用-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00062/article/details/148755959

Ts.ED框架入门指南：从零开始构建TypeScript后端应用

tsed :triangular_ruler: Ts.ED is a Node.js and TypeScript framework on top of Express to write your application with TypeScript (or ES6). It provides a lot of decorators and guideline to make your code more readable and less error-prone. ⭐️ Star to support our work! 项目地址: https://gitcode.com/gh_mirrors/ts/tsed

什么是Ts.ED框架

Ts.ED是一个基于TypeScript的企业级后端框架，构建在Express/Koa等流行Node.js框架之上。它采用装饰器语法和依赖注入等现代化开发模式，为开发者提供了一套完整的解决方案，特别适合构建中大型后端服务。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

Node.js版本至少为v20.11.0
包管理工具(npm/yarn/pnpm/bun)已安装
TypeScript基础了解(非必须但推荐)

项目初始化

Ts.ED提供了便捷的CLI工具来初始化项目，这是推荐的入门方式：

使用CLI创建项目

根据您使用的包管理器，选择以下命令之一：

# npm用户
npx -p @tsed/cli tsed init .

# yarn用户
yarn set version berry
yarn dlx -p @tsed/cli tsed init .

# pnpm用户
pnpm --package=@tsed/cli dlx tsed init .

# bun用户
bunx -p @tsed/cli init .

执行命令后，CLI会引导您完成项目配置，包括：

选择HTTP平台(Express/Koa)
项目结构风格(推荐Ts.ED标准结构)
是否集成Swagger API文档
测试框架选择(Jest等)
代码风格工具(ESLint + Prettier)

项目启动

初始化完成后，使用以下命令启动开发服务器：

# 根据您的包管理器选择
npm start
# 或
yarn start
# 或
pnpm start
# 或
bun start

成功启动后，您将看到类似如下的输出：

[2023-11-01T12:00:00.000] [INFO] [TSED] - Server started on http://0.0.0.0:8083
[2023-11-01T12:00:00.000] [INFO] [TSED] - Swagger UI is available on http://0.0.0.0:8083/api-docs

项目结构解析

通过CLI创建的标准Ts.ED项目包含以下核心目录和文件：

project-root/
├── src/                    # 源代码目录
│   ├── controllers/        # 控制器目录
│   ├── services/           # 服务层目录
│   └── Server.ts           # 应用入口文件
├── test/                   # 测试文件目录
├── .eslintrc               # ESLint配置
├── .prettierrc             # Prettier配置
├── package.json            # 项目配置
└── tsconfig.json           # TypeScript配置

依赖管理注意事项

当升级Ts.ED依赖时，必须保持所有@tsed/*包版本一致(除了@tsed/logger)。建议在package.json中固定版本号：

{
  "dependencies": {
    "@tsed/platform-http": "8.0.0",
    "@tsed/di": "8.0.0",
    "@tsed/core": "8.0.0",
    "@tsed/exceptions": "8.0.0",
    "@tsed/platform-express": "8.0.0",
    "@tsed/swagger": "8.0.0"
  }
}