본문으로 건너뛰기

JS 클라이언트: 구독과 컴포넌트 수명주기

브라우저와 Node.js의 IO 클라이언트에서 구독하고 정리하는 법입니다. 모든 환경에 공통인 흐름(ready의 뜻, 재접속하면 CID와 구독이 어떻게 되는지)은 연결과 CID 수명주기에 있고, 메서드와 이벤트 전체는 클라이언트 API에 있습니다.

연결 상태 이름​

ready는 CID를 받아 통신할 수 있게 된 상태입니다. 소켓이 열린 open과 다르며, 재접속할 때마다 다시 발생합니다. change 이벤트로 아래 상태 이름을 받을 수 있습니다.

재접속 처리​

ready는 최초 연결에서 한 번만 발생하는 이벤트가 아닙니다. 연결이 끊기고 라이브러리가 다시 연결하면 CID를 새로 받은 뒤 ready가 다시 발생합니다. 앱 상태를 연결 수명주기에 맞춰 초기화하세요.

let currentCid = null;

io.on('ready', () => {
currentCid = io.cid; // 재접속마다 갱신
io.subscribe('room#chat'); // 수동 구독 재등록
rebuildRoomState(currentCid); // 피어 목록·방 상태 재구성
});

io.listen('alarm#state', (tag, ...args) => {
console.log(tag, ...args);
}); // 일반 태그는 자동 재구독
io.on('change', (state) => {
if (state === 'closed') currentCid = null;
});
  • CID 변경: 연결이 끊기면 클라이언트의 cid는 비워지고, 새 연결에서 서버가 새 CID를 발급할 수 있습니다. 익명 연결은 특히 동일하다고 가정하지 않습니다. 이전 CID를 키로 저장한 피어 목록·권한·방 상태는 새 ready에서 다시 구성합니다.
  • 수동 구독: subscribe()는 현재 연결에만 적용되며 재접속 후 유지되지 않습니다. ready 핸들러에서 매번 다시 등록합니다.
  • 자동 구독: listen()으로 등록한 일반 태그는 .channels 목록을 기준으로 재접속 시 라이브러리가 다시 구독합니다. 직접 수신(@, @topic)은 구독 자체가 필요 없습니다.
  • rebuildRoomState()는 앱이 구현하는 함수입니다.
  • 리디렉션과 단절: 공개 서버는 최초 연결이나 로그인을 다른 서버로 리디렉션할 수 있습니다. 이는 ready 이전의 정상적인 연결 과정이며, ready 이후의 예기치 않은 단절과 다릅니다. 둘을 같은 오류로 처리하지 말고 연결 대기에는 상한을 둡니다.
  • 서버 응답 제한(9.19.0부터): 연결을 시작한 뒤 15초 안에 서버의 첫 응답이 없으면 클라이언트가 error를 내고 연결을 닫습니다. 자동 재연결이 켜져 있으면 처음 만든 주소로 다시 접속하므로, 리디렉션된 서버에 닿지 않아도 원래 서버로 돌아옵니다. Arduino 라이브러리는 같은 동작을 10초로 합니다.
  • 정리: 더 이상 재연결하지 않으려면 stop(), 인스턴스를 폐기하려면 destroy()를 호출합니다. 공유 인스턴스에서는 link()로 연결한 컴포넌트만 unlinkAll(component)로 해제합니다. 해당 컴포넌트가 link()로 등록한 핸들러와 그 링크만 소유한 구독을 정리하며, on()·listen()으로 등록한 핸들러는 제거하지 않습니다.

두 가지 구독 방식과 용도​

listen()은 ready마다 구독 코드를 쓰지 않아도 되게 하는 간편 문법입니다.

방식적합한 용도연결·재접속 시 구독
수동 subscribe() + on()연결 상태에 따른 처리, 실행 중에 바뀌는 동적 구독앱이 ready 핸들러에서 등록
자동 listen(tag, handler)사용할 태그가 정해진 간단한 앱·CLI, 연결 상태별 코드를 줄이고 싶은 경우저장된 .channels를 이용해 라이브러리가 자동 등록

listen 자동 구독은 ready 이벤트 전에 전송되므로 ready 핸들러에서 바로 송신할 수 있고, 수동 방식은 ready 안에서 subscribe 다음 signal 순서로 보냄

수동 방식: ready에서 구독하고 송신​

const io = new IO();
const tag = 'channel1';
io.on('message', (receivedTag, ...args) => {
console.log(receivedTag, ...args);
});
io.on('ready', () => {
io.subscribe(tag);
io.signal(tag, io.cid + ' is ready.');
});
io.open('ws://localhost:7777');

핸들러는 한 번 등록하고 구독은 ready마다 보내므로 재접속에도 대응합니다. subscribe(tag)는 핸들러를 받지 않고 재구독 목록 .channels에도 저장하지 않습니다.

subscribe()는 연결이 ready일 때만 호출할 수 있습니다. 9.6.0부터 ready가 아닌 상태(연결 전, CID 수신 전, 연결 끊김)에서 호출하면 Error를 던집니다. 그 상태의 요청은 인증 전에 전송되거나 유실되기 때문입니다. destroy() 뒤의 호출은 아무 일도 하지 않습니다.

자동 방식: listen 한 줄로 태그와 핸들러 등록​

const io = new IO();
io.listen('channel1', (tag, ...args) => {
console.log(tag, ...args);
});
io.open('ws://localhost:7777');

listen()은 핸들러를 등록하고 태그를 .channels에 저장합니다. ready가 될 때와 재접속할 때마다 이 목록을 자동 구독하므로 구독용 ready 핸들러가 필요 없습니다.

listen()은 즉시 구독 패킷을 보내지 않으므로 최초 ready 전, 초기화 코드에서 등록하세요. 9.6.0부터 저장된 자동 구독은 ready 이벤트 전에 전송됩니다. 따라서 ready 핸들러에서 바로 signal()해도 자신의 구독보다 앞서지 않습니다.

ready 핸들러 안에서 listen()을 호출하면 태그와 관계없이 Error를 던집니다. 그 자리에서 등록한 구독 태그는 다음 재접속 때에야 구독되고, 재접속마다 같은 핸들러가 또 등록되기 때문입니다. ready 안에서는 on()과 subscribe()를, 이미 ready인 상태에서 동적으로 구독할 때는 subscribe()나 link()를 사용합니다.

unsubscribe(tag)는 서버 구독을 해제하고 저장 목록에서도 태그를 제거합니다. 직접 수신은 서버 구독 없이 on()·listen()으로 @ 또는 @topic에 핸들러를 등록하고 off()로 해제합니다. subscribe('@topic')·unsubscribe('@topic')는 TypeError이며(쉼표 목록에 하나라도 있으면 전체 거부), CID 발행 구독 A@topic은 허용합니다.

link(component, tag, handler)의 첫 인자는 로컬 컴포넌트 식별자이며 서버 주소나 CID가 아닙니다. unlink(component, tag)와 unlinkAll(component)는 그 컴포넌트가 등록한 핸들러만 제거합니다.

io.link('offer-panel', '@offer', (tag, message) => {
console.log(tag, message);
});
// 컴포넌트가 사라질 때
io.unlinkAll('offer-panel');

@·@topic 링크는 로컬 리스너만 관리합니다. 일반 채널과 A@topic 링크는 서버 구독과 재접속 구독도 관리합니다. 연결이 ready이면 바로 구독하고, 아직 아니면 ready가 될 때 구독합니다. 이때 다른 링크·listen·subscribe가 같은 구독을 쓰고 있으면 해제하지 않고 마지막 사용자가 사라질 때 해제합니다.