项目接入了配置中心,之前选用的都是Spring Cloud相关组件,所以直接使用的就是Spring Cloud Config在接入的时候,一旦配置文件有数组相关配置,不管是properties文件还是yml文件都会报错。
错误信息如下
Caused by: org.springframework.http.converter.HttpMessageNotReadableException: Could not read JSON document: com.ctc.wstx.exc.WstxUnexpectedCharException: Unexpected character '[' (code 91) excepted space, or '>' or "/>"
at [row,col {unknown-source}]: [1,1899] (through reference chain: org.springframework.cloud.config.environment.Environment["propertySources"]->java.util.ArrayList[3]); nested exception is com.fasterxml.jackson.databind.JsonMappingException: com.ctc.wstx.exc.WstxUnexpectedCharException: Unexpected character '[' (code 91) excepted space, or '>' or "/>"
at [row,col {unknown-source}]: [1,1899] (through reference chain: org.springframework.cloud.config.environment.Environment["propertySources"]->java.util.ArrayList[3])
跟踪客户端源码发现初始化获取配置信息是由ConfigServicePropertySourceLocator对象的locate()方法触发
客户端调用此方法会触发到服务端的EnvironmentController中的labelled()方法,该方法会从相应的配置仓库返回配置信息,封装成Environment对象返回
看起来好像都没什么问题,可是实际执行序列化和反序列化都是使用的Spring MVC的HttpMessageConverter来处理的,如图
这里可以明显看到客户端并没有要求服务端必须返回json,那么服务端处理的时候选择按照messageConverter的顺序来判断是否支持头信息进行序列化的
可以看到服务端选择MappingJackson2XmlHttpMessageConverter这个转换器进行转换,所带头信息为application/xml,这就悲剧了,实际上有数组的情况下这个转换器支持不了的。我们是希望用MappingJackson2HttpMessageConverter这个转换器来转换,它所支持的头信息为application/json,这才是正确的。。
由于客户端宽泛的限制导致服务端并没有处理好这个问题,我这里直接使用切面强制返回json数据并限制了头信息为application/json保证客户端解析的正确性。下面列出代码
/**
* @author xiezhengchao
* @since 17/12/27 上午10:20.
* 解决1.4.0.RELEASE版本返回值为数组时所引发的bug,如果后续版本修复了可以不需要这个切面配置
*/
@Aspect
@Component
public class EnvironmentAspect{
private final Gson gson = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting().create();
@Pointcut("execution(* org.springframework.cloud.config.server.environment.EnvironmentController.labelled(..))")
public void getResource(){}
@Around("getResource()")
public Object labelledJson(ProceedingJoinPoint pjp) throws Throwable{
HttpServletResponse response = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getResponse();
Object object = pjp.proceed();//执行该方法
finalOutput(response, object);
return null;
}
private void finalOutput(HttpServletResponse response, Object result) throws IOException{
response.setCharacterEncoding("UTF-8");
response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
String jsonStr = gson.toJson(result);
writeData(response, jsonStr);
}
private void writeData(HttpServletResponse response, String jsonStr) throws IOException{
try {
response.getOutputStream().write(jsonStr.getBytes("UTF-8"));
} finally {
response.getOutputStream().flush();
response.getOutputStream().close();
}
}
}
通过这种方法确保了客户端返回的值都是通过json处理的,解决了上面的问题。
其他
这个问题是完全没想到会找了两天才解决,去官网翻了一圈都没发现配置数组问题的,google也没搜到。。只能看源码翻了。
实际上如果你只是引用了spring cloud config那么不会出现这个问题,这是其他包的引用导致的,但是我还是觉得客户端在发送的时候应该直接限制好json这样就没有这么多问题了。