ServiceContractAttribute Classe
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Indica che un'interfaccia o una classe definisce un contratto di servizio in un'applicazione Windows Communication Foundation (WCF).
public ref class ServiceContractAttribute sealed : Attribute[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple=false, Inherited=false)]
public sealed class ServiceContractAttribute : Attribute[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, Inherited=false)]
public sealed class ServiceContractAttribute : Attribute[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple=false, Inherited=false)>]
type ServiceContractAttribute = class
inherit Attribute[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, Inherited=false)>]
type ServiceContractAttribute = class
inherit AttributePublic NotInheritable Class ServiceContractAttribute
Inherits Attribute- Ereditarietà
- Attributi
Esempio
Nell'esempio di codice seguente viene mostrato come applicare l'attributo ServiceContractAttribute a un'interfaccia per definire un contratto di servizio avente un solo metodo di servizio, indicato dall'attributo OperationContractAttribute. In questo caso, il livello di protezione che le associazioni devono applicare a tutti i messaggi è ProtectionLevel.EncryptAndSign.
L'esempio di codice prevede quindi l'implementazione del suddetto contratto nella classe SampleService.
using System;
using System.Collections.Generic;
using System.Net.Security;
using System.ServiceModel;
using System.Text;
namespace Microsoft.WCF.Documentation
{
[ServiceContract(
Namespace="http://microsoft.wcf.documentation",
Name="SampleService",
ProtectionLevel=ProtectionLevel.EncryptAndSign
)]
public interface ISampleService{
[OperationContract]
string SampleMethod(string msg);
}
class SampleService : ISampleService
{
#region ISampleService Members
public string SampleMethod(string msg)
{
return "The service greets you: " + msg;
}
#endregion
}
}
Imports System.Collections.Generic
Imports System.Net.Security
Imports System.ServiceModel
Imports System.Text
Namespace Microsoft.WCF.Documentation
<ServiceContract(Namespace:="http://microsoft.wcf.documentation", Name:="SampleService", ProtectionLevel:=ProtectionLevel.EncryptAndSign)> _
Public Interface ISampleService
<OperationContract> _
Function SampleMethod(ByVal msg As String) As String
End Interface
Friend Class SampleService
Implements ISampleService
#Region "ISampleService Members"
Public Function SampleMethod(ByVal msg As String) As String Implements ISampleService.SampleMethod
Return "The service greets you: " & msg
End Function
#End Region
End Class
End Namespace
Nell'esempio di codice seguente viene mostrato un semplice file di configurazione del servizio precedente che crea un solo endpoint.
<configuration>
<system.serviceModel>
<services>
<service
name="Microsoft.WCF.Documentation.SampleService"
behaviorConfiguration="mex"
>
<host>
<baseAddresses>
<add baseAddress="http://localhost:8080/SampleService"/>
</baseAddresses>
</host>
<endpoint
address=""
binding="wsHttpBinding"
contract="Microsoft.WCF.Documentation.ISampleService"
/>
<endpoint
address="mex"
binding="mexHttpBinding"
contract="IMetadataExchange"
/>
</service>
</services>
<behaviors>
<serviceBehaviors>
<behavior name="mex">
<serviceMetadata httpGetEnabled="true" httpGetUrl=""/>
</behavior>
</serviceBehaviors>
</behaviors>
</system.serviceModel>
</configuration>
Nell'esempio di codice seguente viene mostrato un semplice client che richiama la classe SampleService precedente.
using System;
using System.ServiceModel;
using System.ServiceModel.Channels;
public class Client
{
public static void Main()
{
// Picks up configuration from the config file.
SampleServiceClient wcfClient = new SampleServiceClient();
try
{
// Making calls.
Console.WriteLine("Enter the greeting to send: ");
string greeting = Console.ReadLine();
Console.WriteLine("The service responded: " + wcfClient.SampleMethod(greeting));
Console.WriteLine("Press ENTER to exit:");
Console.ReadLine();
// Done with service.
wcfClient.Close();
Console.WriteLine("Done!");
}
catch (TimeoutException timeProblem)
{
Console.WriteLine("The service operation timed out. " + timeProblem.Message);
wcfClient.Abort();
Console.Read();
}
catch(CommunicationException commProblem)
{
Console.WriteLine("There was a communication problem. " + commProblem.Message);
wcfClient.Abort();
Console.Read();
}
}
}
Imports System.ServiceModel
Imports System.ServiceModel.Channels
Public Class Client
Public Shared Sub Main()
' Picks up configuration from the config file.
Dim wcfClient As New SampleServiceClient()
Try
' Making calls.
Console.WriteLine("Enter the greeting to send: ")
Dim greeting = Console.ReadLine()
Console.WriteLine("The service responded: " & wcfClient.SampleMethod(greeting))
Console.WriteLine("Press ENTER to exit:")
Console.ReadLine()
' Done with service.
wcfClient.Close()
Console.WriteLine("Done!")
Catch timeProblem As TimeoutException
Console.WriteLine("The service operation timed out. " & timeProblem.Message)
wcfClient.Abort()
Console.Read()
Catch commProblem As CommunicationException
Console.WriteLine("There was a communication problem. " & commProblem.Message)
wcfClient.Abort()
Console.Read()
End Try
End Sub
End Class
Commenti
Utilizzare l'attributo ServiceContractAttribute su un'interfaccia (o su una classe) per definire un contratto di servizio. Utilizzare quindi l'attributo OperationContractAttribute in uno o più metodi della classe (o dell'interfaccia) per definire le operazioni di servizio del contratto. Quando il contratto di servizio viene implementato e combinato con un binding e un EndpointAddress oggetto, il contratto di servizio viene esposto per l'uso da parte dei client. Per una panoramica del processo usando esempi semplici, vedere esercitazione Introduzione. Per altre informazioni sulla creazione di contratti di servizio, vedere Progettazione e implementazione dei servizi.
Le informazioni espresse da un attributo ServiceContractAttribute e dalla relativa interfaccia presentano una correlazione ridotta con l'elemento <portType> del linguaggio WSDL (Web Services Description Language). Un contratto di servizio viene usato sul lato servizio per specificare l'endpoint del servizio esposto ai chiamanti. I contratti di servizio vengono inoltre utilizzati sul lato client per specificare il contratto dell'endpoint con cui il client comunica e, se tale contratto è duplex, per specificare (mediante la proprietà CallbackContract) il contratto di callback che il client deve implementare per poter partecipare a una conversazione duplex.
Nota
Un'interfaccia o una classe decorata con l'attributo ServiceContractAttribute deve inoltre presentare almeno un metodo contrassegnato con l'attributo OperationContractAttribute per esporre le proprie funzionalità. Nella sezione degli esempi è disponibile un esempio di codice che descrive una procedura semplicissima per definire e implementare un servizio tramite questi due attributi.
Utilizzare le proprietà dell'attributo ServiceContractAttribute per modificare il contratto di servizio.
La proprietà ConfigurationName specifica il nome dell'elemento di servizio da utilizzare fra quelli contenuti nel file di configurazione.
Le proprietà Name e Namespace controllano il nome e lo spazio dei nomi del contratto nell'elemento
<portType>del linguaggio WSDL.La proprietà SessionMode specifica se il contratto richiede un'associazione che supporta le sessioni.
La proprietà CallbackContract specifica il contratto di callback in una conversazione bidirezionale (duplex).
Le proprietà HasProtectionLevel e ProtectionLevel indicano se la proprietà ProtectionLevel è stata definita in modo esplicito per tutti i messaggi che supportano il contratto e, in tal caso, il valore impostato per questa proprietà.
I servizi implementano i contratti di servizio, che rappresentano lo scambio di dati supportato da un tipo di servizio. Una classe di servizio può implementare un contratto di servizio mediante l'implementazione di un'interfaccia contrassegnata con l'attributo ServiceContractAttribute e che presenta metodi contrassegnati con l'attributo OperationContractAttribute. In alternativa, una classe di servizio può essere contrassegnata con l'attributo ServiceContractAttribute e applicare l'attributo OperationContractAttribute ai propri metodi. Se una classe implementa un'interfaccia contrassegnata con ServiceContractAttribute, non può essere contrassegnata con ServiceContractAttribute.) I metodi sui tipi di servizio contrassegnati con l'oggetto OperationContractAttribute vengono considerati come parte di un contratto di servizio predefinito specificato dal tipo di servizio stesso. Per informazioni dettagliate sulle operazioni di servizio, vedere OperationContractAttribute.
Per impostazione predefinita, le proprietà Name e Namespace corrispondono rispettivamente al nome del tipo di contratto e allo spazio dei nomi http://tempuri.org e la proprietà ProtectionLevel è impostata su ProtectionLevel.None. È consigliabile utilizzare queste proprietà per impostare in modo esplicito i nomi, gli spazi dei nomi e i livelli di protezione dei contratti di servizio. Ciò consente di raggiungere due obiettivi. Il primo è che il contratto compilato con queste proprietà non è connesso direttamente alle informazioni sui tipi gestiti, il che consente di eseguire il refactoring del codice e degli spazi dei nomi gestiti senza violare il contratto secondo quanto espresso in WSDL. Il secondo è che la richiesta esplicita di un certo livello di protezione all'interno del contratto stesso consente di verificare in fase di esecuzione se la configurazione dell'associazione supporta tale livello di sicurezza. Ciò consente di evitare la divulgazione di informazioni riservate a causa di una configurazione inappropriata. Per altre informazioni sui livelli di protezione, vedere Informazioni sul livello di protezione.
Per esporre un servizio da usare dalle applicazioni client, creare un'applicazione host per registrare l'endpoint del servizio con Windows Communication Foundation (WCF). È possibile ospitare i servizi WCF usando Windows Activation Services (WAS), nelle applicazioni console, nelle applicazioni del servizio Windows, nelle applicazioni ASP.NET, nelle applicazioni Windows Forms o in qualsiasi altro tipo di dominio applicazione.
L'hosting in WAS è molto simile alla creazione di un'applicazione ASP.NET. Per informazioni dettagliate, vedere Procedura: ospitare un servizio WCF in IIS.
I client utilizzano l'interfaccia del contratto di servizio (ovvero l'interfaccia contrassegnata con l'attributo ServiceContractAttribute) per creare un canale connesso al servizio oppure utilizzano gli oggetti client (che combinano le informazioni sui tipi dell'interfaccia del contratto di servizio con la classe ClientBase<TChannel> ) per comunicare con il servizio. Per informazioni dettagliate sui canali client ai servizi, vedere Panoramica della classe e del ChannelFactory<TChannel> client WCF.
L'utilizzo di una classe o di un'interfaccia ServiceContractAttribute per ereditare da un'altra classe o interfaccia ServiceContractAttribute consente di estendere il contratto padre. Ad esempio, se un'interfaccia IChildContract è contrassegnata con l'attributo ServiceContractAttribute e ha ereditato da un'altra interfaccia di contratto di servizio, ad esempio IParentContract, il contratto di servizio IChildContract contiene sia i metodi dell'interfaccia IParentContract sia i metodi di dell'interfaccia IChildContract. L'estensione dei contratti (sia di classi sia di interfacce) è molto simile all'estensione di classi e interfacce gestite.
L'approccio più flessibile alla creazione dei servizi è definire anzitutto l'interfaccia del contratto di servizio e quindi fare in modo che la classe di servizio implementi tale interfaccia. Questo è anche il modo più semplice per compilare i servizi se è necessario implementare contratti di servizio definiti da altri utenti. La creazione di servizi direttamente contrassegnando una classe con ServiceContractAttribute e i relativi metodi OperationContractAttribute con funziona quando il servizio espone un solo contratto (ma tale contratto può essere esposto da più di un endpoint).
Utilizzare la CallbackContract proprietà per indicare un altro contratto di servizio che, se associato con il contratto di servizio originale, definire uno scambio di messaggi che può scorrere in due modi in modo indipendente. Per informazioni dettagliate, vedere CallbackContract.
Costruttori
| ServiceContractAttribute() |
Inizializza una nuova istanza della classe ServiceContractAttribute. |
Proprietà
| CallbackContract |
Ottiene o imposta il tipo di contratto di callback quando il contratto è duplex. |
| ConfigurationName |
Consente di ottenere o impostare il nome usato per individuare il servizio in un file di configurazione dell'applicazione. |
| HasProtectionLevel |
Ottiene un valore che indica se al membro è stato assegnato un livello di protezione. |
| Name |
Consente di ottenere o impostare il nome dell'elemento |
| Namespace |
Consente di ottenere o impostare lo spazio dei nomi dell'elemento |
| ProtectionLevel |
Specifica se l'associazione del contratto deve supportare il valore della proprietà ProtectionLevel. |
| SessionMode |
Consente di ottenere o impostare un valore che stabilisce se le sessioni sono consentite, non consentite oppure obbligatorie. |
| TypeId |
Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute) |
Metodi
| Equals(Object) |
Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute) |
| GetHashCode() |
Restituisce il codice hash per l'istanza. (Ereditato da Attribute) |
| GetType() |
Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object) |
| IsDefaultAttribute() |
In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute) |
| Match(Object) |
Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute) |
| MemberwiseClone() |
Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object) |
| ToString() |
Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object) |
Implementazioni dell'interfaccia esplicita
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch. (Ereditato da Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Recupera le informazioni sul tipo relative a un oggetto, che possono essere usate per ottenere informazioni sul tipo relative a un'interfaccia. (Ereditato da Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Recupera il numero delle interfacce di informazioni sul tipo fornite da un oggetto (0 o 1). (Ereditato da Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Fornisce l'accesso a proprietà e metodi esposti da un oggetto. (Ereditato da Attribute) |