简介
在开发中,偶尔会有一些关于Gitlab的二开需求,本文将介绍如果在Java中使用Gitlab提供的API
功能介绍
示例中代码,主要的功能如下:
- 读取整个仓库中的所有文件,读取后进行相关的处理
- 使用Webhook,接收gitlab的Webhook请求,进行代码push事件的监听处理
下面具体的示例代码
代码示例
依赖导入
在maven中导入gitlab api的仓库
<dependency>
<groupId>org.gitlab4j</groupId>
<artifactId>gitlab4j-api</artifactId>
<version>4.19.0</version>
</dependency>
配置相关参考
示例中使用的Spring boot,我们在配置文件中添加相关的gitlab配置信息
主要是服务地址和相关的认证信息等,如下
application:
gitlab:
# gitlab访问地址
host: http://127.0.0.1:81/
# gitlab 访问的token
accessToken: xxxxxxxxxxx
# 对应用户名
namespace: user
# 工程名称
projectName: testProject
# 工程对应的分支,用于区分环境
branch: test
下面是对应的配置类:
@Data
@Configuration
@ConfigurationProperties(prefix = "application.gitlab")
public class GitlabConfig {
private String host;
private String accessToken;
private String namespace;
private String projectName;
private String branch;
}
webhook回调接口
这里简单介绍下Webhook,其主要作用是:
- 当设置的仓库事件发生时(比如代码push,进行了一次提交)
- gitlab就会调用这个回调的接口,发送这次push相关的信息给你的服务
- 回调时里面有相关的提交信息,你可以根据相关的信息来处理
下面这个是回调的接口:
@RestController
@RequestMapping("/")
public class GitlabController {
// gitlab仓库push操作时的回调接口
@PostMapping("/event/push")
public RespResult<String> pushEvent(@RequestBody GitlabPushEvent gitlabPushEvent) {
gitlabService.pushEvent(gitlabPushEvent);
return RespResult.<