Comunicação remota do serviço em C# com Reliable Services

Artigo
03/25/2023

Para serviços que não estão vinculados a um protocolo de comunicação específico ou pilha, como API Web, Windows Communication Foundation ou outros, a estrutura do Reliable Services fornece um mecanismo de comunicação remota para configurar a chamada de procedimento remoto para serviços de forma rápida e fácil. Este artigo descreve como configurar chamadas de procedimento remoto para serviços criados com C#.

Configurar a comunicação remota em um serviço

Você pode configurar a comunicação remota para um serviço em duas etapas simples:

Crie uma interface para implementar o serviço. Essa interface define os métodos disponíveis para uma chamada de procedimento remoto no seu serviço. Os métodos devem ser métodos assíncronos que retornam tarefas. A interface deve implementar Microsoft.ServiceFabric.Services.Remoting.IService para sinalizar que o serviço tem uma interface de comunicação remota.
Use um ouvinte de comunicação remota em seu serviço. RemotingListener é uma implementação ICommunicationListener que fornece funcionalidades de comunicação remota. O namespace Microsoft.ServiceFabric.Services.Remoting.Runtime contém um método de extensão CreateServiceRemotingInstanceListeners para serviços com e sem estado que pode ser usado para criar um ouvinte de comunicação remota usando o protocolo de transporte remoto padrão.

Observação

O Remoting namespace está disponível como um pacote NuGet separado chamado Microsoft.ServiceFabric.Services.Remoting.

Por exemplo, o serviço sem estado a seguir expõe um único método para obter "Hello World" pela chamada de procedimento remoto.

using Microsoft.ServiceFabric.Services.Communication.Runtime;
using Microsoft.ServiceFabric.Services.Remoting;
using Microsoft.ServiceFabric.Services.Remoting.Runtime;
using Microsoft.ServiceFabric.Services.Runtime;

public interface IMyService : IService
{
    Task<string> HelloWorldAsync();
}

class MyService : StatelessService, IMyService
{
    public MyService(StatelessServiceContext context)
        : base (context)
    {
    }

    public Task<string> HelloWorldAsync()
    {
        return Task.FromResult("Hello!");
    }

    protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
    {
     return this.CreateServiceRemotingInstanceListeners();
    }
}

Observação

Os argumentos e os tipos de retorno na interface de serviço podem ser tipos simples, complexos ou personalizados, mas devem poder ser serializados pelo DataContractSerializer do .NET.

Chamar métodos de serviços remotos

Observação

Se você usar mais de uma partição, o ServiceProxy.Create() deverá receber o ServicePartitionKey apropriado. Isso não é necessário em um cenário de partição única.

A chamada de métodos em um serviço usando a pilha de comunicação remota é feita usando um proxy local para o serviço por meio da classe Microsoft.ServiceFabric.Services.Remoting.Client.ServiceProxy . O método ServiceProxy cria um proxy local usando a mesma interface que o serviço implementa. Com esse proxy, você pode chamar métodos na interface remotamente.


IMyService helloWorldClient = ServiceProxy.Create<IMyService>(new Uri("fabric:/MyApplication/MyHelloWorldService"));

string message = await helloWorldClient.HelloWorldAsync();

A estrutura remota propaga exceções geradas pelo serviço para o cliente. Como resultado, ao usar ServiceProxy, o cliente é responsável pelo tratamento das exceções geradas pelo serviço.

Tempo de vida do proxy do serviço

Criar o proxy do serviço é uma operação simples, de modo que os usuários podem criar tantos quantos forem necessários. As instâncias do proxy do serviço poderão ser reutilizadas enquanto os usuários precisarem. Se uma chamada de procedimento remoto gerar uma exceção, você ainda poderá reutilizar a mesma instância do proxy. Cada proxy de serviço contém um cliente de comunicação usado para enviar mensagens durante a transmissão. Ao chamar as chamadas remotas, internamente verifica para ver se o cliente de comunicação é válido. Com base nos resultados das verificações, o cliente de comunicação será recriado se necessário. Portanto, se ocorrer uma exceção, você não precisará recriar ServiceProxy.

Tempo de vida do alocador de proxy do serviço

ServiceProxyFactory é um alocador que cria instâncias de proxy para interfaces remotas diferentes. Se você usar a API ServiceProxyFactory.CreateServiceProxy para criar um proxy, a estrutura criará um proxy do serviço de singleton. É útil para criá-lo manualmente quando você precisa substituir propriedades IServiceRemotingClientFactory. A criação do alocador é uma operação cara. Um alocador de proxy do serviço mantém um cache interno do cliente de comunicação. Uma prática recomendada é armazenar em cache a fábrica de proxy de serviço pelo maior tempo possível.

Tratamento de exceções remotas

Todas as exceções remotas geradas pela API de serviço são reenviadas ao cliente como AggregateException. Exceções remotas devem ser poder ser serializadas por DataContract. Se não puderem, a API do proxy gerará ServiceException com o erro de serialização.

O proxy de serviço trata todas as exceções de failover para a partição de serviço para a qual ele foi criado. Ele resolverá novamente os pontos de extremidade em casos de exceções de failover (exceções não transitórias) e repetirá a chamada com o ponto de extremidade correto. O número de tentativas da exceção de failover é indefinido. Se exceções transitórias ocorrerem, o proxy tentará novamente a chamada.

Os parâmetros de nova tentativa padrão são fornecidos por OperationRetrySettings.

Um usuário pode configurar esses valores passando o objeto OperationRetrySettings para o construtor ServiceProxyFactory.

Usar a pilha de comunicação remota V2

Da versão 2.8 do pacote de comunicação remota do NuGet em diante, você tem a opção de usar a pilha de comunicação remota V2. A pilha de comunicação remota V2 tem um melhor desempenho. Ela também fornece recursos como serialização personalizada e mais APIs conectáveis. O código de modelo continua a usar a pilha de comunicação remota V1. A comunicação remota V2 não é compatível com a V1 (a pilha de comunicação remota anterior). Siga as instruções no artigo Atualizar da V1 para a V2 para evitar efeitos sobre a disponibilidade do serviço.

As abordagens a seguir estão disponíveis para habilitar a pilha V2.

Usar um atributo de assembly para usar a pilha V2

Estas etapas alteram o modelo de código para usar a pilha V2 usando um atributo de assembly.

Altere o recurso do ponto de extremidade "ServiceEndpoint" para "ServiceEndpointV2" no manifesto de serviço.
```
<Resources>
 <Endpoints>
   <Endpoint Name="ServiceEndpointV2" />
 </Endpoints>
</Resources>
```
Use o método Microsoft.ServiceFabric.Services.Remoting.Runtime.CreateServiceRemotingInstanceListeners de extensão para criar os ouvintes remotos (igual para V1 e V2).
```
 protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
 {
     return this.CreateServiceRemotingInstanceListeners();
 }
```

Marque o assembly que contém as interfaces de comunicação remota com um atributo FabricTransportServiceRemotingProvider.

[assembly: FabricTransportServiceRemotingProvider(RemotingListenerVersion = RemotingListenerVersion.V2, RemotingClientVersion = RemotingClientVersion.V2)]

Nenhuma alteração de código é necessária no projeto do cliente. Compile o assembly de cliente com o assembly de interface para garantir que o atributo do assembly mostrado anteriormente seja usado.

Usar as classes V2 explícitas para usar a pilha V2

Como alternativa a usar um atributo de assembly, a pilha V2 também pode ser habilitada usando as classes V2 explícitas.

Estas etapas alteram o modelo de código para usar a pilha V2 usando classes V2 explícitas.

Altere o recurso do ponto de extremidade "ServiceEndpoint" para "ServiceEndpointV2" no manifesto de serviço.
```
<Resources>
 <Endpoints>
   <Endpoint Name="ServiceEndpointV2" />
 </Endpoints>
</Resources>
```

Use o FabricTransportServiceRemotingListener do namespace Microsoft.ServiceFabric.Services.Remoting.V2.FabricTransport.Runtime.

protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
 {
     return new[]
     {
         new ServiceInstanceListener((c) =>
         {
             return new FabricTransportServiceRemotingListener(c, this);

         })
     };
 }

Use o FabricTransportServiceRemotingClientFactory do namespace Microsoft.ServiceFabric.Services.Remoting.V2.FabricTransport.Client para criar clientes.
```
var proxyFactory = new ServiceProxyFactory((c) =>
       {
           return new FabricTransportServiceRemotingClientFactory();
       });
```

Atualizar da comunica remota V1 para a comunicação remota V2

Para atualizar da V1 para a V2, atualizações em duas etapas são necessárias. Siga as etapas deste tutorial.

Atualize o serviço V1 para o serviço V2 usando este atributo. Essa alteração garante que o serviço escute nos ouvintes V1 e V2.

a. Adicione um recurso de ponto de extremidade com o nome "ServiceEndpointV2" no manifesto do serviço.
```
<Resources>
  <Endpoints>
    <Endpoint Name="ServiceEndpointV2" />  
  </Endpoints>
</Resources>
```
b. Use o método de extensão a seguir para criar um ouvinte de comunicação remota.
```
protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
{
    return this.CreateServiceRemotingInstanceListeners();
}
```
c. Adicione o atributo de assembly em interfaces de comunicação remota para usar os ouvintes V1 e V2 e o cliente V2.
```
[assembly: FabricTransportServiceRemotingProvider(RemotingListenerVersion = RemotingListenerVersion.V2|RemotingListenerVersion.V1, RemotingClientVersion = RemotingClientVersion.V2)]
```
Atualize o cliente V1 para um cliente V2 usando o atributo do cliente V2. Essa etapa garante que o cliente use a pilha V2. Nenhuma alteração no projeto/serviço do cliente é necessária. Compilar projetos de cliente com assembly de interface atualizada é suficiente.

Esta etapa é opcional. Use o atributo V2 e, em seguida, atualize o serviço V2. Esta etapa garante que o serviço esteja escutando somente no ouvinte V2.

[assembly: FabricTransportServiceRemotingProvider(RemotingListenerVersion = RemotingListenerVersion.V2, RemotingClientVersion = RemotingClientVersion.V2)]

Use a pilha de comunicação remota V2 (compatível com a interface)

A pilha de comunicação remota V2 (compatível com a interface) é conhecida como V2_1 e é a versão mais atualizada. Ela conta com todos os recursos da pilha de comunicação remota V2. Sua pilha de interface é compatível com a pilha de comunicação remota V1, mas não é compatível com versões anteriores da V1 e da V2. Para atualizar da V1 para a V2_1 sem afetar a disponibilidade do serviço, siga as etapas no artigo Atualizar da V1 para a V2 (compatível com interface).

Use um atributo de assembly para usar a pilha de comunicação remota V2 (compatível com interface)

Siga estas etapas para alterar para uma pilha V2_1.

Adicione um recurso de ponto de extremidade com o nome "ServiceEndpointV2_1" no manifesto do serviço.
```
<Resources>
 <Endpoints>
   <Endpoint Name="ServiceEndpointV2_1" />  
 </Endpoints>
</Resources>
```

Use o método de extensão de comunicação remota para criar um ouvinte de comunicação remota.

 protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
 {
     return this.CreateServiceRemotingInstanceListeners();
 }

Adicione um atributo de assembly nas interfaces de comunicação remota.

 [assembly:  FabricTransportServiceRemotingProvider(RemotingListenerVersion=  RemotingListenerVersion.V2_1, RemotingClientVersion= RemotingClientVersion.V2_1)]

Nenhuma alteração é necessária no projeto do cliente. Compile o assembly de cliente com o assembly de interface para garantir que o atributo do assembly anterior esteja sendo usado.

Use classes de comunicação remota explícitas para criar uma fábrica de ouvinte/cliente para a versão V2 (compatível com interface)

Siga estas etapas:

Adicione um recurso de ponto de extremidade com o nome "ServiceEndpointV2_1" no manifesto do serviço.
```
<Resources>
 <Endpoints>
   <Endpoint Name="ServiceEndpointV2_1" />  
 </Endpoints>
</Resources>
```

Use o ouvinte de comunicação remota V2. O nome do Recurso de Ponto de Extremidade de Serviço padrão utilizado é "ServiceEndpointV2_1" e deve ser definido no Manifesto do Serviço.

protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
 {
     return new[]
     {
         new ServiceInstanceListener((c) =>
         {
             var settings = new FabricTransportRemotingListenerSettings();
             settings.UseWrappedMessage = true;
             return new FabricTransportServiceRemotingListener(c, this,settings);

         })
     };
 }

Use o alocador de cliente V2.

var proxyFactory = new ServiceProxyFactory((c) =>
       {
         var settings = new FabricTransportRemotingSettings();
         settings.UseWrappedMessage = true;
         return new FabricTransportServiceRemotingClientFactory(settings);
       });

Atualizar da comunicação remota V1 para a comunicação remota V2 (compatível com interface)

Para atualizar da V1 para a V2 (compatível com interface, conhecida como V2_1), são necessárias atualizações de duas etapas. Siga as etapas deste tutorial.

Observação

Ao atualizar da V1 para a V2, verifique se o namespace Remoting está atualizado para usar a V2. Exemplo: Microsoft.ServiceFabric.Services.Remoting.V2.FabricTransport.Client

Atualize do serviço V1 para o serviço V2_1 usando o atributo a seguir. Essa alteração garante que o serviço esteja escutando nos ouvintes V1 e V2_1.

a. Adicione um recurso de ponto de extremidade com o nome "ServiceEndpointV2_1" no manifesto do serviço.
```
<Resources>
  <Endpoints>
    <Endpoint Name="ServiceEndpointV2_1" />  
  </Endpoints>
</Resources>
```
b. Use o método de extensão a seguir para criar um ouvinte de comunicação remota.
```
protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
{
    return this.CreateServiceRemotingInstanceListeners();
}
```
c. Adicione o atributo de assembly em interfaces de comunicação remota para usar os ouvintes V1, V2_1 e o cliente V2_1.
```
[assembly: FabricTransportServiceRemotingProvider(RemotingListenerVersion = RemotingListenerVersion.V2_1 | RemotingListenerVersion.V1, RemotingClientVersion = RemotingClientVersion.V2_1)]
```
Atualize o cliente V1 para o cliente V2_1 usando o atributo do cliente V2_1. Esta etapa garante que o cliente esteja usando a pilha V2_1. Nenhuma alteração no projeto/serviço do cliente é necessária. Compilar projetos de cliente com assembly de interface atualizada é suficiente.
Esta etapa é opcional. Remova a versão do ouvinte V1 do atributo e, em seguida, atualize o serviço V2. Esta etapa garante que o serviço esteja escutando somente no ouvinte V2.
```
[assembly: FabricTransportServiceRemotingProvider(RemotingListenerVersion = RemotingListenerVersion.V2_1, RemotingClientVersion = RemotingClientVersion.V2_1)]
```

Usar a serialização personalizada com mensagem encapsulada de comunicação remota

Para uma mensagem encapsulada de comunicação remota, criamos um único objeto encapsulado com todos os parâmetros como um campo. Siga estas etapas:

Implemente a interface IServiceRemotingMessageSerializationProvider para fornecer a implementação para serialização personalizada. Esse snippet de código mostra a aparência da implementação.

public class ServiceRemotingJsonSerializationProvider : IServiceRemotingMessageSerializationProvider
{
  public IServiceRemotingMessageBodyFactory CreateMessageBodyFactory()
  {
    return new JsonMessageFactory();
  }

  public IServiceRemotingRequestMessageBodySerializer CreateRequestMessageSerializer(Type serviceInterfaceType, IEnumerable<Type> requestWrappedType, IEnumerable<Type> requestBodyTypes = null)
  {
    return new ServiceRemotingRequestJsonMessageBodySerializer();
  }

  public IServiceRemotingResponseMessageBodySerializer CreateResponseMessageSerializer(Type serviceInterfaceType, IEnumerable<Type> responseWrappedType, IEnumerable<Type> responseBodyTypes = null)
  {
    return new ServiceRemotingResponseJsonMessageBodySerializer();
  }
}

  class JsonMessageFactory : IServiceRemotingMessageBodyFactory
      {

        public IServiceRemotingRequestMessageBody CreateRequest(string interfaceName, string methodName, int numberOfParameters, object wrappedRequestObject)
        {
          return new JsonBody(wrappedRequestObject);
        }

        public IServiceRemotingResponseMessageBody CreateResponse(string interfaceName, string methodName, object wrappedRequestObject)
        {
          return new JsonBody(wrappedRequestObject);
        }
      }

class ServiceRemotingRequestJsonMessageBodySerializer : IServiceRemotingRequestMessageBodySerializer
  {
      private JsonSerializer serializer;

      public ServiceRemotingRequestJsonMessageBodySerializer()
      {
        serializer = JsonSerializer.Create(new JsonSerializerSettings()
        {
          TypeNameHandling = TypeNameHandling.All
          });
        }

        public IOutgoingMessageBody Serialize(IServiceRemotingRequestMessageBody serviceRemotingRequestMessageBody)
       {
         if (serviceRemotingRequestMessageBody == null)
         {
           return null;
         }          
         using (var writeStream = new MemoryStream())
         {
           using (var jsonWriter = new JsonTextWriter(new StreamWriter(writeStream)))
           {
             serializer.Serialize(jsonWriter, serviceRemotingRequestMessageBody);
             jsonWriter.Flush();
             var bytes = writeStream.ToArray();
             var segment = new ArraySegment<byte>(bytes);
             var segments = new List<ArraySegment<byte>> { segment };
             return new OutgoingMessageBody(segments);
           }
         }
        }

        public IServiceRemotingRequestMessageBody Deserialize(IIncomingMessageBody messageBody)
       {
         using (var sr = new StreamReader(messageBody.GetReceivedBuffer()))
         {
           using (JsonReader reader = new JsonTextReader(sr))
           {
             var ob = serializer.Deserialize<JsonBody>(reader);
             return ob;
           }
         }
       }
      }

class ServiceRemotingResponseJsonMessageBodySerializer : IServiceRemotingResponseMessageBodySerializer
 {
   private JsonSerializer serializer;

  public ServiceRemotingResponseJsonMessageBodySerializer()
  {
    serializer = JsonSerializer.Create(new JsonSerializerSettings()
    {
        TypeNameHandling = TypeNameHandling.All
      });
    }

    public IOutgoingMessageBody Serialize(IServiceRemotingResponseMessageBody responseMessageBody)
    {
      if (responseMessageBody == null)
      {
        return null;
      }

      using (var writeStream = new MemoryStream())
      {
        using (var jsonWriter = new JsonTextWriter(new StreamWriter(writeStream)))
        {
          serializer.Serialize(jsonWriter, responseMessageBody);
          jsonWriter.Flush();
          var bytes = writeStream.ToArray();
          var segment = new ArraySegment<byte>(bytes);
          var segments = new List<ArraySegment<byte>> { segment };
          return new OutgoingMessageBody(segments);
        }
      }
    }

    public IServiceRemotingResponseMessageBody Deserialize(IIncomingMessageBody messageBody)
    {

       using (var sr = new StreamReader(messageBody.GetReceivedBuffer()))
       {
         using (var reader = new JsonTextReader(sr))
         {
           var obj = serializer.Deserialize<JsonBody>(reader);
           return obj;
         }
       }
     }
 }

class JsonBody : WrappedMessage, IServiceRemotingRequestMessageBody, IServiceRemotingResponseMessageBody
{
      public JsonBody(object wrapped)
      {
        this.Value = wrapped;
      }

      public void SetParameter(int position, string parameName, object parameter)
      {  //Not Needed if you are using WrappedMessage
        throw new NotImplementedException();
      }

      public object GetParameter(int position, string parameName, Type paramType)
      {
        //Not Needed if you are using WrappedMessage
        throw new NotImplementedException();
      }

      public void Set(object response)
      { //Not Needed if you are using WrappedMessage
        throw new NotImplementedException();
      }

      public object Get(Type paramType)
      {  //Not Needed if you are using WrappedMessage
        throw new NotImplementedException();
      }
}

Substitua o provedor de serialização padrão por JsonSerializationProvider para um ouvinte de comunicação remota.

protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
{
    return new[]
    {
        new ServiceInstanceListener((c) =>
        {
            return new FabricTransportServiceRemotingListener(context, _calculatorFactory.GetCalculator(Context), serializationProvider: new         ServiceRemotingJsonSerializationProvider());
        })
    };
}

Substitua o provedor de serialização padrão por JsonSerializationProvider para um alocador de cliente de comunicação remota.

var proxyFactory = new ServiceProxyFactory((c) =>
{
    return new FabricTransportServiceRemotingClientFactory(
    serializationProvider: new ServiceRemotingJsonSerializationProvider());
  });

Comunicação remota do serviço em C# com Reliable Services

Configurar a comunicação remota em um serviço

Chamar métodos de serviços remotos

Tempo de vida do proxy do serviço

Tempo de vida do alocador de proxy do serviço

Tratamento de exceções remotas

Usar a pilha de comunicação remota V2

Usar um atributo de assembly para usar a pilha V2

Usar as classes V2 explícitas para usar a pilha V2

Atualizar da comunica remota V1 para a comunicação remota V2

Use a pilha de comunicação remota V2 (compatível com a interface)

Use um atributo de assembly para usar a pilha de comunicação remota V2 (compatível com interface)

Use classes de comunicação remota explícitas para criar uma fábrica de ouvinte/cliente para a versão V2 (compatível com interface)

Atualizar da comunicação remota V1 para a comunicação remota V2 (compatível com interface)

Usar a serialização personalizada com mensagem encapsulada de comunicação remota

Próximas etapas

Recursos adicionais