在.NET Web API開發(fā)中，將數(shù)據(jù)以JSON格式返回給客戶端是一個(gè)常見需求。JSON（JavaScript Object Notation）是一種輕量級(jí)的數(shù)據(jù)交換格式，易于人閱讀和編寫，同時(shí)也易于機(jī)器解析和生成，因此被廣泛應(yīng)用于Web API的數(shù)據(jù)傳輸中。本文將介紹兩種在.NET Web API中設(shè)置響應(yīng)輸出為JSON數(shù)據(jù)格式的常用方式：使用JsonResult類和配置Startup類。

一、使用JsonResult類

JsonResult類是ASP.NET Core MVC中的一個(gè)類，它繼承自ActionResult類，專門用于將對(duì)象序列化為JSON格式并返回給客戶端。使用JsonResult類，開發(fā)者可以在控制器方法中直接返回JSON數(shù)據(jù)，這種方式簡單直觀，適用于需要在特定方法中返回JSON數(shù)據(jù)的場景。

示例代碼

假設(shè)我們有一個(gè)簡單的WeatherForecastController控制器，它包含一個(gè)GetWeatherForecast方法，該方法返回一個(gè)天氣預(yù)報(bào)列表。我們可以使用JsonResult類來返回JSON格式的數(shù)據(jù)：

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方法創(chuàng)建了一個(gè)包含5個(gè)天氣預(yù)報(bào)的列表，然后使用JsonResult類將這個(gè)列表序列化為JSON格式并返回。客戶端接收到的響應(yīng)內(nèi)容將是一個(gè)JSON數(shù)組，每個(gè)元素都是一個(gè)包含日期、溫度和天氣摘要的JSON對(duì)象。

優(yōu)點(diǎn)

• 簡單易用：直接在控制器方法中返回JsonResult對(duì)象，無需額外配置。
• 靈活性高：可以在不同的控制器方法中根據(jù)需要返回不同格式的數(shù)據(jù)。

缺點(diǎn)

• 重復(fù)代碼：如果多個(gè)方法都需要返回JSON數(shù)據(jù)，可能會(huì)導(dǎo)致重復(fù)編寫JsonResult相關(guān)的代碼。
• 不適用于全局配置：這種方式不適合對(duì)整個(gè)Web API的響應(yīng)格式進(jìn)行統(tǒng)一配置。

二、配置Startup類

另一種設(shè)置響應(yīng)輸出為JSON數(shù)據(jù)格式的方式是在Startup類中進(jìn)行全局配置。通過在ConfigureServices方法中配置MVC服務(wù)和在Configure方法中配置中間件，可以使得整個(gè)Web API默認(rèn)以JSON格式返回?cái)?shù)據(jù)。這種方式適用于需要對(duì)整個(gè)API的響應(yīng)格式進(jìn)行統(tǒng)一設(shè)置的場景。

示例代碼

在Startup類中配置默認(rèn)的JSON響應(yīng)格式：

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服務(wù)，并配置默認(rèn)的輸出格式為JSON
        services.AddControllers().AddJsonOptions(options =>
        {
            // 可以在這里配置JSON序列化選項(xiàng)，例如日期格式、駝峰命名等
            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();
        });
    }
}

在上述代碼中，我們?cè)贑onfigureServices方法中調(diào)用了AddControllers方法來添加MVC服務(wù)，并通過AddJsonOptions方法配置了JSON序列化選項(xiàng)。這樣，整個(gè)Web API的響應(yīng)數(shù)據(jù)將默認(rèn)以JSON格式返回，并且可以統(tǒng)一設(shè)置JSON序列化的行為，例如將屬性名稱轉(zhuǎn)換為駝峰命名格式，并以縮進(jìn)的方式格式化輸出JSON。

優(yōu)點(diǎn)

• 統(tǒng)一配置：可以在整個(gè)Web API范圍內(nèi)統(tǒng)一設(shè)置響應(yīng)格式，無需在每個(gè)控制器方法中重復(fù)配置。
• 易于維護(hù)：當(dāng)需要修改響應(yīng)格式時(shí)，只需在Startup類中進(jìn)行調(diào)整，無需逐個(gè)修改控制器方法。

缺點(diǎn)

• 靈活性降低：如果需要在某些特定的控制器方法中返回非JSON格式的數(shù)據(jù)，可能需要進(jìn)行額外的配置或使用其他方法。

三、總結(jié)

在.NET Web API中設(shè)置響應(yīng)輸出為JSON數(shù)據(jù)格式的兩種常用方式各有優(yōu)缺點(diǎn)，適用于不同的場景。使用JsonResult類的方式簡單直觀，適合在特定方法中返回JSON數(shù)據(jù)；而配置Startup類的方式可以實(shí)現(xiàn)全局統(tǒng)一配置，適合對(duì)整個(gè)API的響應(yīng)格式進(jìn)行統(tǒng)一設(shè)置。開發(fā)者可以根據(jù)實(shí)際需求和項(xiàng)目特點(diǎn)選擇合適的方式。在實(shí)際開發(fā)中，也可以結(jié)合使用這兩種方式，以滿足不同的業(yè)務(wù)需求和開發(fā)要求。