ASP.NET Core SignalR cliente JavaScriptASP.NET Core SignalR JavaScript client

Por Rachel AppelBy Rachel Appel

O ASP.NET Core SignalR biblioteca de cliente JavaScript permite que os desenvolvedores chamem o código de Hub do lado do servidor.The ASP.NET Core SignalR JavaScript client library enables developers to call server-side hub code.

Exibir ou baixar código de exemplo (como baixar)View or download sample code (how to download)

Instalar o pacote do cliente do SignalRInstall the SignalR client package

A biblioteca de cliente SignalR JavaScript é entregue como um pacote NPM .The SignalR JavaScript client library is delivered as an npm package. Se você estiver usando o Visual Studio, execute npm install no console do Gerenciador de pacotes enquanto estiver na pasta raiz.If you're using Visual Studio, run npm install from the Package Manager Console while in the root folder. Para Visual Studio Code, execute o comando do terminal integrado.For Visual Studio Code, run the command from the Integrated Terminal.

npm init -y
npm install @microsoft/signalr

o NPM instala o conteúdo do pacote na pasta node_modules\@microsoft\signalr\dist\browser .npm installs the package contents in the node_modules\@microsoft\signalr\dist\browser folder. Crie uma nova pasta chamada signalr na pasta wwwroot\lib .Create a new folder named signalr under the wwwroot\lib folder. Copie o arquivo signalr. js para a pasta wwwroot\lib\signalr .Copy the signalr.js file to the wwwroot\lib\signalr folder.

npm init -y
npm install @aspnet/signalr

o NPM instala o conteúdo do pacote na pasta node_modules\@aspnet\signalr\dist\browser .npm installs the package contents in the node_modules\@aspnet\signalr\dist\browser folder. Crie uma nova pasta chamada signalr na pasta wwwroot\lib .Create a new folder named signalr under the wwwroot\lib folder. Copie o arquivo signalr. js para a pasta wwwroot\lib\signalr .Copy the signalr.js file to the wwwroot\lib\signalr folder.

Usar o SignalR cliente JavaScriptUse the SignalR JavaScript client

Referencie o SignalR cliente JavaScript no elemento <script>.Reference the SignalR JavaScript client in the <script> element.

<script src="~/lib/signalr/signalr.js"></script>

Conectar-se a um hubConnect to a hub

O código a seguir cria e inicia uma conexão.The following code creates and starts a connection. O nome do Hub não diferencia maiúsculas de minúsculas.The hub's name is case insensitive.

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chatHub")
    .configureLogging(signalR.LogLevel.Information)
    .build();

connection.start().then(function () {
    console.log("connected");
});

Conexões entre origensCross-origin connections

Normalmente, os navegadores carregam conexões do mesmo domínio que a página solicitada.Typically, browsers load connections from the same domain as the requested page. No entanto, há ocasiões em que uma conexão com outro domínio é necessária.However, there are occasions when a connection to another domain is required.

Para impedir que um site mal-intencionado leia dados confidenciais de outro site, as conexões entre origens são desabilitadas por padrão.To prevent a malicious site from reading sensitive data from another site, cross-origin connections are disabled by default. Para permitir uma solicitação entre origens, habilite-a na classe Startup.To allow a cross-origin request, enable it in the Startup class.

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using SignalRChat.Hubs;

namespace SignalRChat
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            services.Configure<CookiePolicyOptions>(options =>
            {
                options.CheckConsentNeeded = context => true;
                options.MinimumSameSitePolicy = SameSiteMode.None;
            });

            services.AddMvc();

            services.AddCors(options => options.AddPolicy("CorsPolicy", 
            builder => 
            {
                builder.AllowAnyMethod().AllowAnyHeader()
                       .WithOrigins("http://localhost:55830")
                       .AllowCredentials();
            }));

            services.AddSignalR();
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseBrowserLink();
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseExceptionHandler("/Error");
                app.UseHsts();
            }

            app.UseHttpsRedirection();
            app.UseStaticFiles();
            app.UseCookiePolicy();
            app.UseCors("CorsPolicy");
            app.UseSignalR(routes => 
            {
                routes.MapHub<ChatHub>("/chathub");
            });
            app.UseMvc();            
        }
    }
}

Métodos do hub de chamadas do clienteCall hub methods from client

Os clientes JavaScript chamam métodos públicos em hubs por meio do método Invoke de HubConnection.JavaScript clients call public methods on hubs via the invoke method of the HubConnection. O método invoke aceita dois argumentos:The invoke method accepts two arguments:

  • O nome do método de Hub.The name of the hub method. No exemplo a seguir, o nome do método no Hub é SendMessage.In the following example, the method name on the hub is SendMessage.

  • Quaisquer argumentos definidos no método Hub.Any arguments defined in the hub method. No exemplo a seguir, o nome do argumento é message.In the following example, the argument name is message. O código de exemplo usa a sintaxe de função de seta que tem suporte nas versões atuais de todos os principais navegadores, exceto o Internet Explorer.The example code uses arrow function syntax that is supported in current versions of all major browsers except Internet Explorer.

    connection.invoke("SendMessage", user, message).catch(err => console.error(err.toString()));
    

Observação

Se você estiver usando o serviço de SignalR do Azure no modo sem servidor, não será possível chamar os métodos de Hub de um cliente.If you're using Azure SignalR Service in Serverless mode, you cannot call hub methods from a client. Para obter mais informações, consulte a documentação do serviço deSignalR.For more information, see the SignalR Service documentation.

O método invoke retorna uma promessade JavaScript.The invoke method returns a JavaScript Promise. O Promise é resolvido com o valor de retorno (se houver) quando o método no servidor retorna.The Promise is resolved with the return value (if any) when the method on the server returns. Se o método no servidor gerar um erro, o Promise será rejeitado com a mensagem de erro.If the method on the server throws an error, the Promise is rejected with the error message. Use os métodos then e catch na Promise em si para lidar com esses casos (ou await sintaxe).Use the then and catch methods on the Promise itself to handle these cases (or await syntax).

O método send retorna um PromiseJavaScript.The send method returns a JavaScript Promise. O Promise é resolvido quando a mensagem é enviada ao servidor.The Promise is resolved when the message has been sent to the server. Se houver um erro ao enviar a mensagem, o Promise será rejeitado com a mensagem de erro.If there is an error sending the message, the Promise is rejected with the error message. Use os métodos then e catch na Promise em si para lidar com esses casos (ou await sintaxe).Use the then and catch methods on the Promise itself to handle these cases (or await syntax).

Observação

O uso de send não aguarda até que o servidor tenha recebido a mensagem.Using send doesn't wait until the server has received the message. Consequentemente, não é possível retornar dados ou erros do servidor.Consequently, it's not possible to return data or errors from the server.

Chamar métodos de cliente do HubCall client methods from hub

Para receber mensagens do Hub, defina um método usando o método on do HubConnection.To receive messages from the hub, define a method using the on method of the HubConnection.

  • O nome do método de cliente JavaScript.The name of the JavaScript client method. No exemplo a seguir, o nome do método é ReceiveMessage.In the following example, the method name is ReceiveMessage.
  • Argumentos que o Hub passa para o método.Arguments the hub passes to the method. No exemplo a seguir, o valor do argumento é message.In the following example, the argument value is message.
connection.on("ReceiveMessage", (user, message) => {
    const encodedMsg = user + " says " + message;
    const li = document.createElement("li");
    li.textContent = encodedMsg;
    document.getElementById("messagesList").appendChild(li);
});

O código anterior em connection.on é executado quando o código do lado do servidor o chama usando o método SendAsync .The preceding code in connection.on runs when server-side code calls it using the SendAsync method.

public async Task SendMessage(string user, string message)
{
    await Clients.All.SendAsync("ReceiveMessage", user, message);
}

SignalR determina qual método de cliente deve ser chamado, correspondendo ao nome do método e aos argumentos definidos em SendAsync e connection.on. determines which client method to call by matching the method name and arguments defined in SendAsync and connection.on.

Observação

Como prática recomendada, chame o método Start no HubConnection depois de on.As a best practice, call the start method on the HubConnection after on. Isso garante que seus manipuladores sejam registrados antes que todas as mensagens sejam recebidas.Doing so ensures your handlers are registered before any messages are received.

Tratamento de erros e registro em logError handling and logging

Encadeamento um método de catch ao final do método start para manipular erros do lado do cliente.Chain a catch method to the end of the start method to handle client-side errors. Use console.error para gerar erros no console do navegador.Use console.error to output errors to the browser's console.

connection.start().catch(function (err) {
    return console.error(err.toString());
});

Configure o rastreamento de log no lado do cliente passando um agente e um tipo de evento para registrar quando a conexão é feita.Setup client-side log tracing by passing a logger and type of event to log when the connection is made. As mensagens são registradas com o nível de log especificado e superior.Messages are logged with the specified log level and higher. Os níveis de log disponíveis são os seguintes:Available log levels are as follows:

  • signalR.LogLevel.Error – mensagens de erro.signalR.LogLevel.Error – Error messages. Registra somente Error mensagens.Logs Error messages only.
  • signalR.LogLevel.Warning – mensagens de aviso sobre possíveis erros.signalR.LogLevel.Warning – Warning messages about potential errors. Registra Warninge Error mensagens.Logs Warning, and Error messages.
  • signalR.LogLevel.Information – mensagens de status sem erros.signalR.LogLevel.Information – Status messages without errors. Registra Information, Warninge mensagens de Error.Logs Information, Warning, and Error messages.
  • signalR.LogLevel.Trace – mensagens de rastreamento.signalR.LogLevel.Trace – Trace messages. Registra tudo, incluindo dados transportados entre o Hub e o cliente.Logs everything, including data transported between hub and client.

Use o método configureLogging no HubConnectionBuilder para configurar o nível de log.Use the configureLogging method on HubConnectionBuilder to configure the log level. As mensagens são registradas no console do navegador.Messages are logged to the browser console.

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chatHub")
    .configureLogging(signalR.LogLevel.Information)
    .build();

Reconectar clientesReconnect clients

Reconectar automaticamenteAutomatically reconnect

O cliente JavaScript para SignalR pode ser configurado para reconectar-se automaticamente usando o método withAutomaticReconnect em HubConnectionBuilder.The JavaScript client for SignalR can be configured to automatically reconnect using the withAutomaticReconnect method on HubConnectionBuilder. Ele não se reconectará automaticamente por padrão.It won't automatically reconnect by default.

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chatHub")
    .withAutomaticReconnect()
    .build();

Sem parâmetros, withAutomaticReconnect() configura o cliente para aguardar 0, 2, 10 e 30 segundos, respectivamente, antes de tentar cada tentativa de reconexão, parando após quatro tentativas com falha.Without any parameters, withAutomaticReconnect() configures the client to wait 0, 2, 10, and 30 seconds respectively before trying each reconnect attempt, stopping after four failed attempts.

Antes de iniciar qualquer tentativa de reconexão, o HubConnection fará a transição para o estado de HubConnectionState.Reconnecting e acionará seus retornos de chamada onreconnecting em vez de fazer a transição para o estado de Disconnected e disparar seus retornos de chamada de onclose como um HubConnection sem a reconexão automática configurada.Before starting any reconnect attempts, the HubConnection will transition to the HubConnectionState.Reconnecting state and fire its onreconnecting callbacks instead of transitioning to the Disconnected state and triggering its onclose callbacks like a HubConnection without automatic reconnect configured. Isso fornece uma oportunidade para avisar os usuários de que a conexão foi perdida e para desabilitar os elementos da interface do usuário.This provides an opportunity to warn users that the connection has been lost and to disable UI elements.

connection.onreconnecting((error) => {
    console.assert(connection.state === signalR.HubConnectionState.Reconnecting);

    document.getElementById("messageInput").disabled = true;

    const li = document.createElement("li");
    li.textContent = `Connection lost due to error "${error}". Reconnecting.`;
    document.getElementById("messagesList").appendChild(li);
});

Se o cliente se reconectar com êxito dentro de suas primeiras quatro tentativas, o HubConnection fará a transição de volta para o estado de Connected e acionará seus retornos de chamada onreconnected.If the client successfully reconnects within its first four attempts, the HubConnection will transition back to the Connected state and fire its onreconnected callbacks. Isso fornece uma oportunidade de informar aos usuários que a conexão foi restabelecida.This provides an opportunity to inform users the connection has been reestablished.

Como a conexão é totalmente nova no servidor, um novo connectionId será fornecido ao retorno de chamada onreconnected.Since the connection looks entirely new to the server, a new connectionId will be provided to the onreconnected callback.

Aviso

O parâmetro connectionId do retorno de chamada onreconnected será indefinido se o HubConnection tiver sido configurado para ignorar a negociação.The onreconnected callback's connectionId parameter will be undefined if the HubConnection was configured to skip negotiation.

connection.onreconnected((connectionId) => {
    console.assert(connection.state === signalR.HubConnectionState.Connected);

    document.getElementById("messageInput").disabled = false;

    const li = document.createElement("li");
    li.textContent = `Connection reestablished. Connected with connectionId "${connectionId}".`;
    document.getElementById("messagesList").appendChild(li);
});

withAutomaticReconnect() não configurará o HubConnection para repetir as falhas de início inicial, portanto, as falhas de início precisam ser manipuladas manualmente:withAutomaticReconnect() won't configure the HubConnection to retry initial start failures, so start failures need to be handled manually:

async function start() {
    try {
        await connection.start();
        console.assert(connection.state === signalR.HubConnectionState.Connected);
        console.log("connected");
    } catch (err) {
        console.assert(connection.state === signalR.HubConnectionState.Disconnected);
        console.log(err);
        setTimeout(() => start(), 5000);
    }
};

Se o cliente não se reconectar com êxito dentro de suas primeiras quatro tentativas, o HubConnection fará a transição para o estado de Disconnected e disparará seus retornos de chamada fechamento .If the client doesn't successfully reconnect within its first four attempts, the HubConnection will transition to the Disconnected state and fire its onclose callbacks. Isso fornece uma oportunidade de informar aos usuários que a conexão foi permanentemente perdida e recomenda atualizar a página:This provides an opportunity to inform users the connection has been permanently lost and recommend refreshing the page:

connection.onclose((error) => {
    console.assert(connection.state === signalR.HubConnectionState.Disconnected);

    document.getElementById("messageInput").disabled = true;

    const li = document.createElement("li");
    li.textContent = `Connection closed due to error "${error}". Try refreshing this page to restart the connection.`;
    document.getElementById("messagesList").appendChild(li);
});

Para configurar um número personalizado de tentativas de reconexão antes de desconectar ou alterar o tempo de reconexão, withAutomaticReconnect aceita uma matriz de números que representa o atraso em milissegundos para aguardar antes de iniciar cada tentativa de reconexão.In order to configure a custom number of reconnect attempts before disconnecting or change the reconnect timing, withAutomaticReconnect accepts an array of numbers representing the delay in milliseconds to wait before starting each reconnect attempt.

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chatHub")
    .withAutomaticReconnect([0, 0, 10000])
    .build();

    // .withAutomaticReconnect([0, 2000, 10000, 30000]) yields the default behavior

O exemplo anterior configura a HubConnection para iniciar a tentativa de reconexão imediatamente após a perda da conexão.The preceding example configures the HubConnection to start attempting reconnects immediately after the connection is lost. Isso também é verdadeiro para a configuração padrão.This is also true for the default configuration.

Se a primeira tentativa de reconexão falhar, a segunda tentativa de reconexão também será iniciada imediatamente, em vez de esperar 2 segundos, como seria na configuração padrão.If the first reconnect attempt fails, the second reconnect attempt will also start immediately instead of waiting 2 seconds like it would in the default configuration.

Se a segunda tentativa de reconexão falhar, a terceira tentativa de reconexão será iniciada em 10 segundos, o que é novamente como a configuração padrão.If the second reconnect attempt fails, the third reconnect attempt will start in 10 seconds which is again like the default configuration.

O comportamento personalizado, em seguida, deriva novamente do comportamento padrão ao parar após a terceira tentativa de reconexão, em vez de tentar mais uma tentativa de reconexão em outros 30 segundos, como seria na configuração padrão.The custom behavior then diverges again from the default behavior by stopping after the third reconnect attempt failure instead of trying one more reconnect attempt in another 30 seconds like it would in the default configuration.

Se você quiser ter ainda mais controle sobre o tempo e o número de tentativas de reconexão automática, withAutomaticReconnect aceitará um objeto que implementa a interface IRetryPolicy, que tem um único método chamado nextRetryDelayInMilliseconds.If you want even more control over the timing and number of automatic reconnect attempts, withAutomaticReconnect accepts an object implementing the IRetryPolicy interface, which has a single method named nextRetryDelayInMilliseconds.

nextRetryDelayInMilliseconds usa um único argumento com o tipo RetryContext.nextRetryDelayInMilliseconds takes a single argument with the type RetryContext. O RetryContext tem três propriedades: previousRetryCount, elapsedMilliseconds e retryReason que são um number, um number e um Error respectivamente.The RetryContext has three properties: previousRetryCount, elapsedMilliseconds and retryReason which are a number, a number and an Error respectively. Antes da primeira tentativa de reconexão, previousRetryCount e elapsedMilliseconds serão zero e o retryReason será o erro que causou a perda da conexão.Before the first reconnect attempt, both previousRetryCount and elapsedMilliseconds will be zero, and the retryReason will be the Error that caused the connection to be lost. Após cada tentativa de repetição com falha, previousRetryCount será incrementada em um, elapsedMilliseconds será atualizado para refletir o tempo gasto se reconectando até agora em milissegundos e o retryReason será o erro que causou a falha da última tentativa de reconexão.After each failed retry attempt, previousRetryCount will be incremented by one, elapsedMilliseconds will be updated to reflect the amount of time spent reconnecting so far in milliseconds, and the retryReason will be the Error that caused the last reconnect attempt to fail.

nextRetryDelayInMilliseconds deve retornar um número que representa o número de milissegundos a aguardar antes da próxima tentativa de reconexão ou null se a HubConnection deve parar de reconectar.nextRetryDelayInMilliseconds must return either a number representing the number of milliseconds to wait before the next reconnect attempt or null if the HubConnection should stop reconnecting.

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chatHub")
    .withAutomaticReconnect({
        nextRetryDelayInMilliseconds: retryContext => {
          if (retryContext.elapsedMilliseconds < 60000) {
            // If we've been reconnecting for less than 60 seconds so far,
            // wait between 0 and 10 seconds before the next reconnect attempt.
            return Math.random() * 10000;
          } else {
            // If we've been reconnecting for more than 60 seconds so far, stop reconnecting.
            return null;
          }
        })
    .build();

Como alternativa, você pode escrever um código que reconectará o cliente manualmente, conforme demonstrado na reconexão manual.Alternatively, you can write code that will reconnect your client manually as demonstrated in Manually reconnect.

Reconectar manualmenteManually reconnect

Aviso

Antes de 3,0, o cliente JavaScript para SignalR não se reconecta automaticamente.Prior to 3.0, the JavaScript client for SignalR doesn't automatically reconnect. Você deve escrever um código que reconectará o cliente manualmente.You must write code that will reconnect your client manually.

O código a seguir demonstra uma abordagem de reconexão manual típica:The following code demonstrates a typical manual reconnection approach:

  1. Uma função (nesse caso, a função start) é criada para iniciar a conexão.A function (in this case, the start function) is created to start the connection.
  2. Chame a função start no manipulador de eventos onclose da conexão.Call the start function in the connection's onclose event handler.
async function start() {
    try {
        await connection.start();
        console.log("connected");
    } catch (err) {
        console.log(err);
        setTimeout(() => start(), 5000);
    }
};

connection.onclose(async () => {
    await start();
});

Uma implementação do mundo real usaria um retirada exponencial ou tentaria um número especificado de vezes antes de desistir.A real-world implementation would use an exponential back-off or retry a specified number of times before giving up.

Recursos adicionaisAdditional resources