Skip to content

快速开始

本指南帮助您在 5 分钟内 完成后端服务 youlai-gin(Go/Gin)的启动和验证。

前置条件

必需环境

环境版本要求下载地址
Go1.21+Go官网
MySQL5.7+ / 8.x安装教程
Redis7.x安装教程

开发工具(可选)

  • GoLand(推荐)
  • Visual Studio Code + Go 插件

项目结构

youlai-gin/
├── configs/                  # 配置文件
│   ├── dev.yaml              # 开发环境配置
│   └── prod.yaml             # 生产环境配置
├── internal/                 # 核心业务源码
├── pkg/                      # 公共组件
├── sql/                      # 数据库脚本
│   └── mysql/
│       └── youlai_admin.sql  # 初始化脚本
├── go.mod                    # Go 模块定义
└── main.go                   # 入口文件

安装步骤

数据库初始化

执行数据库脚本:

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

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

配置修改

修改 configs/dev.yaml

数据库配置

yaml
database:
  host: localhost
  port: 3306
  database: youlai_admin
  username: root
  password: your_password

Redis配置

yaml
redis:
  host: localhost
  port: 6379
  password: ""
  database: 0

JWT配置

yaml
jwt:
  secret: your-secret-key-at-least-32-characters-long
  expire: 7200

启动服务

bash
go mod download
go run main.go

启动成功标志:

[GIN-debug] Listening and serving HTTP on :8000

快速验证

接口文档

访问 Swagger 文档:

http://localhost:8000/swagger/index.html

登录测试

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

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

成功响应:

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

env
VITE_APP_API_URL=http://localhost:8000

启动前端

bash
pnpm install
pnpm run dev

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

  • 用户名:admin
  • 密码:123456

常见问题

端口冲突

解决方案:修改 configs/dev.yaml 中的 server.port

数据库连接失败

排查步骤

  1. 确认 MySQL 服务已启动
  2. 检查数据库连接配置
  3. 确认数据库 youlai_admin 已创建

Redis 连接失败

排查步骤

  1. 确认 Redis 服务已启动:redis-cli ping
  2. 检查 Redis 连接配置

下一步

基于 MIT 许可发布