feat: 消息码配置

Author: ElanYoung

spring-boot-base-core/src/main/java/com/starimmortal/core/aop/ResultAspect.java

@@ -0,0 +1,37 @@
+package com.starimmortal.core.aop;
+
+import com.starimmortal.core.configuration.CodeMessageConfiguration;
+import com.starimmortal.core.vo.ResponseVO;
+import org.aspectj.lang.annotation.AfterReturning;
+import org.aspectj.lang.annotation.Aspect;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.util.StringUtils;
+
+/**
+ * 处理返回结果为 UnifyResponseVO 的控制器层方法
+ * message 默认为 null，在此处通过 code 设置为对应消息
+ *
+ * @author william@StarImmortal
+ * @date 2021/02/08
+ */
+@Aspect
+@Component
+public class ResultAspect {
+
+ @Autowired
+ private CodeMessageConfiguration codeMessageConfiguration;
+
+ @AfterReturning(returning = "result", pointcut = "execution(public * com.starimmortal..controller..*.*(..))")
+ public void doAfterReturning(ResponseVO<String> result) {
+ int code = result.getCode();
+ String oldMessage = result.getMessage();
+ // code-message.properties 中配置的 message
+ String newMessage = codeMessageConfiguration.getMessage(code);
+ // 如果 code-message.properties 中指定了相应的 message 并且 UnifyResponseVO 的 message 为null
+ // 则使用 newMessage 替换 oldMessage
+ if (StringUtils.hasText(newMessage) && !StringUtils.hasText(oldMessage)) {
+ result.setMessage(newMessage);
+ }
+ }
+}

spring-boot-base-core/src/main/java/com/starimmortal/core/configuration/CodeMessageConfiguration.java

@@ -0,0 +1,28 @@
+package com.starimmortal.core.configuration;
+
+import lombok.Getter;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.PropertySource;
+import org.springframework.stereotype.Component;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * 消息码配置类
+ *
+ * @author william@StarImmortal
+ * @date 2021/02/08
+ */
+@SuppressWarnings("ConfigurationProperties")
+@ConfigurationProperties
+@PropertySource(value = "classpath:code-message.properties", encoding = "UTF-8")
+@Component
+@Getter
+public class CodeMessageConfiguration {
+ private final Map<Integer, String> codeMessage = new HashMap<>();
+
+ public String getMessage(Integer code) {
+ return codeMessage.get(code);
+ }
+}

spring-boot-base-core/src/main/resources/code-message.properties

@@ -0,0 +1,54 @@
+code-message[0] = ok
+code-message[1] = \u521B\u5EFA\u6210\u529F
+code-message[2] = \u66F4\u65B0\u6210\u529F
+code-message[3] = \u5220\u9664\u6210\u529F
+code-message[4] = \u53D6\u6D88\u6210\u529F
+code-message[5] = \u6CE8\u518C\u6210\u529F
+code-message[9999] = \u670D\u52A1\u5668\u672A\u77E5\u5F02\u5E38
+
+code-message[10000] = \u672A\u643A\u5E26\u4EE4\u724C
+code-message[10001] = \u672A\u767B\u5F55\uFF0C\u8BF7\u5148\u767B\u5F55
+code-message[10002] = \u6743\u9650\u4E0D\u8DB3
+code-message[10003] = \u8BA4\u8BC1\u5931\u8D25
+code-message[10010] = \u6388\u6743\u5931\u8D25
+code-message[10011] = \u66F4\u65B0\u5BC6\u7801\u5931\u8D25
+code-message[10012] = \u8BF7\u4F20\u5165\u8BA4\u8BC1\u5934\u5B57\u6BB5
+code-message[10013] = \u8BA4\u8BC1\u5934\u5B57\u6BB5\u89E3\u6790\u5931\u8D25
+code-message[10020] = \u8D44\u6E90\u4E0D\u5B58\u5728
+code-message[10021] = \u7528\u6237\u4E0D\u5B58\u5728
+code-message[10022] = \u89D2\u8272\u4E0D\u5B58\u5728
+code-message[10025] = \u627E\u4E0D\u5230\u76F8\u5E94\u7684\u89C6\u56FE\u5904\u7406\u5668
+code-message[10026] = \u672A\u627E\u5230\u6587\u4EF6
+code-message[10030] = \u53C2\u6570\u9519\u8BEF
+code-message[10031] = \u7528\u6237\u540D\u6216\u5BC6\u7801\u9519\u8BEF
+code-message[10032] = \u5BC6\u7801\u6821\u9A8C\u5931\u8D25
+code-message[10033] = \u9A8C\u8BC1\u7801\u9519\u8BEF
+code-message[10034] = \u624B\u673A\u683C\u5F0F\u6821\u9A8C\u5931\u8D25
+code-message[10035] = \u624B\u673A\u53F7\u9519\u8BEF
+code-message[10040] = \u4EE4\u724C\u5931\u6548
+code-message[10041] = access token \u635F\u574F
+code-message[10042] = refresh token \u635F\u574F
+code-message[10050] = \u4EE4\u724C\u8FC7\u671F
+code-message[10051] = access token \u8FC7\u671F
+code-message[10052] = refresh token \u8FC7\u671F
+code-message[10060] = \u5B57\u6BB5\u91CD\u590D
+code-message[10070] = \u7981\u6B62\u64CD\u4F5C
+code-message[10071] = \u7528\u6237\u540D\u5DF2\u88AB\u4F7F\u7528\uFF0C\u8BF7\u91CD\u65B0\u8F93\u5165\u65B0\u7684\u7528\u6237\u540D
+code-message[10072] = \u90AE\u7BB1\u5DF2\u88AB\u4F7F\u7528\uFF0C\u8BF7\u91CD\u65B0\u586B\u5165\u65B0\u7684\u90AE\u7BB1
+code-message[10073] = \u624B\u673A\u53F7\u5DF2\u88AB\u4F7F\u7528\uFF0C\u8BF7\u91CD\u65B0\u586B\u5165\u65B0\u7684\u624B\u673A\u53F7
+code-message[10080] = \u8BF7\u6C42\u65B9\u6CD5\u4E0D\u5141\u8BB8
+code-message[10100] = \u5237\u65B0\u4EE4\u724C\u83B7\u53D6\u5931\u8D25
+code-message[10110] = \u6587\u4EF6\u4F53\u79EF\u8FC7\u5927
+code-message[10120] = \u6587\u4EF6\u6570\u91CF\u8FC7\u591A
+code-message[10121] = \u6587\u4EF6\u592A\u591A\uFF0C\u6587\u4EF6\u603B\u6570\u4E0D\u53EF\u8D85\u8FC7${file.nums}
+code-message[10130] = \u6587\u4EF6\u6269\u5C55\u540D\u4E0D\u7B26\u5408\u89C4\u8303
+code-message[10131] = \u6587\u4EF6\u7C7B\u578B\u6682\u4E0D\u652F\u6301
+code-message[10140] = \u8BF7\u6C42\u8FC7\u4E8E\u9891\u7E41\uFF0C\u8BF7\u7A0D\u540E\u91CD\u8BD5
+code-message[10141] = \u77ED\u4FE1\u9A8C\u8BC1\u7801\u53D1\u9001\u592A\u9891\u7E41
+code-message[10142] = \u77ED\u4FE1\u9A8C\u8BC1\u7801\u9519\u8BEF\u6B21\u6570\u8D85\u9650\uFF0C\u8BF7\u4E00\u5C0F\u65F6\u540E\u518D\u8BD5
+code-message[10150] = \u4E22\u5931\u53C2\u6570
+code-message[10160] = \u7C7B\u578B\u9519\u8BEF
+code-message[10170] = \u8BF7\u6C42\u4F53\u4E0D\u53EF\u4E3A\u7A7A
+code-message[10180] = \u5355\u6587\u4EF6\u5927\u5C0F\u4E0D\u80FD\u8D85\u8FC7${file.max-file-size}\uFF0C\u8BF7\u6C42\u5927\u5C0F\u4E0D\u80FD\u8D85\u8FC7${file.max-request-size}
+code-message[10190] = \u8BFB\u53D6\u6587\u4EF6\u6570\u636E\u5931\u8D25
+code-message[10200] = \u5931\u8D25