event

🍬A set of tools that keep Java sweet.

👉 https://whaleal.com/ 👈

github star


🌎English Documentation


📚简介

这是一个 Java 基础类库,用于促进事件驱动编程。

该框架的目的是提供一种简单的方法来生成和处理事件。

鼓励仅使用事件作为应用程序进程和第三方系统之间的通信方式。

这些,通过它们的格式,可以被记录、采取行动、分析、分发等等。

事件应该用于从应用程序的重要部分实时传输信息。

然后,任何相关方都可以注册一个或多个通用或专用侦听器以进一步处理这些事件。

🍺event如何改变我们的coding方式

event的目标是使用一个工具方法代替一段复杂代码,从而最大限度的避免“复制粘贴”代码的问题,彻底改变我们写代码的方式。

以一个通用的数据传输为例

event的存在就是为了减少代码搜索成本,避免网络上参差不齐的代码出现导致的bug,同时避免重复造轮子,。


📝文档


📦背景介绍

🍊Maven

在项目的pom.xml的dependencies中加入以下内容:

<dependency>
    <groupId>com.whaleal</groupId>
    <artifactId>event</artifactId>
    <version>0.1.0</version>
</dependency>

🍐Gradle

implementation 'com.whaleal:event:0.1.0'

📥下载jar

点击以下链接,下载event-X.X.X.jar即可:

🔔️注意 event 1.x支持JDK8+,对Android平台没有测试,不能保证所有工具类或工具方法可用。 所有版本编译起始均为JDK8+

🚽编译安装

访问event的github主页:https://github.com/whaleal/event 下载整个项目源码(v1-main或v1-dev分支都可)然后进入event项目目录执行:

进行基础的编译安装就可以了

然后就可以使用Maven引入了。


🏗️添砖加瓦

🎋分支说明

event的源码分为两个分支,功能如下:

分支 作用
main 主分支,release版本使用的分支,与中央库提交的jar一致,不接收任何pr或修改
v1-main 大版本主分支,不同大版本具有不同vxx-main, 用于合并v1-dev,观察特性,不接收任何pr或修改
v1-dev 开发分支,默认为下个版本的SNAPSHOT版本,接受修改或pr

🐞提供bug反馈或建议

提交问题反馈请说明正在使用的JDK版本呢、event版本和相关依赖库版本。

🧬贡献代码的步骤

1.在github issues 上找到需要修复的问题,或提出要贡献的特性内容

  1. 在github或者Github上fork项目到自己的repo
  2. 把fork过去的项目也就是你的项目clone到你的本地
  3. 修改代码(记得一定要修改v1-dev分支)并进行相关测试
  4. commit后push到自己的库(v1-dev分支)
  5. 登录github或Github在你首页可以看到一个 pull request 按钮,点击它,选择自己的dev 分支及本项目的dev 分支,填写一些说明信息,然后提交即可。
  6. 等待维护者合并

📐PR遵照的原则

event欢迎任何人为event添砖加瓦,贡献代码,不过维护者是一个强迫症患者,为了照顾病人,需要提交的pr(pull request)符合一些规范,规范如下:

  1. 注释完备,尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息,必要时请添加单元测试,如果愿意,也可以加上你的大名。
  2. event的缩进按照IDEA,IDEA真香,默认(tab)缩进,所以请遵守(不要和我争执空格与tab的问题,这是一个病人的习惯)。
  3. 新加的方法不要使用第三方库的方法,event遵循无依赖原则(除非在extra模块中加方法工具)。
  4. 请pull request到v1-dev分支,event在1.x版本后使用了新的分支:v1-main是大版本主分支,表示已经发布中央库的版本,这个分支不允许pr,也不允许修改。
  5. mian 分支 主要用于 release 相关版本等

⭐欢迎关注

如果你觉得本项目还不错,欢迎持续关注,在此表示感谢^_^。

其他相关项目

Project