Блог

Я пытаюсь использовать PostSharp в проекте WebAPI. Я не могу сосредоточиться на этой задаче. Я хотел бы использовать контракты PostSharp для проверки входящих DTO и централизованной обработки исключений в случае ошибки проверки. Но я не знаю, как применить аспект исключения на уровне класса, и, что еще хуже, как вернуть ответ на ошибку JSON, когда это произойдет.

Без примеров кода немного неясно, для чего вы пытаетесь использовать PostSharp. Похоже, вы ищете какую-то типичную проверку модели в ASP.NET Ядро (.NET 5) и возврат пользовательского ответа JSON (при условии, что вы работаете с ASP.NET веб-API).

Я знаю, что вы спрашиваете о PostSharp, но я считаю, что для этого требуется некоторый пользовательский код, чтобы он работал и возвращал пользовательские ответы в ASP.NET, в то время как вы получаете большую часть этого бесплатно с помощью самого ASP в пространстве имен DataAnnotations.

Пример:

 // CredentialsRequest.cs
using System.ComponentModel.DataAnnotations;
public class Credentials
{
    [Required]
    [EmailAddress]
    public string Email { get; set; }

    [Required]
    public string Password { get; set; }
}


// AuthenticationController.cs
[ApiController]
public class AuthenticationController : ControllerBase
{
    [HttpPost]
    public Task<IActionResult> Login([FromBody] Credentials credentials)
    {
        var result = // check `credentials` for valid login
        return result.Success
            ? Ok(result)
            : StatusCode(StatusCodes.Status401Unauthorized, result);
    }
}
 

Чтобы отловить все ошибки проверки модели, вы можете добавить следующую фабрику ответов Startup.ConfigureServices (настройте ее по своему усмотрению).:

 services.Configure<ApiBehaviorOptions>(config =>
{
    // Override default response when input model is invalid
    config.InvalidModelStateResponseFactory =
        ctx => new BadRequestObjectResult(new BaseResponse(
            success: ctx.ModelState.IsValid,
            errors: ctx.ModelState.Values
                .Where(v => v.ValidationState == ModelValidationState.Invalid)
                .SelectMany(v => v.Errors)
                .Select(e => new ErrorDetails
                {
                    Code = "ModelError",
                    Description = e.ErrorMessage
                })
                .ToList()
            ));
});
 

Вот BaseResponse и ErrorDetails некоторые простые модели данных/классы, которые я использую в качестве основы для всех моих моделей данных ответов:

 public class BaseResponse
{
    public bool Success { get; }
    public List<ErrorDetails> Errors { get; }

    public BaseResponse(bool success, ErrorDetails error)
        : this(success, new List<ErrorDetails> { error })
    { }

    public BaseResponse(bool success, List<ErrorDetails> errors = null)
    {
        Success = success;
        Errors = errors;
    }
}
 

Если вы не настроили свой API для возврата данных в другом формате, по умолчанию это должен быть JSON.