Spring Boot接收单个String入参的解决方法

主要给大家介绍了关于Spring Boot接收单个String入参的解决方法，文中通过示例代码介绍的非常详细，对大家学习或者使用spring boot具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧 在Spring Boot应用中，我们经常需要处理HTTP请求并获取请求中的参数。在处理单个String类型入参时，通常的做法是将其作为路径变量、查询参数或请求体的一部分。然而，当仅有一个参数时，将其封装到一个对象中可能显得过于繁琐。本文将介绍一种自定义注解和解析器的方法，以便于Spring Boot更方便地接收单个String入参。 我们创建一个自定义注解`@RequestSingleParam`，用于标记需要接收单个String参数的方法参数。该注解包含三个属性：`value`表示要获取的参数名，`required`表示参数是否必需，默认为true，`defaultValue`表示默认值，默认为空字符串。 ```java @Target(ElementType.PARAMETER) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface RequestSingleParam { String value(); boolean required() default true; String defaultValue() default ""; } ``` 接着，我们需要实现一个`HandlerMethodArgumentResolver`，这是一个Spring MVC的接口，用于解析控制器方法参数。`RequestSingleParamHandlerMethodArgumentResolver`类负责从请求中提取指定的String参数。 ```java public class RequestSingleParamHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver { @Override public boolean supportsParameter(MethodParameter parameter) { return parameter.hasParameterAnnotation(RequestSingleParam.class); } @Override public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception { RequestSingleParam requestSingleParam = parameter.getParameterAnnotation(RequestSingleParam.class); HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class); // 读取请求体内容 BufferedReader reader = request.getReader(); StringBuilder sb = new StringBuilder(); char[] buf = new char[1024]; int rd; while ((rd = reader.read(buf)) != -1) { sb.append(buf, 0, rd); } // 将请求体内容转换为JSON对象，假设请求体是JSON格式 JSONObject jsonObject = JSONObject.parseObject(sb.toString()); String value = requestSingleParam.value(); return jsonObject.get(value); } } ``` 我们需要在Spring Boot的启动类中配置这个自定义的参数解析器。这里我们继承`WebMvcConfigurerAdapter`，并重写`addArgumentResolvers()`方法，将我们的解析器添加到解析器列表中。 ```java @SpringBootApplication @EnableWebMvc public class SpringbootDemoApplication extends WebMvcConfigurerAdapter { public static void main(String[] args) { SpringApplication.run(SpringbootDemoApplication.class, args); } @Override public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers){ argumentResolvers.add(new RequestSingleParamHandlerMethodArgumentResolver()); } } ``` 现在，我们可以在控制器方法上使用`@RequestSingleParam`注解来接收单个String参数。例如： ```java @GetMapping("/example") public String handleSingleParam(@RequestSingleParam("myParam") String param) { // 处理逻辑... return "Success"; } ``` 在这个例子中，当请求的URL类似于`/example?myParam=value`时，`handleSingleParam`方法会接收到`value`作为`param`的值。 总结起来，通过自定义注解和解析器，我们可以方便地在Spring Boot中处理仅包含一个String参数的情况，而无需创建额外的模型类。这种方式提高了代码的简洁性和可维护性，尤其适用于简单接口的实现。不过，要注意的是，这种方法假设请求体是JSON格式，如果请求体不是JSON，可能需要调整解析逻辑。