NetCore3.1 Controller中直接返回JObject对象抛出异常解决方案

问题描述

在NetCore 3.1的Web项目中，Controller有一个方法直接返回JObject对象时，抛出了异常
$\textcolor{red}{System.NotSupportedException : The collection type 'Newtonsoft.Json.Linq.JObject' is not supported.}$

这是因为在Web项目中，响应结果的的序列化器使用的System.Text.Json包下的。它无法直接序列化JObject类型的对象。

问题验证

在Nunit中编写测试方法：

    public void Test2() { 
          //测试序列化 JObject对象
          JObject obj= new JObject();
          obj.Add("msg", "主机配置错误，未找到对应门岗");
          var str= Newtonsoft.Json.JsonConvert.SerializeObject(obj); //Newtonsoft.Json 正常序列化
          Console.WriteLine(str);

          str = System.Text.Json.JsonSerializer.Serialize(obj); 
          //System.Text.Json 无法序列化JObject的对象，会抛出异常System.NotSupportedException : The collection type 'Newtonsoft.Json.Linq.JObject' is not supported.
         //NetCore3.1中是默认使用System.Text.Json 去作为相应的序列化器，这也解释了为什么Controller直接返回JObject对象时，会抛出错误
          Console.WriteLine(str);
        }

在这里插入图片描述
运行单元测试方法后，发现Newtonsoft.Json可以正常序列化JObject对象，而System.Text.Json不能序列化JObject 类型的对象。因此需要替换到Web项目中的默认序列化器。

解决方法

在StartUp中的服务配置类中修改默认的关于序列化器的配置。这里需要先安装Nuget包Microsoft.AspNetCore.Mvc.NewtonsoftJson 【NetCore 3.1版本安装的是3.1.32】。这个包提供了对Newtonsoft.Json库的支持。

     public void ConfigureServices(IServiceCollection services)
        {


            // 配置 Newtonsoft.Json 序列化器 [当Controller直接返回JObject时，因为使用的System.Text.Json作为序列化器，无法序列化JObject对象，会抛出异常]
            services.AddControllers().AddNewtonsoftJson(options =>
            {
                options.SerializerSettings.ContractResolver = new DefaultContractResolver();
            });
      }