Flutter使用retrofit与json_serializable解析含换行符JSON报错问题
问题根源定位
- 这个报错和
retrofit、json_serializable本身没有关系:两者都是在拿到合法的JSON Map之后才做实体类映射,真正抛错的环节是最开始把网络返回的原始字符串转成Map的步骤——也就是Dart内置的json.decode方法的解析过程。 - 按照JSON规范,双引号包裹的字符串值内部,不允许直接出现未转义的原始控制字符(比如实际的换行、回车),这类字符必须转成
\n这种反斜杠加n的双字符序列才是合法格式。 - 同样的JSON在Android能正常解析,是因为Android自带的org.json解析器默认开了宽松模式,会自动兼容这类不规范的输出;但Dart的JSON解析器是严格按规范实现的,没有内置容错逻辑,碰到这种嵌在字符串里的未转义换行,直接就抛“unexpected character”的错,后面的流程根本走不到。
可落地的处理方案
网络层拦截预处理(最快落地,零业务侵入)
这个方案不需要改业务代码,也不用等后端排期,适合紧急修复bug的场景:
- 因为retrofit本身是基于Dio封装的,直接给Dio加个全局响应拦截器,在原始字符串被传递给
json.decode之前,先做兼容处理即可。 - 核心处理逻辑很简单:把原始响应字符串里所有的实际换行、回车控制字符(也就是Dart字符串里用
'\n'、'\r'指代的ASCII 10、13控制字符,不是反斜杠加n组成的双字符转义序列),统一替换成转义后的\\n。 - 这种替换完全没有副作用:
- JSON结构上的换行(比如大括号、逗号后面的换行)本来就是解析器会忽略的空白字符,替换成转义序列之后根本不影响解析结果
- 字符串值内部的未转义换行,替换后就变成了符合规范的转义换行,刚好解决解析报错的问题
- 参考实现代码:
// Dio响应拦截器 Response _handleResponse(Response response) { // 仅处理字符串类型的原始响应,避免影响已经解码的其他格式数据 if (response.data is String) { final rawJsonStr = response.data as String; final validJsonStr = rawJsonStr .replaceAll('\n', '\\n') .replaceAll('\r', '\\n'); response.data = validJsonStr; } return response; }
- 处理完成后的字符串会变成完全符合规范的JSON格式,后续retrofit的自动类型转换、json_serializable的实体映射都可以正常执行,不会再抛出格式错误。
推动后端修正输出(根源解决)
这种在字符串值里直接嵌入未转义换行的JSON属于不规范输出,iOS原生的JSON解析器也是严格模式,迟早会踩同样的兼容问题。和后端对接时说明情况,要求对方按照JSON规范对字符串值里的特殊字符(换行、引号、反斜杠、制表符等)做标准转义,从根源上消除多端的解析适配成本。
自定义宽松解析(长期兼容能力建设)
如果后续对接的接口还有更多不规范的格式(比如未转义的双引号、多余的注释等),可以替换Dart内置的严格JSON解析器,引入支持宽松模式的JSON解析库,在Dio初始化阶段配置全局的解码逻辑,代替默认的json.decode完成字符串到Map的转换。
内容的提问来源于stack exchange,提问作者Kubat Azimov
相关产品推荐
相关产品推荐

