FrameWork：SpringBoot工程响应标准的设计

SpringBoot工程中响应标准的设计

背景分析

在基于C/S架构的编程模型中，客户端往往需要对服务端返回的数据，基于状态的不同进行不同的处理。

响应标准的设计及实现

在基于C/S架构的编程模型中，客户端往往需要对服务端返回的数据，基于状态的不同进行不同的处理。例如，正确的状态数据一种呈现方式，错误的状态数据是另外一种呈现方式。于是服务端响应数据的标准化设计油然而生。

/**
 * 服务端响应标准的设计
 */
@Data
public class JsonResult {

    private Integer state=1;
    private String message="ok";
    private Object Data;

    public JsonResult(String message){
        this.message=message;
    }

    public JsonResult(Object data){
        this.Data=data;
    }

    public JsonResult(Throwable e){
        this.state=0;
        this.message=e.getMessage();
    }
}

服务端响应数据的标准化封装

在Controller类的逻辑方法中进行正常的响应数据封装

package com.cy.pj.module.controller;
@RestController
public class ArithmeticController {
@RequestMapping("/doCompute/{n1}/{n2}")
public JsonResult doCompute(@PathVariable Integer n1, @PathVariable
Integer n2){
Integer result=n1/n2;
JsonResult r=newJsonResult("计算结果:"+result);
r.setData(result);
return r;
}
}

在全局异常处理类对象中进行异常响应数据的封装

package com.cy.pj.common.web;
@RestControllerAdvice
public class GlobalExceptionHandler {
private static final Logger log=
LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(ArithmeticException.class)
public JsonResult doHandleArithmeticException(ArithmeticException e){
e.printStackTrace();
log.info("exception {}",e.getMessage());
return new JsonResult(e);//封装异常结果
}
}