refine MessageSource

Author: hank-cp

demo/skr-demo-all-in-one/src/test/java/demo/skr/aio/util/JsonUtilTest.java

@@ -18,10 +18,14 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.NullNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import org.junit.Test;
 import org.skr.common.util.JsonUtil;
 import org.skr.config.json.JsonSkipPersistence;
 
+import java.util.Optional;
+
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.*;
 
@@ -57,6 +61,12 @@ public record B(
         @JsonSkipPersistence
         int b) {}
 
+    public static class C {
+        public Optional<Integer> a = Optional.empty();
+
+        public Optional<Integer> b;
+    }
+
     @Test
     public void testSkipPersistence() {
         ObjectMapper objectMapper = JsonUtil.setupPersistentObjectMapper(JsonUtil.getObjectMapper());
@@ -78,4 +88,29 @@ public void testSkipPersistence() {
         assertThat(json.get("a"), notNullValue());
         assertThat(json.get("b"), nullValue());
     }
+
+    @Test
+    public void testOptional() {
+        ObjectMapper objectMapper = JsonUtil.setupPersistentObjectMapper(JsonUtil.getObjectMapper());
+
+        C c1 = new C();
+        c1.a = Optional.of(1);
+        JsonNode json = JsonUtil.toJsonNode(objectMapper, c1);
+        assertThat(json.get("a"), notNullValue());
+        assertThat(json.get("a").asInt(), equalTo(1));
+
+        C c2 = new C();
+        json = JsonUtil.toJsonNode(objectMapper, c2);
+        assertThat(json.get("a"), equalTo(NullNode.getInstance()));
+        assertThat(json.get("b"), nullValue());
+
+        C c3 = objectMapper.convertValue(json, C.class);
+        assertThat(c3.a, equalTo(Optional.empty()));
+        assertThat(c3.b, nullValue());
+
+        ObjectNode c4Json = objectMapper.createObjectNode();
+        C c4 = objectMapper.convertValue(c4Json.put("a", "1"), C.class);
+        assertThat(c4.a, notNullValue());
+        assertThat(c4.a.get(), equalTo(1));
+    }
 }

demo/skr-demo-all-in-one/src/test/java/demo/skr/aio/util/ValuedEnumTest.java

@@ -38,7 +38,6 @@
 public class ValuedEnumTest {
 
     @Test
-    @Transactional
     public void testStringEnumConversion() {
         ErrorInfo errorInfo = ErrorInfo.INTERNAL_SERVER_ERROR.msgArgs("test");
         String json = JsonUtil.toJson(errorInfo);
@@ -51,7 +50,6 @@ public void testStringEnumConversion() {
     }
 
     @Test
-    @Transactional
     public void testIntegerEnumConversion() {
         String json = JsonUtil.toJson(PermissionDetail.PermissionResult.PERMISSION_LIMITED);
         assertThat(json, notNullValue());
@@ -63,4 +61,12 @@ public void testIntegerEnumConversion() {
         assertThat(deserializedObj, equalTo(PermissionDetail.PermissionResult.PERMISSION_LIMITED));
     }
 
+    @Test
+    public void testPropertiesMessages() {
+        assertThat(PermissionDetail.PermissionResult.PERMISSION_LIMITED.enumLabel(), equalTo("Permission Checking Result"));
+        assertThat(PermissionDetail.PermissionResult.PERMISSION_LIMITED.valueLabel(), equalTo("Permission limited"));
+
+        assertThat(ErrorInfo.INTERNAL_SERVER_ERROR.msgArgs("asdf").getMessage(), equalTo("内部错误: asdf"));
+    }
+
 }

gradle.properties

@@ -9,7 +9,7 @@ demoA_httpPort=8101
 
 demoB_httpPort=8102
 
-version=0.3.3
+version=0.3.4
 
 springCloudVersion=2022.0.2
 springBootVersion=3.0.6

skr-common/src/main/java/org/skr/common/exception/AuthException.java

@@ -17,12 +17,17 @@
 
 import org.springframework.security.core.AuthenticationException;
 
+import java.io.Serial;
+
 /**
  * @author <a href="https://github.com/hank-cp">Hank CP</a>
  */
 public class AuthException extends AuthenticationException {
 
-    private ErrorInfo errorInfo;
+    @Serial
+    private static final long serialVersionUID = -1412637398991745466L;
+
+    private final ErrorInfo errorInfo;
 
     public AuthException(ErrorInfo errorInfo) {
         super(errorInfo.getMessage());

skr-common/src/main/java/org/skr/common/exception/PermissionException.java

@@ -17,12 +17,17 @@
 
 import org.springframework.security.core.AuthenticationException;
 
+import java.io.Serial;
+
 /**
  * @author <a href="https://github.com/hank-cp">Hank CP</a>
  */
 public class PermissionException extends AuthenticationException {
 
-    private ErrorInfo errorInfo;
+    @Serial
+    private static final long serialVersionUID = -723686741252944458L;
+
+    private final ErrorInfo errorInfo;
 
     public PermissionException(ErrorInfo errorInfo) {
         super(errorInfo.getMessage());

skr-common/src/main/java/org/skr/common/exception/ValidationException.java

@@ -15,8 +15,10 @@
  */
 package org.skr.common.exception;
 
+import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 
+import java.io.Serial;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -27,9 +29,17 @@
  */
 public class ValidationException extends RuntimeException {
 
+    @Serial
+    private static final long serialVersionUID = 2607643356290543387L;
+
     private final List<ErrorInfo> errorInfos;
 
-    public ValidationException(@NotNull List<ErrorInfo> errorInfos) {
+    public ValidationException(@NotNull ErrorInfo errorInfo) {
+        super(errorInfo.getMessage());
+        this.errorInfos = List.of(errorInfo);
+    }
+
+    public ValidationException(@NotEmpty List<ErrorInfo> errorInfos) {
         super(errorInfos.stream()
                 .map(ErrorInfo::getMessage)
                 .collect(Collectors.joining("\n")));

skr-common/src/main/java/org/skr/config/EnumLabelMessageSource.java

@@ -18,44 +18,28 @@
 import org.skr.SkrProperties;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.autoconfigure.context.MessageSourceProperties;
 import org.springframework.context.support.ResourceBundleMessageSource;
 import org.springframework.stereotype.Component;
 import org.springframework.util.StringUtils;
 
-import java.time.Duration;
+import java.nio.charset.StandardCharsets;
 
 /**
  * @author <a href="https://github.com/hank-cp">Hank CP</a>
  */
 @Component
 public class EnumLabelMessageSource extends ResourceBundleMessageSource implements InitializingBean {
 
-    @Autowired(required = false)
-    private MessageSourceProperties messageSourceProperties;
-
     @Autowired
     private SkrProperties skrProperties;
 
     @Override
     public void afterPropertiesSet() {
-        if (messageSourceProperties == null) {
-            messageSourceProperties = new MessageSourceProperties();
-        }
-
         if (StringUtils.hasText(skrProperties.getEnumLabelPropBasename())) {
             setBasenames(StringUtils
                     .commaDelimitedListToStringArray(StringUtils.trimAllWhitespace(skrProperties.getEnumLabelPropBasename())));
         }
-        if (messageSourceProperties.getEncoding() != null) {
-            setDefaultEncoding(messageSourceProperties.getEncoding().name());
-        }
-        setFallbackToSystemLocale(messageSourceProperties.isFallbackToSystemLocale());
-        Duration cacheDuration = messageSourceProperties.getCacheDuration();
-        if (cacheDuration != null) {
-            setCacheMillis(cacheDuration.toMillis());
-        }
-        setAlwaysUseMessageFormat(messageSourceProperties.isAlwaysUseMessageFormat());
-        setUseCodeAsDefaultMessage(messageSourceProperties.isUseCodeAsDefaultMessage());
+        setDefaultEncoding(StandardCharsets.UTF_8.name());
+        setUseCodeAsDefaultMessage(true);
     }
 }

skr-common/src/main/java/org/skr/config/ErrorMessageSource.java

@@ -18,44 +18,28 @@
 import org.skr.SkrProperties;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.autoconfigure.context.MessageSourceProperties;
 import org.springframework.context.support.ResourceBundleMessageSource;
 import org.springframework.stereotype.Component;
 import org.springframework.util.StringUtils;
 
-import java.time.Duration;
+import java.nio.charset.StandardCharsets;
 
 /**
  * @author <a href="https://github.com/hank-cp">Hank CP</a>
  */
 @Component
 public class ErrorMessageSource extends ResourceBundleMessageSource implements InitializingBean {
 
-    @Autowired(required = false)
-    private MessageSourceProperties messageSourceProperties;
-
     @Autowired
     private SkrProperties skrProperties;
 
     @Override
     public void afterPropertiesSet() {
-        if (messageSourceProperties == null) {
-            messageSourceProperties = new MessageSourceProperties();
-        }
-
         if (StringUtils.hasText(skrProperties.getErrorMsgPropBasename())) {
             setBasenames(StringUtils
                     .commaDelimitedListToStringArray(StringUtils.trimAllWhitespace(skrProperties.getErrorMsgPropBasename())));
         }
-        if (messageSourceProperties.getEncoding() != null) {
-            setDefaultEncoding(messageSourceProperties.getEncoding().name());
-        }
-        setFallbackToSystemLocale(messageSourceProperties.isFallbackToSystemLocale());
-        Duration cacheDuration = messageSourceProperties.getCacheDuration();
-        if (cacheDuration != null) {
-            setCacheMillis(cacheDuration.toMillis());
-        }
-        setAlwaysUseMessageFormat(messageSourceProperties.isAlwaysUseMessageFormat());
-        setUseCodeAsDefaultMessage(messageSourceProperties.isUseCodeAsDefaultMessage());
+        setDefaultEncoding(StandardCharsets.UTF_8.name());
+        setUseCodeAsDefaultMessage(true);
     }
 }

skr-common/src/main/resources/skr-enum.properties

@@ -2,6 +2,7 @@ ErrorLevel.warn=Warning
 ErrorLevel.error=Error
 ErrorLevel.fatal=Fatal
 
+PermissionResult=Permission Checking Result
 PermissionResult.0=Permission Granted
 PermissionResult.1=Permission Denied
 PermissionResult.2=Permission limited