SignalR 사용법 개요

개요

SignalR은 ASP.NET Core에서 실시간 통신을 구현하기 위한 핵심 프레임워크이다. 전송 프로토콜의 우선순위는 다음과 같이 결정된다.

  • WebSocket: 양방향 통신 지원
  • Server-Sent Events(SSE): 서버에서 클라이언트로만 데이터 전송
  • Long Polling: 폴링 기반 통신

브라우저가 WebSocket을 지원하지 않거나 네트워크 환경이 제한된 경우 자동으로 하위 프로토콜로 전환된다.

Hub 아키텍처는 양방향 RPC(Remote Procedure Call) 호출을 구현하며, 다음과 같은 주요 사용 시나리오가 있다.

  • 실시간 데이터 대시보드
  • 다중 사용자 협업 도구
  • 인스턴트 메시징 시스템

클라이언트 스텁의 역할

클라이언트 스텁은 프록시 역할을 수행하며, 다음과 같은 기능을 담당한다.

  • 매개변수 직렬화: 로컬 메서드 호출의 매개변수를 네트워크 전송 형식으로 변환
  • 네트워크 요청 전송: 직렬화된 데이터를 프로토콜(HTTP, TCP 등)을 통해 서버로 전송
  • 응답 수신 및 역직렬화: 서버에서 반환된 데이터를 클라이언트에서 사용 가능한 객체로 변환
  • 오류 처리: 네트워크 타임아웃, 연결 실패 등 예외 상황 처리

서버 스텁의 역할

서버 스텁은 요청을 처리하고 결과를 반환하는 역할을 한다.

  • 요청 수신: 클라이언트로부터 네트워크 요청을 수신
  • 매개변수 역직렬화: 수신된 데이터를 서버 메서드의 매개변수 형식으로 변환
  • 실제 메서드 호출: 서버의 실제 비즈니스 로직 메서드를 실행
  • 결과 직렬화 및 반환: 메서드 반환값을 직렬화하여 클라이언트로 전송

Hub 아키텍처 작동 원리

SignalR은 Hub 클래스를 통해 클라이언트와 서버 간의 양방향 통신을 가능하게 한다. 클라이언트는 서버의 Hub 메서드를 직접 호출할 수 있고, 서버는 연결된 모든 클라이언트 또는 특정 클라이언트에게 메시지를 브로드캐스트할 수 있다.

구현 예제

준비 작업

  1. Blazor WebAssembly Standalone App 프로젝트 생성
  2. .NET 6.0 프레임워크 및 ASP.NET Core Hosted 옵션 선택
  3. NuGet 패키지 설치: Microsoft.AspNetCore.SignalR.Client 6.0.36

서버 구현

서버 프로젝트의 Program.cs 파일에 다음 코드를 추가한다.

1. SignalR 서비스를 의존성 주입 컨테이너에 등록

var builder = WebApplication.CreateBuilder(args);
// ... 기존 코드
builder.Services.AddSignalR();
// ... 기존 코드
var app = builder.Build();

2. 응답 압축 서비스를 의존성 컨테이너에 등록

builder.Services.AddResponseCompression(opts =>
{
    opts.MimeTypes = ResponseCompressionDefaults.MimeTypes.Concat(
        new[] { "application/octet-stream" });
});

위 코드는 AddSignalR() 메서드 이후에 위치해야 한다.

3. HTTP 요청 파이프라인에서 응답 압축 미들웨어 활성화

var app = builder.Build();
// ... 기존 코드
app.UseResponseCompression();
// ... 기존 코드
app.Run();

4. SignalR Hub를 특정 라우트에 매핑

app.MapControllers();
// ... 기존 코드
app.MapHub<MessageHub>("/messagehub");
// ... 기존 코드
app.Run();

서버 프로젝트에新しい Hub 파일(MessageHub.cs)을 생성한다.

1.自定义 Hub 클래스 작성

public class MessageHub : Hub
{
    // Hub 메서드 정의
}

2.클라이언트가 호출할 수 있는 서버 메서드 추가

public async Task BroadcastMessage(string sender, string content)
{
    // 연결된 모든 클라이언트에게 메시지 브로드캐스트
    await Clients.All.SendAsync("ReceiveMessage", sender, content);
}

클라이언트 구현

클라이언트 프로젝트에新しい Razor 구성요소 파일(Message.razor)을 생성한다.

@using Microsoft.AspNetCore.SignalR.Client
@inject NavigationManager Navigation

@messages

@code{
    private HubConnection? messageConnection;
    private string messages = string.Empty;

    protected override async Task OnInitializedAsync()
    {
        // SignalR 연결 구성
        messageConnection = new HubConnectionBuilder()
            .WithUrl(Navigation.ToAbsoluteUri("/messagehub"))
            .Build();

        // 메시지 수신 콜백 등록
        messageConnection.On<string, string>("ReceiveMessage", (usr, msg) =>
        {
            messages = $"{usr}: {msg}";
            StateHasChanged();
        });

        // 연결 시작
        await messageConnection.StartAsync();

        // 메시지 전송
        await messageConnection.SendAsync("BroadcastMessage", "KimJi", "안녕하세요");
    }
}

서버 프로젝트를 실행하면 SignalR 연결이Establish되고 실시간 메시징 기능이 동작한다.

참고 자료

  1. SignalR Hub 프로토콜: https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/HubProtocol.md
  2. ASP.NET Core Blazor SignalR 가이드: https://learn.microsoft.com/zh-cn/aspnet/core/blazor/fundamentals/signalr?view=aspnetcore-6.0
  3. 원격 프로시저 호출(RPC): https://en.wikipedia.org/wiki/Remote_procedure_call

태그: SignalR aspnetcore Blazor realtime-communication WebSockets

10월 22일 12:42에 게시됨