Java代码接入Git功能备份文件

最新推荐文章于 2023-08-09 10:46:52 发布

奋斗者ing

最新推荐文章于 2023-08-09 10:46:52 发布

阅读量292

点赞数

分类专栏： git 文章标签： java webview 开发语言

本文链接：https://blog.csdn.net/liaonanfeng88/article/details/125313219

版权

git 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

这个博客介绍了如何使用Java的JGit库进行Git仓库的克隆、打开、提交、推送等操作。提供了详细的代码示例，展示了如何创建Git构建器、重写文件内容、在README.md文件首部追加记录以及如何处理异常。示例代码演示了如何配置远程仓库、本地路径、分支信息，并进行文件修改和提交。

摘要由CSDN通过智能技术生成

Java Git代码依赖Jar

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

Java核心代码工具，可直接使用

public class JGitUtil {
    private static final Logger LOGGER = LoggerFactory.getLogger(JGitUtil.class);
    private static final String README = "README.md";
    private static final String TITLE_LEVEL = "## ";
    private static final String MESSAGE_LEVEL = "* ";
    private static final String DEFAULT_CHARSET = "UTF-8";
    // Depends on the operating system
    private static final String LINE_BREAKS = "\n";
    private static final String DIRECTORY_SPLIT = "/";

    /**
     * 返回一个 builder 实例
     *
     * @return builder
     */
    public static JGitRepositoryBuilder builder() {
        return new JGitRepositoryBuilder();
    }

    /**
     * 获取仓库，首先判断本地仓库是否存在，不存在则从远程Clone仓库
     *
     * @param builder 构建器
     * @return Git
     */
    private static Git getLatestRepository(JGitRepositoryBuilder builder) {
        Git git;
        File fLocalPath = new File(builder.localPath);
        if (!fLocalPath.exists())
            if (!fLocalPath.mkdirs())
                throw new RuntimeException("Git local path is not exists! Create this path failed : " + builder.localPath);
        if (!fLocalPath.isDirectory())
            throw new RuntimeException("Git local path is not a directory : " + builder.localPath);
        try {
            git = Git.open(fLocalPath);
            PullCommand pullCommand = git.pull().setRemoteBranchName(builder.branchName);
            if (builder.username != null && builder.password != null)
                pullCommand.setCredentialsProvider(new UsernamePasswordCredentialsProvider(builder.username, builder.password));
            pullCommand.call();
        } catch (Exception e) {
            LOGGER.warn("git repository not found: {}",e.getMessage());
            if (e instanceof RepositoryNotFoundException) {
                try {
                    CloneCommand cloneCommand = Git.cloneRepository()
                            .setURI(builder.remoteUri)
                            .setDirectory(fLocalPath)
                            .setBranch(builder.branchName);
                    if (builder.username != null && builder.password != null)
                        cloneCommand.setCredentialsProvider(new UsernamePasswordCredentialsProvider(builder.username, builder.password));
                    git = cloneCommand.call();
                } catch (GitAPIException e1) {
                    throw new RuntimeException("Clone git repository failed : " + builder.remoteUri + LINE_BREAKS + "because : " + e1.getMessage());
                }
            } else {
                throw new RuntimeException("Open git repository failed : " + builder.localPath);
            }
        }
        return git;
    }

    /**
     * 重写
     *
     * @param git      git
     * @param filePath 文件相对路径
     * @param message  message
     */
    public static void rewrite(Git git, String filePath, String message) {
        String repositoryPath = git.getRepository().getDirectory().getParent() + DIRECTORY_SPLIT;
        File file = new File(repositoryPath + filePath);
        UTF8Writer writer = null;
        try {
            checkFileTree(file);
            writer = new UTF8Writer(new FileOutputStream(file));
            writer.write(message);
        } catch (IOException e) {
            throw new RuntimeException(e);
        } finally {
            if (writer != null) {
                try {
                    writer.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    /**
     * 提交所有内容
     *
     * @param git     git
     * @param builder builder
     */
    public static void commitAndPush(Git git, JGitRepositoryBuilder builder) {
        try {
            git.add().addFilepattern(".").call();
            git.commit().setMessage(builder.commitMessage).call();
            PushCommand pushCommand = git.push();
            if (builder.username != null && builder.password != null)
                pushCommand.setCredentialsProvider(new UsernamePasswordCredentialsProvider(builder.username, builder.password));
            pushCommand.call();
        } catch (GitAPIException e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * 在README.md 文件首追加记录
     *
     * @param git         git
     * @param title       追加内容标题
     * @param messageList 追加内容
     */
    public static void readMeAppendOnStart(Git git, String title, List<String> messageList) {
        appendOneStart(git, README, title, messageList);
    }

    /**
     * 在文件首追加
     *
     * @param git         git
     * @param filePath    文件相对路径
     * @param title       追加内容标题
     * @param messageList 追加内容
     */
    public static void appendOneStart(Git git, String filePath, String title, List<String> messageList) {
        String repositoryPath = git.getRepository().getDirectory().getParent() + DIRECTORY_SPLIT;
        File sourceFile = new File(repositoryPath + filePath);
        File tmpFile;
        RandomAccessFile tmpFileIO = null;
        RandomAccessFile sourceFileIO = null;
        try {
            checkFileTree(sourceFile);
            tmpFile = new File(repositoryPath + filePath + ".tmp");
            checkFileTree(tmpFile);
            tmpFileIO = new RandomAccessFile(tmpFile, "rw");
            sourceFileIO = new RandomAccessFile(sourceFile, "rw");
            // 将源文件读入到临时文件中
            byte[] buffer = new byte[1024];
            int length;
            while ((length = sourceFileIO.read(buffer)) != -1) {
                tmpFileIO.write(buffer, 0, length);
            }
            // 从源文件首写入新增内容和原内容
            // 写入新增内容
            sourceFileIO.seek(0L);
            sourceFileIO.write((TITLE_LEVEL + title + LINE_BREAKS + LINE_BREAKS).getBytes(DEFAULT_CHARSET));
            for (String item : messageList) {
                sourceFileIO.write((MESSAGE_LEVEL + item + LINE_BREAKS).getBytes(DEFAULT_CHARSET));
            }
            sourceFileIO.write(LINE_BREAKS.getBytes(DEFAULT_CHARSET));
            // 写入原内容
            tmpFileIO.seek(0L);
            while ((length = tmpFileIO.read(buffer)) != -1) {
                sourceFileIO.write(buffer, 0, length);
            }
        } catch (IOException e) {
            throw new RuntimeException(e);
        } finally {
            if (tmpFileIO != null) {
                try {
                    tmpFileIO.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            if (sourceFileIO != null) {
                try {
                    sourceFileIO.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        if (tmpFile != null && !tmpFile.delete())
            throw new RuntimeException("Delete tmp file failed! " + tmpFile);
    }

    /**
     * Git 构建器
     */
    public static class JGitRepositoryBuilder {
        /**
         * 远程仓库地址
         */
        String remoteUri;

        /**
         * 本地仓库地址
         */
        String localPath;

        /**
         * 分支，默认master
         */
        String branchName = "master";

        /**
         * 用户名
         */
        String username;

        /**
         * 密码
         */
        String password;

        /**
         * 提交消息
         */
        String commitMessage;

        private JGitRepositoryBuilder() {
        }

        public JGitRepositoryBuilder remoteUri(String remoteUri) {
            this.remoteUri = remoteUri;
            return this;
        }

        public JGitRepositoryBuilder localPath(String localPath) {
            this.localPath = localPath;
            return this;
        }

        public JGitRepositoryBuilder branchName(String branchName) {
            this.branchName = branchName;
            return this;
        }

        public JGitRepositoryBuilder username(String username) {
            this.username = username;
            return this;
        }

        public JGitRepositoryBuilder password(String password) {
            this.password = password;
            return this;
        }

        public JGitRepositoryBuilder commitMessage(String commitMessage) {
            this.commitMessage = commitMessage;
            return this;
        }

        public Git builder() {
            if (this.remoteUri == null)
                throw new RuntimeException("JGitRepositoryBuilder remoteUri must not be null.");
            if (this.localPath == null)
                throw new RuntimeException("JGitRepositoryBuilder localPath must not be null.");
            return getLatestRepository(this);
        }
    }

    private static void checkFileTree(File file) throws IOException {
        if (!file.exists()) {
            if (!file.getParentFile().exists())
                if (!file.getParentFile().mkdirs())
                    throw new RuntimeException("Git repository has't this directory! Create this directory failed : " + file.getParentFile());
            if (!file.createNewFile())
                throw new RuntimeException("Git repository has't this file! Create this file failed : " + file.getAbsolutePath());
        }
    }
}

调用示例Test

@Test
public void test(){
//        String gitClone = "git@git.xxx.com:10022/xx-xxx/xx-xx-script.git";
//        String gitLocal = "D:\\home\\offline\\script";
        String gitClone = "http://git.mistong.com/xx-xxx/xx-xx-script.git";
        String gitLocal = "D:\\home\\xxx\\http";
        String comment = "my test " + DateUtils.convertDate2String(Calendar.getInstance().getTime());
        try {
            JGitUtil.JGitRepositoryBuilder builder = JGitUtil.builder()
                    .localPath(gitLocal)
                    .remoteUri(gitClone)
                    .username("***")
                    .password("***")
                    .commitMessage(comment);
            Git git = builder.builder();
            JGitUtil.rewrite(git, "test.sh", "*******99999");
            JGitUtil.commitAndPush(git, builder);
            git.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

效果Git上查看提交记录