共计 3232 个字符,预计需要花费 9 分钟才能阅读完成。
在 Spring Boot 我的项目中咱们能够通过 RestControllerAdvice
配合实现 ResponseBodyAdvice<T>
接口来保障 Spring MVC 接口具备对立的返回格局,以保障前端同学可能封装对立的数据接管工具。然而很多网上的文章并没有对理论开发中的细节作出更多的解说。明天胖哥就来分享一下我的采坑经验,也算作一个总结。
管制作用范畴
我记得在后面对于 Swagger3 的文章中提过,如果咱们不指定范畴将导致 Swagger 无奈辨认接口的元信息。因而如果你应用了 Swagger 必须指定其范畴,这里你能够通过指定扫描包来指定其作用域:
@RestControllerAdvice("cn.felord.controller")
如果你的 Spring MVC 控制器有对立的父类控制器的话,
@RestController
@RequestMapping("/foo")
public class FooController extends BaseController {//todo 省略}
也能够这样:
@RestControllerAdvice(assignableTypes = BaseController.class)
白名单
有些接口可能依据业务须要或者协定须要不能应用对立返回体,例如领取的告诉应答。这就须要一个相似白名单的机制来绕过对立返回体控制器告诉类。咱们能够借助于 ResponseBodyAdvice<T>
的下列办法实现:
boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);
这个办法如果返回 false
就示意不执行对立返回体的封装逻辑。这里我举荐注解实现。定义一个标记注解,能够定义在类上或者办法上:
@Documented
@Inherited
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface IgnoreRestBody {}
而后下面的 supports
办法这样实现:
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {return !returnType.hasMethodAnnotation(IgnoreRestBody.class);
}
如果某个 Controller 下所有的办法都绕过,就把这个注解标记在控制器类上;如果只想疏忽某个办法上就把它标记在该办法上即可。
返回独立字符串的问题
有些接口咱们会返回一个字符串:
@GetMapping("/get")
public String getStr(){
// 返回了一个字符串
return "felord.cn";
}
咱们心愿这个字符串被对立返回体解决,相似这样:
{
code: 200,
data: "felord.cn",
msg: "返回成字符串",
}
然而你会发现并没有达到冀望的成果,会抛出类型转换异样。这是因为当咱们的 Spring MVC 接口返回数据时,会依据 Content-Type
来抉择一个 HttpMessageConverter
来解决,而字符串在不申明 Content-Type
的状况下优先应用 StringHttpMessageConverter
,就导致了转换异样,须要设定成MappingJackson2HttpMessageConverter
用Jackson来解决,Spring MVC 的对应配置如下:
@Configuration(proxyBeanMethods = false)
public class SpringMvcConfiguration implements WebMvcConfigurer {
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
// 解决 String 对立封装 RestBody 的问题
converters.add(0, new MappingJackson2HttpMessageConverter());
}
}
嗯,这样就起效了!你认为这样就完了?你会发现你的 JSON 序列化不依照你设置的策略执行了。因为你 new 了一个而不是采纳零碎初始化的那个。解决办法为,将 Spring IoC 中的 ObjectMapper
注入到 MappingJackson2HttpMessageConverter
中去。或者你应用 Debug 调试出零碎默认的 MappingJackson2HttpMessageConverter
的地位,比方我的索引为7
,就能够这样配置:
@Configuration(proxyBeanMethods = false)
public class SpringMvcConfiguration implements WebMvcConfigurer {
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
// 解决 String 对立封装 RestBody 的问题
HttpMessageConverter<?> httpMessageConverter = converters.get(7);
if (!(httpMessageConverter instanceof MappingJackson2HttpMessageConverter)) {
// 确保正确,如果有改变就从新 debug
throw new RuntimeException("MappingJackson2HttpMessageConverter is not here");
}
converters.add(0, httpMessageConverter);
}
}
Data 的类型问题
已经一个安卓开发同学说,你这对立构造中的 data
如果是数组:
{
code: 200,
data: ['a','b'],
msg: "返回成字符串",
}
后续如果 data
增加其它与数组没有关系的属性就不兼容了,你应该保障这个 data
是个 Map
。是的,这也是问题,理论中发现不仅仅是数组,如果是int
、long
等原始类型或者 String
类型都面临这种状况,须要加一个额定的判断 body
是不是可能扭转 data
类型的类型:
private boolean checkPrimitive(Object body) {Class<?> clazz = body.getClass();
return clazz.isPrimitive()
|| clazz.isArray()
|| Collection.class.isAssignableFrom(clazz)
|| body instanceof Number
|| body instanceof Boolean
|| body instanceof Character
|| body instanceof String;
}
而后咱们在 ResponseBodyAdvice<T>
实现中减少一个判断:
// 加强扩展性
if (checkPrimitive(body)) {return RestBody.okData(Collections.singletonMap("result", body));
}
就解决问题了。
总结
明天对 Spring Boot 中对立返回体的一些细节问题进行了分享,心愿可能帮忙你解决一些理论开发中遇到的同样问题。多多关注:码农小胖哥 分享更多有用的编程常识。
关注公众号:Felordcn 获取更多资讯
集体博客:https://felord.cn