Skip to content

Commit 1b951fe

Browse files
LamGCLamGC
committed
[Fix] 修复多处Javadoc问题;
[Change] EncryptUtils 调整‘getSecretKey(byte[], int, String)’方法抛出的异常; [Fix] pom.xml 修复source和javadoc插件不起作用的问题;
1 parent 2e63a0d commit 1b951fe

File tree

12 files changed

+61
-53
lines changed

12 files changed

+61
-53
lines changed

‎pom.xml‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343

4444
<properties>
4545
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
46+
<project.build.javadocEncoding>UTF-8</project.build.javadocEncoding>
4647
<maven.compiler.source>1.8</maven.compiler.source>
4748
<maven.compiler.target>1.8</maven.compiler.target>
4849
</properties>
@@ -84,7 +85,6 @@
8485
</distributionManagement>
8586

8687
<build>
87-
<pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
8888
<plugins>
8989
<plugin>
9090
<artifactId>maven-clean-plugin</artifactId>
@@ -130,33 +130,37 @@
130130
<plugin>
131131
<groupId>org.apache.maven.plugins</groupId>
132132
<artifactId>maven-source-plugin</artifactId>
133+
<version>2.4</version>
133134
<executions>
134135
<execution>
135136
<id>attach-sources</id>
137+
<phase>package</phase>
136138
<goals>
137-
<goal>jar-no-fork</goal>
139+
<goal>jar</goal>
138140
</goals>
139141
</execution>
140142
</executions>
141143
</plugin>
142144
<plugin>
143145
<groupId>org.apache.maven.plugins</groupId>
144146
<artifactId>maven-javadoc-plugin</artifactId>
147+
<version>2.10.2</version>
148+
<configuration>
149+
<aggregate>true</aggregate>
150+
<charset>UTF-8</charset>
151+
<encoding>UTF-8</encoding>
152+
<docencoding>UTF-8</docencoding>
153+
</configuration>
145154
<executions>
146155
<execution>
147156
<id>attach-javadocs</id>
157+
<phase>package</phase>
148158
<goals>
149159
<goal>jar</goal>
150160
</goals>
151-
<configuration>
152-
<additionalOption>
153-
<additionalOption>-Xdoclint:none</additionalOption>
154-
</additionalOption>
155-
</configuration>
156161
</execution>
157162
</executions>
158163
</plugin>
159164
</plugins>
160-
</pluginManagement>
161165
</build>
162166
</project>

‎src/main/java/net/lamgc/utils/base/ArgumentsProperties.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public void load(String argument) {
6666
}
6767

6868
/**
69-
* 将参数数组加载进行处理.<br/>
69+
* 将参数数组加载进行处理.<br>
7070
* 注意: 此前加载的内容将会被清空!
7171
* @param args 参数数组
7272
*/
@@ -146,8 +146,8 @@ private String getKeyFilterFlag(String s){
146146

147147

148148
/**
149-
* 获取指定参数的值.<br/>
150-
* 当参数存在, 但没有赋值时, 方法将返回空字符串而非null.<br/>
149+
* 获取指定参数的值.<br>
150+
* 当参数存在, 但没有赋值时, 方法将返回空字符串而非null.<br>
151151
* @param key 要获取值的参数名
152152
* @return 如果输入的参数中有指定的参数, 则返回非null(即使没有值), 如果该参数不存在, 返回null
153153
*/

‎src/main/java/net/lamgc/utils/base/BasicTypeConverter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import java.util.Objects;
55

66
/**
7-
* 基本数据类型Type 转 包装数据类型Type.<br/>
7+
* 基本数据类型Type 转 包装数据类型Type.<br>
88
* 请使用{@link #valueOfBasicTypeName(Type)}方法获取.
99
*/
1010
public enum BasicTypeConverter {
@@ -25,7 +25,7 @@ public enum BasicTypeConverter {
2525
}
2626

2727
/**
28-
* 尝试转换基本数据类型为包装数据类型.<br/>
28+
* 尝试转换基本数据类型为包装数据类型.<br>
2929
* 如没有对应包装数据类型将返回原Type对象.
3030
* @param baseType 欲转换的基本数据类型Type.
3131
* @return 如果为基本数据类型且存在包装数据类型则返回对应包装数据类型, 不存在则原样返回.

‎src/main/java/net/lamgc/utils/base/runner/Argument.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
/**
1616
* 参数名.
1717
* 如果需要省略参数名, 使用方法名, 则需要在编译时指定 "{@code -parameters}"参数以保留参数名
18+
* @return 返回参数标识名
1819
*/
1920
String name() default "";
2021

@@ -25,6 +26,7 @@
2526
* 如果必填为false, 如已设置defaultValue则转换defaultValue并传参;
2627
* 如未设置defaultValue, 如参数类型为基本数据类型则传入该类型默认值,
2728
* 如参数类型为对象则填入null.
29+
* @return 如果参数必须存在, 则返回true
2830
*/
2931
boolean force() default true;
3032

‎src/main/java/net/lamgc/utils/base/runner/ArgumentsRunner.java‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,9 @@
1010
import java.util.regex.Pattern;
1111

1212
/**
13-
* 命令行参数运行器.<br/>
14-
* 该运行器根据传入的参数, 自动选择指定类中带有{@linkplain Command Command标注}的方法, 且支持参数传入.<br/>
15-
* 运行格式:
16-
* <pre>
17-
* java -jar jarFile <Command> [Arguments...]
18-
* </pre>
13+
* 命令行参数运行器.<br>
14+
* 该运行器根据传入的参数, 自动选择指定类中带有{@linkplain Command Command标注}的方法, 且支持参数传入.<br>
15+
* 运行格式: {@code java -jar jarFile <Command> [Arguments...]}
1916
*/
2017
public class ArgumentsRunner {
2118

@@ -55,7 +52,7 @@ public static Object run(Class<?> runClass, Object object, String[] args) throws
5552
}
5653

5754
/**
58-
* 在调用该方法所在类启动ArgumentsRunner.<br/>
55+
* 在调用该方法所在类启动ArgumentsRunner.<br>
5956
* 注意: 当项目使用如SpringBoot之类的框架, 而框架存在重新打包项目并分隔目录的情况时, 请不要使用本方法!
6057
* 经过重新打包的Jar将无法根据堆栈找到 RunClass.
6158
* @param args 参数
@@ -69,7 +66,7 @@ public static Object runInThisClass(String[] args) throws RunnerException {
6966
}
7067

7168
/**
72-
* 在调用该方法所在类启动ArgumentsRunner.<br/>
69+
* 在调用该方法所在类启动ArgumentsRunner.<br>
7370
* 注意: 当项目使用如SpringBoot之类的框架, 而框架存在重新打包项目并分隔目录的情况时, 请不要使用本方法!
7471
* 经过重新打包的Jar将无法根据堆栈找到 RunClass.
7572
* @param object 当前方法所在的class的实例对象
@@ -198,8 +195,8 @@ public Object run(Object object, String[] args) throws RunnerException {
198195
}
199196

200197
/**
201-
* 获取已获得的命令名. <br/>
202-
* 命令根据方法静态与否, 在命令名前有静态表示的 "Static." 前缀, <br/>
198+
* 获取已获得的命令名. <br>
199+
* 命令根据方法静态与否, 在命令名前有静态表示的 "Static." 前缀, <br>
203200
* 例如实例命令方法 "Command",
204201
* 如果是静态方法, 则为 "Static.Command"
205202
* @return 返回存储命令名的Set对象, 如尚未解析Class内的方法, 则返回null

‎src/main/java/net/lamgc/utils/base/runner/ArgumentsRunnerConfig.java‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ public class ArgumentsRunnerConfig implements Serializable {
2121
private boolean strictDefaultCheck = false;
2222

2323
/**
24-
* true的标识名.<br/>
24+
* true的标识名.<br>
2525
* 参数类型为Boolean且参数值存在的情况下, 将会判断值是否存在于trueFlag中, 如果存在, 则认为是true值.
2626
*/
2727
private Set<String> trueFlag = new HashSet<>(4);
2828

2929
/**
30-
* 转换异常时是否使用参数值而不是抛出异常.<br/>
30+
* 转换异常时是否使用参数值而不是抛出异常.<br>
3131
* 默认值: false
3232
*/
3333
private boolean useDefaultValueInsteadOfException = false;
@@ -42,7 +42,7 @@ public ArgumentsRunnerConfig() {
4242
}
4343

4444
/**
45-
* 构造时会调用的初始化方法.<br/>
45+
* 构造时会调用的初始化方法.<br>
4646
* 可覆盖.
4747
*/
4848
private void initialConfig() {
@@ -60,10 +60,10 @@ private void initialConfig() {
6060
}
6161

6262
/**
63-
* 添加指定Type的Parser对象.<br/>
64-
* 注意: 添加会导致原本的Parser被覆盖.<br/>
65-
* 部分Type的处理: <br/>
66-
* - 对Boolean的Parser: Config默认不存在对Boolean的转换, 如添加对Boolean的Parser将导致TrueFlag失效!<br/>
63+
* 添加指定Type的Parser对象.<br>
64+
* 注意: 添加会导致原本的Parser被覆盖.<br>
65+
* 部分Type的处理: <br>
66+
* - 对Boolean的Parser: Config默认不存在对Boolean的转换, 如添加对Boolean的Parser将导致TrueFlag失效!<br>
6767
* - 对String的Parser: 如果存在对String类型的Parser, 将会提供参数原始值给Parser进行处理.
6868
* @param parser Parser对象
6969
*/
@@ -72,7 +72,7 @@ public void addStringParameterParser(StringParameterParser<?> parser) {
7272
}
7373

7474
/**
75-
* 删除指定Type的Parser对象.<br/>
75+
* 删除指定Type的Parser对象.<br>
7676
* @param type 欲删除Parser对象的Type.
7777
*/
7878
public void removeStringParameterParser(Type type) {
@@ -98,8 +98,8 @@ public boolean hasStringParameterParser(Type type) {
9898
}
9999

100100
/**
101-
* 添加一个代表true的值.<br/>
102-
* 注意: 当StringParameterParser添加了对Boolean对象的Parser时, TrueFlag的设置将会失效.<br/>
101+
* 添加一个代表true的值.<br>
102+
* 注意: 当StringParameterParser添加了对Boolean对象的Parser时, TrueFlag的设置将会失效.<br>
103103
* @param flag true的代表参数值, 代表值将会经过 {@linkplain String#toLowerCase() toLowerCase()} 后存储
104104
*/
105105
public void addTrueFlag(String flag) {
@@ -116,7 +116,7 @@ public boolean removeTrueFlag(String flag) {
116116
}
117117

118118
/**
119-
* 获得当前的trueFlagSet.<br/>
119+
* 获得当前的trueFlagSet.<br>
120120
* 对通过本方法获取的Set对象的修改不会影响到trueFlag.
121121
* @return 存储当前已添加Flag的Set对象.
122122
*/
@@ -133,8 +133,8 @@ public boolean isCommandIgnoreCase() {
133133
}
134134

135135
/**
136-
* 命令是否忽略大小写.<br/>
137-
* <br/>
136+
* 命令是否忽略大小写.<br>
137+
* <br>
138138
* 默认值: false
139139
* @param commandIgnoreCase 默认为false, true则为忽略大小写,
140140
* 需要随着构造方法传入才会生效.
@@ -152,10 +152,10 @@ public boolean isStrictDefaultCheck() {
152152
}
153153

154154
/**
155-
* 设置是否严格检查参数force为false下的默认值.<br/>
155+
* 设置是否严格检查参数force为false下的默认值.<br>
156156
* 当force为false且未设置defaultValue时, 如本项为false, 则返回默认值,
157-
* 如本项为true, 则抛出{@link net.lamgc.utils.base.runner.exception.InvalidParameterException InvalidParameterException}异常.<br/>
158-
* <br/>
157+
* 如本项为true, 则抛出{@link net.lamgc.utils.base.runner.exception.InvalidParameterException InvalidParameterException}异常.<br>
158+
* <br>
159159
* 默认值: false
160160
* @param strictDefaultCheck 设定值.
161161
*/

‎src/main/java/net/lamgc/utils/base/runner/Command.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
public @interface Command {
1515

1616
/**
17-
* 命令名.<br/>
17+
* 命令名.<br>
1818
* 如果填空, 则使用方法名.
1919
* @return 方法所属的命令名
2020
*/
2121
String commandName() default "";
2222

2323
/**
24-
* 是否为默认方法.<br/>
24+
* 是否为默认方法.<br>
2525
* 默认方法需要没有参数, 否则该参数将会被忽略.
2626
* @return 如果为默认方法则为true
2727
*/

‎src/main/java/net/lamgc/utils/base/runner/exception/CommandNotSpecifiedException.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package net.lamgc.utils.base.runner.exception;
22

33
/**
4-
* 当用户未指定命令, 且未设置defaultCommand时抛出.<br/>
4+
* 当用户未指定命令, 且未设置defaultCommand时抛出.<br>
55
* 该异常属于用户引发异常.
66
*/
77
public class CommandNotSpecifiedException extends UserRunnerException {

‎src/main/java/net/lamgc/utils/base/runner/exception/RunnerException.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
public class RunnerException extends RuntimeException {
1010

1111
/**
12-
* 该异常由用户引起.<br/>
12+
* 该异常由用户引起.<br>
1313
* 当Trigger为该值时, 代表异常是由于用户输入原因导致的, 这种异常的出现是偶然的.
1414
*/
1515
public final static int TRIGGER_USER = 1;
1616

1717
/**
18-
* 该异常由开发者引起.<br/>
18+
* 该异常由开发者引起.<br>
1919
* 当Trigger为该值时, 代表异常是由于代码层次原因导致的, 这种异常的出现是必然的.
2020
*/
2121
public final static int TRIGGER_DEVELOPER = 2;

‎src/main/java/net/lamgc/utils/encrypt/EncryptUtils.java‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,12 @@ public static SecretKey BytesToSecretKey(byte[] keyEncode, String algorithm){
2525
* 根据密钥规则(可以是密钥)生成一个AES密钥对象
2626
* @param encodeRules 密钥规则, 可以使用随机数据
2727
* @param keySize 随机源大小,默认128
28+
* @param keyAlgorithm 算法名
29+
* @throws IllegalStateException 当传入的算法名不支持时抛出, 该异常的Cause为{@link NoSuchAlgorithmException}异常.
2830
* @return AES密钥
2931
*/
30-
public static SecretKey getSecretKey(byte[] encodeRules, int keySize, String keyAlgorithm){
32+
public static SecretKey getSecretKey(byte[] encodeRules, int keySize, String keyAlgorithm)
33+
throws IllegalStateException {
3134
if(keySize <= 0){
3235
//设置一个初始值
3336
keySize = 128;
@@ -36,7 +39,7 @@ public static SecretKey getSecretKey(byte[] encodeRules, int keySize, String key
3639
try{
3740
keygen = KeyGenerator.getInstance(keyAlgorithm);
3841
} catch (NoSuchAlgorithmException e) {
39-
throw new RuntimeException(e);
42+
throw new IllegalStateException(e);
4043
}
4144
keygen.init(keySize, new SecureRandom(encodeRules));
4245
return BytesToSecretKey(keygen.generateKey().getEncoded(), keyAlgorithm);

0 commit comments

Comments
 (0)