Menu
CoddyTech

CORS

本课属于 Coddy ASP.NET Core 学习旅程的“REST API”单元。第 17 课,共 20 课。

https://shop.example.com 上的页面调用你的 API 时,浏览器会拦截响应。除非服务器通过 CORS 响应头允许其他来源访问,否则浏览器只允许页面读取来自同一 源(协议、主机和端口)的响应。在发送 PUT、PATCH、DELETE 请求或 JSON 请求体之前,浏览器会先发送 OPTIONS 请求,也就是预检请求。只有响应允许时,浏览器才会发送实际请求。

builder.Services.AddCors(options =>
    options.AddPolicy("shop", policy => policy
        .WithOrigins("https://shop.example.com")
        .WithMethods("GET", "POST")
        .WithHeaders("Content-Type")));
var app = builder.Build();
app.UseCors("shop");

CORS 中间件会用 204 状态码和允许的方法及响应头回应预检请求,并为发往该源的每个响应添加 Access-Control-Allow-Origin。其他源不会收到 CORS 响应头,因此浏览器会拦截响应。只有浏览器会强制执行 CORS 规则:curl 和请求栏会忽略这些规则。

challenge icon

挑战

中等

另一个网站上的看板应用 https://board.example.com 想要从浏览器调用你的 API。允许这个源,并且只允许这一个源。

  1. 在 Program.cs 中,在 builder.Build() 之前,使用 builder.Services.AddCors 添加名为 board 的 CORS 策略。该策略允许源 https://board.example.com、GET、POST、PUT、PATCH 和 DELETE 方法,以及 Content-Type 标头。
  2. 看板会根据 X-Total-Count 显示“第 1 页,共 3 页”。除非服务器公开更多响应标头,否则来自其他源的页面只能读取少数几个标准响应标头,因此请将 .WithExposedHeaders("X-Total-Count") 添加到策略中。
  3. 在 app.UseStatusCodePages(); 之后,使用 app.UseCors("board"); 启用该策略。

看板发出的预检请求会返回 204,并带有以下标头:

Access-Control-Allow-Origin: https://board.example.com
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Content-Type

试试看:按“运行”,选择 OPTIONS,路径填写 /api/tasks/2,并添加标头 Origin: https://board.example.com 和 Access-Control-Request-Method: DELETE。发送请求:响应为 204,正文为空,并且 Headers 选项卡中包含以上标头。使用相同的 Origin 发送 GET /api/tasks:响应为 200,并带有 Access-Control-Allow-Origin 和 Access-Control-Expose-Headers。使用 Origin: https://evil.example.com 时,响应不包含 CORS 标头。

亲手试试

using System.ComponentModel.DataAnnotations;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();

var tasks = new List<TaskItem>
{
    new(1, "Write the project brief", false, 1),
    new(2, "Book the meeting room", true, 3),
    new(3, "Send the invoice", false),
};
var nextId = 4;

bool TitleTaken(string title, int exceptId) =>
    tasks.Any(t => t.Id != exceptId && string.Equals(t.Title, title, StringComparison.OrdinalIgnoreCase));

app.MapGet("/api/tasks", (bool? done, string? search, int? priority, string? sort, HttpResponse response, int page = 1, int pageSize = 10) =>
{
    var errors = new Dictionary<string, string[]>();
    if (sort is not null && sort != "id" && sort != "title" && sort != "priority")
        errors["sort"] = ["Sort by id, title or priority."];
    if (priority is < 1 or > 3)
        errors["priority"] = ["Priority is 1 to 3."];
    if (page < 1)
        errors["page"] = ["Page starts at 1."];
    if (pageSize < 1 || pageSize > 50)
        errors["pageSize"] = ["Page size is 1 to 50."];
    if (errors.Count > 0) return Results.ValidationProblem(errors);

    IEnumerable<TaskItem> result = tasks;
    if (done is not null) result = result.Where(t => t.Done == done);
    if (!string.IsNullOrWhiteSpace(search))
        result = result.Where(t => t.Title.Contains(search, StringComparison.OrdinalIgnoreCase));
    if (priority is not null) result = result.Where(t => t.Priority == priority);
    if (sort == "title") result = result.OrderBy(t => t.Title);
    if (sort == "priority") result = result.OrderBy(t => t.Priority);

    var matching = result.ToList();
    response.Headers["X-Total-Count"] = matching.Count.ToString();
    return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});

app.MapGet("/api/tasks/{id:int}", (int id) =>
{
    var task = tasks.Find(t => t.Id == id);
    return task is null ? Results.NotFound() : Results.Ok(task);
});

app.MapPost("/api/tasks", (TaskInput input) =>
{
    var errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    if (TitleTaken(input.Title, 0))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    var task = new TaskItem(nextId++, input.Title, input.Done, input.Priority);
    tasks.Add(task);
    return Results.Created($"/api/tasks/{task.Id}", task);
});

app.MapPut("/api/tasks/{id:int}", (int id, TaskInput input) =>
{
    var errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    var index = tasks.FindIndex(t => t.Id == id);
    if (index == -1) return Results.NotFound();
    if (TitleTaken(input.Title, id))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    tasks[index] = new TaskItem(id, input.Title, input.Done, input.Priority);
    return Results.Ok(tasks[index]);
});

app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
    var errors = Validation.Errors(patch);
    if (errors is not null) return Results.ValidationProblem(errors);
    var index = tasks.FindIndex(t => t.Id == id);
    if (index == -1) return Results.NotFound();
    if (patch.Title is not null && TitleTaken(patch.Title, id))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    var task = tasks[index];
    tasks[index] = task with
    {
        Title = patch.Title ?? task.Title,
        Done = patch.Done ?? task.Done,
        Priority = patch.Priority ?? task.Priority,
    };
    return Results.Ok(tasks[index]);
});

app.MapDelete("/api/tasks/{id:int}", (int id) =>
{
    var removed = tasks.RemoveAll(t => t.Id == id);
    return removed == 0 ? Results.NotFound() : Results.NoContent();
});

app.MapDelete("/api/tasks", (bool? done) =>
{
    if (done != true)
    {
        return Results.ValidationProblem(new Dictionary<string, string[]>
        {
            ["done"] = ["Add ?done=true to delete the done tasks."],
        });
    }
    tasks.RemoveAll(t => t.Done);
    return Results.NoContent();
});

app.Run();

record TaskItem(int Id, string Title, bool Done, int Priority = 2);
record TaskInput(
    [property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
    bool Done,
    [property: Range(1, 3)] int Priority = 2);
record TaskPatch(string? Title, bool? Done, [property: Range(1, 3)] int? Priority);
quiz icon自我测试

这节课包含一个小测验。开始学习即可作答,并记录你的进度。

REST API中的所有课