diff --git a/README_zh_CN.md b/README_zh_CN.md index 052ccba..48e0eee 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -90,7 +90,7 @@ dependencies { ## 开发示例 -请 [**点击这里**](src/test/java/GithubDemo.java) 查看示例代码。 +请 [**点击这里**](src/test/java/GithubDemoChinese.java) 查看示例代码,也可以 [点击这里](https://github.com/CarmJos/UltraDepository/blob/master/src/main/java/cc/carm/plugin/ultradepository/hooker/UpdateChecker.java) 查看实例项目。 ## 支持与捐赠 diff --git a/src/test/java/GithubDemo.java b/src/test/java/GithubDemo.java index 5f85091..5b5ae62 100644 --- a/src/test/java/GithubDemo.java +++ b/src/test/java/GithubDemo.java @@ -53,14 +53,15 @@ public class GithubDemo { if (behindVersions == null) { System.out.println("Check failed! Please check updates manually."); System.out.println("Download at " + GithubReleases4J.getReleasesURL(owner, repository)); + } else if (behindVersions == 0) { + System.out.println("Check successfully, Now is up-to-date."); + } else if (behindVersions > 0) { + System.out.println("Outdated! Now behind " + behindVersions + " versions."); + System.out.println("Download latest version at " + GithubReleases4J.getLatestReleaseURL(owner, repository)); } else { - if (behindVersions > 0) { - System.out.println("Outdated! Now behind " + behindVersions + " versions."); - System.out.println("Download latest version at " + GithubReleases4J.getLatestReleaseURL(owner, repository)); - } else { - System.out.println("Now is using the latest version."); - } - + System.out.println("Check failed! Current version doesn't exists."); + System.out.println("Please use original version to avoid security issues."); + System.out.println("Download latest version at " + GithubReleases4J.getLatestReleaseURL(owner, repository)); } } diff --git a/src/test/java/GithubDemoChinese.java b/src/test/java/GithubDemoChinese.java new file mode 100644 index 0000000..9780254 --- /dev/null +++ b/src/test/java/GithubDemoChinese.java @@ -0,0 +1,70 @@ +import cc.carm.lib.githubreleases4j.GithubAsset; +import cc.carm.lib.githubreleases4j.GithubRelease; +import cc.carm.lib.githubreleases4j.GithubReleases4J; +import cc.carm.lib.githubreleases4j.GithubUser; + +import java.io.IOException; +import java.util.List; + +public class GithubDemoChinese { + + public void demo() { + + String owner = "库主(用户名或组织名)"; + String repository = "库名"; + + List releases = GithubReleases4J.listReleases("Owner", "RepoName"); + // 列出项目中所有发行版 + + GithubRelease latestRelease = GithubReleases4J.getLatestRelease( + owner, repository, "Token" // 如果是私有项目 则需要输入OAuth token + ); // 得到该库的最新发行 + + if (latestRelease != null) { + + List assets = latestRelease.getAssets(); + // 得到该发行下的所有附件 + + for (GithubAsset asset : assets) { + try { + asset.download(); // 使用原附件名直接下载 + } catch (IOException exception) { + exception.printStackTrace(); + } + + GithubUser uploader = asset.getUploader(); // 得到附件的上传者 + + } + + GithubUser author = latestRelease.getAuthor(); // 得到该发行的发布者 + + } + } + + public void checkUpdate() { + + String owner = "库主(用户名或组织名)"; + String repository = "库名"; + String version = "当前版本的 TagName"; + + Integer behindVersions = GithubReleases4J.getVersionBehind( + owner, repository, "Token",// 如果是私有项目 则需要输入OAuth token + version + ); + + if (behindVersions == null) { + System.out.println("检查更新失败! 请您手动检查版本更新。"); + System.out.println("下载地址 " + GithubReleases4J.getReleasesURL(owner, repository)); + } else if (behindVersions == 0) { + System.out.println("检查完成,当前已是最新版本。"); + } else if (behindVersions > 0) { + System.out.println("发现新版本! 目前已落后 " + behindVersions + " 个版本。"); + System.out.println("最新版下载地址 " + GithubReleases4J.getLatestReleaseURL(owner, repository)); + } else { + System.out.println("检查更新失败! 当前版本未知,请您使用原生版本以避免安全问题。"); + System.out.println("最新版下载地址 " + GithubReleases4J.getLatestReleaseURL(owner, repository)); + } + + } + +}