Skip to content

yangchunjian/ujava

Repository files navigation

🍬架构设计工具.

👉 https://ujava.cn/ 👈

star github star



🌎English Documentation


📚简介

UJava是一个功能丰富且易用的Java设计模式库,旨在帮助开发者快速、便捷地使用设计模式完成各类开发任务。 可以满足各种不同的开发需求。

🎁UJava名称的由来

UJava = U + Java,是基于设计经验的开源库,“U”是You的表示,Java表示语言。UJava谐音“你的语言”,简洁易懂。

🍺UJava理念

UJava既是一个工具集,也是一个知识库,我们从不自诩代码原创,大多数工具类都是搬运而来,因此:

  • 你可以引入使用,也可以拷贝和修改使用,而不必标注任何信息,只是希望能把bug及时反馈回来。
  • 我们努力健全中文注释,为源码学习者提供良好地学习环境,争取做到人人都能看得懂。

🛠️包含组件

提供以下组件:

模块 介绍
ujava-design 设计模式
ujava-script 脚本
ujava-common 通用组件

可以根据需求对每个模块单独引入,也可以通过引入ujava-all方式引入所有模块。


📝文档

📘中文文档

📙参考API


🪙支持UJava

💳捐赠

如果你觉得UJava不错,可以捐赠请维护者吃包辣条~,在此表示感谢^_^。

Gitee上捐赠


📦安装

🍊Maven

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

<dependency>
    <groupId>cn.ujava</groupId>
    <artifactId>ujava-all</artifactId>
    <version>6.0.0</version>
</dependency>

🍐Gradle

implementation 'cn.ujava:ujava-all:6.0.0'

📥下载jar

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

🔔️注意 UJava 3.x支持JDK8+。

🚽编译安装

访问UJava的Gitee主页:https://gitee.com/yangchunjian/ujava 下载整个项目源码(main或dev分支都可)然后进入UJava项目目录执行:

./ujava.sh --install

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


🏗️添砖加瓦

🎋分支说明

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

分支 作用
main 主分支,release版本使用的分支,与中央库提交的jar一致,不接收任何pr或修改
dev 开发分支,默认为下个版本的SNAPSHOT版本,接受修改或pr

🐞提供bug反馈或建议

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

🧬贡献代码的步骤

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

📐PR遵照的原则

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

  1. 注释完备,尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息,必要时请添加单元测试,如果愿意,也可以加上你的大名。
  2. 新加的方法不要使用第三方库的方法,UJava遵循无依赖原则(除非在extra模块中加方法工具)。
  3. 请pull request到dev分支。UJava在5.x版本后使用了新的分支:main是主分支,表示已经发布中央库的版本,这个分支不允许pr,也不允许修改。
  4. 我们如果关闭了你的issue或pr,请不要诧异,这是我们保持问题处理整洁的一种方式,你依旧可以继续讨论,当有讨论结果时我们会重新打开。

⭐Star UJava

Stargazers over time

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages