Java自学者论坛

 找回密码
 立即注册

手机号码,快捷登录

恭喜Java自学者论坛(https://www.javazxz.com)已经为数万Java学习者服务超过8年了!积累会员资料超过10000G+
成为本站VIP会员,下载本站10000G+会员资源,会员资料板块,购买链接:点击进入购买VIP会员

JAVA高级面试进阶训练营视频教程

Java架构师系统进阶VIP课程

分布式高可用全栈开发微服务教程Go语言视频零基础入门到精通Java架构师3期(课件+源码)
Java开发全终端实战租房项目视频教程SpringBoot2.X入门到高级使用教程大数据培训第六期全套视频教程深度学习(CNN RNN GAN)算法原理Java亿级流量电商系统视频教程
互联网架构师视频教程年薪50万Spark2.0从入门到精通年薪50万!人工智能学习路线教程年薪50万大数据入门到精通学习路线年薪50万机器学习入门到精通教程
仿小米商城类app和小程序视频教程深度学习数据分析基础到实战最新黑马javaEE2.1就业课程从 0到JVM实战高手教程MySQL入门到精通教程
查看: 11358|回复: 0

springboot统一返回json数据格式并配置系统异常拦截

[复制链接]
  • TA的每日心情
    奋斗
    2024-11-24 15:47
  • 签到天数: 804 天

    [LV.10]以坛为家III

    2053

    主题

    2111

    帖子

    72万

    积分

    管理员

    Rank: 9Rank: 9Rank: 9

    积分
    726782
    发表于 2021-4-11 13:09:52 | 显示全部楼层 |阅读模式

    本文链接:https://blog.csdn.net/syystx/article/details/82870217
    通常进行前后端分离开发时我们需要定义统一的json数据交互格式并对系统未处理异常进行处理。以下具体介绍在springboot中的实现过程,通过该章节代码可实现框架统一异常处理,并当后台接口反馈类型不为统一格式时能够进行重新包装成统一格式进行返回。

    具体实现如下:

    1、定义统一返回格式

    public class RtnMsg{

    private String rtnCode;

    private String rtnMsg="";

    private Object msg;

    public RtnMsg(String rtnCode,String rtnMsg,Object msg){
    this.rtnCode = rtnCode;
    this.rtnMsg = rtnMsg;
    this.msg = msg;
    }

    public RtnMsg(String rtnCode,String rtnMsg){
    this.rtnCode = rtnCode;
    this.rtnMsg = rtnMsg;
    }

    public RtnMsg(){
    }

    public String getRtnCode() {
    return rtnCode;
    }

    public void setRtnCode(String rtnCode) {
    this.rtnCode = rtnCode;
    }

    public String getRtnMsg() {
    return rtnMsg;
    }

    public void setRtnMsg(String rtnMsg) {
    this.rtnMsg = rtnMsg;
    }

    public Object getMsg() {
    return msg;
    }

    public void setMsg(Object msg) {
    this.msg = msg;
    }




    }
    2、设置常用错误码

    public class RtnCode {

    //正常返回
    public static final String STATUS_OK = "000";
    //参数错误
    public static final String STATUS_PARAM = "001";
    //接口未发现
    public static final String STATUS_NOFOUND = "404";
    //捕获到异常
    public static final String STATUS_SYSERROR = "500";
    }
    3、定义未处理异常统一拦截

    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    /**
    * @author suntongxin
    * Create on 2017年12月12日下午1:55:12
    * All right reserved
    */
    @ControllerAdvice
    public class CommExceptionHandler {

    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public RtnMsg handle(Exception e){
    RtnMsg msg = new RtnMsg(RtnCode.STATUS_SYSERROR, "系统异常,异常原因:"+e.getMessage());
    return msg;
    }
    4、注入拦截response的bean对象

    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    /**
    * @author suntongxin
    * Create on 2017年12月12日下午1:55:27
    * All right reserved
    */
    @Configuration
    public class RtnMsgConfig{

    @Bean
    public ResponseBodyWrapFactoryBean getResponseBodyWrap(){

    return new ResponseBodyWrapFactoryBean();

    }


    }
    5、设置bean过滤原则

    import java.util.ArrayList;
    import java.util.List;

    import org.springframework.beans.factory.InitializingBean;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
    import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
    import org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor;
    /**
    * @author suntongxin
    * Create on 2017年12月12日上午10:48:43
    * All right reserved
    */
    public class ResponseBodyWrapFactoryBean implements InitializingBean{

    @Autowired
    private RequestMappingHandlerAdapter adapter;

    @Override
    public void afterPropertiesSet() throws Exception {

    List<HandlerMethodReturnValueHandler> returnValueHandlers = adapter.getReturnValueHandlers();
    List<HandlerMethodReturnValueHandler> handlers = new ArrayList(returnValueHandlers);
    decorateHandlers(handlers);
    adapter.setReturnValueHandlers(handlers);


    }


    private void decorateHandlers(List<HandlerMethodReturnValueHandler> handlers){

    for(HandlerMethodReturnValueHandler handler : handlers){
    if(handler instanceof RequestResponseBodyMethodProcessor){
    ResponseBodyWrapHandler decorator = new ResponseBodyWrapHandler(handler);
    int index = handlers.indexOf(handler);
    handlers.set(index, decorator);
    break;
    }
    }

    }

    }
    6、实现具体的统一json返回处理

    package cn.seisys.common;

    import org.springframework.core.MethodParameter;
    import org.springframework.web.context.request.NativeWebRequest;
    import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
    import org.springframework.web.method.support.ModelAndViewContainer;
    /**
    * @author suntongxin
    * Create on 2017年12月12日上午10:48:54
    * All right reserved
    */
    public class ResponseBodyWrapHandler implements HandlerMethodReturnValueHandler{

    private final HandlerMethodReturnValueHandler delegate;

    public ResponseBodyWrapHandler(HandlerMethodReturnValueHandler delegate){

    this.delegate = delegate;

    }

    @Override
    public boolean supportsReturnType(MethodParameter returnType) {

    return delegate.supportsReturnType(returnType);

    }

    @Override
    public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer,
    NativeWebRequest webRequest) throws Exception {
    RtnMsg rtnMsg = null;
    if(returnValue instanceof RtnMsg){
    rtnMsg = (RtnMsg)returnValue;
    }else{
    rtnMsg = new RtnMsg(RtnCode.STATUS_OK,"",returnValue);
    }

    delegate.handleReturnValue(rtnMsg, returnType, mavContainer, webRequest);;


    }

    }
     
    ————————————————
    版权声明:本文为CSDN博主「L若儿」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。
    原文链接:https://blog.csdn.net/syystx/article/details/82870217

    哎...今天够累的,签到来了1...
    回复

    使用道具 举报

    您需要登录后才可以回帖 登录 | 立即注册

    本版积分规则

    QQ|手机版|小黑屋|Java自学者论坛 ( 声明:本站文章及资料整理自互联网,用于Java自学者交流学习使用,对资料版权不负任何法律责任,若有侵权请及时联系客服屏蔽删除 )

    GMT+8, 2024-12-23 00:23 , Processed in 0.229562 second(s), 30 queries .

    Powered by Discuz! X3.4

    Copyright © 2001-2021, Tencent Cloud.

    快速回复 返回顶部 返回列表