Wprowadzenie — przykład
W przykładzie GettingStarted pokazano, jak zaimplementować typową usługę i typowego klienta przy użyciu programu Windows Communication Foundation (WCF). Ten przykład jest podstawą dla wszystkich innych podstawowych przykładów technologicznych.
Uwaga
Procedura instalacji i instrukcje kompilacji dla tego przykładu znajdują się na końcu tego tematu.
Usługa opisuje operacje wykonywane w kontrakcie usługi, który uwidacznia publicznie jako metadane. Usługa zawiera również kod implementowania operacji.
Klient zawiera definicję kontraktu usługi i klasę serwera proxy na potrzeby uzyskiwania dostępu do usługi. Kod serwera proxy jest generowany na podstawie metadanych usługi przy użyciu narzędzia ServiceModel Metadata Tool (Svcutil.exe).
W systemie Windows Vista usługa jest hostowana w usłudze aktywacji systemu Windows (WAS). W systemach Windows XP i Windows Server 2003 są hostowane przez usługi Internet Information Services (IIS) i ASP.NET. Hostowanie usługi w usługach IIS lub WAS umożliwia automatyczne aktywowanie usługi po pierwszym korzystaniu z niej.
Uwaga
Jeśli wolisz rozpocząć pracę z przykładem hostujący usługę w aplikacji konsolowej zamiast usług IIS, zobacz przykład Self-Host (Self-Host ).
Usługa i klient określają szczegóły dostępu w ustawieniach pliku konfiguracji, które zapewniają elastyczność w czasie wdrażania. Obejmuje to definicję punktu końcowego, która określa adres, powiązanie i kontrakt. Powiązanie określa szczegóły transportu i zabezpieczeń dotyczące sposobu uzyskiwania dostępu do usługi.
Usługa konfiguruje zachowanie czasu wykonywania w celu opublikowania metadanych.
Usługa implementuje kontrakt, który definiuje wzorzec komunikacji typu żądanie-odpowiedź. Kontrakt jest definiowany przez ICalculator interfejs, który uwidacznia operacje matematyczne (dodawanie, odejmowanie, mnożenie i dzielenie). Klient wysyła żądania do danej operacji matematycznej, a usługa odpowiada z wynikiem. Usługa implementuje ICalculator kontrakt zdefiniowany w poniższym kodzie.
' 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);
}
Implementacja usługi oblicza i zwraca odpowiedni wynik, jak pokazano w poniższym przykładowym kodzie.
' 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;
}
}
Usługa uwidacznia punkt końcowy do komunikowania się z usługą, zdefiniowany przy użyciu pliku konfiguracji (Web.config), jak pokazano w poniższej przykładowej konfiguracji.
<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>
Usługa uwidacznia punkt końcowy pod adresem podstawowym dostarczonym przez host usług IIS lub WAS. Powiązanie jest konfigurowane przy użyciu standardu WSHttpBinding, który zapewnia komunikację HTTP i standardowe protokoły usługi sieci Web na potrzeby adresowania i zabezpieczeń. Kontrakt jest ICalculator implementowany przez usługę.
Zgodnie z konfiguracją dostęp do usługi można uzyskać http://localhost/servicemodelsamples/service.svc za pomocą klienta na tym samym komputerze. Aby klienci na komputerach zdalnych mogli uzyskać dostęp do usługi, należy określić w pełni kwalifikowaną nazwę domeny zamiast hosta lokalnego.
Struktura domyślnie nie uwidacznia metadanych. W związku z tym usługa włącza ServiceMetadataBehavior i uwidacznia punkt końcowy wymiany metadanych (MEX) pod adresem http://localhost/servicemodelsamples/service.svc/mex. Poniższa konfiguracja pokazuje to.
<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>
Klient komunikuje się przy użyciu określonego typu kontraktu przy użyciu klasy klienta wygenerowanej przez narzędzie ServiceModel Metadata Tool (Svcutil.exe). Ten wygenerowany klient jest zawarty w pliku generatedClient.cs lub generatedClient.vb. To narzędzie pobiera metadane dla danej usługi i generuje klienta do użycia przez aplikację kliencką w celu komunikowania się przy użyciu danego typu kontraktu. Usługa hostowana musi być dostępna do wygenerowania kodu klienta, ponieważ usługa jest używana do pobierania zaktualizowanych metadanych.
Uruchom następujące polecenie w wierszu polecenia zestawu SDK w katalogu klienta, aby wygenerować typowy serwer proxy:
svcutil.exe /n:"http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples" http://localhost/servicemodelsamples/service.svc/mex /out:generatedClient.cs
Aby wygenerować klienta w języku Visual Basic, wpisz następujące polecenie w wierszu polecenia zestawu SDK:
Svcutil.exe /n:"http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples" http://localhost/servicemodelsamples/service.svc/mex /l:vb /out:generatedClient.vb
Przy użyciu wygenerowanego klienta klient może uzyskać dostęp do danego punktu końcowego usługi, konfigurując odpowiedni adres i powiązanie. Podobnie jak w przypadku usługi, klient używa pliku konfiguracji (App.config) do określenia punktu końcowego, z którym chce się komunikować. Konfiguracja punktu końcowego klienta składa się z bezwzględnego adresu punktu końcowego usługi, powiązania i kontraktu, jak pokazano w poniższym przykładzie.
<client>
<endpoint
address="http://localhost/servicemodelsamples/service.svc"
binding="wsHttpBinding"
contract=" Microsoft.ServiceModel.Samples.ICalculator" />
</client>
Implementacja klienta tworzy wystąpienie klienta i używa wpisanego interfejsu, aby rozpocząć komunikację z usługą, jak pokazano w poniższym przykładowym kodzie.
' 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();
Po uruchomieniu przykładu żądania operacji i odpowiedzi są wyświetlane w oknie konsoli klienta. Naciśnij klawisz ENTER w oknie klienta, aby zamknąć klienta.
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.
Przykład Wprowadzenie przedstawia standardowy sposób tworzenia usługi i klienta. Druga wersja Podstawowa bazuje na tym przykładzie, aby zademonstrować określone funkcje produktu.
Aby skonfigurować, skompilować i uruchomić przykład
Upewnij się, że wykonano procedurę instalacji jednorazowej dla przykładów programu Windows Communication Foundation.
Aby skompilować wersję rozwiązania w języku C# lub Visual Basic .NET, postępuj zgodnie z instrukcjami w temacie Building the Windows Communication Foundation Samples (Tworzenie przykładów programu Windows Communication Foundation).
Aby uruchomić przykład w konfiguracji pojedynczej lub między komputerami, postępuj zgodnie z instrukcjami w temacie Uruchamianie przykładów programu Windows Communication Foundation.