refactor: Optimsed codes.

Move private and protected methods or fields to the last of java files.

Author: Zihlu Wang

gradlew

@@ -32,36 +32,6 @@
  */
 public final class SecretCreator {
 
-    /**
-     * Private constructor to prevent instantiation
-     */
-    private SecretCreator() {
-    }
-
-    /**
-     * The string containing all lowercase characters that can be used to
-     * generate the secret.
-     */
-    private static final String LOWERCASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz";
-
-    /**
-     * The string containing all uppercase characters that can be used to
-     * generate the secret.
-     */
-    private static final String UPPERCASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
-
-    /**
-     * The string containing all digit characters that can be used to generate
-     * the secret.
-     */
-    private static final String DIGITS = "0123456789";
-
-    /**
-     * The string containing all special sign characters that can be used to
-     * generate the secret.
-     */
-    private static final String SPECIAL_SIGNS = "!@#$%^&,*()_+-=,[]{}|;:,'\",.<>/?";
-
     /**
      * Generates a secure secret with the specified length and character sets.
      *
@@ -153,4 +123,33 @@ public static String createSecret(int length) {
         return createSecret(length, false, false, false);
     }
 
+    /**
+     * Private constructor will protect this class from being instantiated.
+     */
+    private SecretCreator() {
+    }
+
+    /**
+     * The string containing all lowercase characters that can be used to
+     * generate the secret.
+     */
+    private static final String LOWERCASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz";
+
+    /**
+     * The string containing all uppercase characters that can be used to
+     * generate the secret.
+     */
+    private static final String UPPERCASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+
+    /**
+     * The string containing all digit characters that can be used to generate
+     * the secret.
+     */
+    private static final String DIGITS = "0123456789";
+
+    /**
+     * The string containing all special sign characters that can be used to
+     * generate the secret.
+     */
+    private static final String SPECIAL_SIGNS = "!@#$%^&,*()_+-=,[]{}|;:,'\",.<>/?";
 }

simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/SecretCreator.java

@@ -88,11 +88,7 @@ public final class PredefinedKeys {
     public static final List<String> KEYS = List.of(ISSUER, SUBJECT, AUDIENCE, EXPIRATION_TIME, NOT_BEFORE, ISSUED_AT, JWT_ID);
 
     /**
-     * Private constructor to prevent instantiation of the
-     * {@code PredefinedKeys} class.
-     * <p>
-     * This class is intended to be used as a utility class with only static
-     * constants and methods.
+     * Private constructor will protect this class from being instantiated.
      */
     private PredefinedKeys() {
     }

simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/constants/PredefinedKeys.java

@@ -63,6 +63,9 @@ public enum TokenDataType {
      */
     private final Class<?> mappedClass;
 
+    /**
+     * Create a TokenDataType with a mapped class.
+     */
     TokenDataType(Class<?> mappedClass) {
         this.mappedClass = mappedClass;
     }

simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/constants/TokenDataType.java

@@ -98,16 +98,6 @@
 @Slf4j
 public class JjwtTokenResolver implements TokenResolver<Jws<Claims>> {
 
-    private final GuidCreator<?> jtiCreator;
-
-    private final SecureDigestAlgorithm<SecretKey, SecretKey> algorithm;
-
-    private final String issuer;
-
-    private final SecretKey key;
-
-    private final JjwtTokenResolverConfig config = JjwtTokenResolverConfig.getInstance();
-
     /**
      * Create a resolver with specified algorithm, issuer, secret and guid strategy.
      *
@@ -432,6 +422,15 @@ public <T extends TokenPayload> String renew(String oldToken, T payload) {
         return renew(oldToken, Duration.ofMinutes(30), payload);
     }
 
+    /**
+     * Build a new token with specified data.
+     *
+     * @param expireAfter the validity time of the token
+     * @param audience    the audience of the token
+     * @param subject     the subject of the token
+     * @param claims      the data to be included in the token
+     * @return the built token
+     */
     private String buildToken(Duration expireAfter, String audience, String subject, Map<String, Object> claims) {
         var now = LocalDateTime.now();
         var builder = Jwts.builder()
@@ -453,4 +452,29 @@ private String buildToken(Duration expireAfter, String audience, String subject,
         return builder.signWith(key, algorithm)
                 .compact();
     }
+
+    /**
+     * The ID creator for creating unique JWT IDs.
+     */
+    private final GuidCreator<?> jtiCreator;
+
+    /**
+     * The algorithm to sign this token.
+     */
+    private final SecureDigestAlgorithm<SecretKey, SecretKey> algorithm;
+
+    /**
+     * The issuer of this token.
+     */
+    private final String issuer;
+
+    /**
+     * The signature key of this token.
+     */
+    private final SecretKey key;
+
+    /**
+     * The config of this token resolver.
+     */
+    private final JjwtTokenResolverConfig config = JjwtTokenResolverConfig.getInstance();
 }

simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/JjwtTokenResolver.java

@@ -63,17 +63,6 @@
  */
 public final class JjwtTokenResolverConfig implements TokenResolverConfig<SecureDigestAlgorithm<SecretKey, SecretKey>> {
 
-    private JjwtTokenResolverConfig() {
-    }
-
-    private static final Map<TokenAlgorithm, SecureDigestAlgorithm<SecretKey, SecretKey>> SUPPORTED_ALGORITHMS = new HashMap<>() {{
-        put(TokenAlgorithm.HS256, Jwts.SIG.HS256);
-        put(TokenAlgorithm.HS384, Jwts.SIG.HS384);
-        put(TokenAlgorithm.HS512, Jwts.SIG.HS512);
-    }};
-
-    private static JjwtTokenResolverConfig instance;
-
     public static JjwtTokenResolverConfig getInstance() {
         if (instance == null) {
             instance = new JjwtTokenResolverConfig();
@@ -106,4 +95,25 @@ public SecureDigestAlgorithm<SecretKey, SecretKey> getAlgorithm(TokenAlgorithm a
         }
         return SUPPORTED_ALGORITHMS.get(algorithm);
     }
+
+    /**
+     * Private constructor will protect this class from being instantiated.
+     */
+    private JjwtTokenResolverConfig() {
+    }
+
+    /**
+     * A {@code Map} to map a {@link TokenAlgorithm} to {@link SecureDigestAlgorithm}.
+     */
+    private static final Map<TokenAlgorithm, SecureDigestAlgorithm<SecretKey, SecretKey>> SUPPORTED_ALGORITHMS = new HashMap<>() {{
+        put(TokenAlgorithm.HS256, Jwts.SIG.HS256);
+        put(TokenAlgorithm.HS384, Jwts.SIG.HS384);
+        put(TokenAlgorithm.HS512, Jwts.SIG.HS512);
+    }};
+
+    /**
+     * The instance of this config class.
+     */
+    private static JjwtTokenResolverConfig instance;
+
 }

simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/config/JjwtTokenResolverConfig.java

@@ -65,19 +65,6 @@
 @AutoConfigureAfter(value = GuidAutoConfiguration.class)
 public class AuthzeroTokenResolverAutoConfiguration {
 
-    /**
-     * The GuidCreator instance to be used for generating JWT IDs (JTI).
-     */
-    private final GuidCreator<?> jtiCreator;
-
-    /**
-     * The {@code SimpleJwtProperties} instance containing the configuration
-     * properties for Simple JWT.
-     */
-    private final SimpleJwtProperties simpleJwtProperties;
-
-    private final ObjectMapper objectMapper;
-
     /**
      * Constructs a new {@code SimpleJwtAutoConfiguration} instance with the
      * provided SimpleJwtProperties.
@@ -112,4 +99,17 @@ public TokenResolver<DecodedJWT> tokenResolver() {
         );
     }
 
+    /**
+     * The GuidCreator instance to be used for generating JWT IDs (JTI).
+     */
+    private final GuidCreator<?> jtiCreator;
+
+    /**
+     * The {@code SimpleJwtProperties} instance containing the configuration
+     * properties for Simple JWT.
+     */
+    private final SimpleJwtProperties simpleJwtProperties;
+
+    private final ObjectMapper objectMapper;
+
 }

simple-jwt-spring-boot-starter/src/main/java/cn/org/codecrafters/simplejwt/autoconfiguration/AuthzeroTokenResolverAutoConfiguration.java

@@ -39,6 +39,11 @@
 @AutoConfiguration
 public class GuidAutoConfiguration {
 
+    /**
+     * Create a default {@code jtiCreator} with UUID.
+     *
+     * @return UUID creator
+     */
     @Bean(name = "jtiCreator")
     @Conditional(GuidCreatorCondition.class)
     public GuidCreator<?> jtiCreator() {

simple-jwt-spring-boot-starter/src/main/java/cn/org/codecrafters/simplejwt/autoconfiguration/GuidAutoConfiguration.java

@@ -65,17 +65,6 @@
 @AutoConfigureAfter(value = GuidAutoConfiguration.class)
 public class JjwtTokenResolverAutoConfiguration {
 
-    /**
-     * The GuidCreator instance to be used for generating JWT IDs (JTI).
-     */
-    private final GuidCreator<?> jtiCreator;
-
-    /**
-     * The {@code SimpleJwtProperties} instance containing the configuration
-     * properties for Simple JWT.
-     */
-    private final SimpleJwtProperties simpleJwtProperties;
-
     /**
      * Constructs a new {@code SimpleJwtAutoConfiguration} instance with the
      * provided SimpleJwtProperties.
@@ -107,4 +96,15 @@ public TokenResolver<Jws<Claims>> tokenResolver() {
         );
     }
 
+    /**
+     * The GuidCreator instance to be used for generating JWT IDs (JTI).
+     */
+    private final GuidCreator<?> jtiCreator;
+
+    /**
+     * The {@code SimpleJwtProperties} instance containing the configuration
+     * properties for Simple JWT.
+     */
+    private final SimpleJwtProperties simpleJwtProperties;
+
 }

simple-jwt-spring-boot-starter/src/main/java/cn/org/codecrafters/simplejwt/autoconfiguration/JjwtTokenResolverAutoConfiguration.java

@@ -17,6 +17,18 @@
  */
 @Slf4j
 public class GuidCreatorCondition implements Condition {
+
+    /**
+     * The condition to create bean {@code jtiCreator}.
+     * <p>
+     * If Spring does not have a bean of type
+     * {@link cn.org.codecrafters.guid.GuidCreator} named {@code jtiCreator}
+     * in the application context, then create {@code jtiCreator}.
+     *
+     * @param context  the spring application context
+     * @param metadata the metadata of the {@link org.springframework.core.type.AnnotationMetadata class}
+     *                 or {@link org.springframework.core.type.MethodMetadata method} being checked
+     */
     @Override
     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
         final var beanFactory = Objects.requireNonNull(context.getBeanFactory());