当前位置：首页 > article >正文

jenkins+github+springboot自动部署

article 2024/12/2 6:45:24

背景：

最近看流水线有点意思，就说自己也搞一套。

预期效果：

idea提交代码后，GitHub接收，jenkins自动部署。【后续加个自动部署时的代码检查、单元测试、安全测试、sonarqube】

思路分析:

idea上的spring代码push到github,github接到信号push事件，用钩子webhook转发到jenkins，jenkins利用设置好的钩子接收到代码，做后续的操作【比如代码审查、功能测试、安全测试、压力测试、自动部署服务器等等】。

步骤：

1.开发spring程序。自处比较简单。

这里能调通测试接口就行。

值得注意的是，需要配置钩子接口【这里简单介绍下，钩子就是一个触发事件的工具，就像你用钩子把鱼勾过来，把衣服勾过来一样，把想要的东西用钩子拿过来，使你和事务联系起来】。接口是一个"webhook"的接口，后面配置github时会用到。

2.配置webhook接口：

代码如下：

package com.consumer.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;
import java.util.Base64;

@Slf4j
@RestController
@RequestMapping("/webhook")
public class WebHookController {

    private static final String SECRET = "12345"; // 在GitHub设置Webhook时填写的密钥
    private static final String HEADER_X_HUB_SIGNATURE_256 = "X-Hub-Signature-256";

    @PostMapping
    public ResponseEntity<String> receiveWebhook(
            @RequestHeader HttpHeaders headers,
            @RequestBody String payload) {
        log.info("come.");
        log.info("payload:{},headers:{}", payload, headers);
        // 验证签名
        boolean success = verifySignature(headers, payload);
        log.info("success:" + success);
//        if (!success) {
//            return new ResponseEntity<>("Invalid signature", HttpStatus.UNAUTHORIZED);
//        }
        log.info("payload" + payload);
        // 处理 Webhook 事件
        // 这里可以根据需要解析 payload 并执行相应的逻辑
        //....
        return new ResponseEntity<>("Webhook received", HttpStatus.OK);
    }

    private boolean verifySignature(HttpHeaders headers, String payload) {
        String headerValue = headers.getFirst(HEADER_X_HUB_SIGNATURE_256);
        log.info("headerValue:{}", headerValue);
        if (headerValue == null || !headerValue.startsWith("sha256=")) {
            return false;
        }
        String[] parts = headerValue.split("=", 2);
        if (parts.length != 2) {
            return false;
        }
        String signature = parts[1];
        log.info("signature:{}", signature);
        try {
            Mac mac = Mac.getInstance("HmacSHA256");
            SecretKeySpec keySpec = new SecretKeySpec(SECRET.getBytes(StandardCharsets.UTF_8), "HmacSHA256");
            mac.init(keySpec);
            byte[] hmacBytes = mac.doFinal(payload.getBytes(StandardCharsets.UTF_8));
            String calculatedSignature = "sha256=" + Base64.getEncoder().encodeToString(hmacBytes);
            log.info("calculatedSignature:{},headerValue:{}", calculatedSignature, headerValue);
            return calculatedSignature.equals(headerValue);
        } catch (Exception e) {
            log.error("Error verifying signature", e);
            return false;
        }
    }
}

上面屏蔽了验证，有个github配置钩子时信息的接收。

3.idea配置github: