RestFul API 统一格式返回 + 全局异常处理

}

@Override

public String toString() {

return “HttpResult{” +

“success=” + success +

“, code=” + code +

“, data=” + data +

“, message='” + message + ‘’’ +

‘}’;

}

}

复制代码

说明：

1. 构造器私有，外部不可以直接创建；

2. 只可以调用统一返回类的静态方法返回对象；

3. success 是一个Boolean 值，通过这个值，可以直接观察到该次请求是否成功；

4. data 表示响应数据，用于请求成功后，返回客户端需要的数据。

三、测试及总结

---

3.1 简单的接口测试

@RestController

@RequestMapping(“/httpRest”)

@Api(tags = “统一结果测试”)

public class HttpRestController {

@ApiOperation(value = “通用返回成功（没有返回结果）”, httpMethod = “GET”)

@GetMapping(“/success”)

public HttpResult success(){

return HttpResult.success();

}

@ApiOperation(value = “返回成功（有返回结果）”, httpMethod = “GET”)

@GetMapping(“/successWithData”)

public HttpResult successWithData(){

return HttpResult.success(“风尘博客”);

}

@ApiOperation(value = “通用返回失败”, httpMethod = “GET”)

@GetMapping(“/failure”)

public HttpResult failure(){

return HttpResult.failure(ResultCodeEnum.NOT_FOUND);

}

}

复制代码

这里 Swagger以及SpringMVC的配置就没贴出来了，详见Github 示例代码。

3.2 返回结果

http://localhost:8080/swagger-ui.html#/

{

“code”: 200,

“success”