Shulou(Shulou.com)06/03 Report--

This article mainly explains "how to agree on the front-end docking data format." Interested friends may wish to have a look. The method introduced in this paper is simple, fast and practical. Let's let Xiaobian take you to learn "how to agree on the data format of front and rear docking"!

format convention

Listing 1: Sample source code for return message formatting conventions

package site.syksy.qingzhou.web.response;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import io.swagger.v3.oas.annotations.media.Schema;import org.springframework.http.HttpStatus;import org.springframework.http.ResponseEntity;import java.io.Serializable;/** * @author Raspberry */@Schema(title = "Return Message")public class ResponseMessage implements Serializable { private static final long serialVersionUID = 1L; @Schema(title = "Success") private Boolean success; @Schema(title = "Data") private T data; @Schema(title = "Error Code") private String errorCode; @Schema(title = "Error Message") private String errorMessage; /** * error display type： 0 silent; 1 message.warn; 2 message.error; 4 notification; 9 page */ @Schema(title = "Error message display type") private Integer showType; /** * Convenient for back-end Troubleshooting: unique request ID */ @Schema(title = "Unique Request ID") private String traceId; /** * onvenient for backend Troubleshooting: host of current access server */ @Schema(title = "Host currently accessing server") private String host; ...... Omit part of the code, please go to the light boat source code to find...}

The attributes in the ResponseMessage class are based on the ant design pro documentation recommendations.

unified packaging

After agreeing on the format of the front-end and back-end interaction data, we will wrap the return result in each HTTP interface method, but this is redundant. Can these redundant codes be handled centrally? Of course you can! Just create a class that implements the **ResponseBodyAdvice ** interface and add an annotation **@RestControllerAdvice ** to wrap the returned results uniformly. See the source code in Listing 2 for details.

Listing 2: Uniform wrapper return message source code example

package site.syksy.qingzhou.web.response;import org.springframework.core.MethodParameter;import org.springframework.http.MediaType;import org.springframework.http.converter.HttpMessageConverter;import org.springframework.http.server.ServerHttpRequest;import org.springframework.http.server.ServerHttpResponse;import org.springframework.web.bind.annotation.RestControllerAdvice;import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;/** * @author Raspberry */@RestControllerAdvicepublic class GeneralResponseBodyAdvice implements ResponseBodyAdvice { private final static String PACKAGE_PATH = "site.syksy.qingzhou"; @Override public boolean supports(MethodParameter methodParameter, Class> aClass) { String className = methodParameter.getMethod().getDeclaringClass().getName(); if (className.startsWith(PACKAGE_PATH)) { return true; } else { return false; } } @Override public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) { if (o instanceof ResponseMessage) { return o; } if (o instanceof String) { return ResponseMessage.success(o).toJSON(); } return ResponseMessage.success(o); }}

The two methods in the GeneralResponseBodyAdvice ** class are explained as follows:

supports: The beforeBodyWrite method is executed by checking whether the Controller classpath matches site.syksy.qingzhou and returning true.

beforeBodyWrite: First judge whether the result returned by Controller has been wrapped (type belongs to ResponseMessage), whether it is String type (String type, subsequent converter will not convert it to json). If the above judgment is not passed, the result will be packaged into ResponseMessage format.

The constraint in the Listing 2 example is by package path, but it can be constrained in other ways. Note, however, that you must restrict the scope, otherwise the interface of springdoc-openapi will also wrap, and the swagger ui will not parse correctly when accessing it.

At this point, I believe everyone has a deeper understanding of "how to agree on the front-end docking data format," so you may as well do it in practice! Here is the website, more related content can enter the relevant channels for inquiry, pay attention to us, continue to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.