在ASP.NET Core中用HttpClient(三)——发送HTTP PATCH请求
码农译站 人气:0在前面的两篇文章中,我们讨论了很多关于使用HttpClient进行CRUD操作的基础知识。如果你已经读过它们,你就知道如何使用HttpClient从API中获取数据,并使用HttpClient发送POST、PUT和DELETE请求。当我们使用PUT请求时,用它来更新我们的资源。但我们可以通过使用HTTP PATCH请求进行部分更新来改进这一点。因此,在本文中,我们将展示如何使用HttpClient发送HTTP PATCH请求来实现资源的部分更新,从而提高应用程序的性能。
要下载源码,可以访问https://github.com/CodeMazeBlog/httpclient-aspnetcore/tree/patch-with-httpclient获取项目。
更多关于HTTP PATCH请求
正如我们已经提到的,我们使用PUT请求进行完整更新,使用PATCH请求进行部分更新。但这并不是这两个HTTP请求之间的唯一区别。首先,请求主体是不同的。如果我们检查Web API中的PUT,我们可以看到请求体是一个简单的对象:
[FromBody] CompanyForUpdateDto company
但如果我们对PATCH请求做同样的检查:
[FromBody] JsonPatchDocument<EmployeeForUpdateDto> patchDoc
可以看到,如果我们想要支持PATCH请求的请求体,我们必须使用JsonPatchDocument类。这个类帮助我们描述可以使用PATCH请求执行的不同操作集。
同样,对于PUT请求,我们使用application/json作为媒体类型。但是对于PATCH请求,首选的媒体类型是application/json-patch+json。我们可以为HTTP PATCH请求使用application/json媒体类型,但正如我们提到的,首选的媒体类型是application/json-patch+json,我们将在示例中使用它。
HTTP PATCH操作
PATCH请求可以作为JSON数组的一部分执行一个或多个操作。让我们看看PATCH请求的请求体:
[ { "op": "replace", "path": "/name", "value": "new name" }, { "op": "remove", "path": "/name" } ]
正如我们所看到的,请求主体基本上是一个指定不同操作的JSON对象数组。也就是说,我们可以确认两个操作:由op属性指定的Replace和Remove。路径部分表示到我们想要修改的对象属性的路径。最后,value部分表示一个新值,我们用它来替换Name属性的旧值。
使用HttpClient的PatchAsync方法发送HTTP PATCH请求
在我们开始修改客户端项目之前,可以快速地看一下API的PATCH操作的路径:
[Route("api/companies/{companyId}/employees")] [ApiController] public class EmployeesController : ControllerBase
可以看到我们已经在EmployeesController中实现了PATCH操作。由于单个员工不能在没有单个公司的情况下存在,所以到这个控制器的路由是:
api/companies/{companyId}/employees
但是,我们只更新了一个雇员,所以我们需要该雇员的id:
[HttpPatch("{id}")] public IActionResult PartiallyUpdateEmployeeForCompany(Guid companyId, Guid id, [FromBody] JsonPatchDocument<EmployeeForUpdateDto> patchDoc)
这意味着该操作的路由是:
api/companies/{companyId}/employees/{id}
为了简单起见,我们已经从这个控制器中删除了其余的操作,另外,为了便于参考,让我们展示一下API实现:
[HttpPatch("{id}")] public IActionResult PartiallyUpdateEmployeeForCompany(Guid companyId, Guid id, [FromBody] JsonPatchDocument<EmployeeForUpdateDto> patchDoc) { if(patchDoc == null) { _logger.LogError("patchDoc object sent from client is null."); return BadRequest("patchDoc object is null"); } var company = _repository.Company.GetCompany(companyId, trackChanges: false); if (company == null) { _logger.LogInfo($"Company with id: {companyId} doesn't exist in the database."); return NotFound(); } var employeeEntity = _repository.Employee.GetEmployee(companyId, id, trackChanges: true); if (employeeEntity == null) { _logger.LogInfo($"Employee with id: {id} doesn't exist in the database."); return NotFound(); } var employeeToPatch = _mapper.Map<EmployeeForUpdateDto>(employeeEntity); patchDoc.ApplyTo(employeeToPatch); _mapper.Map(employeeToPatch, employeeEntity); _repository.Save(); return NoContent(); }
从请求体接受JsonPatchDocument对象。接下来,我们检查patchDoc对象是否存在空值,以及公司和员工是否存在于数据库中。然后,我们把Employee类型映射到EmployeeForUpdateDto类型。这对我们来说很重要,因为patchDoc对象只能应用于EmployeeForUpdateDto类型。在调用ApplyTo方法之后,我们将再次映射到员工类型,并将更改保存到数据库中。
客户端实现
现在,让我们打开客户端项目,并在Services文件夹中添加一个新服务:
public class HttpClientPatchService : IHttpClientServiceImplementation { private static readonly HttpClient _httpClient = new HttpClient(); public HttpClientPatchService() { _httpClient.BaseAddress = new Uri("https://localhost:5001/api/"); _httpClient.Timeout = new TimeSpan(0, 0, 30); _httpClient.DefaultRequestHeaders.Clear(); } public async Task Execute() { throw new NotImplementedException(); } }
因此,这是HttpClient类的初始配置。一旦开始学习HttpClientFactory,我们将展示如何能够一次性进行配置,而不会为每个服务重复它。
在此之后,我们可以使用PatchAsync方法实现发送HTTP PATCH请求的逻辑:
private async Task PatchEmployee() { var patchDoc = new JsonPatchDocument<EmployeeForUpdateDto>(); patchDoc.Replace(e => e.Name, "Sam Raiden Updated"); patchDoc.Remove(e => e.Age); var uri = Path.Combine("companies", "C9D4C053-49B6-410C-BC78-2D54A9991870", "employees", "80ABBCA8-664D-4B20-B5DE-024705497D4A"); var serializedDoc = JsonConvert.SerializeObject(patchDoc); var requestContent = new StringContent(serializedDoc, Encoding.UTF8, "application/json-patch+json"); var response = await _httpClient.PatchAsync(uri, requestContent); response.EnsureSuccessStatusCode(); }
在这里,我们在JsonPatchDocument类的帮助下创建了一个新的Patch类。为了能够使用这个类,我们必须安装Microsoft.AspNetCore.JsonPatch。接下来,我们使用JsonPatchDocument类中的两个helper方法创建两个操作。然后,创建URI、序列化对象,并创建新的字符串内容。这里需要注意的重要一点是,我们没有使用System.Text中的JsonSerializer.Serialize()方法。而是使用Newtonsoft.Json的JsonConvert.SerializeObject()方法。我们必须这么做,因为PATCH文件不能很好地用System.Text.Json序列化,我们的API会收到400 bad request。
最后,我们使用PatchAsync方法发送请求,并确保响应有一个成功的状态码。
现在,让我们修改Execute方法:
public async Task Execute(){
await PatchEmployee();
}
将服务注册到Program类:
private static void ConfigureServices(IServiceCollection services) { //services.AddScoped<IHttpClientServiceImplementation, HttpClientCrudService>(); services.AddScoped<IHttpClientServiceImplementation, HttpClientPatchService>(); }
在PatchEmployee放置断点,并启动项目。
检查数据库:
我们可以看到Name列被修改,Age列被设置为默认值0。让我们看看如何使用HttpRequestMessage来实现同样的功能。
使用HttpRequestMessage发送PATCH请求
与前面处理所有HTTP请求时一样,我们将使用HttpRequestMessage类向服务器送PATCH请求。在本教程的前几篇文章中,我们已经讨论了这种方法的好处。
所以,让我们在HttpClientPatchService类中添加另一个方法:
private async Task PatchEmployeeWithHttpRequestMessage() { var patchDoc = new JsonPatchDocument<EmployeeForUpdateDto>(); patchDoc.Replace(e => e.Name, "Sam Raiden"); patchDoc.Add(e => e.Age, 28); var uri = Path.Combine("companies", "C9D4C053-49B6-410C-BC78-2D54A9991870", "employees", "80ABBCA8-664D-4B20-B5DE-024705497D4A"); var serializedDoc = JsonConvert.SerializeObject(patchDoc); var request = new HttpRequestMessage(HttpMethod.Patch, uri); request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); request.Content = new StringContent(serializedDoc, Encoding.UTF8); request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json-patch+json"); var response = await _httpClient.SendAsync(request); response.EnsureSuccessStatusCode(); }
我们再次创建了JsonPatchDocument对象,但这一次,我们replace了员工的姓名,并add了年纪。准备URI并序列化对象。完成之后,我们创建一个新的HttpRequestMessage,提供我们想要使用的HTTP方法和URI。就像我们在所有的HttpRequestMessage示例中所做的那样,我们为请求添加了一个accept header、content和content type。最后,我们使用SendAsync方法发送请求,并确保响应中的状态码成功。
为了能够执行这个方法,我们必须在execute方法中调用它:
public async Task Execute() { //await PatchEmployee(); await PatchEmployeeWithHttpRequestMessage(); }
在方法中放置断点,并启动项目:
检查数据库:
结论
在本文中——包括前面的文章,我们讨论了所有的CRUD请求,包括HTTP PATCH请求。现在我们知道了如何使用HttpClient发送所有这些类型的请求,也使用了HttpRequestMessage类。
加载全部内容