Első lépéseket ismertető minta
A GettingStarted minta bemutatja, hogyan implementálhat egy tipikus szolgáltatást és egy tipikus ügyfelet a Windows Communication Foundation (WCF) használatával. Ez a minta az összes többi alapszintű technológiai minta alapja.
Feljegyzés
A minta telepítési eljárása és összeállítási utasításai a témakör végén találhatók.
A szolgáltatás leírja a szolgáltatásszerződésben végrehajtott műveleteket, amelyeket metaadatokként nyilvánosan elérhetővé tesz. A szolgáltatás a műveletek implementálásához szükséges kódot is tartalmazza.
Az ügyfél tartalmazza a szolgáltatási szerződés definícióját és a szolgáltatás elérésére szolgáló proxyosztályt. A proxykódot a szolgáltatás metaadataiból hozza létre a ServiceModel Metadata Segédprogram (Svcutil.exe) használatával.
Windows Vista rendszeren a szolgáltatás a Windows Aktiválási szolgáltatásban (WAS) található. Windows XP és Windows Server 2003 rendszeren az Internet Information Services (IIS) és ASP.NET üzemelteti. Egy szolgáltatás IIS-ben vagy WAS-ban való üzemeltetése lehetővé teszi, hogy a szolgáltatás automatikusan aktiválódjon, amikor első alkalommal érik el.
Feljegyzés
Ha az IIS helyett egy konzolalkalmazásban üzemeltetett szolgáltatást futtató mintával szeretne megismerkedni, tekintse meg az önkiszolgáló mintát.
A szolgáltatás és az ügyfél a konfigurációs fájlbeállításokban adja meg a hozzáférési adatokat, amelyek rugalmasságot biztosítanak az üzembe helyezéskor. Ez magában foglal egy végpontdefiníciót, amely megadja a címet, a kötést és a szerződést. A kötés megadja a szolgáltatás elérésének átviteli és biztonsági adatait.
A szolgáltatás futásidejű viselkedést konfigurál a metaadatok közzétételéhez.
A szolgáltatás megvalósít egy szerződést, amely egy kérés-válasz kommunikációs mintát határoz meg. A szerződést az ICalculator interfész határozza meg, amely matematikai műveleteket tesz elérhetővé (hozzáadás, kivonás, szorzás és osztás). Az ügyfél kéréseket küld egy adott matematikai művelethez, és a szolgáltatás az eredménnyel válaszol. A szolgáltatás az ICalculator alábbi kódban meghatározott szerződést valósít meg.
' Define a service contract.
<ServiceContract(Namespace:="http://Microsoft.Samples.GettingStarted")>
Public Interface ICalculator
<OperationContract()>
Function Add(ByVal n1 As Double, ByVal n2 As Double) As Double
<OperationContract()>
Function Subtract(ByVal n1 As Double, ByVal n2 As Double) As Double
<OperationContract()>
Function Multiply(ByVal n1 As Double, ByVal n2 As Double) As Double
<OperationContract()>
Function Divide(ByVal n1 As Double, ByVal n2 As Double) As Double
End Interface
// Define a service contract.
[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface ICalculator
{
[OperationContract]
double Add(double n1, double n2);
[OperationContract]
double Subtract(double n1, double n2);
[OperationContract]
double Multiply(double n1, double n2);
[OperationContract]
double Divide(double n1, double n2);
}
A szolgáltatás implementációja kiszámítja és visszaadja a megfelelő eredményt az alábbi példakódban látható módon.
' Service class which implements the service contract.
Public Class CalculatorService
Implements ICalculator
Public Function Add(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Add
Return n1 + n2
End Function
Public Function Subtract(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Subtract
Return n1 - n2
End Function
Public Function Multiply(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Multiply
Return n1 * n2
End Function
Public Function Divide(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Divide
Return n1 / n2
End Function
End Class
// Service class that implements the service contract.
public class CalculatorService : ICalculator
{
public double Add(double n1, double n2)
{
return n1 + n2;
}
public double Subtract(double n1, double n2)
{
return n1 - n2;
}
public double Multiply(double n1, double n2)
{
return n1 * n2;
}
public double Divide(double n1, double n2)
{
return n1 / n2;
}
}
A szolgáltatás egy végpontot tesz elérhetővé a szolgáltatással való kommunikációhoz egy konfigurációs fájllal (Web.config) definiálva, ahogyan az az alábbi mintakonfigurációban látható.
<services>
<service
name="Microsoft.ServiceModel.Samples.CalculatorService"
behaviorConfiguration="CalculatorServiceBehavior">
<!-- ICalculator is exposed at the base address provided by
host: http://localhost/servicemodelsamples/service.svc. -->
<endpoint address=""
binding="wsHttpBinding"
contract="Microsoft.ServiceModel.Samples.ICalculator" />
...
</service>
</services>
A szolgáltatás a végpontot az IIS vagy WAS gazdagép által megadott alapcímen teszi elérhetővé. A kötés egy szabványos WSHttpBinding, amely HTTP-kommunikációt és szabványos webszolgáltatás-protokollokat biztosít a címzéshez és a biztonsághoz. A szerződés a ICalculator szolgáltatás által implementált.
A konfigurált módon a szolgáltatást egy ügyfél elérheti http://localhost/servicemodelsamples/service.svc ugyanazon a számítógépen. Ahhoz, hogy a távoli számítógépeken lévő ügyfelek hozzáférhessenek a szolgáltatáshoz, a localhost helyett teljes tartománynevet kell megadni.
A keretrendszer alapértelmezés szerint nem teszi közzé a metaadatokat. Így a szolgáltatás bekapcsolja és elérhetővé teszi a ServiceMetadataBehavior metaadat-exchange (MEX) végpontot a következő helyen http://localhost/servicemodelsamples/service.svc/mex: . Ezt az alábbi konfiguráció szemlélteti.
<system.serviceModel>
<services>
<service
name="Microsoft.ServiceModel.Samples.CalculatorService"
behaviorConfiguration="CalculatorServiceBehavior">
...
<!-- the mex endpoint is exposed at
http://localhost/servicemodelsamples/service.svc/mex -->
<endpoint address="mex"
binding="mexHttpBinding"
contract="IMetadataExchange" />
</service>
</services>
<!--For debugging purposes set the includeExceptionDetailInFaults
attribute to true-->
<behaviors>
<serviceBehaviors>
<behavior name="CalculatorServiceBehavior">
<serviceMetadata httpGetEnabled="True"/>
<serviceDebug includeExceptionDetailInFaults="False" />
</behavior>
</serviceBehaviors>
</behaviors>
</system.serviceModel>
Az ügyfél egy adott szerződéstípussal kommunikál a ServiceModel Metadata Segédprogram (Svcutil.exe) által létrehozott ügyfélosztály használatával. Ez a létrehozott ügyfél a generatedClient.cs vagy generatedClient.vb fájlban található. Ez a segédprogram lekéri egy adott szolgáltatás metaadatait, és létrehoz egy ügyfelet, amelyet az ügyfélalkalmazás használ egy adott szerződéstípus használatával történő kommunikációhoz. Az üzemeltetett szolgáltatásnak elérhetőnek kell lennie az ügyfélkód létrehozásához, mivel a szolgáltatás a frissített metaadatok lekérésére szolgál.
Futtassa a következő parancsot az SDK parancssorából az ügyfélkönyvtárban a beírt proxy létrehozásához:
svcutil.exe /n:"http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples" http://localhost/servicemodelsamples/service.svc/mex /out:generatedClient.cs
Az ügyfél Visual Basicben való létrehozásához írja be az alábbiakat az SDK parancssorából:
Svcutil.exe /n:"http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples" http://localhost/servicemodelsamples/service.svc/mex /l:vb /out:generatedClient.vb
A létrehozott ügyfél használatával az ügyfél hozzáférhet egy adott szolgáltatásvégponthoz a megfelelő cím és kötés konfigurálásával. A szolgáltatáshoz hasonlóan az ügyfél egy konfigurációs fájlt (App.config) használ annak a végpontnak a megadásához, amellyel kommunikálni szeretne. Az ügyfélvégpont konfigurációja a szolgáltatásvégpont, a kötés és a szerződés abszolút címéből áll az alábbi példában látható módon.
<client>
<endpoint
address="http://localhost/servicemodelsamples/service.svc"
binding="wsHttpBinding"
contract=" Microsoft.ServiceModel.Samples.ICalculator" />
</client>
Az ügyfél implementációja példányosítja az ügyfelet, és a gépelt felületet használja a szolgáltatással való kommunikáció megkezdéséhez, ahogyan az az alábbi példakódban látható.
' Create a client
Dim client As New CalculatorClient()
' Call the Add service operation.
Dim value1 = 100.0R
Dim value2 = 15.99R
Dim result = client.Add(value1, value2)
Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result)
' Call the Subtract service operation.
value1 = 145.00R
value2 = 76.54R
result = client.Subtract(value1, value2)
Console.WriteLine("Subtract({0},{1}) = {2}", value1, value2, result)
' Call the Multiply service operation.
value1 = 9.00R
value2 = 81.25R
result = client.Multiply(value1, value2)
Console.WriteLine("Multiply({0},{1}) = {2}", value1, value2, result)
' Call the Divide service operation.
value1 = 22.00R
value2 = 7.00R
result = client.Divide(value1, value2)
Console.WriteLine("Divide({0},{1}) = {2}", value1, value2, result)
'Closing the client gracefully closes the connection and cleans up resources
// Create a client.
CalculatorClient client = new CalculatorClient();
// Call the Add service operation.
double value1 = 100.00D;
double value2 = 15.99D;
double result = client.Add(value1, value2);
Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result);
// Call the Subtract service operation.
value1 = 145.00D;
value2 = 76.54D;
result = client.Subtract(value1, value2);
Console.WriteLine("Subtract({0},{1}) = {2}", value1, value2, result);
// Call the Multiply service operation.
value1 = 9.00D;
value2 = 81.25D;
result = client.Multiply(value1, value2);
Console.WriteLine("Multiply({0},{1}) = {2}", value1, value2, result);
// Call the Divide service operation.
value1 = 22.00D;
value2 = 7.00D;
result = client.Divide(value1, value2);
Console.WriteLine("Divide({0},{1}) = {2}", value1, value2, result);
//Closing the client releases all communication resources.
client.Close();
A minta futtatásakor a műveleti kérelmek és a válaszok megjelennek az ügyfélkonzol ablakában. Nyomja le az ENTER billentyűt az ügyfélablakban az ügyfél leállításához.
Add(100,15.99) = 115.99
Subtract(145,76.54) = 68.46
Multiply(9,81.25) = 731.25
Divide(22,7) = 3.14285714285714
Press <ENTER> to terminate client.
Az Első lépések minta a szolgáltatás és az ügyfél létrehozásának szokásos módját mutatja be. A másik alapszintű build erre a mintára épül, amely konkrét termékfunkciókat mutat be.
A minta beállítása, összeállítása és futtatása
Győződjön meg arról, hogy elvégezte a Windows Communication Foundation-minták egyszeri beállítási eljárását.
A megoldás C# vagy Visual Basic .NET kiadásának létrehozásához kövesse a Windows Communication Foundation-minták készítéséhez szükséges utasításokat.
Ha a mintát egy- vagy számítógépközi konfigurációban szeretné futtatni, kövesse a Windows Communication Foundation-minták futtatásával kapcsolatos utasításokat.