add readme

This commit is contained in:
Looly 2023-05-16 23:34:12 +08:00
parent d657e591fe
commit d3e82c6ad6
6 changed files with 94 additions and 6 deletions

88
hutool-extra/README.md Normal file
View File

@ -0,0 +1,88 @@
<p align="center">
<a href="https://hutool.cn/"><img src="https://plus.hutool.cn/images/hutool.svg" width="45%"></a>
</p>
<p align="center">
<strong>🍬Make Java Sweet Again.</strong>
</p>
<p align="center">
👉 <a href="https://hutool.cn">https://hutool.cn/</a> 👈
</p>
## 📚Hutool-extra 模块介绍
`Hutool-extra`提供了第三方库的工具类,用于简化使用。
-------------------------------------------------------------------------------
## 🛠️包含内容
### AOP切面
动态代理封装提供非IOC下的切面支门面模式封装了
- 基于`java.lang.reflect.Proxy`代理
- 基于`Spring-cglib`代理
### 压缩
提供基于[Commons-compress](https://commons.apache.org/proper/commons-compress/)的压缩解压封装。
### Emoji
提供基于[emoji-java](https://github.com/vdurmont/emoji-java)的Emoji表情工具类。
### FTP
- 提供基于[Apache Commons Net](https://commons.apache.org/proper/commons-net/)的FTP封装。
- 提供基于[Apache FtpServer](http://mina.apache.org/ftpserver-project/)的FTP Server封装。
### Mail
提供基于[Jakarta Mail](https://projects.eclipse.org/projects/ee4j.mail)邮件发送封装。
### 系统信息监控
- 提供基于`JMXJava Management Extensions`相关封装用于完成JVM的监测和管理。
- 提供基于[Oshi](https://github.com/oshi/oshi)的封装用于通过JNI方式获取系统信息。
### 拼音
提供拼音工具库的API通过门面模式完成各类拼音库的适配。
### 二维码和条形码
提供基于[Zxing](https://github.com/zxing/zxing)的二维码、条形码的生成和识别封装。
### Spring
提供[Spring](https://spring.io/projects/spring-framework)相关工具类。
### SSH
- 提供基于[Jsch](http://www.jcraft.com/jsch/)的SSH、SFTP封装。
- 提供基于[Ganymed-SSH2](https://www.ganymed.ethz.ch/ssh2/)的SSH封装。
- 提供基于[SSHJ](https://github.com/hierynomus/sshj)的SSH封装。
### 模板引擎
通过门面模式提供统一的接口用于适配第三方模板引擎。
- `TemplateEngine`:模板引擎接口,用于不同引擎的实现。
- `Template` 模板接口,用于不同引擎模板对象包装。
- `TemplateConfig`:模板配置,用于提供公共配置项。
### 分词器
通过门面模式提供第三方分词库的封装。
- `TokenizerEngine`:分词引擎接口,用于具体实现分词功能。
- `Result`: 分词结果,提供分词后的单词遍历。
- `Word`: 分词,用于表示一个词,以及词的位置。
### 数据校验
基于JSR-380标准的校验工具类封装了[Jakarta Bean Validation](https://beanvalidation.org/)。
### XML和JAXB
提供基于`javax.xml.bind`的JAXBJava Architecture for XML Binding封装根据XML Schema产生Java对象即实现xml和Bean互转。

View File

@ -11,7 +11,7 @@
*/
/**
* 邮件封装基于javax-mail库入口为MailUtil
* 邮件封装基于jakarta.mail库入口为MailUtil
*
* @author looly
*

View File

@ -11,7 +11,7 @@
*/
/**
* System模块主要获取系统JVM内存CPU等信息以便动态监测系统状态
* Management模块主要获取系统JVM内存CPU等信息以便动态监测系统状态
*
* @author looly
*

View File

@ -11,9 +11,9 @@
*/
/**
* 由于Hutool的原则是不依赖于其它配置文件但是很多时候我们需要针对第三方非常棒的库做一些工具类化的支持因此Hutoo-extra包主要用于支持第三方库的工具类支持
* 由于Hutool的原则是不依赖于其它配置文件但是很多时候我们需要针对第三方非常棒的库做一些工具类化的支持<br>
* 因此Hutoo-extra包主要用于支持第三方库的工具类支持
*
* @author looly
*
*/
package org.dromara.hutool.extra;

View File

@ -24,7 +24,7 @@ import java.io.OutputStream;
import java.nio.charset.Charset;
/**
* Ganymed-SSH2封装http://www.ganymed.ethz.ch/ssh2/
* Ganymed-SSH2封装https://www.ganymed.ethz.ch/ssh2/
*
* @author looly
* @since 5.5.3

View File

@ -11,7 +11,7 @@
*/
/**
* 基于JSR-380标准的校验工具类封装了javax.validation的API
* 基于JSR-380标准的校验工具类封装了jakarta.validation的API
*
* @author chengqiang
*/