我可以使用在启动过程中配置的MvcJsonOptions在自定义中间件中进行序列化吗?

时间:2019-03-22 17:44:47

标签: c# asp.net-core asp.net-core-2.0

我正在使用中间件构建ASP.NET Core Api,以进行全局异常处理。在Startup类中,我配置了一些将用于所有控制器的JSON选项。

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc()
        .AddJsonOptions(options =>
        {
            options.SerializerSettings.ContractResolver = new DefaultContractResolver()
            {
                NamingStrategy = new SnakeCaseNamingStrategy()
            };
            options.SerializerSettings.Converters.Add(new StringEnumConverter());
        });
}

然后,我创建了一个用于异常处理的自定义中间件。中间件应该记录错误并以JSON返回错误响应。问题在于全局Newtonsoft的JsonConvert不使用Mvc初始化期间指定的选项(很明显)。

错误处理程序中间件代码:

public class ErrorHandlingMiddleware
{
    private readonly RequestDelegate _next;

    public ErrorHandlingMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context, ILogger<ErrorHandlingMiddleware> logger)
    {
        try
        {
            await _next(context);
        }
        catch (Exception ex)
        {
            await HandleExceptionAsync(context, ex, logger);
        }
    }

    private Task HandleExceptionAsync(HttpContext context, Exception ex, ILogger logger)
    {
        var errorResponse = new ErrorResponse { Message = ex.Message };
        logger.LogError(ex, errorResponse.Message);

        var result = JsonConvert.SerializeObject(errorResponse);
        context.Response.ContentType = "application/json";
        context.Response.StatusCode = 500;
        return context.Response.WriteAsync(result);
    }
}

问题是:有什么方法可以在我的自定义中间件中使用控制器中使用的相同JSON序列化器?我想避免在两个不同的地方设置相同的配置。

1 个答案:

答案 0 :(得分:1)

JsonConvert.SerializeObject有一个overload that also takes an instance of JsonSerializerSettings,可以与选项模式和依赖项注入结合使用。总而言之,看起来像这样:

public class ErrorHandlingMiddleware
{
    private readonly RequestDelegate _next;
    private readonly JsonSerializerSettings _jsonSerializerSettings;

    public ErrorHandlingMiddleware(RequestDelegate next, IOptions<MvcJsonOptions> mvcJsonOptions)
    {
        _next = next;
        _jsonSerializerSettings = mvcJsonOptions.Value.SerializerSettings;
    }

    ...

    private Task HandleExceptionAsync(HttpContext context, Exception ex, ILogger logger)
    {
        ...
        var result = JsonConvert.SerializeObject(errorResponse, _jsonSerializerSettings);
        ...
    }
}

在此示例中,我们将注入已配置的MvcJsonOptions实例,然后将其SerializerSettings值传递给JsonConvert.SerializeObject