12-SpringBoot 工程中的响应规范设计及实现
springboot
公布于 10 月 12 日
背景剖析
在基于 C / S 架构的编程模型中,客户端往往须要对服务端返回的数据,基于状态的不同进行不同的解决。例如,正确的状态数据一种出现形式,谬误的状态数据是另外一种出现形式。于是服务端响应数据的标准化设计油然而生。
响应规范设计
在响应数据标准化设计时,首先要对响应数据进行剖析,哪些数据要响应到客户端,对这些数据进行怎么的状态设计等。如果当初响应的业务数据蕴含三局部:状态,音讯,具体数据。咱们能够这样设计,例如:
package com.cy.pj.common.pojo;
/**
* 基于此对象封装服务端响应到客户端的数据
*/
public class ResponseResult {/** 响应状态码 ( 有的人用 code)*/
private Integer state=1;// 1 示意 ok,0 示意 error,.....
/** 状态码对应的信息 */
private String message="ok";
/** 正确的响应数据 */
private Object data;
public ResponseResult(){}
public ResponseResult(String message){//new ResponseResult("delete ok"),
this.message=message;
}
public ResponseResult(Object data){//new ResponseResult(list);
this.data=data;
}
public ResponseResult(Throwable e){//new ResponseResult(e);
this.state=0;
this.message=e.getMessage();}
public Integer getState() {return state;}
public void setState(Integer state) {this.state = state;}
public String getMessage() {return message;}
public void setMessage(String message) {this.message = message;}
public Object getData() {return data;}
public void setData(Object data) {this.data = data;}
}
响应数据的封装
在 Controller 类的逻辑办法中进行失常的响应数据封装,例如:
package com.cy.pj.module.controller;
import com.cy.pj.common.pojo.ResponseResult;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ArithmeticController {@RequestMapping("/doCompute/{n1}/{n2}")
public ResponseResult doCompute(@PathVariable Integer n1, @PathVariable Integer n2){
Integer result=n1/n2;
ResponseResult r=new ResponseResult("计算结果:"+result);
r.setData(result);
return r;
}
}
在全局异样解决对象中进行异样响应数据的封装,例如:
package com.cy.pj.common.web;
import com.cy.pj.common.pojo.ResponseResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@RestControllerAdvice
public class GlobalExceptionHandler {private static final Logger log= LoggerFactory.getLogger(GlobalExceptionHandler.class);//2
@ExceptionHandler(ArithmeticException.class)
public ResponseResult doHandleArithmeticException(ArithmeticException e){e.printStackTrace();
log.info("exception {}",e.getMessage());
return new ResponseResult(e);// 封装异样后果
}
}
总结 (Summary)
本大节次要解说了 Spring Boot 工程中对逻辑数据的响应如何进行标准化设计,为什么这样设计,这样设计的益处以及如何设计。通过对这一大节的学习要进步其响应标准维度的设计理念,把握基本技能。