关于前后端响应结果

关于前后端响应结果

控制器处理完请求后，向客户端进行响应时，推荐使用JSON格式的响应数据，并且，此JSON格式的数据中至少应该包括：

• 业务状态码
• 提示信息

在Spring MVC框架中，当需要向客户端响应JSON格式的结果时，需要：

• 当前处理请求的方法必须是“响应正文”的
  • 在处理请求的方法或控制器类上使用@ResponseBody，或控制器类上使用了@RestController，就是“响应正文”的
• 在项目中添加jackson-databind的依赖
  • 包含在spring-boot-starter-web依赖项中
• 开启注解驱动
  • 使用注解模式的Spring MVC项目（包括Spring Boot）均默认开启
• 使用自定义的类型作为处理请求的方法的返回值类型，并且，此类中应该包含响应的JSON中的各属性

则在项目的根包下创建web.JsonResult类：

package cn.tedu.csmall.product.web;

import cn.tedu.csmall.product.ex.ServiceCode;
import cn.tedu.csmall.product.ex.ServiceException;
import lombok.Data;

import java.io.Serializable;

@Data
public class JsonResult<T> implements Serializable {

    /**
     * 业务状态码
     */
    private Integer state;
    /**
     * 错误时的提示消息
     */
    private String message;
    /**
     * 成功时响应的数据
     */
    private T data;

    public JsonResult() {
    }

    private JsonResult(Integer state, String message, T data) {
        this.state = state;
        this.message = message;
        this.data = data;
    }

    public static JsonResult<Void> ok() {
        return ok(null);
    }

    public static <T> JsonResult<T> ok(T data) {
        return new JsonResult(ServiceCode.OK.getValue(), null, data);
    }

    public static JsonResult<Void> fail(ServiceException e) {
        return fail(e.getServiceCode().getValue(), e.getMessage());
    }

    public static JsonResult<Void> fail(Integer state, String message) {
        return new JsonResult(state, message, null);
    }

}

然后，在处理请求的方法中，使用JsonResult作为返回值类型，并返回此类型的结果：

@PostMapping("/{id:[0-9]+}/enable")
public JsonResult<Void> setEnable(@PathVariable Long id) {
    log.debug("即将处理【启用品牌】的请求，id={}", id);

    try {
        brandService.setEnable(id);
        return JsonResult.ok();
    } catch (ServiceException e) {
        return JsonResult.fail(e);
    }
}