Spring Boot接口定义和全局异常统一处理


Posted in Java/Android onApril 20, 2022

前言:

前段时间接手了一个老项目,现在需要在此项目中添加一些新的需求,同事在开发过程中遇到了一些问题?

  • 1.成功的状态到底是200还是0啊,订单系统200代表成功,而会员系统却是0代表成功。
  • 2.接口返回的结果中,有些是用msg字段表示描述,有些又是用desc字段描述,前段处理起来比较麻烦能不能统一。
  • 3.错误提示信息需要支持国际化。

其实这些问题,归根究底还是代码规范问题,我们需要将接口定义和全局异常统一处理,历史项目10多个工程,难道每个工程都去实现一遍,答案可定是不可能的。

1、解决方案

Spring Boot接口定义和全局异常统一处理

定义公共模块,实现统一接口定义规范和异常处理,其他的系统进行依赖和扩展即可。

2、具体实现

2.1 定义状态码统一接口

public interface BaseResultCode
{
    /**
     * 状态码
     * @return
     */
    int getCode();
    /**
     * 提示信息
     * @return
     */
    String getMsg();
}

2.2 公共模块状态码枚举类

public enum ResultCode implements BaseResultCode
{
    OK(200, "成功"),
    ERROR(300,"系统异常"), 
    NEED_AUTH(301, "非法请求,请重新登录"), 
    PARAMTER_ERROR(302, "参数错误");
    //省略其他定义错误码
    private int code;
    private String msg;
    private ResultCode(int code, String msg)
    {
        this.code = code;
        this.msg = msg;
    }
    public static ResultCode getValue(int code)
    {
        for (ResultCode errorCode : values())
        {
            if (errorCode.getCode() == code)
            {
                return errorCode;
            }
        }
        return null;
    }
   //省略Get、Set方法
 }

2.3 定义全局自定义异常

public class SysException extends RuntimeException
{
    private static final long serialVersionUID = 5225171867523879342L;
    private int code;
    private String msg;
    private Object[] params;
    private BaseResultCode errorCode;
    public SysException()
    {
        super();
    }
    public SysException(String message)
    {
        super(message);
    }
    public SysException(Throwable cause)
    {
        super(cause);
    }
    public SysException(int code ,String message)
    {
        this.code = code;
        this.msg = message;
    }
    public SysException(int code ,String message,  Object[] params)
    {
        this(code, message);
        this.params= params;
    }
    public SysException(String message, Throwable cause)
    {
        super(message, cause);
    }
    public SysException(BaseResultCode errorCode)
    {
        this.errorCode = errorCode;
    }
    public SysException(String message, Object[] params)
    {
        super(message);
        this.params = params;
    }
    public SysException(BaseResultCode errorCode, String message, Object[] params)
    {
        this(message, params);
        this.errorCode = errorCode;
    }
    
    /**
     * Construct by default
     * 
     * @param message
     *            message
     * @param parameters
     *            parameters
     * @param cause
     *            cause
     */
    public SysException(String message, Object[] params, Throwable cause)
    {
        super(message, cause);
        this.params = params;
    }

    public int getCode()
    {
        return code;
    }
    public void setCode(int code)
    {
        this.code = code;
    }
    public String getMsg()
    {
        return msg;
    }
    public void setMsg(String msg)
    {
        this.msg = msg;
    }
    /**
     * @return the params
     */
    public Object[] getParams()
    {
        return params;
    }
    /**
     * @param params
     *            the params to set
     */
    public void setParams(Object[] params)
    {
        this.params = params;
    }
    public BaseResultCode getErrorCode()
    {
        return errorCode;
    }
    public void setErrorCode(BaseResultCode errorCode)
    {
        this.errorCode = errorCode;
    }
    
}

2.4 定义统一接口格式输出类

public class Result implements Serializable
{
    private static final long serialVersionUID = -1773941471021475043L;
    private Object data;
    private int code;
    private String msg;
    public Result()
    {
    }
    public Result(int code, Object data, String msg)
    {
        this.code = code;
        this.data = data;
        this.msg = msg;
    }
    public Result(int code, String desc)
    {
        this(code, null, desc);
    }
    public Result(BaseResultCode errorCode)
    {
        this(errorCode.getCode(), null, errorCode.getMsg());
    }
    public static Result success()
    {
        return success(null);
    }
    public static Result success(Object data)
    {
        Result result = new Result();
        result.setData(data);
        result.setCode(ResultCode.OK.getCode());
        return result;
    }
    public static Result error(String msg)
    {
        Result result = new Result();
        result.setCode(ResultCode.ERROR.getCode());
        result.setMsg(msg);
        return result;
    }
    public static Result error(BaseResultCode baseCode)
    {
        Result result = new Result();
        result.setCode(baseCode.getCode());
        result.setMsg(baseCode.getMsg());
        return result;
    }
}

个人建议:统一接口输出类不要定义为泛型类型

2.5 定义统一接口格式输出类

@RestControllerAdvice
public class SysExceptionHandler
{
    public static Log logger = LogManager.getLogger(SysExceptionHandler.class);
    @ExceptionHandler(Exception.class)
    public Result handleException(HttpServletRequest request,
            Exception ex)
    {
        logger.error("Handle Exception Request Url:{},Exception:{}",request.getRequestURL(),ex);
        Result result = new Result();
        //系统异常
        if (ex instanceof SysException)
        {
            SysException se = (SysException) ex;
            BaseResultCode resultCode =se.getErrorCode();
            if(resultCode==null)
            {
                result = Result.error(se.getMessage());
            }
            else
            {
               result = new Result(resultCode.getCode(),
                                       StringUtil.isNotEmpty(se.getMessage())?se.getMessage():resultCode.getMsg());
            }
        }
        //参数错误
        else if (ex instanceof ConstraintViolationException)
        {
            ConstraintViolationException v = (ConstraintViolationException) ex;
            String message = v.getConstraintViolations().iterator().next()
                    .getMessage();
            result.setCode(ResultCode.PARAMTER_ERROR.getCode());
            result.setMsg(ResultCode.PARAMTER_ERROR.getMsg() + ":" + message);
        }
        //参数错误
        else if (ex instanceof BindException)
        {
            BindException v = (BindException) ex;
            String message = v.getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(","));
            result.setCode(ResultCode.PARAMTER_ERROR.getCode());
            result.setMsg(ResultCode.PARAMTER_ERROR.getMsg() + ":" + message);
        }
        //参数错误
        else if (ex instanceof MethodArgumentNotValidException)
        {
            MethodArgumentNotValidException v = (MethodArgumentNotValidException) ex;
            String message = v.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(","));
            result.setCode(ResultCode.PARAMTER_ERROR.getCode());
            result.setMsg(ResultCode.PARAMTER_ERROR.getMsg() + ":" + message);
        }
        else
        {
           result = new Result(ResultCode.ERROR.getCode(),ExceptionUtil.getErrorMsg(ex));
        }
        logger.info("exception handle reuslt:" + result);
        return result;
    }
}

上述定义已经可以实现全局接口和异常的统一处理,但是存在的如下问题

每个controller都需要返回Reesult类型,且每个方法都需要返回Result.success()或者Result.success(data)的结果,有点重复,需要进行优化。

@GetMapping("addUser")
    public Result add()
    {
       for(int i=0;i<10;i++)
       {
           TUser user = new TUser();
           //user.setOid(IdWorker.getId());
           user.setName("shareing_"+i);
           user.setAge(i);
           userService.addUser(user);
       }
       return Result.success();
    }

2.6 接口统一输出优化

实现方式只需要实现ResponseBodyAdvice接口,重写beforeBodyWrite方法接口。

@RestControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice<Object>
{
    private Logger logger = LoggerFactory.getLogger(ResponseAdvice.class);
    @Override
    public boolean supports(MethodParameter returnType,
            Class<? extends HttpMessageConverter<?>> converterType)
    {
        return true;
    }
    @Override
    public Object beforeBodyWrite(Object o, MethodParameter returnType,
            MediaType selectedContentType,
            Class<? extends HttpMessageConverter<?>> selectedConverterType,
            ServerHttpRequest request, ServerHttpResponse response)
    {
        logger.info("before body write param:{}",o);
        if(o instanceof String)
        {
           //序列化结果输出
           return FastJsonUtil.toJSONString(Result.success(o));
        }
        else if (o instanceof Result)
        {
             return o;
        }
        return Result.success(o);
    }
}

经过优化后,controller输出可以根据业务的需求定义输出对象。

@GetMapping("getUserByName")
    public TUser getUserByName1(@RequestParam String name)
    {
       logger.info("getUserByName paramter name:"+name);
       return userService.getUserByName(name); 
    }

2.7 子系统如何实现

子系统引入common的jar包,

<dependency>
	    <groupId>com.xx</groupId>
	    <artifactId>xx-common</artifactId>
	    <version>2.0</version>
	</dependency>

3、子系统定义状态码,实现BaseResultCode接口

public enum OrderModelErrorCode implements BaseResultCode
{
    ORDER_STATUS_ERROR(1000, "订单状态不正确");
    private int code;
    private String msg;
    private UserModelErrorCode(int code, String msg)
    {
        this.code = code;
        this.msg = msg;
    }
    @Override
    public int getCode()
    {
        return code;
    }
    @Override
    public String getMsg()
    {
        return msg;
    }
}

定义异常处理类,继承公共异常处理类SysExceptionHandler

@RestControllerAdvice
public class OrderModalExceptionHandle extends SysExceptionHandler
{
     @Override
    public Result handleException(HttpServletRequest request, Exception ex)
    {
        return super.handleException(request, ex);
        //子系统可以扩展异常处理
    }
}

子系统使用示例:

@Override
public Order getOrder(String orderId)
{
	Order order =getOrder(orderId);
        //相关伪代码
	if(order.getStatus()>120)
	{
	   throw new SysException(OrderModelErrorCode.ORDER_STATUS_ERROR);    
	}
	return order;
}

经过相关项目的重构,已经解决了第一个和第二问题,关于第三个国际化问题,将在后续的文章中讲解。

到此这篇关于Spring Boot统一接口返回以及全局异常处理的文章就介绍到这了!

Java/Android 相关文章推荐
详解Java线程池是如何重复利用空闲线程的
Jun 26 Java/Android
Maven学习----Maven安装与环境变量配置教程
Jun 29 Java/Android
Java数组与堆栈相关知识总结
Jun 29 Java/Android
java设计模式--建造者模式详解
Jul 21 Java/Android
Java中try catch处理异常示例
Dec 06 Java/Android
关于@OnetoMany关系映射的排序问题,使用注解@OrderBy
Dec 06 Java/Android
Java9新特性对HTTP2协议支持与非阻塞HTTP API
Mar 16 Java/Android
JavaWeb实现显示mysql数据库数据
Mar 19 Java/Android
SpringBoot中使用Redis作为全局锁示例过程
Mar 24 Java/Android
Java8 Stream API 提供了一种高效且易于使用的处理数据的方式
Apr 13 Java/Android
Java Spring Lifecycle的使用
May 06 Java/Android
Android学习之BottomSheetDialog组件的使用
Jun 21 Java/Android
Spring Boot配合PageHelper优化大表查询数据分页
Java Spring Boot 正确读取配置文件中的属性的值
Elasticsearch Recovery 详细介绍
Apr 19 #Java/Android
Elasticsearch 配置详解
Apr 19 #Java/Android
引用计数法和root搜索算法以及JVM中判定对象需要回收的方法
解决springboot druid数据库连接失败后一直重连的方法
Apr 19 #Java/Android
Android自定义双向滑动控件
Apr 19 #Java/Android
You might like
PHP获取文件绝对路径的代码(上一级目录)
2011/05/29 PHP
解析php中static,const与define的使用区别
2013/06/18 PHP
WAMP环境中扩展oracle函数库(oci)
2015/06/26 PHP
注意!PHP 7中不要做的10件事
2016/09/18 PHP
老鱼 浅谈javascript面向对象编程
2010/03/04 Javascript
Javascript将string类型转换int类型
2010/12/09 Javascript
JS写的贪吃蛇游戏(个人练习)
2013/07/08 Javascript
jquery css 设置table的奇偶行背景色示例
2014/06/03 Javascript
jQuery创建DOM元素实例解析
2015/01/19 Javascript
jQuery预加载图片常用方法
2015/06/15 Javascript
详解Javascript ES6中的箭头函数(Arrow Functions)
2016/08/24 Javascript
jquery实现瀑布流效果 jquery下拉加载新数据
2016/12/12 Javascript
Bootstrap modal使用及点击外部不消失的解决方法
2016/12/13 Javascript
bootstrap Table服务端处理分页(后台是.net)
2017/10/19 Javascript
webpack+vue-cil中proxyTable处理跨域的方法
2018/07/20 Javascript
layer设置maxWidth及maxHeight解决方案
2019/07/26 Javascript
微信小程序实现手指拖动选项排序
2020/04/22 Javascript
JavaScript实现动态生成表格
2020/08/02 Javascript
分享8个JavaScript库可更好地处理本地存储
2020/10/12 Javascript
vue组件添加事件@click.native操作
2020/10/30 Javascript
python 剪切移动文件的实现代码
2018/08/02 Python
Python定时发送消息的脚本:每天跟你女朋友说晚安
2018/10/21 Python
python argparse模块通过后台传递参数实例
2020/04/20 Python
基于html和CSS3制作酷炫的导航栏
2015/09/23 HTML / CSS
基于HTML5的WebGL实现json和echarts图表展现在同一个界面
2017/10/26 HTML / CSS
女性时尚网购:Chic Me
2019/07/30 全球购物
学校安全工作制度
2014/01/19 职场文书
大学生在校学习的自我评价
2014/02/18 职场文书
优秀团队获奖感言
2014/02/19 职场文书
2015年幼儿园后勤工作总结
2015/04/25 职场文书
2015年科学教研组工作总结
2015/07/22 职场文书
2016反腐倡廉警示教育心得体会
2016/01/13 职场文书
《中华上下五千年》读后感3篇
2019/11/29 职场文书
SpringBoot集成Druid连接池连接MySQL8.0.11
2021/07/02 Java/Android
JAVA springCloud项目搭建流程
2022/05/11 Java/Android