Používanie volaní AJAX na odoslanie vlastnej hlavičky User-Agent do služby WCF v ASP.NET

Vylepšenie volaní služby WCF pomocou vlastných hlavičiek v ASP.NET

The User-Agent a iné vlastné hlavičky je často potrebné dodať službe pri práci s webovými aplikáciami ASP.NET, ktoré integrujú služby WCF. Pri používaní JavaScriptu na uskutočňovanie asynchrónnych volaní služieb môže byť tento proces zložitý.

JavaScript zvyčajne používajú vývojári na komunikáciu so službami WCF prostredníctvom služieb s podporou AJAX. Aj keď služby fungujú perfektne pri jednoduchých požiadavkách, je potrebné venovať zvýšenú pozornosť pridávaniu vlastných hlavičiek ako napr User-Agent.

Pri pokuse o odovzdanie týchto hlavičiek cez GetAjaxService() a podobné metódy sa vyskytne problém. Vlastné hlavičky nie sú štandardne podporované v GetUsers(). Zatiaľ čo pridávanie hlavičiek je jednoduché v iných metódach, ako je get() alebo XMLHttpRequest, je dôležité diskutovať o tom, ako to dosiahnuť v existujúcom rámci.

Tento tutoriál vás prevedie procesom zmeny aktuálneho volania služby tak, aby dopyty AJAX na službu WCF mohli pridávať vlastné hlavičky. Dôležité údaje, ako napr User-Agent, sa vďaka tejto technike odovzdáva správne.

Ako používať JavaScript v ASP.NET na odovzdanie hlavičky User-Agent do služby WCF

Vyššie uvedené skripty ukazujú, ako odovzdať vlastné hlavičky v aplikáciách ASP.NET, ktoré uskutočňujú volania služby WCF s podporou AJAX, ako napr. User-Agent. V prvom príklade je User-Agent hlavička sa nastavuje manuálne pomocou XMLHttpRequest metóda. Vyžaduje sa to, pretože bežné volania služby AJAX túto hlavičku štandardne neobsahujú. Pred odoslaním požiadavky HTTP do služby WCF môžeme do nej pridať vlastné hlavičky pomocou setRequestHeader. Tu sa načíta reťazec používateľského agenta prehliadača a odošle sa na server pomocou navigator.userAgent.

Druhý skript dosahuje rovnaký cieľ využitím jQuery.ajax. Použitie jQuery zjednodušuje asynchrónne požiadavky HTTP a my môžeme poskytnúť User-Agent do služby WCF pomocou vlastnej hlavičky v nastaveniach požiadavky. Vďaka krátkej syntaxi a funkciám spracovania chýb jQuery je pre vývojárov výhodné ľahko zvládnuť úspešné a neúspešné požiadavky. Zabezpečenie, že služba WCF na strane servera získa potrebné hlavičky pre spracovanie a vykazovanie je cieľom v oboch prípadoch.

HttpContext.Current.Request.Headers sa používa na úpravu služby WCF na backende tak, aby mohla čítať hlavičky prichádzajúcich požiadaviek. To umožňuje službe používať User-Agent na analýzu, overenie a ďalšie použitia podľa potreby po extrakcii. Zahrnutie tejto funkcie zaručuje, že kľúčové metadáta, ako napríklad informácie o klientovi, zostanú dostupné počas volania služby bez toho, aby to narušilo bežnú prevádzku služby. Škálovateľnosť sa zlepšuje použitím ServiceBehavior, čo zaručuje, že niekoľko inštancií služby dokáže spracovať súbežné požiadavky.

Nakoniec sa pridá a jednotkový test overuje, že User-Agent hlavička je vhodne prijatá a spracovaná službou WCF. Tento test určuje, či služba odpovedá úspešne odoslaním požiadavky HTTP s prispôsobeným User-Agent. Aby sa zabezpečilo, že služba bude fungovať tak, ako má v prehliadačoch a klientoch, je nevyhnutné uviesť tieto testy do praxe v rôznych kontextoch. Tieto skripty v podstate poskytujú požadované hlavičky s každou požiadavkou, čím zaisťujú správnu a bezpečnú komunikáciu medzi JavaScriptom na strane klienta a službou WCF.

// 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();
}

// 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 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
  }
}

// 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);
    }
  }
}

Spracovanie vlastných hlavičiek v službe WCF pomocou AJAX

Schopnosť podporovať vlastné hlavičky HTTP počas asynchrónnych požiadaviek JavaScriptu je kritickou súčasťou práce so službami WCF v a ASP.NET aplikácie. Okrem hlavičiek, ako sú napr User-Agent. Bezpečnú a kontextovo špecifickú komunikáciu medzi klientom a serverom uľahčujú vlastné hlavičky.

Môžete to urobiť prispôsobením požiadavky AJAX v prípadoch, keď služba závisí od User-Agent pre špecifické vlastnosti prehliadača. Na preposielanie takýchto hlavičiek XMLHttpRequest a jQuery.ajax obe ponúkajú potrebnú flexibilitu. Táto metóda môže byť rozšírená tak, aby zahŕňala akúkoľvek hlavičku vyžadovanú službou WCF s cieľom regulovať správanie podľa atribútov klienta, ako je platforma, verzia alebo kontext zabezpečenia.

Bezpečná manipulácia s týmito hlavičkami je ďalším rozhodujúcim faktorom. Ak sa doručujú citlivé údaje, je napríklad nevyhnutné používať autentifikačné hlavičky alebo šifrovanie založené na tokenoch. Je nevyhnutné mať zavedené vhodné metódy spracovania chýb, aby sa zaručilo, že služba WCF spracuje požiadavky s neplatnými alebo chýbajúcimi hlavičkami zdvorilým spôsobom. V neposlednom rade je pre maximálnu efektivitu a kompatibilitu medzi prehliadačmi nevyhnutné testovanie hlavičiek v rôznych scenároch.