Procedimiento Migrar código administrado DCOM a WCF
Windows Communication Foundation (WCF) es la opción recomendada y segura para reemplazar al modelo de objetos de componentes distribuidos (DCOM) en las llamadas de código administrado entre servidores y clientes en un entorno distribuido. En este artículo se muestra cómo migrar el código de DCOM a WCF en los escenarios siguientes.
El servicio remoto devuelve un objeto por valor al cliente.
El cliente envía un objeto por valor al servicio remoto.
El servicio remoto devuelve un objeto por referencia al cliente.
Por motivos de seguridad, en WCF no se permite enviar objetos por referencia desde el cliente al servicio. En WCF puede conseguir un escenario que necesite una conversación entre el cliente y el servidor con un servicio dúplex. Para más información sobre los servicios dúplex, vea Duplex Services (Servicios dúplex).
Para obtener más detalles sobre cómo crear servicios WCF y clientes para esos servicios, vea Programación basica de WFC, Diseño e implementación de servicios y Creación de clientes.
Código de ejemplo DCOM
Para estos escenarios, las interfaces DCOM que se muestran con WCF tienen la siguiente estructura:
[ComVisible(true)]
[Guid("AA9C4CDB-55EA-4413-90D2-843F1A49E6E6")]
public interface IRemoteService
{
Customer GetObjectByValue();
IRemoteObject GetObjectByReference();
void SendObjectByValue(Customer customer);
}
[ComVisible(true)]
[Guid("A12C98DE-B6A1-463D-8C24-81E4BBC4351B")]
public interface IRemoteObject
{
}
public class Customer
{
}
El servicio devuelve un objeto por valor
En este escenario, se realiza una llamada a un servicio y el método devuelve un objeto que se pasa por valor desde el servidor al cliente. Este escenario representa la siguiente llamada COM:
public interface IRemoteService
{
Customer GetObjectByValue();
}
En este escenario, el cliente recibe una copia deserializada de un objeto desde el servicio remoto. El cliente puede interactuar con esta copia local sin tener que volver a llamar al servicio. En otras palabras, se garantiza al cliente que el servicio no participará en modo alguno cuando se llame a métodos en la copia local. WCF siempre devuelve objetos desde el servicio por valor, por lo que los pasos siguientes describen la creación de un servicio WCF normal.
Paso 1: Definir la interfaz de servicio WCF
Defina una interfaz pública para el servicio WCF y márquela con el atributo [ServiceContractAttribute]. Marque los métodos que desea exponer a los clientes con el atributo [OperationContractAttribute]. En el ejemplo siguiente se muestra cómo usar estos atributos para identificar la interfaz del servidor y los métodos de interfaz a los que puede llamar un cliente. El método usado para este escenario se muestra en negrita.
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Web;
. . .
[ServiceContract]
public interface ICustomerManager
{
[OperationContract]
void StoreCustomer(Customer customer);
[OperationContract] Customer GetCustomer(string firstName, string lastName);
}
Paso 2: Definir el contrato de datos
A continuación debe crear un contrato de datos para el servicio, en el que se describirá cómo se intercambian los datos entre el servicio y sus clientes. Las clases descritas en el contrato de datos deben marcarse con el atributo [DataContractAttribute]. Las propiedades o los campos individuales que quiera que sean visibles para el cliente y el servidor deben marcarse con el atributo [DataMemberAttribute]. Si quiere que los tipos derivados de una clase estén permitidos en el contrato de datos, debe identificarlos con el atributo [KnownTypeAttribute]. WCF solo serializará o deserializará tipos en la interfaz de servicio y tipos identificados como tipos conocidos. Si intenta usar un tipo que no sea un tipo conocido, se producirá una excepción.
Para más información sobre los contratos de datos, vea Data Contracts (Contratos de datos).
[DataContract]
[KnownType(typeof(PremiumCustomer))]
public class Customer
{
[DataMember]
public string Firstname;
[DataMember]
public string Lastname;
[DataMember]
public Address DefaultDeliveryAddress;
[DataMember]
public Address DefaultBillingAddress;
}
[DataContract]
public class PremiumCustomer : Customer
{
[DataMember]
public int AccountID;
}
[DataContract]
public class Address
{
[DataMember]
public string Street;
[DataMember]
public string Zipcode;
[DataMember]
public string City;
[DataMember]
public string State;
[DataMember]
public string Country;
}
Paso 3: Implementar el servicio WCF
A continuación, debe implementar la clase de servicio WCF que implementa la interfaz que definió en el paso anterior.
public class CustomerService: ICustomerManager
{
public void StoreCustomer(Customer customer)
{
// write to a database
}
public Customer GetCustomer(string firstName, string lastName)
{
// read from a database
}
}
Paso 4: Configurar el servicio y el cliente
Para ejecutar un servicio WCF, deberá declarar un punto de conexión que exponga esa interfaz de servicio en una dirección URL específica mediante un enlace WCF específico. Un enlace especifica los detalles de transporte, codificación y protocolo para que los clientes y el servidor puedan comunicarse. Normalmente, los enlaces se agregan al archivo de configuración del proyecto de servicio (web.config). A continuación se muestra una entrada de enlace para el servicio de ejemplo:
<configuration>
<system.serviceModel>
<services>
<service name="Server.CustomerService">
<endpoint address="http://localhost:8083/CustomerManager"
binding="basicHttpBinding"
contract="Shared.ICustomerManager" />
</service>
</services>
</system.serviceModel>
</configuration>
Después, deberá configurar el cliente para que coincida con la información de enlace especificada por el servicio. Para ello, agregue lo siguiente al archivo de configuración (app.config) de la aplicación del cliente.
<configuration>
<system.serviceModel>
<client>
<endpoint name="customermanager"
address="http://localhost:8083/CustomerManager"
binding="basicHttpBinding"
contract="Shared.ICustomerManager"/>
</client>
</system.serviceModel>
</configuration>
Paso 5: Ejecutar el servicio
Por último, puede probarlo internamente en una aplicación de consola; para ello, agregue las líneas siguientes a la aplicación de servicio e inicie la aplicación. Para más información sobre otras formas de hospedar una aplicación de servicio WCF, vea Hosting Services (Servicios de hospedaje).
ServiceHost customerServiceHost = new ServiceHost(typeof(CustomerService));
customerServiceHost.Open();
Paso 6: Llamar al servicio desde el cliente
Para llamar al servicio desde el cliente, deberá crear un generador de canales para el servicio y solicitar un canal, lo que le permitirá llamar directamente al método GetCustomer desde el cliente. El canal implementa la interfaz del servicio y controla automáticamente la lógica de solicitud/respuesta subyacente. El valor devuelto de esta llamada de método es la copia deserializada de la respuesta del servicio.
ChannelFactory<ICustomerManager> factory =
new ChannelFactory<ICustomerManager>("customermanager");
ICustomerManager service = factory.CreateChannel();
Customer customer = service.GetCustomer("Mary", "Smith");
El cliente envía un objeto por valor al servidor
En este escenario, el cliente envía un objeto en el servidor por valor. Esto significa que el servidor recibirá una copia del objeto deserializada. El servidor puede llamar a métodos en esa copia con la garantía de que no habrá ninguna devolución de llamada en el código de cliente. Como se mencionó anteriormente, los intercambios normales de datos de WCF son por valor. Esto garantiza que una llamada a métodos en uno de estos objetos se ejecuta únicamente de forma local y no invoca código en el cliente.
Este escenario representa la siguiente llamada de método COM:
public interface IRemoteService
{
void SendObjectByValue(Customer customer);
}
En el escenario se usa la misma interfaz de servicio y el mismo contrato de datos que en el primer ejemplo. Además, el cliente y el servicio se configurarán de la misma manera. En este ejemplo, se crea un canal para enviar el objeto y que se ejecute de la misma manera. Sin embargo, en este ejemplo, se creará un cliente que llame al servicio pasando un objeto por valor. El método de servicio que llamará el cliente en el contrato de servicio se muestra en negrita:
[ServiceContract]
public interface ICustomerManager
{
[OperationContract] void StoreCustomer(Customer customer);
[OperationContract]
Customer GetCustomer(string firstName, string lastName);
}
Agregar código al cliente que envíe un objeto por valor
El siguiente código muestra cómo el cliente crea un nuevo objeto de cliente por valor, crea un canal para comunicarse con el servicio ICustomerManager y le envía el objeto de cliente.
El objeto de cliente se serializa y se envía al servicio, donde se deserializa en una nueva copia del objeto. Cualquier método al que llame el servicio en este objeto solo se ejecutará localmente en el servidor. Es importante que tenga en cuenta que este código ejemplifique el envío de un tipo derivado (PremiumCustomer). El contrato de servicio espera un objeto Customer, pero los datos del servicio de contrato usan el atributo [KnownTypeAttribute] para indicar que PremiumCustomer también está permitido. WCF no podrá serializar ni deserializar cualquier otro tipo a través de esta interfaz de servicio.
PremiumCustomer customer = new PremiumCustomer();
customer.Firstname = "John";
customer.Lastname = "Doe";
customer.DefaultBillingAddress = new Address();
customer.DefaultBillingAddress.Street = "One Microsoft Way";
customer.DefaultDeliveryAddress = customer.DefaultBillingAddress;
customer.AccountID = 42;
ChannelFactory<ICustomerManager> factory =
new ChannelFactory<ICustomerManager>("customermanager");
ICustomerManager customerManager = factory.CreateChannel();
customerManager.StoreCustomer(customer);
El servicio devuelve un objeto por referencia
En este escenario, la aplicación cliente realiza una llamada al servicio remoto y el método devuelve un objeto que se pasa por referencia desde el servicio al cliente.
Como se mencionó anteriormente, los servicios WCF siempre devuelven objetos por valor. Sin embargo, se puede conseguir un resultado similar usando la clase EndpointAddress10. EndpointAddress10 es un objeto serializable por valor que el cliente puede usar para obtener un objeto por referencia con sesión en el servidor.
El comportamiento del objeto por referencia de WCF que se muestra en este escenario es diferente al de DCOM. En DCOM, el servidor puede devolver directamente un objeto por referencia al cliente y el cliente puede llamar a métodos del objeto, que se ejecutan en el servidor. En WCF, sin embargo, el objeto devuelto es siempre por valor. El cliente debe tomar ese objeto por valor, representado por EndpointAddress10, y usarlo para crear su propio objeto por referencia con sesión. Las llamadas de método de cliente en el objeto con sesión se ejecutan en el servidor. En otras palabras, este objeto por referencia en WCF es un servicio WCF normal que se configura para ser con sesión.
En WCF, una sesión es una manera de asociar varios mensajes enviados entre dos puntos de conexión. Esto significa que cuando un cliente obtiene una conexión a este servicio, se establecerá una sesión entre el cliente y el servidor. El cliente usará una única instancia del objeto del lado servidor para todas las interacciones dentro de esta sesión única. Los contratos de WCF con sesión son similares a los patrones de solicitud/respuesta de red orientados a conexiones.
Este escenario se representa mediante el siguiente método DCOM.
public interface IRemoteService
{
IRemoteObject GetObjectByReference();
}
Paso 1: Definir la interfaz de servicio de WCF con sesión y la implementación
En primer lugar, defina una interfaz de servicio WCF que contenga el objeto con sesión.
En este código, el objeto con sesión se marca con el atributo ServiceContract, que lo identifica como una interfaz de servicio WCF normal. Además, se establece la propiedad SessionMode para indicar que será un servicio con sesión.
[ServiceContract(SessionMode = SessionMode.Allowed)]
public interface ISessionBoundObject
{
[OperationContract]
string GetCurrentValue();
[OperationContract]
void SetCurrentValue(string value);
}
En el siguiente código se muestra la implementación del servicio.
El servicio se marca con el atributo [ServiceBehavior] y su propiedad InstanceContextMode se establece en InstanceContextMode.PerSessions para indicar que debe crearse una instancia única de este tipo para cada sesión.
[ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession)]
public class MySessionBoundObject : ISessionBoundObject
{
private string _value;
public string GetCurrentValue()
{
return _value;
}
public void SetCurrentValue(string val)
{
_value = val;
}
}
Paso 2: Definir el servicio del generador WCF para el objeto con sesión
El servicio que crea el objeto con sesión debe definirse e implementarse. El código siguiente muestra cómo hacerlo. Este código crea otro servicio WCF que devuelve un objeto EndpointAddress10. Se trata de una forma serializable de un punto de conexión que puede usarse para crear el objeto con sesión.
[ServiceContract]
public interface ISessionBoundFactory
{
[OperationContract]
EndpointAddress10 GetInstanceAddress();
}
En el siguiente ejemplo se muestra la implementación de esta función. Esta implementación mantiene un generador de canales de singleton para crear objetos con sesión. Cuando se llama a GetInstanceAddress, este crea un canal y crea un objeto EndpointAddress10 que apunta a la dirección remota asociada a este canal. EndpointAddress10 es un tipo de datos que se puede devolver al cliente por valor.
public class SessionBoundFactory : ISessionBoundFactory
{
public static ChannelFactory<ISessionBoundObject> _factory =
new ChannelFactory<ISessionBoundObject>("sessionbound");
public SessionBoundFactory()
{
}
public EndpointAddress10 GetInstanceAddress()
{
IClientChannel channel = (IClientChannel)_factory.CreateChannel();
return EndpointAddress10.FromEndpointAddress(channel.RemoteAddress);
}
}
Paso 3: Configurar e iniciar los servicios WCF
Para hospedar estos servicios, deberá agregar lo siguiente al archivo de configuración del servidor (web.config).
Agregue una sección
<client>que describa el extremo para el objeto con sesión. En este escenario, el servidor también actúa como un cliente y debe configurarse para habilitar esta opción.En la sección
<services>, declare los extremos de servicio para el generador y el objeto con sesión. Esto permite al cliente comunicarse con los puntos de conexión de servicio, adquirir el EndpointAddress10 y crear el canal con sesión.
En el siguiente ejemplo se muestra un archivo de configuración con estas opciones:
<configuration>
<system.serviceModel>
<client>
<endpoint name="sessionbound"
address="net.tcp://localhost:8081/SessionBoundObject"
binding="netTcpBinding"
contract="Shared.ISessionBoundObject"/>
</client>
<services>
<service name="Server.MySessionBoundObject">
<endpoint address="net.tcp://localhost:8081/SessionBoundObject"
binding="netTcpBinding"
contract="Shared.ISessionBoundObject" />
</service>
<service name="Server.SessionBoundFactory">
<endpoint address="net.tcp://localhost:8081/SessionBoundFactory"
binding="netTcpBinding"
contract="Shared.ISessionBoundFactory" />
</service>
</services>
</system.serviceModel>
</configuration>
Agregue las siguientes líneas a una aplicación de consola para hospedar el servicio e inicie la aplicación.
ServiceHost factoryHost = new ServiceHost(typeof(SessionBoundFactory));
factoryHost.Open();
ServiceHost sessionBoundServiceHost = new ServiceHost(
typeof(MySessionBoundObject));
sessionBoundServiceHost.Open();
Paso 4: Configurar el cliente y llamar al servicio
Configure el cliente para comunicarse con los servicios WCF; para ello, realice las siguientes entradas en el archivo de configuración de aplicación del proyecto (app.config).
<configuration>
<system.serviceModel>
<client>
<endpoint name="sessionbound"
address="net.tcp://localhost:8081/SessionBoundObject"
binding="netTcpBinding"
contract="Shared.ISessionBoundObject"/>
<endpoint name="factory"
address="net.tcp://localhost:8081/SessionBoundFactory"
binding="netTcpBinding"
contract="Shared.ISessionBoundFactory"/>
</client>
</system.serviceModel>
</configuration>
Para llamar al servicio, agregue el código al cliente para hacer lo siguiente:
Cree un canal para el servicio
ISessionBoundFactory.Use el canal para invocar el servicio
ISessionBoundFactoryy obtener un objeto EndpointAddress10.Use EndpointAddress10 para crear un canal para obtener un objeto con sesión.
Llame a los métodos
SetCurrentValueyGetCurrentValuepara mostrar que sigue siendo la misma instancia de objeto que se usa en varias llamadas.
ChannelFactory<ISessionBoundFactory> factory =
new ChannelFactory<ISessionBoundFactory>("factory");
ISessionBoundFactory sessionBoundFactory = factory.CreateChannel();
EndpointAddress10 address = sessionBoundFactory.GetInstanceAddress();
ChannelFactory<ISessionBoundObject> sessionBoundObjectFactory =
new ChannelFactory<ISessionBoundObject>(
new NetTcpBinding(),
address.ToEndpointAddress());
ISessionBoundObject sessionBoundObject =
sessionBoundObjectFactory.CreateChannel();
sessionBoundObject.SetCurrentValue("Hello");
if (sessionBoundObject.GetCurrentValue() == "Hello")
{
Console.WriteLine("Session-full instance management works as expected");
}
