Bir NOTFOUND dönen IHttpActionResultbir şey benim WebAPI GET eylem bulunmazsa zaman. Bu yanıtın yanı sıra özel bir mesaj ve / veya istisna mesajı (varsa) göndermek istiyorum. Mevcut ApiControllersitesindeki NotFound()yöntem Mesaj geçmek için bir aşırı sağlamaz.
Bunu yapmanın bir yolu var mı? yoksa kendi geleneğimi IHttpActionResultmi yazmam gerekecek ?
Yanıtlar:
Yanıt mesajı şeklini özelleştirmek istiyorsanız, kendi eylem sonucunuzu yazmanız gerekir.
Basit boş 404'ler gibi şeyler için kutudan çıkan en yaygın yanıt mesajı şekillerini sağlamak istedik, ancak bu sonuçları olabildiğince basit tutmak istedik; Eylem sonuçlarını kullanmanın temel avantajlarından biri, eylem yönteminizin birim testini çok daha kolay hale getirmesidir. Eylem sonuçlarına ne kadar çok özellik koyarsak, eylem yönteminin beklediğiniz şeyi yaptığından emin olmak için birim testinizin o kadar çok şeyi dikkate alması gerekir.
Sık sık özel bir mesaj sağlama yeteneğini de istiyorum, bu nedenle bu eylemin gelecekteki bir sürümle sonuçlanmasını desteklemeyi düşünmemiz için bir hata kaydetmekten çekinmeyin: https://aspnetwebstack.codeplex.com/workitem/list/advanced
Bununla birlikte, eylem sonuçlarıyla ilgili güzel bir şey, biraz farklı bir şey yapmak istiyorsanız, her zaman oldukça kolay bir şekilde kendi yazınızı yazabilmenizdir. Sizin durumunuzda bunu nasıl yapabileceğiniz aşağıda açıklanmıştır (hata mesajını metin / düz olarak istediğinizi varsayarak; JSON istiyorsanız, içerikle biraz farklı bir şey yaparsınız):
public class NotFoundTextPlainActionResult : IHttpActionResult
{
public NotFoundTextPlainActionResult(string message, HttpRequestMessage request)
{
if (message == null)
{
throw new ArgumentNullException("message");
}
if (request == null)
{
throw new ArgumentNullException("request");
}
Message = message;
Request = request;
}
public string Message { get; private set; }
public HttpRequestMessage Request { get; private set; }
public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
{
return Task.FromResult(Execute());
}
public HttpResponseMessage Execute()
{
HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.NotFound);
response.Content = new StringContent(Message); // Put the message in the response body (text/plain content).
response.RequestMessage = Request;
return response;
}
}
public static class ApiControllerExtensions
{
public static NotFoundTextPlainActionResult NotFound(this ApiController controller, string message)
{
return new NotFoundTextPlainActionResult(message, controller.Request);
}
}
Ardından, eylem yönteminizde şöyle bir şey yapabilirsiniz:
public class TestController : ApiController
{
public IHttpActionResult Get()
{
return this.NotFound("These are not the droids you're looking for.");
}
}
Özel bir denetleyici temel sınıfı kullandıysanız (doğrudan ApiController'den miras almak yerine), "bunu" da ortadan kaldırabilirsiniz. bölüm (maalesef bir uzantı yöntemi çağrılırken gereklidir):
public class CustomApiController : ApiController
{
protected NotFoundTextPlainActionResult NotFound(string message)
{
return new NotFoundTextPlainActionResult(message, Request);
}
}
public class TestController : CustomApiController
{
public IHttpActionResult Get()
{
return NotFound("These are not the droids you're looking for.");
}
}
İşte basit bir mesajla bir IHttpActionResult NotFound döndürmek için tek satırlık bir kılavuz:
return Content(HttpStatusCode.NotFound, "Foo does not exist.");
İsterseniz kullanabilirsiniz ResponseMessageResult:
var myCustomMessage = "your custom message which would be sent as a content-negotiated response";
return ResponseMessage(
Request.CreateResponse(
HttpStatusCode.NotFound,
myCustomMessage
)
);
evet, çok daha kısa sürümlere ihtiyacınız varsa, o zaman sanırım özel eylem sonucunuzu uygulamanız gerekir.
HttpResponseMessage sınıfının ReasonPhrase özelliğini kullanabilirsiniz
catch (Exception exception)
{
throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.NotFound)
{
ReasonPhrase = exception.Message
});
}
D3m3t3er'ın önerdiği şekilde özel bir müzakere edilmiş içerik sonucu oluşturabilirsiniz. Ancak ben miras alırdım. Ayrıca, yalnızca NotFound'u döndürmek için ihtiyacınız varsa, yapıcıdan http durumunu başlatmanız gerekmez.
public class NotFoundNegotiatedContentResult<T> : NegotiatedContentResult<T>
{
public NotFoundNegotiatedContentResult(T content, ApiController controller)
: base(HttpStatusCode.NotFound, content, controller)
{
}
public override Task<HttpResponseMessage> ExecuteAsync(
CancellationToken cancellationToken)
{
return base.ExecuteAsync(cancellationToken).ContinueWith(
task => task.Result, cancellationToken);
}
}
OkNegotiatedContentResultOrtaya çıkan yanıt mesajındaki HTTP kodunu basitçe türetip geçersiz kılarak çözdüm. Bu sınıf, içerik gövdesini herhangi bir HTTP yanıt koduyla döndürmenize olanak tanır.
public class CustomNegotiatedContentResult<T> : OkNegotiatedContentResult<T>
{
public HttpStatusCode HttpStatusCode;
public CustomNegotiatedContentResult(
HttpStatusCode httpStatusCode, T content, ApiController controller)
: base(content, controller)
{
HttpStatusCode = httpStatusCode;
}
public override Task<HttpResponseMessage> ExecuteAsync(
CancellationToken cancellationToken)
{
return base.ExecuteAsync(cancellationToken).ContinueWith(
task => {
// override OK HTTP status code with our own
task.Result.StatusCode = HttpStatusCode;
return task.Result;
},
cancellationToken);
}
}
Özelliği ayarlamak için IHttpActionResultbir IExceptionHandlersınıfın gövdesinde bir örnek oluşturmam gerekiyordu ExceptionHandlerContext.Result. Ancak ben de bir gelenek ayarlamak istedim ReasonPhrase.
Bir can ResponseMessageResultsarma olduğunu buldum HttpResponseMessage(ReasonPhrase'in kolayca ayarlanmasına izin verir).
Örneğin:
public class MyExceptionHandler : ExceptionHandler
{
public override void Handle(ExceptionHandlerContext context)
{
var ex = context.Exception as IRecordNotFoundException;
if (ex != null)
{
context.Result = new ResponseMessageResult(new HttpResponseMessage(HttpStatusCode.NotFound) { ReasonPhrase = $"{ex.EntityName} not found" });
}
}
}
NegotitatedContentResult<T>Belirtildiği gibi tabandan miras alırsanız ve sizin dönüşümü yapmanız gerekmiyorsa content(örneğin sadece bir dizge döndürmek istiyorsanız), o zaman ExecuteAsyncyöntemi geçersiz kılmanıza gerek yoktur .
Tüm yapmanız gereken uygun bir tür tanımı ve hangi HTTP Durum Kodunun döndürüleceğini tabana söyleyen bir kurucu sağlamaktır. Diğer her şey çalışıyor.
İşte hem NotFoundve hem için örnekler InternalServerError:
public class NotFoundNegotiatedContentResult : NegotiatedContentResult<string>
{
public NotFoundNegotiatedContentResult(string content, ApiController controller)
: base(HttpStatusCode.NotFound, content, controller) { }
}
public class InternalServerErrorNegotiatedContentResult : NegotiatedContentResult<string>
{
public InternalServerErrorNegotiatedContentResult(string content, ApiController controller)
: base(HttpStatusCode.InternalServerError, content, controller) { }
}
Ve sonra ilgili uzatma yöntemlerini oluşturabilirsiniz ApiController(veya varsa, bir temel sınıfta yapabilirsiniz):
public static NotFoundNegotiatedContentResult NotFound(this ApiController controller, string message)
{
return new NotFoundNegotiatedContentResult(message, controller);
}
public static InternalServerErrorNegotiatedContentResult InternalServerError(this ApiController controller, string message)
{
return new InternalServerErrorNegotiatedContentResult(message, controller);
}
Ve sonra tıpkı yerleşik yöntemler gibi çalışırlar. Ya var olanı arayabilir ya NotFound()da yeni geleneğinizi arayabilirsiniz NotFound(myErrorMessage).
Ve tabii ki, özel tip tanımlarındaki "sabit kodlanmış" dizgi türlerinden kurtulabilir ve isterseniz onu genel olarak bırakabilirsiniz, ancak daha sonra gerçekte ne olduğuna bağlı olarak şeyler için endişelenmeniz gerekebilir .ExecuteAsync<T>
Tüm yaptıklarını görmek için kaynak koduna bakabilirsiniz NegotiatedContentResult<T>. Fazla bir şey yok.
PO'nun bir mesaj metni ile sorulduğunu biliyorum, ancak yalnızca bir 404 döndürmek için başka bir seçenek, yöntemin bir IHttpActionResult döndürmesini sağlamak ve StatusCode işlevini kullanmaktır.
public async Task<IHttpActionResult> Get([FromUri]string id)
{
var item = await _service.GetItem(id);
if(item == null)
{
StatusCode(HttpStatusCode.NotFound);
}
return Ok(item);
}
Buradaki yanıtlarda küçük bir geliştirici hikayesi sorunu eksik. ApiControllerSınıf hala tutulmuşsa NotFound()geliştiriciler kullanabileceğini yöntemi. Bu, bazı 404 yanıtlarının kontrolsüz bir sonuç gövdesi içermesine neden olur.
Burada , geliştiricilerin "404 göndermenin daha iyi yolunu" bilmesini gerektirmeyen, daha az hataya açık bir yöntem sağlayacak olan " daha iyi ApiController NotFound yöntemi " kodunun birkaç parçasını sunuyorum.
ApiController bir sınıf yaratApiController
NotFoundgeliştiricilerin ilk kullanılabilir API'yi kullanmasına izin vermek için yöntemini geçersiz kılın[Obsolete("Use overload instead")]protected NotFoundResult NotFound(string message)teşvik etmek istediğiniz bir ekstra ekleyinNegotiatedContentResult. ekli bkz iyi NotFoundResult sınıfı .