From 49735374fd120d18e61d68edc8b4caafc4670eaf Mon Sep 17 00:00:00 2001 From: Looly Date: Thu, 17 Oct 2019 10:55:42 +0800 Subject: [PATCH] fix readme --- README.md | 87 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 53 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index c58f33376..06c791eb0 100644 --- a/README.md +++ b/README.md @@ -47,10 +47,15 @@ ------------------------------------------------------------------------------- ## 简介 +Hutool是一个小而全的Java工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率，使Java拥有函数式语言般的优雅，让Java语言也可以“甜甜的”。 -Hutool是一个Java工具包，也只是一个工具包，它帮助我们简化每一行代码，减少每一个方法，让Java语言也可以“甜甜的”。它最初是作者项目中“util”包的一个整理，后来慢慢积累并加入更多非业务相关功能，并广泛学习其它开源项目精髓，经过自己整理修改，最终形成丰富的开源工具集。 +Hutool中的工具方法来自于每个用户的精雕细琢，它涵盖了Java开发底层代码中的方方面面，它既是大型项目开发中解决小问题的利器，也是小型项目中的效率担当； -Hutool是Hu + tool的自造词，谐音“糊涂”，寓意，追求“万事都作糊涂观，无所谓失，无所谓得”的境界。 +Hutool是项目中“util”包友好的替代，它节省了我们对项目中公用类和公用工具方法的封装时间，使开发专注于业务，同时可以最大限度的避免封装不完善带来的bug。 + +### Hutool名称的由来 + +Hutool = Hu + tool，是原公司项目底层代码剥离后的开源库，“Hu”是公司名称的表示，tool表示工具。Hutool谐音“糊涂”，一方面简洁易懂，一方面寓意“难得糊涂”。 ### Hutool如何改变我们的coding方式 @@ -58,34 +63,36 @@ Hutool的目标是使用一个工具方法代替一段复杂代码，从而最 以计算MD5为例： -- 【以前】打开百度 -> 搜“Java MD5加密” -> 打开某篇博客-> 复制粘贴 -> 改改好用 +- 【以前】打开搜索引擎 -> 搜“Java MD5加密” -> 打开某篇博客-> 复制粘贴 -> 改改好用 - 【现在】引入Hutool -> SecureUtil.md5() -同样，当我们想实现什么功能，脑袋中第一个想到的就是去找XXXUtil，而非百度。 +Hutool的存在就是为了减少代码搜索成本，避免网络上参差不齐的代码出现导致的bug。 ------------------------------------------------------------------------------- ## 包含组件 一个Java基础工具类，对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装，组成各种Util工具类，同时提供以下组件： -- hutool-aop JDK动态代理封装，提供非IOC下的切面支持 -- hutool-bloomFilter 布隆过滤，提供一些Hash算法的布隆过滤 -- hutool-cache 简单缓存实现 -- hutool-core 核心，包括Bean操作、日期、各种Util等 -- hutool-cron 定时任务模块，提供类Crontab表达式的定时任务 -- hutool-crypto 加密解密模块，提供对称、非对称和摘要算法封装 -- hutool-db JDBC封装后的数据操作，基于ActiveRecord思想 -- hutool-dfa 基于DFA模型的多关键字查找 -- hutool-extra 扩展模块，对第三方封装（模板引擎、邮件、Servlet、二维码、Emoji、FTP、分词等） -- hutool-http 基于HttpUrlConnection的Http客户端封装 -- hutool-log 自动识别日志实现的日志门面 -- hutool-script 脚本执行封装，例如Javascript -- hutool-setting 功能更强大的Setting配置文件和Properties封装 -- hutool-system 系统参数调用封装（JVM信息等） -- hutool-json JSON实现 -- hutool-captcha 图片验证码实现 -- hutool-poi 针对POI中Excel的封装 -- hutool-socket 基于Java的NIO和AIO的Socket封装 +| 模块 | 介绍 | +| -------------------|---------------------------------------------------------------------------------- | +| hutool-aop | JDK动态代理封装，提供非IOC下的切面支持 | +| hutool-bloomFilter | 布隆过滤，提供一些Hash算法的布隆过滤 | +| hutool-cache | 简单缓存实现 | +| hutool-core | 核心，包括Bean操作、日期、各种Util等 | +| hutool-cron | 定时任务模块，提供类Crontab表达式的定时任务 | +| hutool-crypto | 加密解密模块，提供对称、非对称和摘要算法封装 | +| hutool-db | JDBC封装后的数据操作，基于ActiveRecord思想 | +| hutool-dfa | 基于DFA模型的多关键字查找 | +| hutool-extra | 扩展模块，对第三方封装（模板引擎、邮件、Servlet、二维码、Emoji、FTP、分词等） | +| hutool-http | 基于HttpUrlConnection的Http客户端封装 | +| hutool-log | 自动识别日志实现的日志门面 | +| hutool-script | 脚本执行封装，例如Javascript | +| hutool-setting | 功能更强大的Setting配置文件和Properties封装 | +| hutool-system | 系统参数调用封装（JVM信息等） | +| hutool-json | JSON实现 | +| hutool-captcha | 图片验证码实现 | +| hutool-poi | 针对POI中Excel的封装 | +| hutool-socket | 基于Java的NIO和AIO的Socket封装 | 可以根据需求对每个模块单独引入，也可以通过引入`hutool-all`方式引入所有模块。 @@ -126,11 +133,12 @@ compile 'cn.hutool:hutool-all:5.0.0' - [Maven中央库2](http://repo2.maven.org/maven2/cn/hutool/hutool-all/5.0.0/) > 注意 -> Hutool支持JDK7+，对Android平台没有测试，不能保证所有工具类获工具方法可用。 +> Hutool 5.x支持JDK8+，对Android平台没有测试，不能保证所有工具类获工具方法可用。 +> 如果你的项目使用JDK7，请使用Hutool 4.x版本 ### 编译安装 -访问Hutool的码云主页：[https://gitee.com/loolly/hutool](https://gitee.com/loolly/hutool) 下载整个项目源码（v4-master或v4-dev分支都可）然后进入Hutool项目目录执行： +访问Hutool的码云主页：[https://gitee.com/loolly/hutool](https://gitee.com/loolly/hutool) 下载整个项目源码（v5-master或v5-dev分支都可）然后进入Hutool项目目录执行： ```sh ./hutool.sh install @@ -142,20 +150,22 @@ compile 'cn.hutool:hutool-all:5.0.0' ## 添砖加瓦 +### 分支说明 + +Hutool的源码分为两个分支，功能如下： + +| 分支 | 作用 | +|-----------|---------------------------------------------------------------| +| v5-master | 主分支，release版本使用的分支，与中央库提交的jar一致，不接收任何pr或修改 | +| v5-dev | 开发分支，默认为下个版本的SNAPSHOT版本，接受修改或pr | + ### 提供bug反馈或建议 -- [码云Gitee](https://gitee.com/loolly/hutool/issues) -- [Github](https://github.com/looly/hutool/issues) +提交问题反馈请说明正在使用的JDK版本呢、Hutool版本和相关依赖库版本。 -### 遵照的原则 +- [码云Gitee issue](https://gitee.com/loolly/hutool/issues) +- [Github issue](https://github.com/looly/hutool/issues) -Hutool欢迎任何人为Hutool添砖加瓦，贡献代码，不过作者是一个强迫症患者，为了照顾病人，需要提交的pr（pull request）符合一些规范，规范如下： - -1. 注释完备，尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息，如果愿意，也可以加上你的大名。 -2. Hutool的缩进按照Eclipse（~~不要跟我说IDEA多好用，作者非常懒，学不会~~，IDEA真香，改了Eclipse快捷键后 -舒服多了）默认（tab）缩进，所以请遵守（不要和我争执空格与tab的问题，这是一个病人的习惯）。 -3. 新加的方法不要使用第三方库的方法，Hutool遵循无依赖原则（除非在extra模块中加方法工具）。 -4. 请pull request到`v4-dev`分支。Hutool在4.x版本后使用了新的分支：`v4-master`是主分支，表示已经发布中央库的版本，这个分支不允许pr，也不允许修改。`v4-dev`分支是开发分支，Hutool的下个版本或者SNAPSHOT版本在这个分支上开发，你可以pr到这个分支。 ### 贡献代码的步骤 @@ -166,6 +176,15 @@ Hutool欢迎任何人为Hutool添砖加瓦，贡献代码，不过作者是一 5. 登录Gitee或Github在你首页可以看到一个 pull request 按钮，点击它，填写一些说明信息，然后提交即可。 6. 等待作者合并 +### PR遵照的原则 + +Hutool欢迎任何人为Hutool添砖加瓦，贡献代码，不过作者是一个强迫症患者，为了照顾病人，需要提交的pr（pull request）符合一些规范，规范如下： + +1. 注释完备，尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息，必要时请添加单元测试，如果愿意，也可以加上你的大名。 +2. Hutool的缩进按照Eclipse（~~不要跟我说IDEA多好用，作者非常懒，学不会~~，IDEA真香，改了Eclipse快捷键后舒服多了）默认（tab）缩进，所以请遵守（不要和我争执空格与tab的问题，这是一个病人的习惯）。 +3. 新加的方法不要使用第三方库的方法，Hutool遵循无依赖原则（除非在extra模块中加方法工具）。 +4. 请pull request到`v5-dev`分支。Hutool在5.x版本后使用了新的分支：`v5-master`是主分支，表示已经发布中央库的版本，这个分支不允许pr，也不允许修改。 + ------------------------------------------------------------------------------- ## 捐赠