如何在Java中实现新文件生成时自动执行git commit操作

方案1：调用系统Shell/Git命令实现（推荐，运维成本低） #

你原本的思路是可行的，只要正确处理Java调用外部进程的逻辑即可，适合服务器已经预装Git、且提前配置好仓库权限的场景。

核心实现代码 #

import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;

public class GitAutoCommitUtil {
    // repoPath为Git仓库根目录的绝对路径，commitMsg为提交信息
    public static void commitNewFile(String repoPath, String commitMsg) throws IOException, InterruptedException {
        // 依次执行git add、git commit命令
        runCommand(repoPath, "git", "add", ".");
        // 也可以指定具体新增的文件路径，代替上面的. 减少不必要的文件扫描：runCommand(repoPath, "git", "add", "xxx/新生成的文件名");
        runCommand(repoPath, "git", "commit", "-m", commitMsg);
        // 如果需要同步推送到远程，再加一行：runCommand(repoPath, "git", "push");
    }

    private static void runCommand(String workDir, String... command) throws IOException, InterruptedException {
        ProcessBuilder pb = new ProcessBuilder(command);
        // 设置命令执行的工作目录为Git仓库根目录
        pb.directory(new java.io.File(workDir));
        // 合并错误流和输入流，避免进程因为缓冲区满阻塞
        pb.redirectErrorStream(true);
        Process process = pb.start();

        // 读取进程输出，必须做，否则进程会卡住
        try (InputStream is = process.getInputStream()) {
            String output = new String(is.readAllBytes(), StandardCharsets.UTF_8);
            // 可以把output打debug日志，排查问题用
        }

        int exitCode = process.waitFor();
        if (exitCode != 0) {
            throw new RuntimeException("Git命令执行失败，错误码：" + exitCode);
        }
    }
}

前置配置要求 #

• 服务器运行Java程序的账户，提前在Git中配置用户名和邮箱：

  git config --global user.name "你的用户名"
  git config --global user.email "你的邮箱"
  

• 如果仓库是私有库且需要推送，提前配置好SSH密钥或者Git凭证存储，避免命令执行时需要人工输入密码
• 保证Java程序对Git仓库目录有读写权限

方案2：使用JGit纯Java实现（无系统Git依赖） #

如果服务器不能预装Git，可以使用Eclipse开源的JGit库，直接通过Java API操作Git仓库，不需要依赖外部命令。

第一步：引入Maven依赖 #

<dependency>
    <groupId>org.eclipse.jgit</groupId>
    <artifactId>org.eclipse.jgit</artifactId>
    <version>6.9.0.202403050700-r</version>
</dependency>

核心实现代码 #

import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.errors.GitAPIException;
import java.io.File;
import java.io.IOException;

public class JGitCommitUtil {
    public static void commitNewFile(String repoPath, String commitMsg) throws IOException, GitAPIException {
        try (Git git = Git.open(new File(repoPath))) {
            // 添加所有新增变更，也可以指定具体文件路径
            git.add().addFilepattern(".").call();
            // 执行commit
            git.commit()
               .setMessage(commitMsg)
               // 也可以在这里单独指定本次提交的用户名和邮箱
               .setAuthor("提交人名称", "提交人邮箱")
               .call();
            // 需要推送的话追加push逻辑即可
            // git.push().call();
        }
    }
}

通用注意事项 #

• 必须在新文件完全写入、关闭IO流之后再触发Commit操作，避免提交不完整的损坏文件
• 对Commit逻辑做独立的异常捕获，不要因为Commit失败中断主业务程序的运行，建议把Commit失败的信息打印错误日志方便排查
• 可以根据业务场景加提交合并逻辑，比如10分钟内生成多个文件的话合并为一次提交，避免产生过多无意义的Commit记录
• 可以在提交信息里带上文件生成时间、业务标识等信息，方便后续回溯版本

内容的提问来源于stack exchange，提问作者F Lehmann