[add] 加入统一响应类ResponseData

Author: BlueDriver

web/src/main/java/demo/web/controller/RestfulController.java

@@ -1,5 +1,6 @@
 package demo.web.controller;
 
+import demo.web.controller.base.ResponseData;
 import demo.web.controller.req.User;
 import demo.web.handler.GlobalExceptionHandler;
 import demo.web.service.AsyncTaskService;
@@ -110,8 +111,8 @@ public User param(@Valid User user) {
  * 异常类型：{@link org.springframework.web.bind.MethodArgumentNotValidException}
  */
  @PostMapping("/param1")
- public User param1(@Valid @RequestBody User user) {
- return user;
+ public ResponseData param1(@Valid @RequestBody User user) {
+ return ResponseData.successObj().putData("user", user);
  }
 
  /**

web/src/main/java/demo/web/controller/base/ResponseCode.java

@@ -0,0 +1,33 @@
+package demo.web.controller.base;
+
+/**
+ * parent
+ * demo.web.controller.base
+ * 返回状态码
+ *
+ * @author BlueDriver
+ * @email cpwu@foxmail.com
+ * @date 2019/04/01 10:16 Monday
+ */
+public interface ResponseCode {
+ /**
+ * 成功success
+ */
+ int SUCCESS = 0;
+ /**
+ * 异常Exception
+ */
+ int EXCEPTION = 1;
+ /**
+ * 参数错误Parameter error
+ */
+ int PARAM_INVALID = 2;
+ /**
+ * 无权限NO permission
+ */
+ int NO_PERMISSION = 3;
+ /**
+ * 状态异常
+ */
+ int STATUS_ERROR = 4;
+}

web/src/main/java/demo/web/controller/base/ResponseData.java

@@ -0,0 +1,88 @@
+package demo.web.controller.base;
+
+import lombok.Data;
+import lombok.experimental.Accessors;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * parent
+ * demo.web.controller.base
+ * 统一响应数据
+ *
+ * @author BlueDriver
+ * @email cpwu@foxmail.com
+ * @date 2019/04/01 10:03 Monday
+ */
+@Data
+@Accessors(chain = true)
+public class ResponseData {
+ /**
+ * 返回码
+ *
+ * @see ResponseCode
+ */
+ private Integer code;
+ /**
+ * 说明
+ */
+ private String msg;
+ /**
+ * 数据
+ */
+ private Map<String, Object> data = new HashMap<>();
+ /**
+ * 扩展数据（根据实际需要赋值）
+ */
+ private Object ext;
+
+ /**
+ * 辅助构造方法
+ * 成功返回，剩下的只需要赋值data即可
+ */
+ public static ResponseData successObj() {
+ return successObj(null);
+ }
+
+ /**
+ * 辅助构造方法，带data设置
+ * 成功返回
+ */
+ public static ResponseData successObj(Map<String, Object> data) {
+ ResponseData responseData = new ResponseData();
+ responseData.setCode(ResponseCode.SUCCESS);
+ responseData.setMsg("处理成功");
+ responseData.setData(data == null ? new HashMap<>() : data);
+ return responseData;
+ }
+
+ /**
+ * 设置data
+ */
+ public ResponseData putData(String key, Object value) {
+ this.getData().put(key, value);
+ return this;
+ }
+
+ /**
+ * 辅助构造方法
+ * 异常返回，使用默认异常消息
+ */
+ public static ResponseData exceptionObj(Exception e) {
+ return exceptionObj(e, "发生异常：" + e.getMessage());
+ }
+
+ /**
+ * 辅助构造方法
+ * 异常返回，带异常消息
+ */
+ public static ResponseData exceptionObj(Exception e, String msg) {
+ ResponseData responseData = new ResponseData();
+ responseData.setCode(ResponseCode.EXCEPTION);
+ responseData.setMsg(msg);
+ //为便于排查异常，将异常类名赋值为ext
+ responseData.setExt(e.getClass().getName());
+ return responseData;
+ }
+}

web/src/main/java/demo/web/handler/GlobalExceptionHandler.java

@@ -33,14 +33,14 @@
 @ResponseBody
 public class GlobalExceptionHandler {
  /**
- * 处理参数校验异常
+ * 处理多参校验异常
  */
  @ExceptionHandler(value = {MethodArgumentNotValidException.class, BindException.class})
  private ResponseData paramHandler(Exception e) {
  ResponseData responseData = new ResponseData();
  responseData.setCode(ResponseCode.PARAM_INVALID);
  FieldError error;// = new FieldError("obj", "field", "default msg");
- //入参为对象
+ //入参为对象(json)
  if (e instanceof MethodArgumentNotValidException) {
  MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;
  error = ex.getBindingResult().getFieldError();//如果错误不止一个，亲测好象是随机获取一个错误
@@ -49,21 +49,22 @@ private ResponseData paramHandler(Exception e) {
  BindException ex = (BindException) e;
  error = ex.getBindingResult().getFieldError();
  }
- responseData.setMsg(error.getField() + error.getDefaultMessage() + ":" + error.getRejectedValue());
+ responseData.setMsg("参数非法：" + error.getDefaultMessage() + ": " +
+ "[" + error.getField() + "=" + error.getRejectedValue() + "]");
  responseData.setExt(e.getClass().getName());
  return responseData;
  }
 
  /**
- * 单个参数校验
+ * 单个参数校验（键值对)
  */
  @ExceptionHandler(value = ConstraintViolationException.class)
  @ResponseBody
  public ResponseData handleBindGetException(ConstraintViolationException e) {
  log.error("单个参数校验异常", e);
  ResponseData responseData = new ResponseData();
  responseData.setCode(ResponseCode.PARAM_INVALID)
- .setMsg(e.getMessage())
+ .setMsg("参数非法：" + e.getMessage())
  .setExt(e.getClass().getName());
  return responseData;
  }
@@ -90,9 +91,7 @@ public ResponseData handleMax(MaxUploadSizeExceededException e) {
  private ResponseData defaultExceptionHandler(HttpServletRequest req, HttpServletResponse resp,
  HttpSession session, Exception e) {
  log.error("exception handler: ", e);
- ResponseData responseData = ResponseData.exceptionObj(e);
- responseData.setExt(e.getClass().getName());
- return responseData;
+ return ResponseData.exceptionObj(e);
  }