docs(global): Optimised javadoc, changed the spelling to British English.

Author: Zihlu Wang

devkit-core/src/main/java/cn/org/codecrafters/devkit/core/exceptions/package-info.java

@@ -16,7 +16,7 @@
  */
 
 /**
- * Commonly used exceptions will be used in JDevKit.
+ * This package contains commonly used exceptions will be used in JDevKit.
  *
  * @author Zihlu Wang
  * @since 1.0.0

devkit-core/src/main/java/cn/org/codecrafters/devkit/core/package-info.java

@@ -16,19 +16,16 @@
  */
 
 /**
- * This package is a part of JDevKit, an open-source Java Development Kit that
- * provides a set of convenient tools to streamline code development and
- * enhance productivity. This package serves as the core package containing
- * common exceptions that are used throughout the entireJDevKit project.
- *
+ * This package is the core part of JDevKit, an open-source Java Development
+ * Kit that provides a set of convenient tools to streamline code development
+ * and enhance productivity. This package serves as the core package containing
+ * common exceptions that are used throughout the entire JDevKit project.
  * <p>
  * JDevKit is designed to be modular, and other specific feature modules within
  * the library may rely on these exceptions from the core package.
- *
  * <p>
  * For more information and the latest version of JDevKit, please visit our
  * website <a href="https://codecrafters.org.cn">codecrafters.org.cn</a>.
- *
  * <p>
  * <b>Contact</b>
  * <ul>

devkit-core/src/main/java/cn/org/codecrafters/devkit/package-info.java

@@ -19,8 +19,8 @@
  * This package is the main part of JDevKit, an open-source Java class library
  * that provides a set of convenient tools to streamline code development and
  * enhance productivity. This package serves as the root package for several
- * modules, containing devkit-core, guid and dev-utils module.
- *
+ * modules, containing {@code devkit-core}, {@code guid} and {@code dev-utils}
+ * module.
  * <p>
  * For more information and the latest version of JDevKit, please visit our
  * website <a href="https://codecrafters.org.cn">codecrafters.org.cn</a>.

devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/AesUtil.java

@@ -34,12 +34,12 @@
 import java.util.UUID;
 
 /**
- * AES Util helps you encrypt and decrypt data with specified key and AES
- * algorithm.
+ * {@link AesUtil} can help you encrypt and decrypt data with specified secret
+ * by AES algorithm.
  *
  * @author hubin@baomidou
- * @since 1.1.0
  * @version 1.1.0
+ * @since 1.1.0
  */
 @Slf4j
 public final class AesUtil {
@@ -52,17 +52,17 @@ private AesUtil() {
     private static final String AES_CBC_CIPHER = "AES/CBC/PKCS5Padding";
 
     /**
-     * Encrypt the given data with given key with AES algorithm.
+     * Encrypts the data using the AES algorithm with the given secret.
      *
-     * @param data the data to be encrypted
-     * @param key  the key to encrypt the data
+     * @param data   the data to be encrypted
+     * @param secret the secret to encrypt the data
      * @return the encryption result or {@code null} if encryption failed
      */
-    public static byte[] encrypt(byte[] data, byte[] key) {
+    public static byte[] encrypt(byte[] data, byte[] secret) {
         try {
-            var secretKeySpec = new SecretKeySpec(new SecretKeySpec(key, AES).getEncoded(), AES);
+            var secretKeySpec = new SecretKeySpec(new SecretKeySpec(secret, AES).getEncoded(), AES);
             var cipher = Cipher.getInstance(AES_CBC_CIPHER);
-            cipher.init(Cipher.ENCRYPT_MODE, secretKeySpec, new IvParameterSpec(key));
+            cipher.init(Cipher.ENCRYPT_MODE, secretKeySpec, new IvParameterSpec(secret));
             return cipher.doFinal(data);
         } catch (NoSuchAlgorithmException | NoSuchPaddingException | UnsupportedOperationException |
                  InvalidKeyException | InvalidAlgorithmParameterException | IllegalBlockSizeException |
@@ -76,17 +76,17 @@ public static byte[] encrypt(byte[] data, byte[] key) {
     }
 
     /**
-     * Decrypt the given data with given key with AES algorithm.
+     * Decrypts the data using the AES algorithm with the given secret.
      *
      * @param data the data to be decrypted
-     * @param key  the key to encrypt the data
+     * @param secret  the secret to encrypt the data
      * @return the decryption result or {@code null} if decryption failed
      */
-    public static byte[] decrypt(byte[] data, byte[] key) {
+    public static byte[] decrypt(byte[] data, byte[] secret) {
         try {
-            var secretKeySpec = new SecretKeySpec(new SecretKeySpec(key, AES).getEncoded(), AES);
+            var secretKeySpec = new SecretKeySpec(new SecretKeySpec(secret, AES).getEncoded(), AES);
             var cipher = Cipher.getInstance(AES_CBC_CIPHER);
-            cipher.init(Cipher.DECRYPT_MODE, secretKeySpec, new IvParameterSpec(key));
+            cipher.init(Cipher.DECRYPT_MODE, secretKeySpec, new IvParameterSpec(secret));
             return cipher.doFinal(data);
         } catch (NoSuchAlgorithmException | NoSuchPaddingException | UnsupportedOperationException |
                  InvalidKeyException | InvalidAlgorithmParameterException | IllegalBlockSizeException |
@@ -100,36 +100,36 @@ public static byte[] decrypt(byte[] data, byte[] key) {
     }
 
     /**
-     * Encrypt the given data with given key with AES algorithm.
+     * Encrypts the data using the AES algorithm with the given secret.
      *
      * @param data the data to be encrypted
-     * @param key  the key to encrypt the data
+     * @param secret  the secret to encrypt the data
      * @return the encryption result or {@code null} if encryption failed
      */
-    public static String encrypt(String data, String key) {
-        return Base64.getEncoder().encodeToString(encrypt(data.getBytes(StandardCharsets.UTF_8), key.getBytes(StandardCharsets.UTF_8)));
+    public static String encrypt(String data, String secret) {
+        return Base64.getEncoder().encodeToString(encrypt(data.getBytes(StandardCharsets.UTF_8), secret.getBytes(StandardCharsets.UTF_8)));
     }
 
     /**
-     * Decrypt the given data with given key with AES algorithm.
+     * Decrypts the data using the AES algorithm with the given secret.
      *
      * @param data the data to be decrypted
-     * @param key  the key to encrypt the data
+     * @param secret  the secret to encrypt the data
      * @return the decryption result or {@code null} if decryption failed
      */
-    public static String decrypt(String data, String key) {
+    public static String decrypt(String data, String secret) {
         return new String(Objects.requireNonNull(
                 decrypt(Base64.getDecoder().decode(data.getBytes()),
-                        key.getBytes(StandardCharsets.UTF_8)))
+                        secret.getBytes(StandardCharsets.UTF_8)))
         );
     }
 
     /**
-     * Generates 16 characters-long random key.
+     * Generates 16 characters-long random secret.
      *
      * @return the generated secure secret
      */
-    public static String generateRandomKey() {
+    public static String generateRandomSecret() {
         return UUID.randomUUID().toString().replaceAll("-", "").substring(0, 16);
     }
 

devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/Base64Util.java

@@ -20,10 +20,11 @@
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
+import java.util.Objects;
 
 /**
- * The {@code Base64Util} class provides static methods to encode and decode
- * strings using Base64 encoding. It utilizes the {@link Base64} class from the
+ * The {@link Base64Util} class provides static methods to encode and decode
+ * strings with Base64 encoding. It utilizes the {@link Base64} class from the
  * Java standard library for performing the encoding and decoding operations.
  * This utility class offers convenient methods to encode and decode strings
  * with different character sets.
@@ -55,6 +56,34 @@
  */
 public final class Base64Util {
 
+    private static Base64.Encoder encoder;
+
+    private static Base64.Decoder decoder;
+
+    /**
+     * Ensure that there is only one Base64 Encoder.
+     *
+     * @return the {@link Base64.Encoder} instance
+     */
+    private static Base64.Encoder getEncoder() {
+        if (Objects.isNull(encoder)) {
+            encoder = Base64.getEncoder();
+        }
+        return encoder;
+    }
+
+    /**
+     * Ensure that there is only one Base64 Encoder.
+     *
+     * @return the {@link Base64.Encoder} instance
+     */
+    private static Base64.Decoder getDecoder() {
+        if (Objects.isNull(decoder)) {
+            decoder = Base64.getDecoder();
+        }
+        return decoder;
+    }
+
     /**
      * Private constructor to prevent instantiation of the class.
      */
@@ -69,8 +98,7 @@ private Base64Util() {
      * @return the Base64 encoded string
      */
     public static String encode(String value, Charset charset) {
-        var encoder = Base64.getEncoder();
-        var encoded = encoder.encode(value.getBytes(charset));
+        var encoded = getEncoder().encode(value.getBytes(charset));
 
         return new String(encoded);
     }
@@ -93,8 +121,7 @@ public static String encode(String value) {
      * @return the decoded string
      */
     public static String decode(String value, Charset charset) {
-        var decoder = Base64.getDecoder();
-        var decoded = decoder.decode(value.getBytes(charset));
+        var decoded = getDecoder().decode(value.getBytes(charset));
 
         return new String(decoded);
     }

devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/BranchUtil.java

@@ -23,24 +23,24 @@
 import java.util.function.Supplier;
 
 /**
- * The BranchUtil class provides static methods to simplify conditional logic
- * in Java development by leveraging lambda expressions. It offers convenient
- * methods to replace verbose if...else statements with more concise and
- * expressive functional constructs.
+ * The {@link BranchUtil} class provides static methods to simplify conditional
+ * logic in Java development by leveraging lambda expressions. It offers
+ * convenient methods to replace verbose {@code if...else} statements with more
+ * concise and expressive functional constructs.
  * <p>
- * Developers can use the methods in this utility class to streamline their
- * code, enhance readability, and promote a more functional style of
- * programming when dealing with branching logic and conditional statements.
+ * Developers can use methods in this utility class to streamline their code,
+ * enhance readability, and promote a more functional style of programming when
+ * dealing with branching logic and conditional statements.
  * <p>
  * <b>Example:</b>
  * <pre>
  * // If you want to simplify an if (exp1 || exp2), you can use the
  * // following code:
- * var r1 = BranchUtil.or(1 == 1, 2 == 1)
+ * String r1 = BranchUtil.or(1 == 1, 2 == 1)
  *     .handle(() -> "1 is equal to 1 or 2 is equal to 1.");
  *
  * // If you have an else branch, you can use the following code:
- * var r2 = BranchUtil.or(1 == 1, 2 == 1)
+ * String r2 = BranchUtil.or(1 == 1, 2 == 1)
  *     .handle(() -> "1 is equal to 1 or 2 is equal to 1.",
  *             () -> "1 is not equal to 1 and 2 is not equal to 1.");
  *