자바스크립트에서 JSON RPC를 구현하는 방법

10 Sep 2023

javascript

자바스크립트는 웹 애플리케이션 개발에 널리 사용되는 언어입니다. 웹 애플리케이션에는 종종 서버와 클라이언트 간의 통신이 필요한데, 이때 JSON-RPC (JSON Remote Procedure Call)는 인기있는 프로토콜 중 하나입니다. 이번 블로그에서는 자바스크립트에서 JSON RPC를 구현하는 방법에 대해 알아보겠습니다.

JSON RPC란?

JSON-RPC는 원격 프로시저 호출을 위한 간단한 프로토콜입니다. 서버에 있는 기능이나 메소드를 클라이언트에서 직접 호출하여 실행할 수 있도록 합니다. JSON-RPC는 주로 HTTP 또는 TCP/IP와 같은 네트워크 프로토콜을 기반으로 동작하며, 데이터는 JSON 형식으로 전송됩니다.

JSON RPC 요청 구조

JSON RPC 요청은 다음과 같은 구조를 갖습니다.

{
    "jsonrpc": "2.0",
    "method": "methodName",
    "params": [param1, param2, ...],
    "id": requestId
}

jsonrpc: JSON RPC 버전을 지정합니다. 일반적으로 “2.0”을 사용합니다.
method: 호출할 서버 메소드의 이름을 지정합니다.
params: 메소드에 전달할 매개변수의 배열을 지정합니다.
id: 요청을 구분할 고유한 식별자를 지정합니다.

JSON RPC 응답 구조

JSON RPC 응답은 다음과 같은 구조를 갖습니다.

{
    "jsonrpc": "2.0",
    "result": resultData,
    "error": {
        "code": errorCode,
        "message": errorMessage
    },
    "id": requestId
}

jsonrpc: JSON RPC 버전을 지정합니다. 일반적으로 “2.0”을 사용합니다.
result: 메소드가 성공적으로 실행되었을 때의 결과 데이터를 지정합니다.
error: 메소드 실행 중에 발생한 오류 정보를 지정합니다. code는 오류 코드를, message는 오류 메시지를 나타냅니다.
id: 요청을 구분할 고유한 식별자를 지정합니다.

자바스크립트에서 JSON RPC 구현하기

자바스크립트에서 JSON RPC를 구현하려면 다음 단계를 따르면 됩니다.

서버 URL과 요청 데이터를 포함한 JSON-RPC 요청 객체를 만듭니다.
XMLHttpRequest나 Fetch API를 사용하여 서버에 요청을 전송합니다.
서버로부터 받은 응답 데이터를 JSON 객체로 파싱합니다.
응답 객체에서 결과 또는 오류 정보를 추출하여 처리합니다.

다음은 예시 코드입니다.

const serverUrl = 'http://example.com/api/rpc';

function sendJsonRpcRequest(method, params) {
    const requestObj = {
        jsonrpc: '2.0',
        method: method,
        params: params,
        id: Math.random().toString(36).substr(2)
    };

    const requestOptions = {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify(requestObj)
    };

    fetch(serverUrl, requestOptions)
        .then(response => response.json())
        .then(responseObj => {
            if (responseObj.error) {
                console.error('JSON RPC error:', responseObj.error);
            } else {
                console.log('JSON RPC result:', responseObj.result);
            }
        })
        .catch(error => {
            console.error('JSON RPC request failed:', error);
        });
}

// 사용 예시
sendJsonRpcRequest('methodName', [param1, param2]);

위 코드는 클라이언트에서 sendJsonRpcRequest 함수를 호출하여 서버에 JSON RPC 요청을 전송합니다. 이때 해당하는 메소드 이름과 매개변수를 전달합니다. 서버로부터 받은 JSON RPC 응답은 콘솔에 로그로 출력되거나 오류가 발생할 경우 콘솔에 오류 메시지가 출력됩니다.

이렇게 자바스크립트에서 JSON RPC를 구현하면 서버와 클라이언트 간의 효율적인 통신을 할 수 있습니다. JSON-RPC가 제공하는 간단한 프로토콜로 원격 프로시저 호출을 구현할 수 있으므로, 웹 애플리케이션 개발에 유용하게 활용할 수 있습니다.

자바스크립트에서 JSON RPC를 구현하는 방법에 대해 간략히 소개했지만, 더 많은 공부와 실제 적용이 필요합니다. JSON RPC에 대해 자세히 알아보고 실습해보는 것을 권장합니다.