基于netcore的webapi 返回json多重转义符导致反序列异常问题

最近用netcore做服务端来实现客户端更新下载功能。

获取版本号如下:

        /// <summary>
        /// Gets this instance.
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        [Route("GetVersion")]
        public string GetVersion()
        {
            _logger.LogInformation("======receive getVersion request!");
            VersionInfo info = new VersionInfo {Result = _appModel};
            var msg = JsonConvert.SerializeObject(info);
            _logger.LogInformation($"======send getVersion response;{msg}!");
            return msg;
        }

但是客户端实际收到的字符串多了一层转义符“\\”,导致反序列化为实体时候失败,抛出异常。

尝试修改返回值类型为通用的IActionResult,代码如下:

        /// <summary>
        /// Gets this instance.
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        [Route("GetVersion")]
        public IActionResult GetVersion()
        {
            _logger.LogInformation("======receive getVersion request!");
            VersionInfo info = new VersionInfo {Result = _appModel};
            var msg = JsonConvert.SerializeObject(info);
            _logger.LogInformation($"======send getVersion response;{msg}!");
            return Ok(msg);
        }

 客户端收到内容还是一样,多了一层转义符“\\”.最终在微软官网找到答案:

基于netcore的webapi 返回json多重转义符导致反序列异常问题

最终解决办法:

原来netcore会自动的将返回对象进行序列化,我们返回之前就已经序列化过了,就导致重复序列化就多了转义符“\\”,所以去除返回之前的序列就好了,直接返回实体对象。最终代码如下:

        /// <summary>
        /// Gets this instance.
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        [Route("GetVersion")]
        public IActionResult GetVersion()
        {
            _logger.LogInformation("======receive getVersion request!");
            VersionInfo info = new VersionInfo {Result = _appModel};
            return Ok(info);
        }