asp.net-web-api
Creazione di un ActionFilterAttribute personalizzato
Ricerca…
introduzione
Filtri di azione Gli attributi sono una parte di ASP .NET Framework che ritengo utile per seguire il principio DRY. Puoi sostituire diverse linee di logica comune con un semplice tag dichiarativo. Il framework fornisce diversi utili attributi del filtro di azione per impostazione predefinita, come Autorizza e gestisce gli attributi di errore. Questa guida ha lo scopo di mostrarti come creare il tuo attributo personalizzato.
EnsurePresenseOfAttribute
Questo è un esempio di un attributo che ho creato per convalidare che i parametri richiesti sono stati assegnati nell'oggetto di richiesta ricevuto in una rotta POST. Ho deciso questo approccio perché l'approccio standard ModelState.IsValid non era valido. Questo perché gli attributi richiesti variano in base all'azione che viene chiamata.
// ATTRIBUISCE SOLO VALIDO PER I METODI [AttributeUsage (AttributeTargets.Method)] // INHERIT ActionFilterAttribute public class EnsurePresencesOfAttribute: ActionFilterAttribute {// ReSharper disabilita una volta IncoStringName stringa pubblica richiesta {get; impostato; }
// VALIDATE REQUIRED ATTRIBUTES
// FOR NON-ASYNC REQUESTS
public override void OnActionExecuting(HttpActionContext context)
{
Dictionary<string, object> model = context.ActionArguments;
var serialstring = JsonConvert.SerializeObject(model);
foreach (var requirement in required.Split(','))
{
if (serialstring.Contains($"{requirement}\":null"))
{
ValueError(context, requirement);
return;
}
}
base.OnActionExecuting(context);
}
// VALIDATE THE REQUIRED ATTRIBUTES ARE PRESENT
// FOR ASYNC REQUESTS
public override Task OnActionExecutingAsync(HttpActionContext context, CancellationToken token)
{
Dictionary<string, object> model = context.ActionArguments;
var serialstring = JsonConvert.SerializeObject(model);
foreach (var requirement in required.Split(','))
{
if (serialstring.Contains($"{requirement}\":null"))
{
ValueError(context, requirement);
return Task.FromResult(0);
}
}
return base.OnActionExecutingAsync(context, token);
}
// LOG ERROR AND RETURN AND SET ERROR RESPONSE
private static void ValueError(HttpActionContext context, string requirement)
{
var action = context.ActionDescriptor.ActionName;
AppUtils.LogError($"{action} Failed : Missing Required Attribute {requirement}. ");
using (var controller = new BaseApiController { Request = new HttpRequestMessage() })
{
controller.Request.Properties.Add(HttpPropertyKeys.HttpConfigurationKey, new HttpConfiguration());
context.Response = controller.InvalidInputResponse();
}
}
Controller prima di EnsuresPresenseOf Attribute
[HttpPost]
[Route("api/Fitbit/Activity/Stats")]
public async Task<HttpResponseMessage> ActivityStats(FitbitRequestDTO request)
{
if (string.IsNullOrEmpty(request.PatientId) || string.IsNullOrEmpty(request.DeviceId))
return InvalidInputResponse();
try
{
var tokenErrorResponse = await EnsureToken(request);
if (tokenErrorResponse != null)
return tokenErrorResponse;
var client = GetFitbitClient();
var stats = await client.GetActivitiesStatsAsync();
return OkResponse(stats);
}
catch (Exception e)
{
const string function = " ActivityStats ";
AppUtils.LogException(function, e);
return SystemErrorResponse(function, e);
}
}
Controller di aggiornamento
public async Task<HttpResponseMessage> ActivityStats(FitbitRequestDTO request)
{
try
{
var tokenErrorResponse = await EnsureToken(request);
if (tokenErrorResponse != null)
return tokenErrorResponse;
var client = GetFitbitClient();
var stats = await client.GetActivitiesStatsAsync();
return OkResponse(stats);
}
catch (Exception e)
{
const string function = " ActivityStats ";
AppUtils.LogException(function, e);
return SystemErrorResponse(function, e);
}
}