SpringBoot2 国际化最佳实践

小鱼儿 2023-05-30 09:27 25阅读 0赞

一般情况下确实对应不到国际化, **但是无奈老板说, 我们要做国际化, 作为boss  drive  develop 的一员**, 还能有啥办法, 我也很绝望啊.,那就做呗.

其实很简单, 这里就以我们抛出的异常进行封装, 在英文和中文环境下两套不同的错误.

1. 新建项目

2.在resources 文件夹下建立 i18n文件夹, 放错误信息.

新建文件   error\_zh\_CN.properties   放置中文错误信息

新建文件  error\_en\_US.properties   放置中文错误信息

3. 新建配置类:

package com.curefun.core.config;
    
    import java.util.Locale;
    import java.util.ResourceBundle;
    import java.util.concurrent.ConcurrentHashMap;
    import org.springframework.context.annotation.PropertySource;
    import org.springframework.context.i18n.LocaleContextHolder;
    
    /*
     * 错误码文本获取
     * 在项目resources目录下新建i18n文件夹，错误码文本按语言类型划分文件，使用error开头，后跟语言编码，如error_zh_cn.properties,error_en_us.properties
     */
    @PropertySource(value = { "classpath:i18n/error*.properties" })
    public class ErrorCodeMessage {
    
    	private static ConcurrentHashMap<String, ResourceBundle> messages = new ConcurrentHashMap<String, ResourceBundle>();
    
    	/**
    	 * 获取错误码文本
    	 * @param key 错误码编码，如“10000”
    	 * @param params String.format()占位符对应文本
    	 * @return
    	 */
    	public static String getMessage(String key, Object... params) {
    		// 获取语言，这个语言是从header中的Accept-Language中获取的，
    		// 会根据Accept-Language的值生成符合规则的locale，如zh、pt、en等
    		Locale locale = LocaleContextHolder.getLocale();
    		ResourceBundle message = messages.get(locale.getLanguage());
    		if (null == message) {
    			synchronized (messages) {
    				// 在这里读取配置信息
    				message = messages.get(locale.getLanguage());
    				if (null == message) {
    					message = ResourceBundle.getBundle("i18n/error", locale);
    					messages.put(locale.getLanguage() + "_" + locale.getCountry(), message);
    				}
    			}
    		}
    		// 此处获取并返回message
    		if (null != params) {
    			return String.format(message.getString(key), params);
    		}
    		return message.getString(key);
    	}
    
    	/**
    	 * 清空错误文本缓存map
    	 */
    	public static void flushMessage() {
    		messages.clear();
    	}
    }

这里进行配置的加载, 进行信息的缓存,

在业务代码中只需要很简单的抛出异常就好了

public class BusinessException extends  RuntimeException {
    
        private String code;
    
        public BusinessException(String code) {
            super(ErrorCodeMessage.getMessage(code));
            this.code = code;
        }
    
        public BusinessException(String code, Object ...msgError) {
            super(ErrorCodeMessage.getMessage(code,msgError));
            this.code = code;
        }
    
    
        public String getCode() {
            return this.code;
        }
    
    
    }

最后一步, 定义一个全局的异常处理器

import com.alibaba.fastjson.JSONObject;
    import com.curefun.core.exception.BusinessException;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.MissingServletRequestParameterException;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RestControllerAdvice;
    
    
    /**
     * @author zk
     * @Description: 全局异常处理
     * @date 2019年10月29日15:08:35
     */
    @Slf4j
    @RestControllerAdvice
    public class ExceptionHandleController {
    
    
        /**
         * 处理参数异常
         *
         * @param ex
         */
        @ExceptionHandler(BusinessException.class)
        public JSONObject handleParamException(BusinessException ex) {
            JSONObject obj = new JSONObject();
            obj.put("code", ex.getCode());
            String message = ex.getMessage();
            obj.put("msg", message);
            obj.put("data", "");
            log.error("发生异常:{}",ex);
            return obj;
        }
    
    
        /**
         * 处理参数缺失异常
         *
         * @param ex
         */
        @ExceptionHandler(MissingServletRequestParameterException.class)
        public JSONObject handleMissParamException(BusinessException ex) {
            JSONObject obj = new JSONObject();
            obj.put("code", 15000);
            obj.put("msg", "缺少参数");
            obj.put("data", "缺少参数");
            log.error("发生异常:{}",ex);
            return obj;
        }
    
    
    
    
        @ExceptionHandler(Exception.class)
        public JSONObject handleException(Exception ex) {
            JSONObject obj = new JSONObject();
            obj.put("code", "15000");
            obj.put("msg", "服务内部错误");
            obj.put("data", "");
            ex.printStackTrace();
            log.error("发生异常:{}",ex.getCause());
            return obj;
        }
    
    }

好像我又水了一篇文章,  哈哈哈 ,  真容易,  果然花了5分钟写的文章 , 大概率是很水的文章.  凑合看下,  非常简单的总结