在.NET Web API中设置响应输出Json数据格式的两种常用方式-51CTO.COM

在.NET Web API开发中，将数据以JSON格式返回给客户端是一个常见需求。JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，易于人阅读和编写，同时也易于机器解析和生成，因此被广泛应用于Web API的数据传输中。本文将介绍两种在.NET Web API中设置响应输出为JSON数据格式的常用方式：使用JsonResult类和配置Startup类。

一、使用JsonResult类

JsonResult类是ASP.NET Core MVC中的一个类，它继承自ActionResult类，专门用于将对象序列化为JSON格式并返回给客户端。使用JsonResult类，开发者可以在控制器方法中直接返回JSON数据，这种方式简单直观，适用于需要在特定方法中返回JSON数据的场景。

示例代码

假设我们有一个简单的WeatherForecastController控制器，它包含一个GetWeatherForecast方法，该方法返回一个天气预报列表。我们可以使用JsonResult类来返回JSON格式的数据：

using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    [HttpGet]
    public JsonResult GetWeatherForecast()
    {
        var rng = new System.Random();
        var forecast = new List<WeatherForecast>();
        for (int i = 0; i < 5; i++)
        {
            forecast.Add(new WeatherForecast
            {
                Date = DateTime.Now.AddDays(i),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            });
        }

        return new JsonResult(forecast);
    }
}

public class WeatherForecast
{
    public DateTime Date { get; set; }
    public int TemperatureC { get; set; }
    public string Summary { get; set; }
}

在上述代码中，GetWeatherForecast方法创建了一个包含5个天气预报的列表，然后使用JsonResult类将这个列表序列化为JSON格式并返回。客户端接收到的响应内容将是一个JSON数组，每个元素都是一个包含日期、温度和天气摘要的JSON对象。

优点

简单易用：直接在控制器方法中返回JsonResult对象，无需额外配置。
灵活性高：可以在不同的控制器方法中根据需要返回不同格式的数据。

缺点

重复代码：如果多个方法都需要返回JSON数据，可能会导致重复编写JsonResult相关的代码。
不适用于全局配置：这种方式不适合对整个Web API的响应格式进行统一配置。

二、配置Startup类

另一种设置响应输出为JSON数据格式的方式是在Startup类中进行全局配置。通过在ConfigureServices方法中配置MVC服务和在Configure方法中配置中间件，可以使得整个Web API默认以JSON格式返回数据。这种方式适用于需要对整个API的响应格式进行统一设置的场景。

示例代码

在Startup类中配置默认的JSON响应格式：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.AspNetCore.Mvc;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 添加MVC服务，并配置默认的输出格式为JSON
        services.AddControllers().AddJsonOptions(options =>
        {
            // 可以在这里配置JSON序列化选项，例如日期格式、驼峰命名等
            options.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
            options.JsonSerializerOptions.WriteIndented = true;
        });
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }
}

在上述代码中，我们在ConfigureServices方法中调用了AddControllers方法来添加MVC服务，并通过AddJsonOptions方法配置了JSON序列化选项。这样，整个Web API的响应数据将默认以JSON格式返回，并且可以统一设置JSON序列化的行为，例如将属性名称转换为驼峰命名格式，并以缩进的方式格式化输出JSON。

优点

统一配置：可以在整个Web API范围内统一设置响应格式，无需在每个控制器方法中重复配置。
易于维护：当需要修改响应格式时，只需在Startup类中进行调整，无需逐个修改控制器方法。

缺点

灵活性降低：如果需要在某些特定的控制器方法中返回非JSON格式的数据，可能需要进行额外的配置或使用其他方法。

三、总结

在.NET Web API中设置响应输出为JSON数据格式的两种常用方式各有优缺点，适用于不同的场景。使用JsonResult类的方式简单直观，适合在特定方法中返回JSON数据；而配置Startup类的方式可以实现全局统一配置，适合对整个API的响应格式进行统一设置。开发者可以根据实际需求和项目特点选择合适的方式。在实际开发中，也可以结合使用这两种方式，以满足不同的业务需求和开发要求。