Skip to content

快速开始 ​

本指南帮助您在 5 分钟内 完成后端服务 youlai-aspnet(.NET 10 / ASP.NET Core 10)的启动和验证。

前置条件 ​

必需环境:

环境版本要求下载地址
.NET SDK10.0.100+下载地址
MySQL5.7+ / 8.x安装教程
Redis7.x安装教程

开发工具(可选):

  • Visual Studio 2022(推荐)
  • Visual Studio Code + C# Dev Kit
  • JetBrains Rider

项目结构 ​

youlai-aspnet/
  sql/                      # 数据库脚本
   mysql/
      youlai_admin.sql  # 初始化脚本
  src/
   Youlai.Api/           # Web API 入口
     Controllers/       # 控制器(按模块)
       Auth/            # 认证模块
       Codegen/         # 代码生成模块
       File/            # 文件模块
       Message/         # SSE 实时通信
       System/          # 系统模块
     Middlewares/       # 中间件
     Security/          # 安全配置
     Swagger/           # Swagger 配置
     Program.cs         # 应用入口
     appsettings.json   # 生产环境配置
     appsettings.Development.json # 开发环境配置
   Youlai.Application/   # 应用层
     Auth/              # 认证服务
     Codegen/           # 代码生成服务
     Common/            # 公共组件
     File/              # 文件服务
     Security/          # 安全服务
     System/            # 系统服务
   Youlai.Domain/        # 领域层
     Entities/          # 实体模型
     Enums/             # 枚举
   Youlai.Infrastructure/# 基础设施层
     CodegenTemplates/  # 代码生成模板
     FileStorage/       # 文件存储实现
     Persistence/       # EF Core DbContext
  tests/                  # 测试项目
  youlai-aspnet.sln       # 解决方案文件
  global.json             # SDK 版本锁定

安装步骤 ​

数据库初始化 ​

执行数据库脚本:

bash
mysql -u root -p < sql/mysql/youlai_admin.sql

或通过数据库管理工具导入 sql/mysql/youlai_admin.sql。

配置修改 ​

修改 src/Youlai.Api/appsettings.Development.json:

数据库配置:

json
"Database": {
  "ConnectionString": "Server=localhost;Port=3306;Database=youlai_admin;User=root;Password=your_password;"
}

Redis配置:

json
"Redis": {
  "ConnectionString": "localhost:6379,password=,defaultDatabase=0"
}

JWT配置:

json
"Security": {
  "Session": {
    "Jwt": {
      "SecretKey": "your-secret-key-at-least-32-characters-long"
    }
  }
}

启动服务 ​

Visual Studio 方式:

打开 youlai-aspnet.sln,设置 Youlai.Api 为启动项目,按 F5 运行。

命令行方式:

bash
dotnet restore
dotnet run --project src/Youlai.Api

启动成功标志:

Now listening on: http://localhost:8000

快速验证 ​

接口文档 ​

访问 Swagger 文档:

http://localhost:8000/swagger

登录测试 ​

使用 Swagger 或 curl 测试登录接口:

bash
curl -X POST http://localhost:8000/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"123456","captchaId":"test","captchaCode":"1234"}'

成功响应:

json
{
  "code": "00000",
  "msg": "成功",
  "data": {
    "accessToken": "eyJhbGc...",
    "refreshToken": "eyJhbGc...",
    "tokenType": "Bearer",
    "expiresIn": 7200
  }
}

前端联调 ​

克隆前端项目 ​

bash
git clone https://gitee.com/youlaiorg/vue3-element-admin.git
cd vue3-element-admin

配置后端地址 ​

修改 .env.development:

dotenv
VITE_APP_API_URL=http://localhost:8000

启动前端 ​

bash
pnpm install
pnpm run dev

访问 http://localhost:3000,使用以下账号登录:

  • 用户名:admin
  • 密码:123456

常见问题 ​

端口冲突 ​

错误信息:Address already in use

解决方案:修改 Kestrel:Endpoints:Http:Url 在 appsettings.Development.json

数据库连接失败 ​

错误信息:Unable to connect to MySQL server

排查步骤:

  1. 确认 MySQL 服务已启动
  2. 检查数据库连接配置(地址、端口、用户名、密码)
  3. 确认数据库 youlai_admin 已创建

Redis 连接失败 ​

错误信息:It was not possible to connect to the redis server

排查步骤:

  1. 确认 Redis 服务已启动:redis-cli ping
  2. 检查 Redis 连接配置
  3. 如有密码,确认密码正确

下一步 ​

基于 MIT 许可发布 · 如需部署协助或二开定制,请查看 支持与合作