Skip to content

Commit b8b742c

Browse files
committed
更新README-zh.md文件;
1 parent fb84bd2 commit b8b742c

File tree

1 file changed

+53
-1
lines changed

1 file changed

+53
-1
lines changed

README-zh.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,62 @@
44
## 支持环境 ##
55
>**提示:** 目前,该项目尚未完成兼容性测试,此兼容性数据仅供参考。
66
- Base:
7-
- Java: 1.8或更高版本
7+
- Java: 1.8.0或更高版本
8+
- Encrypt:
9+
- Java: 1.8.0_161或更高版本(或对Java安装JCE.policy以解除对AES256及以上的限制)
10+
- Event:
11+
- Java: 1.8.0或更高版本
812

913
## 介绍 ##
1014
### 这个项目的用途? ###
1115
这个项目的目的是想将一些在Java开发中经常用到的全部总结在一个库内,避免“同一个轮子造了很多次”的情况出现。
1216

17+
## 工具 ##
18+
### base ###
19+
包路径: net.lamgc.utils.base
20+
介绍: 存放着一些基础工具类.
1321

22+
- `ArgumentsProperties` - 用于解析参数列表以生成参数键值对, 可以快速的查找参数.
23+
24+
### encrypt ###
25+
包路径: net.lamgc.utils.encrypt
26+
介绍: Encrypt Utils包含了AES加解密, RSA加解密和签名等与加密有关的工具类, 所有工具类均以Java自带加密套件为基础开发.
27+
28+
- `AESEncrypt` - AES加解密相关类.
29+
- `DiffieHellmanEncrypt` - DiffieHellman密钥交换算法类.
30+
- `MessageDigestUtils` - 消息摘要算法工具类.
31+
- `RSAEncrypt` - RSA加解密工具类.
32+
- `RSAEncryptWithAES` - RSA联合AES的长数据加解密工具类.
33+
- `RSASign` - RSA签名工具类.
34+
35+
### event ###
36+
包路径: net.lamgc.utils.event
37+
介绍: Event Utils是一套简单, 泛用的事件系统, 可以快速的为项目添加灵活的事件功能, 该事件系统以Bukkit API为原型开发.
38+
39+
- `BasicEventHandlerList` - 内置的默认EventHandlerList.
40+
- `EventExecutor` - 事件执行器, 用于投递事件到事件方法中.
41+
- `EventHandler` - 实现事件处理器所需的空接口, 用于标识某个类包含事件方法.
42+
- `EventObject` - 实现事件所需的空接口, 用于标识某个类为事件对象, 作为参数传递给事件方法.
43+
- `EventHandlerList` - 存储事件方法的List接口, 可实现该接口来改变存储方式.
44+
- `EventHandlerObjectMap` - 存储EventHandler对象的Map接口.
45+
- `EventInvokeException` - 用于包装事件方法抛出异常的信息, 转交给EventUncaughtExceptionHandler处理.
46+
- `EventUncaughtExceptionHandler` - 用于处理事件方法抛出异常的异常处理接口.
47+
- `HashHandlerObjectMap` - 内置的默认EventHandlerObjectMap, 通过HashMap实现
48+
49+
## LICENSE / 版权许可 ##
50+
本项目遵行`Apache 2`许可证开源:
51+
```
52+
Copyright 2019 LamGC
53+
54+
Licensed under the Apache License, Version 2.0 (the "License");
55+
You must not use the project and the files in the project except in compliance with the License.
56+
You may obtain a copy of the License at
57+
58+
http://www.apache.org/licenses/LICENSE-2.0
59+
60+
Unless required by applicable law or agreed to in writing, software
61+
distributed under the License is distributed on an "AS IS" BASIS,
62+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
63+
See the License for the specific language governing permissions and
64+
limitations under the License.
65+
```

0 commit comments

Comments
 (0)