Prexis

什么是 Prexis?

为什么选择 Prexis?

与原生 Express 对比

与其他框架对比

核心优势

1. 零配置启动

pnpm install && pnpm dev

2. 模块化架构

src/modules/users/
├── dtos/ # 数据传输对象
├── services/ # 业务逻辑
├── controllers/ # 请求处理
└── routes/ # 路由定义

3. CLI 脚手架

pnpm gen product # 自动创建 product 模块全部文件

4. 生产级可靠性

5. 高性能

适用场景

核心特性

开发体验

API 能力

企业级功能

部署运维

测试覆盖

技术栈

性能基准

快速开始

环境要求

安装与运行

# 克隆项目
git clone https://github.com/fwx5618177/prexis.git
cd prexis
# 安装依赖
pnpm install
# 配置环境变量
cp .env.example .env
# 启动开发服务器
pnpm dev

项目结构

prexis/
├── src/
│ ├── app.ts # Express 应用配置
│ ├── server.ts # 服务入口
│ ├── routes.ts # 路由注册
│ ├── config/ # 配置管理
│ ├── exceptions/ # 自定义异常
│ ├── middlewares/ # 中间件
│ │ ├── auth.middleware.ts # JWT 认证
│ │ ├── cors.middlewares.ts # CORS 配置
│ │ ├── csrf.middleware.ts # CSRF 防护
│ │ ├── error.middleware.ts # 错误处理
│ │ ├── rateLimit.middleware.ts # 速率限制
│ │ ├── requestId.middleware.ts # 请求 ID
│ │ ├── telemetry.middleware.ts # 链路追踪
│ │ └── validation.middleware.ts # 参数验证
│ ├── modules/ # 业务模块
│ │ ├── auth/ # 认证模块
│ │ ├── users/ # 用户模块
│ │ ├── health/ # 健康检查
│ │ ├── graphql/ # GraphQL 模块
│ │ ├── websocket/ # WebSocket 模块
│ │ └── worker/ # Worker 线程模块
│ ├── services/ # 公共服务
│ │ ├── circuit-breaker.service.ts # 熔断器
│ │ ├── http2.service.ts # HTTP/2 支持
│ │ ├── performance.service.ts # 性能优化
│ │ ├── redis.service.ts # Redis 客户端
│ │ └── worker.service.ts # Worker 线程池
│ ├── shared/ # 共享工具
│ ├── types/ # TypeScript 类型定义
│ └── utils/ # 工具函数
├── cli/ # CLI 代码生成工具
├── prisma/ # Prisma 数据库配置
├── tests/ # 测试用例
├── http/ # HTTP 测试文件
├── docs/ # 文档
└── benchmark/ # 性能测试脚本

常用命令

开发

pnpm dev # 启动开发服务器(热重载)
pnpm build # 构建生产版本
pnpm start # 启动生产服务
pnpm start:cluster # PM2 集群模式启动

测试

pnpm test # 运行测试
pnpm test:watch # 监听模式测试
pnpm test:coverage # 生成覆盖率报告

代码质量

pnpm lint # ESLint 检查
pnpm lint:fix # 自动修复
pnpm format # Prettier 格式化
pnpm typecheck # TypeScript 类型检查

数据库

pnpm prisma:generate # 生成 Prisma 客户端
pnpm prisma:migrate # 执行数据库迁移

CLI 工具

生成模块

# 生成完整模块(包含 dto、service、controller、route)
pnpm gen <模块名>
# 示例
pnpm gen product # 创建 src/modules/product/
pnpm gen user-profile # 创建 src/modules/user-profile/
pnpm gen order-item # 创建 src/modules/order-item/

src/modules/<模块名>/
├── index.ts
├── dtos/
│ └── <模块名>.dto.ts
├── services/
│ └── <模块名>.service.ts
├── controllers/
│ └── <模块名>.controller.ts
└── routes/
 └── <模块名>.route.ts

选项参数

pnpm gen product --no-dto # 不生成 DTO
pnpm gen product --no-service # 不生成 Service
pnpm gen product --no-controller # 不生成 Controller
pnpm gen product --no-route # 不生成 Route

其他命令

pnpm cli:list # 列出所有现有模块
pnpm clean:examples # 清理示例模块
pnpm clean:examples -y # 跳过确认直接清理

注册路由

import { ProductRoute } from '@modules/product'
const routes: Routes[] = [
 // ... 其他路由
 new ProductRoute(),
]

API 端点

Docker 部署

开发环境

docker compose --profile dev up

生产环境

docker compose --profile prod up -d

Kubernetes 部署

基础部署

kubectl apply -f k8s.yaml

蓝绿部署

# 1. 部署新版本(绿色环境)
kubectl set image deployment/prexis-green prexis=prexis:v2.0.0
# 2. 验证新版本
kubectl rollout status deployment/prexis-green
# 3. 切换流量到新版本
kubectl patch service prexis -p '{"spec":{"selector":{"version":"green"}}}'
# 4. 回滚(如有问题)
kubectl patch service prexis -p '{"spec":{"selector":{"version":"blue"}}}'

金丝雀发布

# 1. 部署金丝雀版本(默认 replicas: 0)
kubectl scale deployment/prexis-canary --replicas=1
# 2. 金丝雀接收约 10% 流量(1/10 pods)
# 主 Deployment 9 个副本 + 金丝雀 1 个副本
# 3. 监控金丝雀指标
kubectl logs -l version=canary --tail=100
# 4. 逐步扩大金丝雀比例
kubectl scale deployment/prexis-canary --replicas=3
kubectl scale deployment/prexis --replicas=7
# 5. 全量发布
kubectl set image deployment/prexis prexis=prexis:v2.0.0
kubectl scale deployment/prexis-canary --replicas=0

自动扩缩容

# 查看 HPA 状态
kubectl get hpa prexis-hpa
# 手动调整副本数范围
kubectl patch hpa prexis-hpa -p '{"spec":{"minReplicas":3,"maxReplicas":20}}'

贡献指南

许可证