[Change] 将多个加密工具类方法中抛出的'RuntimeException'替换为'IllegalStateException';

LamGC · LamGC · commit d5532a1344ed · 2020-06-30T10:37:40.000+08:00
[Update] 更新加密工具类的Javadoc内容;
diff --git a/src/main/java/net/lamgc/utils/encrypt/AESEncrypt.java b/src/main/java/net/lamgc/utils/encrypt/AESEncrypt.java
@@ -1,10 +1,8 @@
 package net.lamgc.utils.encrypt;
 
 import javax.crypto.*;
-import javax.crypto.spec.SecretKeySpec;
 import java.security.InvalidKeyException;
 import java.security.NoSuchAlgorithmException;
-import java.security.SecureRandom;
 
 /**
  * AES对称加密工具类
@@ -55,7 +53,7 @@ public static byte[] encrypt(byte[] data, SecretKey key) throws NoSuchPaddingExc
         try {
             cipher = Cipher.getInstance(Algorithm);
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         //初始化为加密模式,导入密钥
         //初始化密码器
@@ -79,7 +77,7 @@ public static byte[] decrypt(byte[] data, SecretKey key) throws NoSuchPaddingExc
         try {
             cipher = Cipher.getInstance(Algorithm);
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         //初始化为加密模式,导入密钥
         //初始化密码器
diff --git a/src/main/java/net/lamgc/utils/encrypt/DiffieHellmanEncrypt.java b/src/main/java/net/lamgc/utils/encrypt/DiffieHellmanEncrypt.java
@@ -6,6 +6,9 @@
 import java.security.spec.InvalidKeySpecException;
 import java.security.spec.X509EncodedKeySpec;
 
+/**
+ * DH密钥交换
+ */
 public final class DiffieHellmanEncrypt {
 
     static {
@@ -21,11 +24,18 @@ public final class DiffieHellmanEncrypt {
 
     private KeyPair keyPair;
 
-
+    /**
+     * 使用默认的密钥长度构造一个DH密钥交换对象
+     * @see #DEFAULT_KEY_SIZE
+     */
     public DiffieHellmanEncrypt(){
         initKey(DEFAULT_KEY_SIZE);
     }
 
+    /**
+     * 构造一个DH密钥交换对象并指定DH密钥长度
+     * @param keySize 密钥长度
+     */
     public DiffieHellmanEncrypt(int keySize){
         initKey(keySize);
     }
@@ -40,7 +50,7 @@ public void initKey(int keySize){
         try {
             keyPairGenerator = KeyPairGenerator.getInstance(KEY_ALGORITHM);
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         //初始化密钥对生成器
         keyPairGenerator.initialize(keySize);
@@ -70,22 +80,29 @@ public SecretKey getSecretKey(byte[] publicKey, Algorithm algorithm) throws Inva
             PublicKey pubKey = keyFactory.generatePublic(x509KeySpec);
             return getSecretKey(pubKey, algorithm);
         }catch(NoSuchAlgorithmException | InvalidKeySpecException e){
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
     }
 
+    /**
+     * 引入对方公钥, 构造指定算法的密钥
+     * @param publicKey 对方公钥
+     * @param algorithm 公共密钥算法
+     * @return 密钥对象
+     * @throws InvalidKeyException 当PublicKey无效时抛出
+     */
     public SecretKey getSecretKey(PublicKey publicKey, Algorithm algorithm) throws InvalidKeyException {
         try{
             KeyAgreement keyAgree = KeyAgreement.getInstance(KEY_ALGORITHM);
             keyAgree.init(this.keyPair.getPrivate());
             keyAgree.doPhase(publicKey, true);
             return keyAgree.generateSecret(algorithm.algorithmName);
         }catch(NoSuchAlgorithmException e){
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
     }
 
-
+    @SuppressWarnings("unused")
     public enum Algorithm{
         AES("AES"),
         RC2("RC2"),
diff --git a/src/main/java/net/lamgc/utils/encrypt/EncryptUtils.java b/src/main/java/net/lamgc/utils/encrypt/EncryptUtils.java
@@ -14,6 +14,7 @@ public final class EncryptUtils {
      * @param keyEncode 密钥编码数据
      * @param algorithm 密钥所属算法
      * @return SecretKey对象
+     * @throws NullPointerException 当byteEncode或algorithm为null时抛出
      */
     public static SecretKey BytesToSecretKey(byte[] keyEncode, String algorithm){
         Objects.requireNonNull(keyEncode);
@@ -26,8 +27,8 @@ public static SecretKey BytesToSecretKey(byte[] keyEncode, String algorithm){
      * @param encodeRules 密钥规则, 可以使用随机数据
      * @param keySize 随机源大小,默认128
      * @param keyAlgorithm 算法名
-     * @throws IllegalStateException 当传入的算法名不支持时抛出, 该异常的Cause为{@link NoSuchAlgorithmException}异常.
      * @return AES密钥
+     * @throws IllegalStateException 当传入的算法名不支持时抛出, 该异常的Cause为{@link NoSuchAlgorithmException}异常.
      */
     public static SecretKey getSecretKey(byte[] encodeRules, int keySize, String keyAlgorithm)
             throws IllegalStateException {
diff --git a/src/main/java/net/lamgc/utils/encrypt/HmacEncryptUtils.java b/src/main/java/net/lamgc/utils/encrypt/HmacEncryptUtils.java
@@ -6,6 +6,10 @@
 import java.security.NoSuchAlgorithmException;
 import java.util.Objects;
 
+/**
+ * Hmac加密工具类
+ * <p>通过该类可以很便捷的进行Hmac加密操作.</p>
+ */
 public final class HmacEncryptUtils {
 
     private HmacEncryptUtils() {}
diff --git a/src/main/java/net/lamgc/utils/encrypt/MessageDigestUtils.java b/src/main/java/net/lamgc/utils/encrypt/MessageDigestUtils.java
@@ -4,10 +4,19 @@
 import java.security.NoSuchAlgorithmException;
 import java.util.Objects;
 
+/**
+ * 数据摘要工具类.
+ */
 public final class MessageDigestUtils {
 
     private MessageDigestUtils() {}
 
+    /**
+     * 对指定数据取摘要
+     * @param data 待取摘要的数据
+     * @param algorithm 数据摘要算法
+     * @return 返回数据摘要
+     */
     public static byte[] encrypt(byte[] data, Algorithm algorithm){
         MessageDigest digest;
         try {
diff --git a/src/main/java/net/lamgc/utils/encrypt/RSAEncrypt.java b/src/main/java/net/lamgc/utils/encrypt/RSAEncrypt.java
@@ -12,6 +12,9 @@
 import java.security.spec.X509EncodedKeySpec;
 import java.util.Objects;
 
+/**
+ * RSA加密类.
+ */
 public final class RSAEncrypt {
 
     public static int DEFAULT_KEY_SIZE = 3072;
@@ -28,7 +31,7 @@ public static KeyPair getKeyPair(int keySize){
 		try{
             keyPairGen = KeyPairGenerator.getInstance("RSA");
         }catch(NoSuchAlgorithmException e){
-		    throw new RuntimeException(e);
+		    throw new IllegalStateException(e);
         }
 
         keyPairGen.initialize(keySize, new SecureRandom());
@@ -46,7 +49,7 @@ public static RSAPublicKey bytesToRSAPublicKey(byte[] keyBytes) throws InvalidKe
         try {
             return (RSAPublicKey) KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(keyBytes));
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
     }
 
@@ -60,7 +63,7 @@ public static RSAPrivateKey bytesToRSAPrivateKey(byte[] keyBytes) throws Invalid
         try {
             return (RSAPrivateKey) KeyFactory.getInstance("RSA").generatePrivate(new PKCS8EncodedKeySpec(keyBytes));
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
     }
 
@@ -82,7 +85,7 @@ public static byte[] encrypt(RSAPublicKey publicKey, byte[] plainTextData) throw
             cipher.init(Cipher.ENCRYPT_MODE, publicKey);  
             output = cipher.doFinal(plainTextData);
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         return output;  
     }
@@ -105,7 +108,7 @@ public static byte[] encrypt(RSAPrivateKey privateKey, byte[] plainTextData) thr
             cipher.init(Cipher.ENCRYPT_MODE, privateKey);  
             output = cipher.doFinal(plainTextData);  
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         return output;
     }
@@ -129,7 +132,7 @@ public static byte[] decrypt(RSAPrivateKey privateKey, byte[] cipherData) throws
             cipher.init(Cipher.DECRYPT_MODE, privateKey);
             output = cipher.doFinal(cipherData);  
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         return output; 
     }
@@ -153,7 +156,7 @@ public static byte[] decrypt(RSAPublicKey publicKey, byte[] cipherData) throws N
             cipher.init(Cipher.DECRYPT_MODE, publicKey);  
             output = cipher.doFinal(cipherData);
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         return output;
     }
diff --git a/src/main/java/net/lamgc/utils/encrypt/RSASign.java b/src/main/java/net/lamgc/utils/encrypt/RSASign.java
@@ -29,7 +29,7 @@ public static byte[] sign(byte[] content, byte[] privateKey, SignAlgorithm algor
             priKey = KeyFactory.getInstance("RSA").generatePrivate(privatePKCS8);
             signature = Signature.getInstance(algorithm.algorithmName);
         }catch(NoSuchAlgorithmException e){
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         signature.initSign(priKey);
         signature.update(content);
@@ -71,7 +71,7 @@ public static boolean checkSign(byte[] content, byte[] sign, byte[] publicKey, S
             pubKey = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKey));
             signature = Signature.getInstance(algorithm.algorithmName);
         }catch(NoSuchAlgorithmException e){
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
         signature.initVerify(pubKey);
         signature.update(content);

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,9 @@`
`12`	`12`	`import java.security.spec.X509EncodedKeySpec;`
`13`	`13`	`import java.util.Objects;`
`14`	`14`
	`15`	`+/**`
	`16`	`+ * RSA加密类.`
	`17`	`+ */`
`15`	`18`	`public final class RSAEncrypt {`
`16`	`19`
`17`	`20`	`public static int DEFAULT_KEY_SIZE = 3072;`
`@@ -28,7 +31,7 @@ public static KeyPair getKeyPair(int keySize){`
`28`	`31`	`try{`
`29`	`32`	`keyPairGen = KeyPairGenerator.getInstance("RSA");`
`30`	`33`	`}catch(NoSuchAlgorithmException e){`
`31`		`- throw new RuntimeException(e);`
	`34`	`+ throw new IllegalStateException(e);`
`32`	`35`	`}`
`33`	`36`
`34`	`37`	`keyPairGen.initialize(keySize, new SecureRandom());`
`@@ -46,7 +49,7 @@ public static RSAPublicKey bytesToRSAPublicKey(byte[] keyBytes) throws InvalidKe`
`46`	`49`	`try {`
`47`	`50`	`return (RSAPublicKey) KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(keyBytes));`
`48`	`51`	`} catch (NoSuchAlgorithmException e) {`
`49`		`- throw new RuntimeException(e);`
	`52`	`+ throw new IllegalStateException(e);`
`50`	`53`	`}`
`51`	`54`	`}`
`52`	`55`
`@@ -60,7 +63,7 @@ public static RSAPrivateKey bytesToRSAPrivateKey(byte[] keyBytes) throws Invalid`
`60`	`63`	`try {`
`61`	`64`	`return (RSAPrivateKey) KeyFactory.getInstance("RSA").generatePrivate(new PKCS8EncodedKeySpec(keyBytes));`
`62`	`65`	`} catch (NoSuchAlgorithmException e) {`
`63`		`- throw new RuntimeException(e);`
	`66`	`+ throw new IllegalStateException(e);`
`64`	`67`	`}`
`65`	`68`	`}`
`66`	`69`
`@@ -82,7 +85,7 @@ public static byte[] encrypt(RSAPublicKey publicKey, byte[] plainTextData) throw`
`82`	`85`	`cipher.init(Cipher.ENCRYPT_MODE, publicKey);`
`83`	`86`	`output = cipher.doFinal(plainTextData);`
`84`	`87`	`} catch (NoSuchAlgorithmException e) {`
`85`		`- throw new RuntimeException(e);`
	`88`	`+ throw new IllegalStateException(e);`
`86`	`89`	`}`
`87`	`90`	`return output;`
`88`	`91`	`}`
`@@ -105,7 +108,7 @@ public static byte[] encrypt(RSAPrivateKey privateKey, byte[] plainTextData) thr`
`105`	`108`	`cipher.init(Cipher.ENCRYPT_MODE, privateKey);`
`106`	`109`	`output = cipher.doFinal(plainTextData);`
`107`	`110`	`} catch (NoSuchAlgorithmException e) {`
`108`		`- throw new RuntimeException(e);`
	`111`	`+ throw new IllegalStateException(e);`
`109`	`112`	`}`
`110`	`113`	`return output;`
`111`	`114`	`}`
`@@ -129,7 +132,7 @@ public static byte[] decrypt(RSAPrivateKey privateKey, byte[] cipherData) throws`
`129`	`132`	`cipher.init(Cipher.DECRYPT_MODE, privateKey);`
`130`	`133`	`output = cipher.doFinal(cipherData);`
`131`	`134`	`} catch (NoSuchAlgorithmException e) {`
`132`		`- throw new RuntimeException(e);`
	`135`	`+ throw new IllegalStateException(e);`
`133`	`136`	`}`
`134`	`137`	`return output;`
`135`	`138`	`}`
`@@ -153,7 +156,7 @@ public static byte[] decrypt(RSAPublicKey publicKey, byte[] cipherData) throws N`
`153`	`156`	`cipher.init(Cipher.DECRYPT_MODE, publicKey);`
`154`	`157`	`output = cipher.doFinal(cipherData);`
`155`	`158`	`} catch (NoSuchAlgorithmException e) {`
`156`		`- throw new RuntimeException(e);`
	`159`	`+ throw new IllegalStateException(e);`
`157`	`160`	`}`
`158`	`161`	`return output;`
`159`	`162`	`}`