AJAX 呼び出しを使用してカスタム ユーザー エージェント ヘッダーを ASP.NET の WCF サービスに送信する

ASP.NET の WCF サービスにユーザー エージェント ヘッダーを送信するためのさまざまな方法

このスクリプトは、次を使用して変更された User-Agent ヘッダーを渡して、WCF サービスを呼び出します。 XMLHttpRequest そして 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 サービス呼び出しにユーザー エージェント ヘッダーを追加する

この手法では、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. 1 回の AJAX 呼び出しで複数のヘッダーを渡すことはできますか?
6. はい、次のコマンドを使用して複数のカスタム ヘッダーを追加できます。 XMLHttpRequest または jQuery.ajax を使用して headers jQuery のオプションまたは使用 setRequestHeader()。
7. 予期されたヘッダーが WCF サービスによって受信されなかった場合はどうなりますか?
8. WCF サービスがエラーをスローしたり、要求を不適切に処理したりする可能性があります。適切なエラー処理を使用して、ヘッダーの欠落や不正がないことを確認することが重要です。

WCF サポート コールでのカスタム ヘッダーに関するディスカッションの結論

適切なクライアント/サーバー通信を維持するには、次のようなカスタム ヘッダーを提供する方法を知る必要があります。 ユーザーエージェント、JavaScript から WCF サービスを呼び出すとき。開発者は、jQuery または XMLHttpRequest を使用して、これらのヘッダーを AJAX クエリに簡単に組み込むことができます。

さらに、WCF サービスがこれらのヘッダーを読み取って使用できるようにすると、セキュリティが向上し、より有能な要求処理が可能になります。この手順に従うことで、アプリケーションがクライアントのブラウザーや環境に依存せずに一貫して実行されるようにすることで、互換性とパフォーマンスを向上させることができます。