SpringBoot接口 - 如何优雅的对接口返回内容统一封装？

SpringBoot接口 - 如何优雅的对接口返回内容统一封装？

在以SpringBoot开发Restful接口时，统一返回方便前端进行开发和封装，以及出现时给出响应编码和信息。@pdai

RESTful API接口?

什么是 REST？

Representational State Transfer，翻译是“表现层状态转化”。可以总结为一句话：REST 是所有 Web 应用都应该遵守的架构设计指导原则。

面向资源是 REST 最明显的特征，对于同一个资源的一组不同的操作。资源是服务器上一个可命名的抽象概念，资源是以名词为核心来组织的，首先关注的是名词。REST 要求，必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

什么是 RESTful API？

符合 REST 设计标准的 API，即 RESTful API。REST 架构设计，遵循的各项标准和准则，就是 HTTP 协议的表现，换句话说，HTTP 协议就是属于 REST 架构的设计模式。比如，无状态，请求-响应。

Restful相关文档可以参考 ​​返回结果如下

{ "userId": 1, "userName": "赵一"}

如果封装了，返回正常的结果如下：

{ "timestamp": 11111111111, "status": 200, "message": "success", "data": { "userId": 1, "userName": "赵一" }}

异常返回结果如下：

{ "timestamp": 11111111111, "status": 10001, "message": "User not exist", "data": null}

实现案例

如何实现上面的封装呢？

状态码封装

这里以常见的状态码为例，包含responseCode 和 description两个属性。

如果还有其它业务状态码，也可以放到这个类中。

/** * @author pdai */@Getter@AllArgsConstructorpublic enum ResponseStatus { SUCCESS("200", "success"), FAIL("500", "failed"), HTTP_STATUS_200("200", "ok"), HTTP_STATUS_400("400", "request error"), HTTP_STATUS_401("401", "no authentication"), HTTP_STATUS_403("403", "no authorities"), HTTP_STATUS_500("500", "server error"); public static final List HTTP_STATUS_ALL = Collections.unmodifiableList( Arrays.asList(HTTP_STATUS_200, HTTP_STATUS_400, HTTP_STATUS_401, HTTP_STATUS_403, HTTP_STATUS_500 )); /** * response code */ private final String responseCode; /** * description. */ private final String description;}

返回内容封装

包含公共的接口返回时间，状态status, 消息message， 以及数据data。

考虑到数据的序列化（比如在网络上传输），这里data有时候还会extends Serializable。

@Data@Builderpublic class ResponseResult { /** * response timestamp. */ private long timestamp; /** * response code, 200 -> OK. */ private String status; /** * response message. */ private String message; /** * response data. */ private T data; /** * response success result wrapper. * * @param type of data class * @return response result */ public static ResponseResult success(){ return success(null); } /** * response success result wrapper. * * @param data response data * @param type of data class * @return response result */ public static ResponseResult success(T data){ return ResponseResult.builder().data(data) .message(ResponseStatus.SUCCESS.getDescription()) .status(ResponseStatus.SUCCESS.getResponseCode()) .timestamp(System.currentTimeMillis()) .build(); } /** * response error result wrapper. * * @param message error message * @param type of data class * @return response result */ public static ResponseResult fail(String message){ return fail(null, message); } /** * response error result wrapper. * * @param data response data * @param message error message * @param type of data class * @return response result */ public static ResponseResult fail(T data, String message){ return ResponseResult.builder().data(data) .message(message) .status(ResponseStatus.FAIL.getResponseCode()) .timestamp(System.currentTimeMillis()) .build(); }}

接口返回时调用

在接口返回时调用, 以用户接口为例

/** * @author pdai */@RestController@RequestMapping("/user")public class UserController { @Autowired private IUserService userService; /** * @param user user param * @return user */ @ApiOperation("Add/Edit User") @PostMapping("add") public ResponseResult add(User user){ if (user.getId()==null || !userService.exists(user.getId())) { user.setCreateTime(LocalDateTime.now()); user.setUpdateTime(LocalDateTime.now()); userService.save(user); } else { user.setUpdateTime(LocalDateTime.now()); userService.update(user); } return ResponseResult.success(userService.find(user.getId())); } /** * @return user list */ @ApiOperation("Query User One") @GetMapping("edit/{userId}") public ResponseResult edit(@PathVariable("userId"){ return ResponseResult.success(userService.find(userId)); }}

示例源码

​​​​Java 全栈知识体系(https://pdai.tech)​​

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。