自定義@RequestBody注解如何獲取JSON數(shù)據(jù)

更新時(shí)間：2023年04月10日 14:23:42 作者：明淵陶向反01

這篇文章主要介紹了自定義@RequestBody注解如何獲取JSON數(shù)據(jù)問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

自定義注解

首先思考，我們需要這個(gè)注解做什么？

設(shè)置該字段的必選性（required）
設(shè)置該字段在請(qǐng)求體 JSON 中的 key 值（name、value）
設(shè)置該字段的默認(rèn)值（defaultValue）

于是我們的注解類 @JsonArg 至少應(yīng)該長(zhǎng)這樣：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface JsonArg {
? ? @AliasFor("name")
? ? String value() default "";

? ? @AliasFor("value")
? ? String name() default "";

? ? boolean required() default true;

? ? String defaultValue() default ValueConstants.DEFAULT_NONE;
}

其中：

@Retention(RetentionPolicy.RUNTIME) 聲明我們需要在運(yùn)行期動(dòng)態(tài)地獲取它地信息
@Target(ElementType.PARAMETER) 聲明這個(gè)注解只能作用在方法參數(shù)

是的，它和 Spring MVC 自帶的 @RequestParam 注解非常像，但 @RequestParam 只能作用于 query parameters 和 form data。

自定義解析器

單純的定義注解類程序是無法知道我們要它做什么的，所以我們要告訴程序在遇到這個(gè)注解時(shí)該做什么。

public class JsonArgMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver {
? ? /**
? ? ?* 表示關(guān)于 namedValue 的信息，包括名稱、是否需要它以及默認(rèn)值。
? ? ?*
? ? ?* @param parameter 待處理的方法參數(shù)
? ? ?* @return {@link JsonArgNamedValueInfo}
? ? ?*/
? ? @Override
? ? protected NamedValueInfo createNamedValueInfo(MethodParameter parameter) {
? ? ? ? JsonArg ann = parameter.getParameterAnnotation(JsonArg.class);
? ? ? ? return (ann != null ? new JsonArgNamedValueInfo(ann) : new JsonArgNamedValueInfo());
? ? }

? ? /**
? ? ?* 解析方法
? ? ?*
? ? ?* @param name ? ? ?待解析的 JSON 的 key
? ? ?* @param parameter 待處理的方法參數(shù)
? ? ?* @return 解析出來的值
? ? ?*/
? ? @Override
? ? protected Object resolveName(String name, MethodParameter parameter, NativeWebRequest request) throws Exception {
? ? ? ? ContentCachingRequestWrapper contentCachingRequestWrapper = request.getNativeRequest(ContentCachingRequestWrapper.class);
? ? ? ? String body;
? ? ? ? assert contentCachingRequestWrapper != null;
? ? ? ? byte[] contentAsByteArray = contentCachingRequestWrapper.getContentAsByteArray();
? ? ? ? if (contentAsByteArray.length == 0) {
? ? ? ? ? ? try (BufferedReader reader = contentCachingRequestWrapper.getReader()) {
? ? ? ? ? ? ? ? body = reader.lines().collect(Collectors.joining(""));
? ? ? ? ? ? }
? ? ? ? } else {
? ? ? ? ? ? body = new String(contentAsByteArray);
? ? ? ? }
? ? ? ? return JSONObject.parseObject(body).get(name);
? ? }

? ? /**
? ? ?* 是否支持該方法參數(shù)
? ? ?*
? ? ?* @param parameter 待處理的方法參數(shù)
? ? ?*/
? ? @Override
? ? public boolean supportsParameter(MethodParameter parameter) {
? ? ? ? return true;
? ? }

? ? private static class JsonArgNamedValueInfo extends NamedValueInfo {
? ? ? ? public JsonArgNamedValueInfo() {
? ? ? ? ? ? super("", false, ValueConstants.DEFAULT_NONE);
? ? ? ? }

? ? ? ? public JsonArgNamedValueInfo(JsonArg annotation) {
? ? ? ? ? ? super(annotation.name(), annotation.required(), annotation.defaultValue());
? ? ? ? }
? ? }
}

注意到在 resolveName() 方法中我們獲取的 request 類型是 ContentCachingRequestWrapper。

這是因?yàn)槟J(rèn)的 request 只能讀取一次請(qǐng)求體，而我們的解析器在解析每個(gè)方法參數(shù)時(shí)都需要讀取一次請(qǐng)求體。

包裝請(qǐng)求

添加過濾器將我們的請(qǐng)求轉(zhuǎn)換為所需要的 ContentCachingRequestWrapper。

/*
? ? 將request包裝成ContentCachingRequest，以反復(fù)讀取請(qǐng)求體
?*/
@Component
public class CachingRequestBodyFilter extends GenericFilterBean {
? ? @Override
? ? public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
? ? ? ? if (servletRequest instanceof HttpServletRequest) {
? ? ? ? ? ? filterChain.doFilter(new ContentCachingRequestWrapper((HttpServletRequest) servletRequest), servletResponse);
? ? ? ? } else {
? ? ? ? ? ? filterChain.doFilter(servletRequest, servletResponse);
? ? ? ? }
? ? }
}

注冊(cè)解析器

最后，將自定義的解析器注冊(cè)到 Spring MVC。

@Configuration
public class SpringMvcConfig implements WebMvcConfigurer {
? ? @Override
? ? public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
? ? ? ? resolvers.add(new JsonArgMethodArgumentResolver());
? ? }
}

用法

和 @RequestParam 的用法相似。

public CommonResult<Object> signUp(
? ? ? ? ? ? @JsonArg(name = "uname") String username,
? ? ? ? ? ? @JsonArg(required = false, name = "pwd", defaultValue = "123") String password
? ? ) {
? ? ? ? log.info("[Username]: {}, [Password]: {}", username, password);
? ? ? ? return null;
}