JGit获取当前分支的所有提交请求

淩亂°似流年 2022-10-23 15:24 558阅读 0赞

## 一、引言 ##

最近在写一个有关于JGit的工程（代码覆盖率），在使用JGit过程中发现这个工具挺好用，特做此笔记记录一些自己用到的一些方法。

## 二、代码部分 ##

#### 功能： 需要获取当前分支的所有commit记录 ####

###### 1. TestDemo代码块 ######

public class TestMain { 
        public static String remotePath = "https://github.com/******.git";  	//远程库路径 
        public static String localPath = "/Users/bigman/software/local";			//下载已有仓库到本地路径
        public static String branchName = "master";   //分支名
        public static String projectName = "FirstGithub";  //项目名
        public static void main(String[] args) throws GitAPIException, IOException { 
            String filePath = TestMain.localPath+"/"+TestMain.projectName;
            // 初始化adapter
            GitAdapter gitAdapter = new GitAdapter(TestMain.remotePath,filePath,TestMain.branchName);
            List<CommitMessage> commitMessages = gitAdapter.getCommitMessages();
            int i=1;
            System.out.println("=========================================================================================");
    
            for(CommitMessage commitMessage : commitMessages) { 
                System.out.println(i+" "+commitMessage.toString());
                i++;
            }
        }
    }

###### 2. commitMessage 代码块 ######

@Data
    @ToString
    public class CommitMessage { 
        private String commitId;
        private String commitIdent;
        private String commitMessage;
        private String commitDate;
        //如果只需要获取merge的提交记录时，使用以下两个字段记录merge的来源
        private String lastCommitId; // <自己的上一次commitId>合并时的上一次commitId
        private String mergeBranchCommitId;  // 合并分支的commitId
    }

###### 3. GitAdapter 工具类 ######

public class GitAdapter { 		
    	private static final Logger logger = LoggerFactory.getLogger(GitAdapter.class);
    
        private final static String REF_HEADS = "refs/heads/";
        private final static String MASTER_BRANCH = "master";
        // 远程仓库路径 用的就是.git 
        private String remotePath;
    
        // 本地仓库路径 包含了项目工程名projectName
        private String localPath;
    
        private Git git;
    
        private Repository repository;
    
        private Ref branchRef;
    
        public String branchName;
        // Git授权
        private static UsernamePasswordCredentialsProvider usernamePasswordCredentialsProvider;
    
        /** * 构造函数：没有传分支信息则默认拉取master代码 * @param remotePath * @param localPath */
        public GitAdapter(String remotePath,String localPath) { 
            this(remotePath,localPath,MASTER_BRANCH);
        }
    
        public GitAdapter(String remotePath, String localPath, String branchName) { 
            this.remotePath = remotePath;
            this.localPath = localPath;
            this.branchName = branchName;
          // github账户密码
            this.usernamePasswordCredentialsProvider = new UsernamePasswordCredentialsProvider("username","password");
            // 初始化git
            this.initGit();
            repository = git.getRepository();
        }
    
        /** * 默认初始化的时候会自动拉取 @branchName 的最新代码 */
        private void initGit() { 
            File file = new File(localPath);
            System.out.println("文件路径"+localPath);
            // 如果文件存在 说明已经拉取过代码,则拉取最新代码
            if(file.exists()) { 
                try { 
                    // 打开git
                    git = Git.open(new File(localPath));
                    // 拉取最新的提交
                    git.pull().setCredentialsProvider(usernamePasswordCredentialsProvider).call();
                } catch (GitAPIException | IOException e) { 
                    logger.error("远程仓库拉取异常");
                    e.printStackTrace();
                } finally { 
                    logger.info("pull success");
                    git.close();
                }
            }
            // 文件不存在，说明未拉取过代码 则拉取最新代码
            else { 
                try { 
                    git = Git.cloneRepository()
                            .setCredentialsProvider(usernamePasswordCredentialsProvider)
                            .setURI(remotePath)
                            .setBranch(branchName)
                            .setDirectory(new File(localPath))
                            .call();
                    // 拉取最新的提交
                    git.pull().setCredentialsProvider(usernamePasswordCredentialsProvider).call();
                } catch (GitAPIException e) { 
                    logger.error("远程仓库下载异常");
                    e.printStackTrace();
                } finally { 
                    logger.info("down success");
                    git.close();
                }
            }
        }
        
    /// 此处省略其他不重要代码
    
    	/** * 获取当前分支的所有提交记录 * @return * @throws IOException * @throws GitAPIException */
        public List<CommitMessage> getCommitMessages() throws IOException, GitAPIException { 
            List<CommitMessage> commitMessages = new ArrayList<>();
            CommitMessage commitMessage = null;
            Iterable<RevCommit> commits = git.log().all().call();
            RevWalk walk = new RevWalk(repository);
            for(RevCommit commit:commits) { 
                commitMessage = new CommitMessage();
                boolean foundInThisBranch = false;
                RevCommit targetCommit = walk.parseCommit(commit.getId());
                for(Map.Entry< String,Ref> e : repository.getAllRefs().entrySet()){ 
    // e.getKey()
                    if(e.getKey().startsWith("refs/remotes/origin")) { 
                        if(walk.isMergedInto(targetCommit,walk.parseCommit(e.getValue().getObjectId()))) { 
                            String foundInBranch = e.getValue().getTarget().getName();
    // foundInBranch = foundInBranch.replace("refs/heads","");
                            if(foundInBranch.contains(branchName)) { 
                            // 如果只想获取commit merge的记录，则在此处添加一个条件即可
                            // if(targetCommit.getParents().length==2) { 
                                    foundInThisBranch = true;
                                    break;
                            }
                        }
                    }
    
                }
                if(foundInThisBranch) { 
                    commitMessage.setCommitId(commit.getName());
                    commitMessage.setCommitIdent(commit.getAuthorIdent().getName());
                    commitMessage.setCommitMessage(commit.getFullMessage());
                    commitMessage.setCommitDate(new Date(commit.getCommitTime()*1000L).toString());
     // commitMessage.setLastCommitId(commit.getParent(0).getName());
    // commitMessage.setMergeBranchCommitId(commit.getParent(1).getName());
                    commitMessages.add(commitMessage);
                }
            }
            return commitMessages;
        }
    }

## 三、结果 ##

对比自己github上面master分支的提交记录，可以知道这个结果与此记录一模一样。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0h1YW5nMTE3ODM4Nzg0OA_size_16_color_FFFFFF_t_70]

## 四、总结 ##

网上这一类的相关资料说多也多，不多也不多；蛮多都只是给一点思路，或者就是直接给一些代码块，真正实现自己想要的功能的是非常少的。楼主刚开始也是直接把想要的代码块复制下来去执行，发现不是一堆的报错就是取到的结果不是自己想要的。其实了解这个工具类或者了解其他工具类最早应该做的不是找实习的功能，而是充分去了解这个工具类，这个工具类所要实现的目的是什么，然后从最简单的功能去了解，然后在到复杂，最后就是任意的去写自己想要的功能而不依托于网上的资料。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0h1YW5nMTE3ODM4Nzg0OA_size_16_color_FFFFFF_t_70]: /images/20221023/ecb60e6404824541b8c75808e059d0dd.png