Använda AJAX-samtal för att skicka en anpassad användaragenthuvud till WCF-tjänsten i ASP.NET

Förbättra WCF-tjänstsamtal med anpassade rubriker i ASP.NET

De Användaragent och andra anpassade rubriker måste ofta levereras till tjänsten när man arbetar med ASP.NET-webbapplikationer som integrerar WCF-tjänster. När du använder JavaScript för att göra asynkrona serviceanrop kan den här processen bli svår.

Vanligtvis används JavaScript av utvecklare för att kommunicera med WCF-tjänster genom AJAX-aktiverade tjänster. Även om tjänsterna fungerar perfekt för enkla förfrågningar måste extra försiktighet tas när man lägger till anpassade rubriker som t.ex Användaragent.

När du försöker skicka dessa rubriker via GetAjaxService() och liknande metoder uppstår problemet. Anpassade rubriker stöds inte som standard i GetUsers(). Även om det är enkelt att lägga till rubriker i andra metoder som get() eller XMLHttpRequest, är det viktigt att diskutera hur man kan åstadkomma detta inom det befintliga ramverket.

Denna handledning kommer att leda dig genom processen att ändra det aktuella serviceanropet så att AJAX-förfrågningar till en WCF-tjänst kan lägga till anpassade rubriker. Viktig information, som t.ex Användaragent, passeras korrekt tack vare denna teknik.

Hur man använder JavaScript i ASP.NET för att skicka användaragenthuvudet till WCF-tjänsten

Skripten som nämns ovan visar hur man skickar anpassade rubriker i ASP.NET-applikationer som gör AJAX-aktiverade WCF-tjänstanrop, som Användaragent. I det första exemplet är Användaragent header ställs in manuellt med hjälp av XMLHttpRequest metod. Detta krävs eftersom vanliga AJAX-tjänstanrop inte inkluderar denna rubrik som standard. Innan vi skickar HTTP-förfrågan till WCF-tjänsten kan vi lägga till anpassade rubriker till den genom att använda setRequestHeader. Här hämtas webbläsarens användaragentsträng och skickas till servern som använder navigator.userAgent.

Det andra skriptet uppnår samma mål genom att använda jQuery.ajax. Att använda jQuery gör asynkrona HTTP-förfrågningar enklare, och vi kan tillhandahålla Användaragent till WCF-tjänsten genom att använda en anpassad rubrik i förfrågningsinställningarna. jQuerys korta syntax och felhanteringsfunktioner gör det fördelaktigt för utvecklare att enkelt hantera framgång och misslyckande för begäran. Att säkerställa att WCF-tjänsten på serversidan får det nödvändiga rubriker för handläggning och rapportering är målet i båda fallen.

HttpContext.Current.Request.Headers används för att modifiera WCF-tjänsten på backend så att den kan läsa inkommande förfrågningsrubriker. Detta gör att tjänsten kan använda Användaragent för analys, validering och annan användning efter behov efter att ha extraherat den. Inkluderandet av denna funktion garanterar att viktig metadata, såsom kundinformation, förblir tillgänglig under hela servicesamtalet utan att störa tjänstens normala drift. Skalbarheten förbättras genom att använda Servicebeteende, vilket garanterar att flera instanser av tjänsten kan hantera samtidiga förfrågningar.

Slutligen lägger man till en enhetstest verifierar att Användaragent header tas emot och bearbetas på lämpligt sätt av WCF-tjänsten. Detta test avgör om tjänsten svarar framgångsrikt genom att skicka en HTTP-förfrågan med en anpassad Användaragent. För att säkerställa att tjänsten fungerar som avsett över webbläsare och klienter är det absolut nödvändigt att omsätta dessa tester i praktiken i olika sammanhang. Dessa skript tillhandahåller i huvudsak de nödvändiga rubrikerna med varje begäran, vilket säkerställer korrekt och säker kommunikation mellan JavaScript på klientsidan och en WCF-tjänst.

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

Hantera anpassade rubriker i WCF Service med AJAX

Möjligheten att stödja anpassade HTTP-rubriker under asynkrona JavaScript-förfrågningar är en kritisk komponent för att arbeta med WCF-tjänster i en ASP.NET ansökan. Du kan också behöva skicka WCF-tjänstens speciella klientidentiteter eller autentiseringstoken utöver rubriker som Användaragent. Säker och kontextspecifik kommunikation mellan klienten och servern underlättas av anpassade rubriker.

Du kan göra detta genom att anpassa AJAX-förfrågan i fall där tjänsten beror på Användaragent för webbläsarspecifika egenskaper. För vidarebefordran av sådana rubriker, XMLHttpRequest och jQuery.ajax båda erbjuder den nödvändiga flexibiliteten. Denna metod kan utökas till att inkludera vilken rubrik som helst som krävs av WCF-tjänsten för att reglera beteendet enligt klientattribut som plattform, version eller säkerhetskontext.

Säker hantering av dessa rubriker är en annan avgörande faktor. Till exempel är det absolut nödvändigt att använda token-baserade autentiseringsrubriker eller kryptering om känslig data levereras. Det är absolut nödvändigt att ha lämpliga felhanteringsmetoder på plats för att garantera att WCF-tjänsten hanterar förfrågningar med ogiltiga eller saknade rubriker på ett artigt sätt. Sist men inte minst, för maximal effektivitet och kompatibilitet över webbläsare, är det viktigt att testa rubrikerna i olika scenarier.