优化说明

hsweb-commons/hsweb-commons-crud/src/main/java/org/hswebframework/web/crud/web/CommonErrorControllerAdvice.java

@@ -7,6 +7,7 @@ import org.hswebframework.web.authorization.exception.AuthenticationException;
 import org.hswebframework.web.authorization.exception.UnAuthorizedException;
 import org.hswebframework.web.authorization.token.TokenState;
 import org.hswebframework.web.exception.BusinessException;
+import org.hswebframework.web.exception.I18nSupportException;
 import org.hswebframework.web.exception.NotFoundException;
 import org.hswebframework.web.exception.ValidationException;
 import org.hswebframework.web.i18n.LocaleUtils;
@@ -255,4 +256,13 @@ public class CommonErrorControllerAdvice {
                                   (err, msg) -> ResponseMessage.error(400, "illegal_argument", msg));
     }
 
+    @ExceptionHandler
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    public Mono<ResponseMessage<Object>> handleException(I18nSupportException e) {
+        return LocaleUtils
+                .resolveThrowable(messageSource,
+                                  e,
+                                  (err, msg) -> ResponseMessage.error(400, err.getCode(), msg));
+    }
+
 }

hsweb-core/src/main/java/org/hswebframework/web/dict/I18nEnumDict.java

@@ -10,7 +10,7 @@ package org.hswebframework.web.dict;
  * @AllArgsConstructor
  * @Getter
  * @Dict("device-state")
- * public enum DeviceState implements I18nEnumDict<String> {
+ * public enum DeviceState implements I18nEnumDict&lt;String&gt; {
  *     notActive("未启用"),
  *     offline("离线"),
  *     online("在线");
@@ -21,6 +21,7 @@ package org.hswebframework.web.dict;
  *     public String getValue() {
  *         return name();
  *     }
+ *   }
  * </pre>
  * <p>
  * 在resources下添加文件: <code>i18n/{path}/{name}_zh_CN.properties</code>

hsweb-core/src/main/java/org/hswebframework/web/i18n/LocaleUtils.java

@@ -41,12 +41,12 @@ public class LocaleUtils {
     }
 
     /**
-     * 在指定的语言环境中执行函数,<b>只能</b>在非响应式同步操作时使用,如：转换实体类中某些属性的国际化消息。
+     * 在指定的区域中执行函数,<b>只能</b>在非响应式同步操作时使用,如：转换实体类中某些属性的国际化消息。
      * <p>
      * 在函数的逻辑中可以通过{@link LocaleUtils#current()}来获取当前语言.
      *
      * @param data   参数
-     * @param locale 语言地区
+     * @param locale 区域
      * @param mapper 函数
      * @param <T>    参数类型
      * @param <R>    函数返回类型
@@ -61,10 +61,12 @@ public class LocaleUtils {
         }
     }
 
-    public static Function<Context, Context> useLocale(Locale locale) {
-        return ctx -> ctx.put(Locale.class, locale);
-    }
-
+    /**
+     * 使用指定的区域来执行某些操作
+     *
+     * @param locale   区域
+     * @param consumer 任务
+     */
     public static void doWith(Locale locale, Consumer<Locale> consumer) {
         try {
             CONTEXT_THREAD_LOCAL.set(locale);
@@ -75,9 +77,24 @@ public class LocaleUtils {
     }
 
     /**
-     * 响应式方式获取当前语言地区
+     * 在响应式作用,使用指定的区域作为语言环境,在下游则可以使用{@link LocaleUtils#currentReactive()}来获取
+     * <p>
+     * <pre>
+     * monoOrFlux
+     * .subscriberContext(LocaleUtils.useLocale(locale))
+     * </pre>
+     *
+     * @param locale 区域
+     * @return 上下为构造函数
+     */
+    public static Function<Context, Context> useLocale(Locale locale) {
+        return ctx -> ctx.put(Locale.class, locale);
+    }
+
+    /**
+     * 响应式方式获取当前区域
      *
-     * @return 语言地区
+     * @return 区域
      */
     @SuppressWarnings("all")
     public static Mono<Locale> currentReactive() {
@@ -86,33 +103,96 @@ public class LocaleUtils {
                 .map(ctx -> ctx.getOrDefault(Locale.class, DEFAULT_LOCALE));
     }
 
-    public static <T> void onNext(Signal<T> signal, BiConsumer<T, Locale> consumer) {
-        if (signal.getType() != SignalType.ON_NEXT) {
-            return;
-        }
-        Locale locale = signal.getContext().getOrDefault(Locale.class, DEFAULT_LOCALE);
-
-        doWith(locale, l -> consumer.accept(signal.get(), l));
-
-    }
-
+    /**
+     * 响应式方式解析出异常的区域消息，并进行结果转换.
+     * <p>
+     *
+     * <pre>
+     * LocaleUtils
+     *  .resolveThrowable(error,(err,msg)-> createResponse(err,msg) );
+     * </pre>
+     *
+     * @param source 异常
+     * @param mapper 结果转换器
+     * @param <S>    异常类型
+     * @param <R>    转换结果类型
+     * @return 转换后的结果
+     * @see LocaleUtils#doWithReactive(Object, Function, BiFunction, Object...)
+     */
     public static <S extends I18nSupportException, R> Mono<R> resolveThrowable(S source,
                                                                                BiFunction<S, String, R> mapper) {
         return resolveThrowable(messageSource, source, mapper);
     }
 
+    /**
+     * 指定消息源,响应式方式解析出异常的区域消息，并进行结果转换.
+     * <p>
+     *
+     * <pre>
+     * LocaleUtils
+     *  .resolveThrowable(source,error,(err,msg)-> createResponse(err,msg) );
+     * </pre>
+     *
+     * @param messageSource 消息源
+     * @param source        异常
+     * @param mapper        结果转换器
+     * @param <S>           异常类型
+     * @param <R>           转换结果类型
+     * @return 转换后的结果
+     * @see LocaleUtils#doWithReactive(Object, Function, BiFunction, Object...)
+     */
     public static <S extends I18nSupportException, R> Mono<R> resolveThrowable(MessageSource messageSource,
                                                                                S source,
                                                                                BiFunction<S, String, R> mapper) {
         return doWithReactive(messageSource, source, I18nSupportException::getCode, mapper, source.getArgs());
     }
 
+    /**
+     * 使用参数,响应式方式解析出异常的区域消息，并进行结果转换.
+     * <p>
+     * 参数对应消息模版中的{n}
+     * <p>
+     *
+     * <pre>
+     * LocaleUtils
+     *  .resolveThrowable(source,error,(err,msg)-> createResponse(err,msg) );
+     * </pre>
+     *
+     * @param source 异常
+     * @param mapper 结果转换器
+     * @param args   参数
+     * @param <S>    异常类型
+     * @param <R>    转换结果类型
+     * @return 转换后的结果
+     * @see LocaleUtils#doWithReactive(Object, Function, BiFunction, Object...)
+     * @see java.text.MessageFormat
+     */
     public static <S extends Throwable, R> Mono<R> resolveThrowable(S source,
                                                                     BiFunction<S, String, R> mapper,
                                                                     Object... args) {
         return resolveThrowable(messageSource, source, mapper, args);
     }
 
+    /**
+     * 使用参数,指定消息源,响应式方式解析出异常的区域消息，并进行结果转换.
+     * <p>
+     * 参数对应消息模版中的{n}
+     * <p>
+     *
+     * <pre>
+     * LocaleUtils
+     *  .resolveThrowable(source,error,(err,msg)-> createResponse(err,msg) );
+     * </pre>
+     *
+     * @param source 异常
+     * @param mapper 结果转换器
+     * @param args   参数
+     * @param <S>    异常类型
+     * @param <R>    转换结果类型
+     * @return 转换后的结果
+     * @see LocaleUtils#doWithReactive(Object, Function, BiFunction, Object...)
+     * @see java.text.MessageFormat
+     */
     public static <S extends Throwable, R> Mono<R> resolveThrowable(MessageSource messageSource,
                                                                     S source,
                                                                     BiFunction<S, String, R> mapper,
@@ -120,6 +200,18 @@ public class LocaleUtils {
         return doWithReactive(messageSource, source, Throwable::getMessage, mapper, args);
     }
 
+    /**
+     * 在响应式环境中处理区域消息并转换为新的结果
+     *
+     * @param source  数据
+     * @param message 消息转换
+     * @param mapper  数据转换
+     * @param args    参数
+     * @param <S>     数据类型
+     * @param <R>     结果类型
+     * @return 转换结果
+     * @see java.text.MessageFormat
+     */
     public static <S, R> Mono<R> doWithReactive(S source,
                                                 Function<S, String> message,
                                                 BiFunction<S, String, R> mapper,
@@ -127,6 +219,18 @@ public class LocaleUtils {
         return doWithReactive(messageSource, source, message, mapper, args);
     }
 
+    /**
+     * 指定消息源，在响应式环境中处理区域消息并转换为新的结果
+     *
+     * @param source  数据
+     * @param message 消息转换
+     * @param mapper  数据转换
+     * @param args    参数
+     * @param <S>     数据类型
+     * @param <R>     结果类型
+     * @return 转换结果
+     * @see java.text.MessageFormat
+     */
     public static <S, R> Mono<R> doWithReactive(MessageSource messageSource,
                                                 S source,
                                                 Function<S, String> message,
@@ -140,6 +244,14 @@ public class LocaleUtils {
                 });
     }
 
+    /**
+     * 使用指定的消息源，响应式方式解析消息
+     *
+     * @param messageSource 消息源
+     * @param code          消息编码
+     * @param args          参数
+     * @return 解析后的消息
+     */
     public static Mono<String> resolveMessageReactive(MessageSource messageSource,
                                                       String code,
                                                       Object... args) {
@@ -147,6 +259,15 @@ public class LocaleUtils {
                 .map(locale -> resolveMessage(messageSource, locale, code, code, args));
     }
 
+    /**
+     * 解析消息
+     *
+     * @param code           消息编码
+     * @param locale         地区
+     * @param defaultMessage 默认消息
+     * @param args           参数
+     * @return 解析后的消息
+     */
     public static String resolveMessage(String code,
                                         Locale locale,
                                         String defaultMessage,
@@ -154,6 +275,16 @@ public class LocaleUtils {
         return resolveMessage(messageSource, locale, code, defaultMessage, args);
     }
 
+    /**
+     * 使用指定的消息源解析消息
+     *
+     * @param messageSource
+     * @param code           消息编码
+     * @param locale         地区
+     * @param defaultMessage 默认消息
+     * @param args           参数
+     * @return 解析后的消息
+     */
     public static String resolveMessage(MessageSource messageSource,
                                         Locale locale,
                                         String code,
@@ -162,16 +293,38 @@ public class LocaleUtils {
         return messageSource.getMessage(code, args, defaultMessage, locale);
     }
 
+    /**
+     * 使用默认消息源和当前地区解析消息
+     *
+     * @param code 消息编码
+     * @param args 参数
+     * @return 解析后的消息
+     */
     public static String resolveMessage(String code, Object... args) {
         return resolveMessage(messageSource, current(), code, code, args);
     }
 
+    /**
+     * 使用默认消息源和当前地区解析消息
+     *
+     * @param code           消息编码
+     * @param args           参数
+     * @param defaultMessage 默认消息
+     * @return 解析后的消息
+     */
     public static String resolveMessage(String code,
                                         String defaultMessage,
                                         Object... args) {
         return resolveMessage(messageSource, current(), code, defaultMessage, args);
     }
 
+    /**
+     * 使用指定消息源和当前地区解析消息
+     *
+     * @param code 消息编码
+     * @param args 参数
+     * @return 解析后的消息
+     */
     public static String resolveMessage(MessageSource messageSource,
                                         String code,
                                         String defaultMessage,
@@ -179,4 +332,32 @@ public class LocaleUtils {
         return resolveMessage(messageSource, current(), code, defaultMessage, args);
     }
 
+
+    /**
+     * 在响应式中获取区域并执行指定的操作
+     *
+     * @param operation 操作
+     * @param <T>       元素类型
+     */
+    public static <T> Consumer<Signal<T>> on(SignalType type, BiConsumer<Signal<T>, Locale> operation) {
+        return signal -> {
+            if (signal.getType() != type) {
+                return;
+            }
+            Locale locale = signal.getContext().getOrDefault(Locale.class, DEFAULT_LOCALE);
+
+            doWith(locale, l -> operation.accept(signal, l));
+        };
+    }
+
+    /* SignalType.ON_NEXT */
+    public static <T> Consumer<Signal<T>> onNext(BiConsumer<T, Locale> operation) {
+        return on(SignalType.ON_NEXT, (s, l) -> operation.accept(s.get(), l));
+    }
+
+    /* SignalType.ON_ERROR */
+    public static <T> Consumer<Signal<T>> onError(BiConsumer<Throwable, Locale> operation) {
+        return on(SignalType.ON_ERROR, (s, l) -> operation.accept(s.getThrowable(), l));
+    }
+
 }