Java 调用 GitLabAPI 获取仓库里的文件件提交记录-Toy模板网

这篇具有很好参考价值的文章主要介绍了Java 调用 GitLabAPI 获取仓库里的文件件提交记录。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

1. 需求

项目组需要做统计，获取每个开发人员的代码提交次数，提交时间，提交人等等，因代码在GitLab上管理，所以需要调用GitLabAPI来获取。

2. 开发

API官网：https://docs.gitlab.com/ee/api/

2.1 创建自定义令牌

自定义令牌是为了后续接口访问有权限而建立的。
创建 GitLab 个人访问令牌的方法如下：

在任何页面的右上角，单击您的个人资料照片，然后单击 “Settings（设置）”。
在左侧边栏中，单击 “Developer settings（开发者设置）”。
在左侧边栏中，单击 “Personal access tokens（个人访问令牌）”。
单击 “Generate new token（生成新令牌）”。
给令牌一个描述性名称。
选择要授予此令牌的作用域或权限。
要使用令牌从命令行访问仓库，请选择 “repo（仓库）”。
单击 “Generate token（生成令牌）”。
单击 “将令牌复制到剪贴板”。

请注意，离开此页面后，您将无法再次看到令牌，所以一定要保留好令牌。像对待密码一样对待您的令牌，确保其机密性。

2.2 找项目ID

第一步需要找项目的ID，这个不知道怎么找，我的方法是在gitlab项目上打开F12看控制台，看他们的接口访问的适合用的ID。
如图：110 就是项目ID，拿着项目ID能办很多事儿。
Java 调用 GitLabAPI 获取仓库里的文件件提交记录,java,java,python,运维,gitlab

2.3 调接口

直接上代码了：

@Slf4j
@Service
public class GitLabApiCallService {

    @Resource(name = "initRestTemplate")
    private RestTemplate restTemplate;

    /**
     * 获取 项目下的文件 下的文件
     * @return
     */
    public JSONArray getTree(Integer page) throws Exception{
        String gitLabToken = ModelConfig.getGitLabToken();
        String gitLabApiUrl = ModelConfig.getGitLabApiUrl();
        String projectId = "110";
        String directoryPath = "aaaaa";
        String baseUrl = String.format("%s/projects/%s/repository/tree?ref=master&path=%s&per_page=100&page="+page,
                gitLabApiUrl,projectId,directoryPath);
        // 设置请求头
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
        headers.set("Private-Token",gitLabToken);
        HttpEntity<Map<String, String>> requestEntity = new HttpEntity<>(null, headers);
        // 执行
        log.debug("url：{} , requestEntity: {} ", baseUrl, requestEntity);
        ResponseEntity<String> response = restTemplate.exchange(baseUrl, HttpMethod.GET, requestEntity, String.class);
        // 处理返回值
        if (response.getStatusCode() == HttpStatus.OK) {
            log.info("GET request successful");
            String body = response.getBody();
            if(StrUtil.isNotBlank(body)){
                JSONArray jsonArray = JSONArray.parseArray(body);
                log.debug("结果：{}",jsonArray);
                return jsonArray;
            } else {
                return null;
            }
        } else {
            log.error(" GET request failed");
            return null;
        }
    }

    /**
     * 查看提交记录
     * @return
     */
    public JSONArray getCommit(String filePath)  throws Exception {
        String gitLabToken = ModelConfig.getGitLabToken();
        String gitLabApiUrl = ModelConfig.getGitLabApiUrl();
        String projectId = "110";
        String directoryPath = "aaaa";
        Integer per_page = 201000;
        String baseUrl = String.format("%s/projects/%s/repository/commits?ref_name=master&path=%s",
                gitLabApiUrl,projectId,filePath);
        // 设置请求头
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
        headers.set("Private-Token",gitLabToken);

        // 绑定请求头
        HttpEntity<String> requestEntity = new HttpEntity<>(null, headers);

        // 执行
        log.debug("url：{} , requestEntity: {} ", baseUrl, requestEntity);
        ResponseEntity<String> response = restTemplate.exchange(baseUrl, HttpMethod.GET, requestEntity, String.class);
        // 处理返回值
        if (response.getStatusCode() == HttpStatus.OK) {
            log.info("GET request successful");
            String body = response.getBody();
            if(StrUtil.isNotBlank(body)){
                JSONArray jsonArray = JSONArray.parseArray(body);
                log.debug("结果：{}",jsonArray);
                return jsonArray;
            } else {
                return null;
            }
        } else {
            log.error("GET request failed");
            return null;
        }
    }
}