devbox
我家自动化
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

SpringController返回值和异常自动包装

作者：我家自动化 | 2024-03-13 17:02:15

赞

踩

SpringController返回值和异常自动包装

今天遇到一个需求，在不改动原系统代码的情况下。将Controller的返回值和异常包装到一个统一的返回对象中去。

例如原系统的接口

public String myIp(@ApiIgnore HttpServletRequest request);

返回的只是一个IP字符串"0:0:0:0:0:0:0:1"，目前接口需要包装为：

{"code":200,"message":"","result":"0:0:0:0:0:0:0:1","success":true}

而原异常跳转到error页面，需要调整为

{
  "success": false,
  "message": "For input string: \"fdsafddfs\"",
  "code": 500,
  "result": "message"
}

因此就有了2个工作子项需要完成：

1）Exception的处理

2）controller return值的处理

Exception的自动包装

返回的exception处理可以采用@RestControllerAdvice来处理。

建立自己的Advice类，注入国际化资源（异常需要支持多语言）
 

  1. package org.ccframe.commons.mvc;
  2.  
  3. import lombok.extern.log4j.Log4j2;
  4. import org.apache.commons.lang3.StringUtils;
  5. import org.apache.http.HttpStatus;
  6. import org.ccframe.commons.filter.CcRequestLoggingFilter;
  7. import org.ccframe.commons.util.BusinessException;
  8. import org.ccframe.config.GlobalEx;
  9. import org.ccframe.subsys.core.dto.Result;
  10. import org.springframework.context.MessageSource;
  11. import org.springframework.context.NoSuchMessageException;
  12. import org.springframework.core.MethodParameter;
  13. import org.springframework.http.ResponseEntity;
  14. import org.springframework.orm.ObjectOptimisticLockingFailureException;
  15. import org.springframework.web.HttpRequestMethodNotSupportedException;
  16. import org.springframework.web.bind.annotation.*;
  17. import org.springframework.web.context.request.NativeWebRequest;
  18. import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
  19. import org.springframework.web.method.support.ModelAndViewContainer;
  20. import org.springframework.web.multipart.MaxUploadSizeExceededException;
  21. import org.springframework.web.servlet.LocaleResolver;
  22. import org.springframework.web.servlet.NoHandlerFoundException;
  23.  
  24. import javax.servlet.http.HttpServletRequest;
  25. import java.util.Locale;
  26.  
  27. @RestControllerAdvice
  28. @Log4j2
  29. public class GlobalRestControllerAdvice{
  30.  
  31.     private MessageSource messageSource; //国际化资源
  32.  
  33.     private LocaleResolver localeResolver;
  34.  
  35.     private Object[] EMPTY_ARGS = new Object[0];
  36.  
  37.     public GlobalRestControllerAdvice(MessageSource messageSource, LocaleResolver localeResolver){
  38.         this.messageSource = messageSource;
  39.         this.localeResolver = localeResolver;
  40.     }
  41.  
  42.     private Result<String> createError(HttpServletRequest request, Exception e,int code, String msgKey, Object[] args){
  43.         Locale currentLocale = localeResolver.resolveLocale(request);
  44.         String message = "";
  45.         try {
  46.             message = messageSource.getMessage(msgKey, args, currentLocale);
  47.         }catch (NoSuchMessageException ex){
  48.             message = e.getMessage();
  49.         }finally {
  50.             log.error(message);
  51.             CcRequestLoggingFilter.pendingLog(); //服务器可以记录出错时的请求啦
    声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/我家自动化/article/detail/229669
    推荐阅读
    相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。