C#中处理HTTP请求和响应（GET、POST）

在C#中处理HTTP请求和响应，特别是在ASP.NET Core中，通常涉及到创建控制器（Controllers）和操作方法（Action Methods）。

控制器是处理HTTP请求并生成HTTP响应的类。操作方法则是控制器中的方法，它们对应于特定的HTTP路由和HTTP方法（如GET、POST等）。

以下是如何在C#中处理HTTP请求和响应的基本步骤，以及GET和POST请求方法的示例：

1. 创建ASP.NET Core项目

首先，你需要创建一个ASP.NET Core Web项目。你可以使用Visual Studio、Visual Studio Code、.NET CLI或其他工具来创建项目。

2. 创建控制器

在ASP.NET Core项目中，你可以通过添加一个新的控制器类来处理HTTP请求。控制器类通常位于Controllers文件夹中。

3. 处理GET请求

要在C#中处理GET请求，你可以在控制器中添加一个带有HttpGet特性的操作方法。例如：

[ApiController]
[Route("[controller]")]
public class ProductsController : ControllerBase
{
    // 假设有一个产品列表
    private readonly List<Product> _products = new List<Product>
    {
        new Product { Id = 1, Name = "Product 1", Price = 100 },
        new Product { Id = 2, Name = "Product 2", Price = 200 }
    };

    // 处理GET请求，返回所有产品
    [HttpGet]
    public IActionResult Get()
    {
        return Ok(_products); // 返回产品列表的JSON表示
    }

    // 处理GET请求，根据ID返回单个产品
    [HttpGet("{id}")]
    public IActionResult Get(int id)
    {
        var product = _products.FirstOrDefault(p => p.Id == id);

        if (product == null)
        {
            return NotFound(); // 如果产品不存在，返回404 Not Found
        }

        return Ok(product); // 返回单个产品的JSON表示
    }
}

在这个示例中，Get方法处理不带参数的GET请求，并返回所有产品。带有{id}的Get方法处理带有产品ID的GET请求，并返回单个产品。

4. 处理POST请求

要在C#中处理POST请求，你可以在控制器中添加一个带有HttpPost特性的操作方法。POST请求通常用于提交数据到服务器。例如：

// ... 省略其他代码 ...

// 处理POST请求，添加新产品
[HttpPost]
public IActionResult Post([FromBody] Product product)
{
    if (product == null || !ModelState.IsValid)
    {
        return BadRequest("Invalid product data"); // 如果数据无效，返回400 Bad Request
    }

    _products.Add(product); // 假设这里只是将产品添加到内存中，实际上你可能需要保存到数据库

    return CreatedAtAction(nameof(Get), new { id = product.Id }, product); // 返回201 Created状态码和产品的位置
}

在这个示例中，Post方法处理POST请求，并接受一个Product对象作为请求体。如果产品数据有效，则将其添加到产品列表中（在实际应用中，你可能需要将其保存到数据库）。然后，它返回一个201 Created状态码和产品的位置。

5. 运行和测试应用程序

最后，你可以运行ASP.NET Core应用程序，并使用工具如Postman、curl或浏览器来测试你的HTTP请求和响应。

这些只是基本的示例，ASP.NET Core提供了许多其他特性和功能，如路由、模型绑定、模型验证、异常处理等，可以帮助你更好地处理HTTP请求和响应。

【路由】

在ASP.NET Core中，路由是定义URL模式与特定操作方法的映射的过程。ASP.NET Core 使用路由中间件来处理这些URL模式，并将它们映射到控制器中的操作方法。以下是如何在ASP.NET Core中配置和使用路由的基本步骤：

1. 创建控制器和操作方法

首先，你需要创建包含操作方法的控制器。这些操作方法通常带有HTTP方法属性（如HttpGet、HttpPost等），这些属性定义了哪些HTTP请求应被路由到这些方法。

[ApiController]
[Route("[controller]")] // 这里的[controller]是一个占位符，它会被替换为控制器的名称
public class ProductsController : ControllerBase
{
    // GET api/products
    [HttpGet]
    public IActionResult Get()
    {
        // ... 返回产品列表
    }

    // GET api/products/5
    [HttpGet("{id}")]
    public IActionResult Get(int id)
    {
        // ... 根据ID返回产品
    }

    // POST api/products
    [HttpPost]
    public IActionResult Post([FromBody] Product product)
    {
        // ... 创建产品并返回结果
    }
}

2. 配置路由

在ASP.NET Core中，路由通常在Startup.cs文件的Configure方法中配置，特别是在UseEndpoints或UseMvc（对于旧版本的ASP.NET Core MVC）方法中。

对于ASP.NET Core 3.0及更高版本，使用UseEndpoints方法：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ... 其他中间件配置 ...

    app.UseRouting(); // 启用路由中间件

    // ... 认证和授权中间件（如果需要） ...

    app.UseEndpoints(endpoints =>
    {
        // 启用对控制器的路由
        endpoints.MapControllers();

        // 你可以在这里添加其他端点映射，例如映射到Razor Pages、SignalR等
    });
}

对于ASP.NET Core 2.x及更早版本，使用UseMvc方法：

public void Configure(IApplicationBuilder app)
{
    // ... 其他中间件配置 ...

    app.UseMvc(routes =>
    {
        // 启用对控制器的路由
        routes.MapRoute(
            name: "default",
            template: "{controller=Home}/{action=Index}/{id?}");
    });
}

但是，请注意，在ASP.NET Core 3.0及更高版本中，建议使用基于属性的路由（如上面的ProductsController示例所示），而不是传统的基于约定的路由。

3. 自定义路由模板

你可以通过在控制器或操作方法上指定路由模板来进一步自定义路由。例如：

[ApiController]
[Route("api/[controller]")] // 将所有路由都放在api/前缀下
public class ProductsController : ControllerBase
{
    // ... 操作方法 ...

    // 自定义路由模板
    [HttpGet("by-category/{category:alpha}")]
    public IActionResult GetByCategory(string category)
    {
        // ... 根据类别返回产品列表
    }
}

在这个例子中，GetByCategory方法将响应类似api/products/by-category/electronics这样的URL。

4. 路由约束

你还可以使用路由约束来限制路由参数的值。在上面的例子中，:alpha约束确保category参数只包含字母字符。ASP.NET Core提供了许多内置约束，如int、bool、length、minlength、maxlength、range、regex等。你也可以创建自定义约束。

5. 路由参数和查询字符串

在操作方法中，你可以通过参数名称来捕获路由参数和查询字符串值。路由参数是URL路径的一部分，而查询字符串是URL末尾的键值对（以?开始）。ASP.NET Core会自动将这些值绑定到操作方法的参数上。

6. 测试路由

你可以使用各种工具（如Postman、curl、浏览器等）来测试你的路由是否按预期工作。确保你的应用程序正在运行，并尝试访问不同的URL来验证路由配置是否正确。

【模型绑定】

在ASP.NET Core中，模型绑定（Model Binding）是一个自动过程，它将HTTP请求中的数据（如路由数据、查询字符串参数、表单数据、请求体等）映射到控制器操作方法的参数上。这使得开发人员能够更轻松地处理请求数据，而无需手动解析请求的各个部分。

以下是如何在ASP.NET Core中使用模型绑定的步骤：

1. 定义模型类

首先，你需要定义一个或多个模型类来表示你的数据。这些类通常是简单的POCO（Plain Old CLR Objects）类，具有公共属性和字段。

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
}

2. 在控制器操作方法中使用模型类作为参数

在控制器操作方法中，你可以将模型类作为参数。ASP.NET Core的模型绑定系统将尝试从HTTP请求中提取数据，并将其填充到该模型的实例中。

[ApiController]
[Route("[controller]")]
public class ProductsController : ControllerBase
{
    // POST api/products
    [HttpPost]
    public IActionResult Post(Product product)
    {
        // 在这里，product参数已经被模型绑定系统填充了从请求体中提取的数据

        // 假设将产品保存到数据库或其他存储中...

        return CreatedAtAction(nameof(Get), new { id = product.Id }, product);
    }
}

在这个例子中，当发送一个POST请求到api/products时，模型绑定系统将从请求体中读取JSON或XML数据（取决于Content-Type头），并尝试将其反序列化为Product类的实例。然后，它将该实例作为参数传递给Post方法。

3. 自定义模型绑定

虽然ASP.NET Core提供了内置的模型绑定功能，但你也可以创建自定义的模型绑定器来处理特定的需求。这通常在你需要处理复杂的数据类型或自定义的序列化/反序列化逻辑时很有用。

要创建自定义模型绑定器，你需要实现IModelBinder接口或继承ModelBinder类，并在Startup.cs中配置模型绑定选项以使用你的自定义绑定器。

4. 处理模型绑定错误

如果模型绑定过程中发生错误（例如，无法从请求中解析数据，或者数据不符合模型类的要求），ASP.NET Core将自动将模型状态设置为无效，并将错误添加到ModelState字典中。你可以在操作方法中检查ModelState.IsValid属性来确定模型绑定是否成功。

[HttpPost]
public IActionResult Post(Product product)
{
    if (!ModelState.IsValid)
    {
        // 模型绑定失败，返回错误响应
        return BadRequest(ModelState);
    }

    // 模型绑定成功，继续处理请求...
}

在这个例子中，如果模型绑定失败，Post方法将返回一个带有错误详细信息的400 Bad Request响应。你可以根据需要自定义错误响应的格式和内容。

【模型验证】

在ASP.NET Core中，模型验证（Model Validation）是一个强大的功能，它允许你在将数据保存到数据库或执行其他操作之前验证用户输入的数据。ASP.NET Core 提供了一系列内置的数据注解（Data Annotations）用于模型验证，并且支持自定义验证逻辑。

以下是使用ASP.NET Core进行模型验证的步骤：

1. 在模型类中添加数据注解

在你的模型类（如Product类）中，使用数据注解来定义验证规则。ASP.NET Core 提供了一些常用的注解，如Required、Range、StringLength等。

public class Product
{
    public int Id { get; set; }

    [Required]
    [StringLength(100, ErrorMessage = "Name must be at least {2} and at max {1} characters long.")]
    public string Name { get; set; }

    [Required]
    [Range(typeof(decimal), "0.01", "1000.00")]
    public decimal Price { get; set; }
}

在上面的例子中，Name属性被标记为Required，表示它不能为空，并且它的长度必须在1到100个字符之间。Price属性被标记为Required，表示它不能为空，并且它的值必须在0.01到1000.00之间。

2. 在控制器操作方法中检查模型状态

在控制器操作方法中，你可以通过检查ModelState.IsValid属性来确定模型验证是否成功。如果模型验证失败，你可以返回一个错误响应。

[HttpPost]
public IActionResult Post([FromBody] Product product)
{
    if (!ModelState.IsValid)
    {
        // 模型验证失败，返回错误响应
        return BadRequest(ModelState);
    }

    // 模型验证成功，继续处理请求...
    // ...

    return CreatedAtAction(nameof(GetProduct), new { id = product.Id }, product);
}

在这个例子中，如果模型验证失败（即ModelState.IsValid为false），则返回一个带有验证错误的400 Bad Request响应。你可以根据需要自定义错误响应的格式和内容。

3. 自定义验证逻辑

除了使用内置的数据注解外，你还可以创建自定义的验证逻辑。这可以通过实现IValidatableObject接口或在模型属性上使用CustomValidation属性来完成。

public class Product : IValidatableObject
{
    // ... 其他属性和方法 ...

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (Price < Cost) // 假设Cost是另一个属性或计算得出的值
        {
            yield return new ValidationResult("Price cannot be less than cost.", new[] { nameof(Price) });
        }
    }
}

在这个例子中，Product类实现了IValidatableObject接口，并提供了自定义的验证逻辑。如果Price小于Cost，则返回一个验证错误。

4. 显示验证错误

在客户端（如MVC视图或Razor Pages），你可以使用ASP.NET Core的内置功能来显示验证错误。在Razor视图中，你可以使用@Html.ValidationSummary()和@Html.ValidationMessageFor()方法来显示验证错误的摘要和针对特定属性的错误消息。

在API控制器中，你通常会将验证错误作为响应的一部分返回给客户端，客户端可以根据这些错误消息来显示相应的错误提示。

【异常处理】

在ASP.NET Core中，异常处理是一个重要的方面，因为它确保你的应用程序在遇到未处理的异常时能够优雅地响应。ASP.NET Core 提供了几种处理异常的方法，包括使用中间件、控制器过滤器以及特定的异常处理页面（对于MVC和Razor Pages应用程序）。

以下是几种在ASP.NET Core中处理异常的方法：

1. 使用中间件处理异常

你可以使用中间件来捕获和处理应用程序中的异常。ASP.NET Core 提供了一个名为 UseExceptionHandler 的中间件，它可以捕获异常并提供一个指定的错误处理路径。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage(); // 开发环境显示详细异常页面
    }
    else
    {
        app.UseExceptionHandler("/Error"); // 非开发环境捕获异常并重定向到 /Error 路由
        // app.UseHsts(); // HTTPS重定向（可选）
    }

    // ... 其他中间件配置 ...

    app.UseRouting();

    // ... 其他中间件配置 ...

    app.UseEndpoints(endpoints =>
    {
        // ... 路由配置 ...
        endpoints.MapGet("/Error", async context =>
        {
            var exceptionHandlerPathFeature = context.Features.Get<IExceptionHandlerPathFeature>();
            var exception = context.Features.Get<IExceptionHandlerFeature>()?.Error;

            // 在这里处理异常并返回错误响应，例如使用 View 或 JSON
            await context.Response.WriteAsJsonAsync(new { status = "error", message = "An error occurred." });
        });
    });
}

2. 使用控制器操作处理异常

对于MVC或Web API项目，你可以创建一个特定的控制器操作来处理异常。通过配置中间件将异常路由到该操作。

[ApiController]
[Route("[controller]")]
public class ErrorController : ControllerBase
{
    [HttpGet]
    public IActionResult Get()
    {
        // 获取异常详情（如果可用）
        var exceptionHandlerPathFeature = HttpContext.Features.Get<IExceptionHandlerPathFeature>();
        var exception = HttpContext.Features.Get<IExceptionHandlerFeature>()?.Error;

        // 返回错误响应，例如使用 View 或 JSON
        return StatusCode(StatusCodes.Status500InternalServerError, new { status = "error", message = "An error occurred." });
    }
}

3. 使用异常过滤器

在MVC中，你可以创建异常过滤器（IExceptionFilter）来在全局范围内处理异常。这允许你在控制器操作之前和之后捕获异常，并执行自定义的逻辑。

public class GlobalExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        // 自定义异常处理逻辑
        // 例如，记录异常详情到日志
        // ...

        // 设置结果或执行其他操作
        context.Result = new ObjectResult(new { status = "error", message = "An error occurred." })
        {
            StatusCode = StatusCodes.Status500InternalServerError
        };

        // 标记异常已处理，防止进一步传播
        context.ExceptionHandled = true;
    }
}

// 在Startup.cs中注册过滤器
services.AddControllers(options =>
{
    options.Filters.Add<GlobalExceptionFilter>();
});

4. 对于MVC和Razor Pages应用程序，使用错误视图

对于MVC和Razor Pages应用程序，你可以创建一个或多个错误视图（如Error.cshtml）来显示友好的错误消息。当应用程序遇到未处理的异常时，它会查找这些视图并显示它们。

确保你的错误视图位于Views/Shared文件夹中，以便它可以在整个应用程序中共享。然后，配置中间件以在发生异常时显示错误视图（如上面的 UseExceptionHandler 示例所示）。

5. 日志记录

无论你选择哪种异常处理方法，都应该考虑将异常详情记录到日志中。这有助于你在生产环境中诊断问题。ASP.NET Core 提供了内置的日志记录API，你可以使用它来记录异常和其他重要信息。