AJAX iškvietimų naudojimas norint siųsti pasirinktinę vartotojo agento antraštę į WCF paslaugą ASP.NET

WCF paslaugų skambučių tobulinimas naudojant ASP.NET pasirinktines antraštes

The Vartotojo agentas ir kitos pasirinktinės antraštės dažnai turi būti pateikiamos tarnybai dirbant su ASP.NET žiniatinklio programomis, kurios integruoja WCF paslaugas. Naudojant „JavaScript“ asinchroniniams paslaugų skambučiams atlikti, šis procesas gali būti sudėtingas.

Paprastai kūrėjai naudoja „JavaScript“, norėdami susisiekti su WCF paslaugomis per AJAX įgalintas paslaugas. Nors paslaugos puikiai tinka paprastoms užklausoms, pridedant pasirinktines antraštes, pvz., reikia būti atsargiems Vartotojo agentas.

Bandant perduoti šias antraštes naudojant GetAjaxService() ir panašius metodus, iškyla problema. GetUsers() tinkintos antraštės nepalaikomos pagal numatytuosius nustatymus. Nors antraštes pridėti paprasta naudojant kitus metodus, pvz., get() arba XMLHttpRequest, svarbu aptarti, kaip tai padaryti esamoje sistemoje.

Ši pamoka padės jums pakeisti dabartinį paslaugos iškvietimą, kad AJAX užklausos WCF paslaugai galėtų pridėti pasirinktines antraštes. Svarbūs duomenys, tokie kaip Vartotojo agentas, šios technikos dėka išlaikomas teisingai.

Kaip naudoti „JavaScript“ ASP.NET, norint perduoti vartotojo agento antraštę WCF paslaugai

Aukščiau paminėti scenarijai rodo, kaip perduoti pasirinktines antraštes ASP.NET programose, kurios atlieka AJAX įgalintus WCF paslaugų skambučius, pvz., Vartotojo agentas. Pirmajame pavyzdyje, Vartotojo agentas antraštė nustatoma rankiniu būdu naudojant XMLHttpRequest metodas. Tai būtina, nes įprastuose AJAX paslaugų skambučiuose ši antraštė pagal numatytuosius nustatymus nėra. Prieš siųsdami HTTP užklausą WCF paslaugai, galime prie jos pridėti pasirinktines antraštes naudodami setRequestHeader. Čia nuskaitoma naršyklės vartotojo agento eilutė ir perduodama serveriui naudojant navigator.userAgent.

Antrasis scenarijus pasiekia tą patį tikslą naudodamas jQuery.ajax. Naudojant jQuery asinchroninės HTTP užklausos tampa lengvesnės, o mes galime pateikti Vartotojo agentas WCF paslaugai naudodami pasirinktinę antraštę užklausos nustatymuose. Dėl trumpos „jQuery“ sintaksės ir klaidų apdorojimo funkcijų kūrėjams naudinga lengvai tvarkyti užklausų sėkmę ir nesėkmę. Užtikrinant serverio WCF paslaugą, gaunama reikiama antraštes abiem atvejais tikslas yra apdorojimas ir ataskaitų teikimas.

HttpContext.Current.Request.Headers naudojamas WCF paslaugai modifikuoti vidinėje sistemoje, kad ji galėtų nuskaityti gaunamų užklausų antraštes. Tai leidžia paslaugai naudotis Vartotojo agentas analizei, patvirtinimui ir kitiems tikslams, jei reikia ištraukus. Šios funkcijos įtraukimas garantuoja, kad svarbūs metaduomenys, pvz., kliento informacija, išliks pasiekiami per visą paslaugos skambutį, netrukdydami įprasto paslaugos veikimo. Mastelio keitimas pagerinamas naudojant Paslaugos elgesys, kuri garantuoja, kad keli paslaugos egzemplioriai gali apdoroti vienu metu teikiamas užklausas.

Galiausiai pridedant a vieneto testas patikrina, kad Vartotojo agentas WCF tarnyba tinkamai gauna ir apdoroja antraštę. Šis testas nustato, ar paslauga sėkmingai atsako siųsdama HTTP užklausą su tinkintu Vartotojo agentas. Siekiant užtikrinti, kad paslauga veiktų taip, kaip numatyta visose naršyklėse ir klientuose, būtina šiuos testus pritaikyti įvairiuose kontekstuose. Šie scenarijai iš esmės pateikia reikiamas antraštes su kiekviena užklausa, užtikrindami teisingą ir saugų ryšį tarp kliento pusės JavaScript ir WCF paslaugos.

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

Pasirinktinių antraščių tvarkymas WCF tarnyboje su AJAX

Galimybė palaikyti pasirinktines HTTP antraštes asinchroninių „JavaScript“ užklausų metu yra esminis komponentas dirbant su WCF paslaugomis ASP.NET taikymas. Be antraštių, pvz. Vartotojo agentas. Saugų ir kontekstą atitinkantį ryšį tarp kliento ir serverio palengvina tinkintos antraštės.

Tai galite padaryti suasmeninę AJAX užklausą tais atvejais, kai paslauga priklauso nuo Vartotojo agentas naršyklei būdingų savybių. Norėdami persiųsti tokias antraštes, XMLHttpRequest ir jQuery.ajax abu siūlo būtiną lankstumą. Šis metodas gali būti išplėstas įtraukiant bet kurią WCF paslaugai reikalingą antraštę, kad būtų galima reguliuoti elgesį pagal kliento atributus, pvz., platformą, versiją ar saugos kontekstą.

Kitas svarbus veiksnys yra saugus šių antraščių tvarkymas. Pavyzdžiui, jei pristatomi neskelbtini duomenys, būtina naudoti prieigos rakto autentifikavimo antraštes arba šifravimą. Būtina turėti tinkamus klaidų apdorojimo metodus, kad būtų užtikrinta, jog WCF paslauga mandagiai tvarkys užklausas su netinkamomis arba trūkstamomis antraštėmis. Paskutinis, bet ne mažiau svarbus dalykas – norint užtikrinti maksimalų efektyvumą ir suderinamumą su keliomis naršyklėmis, būtina išbandyti antraštes įvairiais scenarijais.