使用 AJAX 调用将自定义用户代理标头发送到 ASP.NET 中的 WCF 服务

在 ASP.NET 中将 User-Agent 标头发送到 WCF 服务的各种方法

此脚本通过传递修改后的 User-Agent 标头来调用 WCF 服务 XMLHttp请求 和 JavaScript。

// JavaScript - Using XMLHttpRequest to pass User-Agent header
function GetUsersWithHeaders() {
  var xhr = new XMLHttpRequest();
  xhr.open("POST", "AjaxWebService.svc/GetUsers", true);
  xhr.setRequestHeader("User-Agent", navigator.userAgent);
  xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
      var result = JSON.parse(xhr.responseText);
      if (result !== null) {
        console.log(result); // Process result
      }
    }
  };
  xhr.send();
}

使用 jQuery 在 WCF 服务调用中添加 User-Agent 标头

此技术展示了如何在 AJAX 调用期间使用以下方法将自定义的 User-Agent 标头传递到 WCF 服务： jQuery.ajax。

// JavaScript - Using jQuery.ajax to pass User-Agent header
function GetUsersWithJQuery() {
  $.ajax({
    url: 'AjaxWebService.svc/GetUsers',
    type: 'POST',
    headers: {
      'User-Agent': navigator.userAgent
    },
    success: function(result) {
      if (result !== null) {
        console.log(result); // Process result
      }
    },
    error: function() {
      alert('Error while calling service');
    }
  });
}

ASP.NET 后端：修改 WCF 服务以处理自定义标头

下面的脚本演示了如何更改 WCF 服务后端，以便它可以读取唯一的 用户代理 从前端传递的标头。

// ASP.NET C# - Modify WCF service to read User-Agent header
[ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession, ConcurrencyMode = ConcurrencyMode.Multiple)]
[ServiceContract(Namespace = "", SessionMode = SessionMode.Allowed)]
[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
public class AjaxWebService
{
  [OperationContract]
  public UsersData[] GetUsers()
  {
    var userAgent = HttpContext.Current.Request.Headers["User-Agent"];
    if (string.IsNullOrEmpty(userAgent))
    {
      throw new InvalidOperationException("User-Agent header is missing");
    }
    return this.Service.GetUsers();  // Call WCF service API
  }
}

使用自定义标头对 WCF 服务调用进行单元测试

为了验证 用户代理 标头在各种设置中正确传递，该脚本提供了一个简单的 单元测试。

// Unit Test - Testing WCF service with custom headers
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Net.Http;
using System.Threading.Tasks;
using System.Web.Http;
namespace AjaxWebService.Tests
{
  [TestClass]
  public class AjaxWebServiceTests
  {
    [TestMethod]
    public async Task TestGetUsersWithUserAgentHeader()
    {
      var client = new HttpClient();
      var request = new HttpRequestMessage(HttpMethod.Post, "AjaxWebService.svc/GetUsers");
      request.Headers.Add("User-Agent", "TestAgent");
      var response = await client.SendAsync(request);
      Assert.IsTrue(response.IsSuccessStatusCode);
    }
  }
}

有关将标头传递到 WCF 服务的常见问题

1. 如何向 XMLHttpRequest 添加自定义标头？
2. 建立连接后、提交请求之前，您可以在中添加自定义标头 XMLHttpRequest 通过利用 setRequestHeader() 技术。
3. User-Agent 标头的作用是什么？
4. 客户端的浏览器、设备和操作系统都在 用户代理 标头，使 WCF 服务能够自定义答案或记录信息。
5. 我可以在一次 AJAX 调用中传递多个标头吗？
6. 是的，您可以添加几个自定义标头 XMLHttpRequest 或者 jQuery.ajax 通过使用 headers jQuery 中的选项或使用 setRequestHeader()。
7. 如果 WCF 服务未收到预期标头，会发生什么情况？
8. WCF 服务可能会引发错误或不正确地处理请求。使用适当的错误处理来确保没有标头丢失或不正确非常重要。

结束关于 WCF 支持电话中的自定义标头的讨论

维护适当的客户端-服务器通信需要了解如何提供自定义标头，例如 用户代理，当从 JavaScript 调用 WCF 服务时。开发人员可以使用 jQuery 或 XMLHttpRequest 轻松将这些标头合并到 AJAX 查询中。

此外，允许 WCF 服务读取和使用这些标头可以提高安全性并允许更强大的请求处理。通过遵循此过程，您可以确保应用程序始终独立于客户端浏览器或环境运行，从而提高兼容性和性能。