Skip to content

后端快速开始

本文档将指导你快速搭建和运行 youlai-boot 后端项目。

前置条件

在开始之前,请确保你的开发环境满足以下要求:

软件版本要求下载地址
JDK17+Oracle JDK
Maven3.6+Maven
MySQL8.0+MySQL
Redis7.0+Redis
IDEA2023+IntelliJ IDEA

第一步:克隆项目

bash
git clone https://gitee.com/youlaiorg/youlai-boot.git
cd youlai-boot
bash
git clone https://github.com/haoxianrui/youlai-boot.git
cd youlai-boot

第二步:数据库配置

导入SQL脚本

执行 youlai.sql 脚本完成数据库创建、表结构和基础数据的初始化。

提示

  • youlai.sql 脚本已包含创建数据库的语句,直接执行即可
  • 可以使用 Navicat、DBeaver、MySQL Workbench 等工具导入 SQL 文件
  • 脚本包含管理员账号、菜单、角色等基础数据

验证数据

导入成功后,应该包含以下核心表:

  • sys_user - 用户表
  • sys_role - 角色表
  • sys_menu - 菜单表
  • sys_dept - 部门表
  • sys_dict - 字典表
  • sys_user_role - 用户角色关联表
  • sys_role_menu - 角色菜单关联表

第三步:配置文件

修改 src/main/resources/application-dev.yml

yaml
spring:
  # 数据源配置
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/youlai?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false&allowPublicKeyRetrieval=true&rewriteBatchedStatements=true
    username: root           # 修改为你的数据库用户名
    password: 123456         # 修改为你的数据库密码

  # Redis 配置
  data:
    redis:
      host: localhost        # Redis 地址
      port: 6379             # Redis 端口
      password:              # Redis 密码(如果有)
      database: 0
      timeout: 10s
      lettuce:
        pool:
          max-active: 200
          max-wait: -1ms
          max-idle: 10
          min-idle: 0

# JWT 配置
jwt:
  # 密钥(建议修改为自己的)
  secret: youlai123456youlai123456youlai123456
  # 过期时间(单位:秒),默认 2 小时
  expiration: 7200

第四步:启动项目

执行 YoulaiBootApplication.java 的 main 方法完成后端项目启动。

启动方式

  1. 使用 IDEA 打开项目
  2. 等待 Maven 依赖下载完成
  3. 找到启动类 YoulaiBootApplication.java
  4. 右键点击 -> Run 'YoulaiBootApplication.main()'

第五步:验证启动

访问接口文档地址 http://localhost:8080/doc.html 验证项目启动是否成功。

启动成功后,你应该能看到 Knife4j 接口文档页面。

接口文档

项目支持两种接口文档访问方式:

测试登录接口

在接口文档中测试登录:

  1. 找到 认证管理 -> 登录接口
  2. 点击 调试
  3. 输入参数:
    json
    {
      "username": "admin",
      "password": "123456"
    }
  4. 点击 发送
  5. 返回结果包含 accessToken 表示成功

常见问题

1. 数据库连接失败

错误信息

com.mysql.cj.jdbc.exceptions.CommunicationsException: Communications link failure

解决方案

  • 检查 MySQL 服务是否启动
  • 检查数据库地址、端口是否正确
  • 检查用户名、密码是否正确
  • 检查防火墙是否阻止连接

2. Redis 连接失败

错误信息

Unable to connect to Redis

解决方案

  • 检查 Redis 服务是否启动
  • 检查 Redis 地址、端口是否正确
  • 如果设置了密码,检查密码是否配置
  • Windows 用户可以下载 Redis for Windows

3. 端口被占用

错误信息

Port 8989 was already in use

解决方案

  • 修改配置文件中的端口号
  • 或者停止占用该端口的程序
yaml
server:
  port: 8990  # 修改为其他端口

4. Maven 依赖下载慢

解决方案: 配置阿里云 Maven 镜像,修改 settings.xml

xml
<mirrors>
  <mirror>
    <id>aliyunmaven</id>
    <mirrorOf>*</mirrorOf>
    <name>阿里云公共仓库</name>
    <url>https://maven.aliyun.com/repository/public</url>
  </mirror>
</mirrors>

5. JDK 版本不匹配

错误信息

Unsupported class file major version

解决方案

  • 确保使用 JDK 17 或更高版本
  • 在 IDEA 中检查项目 SDK 配置

下一步

恭喜!你已经成功启动了后端项目。接下来你可以:

技术支持

如果遇到问题,可以通过以下方式获取帮助:

基于 MIT 许可发布