GitHub Actions + Spring Boot 实战：自动化部署的核心配置与避坑指南

最新推荐文章于 2025-12-05 14:41:23 发布

原创最新推荐文章于 2025-12-05 14:41:23 发布 · 266 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#github #spring boot #自动化

GitHub Actions 与 Spring Boot 自动化部署实战

核心配置步骤

1. 创建基础工作流文件
在项目根目录创建 .github/workflows/deploy.yml，定义触发条件（如 push 到 main 分支）：

name: Deploy Spring Boot App
on:
  push:
    branches: [ "main" ]

2. 配置 Java 环境与构建
使用 actions/setup-java 设置 JDK 版本，添加 Maven 构建步骤：

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'
      - name: Build with Maven
        run: mvn -B package --file pom.xml

3. 部署到服务器（SSH 方式示例）
通过 appleboy/scp-action 和 appleboy/ssh-action 实现文件传输与远程命令执行：

- name: Copy files via SCP
  uses: appleboy/scp-action@v0.1.3
  with:
    host: ${{ secrets.SERVER_IP }}
    username: ${{ secrets.SSH_USER }}
    key: ${{ secrets.SSH_KEY }}
    source: "target/*.jar"
    target: "/home/user/app/"
- name: Restart server
  uses: appleboy/ssh-action@v0.1.4
  with:
    host: ${{ secrets.SERVER_IP }}
    username: ${{ secrets.SSH_USER }}
    key: ${{ secrets.SSH_KEY }}
    script: |
      sudo systemctl restart your-service.service

关键避坑点

1. 敏感信息保护
所有服务器凭据必须存储在 GitHub Secrets 中，切勿硬编码在 YAML 文件里。通过 ${{ secrets.XXX }} 引用。

2. 构建缓存优化
添加依赖缓存步骤提升构建速度：

- name: Cache Maven packages
  uses: actions/cache@v3
  with:
    path: ~/.m2
    key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
    restore-keys: ${{ runner.os }}-m2

3. 跨平台兼容性
若需支持多平台构建，明确指定 runs-on 矩阵：

jobs:
  build:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}

4. 健康检查延迟
部署后添加延迟等待应用启动完成：

- name: Verify deployment
  run: |
    sleep 30
    curl -sSf http://localhost:8080/actuator/health

高级技巧

1. 多阶段部署
通过 needs 关键字实现构建、测试、部署的流水线分离：

jobs:
  build:
    # 构建步骤
  deploy:
    needs: build
    # 部署步骤

2. 自定义 Docker 部署
结合 Docker 构建镜像并推送到仓库：

- name: Build and push Docker image
  uses: docker/build-push-action@v4
  with:
    push: true
    tags: user/app:latest
    secrets: |
      {"username":${{ secrets.DOCKER_USER }}, "password":${{ secrets.DOCKER_PASS }}}

3. 通知机制
添加 Slack 或邮件通知步骤：

- name: Slack notification
  uses: slackapi/slack-github-action@v1.23.0
  with:
    slack-message: "Deployment succeeded"

通过以上配置，可实现从代码提交到生产环境部署的全流程自动化，同时避免常见的安全性和稳定性问题。