Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 3.26 KB

README.zh_CN.md

File metadata and controls

87 lines (61 loc) · 3.26 KB
Raw

gotify-java-client

gotify-java-client 是使用Java编写的 Gotify 同步Client.gotify-java-client 可以在Java或者Android应用中使用。

从源码构建

使用gotify-java-client时无需从源码构建，可以从release页面直接下载二进制jar。如果你想提前体验新功能gotify-java-client 可以很容易使用 maven 进行构建，当然这需要你已经安装JDK 1.8或者更高版本。

gotify-java-client 运行需要 Java 8 及其以上版本。

$ git clone https://github.com/ctlove0523/gotify-java-client.git
$ cd gotify-java-client
$ mvn clean package

如果你想将gotify-java-client 的jar包发布到本地maven仓库，下面的命令可以轻松完成这项工作：

$ mvn clean install

将 gotify-java-client 添加到项目的依赖中：

<dependency>
	<groupId>io.github.ctlove0523.gotify</groupId>
	<artifactId>gotify-java-client</artifactId>
	<version>{version}</version>
</dependency>

开始使用

如果对Gotify 还不熟悉，可以参考 Gotify 和 Gotify API 进行学习。下面是一个非常简单的获取应用的样例：

Credential credential=new BasicCredential.Builder()
		.userName("admin")
		.password("admin")
		.build();

GotifyClientConfig config=new GotifyClientConfig.Builder()
		.endpoint("http://localhost")
		.credential(credential)
		.build();

GotifyClient gotifyClient=GotifyClient.build(config);

MessageClient messageClient = gotifyClient.getMessageClient();
messageClient.registerMessageHandler(message -> System.out.println(message.getMessage()));

gotify-java-client 所有公开的方法都会返回一个Result<T,E> 对象，如果方法调用成功，那么isSuccessful() 方法返回true，否则返回false ，可以调用error() 方法获取Server返回的错误信息。下面是管用的方法：

Result<List<Application>, GotifyResponseError> result = appClient.getApplications();
if (result.isSuccessful()) {
	// do something
} else {
	// process error/IOException
}

获取帮助

在使用gotify-java-client 的过程中遇到任何困难，我们都非常乐意提供帮助！

报告问题

gotify-java-client 使用Github 的issue 跟踪系统来记录bugs和功能需求。如果你想提一个issue，请参考下面的建议：

  • 在提bug之前，请从search the issue tracker 查看是否已经有其他人报告相同的bug。
  • 如果不存在相同的issue，那么请你创建一个新的issue
  • 报告bug时请尽量提供足够多的信息，以方便我们定位并解决bug，因此我们需要知道gotify-java-client 的版本以及你使用的操作系统和JDK版本。

License

gotify-java-client 使用 MIT License.