配置国际化资源目录

在application.yml里配置message的目录

  1. spring:
  2.   messages:
  3.     encoding: UTF-8
  4.     basename: i18n/msg

image.png
这里我配置在resource目录下的/i18n/msg，里面每个msg.properties就是不同语言对应的消息文字。

定义全局异常消息国际化

我们可以自定义一种抽象异常父类，需要给出国际化消息提示的时候，传入消息的key，然后自动返回国际化的提示。
如果你想要你的异常可以进行国际化的提示，继承这个国际化类就OK。

  1. public abstract class LocalizationException extends RuntimeException {
  3.     private static final long serialVersionUID = 7718379187319837197L;
  5.     private static MessageSource messageSource;
  7.     public LocalizationException(String messageKey, String... messageArguments) {
  8.         this(getMessage(messageKey, messageArguments), null, messageKey, messageArguments);
  9.     }
  12.     public static MessageSource getMessageSource() {
  13.         return messageSource;
  14.     }
  16.     public static void setMessageSource(MessageSource messageSource) {
  17.         LocalizationException.messageSource = messageSource;
  18.     }
  20.     private final String messageKey;
  21.     private final String[] messageArguments;
  23.     public LocalizationException(String systemErrorMessage, Throwable cause, String messageKey,
  24.                                  String... messageArguments) {
  25.         super(systemErrorMessage, cause);
  27.         this.messageKey = messageKey;
  28.         this.messageArguments = messageArguments;
  29.     }
  31.     LocalizationException(String systemErrorMessage, String messageKey, String... messageArguments) {
  32.         this(systemErrorMessage, null, messageKey, messageArguments);
  33.     }
  35.     LocalizationException(Throwable cause, String messageKey, String... messageArguments) {
  36.         this(cause.getMessage(), cause, messageKey, messageArguments);
  37.     }
  39.     LocalizationException(Throwable cause) {
  40.         super(cause);
  41.         this.messageKey = null;
  42.         this.messageArguments = null;
  43.     }
  45.     /**
  46.      * @return the messageKey - the key to lookup up in the localized resource bundles, such as
  47.      * 'user.not.found'.
  48.      */
  49.     public String getMessageKey() {
  50.         return messageKey;
  51.     }
  53.     /**
  54.      * @return the messageArguments - - an array of arguments that will be filled in for params
  55.      * within the message (params look like "{0}", "{1,date}", "{2,time}" within a message),
  56.      * or <code>null</code> if none.
  57.      */
  58.     public Object[] getMessageArguments() {
  59.         return messageArguments;
  60.     }
  62.     @Override
  63.     public String getMessage() {
  64.         if (StringUtils.isNotBlank(getMessageKey())) {
  65.             return messageSource.getMessage(getMessageKey(), getMessageArguments(), getMessageKey(),
  66.                     LocaleContextHolder.getLocale());
  67.         } else {
  68.             return super.getMessage();
  69.         }
  70.     }
  72.     private static String getMessage(String messageKey, String... messageArguments) {
  73.         if (StringUtils.isNotBlank(messageKey)) {
  74.             return messageSource.getMessage(messageKey, messageArguments, messageKey, LocaleContextHolder.getLocale());
  75.         } else {
  76.             return messageKey;
  77.         }
  78.     }
  79. }

这里本地化异常LocalizationException里包含了MessageSource国际化资源对象，最终通过把国际化消息的key和arguments传递给messageSource获得国际化的消息。
下面定义一个授权异常子类实现本地化异常父类：

  1. public class AuthException extends LocalizationException {
  2.     public AuthException(String messageKey, String... messageArguments) {
  3.         super(messageKey, messageArguments);
  4.     }
  5. }

之后我们把异常的Key全局统一管理起来，写到一个接口常量中。

  1. public interface ExceptionCode {
  3.     String ERROR_JWT_INVALID_SIGNATURE = "error.jwt.invalid.signature";
  5.     String ERROR_JWT_INVALID_TOKEN = "error.jwt.invalid.token";
  6. }

配置全局异常拦截

上一步实现了全局异常的消息国际化，下一步配置全局国际化异常的拦截处理。

  1. @Slf4j
  2. @RestControllerAdvice
  3. public class GlobalExceptionHandler {
  5.     /**
  6.      * 拦截国际化异常
  7.      * @param e
  8.      * @return
  9.      */
  10.     @ExceptionHandler(value = {LocalizationException.class})
  11.     public Result baseException(LocalizationException e) {
  12.         log.error("LocalizationException:{}", e.getMessage());
  13.         return Result.fail(e.getMessage());
  14.     }
  16.      /**
  17.      * 拦截RuntimeException
  18.      * @param ex
  19.      * @return
  20.      */
  21.     @ExceptionHandler(value = {RuntimeException.class})
  22.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  23.     public Result runtimeException(RuntimeException ex) {
  24.         log.error("exception:", ex);
  25.         return Result.fail(ExceptionUtils.getMessage(ex));
  26.     }
  28.     /**
  29.      * 拦截Exception
  30.      * @param ex
  31.      * @return
  32.      */
  33.     @ExceptionHandler(value = {Exception.class})
  34.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  35.     public Result exception(Exception ex) {
  36.         log.error("exception:", ex);
  37.         return Result.fail(ApiErrorCode.FAILED.getMsg());
  38.     }
  40.     /**
  41.      * 在调用RPC、二方包、或动态生成类的相关方法
  42.      * @param throwable
  43.      * @return
  44.      */
  45.     @ExceptionHandler(value = {Throwable.class})
  46.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  47.     public Result throwable(Throwable throwable) {
  48.         log.error("throwable:", throwable);
  49.         return Result.fail(ApiErrorCode.FAILED.getMsg());
  50.     }
  51. }

重点在于@RestControllerAdvice注解和@ExceptionHandler进行拦截异常。如果没有拦截到的异常可以使用Exception异常兜底。

配置 messageSource Bean

然后我们需要将messageSource配置Bean，并注入到LocalizationException的静态变量messageSource中使用。

  1. @Configuration
  2. public class MessageConfig {
  4.     /**
  5.      * 静态注入messageSource到LocalizationException中
  6.      */
  7.     @Bean
  8.     @Autowired
  9.     public MethodInvokingFactoryBean methodInvokingFactoryBean(MessageSource messageSource) {
  10.         MethodInvokingFactoryBean methodInvokingFactoryBean = new MethodInvokingFactoryBean();
  11.         methodInvokingFactoryBean.setTargetClass(LocalizationException.class);
  12.         methodInvokingFactoryBean.setTargetMethod("setMessageSource");
  13.         methodInvokingFactoryBean.setArguments(messageSource);
  14.         return methodInvokingFactoryBean;
  15.     }
  17.     /**
  18.      * 自定义messageSource文件的位置,更灵活，此方法可不写，因为application.yml已经配置了
  19.      */
  20.     @Bean
  21.     public ReloadableResourceBundleMessageSource messageSource() {
  22.         ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
  24.         messageSource.setBasename("classpath:/i18n/msg");
  25.         // 设置缓存加载的属性文件的秒数,-1表示要永久缓存（与java.util.ResourceBundle的默认行为匹配）
  26.         messageSource.setCacheSeconds(10);
  27.         messageSource.setDefaultEncoding(StandardCharsets.UTF_8);
  29.         return messageSource;
  30.     }
  31. }

ReloadableResourceBundleMessageSource的继承结构：image.png

使用国际化异常消息提示

当我们想要使用异常消息国际化提示的时候，比如使用上面定义的AuthException，
只需要如下操作：

  1.  throw new AuthException(ExceptionCode.ERROR_JWT_INVALID_SIGNATURE);

可以看到抛出的异常消息最终被国际化，我们将国际化消息的提取封装在了LocalizationException中。