XML-RPC-빠른 가이드

RPC는 원격 프로 시저 호출을 의미합니다. 이름에서 알 수 있듯이 원격 컴퓨터에서 사용할 수있는 프로 시저 또는 함수를 호출하는 메커니즘입니다. RPC는 웹보다 훨씬 오래된 기술입니다. 실제로 RPC는 개발자에게 네트워크를 통해 호출 할 수있는 인터페이스를 정의하는 메커니즘을 제공합니다. 이러한 인터페이스는 단일 함수 호출처럼 간단하거나 대규모 API처럼 복잡 할 수 있습니다.

XML-RPC 란 무엇입니까?

XML-RPC는 컴퓨터가 다른 컴퓨터에서 프로 시저를 쉽게 호출 할 수 있도록하는 가장 간단하고 가장 안전한 웹 서비스 접근 방식 중 하나입니다.

XML-RPC를 사용하면 프로그램이 네트워크를 통해 함수 또는 프로 시저 호출을 수행 할 수 있습니다.
XML-RPC는 HTTP 프로토콜을 사용하여 클라이언트 컴퓨터에서 서버 컴퓨터로 정보를 전달합니다.
XML-RPC는 작은 XML 어휘를 사용하여 요청 및 응답의 특성을 설명합니다.
XML-RPC 클라이언트는 XML 요청에 프로 시저 이름과 매개 변수를 지정하고 서버는 XML 응답에 오류 또는 응답을 반환합니다.
XML-RPC 매개 변수는 유형과 내용의 간단한 목록입니다. 구조체와 배열은 사용 가능한 가장 복잡한 유형입니다.
XML-RPC에는 객체에 대한 개념이 없으며 다른 XML 어휘를 사용하는 정보를 포함하는 메커니즘도 없습니다.
그러나 XML-RPC 및 웹 서비스를 사용하면 웹은 컴퓨터가 긴밀하게 연결된 경로를 따라 정보를 교환하는 절차 적 연결 모음이됩니다.
XML-RPC는 1998 년 초에 등장했습니다. UserLand Software에 의해 게시되었으며 처음에는 Frontier 제품에 구현되었습니다.

왜 XML-RPC인가?

여러 컴퓨팅 환경을 통합해야하지만 복잡한 데이터 구조를 직접 공유 할 필요가없는 경우 XML-RPC를 사용하면 통신을 빠르고 쉽게 설정할 수 있습니다.

단일 환경에서 작업하는 경우에도 RPC 접근 방식을 사용하면 데이터 모델이 다르거 나 예상을 처리하는 프로그램을 쉽게 연결할 수 있으며 재사용 가능한 논리에 쉽게 액세스 할 수 있습니다.

XML-RPC는 컴퓨터간에 다양한 연결을 설정하기위한 훌륭한 도구입니다.
XML-RPC는 통합 자에게 표준 어휘와 정보 교환 방식을 사용할 수있는 기회를 제공합니다.
XML-RPC의 가장 명백한 응용 분야는 다양한 종류의 환경을 연결하여 Java가 Perl, Python, ASP 등과 통신 할 수 있도록하는 것입니다.

XML-RPC 기술 개요

XML-RPC는 상대적으로 작은 세 부분으로 구성됩니다.

XML-RPC data model : 매개 변수, 반환 값 및 오류 (오류 메시지)를 전달하는 데 사용할 유형 집합입니다.
XML-RPC request structures : 메소드 및 매개 변수 정보를 포함하는 HTTP POST 요청입니다.
XML-RPC response structures : 반환 값 또는 오류 정보가 포함 된 HTTP 응답입니다.

다음 세 장에서이 세 가지 구성 요소를 모두 살펴 보겠습니다.

XML-RPC 사양은 6 개의 기본 데이터 유형과 유형의 조합을 나타내는 2 개의 복합 데이터 유형을 정의합니다.

XML-RPC의 기본 데이터 유형

유형	값	예
int 또는 i4	-2,147,483,648에서 2,147,483,647 사이의 32 비트 정수입니다.	<int> 27 </ int> <i4> 27 </ i4>
더블	64 비트 부동 소수점 숫자	<double> 27.31415 </ double> <double> -1.1465 </ double>
부울	참 (1) 또는 거짓 (0)	<boolean> 1 </ boolean> <boolean> 0 </ boolean>
끈	많은 구현이 유니 코드를 지원하지만 ASCII 텍스트	<string> 안녕하세요 </ string> <string> 광주! @ </ string>
dateTime.iso8601	ISO8601 형식의 날짜 : CCYYMMDDTHH : MM : SS	<dateTime.iso8601> 20021125T02 : 20 : 04 </dateTime.iso8601> <dateTime.iso8601> 20020104T17 : 27 : 30 </dateTime.iso8601>
base64	RFC 2045에 정의 된대로 Base 64로 인코딩 된 이진 정보	<base64> SGVsbG8sIFdvcmxkIQ == </ base64>

이러한 기본 유형은 항상 값 요소로 묶여 있습니다. 문자열 (및 문자열 만)은 값 요소로 묶일 수 있지만 문자열 요소는 생략합니다 . 이러한 기본 유형은 두 가지 더 복잡한 유형, 배열 및 구조체로 결합 될 수 있습니다. 배열은 순차 정보를 나타내고 구조체는 해시 테이블, 연관 배열 또는 속성과 같이 이름-값 쌍을 나타냅니다.

배열은 값 목록을 보유 하는 데이터 요소 를 포함하는 배열 요소 로 표시됩니다 . 다른 데이터 유형과 마찬가지로 배열 요소는 값 요소 로 묶어야합니다 . 예를 들어, 다음 배열 에는 4 개의 문자열이 있습니다.

<value>
   <array>
      <data>
         <value><string>This </string></value>
         <value><string>is </string></value>
         <value><string>an </string></value>
         <value><string>array.</string></value>
      </data>
   </array>
</value>

다음 배열에는 4 개의 정수가 포함됩니다.

<value>
   <array>
      <data>
         <value><int>7</int></value>
         <value><int>1247</int></value>
         <value><int>-91</int></value>
         <value><int>42</int></value>
      </data>
   </array>
</value>

배열에는 다음과 같이 다양한 유형의 혼합이 포함될 수도 있습니다.

<value>
   <array>
      <data>
         <value><boolean>1</boolean></value>
         <value><string>Chaotic collection, eh?</string></value>
         <value><int>-91</int></value>
         <value><double>42.14159265</double></value>
      </data>
   </array>
</value>

다차원 배열을 만드는 것은 간단합니다. 배열 안에 배열을 추가하기 만하면됩니다.

<value>
   <array>
      <data>
		
         <value>
            <array>
               <data>
                  <value><int>10</int></value>
                  <value><int>20</int></value>
                  <value><int>30</int></value>
               </data>
            </array>
         </value>
			
         <value>
            <array>
               <data>
                  <value><int>15</int></value>
                  <value><int>25</int></value>
                  <value><int>35</int></value>
               </data>
            </array>
         </value>
			
      </data>
   </array>
</value>

간단한 구조체는 다음과 같습니다.

<value>
   <struct>
      <member>
         <name>givenName</name>
         <value><string>Joseph</string></value>
      </member>
		
      <member>
         <name>familyName</name>
         <value><string>DiNardo</string></value>
      </member>
		
      <member>
         <name>age</name>
         <value><int>27</int></value>
      </member>
   </struct>
</value>

이렇게하면 모든 프로그래밍 언어에서 지원하는 거의 모든 데이터 유형을 구현할 수 있습니다.

XML-RPC 요청은 XML 콘텐츠와 HTTP 헤더의 조합입니다. XML 콘텐츠는 데이터 형식화 구조를 사용하여 매개 변수를 전달하고 호출되는 프로 시저를 식별하는 추가 정보를 포함하는 반면 HTTP 헤더는 웹을 통해 요청을 전달하기위한 래퍼를 제공합니다.

각 요청에는 루트 요소가 methodCall 요소 인 단일 XML 문서가 포함 됩니다. 각 methodCall 요소에는 methodName 요소와 params 요소가 포함됩니다. methodName로의 그동안 요소 식별이 프로 시저의 이름이 호출 할 수 있는 params 요소는 매개 변수와 그 값의 목록이 포함되어 있습니다. 각 params 요소에는 값 요소를 포함하는 param 요소 목록이 포함 됩니다.

예를 들어 반경에 대한 Double 매개 변수를 사용 하는 circleArea 라는 메서드에 요청을 전달 하려면 XML-RPC 요청은 다음과 같습니다.

<?xml version="1.0"?>
<methodCall>
   <methodName>circleArea</methodName>
      <params>
         <param>
            <value><double>2.41</double></value>
         </param>
      </params>
</methodCall>

이러한 요청에 대한 HTTP 헤더는 보낸 사람과 콘텐츠를 반영합니다. 기본 템플릿은 다음과 같습니다.

POST /target HTTP 1.0
User-Agent: Identifier
Host: host.making.request
Content-Type: text/xml
Content-Length: length of request in bytes

예를 들어 / xmlrpc 에서 수신하는 XML-RPC 서버에서 circleArea 메서드를 사용할 수있는 경우 요청은 다음과 같습니다.

POST /xmlrpc HTTP 1.0
User-Agent: myXMLRPCClient/1.0
Host: 192.168.124.2
Content-Type: text/xml
Content-Length: 169

조립 된 전체 요청은 다음과 같습니다.

POST /xmlrpc HTTP 1.0
User-Agent: myXMLRPCClient/1.0
Host: 192.168.124.2
Content-Type: text/xml
Content-Length: 169
<?xml version="1.0"?>
<methodCall>
   <methodName>circleArea</methodName>
      <params>
         <param>
            <value><double>2.41</double></value>
         </param>
      </params>
</methodCall>

신중하게 구성된 페이로드가있는 일반적인 HTTP 요청입니다.

응답은 요청과 매우 유사하지만 몇 가지 추가 사항이 있습니다. 응답이 성공하면 (프로 시저가 발견되고 올바르게 실행되고 결과가 반환 됨) XML-RPC 응답은 methodCall 요소가 methodResponse 요소 로 대체되고 methodName 요소 가 없다는 점을 제외하면 요청과 매우 유사합니다 .

<?xml version="1.0"?>
<methodResponse>
   <params>
      <param>
         <value><double>18.24668429131</double></value>
      </param>
   </params>
</methodResponse>

XML-RPC 응답에는 하나의 매개 변수 만 포함될 수 있습니다.
해당 매개 변수는 배열 또는 구조체 일 수 있으므로 여러 값을 반환 할 수 있습니다.
항상 응답으로 값을 반환해야합니다. "성공 값"-true (1)로 설정된 부울 일 수 있습니다.

요청과 마찬가지로 응답은 HTTP로 패키징되고 HTTP 헤더가 있습니다. 모든 XML-RPC 응답은 메시지에 오류가 포함 된 경우에도 200 OK 응답 코드를 사용합니다. 헤더는 요청과 유사한 공통 구조를 사용하며 일반적인 헤더 세트는 다음과 같습니다.

HTTP/1.1 200 OK
Date: Sat, 06 Oct 2001 23:20:04 GMT
Server: Apache.1.3.12 (Unix)
Connection: close
Content-Type: text/xml
Content-Length: 124

XML-RPC는 HTTP 1.0 지원 만 필요하지만 HTTP 1.1은 호환됩니다.
Content-Type은 text / xml로 설정해야합니다.
Content-Length 헤더는 응답 길이를 바이트 단위로 지정합니다.

헤더와 응답 페이로드가 모두 포함 된 완전한 응답은 다음과 같습니다.

HTTP/1.1 200 OK
Date: Sat, 06 Oct 2001 23:20:04 GMT
Server: Apache.1.3.12 (Unix)
Connection: close
Content-Type: text/xml
Content-Length: 124

<?xml version="1.0"?>
<methodResponse>
   <params>
      <param>
         <value><double>18.24668429131</double></value>
      </param>
   </params>
</methodResponse>

응답이 XML-RPC 서버에서 XML-RPC 클라이언트로 전달되면 연결이 닫힙니다. 후속 요청은 별도의 XML-RPC 연결로 보내야합니다.

XML-RPC 오류는 일종의 응답입니다. XML-RPC 요청을 처리하는 데 문제가있는 경우 methodResponse 요소는 params 요소 대신 오류 요소를 포함합니다. params 요소 와 같은 오류 요소 에는 문제가 발생했음을 나타내는 단일 값만 있습니다. 결함 응답은 다음과 같습니다.

<?xml version="1.0"?>
<methodResponse>
   <fault>
      <value><string>No such method!</string></value>
   </fault>
</methodResponse>

오류에는 오류 코드도 있습니다. XML-RPC는 오류 코드를 전혀 표준화하지 않습니다. 특정 패키지가 오류를 처리하는 방법을 보려면 설명서를 확인해야합니다.

오류 응답은 다음과 같습니다.

<?xml version="1.0"?>
<methodResponse>
   <fault>
      <value>
         <struct>
            <member>
               <name>code</name>
               <value><int>26</int></value>
            </member>
				
            <member>
               <name>message</name>
               <value><string>No such method!</string></value>
            </member>
				
         </struct>
      </value>
   </fault>
</methodResponse>

XML-RPC를 시연하기 위해 Java를 사용하여 XML-RPC 메시지를 처리하는 서버를 만들고 해당 서버에서 프로 시저를 호출하는 Java 클라이언트를 만들 것입니다.

대화의 Java 쪽에서는 Apache XML 프로젝트의 Apache XML-RPC를 사용합니다. http://xml.apache.org/xmlrpc/

모든 .jar 파일을 적절한 경로에 넣고 JAVA를 사용하여 하나의 클라이언트와 하나의 작은 XML-RPC 서버를 만듭니다.

XML-RPC 클라이언트

sum 함수 라는 함수를 호출하는 XML-RPC 클라이언트를 작성해 보겠습니다 . 이 함수는 두 개의 매개 변수를 취하고 그 합계를 반환합니다.

import java.util.*;
import org.apache.xmlrpc.*;

public class JavaClient 
{
   public static void main (String [] args) 
   {
      try {

         XmlRpcClient client = new XmlRpcClient("http://localhost/RPC2"); 
         Vector params = new Vector();
         params.addElement(new Integer(17));
         params.addElement(new Integer(13));

         Object result = server.execute("sample.sum", params);

         int sum = ((Integer) result).intValue();
         System.out.println("The sum is: "+ sum);

      } catch (Exception exception) {
         System.err.println("JavaClient: " + exception);
      }
   }
}

위의 예제 클라이언트에서 어떤 일이 발생했는지 살펴 보겠습니다.

Java 패키지 org.apache.xmlrpc에는 XML-RPC Java 클라이언트 및 XML-RPC 서버 (예 : XmlRpcClient) 용 클래스가 포함되어 있습니다.
패키지 java.util은 Vector 클래스에 필요합니다.
server.execute (...) 함수 는 서버에 요청을 보냅니다. 프로 시저 sum (17,13)은 마치 로컬 프로 시저 인 것처럼 서버에서 호출됩니다. 프로 시저 호출의 반환 값은 항상 Object입니다.
여기서 "sample"은 서버에 정의 된 핸들러를 나타냅니다.
프로 시저 호출의 모든 매개 변수는 항상 Vector에 수집됩니다.
XmlRpcClient 클래스는 서버 컴퓨터의 "웹 주소"다음에 / RPC2를 지정하여 구성됩니다.
- localhost-로컬 시스템을 의미합니다.
- localhost 대신 IP 번호를 지정할 수 있습니다 (예 : 194.80.215.219).
- xyz.dyndns.org와 같은 도메인 이름을 지정할 수 있습니다.
- 도메인 이름과 함께 포트 번호를 xyz.dyndns.org:8080으로 지정할 수 있습니다. 기본 포트는 80입니다.
원격 프로 시저 호출의 결과는 항상 Object이며 적절한 유형으로 캐스트되어야합니다.
문제가 발생하면 (연결 없음 등) 예외가 발생하고 catch 문을 사용하여 포착해야 합니다.

위의 호출로 인해 클라이언트는 다음 메시지를 서버에 보냅니다. 이것은 내부적 으로 server.execute (...)에 의해 처리되며 당신은 그것과 아무 관련이 없습니다.

<?xml version="1.0" encoding="ISO-8859-1"?>
<methodCall>
   <methodName>sample.sum</methodName>
   <params>
      <param>
         <value><int>17</int></value>
      </param>
		 
      <param>
         <value><int>13</int></value>
      </param>
   </params>
</methodCall>

XML-RPC 서버

다음은 Java로 작성된 XML-RPC 서버의 소스 코드입니다. org.apache.xmlrpc. * 에서 사용할 수있는 내장 클래스를 사용 합니다.

import org.apache.xmlrpc.*;

public class JavaServer 
{ 

   public Integer sum(int x, int y) 
   {
      return new Integer(x+y);
   }

   public static void main (String [] args) 
   {
      try {

         System.out.println("Attempting to start XML-RPC Server...");
         WebServer server = new WebServer(80);
         server.addHandler("sample", new JavaServer());
         server.start();
         System.out.println("Started successfully.");
         System.out.println("Accepting requests. (Halt program to stop.)");
      } catch (Exception exception) 
      {
         System.err.println("JavaServer: " + exception);
      }
   }
}

위의 예제 서버에서 수행 한 작업을 살펴 보겠습니다.

org.apache.xmlrpc 패키지에는 XML-RPC 서버 구현을위한 WebServer 클래스가 포함되어 있습니다.
원격으로 호출 되는 프로 시저 합계 는 클래스의 공용 메서드로 구현됩니다.
그런 다음 동일한 서버 클래스의 인스턴스가 클라이언트가 액세스 할 수있는 핸들러와 연결됩니다.
서버는 포트 번호 (여기서는 80)로 초기화됩니다.
문제가 발생하면 예외가 발생하고 catch 문을 사용하여 잡아야 합니다.

주어진 예제 클라이언트에서 언급 된 호출에 대해 서버는 다음 응답을 클라이언트에 다시 보냅니다.

<?xml version="1.0" encoding="ISO-8859-1"?>
<methodResponse>
   <params>
      <param>
         <value><int>30</int></value>
      </param>
   </params>
</methodResponse>

이제 서버가 준비되었으므로 다음과 같이 프롬프트에서 컴파일하고 실행하십시오.

C:\ora\xmlrpc\java>java JavaServer
Attempting to start XML-RPC Server...
Started successfully.
Accepting requests. (Halt program to stop.)

이제 기능을 테스트하려면 다음과 같이이 서버를 호출하십시오.

C:\ora\xmlrpc\java>java JavaClient
30

이 자습서에서는 XML-RPC가 무엇이며 XML-RPC가 필요한 이유를 배웠습니다. 데이터 모델과 클라이언트와 서버간에 교환 할 요청 및 응답 메시지 형식에 대해 논의했습니다. XML-RPC 클라이언트와 서버가 정보를 교환하는 방법을 보여주기 위해 한 가지 예를 들어 보았습니다.

XML-RPC는 제한된 기능을 가진 매우 단순한 개념입니다. 이러한 제한은 여러면에서 XML-RPC의 가장 매력적인 기능입니다. 프로토콜 구현 및 상호 운용성 테스트의 어려움을 상당히 줄여주기 때문입니다.

XML-RPC는 간단하지만 간단한 도구를 창의적으로 적용하면 정교하고 강력한 아키텍처를 만들 수 있습니다. 다양한 시스템이 통신해야하는 경우 XML-RPC가 가장 적절한 최소 공통 분모 일 수 있습니다.