GitLab 配置 webhook

GitLab配置webhook全流程分享

原创于 2025-05-21 13:30:22 发布 · 1.5k 阅读

15 ·

CC 4.0 BY-SA版权

文章标签：

#gitlab #WebHook #Git #Java #后端

【Git】专栏收录该内容

4 篇文章

订阅专栏

前言：

GitLab 是一个开源的代码托管平台，相信大家都使用过它，它提供了许多功能，如版本控制、代码管理、issue跟踪、合并请求等，这些功能也是我们项目开发中使用的最多的功能，本篇我将分享一下 GitLab 的 webhook 功能。

背景：

公司技术总监提出一个管理层面的需求，想知道技术团队成员每天提交了多少代码，实现这个需求就需要依赖 GitLab 的数据统计功能了，我的团队接到总监的这个需求之后，我就开始了调研，简单调研后有三个方案，如下：

通过 GitLab API 获取数据。
通过访问 GitLab 数据库获取数据。
通过 GitLab webhook 获取数据。

以上三个方案理论上都是可行的，但是 GitLab 的运维部门不允许直接访问 GitLab 数据库，因此方案2直接被淘汰，方案一和方案三可行，本篇简单分享一下通过 GitLab webhook 来获取用户提交代码的相关数据。

GitLab webhook 是什么？

GitLab webhook 是 GitLab 提供的一种事件机制，用于将 GitLab 仓库中的事件如代码提交、合并请求、issue创建等实时通知到外部系统。以下是对其原理、作用和使用场景的简单介绍：

原理：

GitLab webhook 的原理非常简单，当 GitLab 仓库发生事件时，GitLab 会向预先配置好的 URL 发送 POST 请求，请求体中会包含事件的相关信息，对应 URL 的系统收到请求后，可以根据请求中的信息进行数据分析集成。

作用：

GitLab webhook 可以非常方便地实现各种功能，例如代码统计、代码审核、持续集成等。

使用场景：

代码统计：使用 webhook 功能可以统计代码提交量、代码提交时间、代码提交人等信息，实现代码统计功能。
代码审核：使用 webhook 功能可以实现代码审核功能，例如代码提交后，可以自动触发代码审核，并通知审核人进行审核，代码合并也是一样。
持续集成：使用 webhook 可以实现持续集成功能，例如代码提交后，可以自动触发构建任务。

如何配置 GitLab webhook

在左侧菜单中选择“Settings” -> “Integrations”，点击“Add webhook” 按钮，就可以完成 webhook 的创建，截图如下：

在这里插入图片描述

webhook 的创建可以分项目和全局，因为我不是 GitLab 的管理员，所以只有项目级别的 webhook的配置权限。

应用完成 webhook 请求的接收

我们只需要在应用代码中暴露一个接口，用来接收 webhook 请求，然后解析请求体中的信息，并进行数据分析处理即可(注意应用的鉴权处理)，代码如下：

@PostMapping("/web-hook/git-lab")
public void handleGitLabPushEvent(@RequestBody Map<String, Object> payload,
								  @RequestHeader("X-Gitlab-Token") String token) {
	String json = payload.toString();
	try {
		//业务处理分析
		String objectKind = (String) payload.get("object_kind");

	} catch (Exception e) {

	}
}