错误处理

SOP对错误处理已经封装好了，简单做法是throw ServiceException，在最顶层的Controller会做统一处理。例如：

  1. if(StringUtils.isEmpty(param.getGoods_name())) {
  2.     throw new ServiceException("goods_name不能为null");
  3. }

为了保证编码风格的一致性，推荐统一使用ServiceException

i18n国际化

SOP支持国际化消息。通过Request对象中的getLocale()来决定具体返回那种语言，客户端通过设置Accept-Language头部来决定返回哪种语言，中文是zh，英文是en。

SOP通过模块化来管理国际化消息，这样做的好处结构清晰，维护方便。下面就来讲解如何设置国际化消息。

以story服务为例，假设我们要对商品模块进行设置，步骤如下：

  • 在resource/i18n/isp目录下新建goods_error_zh_CN.properties属性文件

属性文件的文件名有规律， i18n/isp/goods_error 表示模块路径， _zh_CN.properties 表示中文错误消息。如果要使用英文错误，则新建一个goods_error_en.properties即可。

  • 在goods_error_zh_CN.properties中配置错误信息
  1. # 商品名字不能为空
  2. isp.goods_error_100=\u5546\u54C1\u540D\u79F0\u4E0D\u80FD\u4E3A\u7A7A

isp.goodserror为固定前缀，100为错误码，这两个值后续会用到。

接下来是把属性文件加载到国际化容器当中。

  • 添加国际化配置，在OpenServiceConfig中的static块中添加，代码如下：
  1. @Configuration
  2. public class OpenServiceConfig extends AlipayServiceConfiguration {
  4.     static {
  5.         ServiceConfig.getInstance().getI18nModules().add("i18n/isp/goods_error");
  6.     }
  7. }
  • 新建一个枚举用来定义错误
  1. // 按模块来定义异常消息,团队开发可以分开进行
  2. public enum  GoodsErrorEnum {
  3.     /** 参数错误 */
  4.     NO_GOODS_NAME("100"),
  5.     ;
  6.     private ServiceErrorMeta errorMeta;
  8.     StoryErrorEnum(String subCode) {
  9.         this.errorMeta = new ServiceErrorMeta("isp.goods_error_", subCode);
  10.     }
  12.     public ServiceErrorMeta getErrorMeta() {
  13.         return errorMeta;
  14.     }
  15. }

接下来就可以使用了

  1. if (StringUtils.isEmpty(param.getGoods_name())) {
  2.     throw GoodsErrorEnum.NO_GOODS_NAME.getErrorMeta().getException();
  3. }

国际化消息传参

即代码中变量传入到properties文件中去，做法是采用{0},{1}占位符。0代表第一个参数，1表示第二个参数。

  1. # 商品名称太短，不能小于{0}个字
  2. isp.goods_error_101=\u5546\u54C1\u540D\u79F0\u592A\u77ED\uFF0C\u4E0D\u80FD\u5C0F\u4E8E{0}\u4E2A\u5B57
  1. if (param.getGoods_name().length() <= 3) {
  2.     throw GoodsErrorEnum.LESS_GOODS_NAME_LEN.getErrorMeta().getException(3);
  3. }

直接放进getException(Object… params)方法参数中，因为是可变参数，可随意放。