0

0

ASP.NET Core 中的问题详细信息服务如何用法?

小老鼠

小老鼠

发布时间:2025-10-05 16:31:02

|

1059人浏览过

|

来源于php中文网

原创

ASP.NET Core通过RFC 7807规范实现标准化错误响应,支持自动与手动返回application/problem+json格式的结构化错误信息。在Program.cs中配置ApiBehaviorOptions和UseExceptionHandler可启用默认错误处理机制,控制器中可直接使用Problem()、ValidationProblem()或自定义ProblemDetails派生类返回详细错误,便于客户端解析与统一处理。

asp.net core 中的问题详细信息服务如何用法?

在 ASP.NET Core 中,问题详细信息(Problem Details)服务用于标准化错误响应格式,遵循 RFC 7807 规范。它让 API 返回结构化的错误信息,便于客户端解析和处理。

启用问题详细信息服务

ASP.NET Core 默认支持问题详细信息,尤其是在开发环境中。当你抛出异常或返回特定状态码时,框架可自动返回 application/problem+json 格式的响应。

要确保启用该功能,在 Program.cs 中配置:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
// 启用问题详细信息作为默认错误响应
builder.Services.Configure(options =>
{
    options.InvalidModelStateResponseFactory = context =>
    {
        var problemDetails = new ValidationProblemDetails(context.ModelState)
        {
            Type = "https://tools.ietf.org/html/rfc7231#section-6.5.1",
            Title = "One or more validation errors occurred.",
            Status = StatusCodes.Status400BadRequest,
            Detail = "请检查请求数据是否符合要求。",
            Instance = context.HttpContext.Request.Path
        };

        return new BadRequestObjectResult(problemDetails);
    };
});

var app = builder.Build();

app.UseExceptionHandler(exceptionHandlerApp =>
{
    exceptionHandlerApp.Run(async context =>
    {
        context.Response.StatusCode = StatusCodes.Status500InternalServerError;
        context.Response.ContentType = "application/problem+json";

        var problemDetails = new ProblemDetails
        {
            Status = StatusCodes.Status500InternalServerError,
            Title = "An unexpected error occurred.",
            Type = "https://tools.ietf.org/html/rfc7231#section-6.6.1",
            Detail = "请联系系统管理员或稍后重试。"
        };

#if DEBUG
        problemDetails.Extensions["traceId"] = context.TraceIdentifier;
        problemDetails.Extensions["message"] = context.Features.Get()?.Error.Message;
#endif

        await context.Response.WriteAsJsonAsync(problemDetails);
    });
});

app.UseHttpsRedirection();
app.MapControllers();

app.Run();

手动返回问题详细信息

你可以在控制器中直接使用 Problem()ValidationProblem() 或构造 ProblemDetails 对象返回标准错误响应。

Heeyo
Heeyo

Heeyo:AI儿童启蒙陪伴师,风靡于硅谷的儿童AI导师和玩伴

下载
示例:返回自定义问题详情
[HttpGet("error")]
public IActionResult TriggerError()
{
    return Problem(
        detail: "数据库连接失败。",
        title: "服务暂时不可用",
        statusCode: StatusCodes.Status503ServiceUnavailable,
        type: "https://example.com/errors/db-connection-failed",
        instance: Request.Path);
}
验证失败时返回问题详情
[HttpPost]
public IActionResult Create([FromBody] MyModel model)
{
    if (!ModelState.IsValid)
    {
        return ValidationProblem();
    }
    // 处理逻辑
    return Ok();
}

自定义问题详情类型

你可以继承 ProblemDetails 添加额外字段,比如错误代码或建议操作。

public class CustomProblemDetails : ProblemDetails
{
    public string ErrorCode { get; set; }
    public string[] Suggestions { get; set; }
}

使用方式:

return new ObjectResult(new CustomProblemDetails
{
    Status = 400,
    Title = "输入参数错误",
    Detail = "邮箱格式不正确",
    ErrorCode = "INVALID_EMAIL",
    Suggestions = new[] { "检查邮箱拼写", "使用有效域名" },
    Instance = Request.Path
})
{
    StatusCode = 400
};
基本上就这些。通过合理使用问题详细信息,你的 API 错误会更清晰、统一,也更容易被前端或第三方系统处理。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

412

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

75

2025.09.10

xml格式相关教程
xml格式相关教程

本专题整合了xml格式相关教程汇总,阅读专题下面的文章了解更多详细内容。

0

2026.01.19

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

13

2026.01.19

微信聊天记录删除恢复导出教程汇总
微信聊天记录删除恢复导出教程汇总

本专题整合了微信聊天记录相关教程大全,阅读专题下面的文章了解更多详细内容。

87

2026.01.18

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

111

2026.01.16

全民K歌得高分教程大全
全民K歌得高分教程大全

本专题整合了全民K歌得高分技巧汇总,阅读专题下面的文章了解更多详细内容。

155

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

AngularJS教程
AngularJS教程

共24课时 | 2.7万人学习

CSS教程
CSS教程

共754课时 | 20.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号