TyX Core Framework 使用教程

TyX Core Framework 使用教程

1. 项目目录结构及介绍

TyX 是一个专为 AWS Lambda 设计的基于 TypeScript 的无服务器后端框架。下面展示的是基于提供的GitHub仓库基础之上的一般性项目结构和各部分简介：

.
├── api                     # 接口定义文件夹，存放服务的API接口规范。
│   ├── box.ts              # 示例：Box服务的API定义。
│   └── item.ts             # 示例：Item服务的API定义。
├── services                # 实现服务逻辑的文件夹。
│   ├── NoteService.ts      # 示例服务类，包含了REST操作。
│   └── ...                 # 其他服务类文件。
├── functions               # 函数处理相关，用于Lambda容器设置和导出。
│   ├── function.ts         # Lambda函数处理逻辑的入口文件。
│   └── local.ts            # 本地测试用的服务容器配置。
├── serverless.yml          # Serverless框架配置文件，定义云函数部署细节。
├── package.json            # 项目依赖和脚本配置。
├── tsconfig.json           # TypeScript编译配置文件，确保装饰器等正确工作。
└── ...

• api 目录存储了服务的接口定义，利用TypeScript接口保持服务的类型安全。
• services 包含实际的服务实现，每个.ts文件通常对应一个服务类。
• functions 提供Lambda的入口和Express容器配置，支持云端和本地运行模式。
• serverless.yml 是Serverless框架的核心配置文件，描述如何打包和部署到AWS Lambda。
• package.json 记录了项目依赖项和构建命令。
• tsconfig.json 配置TypeScript编译选项，包括对装饰器的支持。

2. 项目的启动文件介绍

在TyX项目中，有两个关键的启动文件需要关注：

function.ts

此文件是主要的 Lambda 函数处理逻辑所在，通过创建LambdaContainer实例并发布服务（如NoteService），它负责将服务绑定到Lambda的事件处理中。这里导出的handler函数是Lambda的入口点。

local.ts

当进行本地开发和测试时，这个文件变得重要。它使用ExpressContainer来模拟Lambda环境，使开发者可以在本地以HTTP服务的形式运行和调试服务逻辑，无需部署到云端。

3. 项目的配置文件介绍

serverless.yml

这是管理云函数配置的关键文件。它定义了AWS Lambda函数的多个方面：

• service: 定义服务名。
• provider: 指定云提供商信息，如AWS地区、运行时环境等。
• functions: 定义具体函数的配置，包括处理函数路径、触发事件类型（如HTTP）和其他特定设置如CORS。
• events: 细化每个功能对应的事件源，例如API Gateway请求路径与HTTP方法。

tsconfig.json

虽然这不是传统意义上的“启动”或“配置”文件，但它是TypeScript编译的重要配置，确保了项目能够正确处理装饰器（如@Service, @Get等）。需启用emitDecoratorMetadata和experimentalDecorators以兼容TyX的元数据需求。

综上所述，TyX项目通过精心组织的目录结构、明确的启动脚本以及细致的配置文件，为开发无服务器应用程序提供了清晰的路径和强大的功能支持。