spring cloud config处理数组配置异常解决方法

项目接入了配置中心,之前选用的都是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这样就没有这么多问题了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,755评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,369评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,799评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,910评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,096评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,159评论 3 411
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,917评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,360评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,673评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,814评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,509评论 4 334
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,156评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,882评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,123评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,641评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,728评论 2 351

推荐阅读更多精彩内容