Hva er WSDL? Betydning og eksempel

Hva er WSDL?

Web Services Description Språk (WSDL) er en XML-basert fil som i utgangspunktet forteller klientapplikasjonen hva webtjenesten gjør. WSDL-filen brukes til å beskrive i et nøtteskall hva nettjenesten gjør og gir klienten all informasjon som kreves for å koble seg til nettjenesten og bruke all funksjonaliteten som tilbys av nettjenesten.

I denne veiledningen skal vi fokusere på den viktigste delen av webtjenester, og det er WSDL, eller webtjenester. Descriptionspråk. Det fungerer som kontracmellom webtjenesten og enhver klient som ønsker å konsumere den.

Strukturen til et WSDL-dokument

Et WSDL-dokument brukes til å beskrive en webtjeneste. Denne beskrivelsen er nødvendig slik at klientapplikasjoner kan forstå hva webtjenesten faktisk gjør.

• WSDL-filen inneholder plasseringen til webtjenesten, og
• Metodene som er eksponert av webtjenesten.

Selve WSDL-filen kan se veldig kompleks ut for enhver bruker, men den inneholder all nødvendig informasjon som enhver klientapplikasjon ville trenge for å bruke den relevante webtjenesten. Nedenfor er den generelle strukturen til en WSDL-fil:

• Definisjon
• Targetnamespace
• Datatyper
• meldinger
• Porttype
• Bindinger
• Service

En viktig ting å merke seg her er at definisjonen av meldinger, som er det som sendes av SOAP protokoll, er faktisk definert i WSDL-dokumentet. WSDL-dokumentet forteller en klientapplikasjon hvilke typer SOAP-meldinger som sendes og aksepteres av webtjenesten.

Med andre ord er WSDL akkurat som et postkort som har adressen til et bestemt sted. Adressen gir detaljene om hvor meldingen skal leveres. Derfor er WSDL-filen på samme måte postkortet som har adressen til webtjenesten som kan levere all funksjonaliteten klienten ønsker.

<!-- WSDL definition structure -->
<definitions
      name="Guru99Service"
      targetNamespace=http://example.org/math/
      xmlns=http://schemas.xmlsoap.org/wsdl/>
   <!-- abstract definitions -->
      <types> ...
      <message> ...
      <portType> ...

   <!-- concrete definitions -->
      <binding> ...
      <service> ...
</definition>

Nedenfor er et diagram over strukturen til en WSDL-fil.

Strukturen til en WSDL

WSDL-elementer

WSDL-filen inneholder følgende hoveddeler:

1. Ocuco Taggen brukes til å definere alle de komplekse datatypene som skal brukes i meldingen som utveksles mellom klientapplikasjonen og webtjenesten. Dette er viktig fordi hvis webtjenesten jobber med en kompleks datatype, bør klientapplikasjonen vite hvordan den skal behandles. Datatyper som flyttall, tall og strenger er alle enkle datatyper, men det kan finnes strukturerte datatyper levert av webtjenesten. For eksempel kan det være en datatype kalt EmployeeDataType som kan ha to elementer kalt «EmployeeName» av typen streng og «EmployeeID» av typen tall eller heltall. Sammen danner de en kompleks datatype.
2. Ocuco Taggen brukes til å definere meldingen som utveksles mellom klientapplikasjonen og webserveren. Disse meldingene forklarer input- og output-operasjonene som kan utføres av webtjenesten. Et eksempel på en melding kan være en som godtar ansatt-ID-en til en ansatt, og output-meldingen kan være navnet på den ansatte basert på den angitte ansatt-ID-en.
3. Ocuco taggen brukes til å kapsle inn hver inn- og utgangsmelding i én logisk operasjon. Så det kan være en operasjon kalt "GetEmployee" som kombinerer inngangsmeldingen om å godta EmployeeID fra en klientapplikasjon og deretter sende EmployeeName som utdatamelding.
4. Ocuco Taggen brukes til å binde operasjonen til en bestemt porttype. Dette er slik at når klientapplikasjonen kaller den relevante porttypen, vil den kunne få tilgang til operasjonene som er bundet til den. Porttyper er akkurat som grensesnitt. Så hvis en klientapplikasjon trenger å bruke en webtjeneste, må de bruke bindingsinformasjonen for å sikre at de kan koble til grensesnittet som tilbys av den webtjenesten.
5. Ocuco En tag er et navn gitt til selve webtjenesten. Når en klientapplikasjon først foretar et kall til webtjenesten, vil den gjøre det ved å kalle navnet på webtjenesten. For eksempel kan en webtjeneste være plassert på en adresse som http://localhost/Guru99/Tutorial.asmx. Service-ID-en vil ha URL definert, som forteller klientapplikasjonen at en webtjeneste er tilgjengelig på denne plasseringen.

Hvorfor WSDL

En webtjeneste er en viktig komponent i byggingen av moderne webapplikasjoner. Hovedformålet deres er å la flere applikasjoner bygget på forskjellige programmeringsspråk kommunisere med hverandre. For eksempel kan vi få en .Net-webapplikasjon til å kommunisere med en Java applikasjon via en webtjeneste.

En webtjeneste har følgende hovedfunksjoner:

• Den er bygget med programmeringsspråket XML. Nesten alle moderne teknologier som .Net og Java har tilsvarende kommandoer som har muligheten til å arbeide med XML. Derfor ble XML tatt som det mest passende språket for å bygge webtjenester.
• Webtjenester kommuniserer via HTTP. HTTP er en protokoll som brukes av alle nettbaserte applikasjoner. Derfor var det fornuftig å sørge for at webtjenester også hadde muligheten til å fungere over HTTP-protokollen.
• Webtjenester samsvarer med en bestemt språkspesifikasjon. Denne spesifikasjonen er satt av W3C, som er det styrende organet for alle nettstandarder.
• Nettjenester har et beskrivelsesspråk kjent som WSDL, som brukes til å beskrive nettjenesten.

WSDL-filen er skrevet i vanlig XML. Grunnen til at den er i XML er at filen kan leses av et hvilket som helst programmeringsspråk. Så hvis klientapplikasjonen ble skrevet i .Net, ville den forstå XML-filen. På samme måte, hvis klientapplikasjonen ble skrevet i Java programmeringsspråk, ville det også kunne tolke WSDL-filen.

WSDL-filen er det som binder alt sammen. Fra diagrammet ovenfor kan du se at du kan opprette en webtjeneste i .Net-språket. Så det er her tjenesten implementeres. Hvis du ikke hadde WSDL-filen og ønsket en Java klasse for å bruke webtjenesten, ville du trenge mye kodearbeid for å oppnå dette. Men nå, med WSDL-filen, som er i XML og kan forstås av ethvert programmeringsspråk, kan du enkelt ha en Java klasse bruker .Net-webtjenesten. Derfor er mengden av kodeinnsats kraftig redusert.

WSDL-meldingsdel

WSDL består av en seksjon kalt "meldinger" som er betegnet med element. Dette elementet brukes i utgangspunktet til å beskrive dataene som utveksles mellom webtjenesten og klientapplikasjonen.

Hver webtjeneste vil alltid ha to typer meldinger:

• Den ene er for inngangen til nettjenesten, og den andre er for utgangen av nettjenesten.
• Inndataene brukes til å beskrive parameterne som er akseptert av webtjenesten. Dette er et viktig aspekt ved klientapplikasjonen slik at den kjenner verdiene som skal sendes som parametere til webtjenesten.
• Den andre typen melding er utgangsmeldingen som forteller hvilke resultater nettjenesten gir.

Hver melding vil på sin side ha en element som brukes til å beskrive parameteren som brukes av inn- og utgangsmeldingen.

Nedenfor er et enkelt eksempel på hvordan en melding for en webtjeneste ser ut. Webtjenestens funksjonalitet er å oppgi navnet på en «opplæring» når en «opplærings-ID» er sendt inn som en parameter til webtjenesten.

1. Som vi kan se, har webtjenesten to meldinger, én for input og den andre for output.
2. Inndatameldingen er kjent som TutorialNameRequest, som har én parameter kalt TutorialID. Denne parameteren er av typen number, som er spesifisert av xsd:number-typen.
3. Utdatameldingen kalles TutorialNameResponse, som har én parameter kalt TutorialName. Denne parameteren er av typen string, som er spesifisert av xsd:string-typen.

Port Type Binding

Porter brukes i WSDL til å definere én komplett operasjon som tilbys av webtjenesten. I forrige emne så vi at webtjenesten vår leverte to meldinger, én for input kalt «TutorialNameRequest» og den andre for output kalt «TutorialNameResponse». Sammen danner input- og output-meldingen det som kalles én komplett operasjon.

WSDL gir et element kalt som brukes til å definere operasjonene som tilbys av webtjenesten.

Så i eksemplet ovenfor kan vi merke oss følgende:

1. Navnet på porttypen som innkapsler operasjonen er gitt som «Tutorial_PortType».
2. Selve operasjonen får navnet «Opplæring». Så operasjonen vår gir i utgangspunktet et Opplæringsnavn hvis OpplæringsID-en oppgis som en inputparameter.
3. Deretter er de to meldingene våre, en for input og den andre for output, som danner operasjonen vår.

I tillegg til det element, det er også element som brukes til å definere hvordan meldingene skal overføres.

1. Eksemplet ovenfor viser at bindingen består av et bindingsnavn som i vårt tilfelle er gitt som «TutorialSoapBinding». Binding er, enkelt sagt, informasjonen som klientapplikasjonen bruker for å faktisk binde seg til webtjenesten. Når den er bundet til webtjenesten, har den muligheten til å kalle de forskjellige operasjonene som eksponeres av webtjenesten.
2. Transportlaget er gitt som http://, som betyr at meldingene overføres over HTTP-protokollen.

Oppretter WSDL-fil

WSDL-filen opprettes hver gang en webtjeneste bygges i et hvilket som helst programmeringsspråk. Siden WSDL-filen er ganske komplisert å generere fra bunnen av, er alle editorer som Visual Studio for .Net og Eclipse forum Java opprette WSDL-filen automatisk.

Nedenfor er et eksempel på en WSDL-fil opprettet i Visual Studio.

<?xml version="1.0"?>
<definitions name="Tutorial"
      targetNamespace=http://Guru99.com/Tutorial.wsdl
      xmlns:tns=http://Guru99.com/Tutorial.wsdl
      xmlns:xsd1=http://Guru99.com/Tutorial.xsd
      xmlns:soap=http://schemas.xmlsoap.org/wsdl/soap/
      xmlns="http://schemas.xmlsoap.org/wsdl/">
   <types>
      <schema targetNamespace=http://Guru99.com/Tutorial.xsd
         xmlns="http://www.w3.org/2000/10/XMLSchema">
         <element name="TutorialNameRequest">
            <complexType>
               <all>
                  <element name="TutorialName" type="string"/>
               </all>
            </complexType>
         </element>
         <element name="TutorialIDRequest">
            <complexType>
               <all>
                  <element name="TutorialID" type="number"/>
               </all>
            </complexType>
         </element>
      </schema>
   </types>
   <message name="GetTutorialNameInput">
      <part name="body" element="xsd1:TutorialIDRequest"/>
   </message>
   <message name="GetTutorialNameOutput">
      <part name="body" element="xsd1:TutorialNameRequest"/>
   </message>
   <portType name="TutorialPortType">
      <operation name="GetTutorialName">
         <input message="tns:GetTutorialNameInput"/>
         <output message="tns:GetTutorialNameOutput"/>
      </operation>
   </portType>
   <binding name="TutorialSoapBinding" type="tns:TutorialPortType">
      <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
      <operation name="GetTutorialName">
         <soap:operation soapAction="http://Guru99.com/GetTutorialName"/>
         <input>
            <soap:body use="literal"/>
         </input>
         <output>
            <soap:body use="literal"/>
         </output>
      </operation>
   </binding>
   <service name="TutorialService">
      <documentation>TutorialService</documentation>
      <port name="TutorialPort" binding="tns:TutorialSoapBinding">
         <soap:address location="http://Guru99.com/Tutorial"/>
      </port>
   </service>
</definitions>

WSDL-filen ovenfor ser veldig skremmende ut for enhver bruker. Vi vil dekke de ulike delene i detalj i de påfølgende veiledningene, men la oss foreløpig ta en oppsummering av hva hver del av WSDL-filen faktisk gjør.

Publisering av netttjenesteeksempel

La oss nå se på et eksempel på hvordan vi kan publisere en webtjeneste og bruke den ved hjelp av Visual Studio. I dette eksemplet skal vi opprette en webtjeneste med én WebMethod. Denne metoden vil godta en heltallsparameter kalt «TutorialID». Web-metoden vil deretter returnere en streng kalt «Webtjenester».

Deretter oppretter vi en konsollbasert applikasjon som bruker denne webtjenesten og kaller webmetoden vår deretter. La oss se på trinnene som kreves for å utføre dette eksemplet.

Trinn 1) Det første trinnet er å lage din webtjeneste. De detaljerte trinnene for hvordan Asp.Net Nettprosjekter og webtjenester er opprettet, og det er forklart hvordan de opprettes. her.Følg de samme trinnene for å opprette prosjektet og webtjenesten deretter. Det viktigste er å legge inn koden nedenfor i webtjenestefilen.

namespace webservic_asmx
{
   [WebService(Name = "Guru99 Web service")]
   public class TutorialService : System.Web.Services.WebService
   {
      [WebMethod]
      public string GetTutorialService(int TutorialID)
      {
         string TutorialName = "Web Services";
         return TutorialName;
      }
   }
}

Code Forklaring:

1. Her lager vi en webmetode kalt «Guru99WebService.» I denne webmetoden inkluderer vi en heltallsparameter som må sendes hver gang denne webmetoden kalles.
2. Deretter definerer vi en variabel kalt "TutorialName" som vil inneholde strengverdien til "Web Services." Dette er verdien som vil bli returnert når nettjenesten kalles opp.

Trinn 2) Når vi har definert webtjenestefilen, er neste trinn å opprette et klientprosjekt som skal bruke denne webtjenesten. La oss opprette en enkel konsollapplikasjon som vil kalle denne webtjenesten og påkalle «Guru99WebService», og vis deretter resultatet av web-metoden i konsollloggskjermen. Følg trinnene nedenfor for å opprette et konsollprogram. Høyreklikk på Visual Studio-løsningsfilen og velg alternativet Legg til->Nytt prosjekt.

Trinn 3) I dette trinnet

1. Sørg for å først velge Visual C# Windows alternativ. Velg deretter alternativet for å opprette en konsollapplikasjon.
2. Gi et navn for prosjektet ditt som i vårt tilfelle har blitt gitt som "DemoApplication."

Etter at du har klikket på OK-knappen på skjermbildet ovenfor, vil du kunne se prosjektet i Solution Explorer i Visual Studio.

Trinn 4) I dette trinnet angir du DemoApplication Console-applikasjonen som oppstartsprosjekt. Dette gjøres for å sikre at denne applikasjonen starter først når hele Visual Studio-prosjektet kjøres. Denne konsollapplikasjonen vil igjen kalle webtjenesten som automatisk startes av Visual Studio. For å fullføre dette trinnet, høyreklikker du på DemoApplication-prosjektet og velger alternativet «Angi som oppstartsprosjekt».

Trinn 5) Neste trinn er å legge til servicereferansen til vår «Guru99Webservice» til konsollapplikasjonen vår. Dette gjøres slik at DemoApplication kan referere til webtjenesten og alle webmetodene i webtjenesten. For å gjøre dette, høyreklikk på DemoApplication-prosjektfilen og velg menyalternativet Legg til->Tjenestereferanse.

Trinn 6) I dette trinnet vil vi oppgi de forskjellige verdiene som kreves for å legge til tjenestereferansen vår.

1. Først må vi velge vårt oppdagingsalternativ. Dette alternativet vil automatisk hente WSDL-filen for TutorialService-webtjenesten vår.
2. Deretter bør vi gi et navn til tjenestereferansen vår. I vårt tilfelle gir vi den navnet Guru99Nettjeneste.
3. Så må vi utvide alternativet TutorialService.asmx slik at vi kan se metoden «GetTutorialService» på høyre side. Her er TutorialService.asmx navnet på Visual Studio .Net-filen vår, som inneholder koden for webtjenesten vår.
4. Da vil vi se webmetoden vår, som vi hadde i webtjenesten vår, kjent som «GetTutorialService».

Når vi klikker på «OK»-knappen, vil all nødvendig kode for å få tilgang til denne webtjenesten bli lagt til i DemoApplication Console-applikasjonen vår, som vist nedenfor. Skjermbildet viser at «Guru«99Webservice» ble lagt til i konsollapplikasjonen vår.

Trinn 7) Neste trinn er å legge til koden i konsollapplikasjonen vår for å få tilgang til webmetoden i webtjenesten vår. Åpne Program.cs-kodefilen som følger automatisk med konsollapplikasjonen, og legg til koden nedenfor.

namespace DemoApplication
{
   class Program
   {
      static void Main(string[] args)
      {
         var client = new Guru99Webservice.Guru99WebserviceSoapClient();

         Console.WriteLine(client.GetTutorialService(1));

         Console.ReadKey();
      }
   }
}

Code Forklaring:

1. Den første delen er å velge Program.cs-filen. Dette er hovedfilen som opprettes av Visual Studio når et konsollprogram opprettes. Det er denne filen som kjøres når konsollprogrammet (i vårt tilfelle DemoApplication) kjøres.
2. Deretter oppretter vi en variabel kalt «client» som settes til en instans av tjenestereferansen vår som ble opprettet i et tidligere trinn. I vårt tilfelle er tjenestereferansen 'Guru99Nettjeneste.Guru99WebserviceSoapClient()'.
3. Vi kaller deretter webmetoden vår «GetTutorialService» i TutorialService-webtjenesten. Husk at GetTutorialService-metoden vår godtar en heltallsparameter, så vi sender bare en heltallsparameter til webmetoden.
4. Denne siste linjen er bare for å sikre at konsollloggskjermen forblir aktiv slik at vi kan se utdataene. Denne kommandoen vil vente på inndata fra brukeren.

Produksjon

Når alle trinnene ovenfor er fulgt, og DemoApplication kjøres, vil utdataene nedenfor vises.

Fra utgangen kan vi tydelig se at DemoApplication kaller opp webtjenesten vår og at strengen som returneres av webtjenesten vises i konsollloggen vår.

Spørsmål og svar