AJAX JSON RPC JAVA ORB

2023-02-072023
10.1% (37.2/365)
February
22.2% (6.2/28)
Week 06
17.3% (1.2/7)
Day 07 Tue
21.6% (5.2/24)

訪問者

total: 22050
today: 2
yesterday: 4
now: 10

↑

更新

MenuBar

JSONとは？
JSON RPC JAVA ORB とは？
JSONのインストール
JSONサンプルプログラム
JSON Bridgeの初期化
Hello JSON
いろいろな引数でJSON Bridgeを呼び出す
いろいろな返値をJSON Bridgeから受け取る
JSON Bridgeによる例外の搬送
その他の機能
参考文献

JSONとは？ †

多言語間でオブジェクトをやりとりするときに、オブジェクトを表記するための中立的な表記法
現在、多言語間でオブジェクトをやりとりするためのプロトコルとしてはXMLが広く使われはじめてきている
ところが、オブジェクトをシリアライズ（文字列化)するのに、マークアップ言語であるXMLを使うのはキモい
ということで「Java Scriptオブジェクトの内部表記方法を使おう！」というのがJSON
Java Scriptでは、以下のようにオブジェクトを定義することが出来る。
```
 var obj =
  {
  “key1” : “val1” ,
  “key2” : { “key21” : “val21” , “key22” : “val22” } ,
  “key3” : [ “val31” , “val32” , “val33” ]
  }
```
この表記法を多言語間のオブジェクトのやりとりに使うのが、JSON = Java Script Object Notation

↑

JSON RPC JAVA ORB とは？ †

ClientサイドにあるJava Scriptから、ServerサイドのJavaオブジェクトを呼び出す方法
- RPC(Remote Procedure Call)
  - 異なるマシンに処理を依頼すること
- ORB(Object Request Broker)
  - CORBAで出てきた概念。異なるマシン上に分散して存在するオブジェクトに処理を依頼する仕組み。
- JSON RPC JAVA ORB
  - ClientサイドからJSON RPC BridgeにJava Script Objectで処理を依頼すると、ServerサイドでJava Classが呼ばれる。
  - 勝手にJava Script ObjectとJava Objectを変換してくれるのでユーザプログラムからは特に意識する必要はない。
もうちょっと詳しく言うと

↑

JSONのインストール †

JSON-RPC-Java-ORB公式サイトから、json-rpc-java-1.0rc2.zip をダウンロードして展開します。
Eclipse Sysdeo で、Tomcatプロジェクトを作成します。
JSON-RPC-Java-ORBをTomcatプロジェクトに配置します。
- jsonrpc.jar を ${Context Root}\WEB-INF\lib に配置します。
- jsonrpc.js を ${Context Root} に配置します。

web.xmlの作成
JSONPRCServletをWebアプリに登録します。

<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
  <servlet>
    <servlet-name>com.metaparadigm.jsonrpc.JSONRPCServlet</servlet-name>
    <servlet-class>com.metaparadigm.jsonrpc.JSONRPCServlet</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>com.metaparadigm.jsonrpc.JSONRPCServlet</servlet-name>
    <url-pattern>/JSON-RPC</url-pattern>
  </servlet-mapping>
</web-app>

↑

JSONサンプルプログラム †

JSON-RPC-JAVA-ORB のほとんどの機能を検証できる練習プログラムを作りました。

作成したプログラムは、「JSONのインストール」のスクリーンショットにあるように、 HelloJSON.jsp、HelloJSON.java及び、ExampleBean?.javaのみです。
- HelloJSON.jsp、HelloJSON.javaについては以下の章で説明します。
- ExampleBean?.java は、下記のような単純なBeanです。
```
 public final class ExampleBean implements Serializable{
   
   private static final long serialVersionUID = -8306703160077279386L; 
 
   private ExampleBean father;
   private ExampleBean mother;
 
   private String name;
   private int age;
 
 …(以下 setter/getter )…
 
 }
```
ソースコードは、JSONExam.war。

↑

JSON Bridgeの初期化 †

最初に、JSON Bridgeを初期化して、クライアント(Webブラウザ)とサーバ(J2EEコンテナ)で通信が出来るようにします。

(HelloJSON.jsp)

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  "http://www.w3.org/TR/html4/loose.dtd">
 
 <jsp:useBean id="JSONRPCBridge" scope="session"
      class="com.metaparadigm.jsonrpc.JSONRPCBridge" />
 <% JSONRPCBridge.registerObject("hello", new com.snail.web.json.HelloJSON() ); %>
 
 <html>
 <head>
 
 <title>JSON-RPC-Java Hello</title>
 <script type="text/javascript" src="jsonrpc.js"></script>
 <script language="javascript">
 <!--
 function init(){
   jsonrpc = new JSONRpcClient("JSON-RPC");
 }
 …(その他のJavascriptプログラム)…
 
 //-->
 </script>
 
 </head>
 <body bgcolor="#ffffff" onLoad="init();">
 
 <h2>JSON-RPC-Java Examinations</h2>
 
 …(HTML)…
 
 </body>
 </html>

サーバ側での動作
- Sessionに、JSONRPCBridgeを登録し、そこにサーバ側で動作するJavaオブジェクトを登録します。
クライアント側での動作
- Webページの、onLoadイベントで JSONRpcClient? を初期化します。
- 以降、JSONRpcClient? を通じてJava Script側から、JSONRPCBridgeに登録したJavaオブジェクト(ここでは com.snail.web.json.HelloJSON )を呼び出す事が出来ます。

↑

Hello JSON †

機能
とりあえず、クライアント側から文字列を送って、サーバ側から戻ってきた文字列を表示するプログラムです。
- 実行画面
- 実行結果

サーバプログラム(HelloJSON.java)

  public String sayHello(String name) {
    return "Hello " + name + "!";
  }

クライアントプログラム(HelloJSON.jsp)

 function clickHello(){
   var whoNode = document.getElementById("who");
   var result = jsonrpc.hello.sayHello(whoNode.value);
   alert("The server replied: " + result);
 }

↑

いろいろな引数でJSON Bridgeを呼び出す †

Mapを送る

機能
- 実行画面
- 実行結果

サーバプログラム(HelloJSON.java)

  public String setMap(Map map) {
    String name = (String) map.get("Name");
    String age = (String) map.get("Age");
    String father = (String) map.get("Father");
    String mother = (String) map.get("Mother");
 
    return name + " is " + age + " years old. His father is " + father
        + " and mother is " + mother + ".";
  }

クライアントプログラム(HelloJSON.jsp)

 function clickSendMap(){
   try{
    var age    = document.getElementById("age").value;
    var name   = document.getElementById("name").value;
    var father = document.getElementById("father").value;
    var mother = document.getElementById("mother").value;
    
    var jsonMsg = 
      {"javaClass" : "java.util.HashMap",
       "map": {"Age": age, "Name": name, "Father": father, "Mother": mother} 
      };
    
    alert( jsonrpc.hello.setMap(jsonMsg) );
   }catch(e){
     alert(e);
   }
 }

Beanを送る

機能
- 実行画面
- 実行結果

サーバプログラム(HelloJSON.java)

  public String setBean(ExampleBean bean) {
    String name = bean.getName();
    int age = bean.getAge();
    String mother = bean.getMother().getName();
 
    return mother + " brought " + name + " into the world " + age
        + " years ago.";
  }

クライアントプログラム(HelloJSON.jsp)

 function clickSendBean(){
   try{
    var age    = document.getElementById("age").value;
    var name   = document.getElementById("name").value;
    var father = document.getElementById("father").value;
    var mother = document.getElementById("mother").value;
 
    var jsonMsg = 
       {"javaClass": "com.snail.web.json.ExampleBean",
        "age": age, 
        "name": name,       
        "father": 
          {"javaClass": "com.snail.web.json.ExampleBean",
           "name": father},
        "mother": 
          {"javaClass": "com.snail.web.json.ExampleBean",
           "name": mother}
       };
 
    alert( jsonrpc.hello.setBean(jsonMsg) );
   }catch(e){
     alert(e);
   }
 }

Listを送る

機能
- 実行画面
- 実行結果

サーバプログラム(HelloJSON.java)

  public String setList(List list) {
    return "Argument List is" + list;
  }

クライアントプログラム(HelloJSON.jsp)

 function clickSendList(){
   try{
    var age    = document.getElementById("age").value;
    var name   = document.getElementById("name").value;
    var father = document.getElementById("father").value;
    var mother = document.getElementById("mother").value;
 
    var jsonMsg = 
       {"javaClass": "java.util.LinkedList",
        "list": [age,name,father,mother] };
 
    alert( jsonrpc.hello.setList(jsonMsg) );
   }catch(e){
     alert(e);
   }
 }

↑

いろいろな返値をJSON Bridgeから受け取る †

Mapを受け取る

機能
- 実行画面
- どうやらLinkedHashMap?を使っても、要素の順番は保存されない模様

サーバプログラム(HelloJSON.java)

   public Map sayMap() {
     Map<String, String> m = new LinkedHashMap<String, String>();
     m.put("FirstElement", "Enterprise");
     m.put("SecondElement", "Constitution");
     m.put("ThirdElement", "Yamato");
     m.put("FourthElement", "Melbourne");
 
     return m;
   }

クライアントプログラム(HelloJSON.jsp)

 function clickGetMap(){
    var ret = jsonrpc.hello.sayMap();
    document.getElementById("jsonMsg").innerHTML=toJSON(ret);
    document.getElementById("javaClass").innerHTML=ret.javaClass;
    document.getElementById("obj").innerHTML=
      "FirstElement= " + ret.map.FirstElement  + ", " +
      "SecondElement=" + ret.map.SecondElement + ", " +
      "ThirdElement= " + ret.map.ThirdElement  + ", " +
      "ForuthElement=" + ret.map.FourthElement;
 }

Beanを受け取る

機能
- 実行画面

サーバプログラム(HelloJSON.java)

   public ExampleBean sayBean() {
     ExampleBean father = new ExampleBean();
     father.setName("Bob");
     father.setAge(34);
 
     ExampleBean mother = new ExampleBean();
     mother.setName("Alice");
     mother.setAge(32);
 
     ExampleBean me = new ExampleBean();
     me.setName("Kent");
     me.setAge(5);
     me.setFather(father);
     me.setMother(mother);
 
     return me;
   }

クライアントプログラム(HelloJSON.jsp)

 function clickGetBean(){
    var ret = jsonrpc.hello.sayBean();
    document.getElementById("jsonMsg").innerHTML=toJSON(ret);
    document.getElementById("javaClass").innerHTML=ret.javaClass;
    document.getElementById("obj").innerHTML=
     "Name = "  + ret.name + ", " +
     "Age ="    + ret.age  + ", " +
     "Father= " + ret.father.name  + ", " +
     "Mother="  + ret.mother.name;
 }

Listを受け取る

機能
- 実行画面

サーバプログラム(HelloJSON.java)

   public List sayList() {
     List<String> list = new LinkedList<String>();
 
     list.add("linux");
     list.add("apache");
     list.add("php");
     list.add("mysql");
 
     return list;
   }

クライアントプログラム(HelloJSON.jsp)

 function clickGetList(){
    var ret = jsonrpc.hello.sayList();
    document.getElementById("jsonMsg").innerHTML=toJSON(ret);
    document.getElementById("javaClass").innerHTML=ret.javaClass;
    
    var str = "";
    for( cnt = 0 ; cnt < ret.list.length ; cnt++ ){
      str = str + cnt + " " + ret.list[ cnt ] + ", ";
    }
    document.getElementById("obj").innerHTML=str;
 }

↑

JSON Bridgeによる例外の搬送 †

機能
- 実行画面

サーバプログラム(HelloJSON.java)

   public String sayErrId() throws Exception {
     throw new Exception("ERR01");
   }

クライアントプログラム(HelloJSON.jsp)

 function clickErrMsg(){
  try{
    jsonrpc.hello.sayErrId();
  }catch(e){
    document.getElementById("eName").innerHTML=e.name;
    document.getElementById("eCode").innerHTML=e.code;
    document.getElementById("eMsg").innerHTML=e.message;
    document.getElementById("eStack").innerHTML=e.javaStack;
  }
 }

JSON例外について
- JSONの例外は、e.name、e.code、e.message、e.javaStack を含む
- codeからは以下のようなシステム的な障害状況を判断することが出来る
```
JSONRpcClient.Exception.CODE_ERR_PARSE = 590 
JSONRpcClient.Exception.CODE_ERR_NOMETHOD = 591 
JSONRpcClient.Exception.CODE_ERR_UNMARSHALL = 592 
JSONRpcClient.Exception.CODE_ERR_MARSHALL = 593
```
- ユーザプログラムから業務的な例外を搬送したいときには、
  Java側では、
```
throw new Exception("エラーコード文字列");
```
  を使い、Java Script側では e.message で "エラーコード文字列" を受け取るようにするのが吉。

↑

その他の機能 †

Staticメソッドしかないんですけど・・・

 <jsp:useBean id="JSONRPCBridge" scope="session"
      class="com.metaparadigm.jsonrpc.JSONRPCBridge" />
 <% JSONRPCBridge.registerClass("myClass", myClass); %>

registerObject() の代わりに registreClass() を使う

特にユーザ別にJavaユーザプログラムを分ける必要がないとき

 <% JSONRPCBridge.getGlobalBridge().registerObject("myObject", myObject); %>
 <% JSONRPCBridge.getGlobalBridge().registerClass("myClass", myClass); %>

getGloablBridge?() で Singleton が得られる。

Basic認証を通じてJSON RPC Servletを呼び出す
```
 var jsonrpc = new JSONRpcClient("JSON-RPC", user, pass)
```
Java Script で、JSONRPCClient を初期化する際にユーザ名とパスワードを第二引数、第三引数にいれる

非同期呼び出し
JSONBridgeを呼び出す際に、第一引数に非同期呼び出し完了時にCall Backされる関数をいれる。Call Backされる関数の第一引数は返値、第二引数は例外。

同期呼び出し版

 function clickHello(){
   var whoNode = document.getElementById("who");
   var result = jsonrpc.hello.sayHello(whoNode.value);
   alert( 'Synchronous Call Result :' + result);
 }

非同期呼び出し版

 function clickHello(){
   var whoNode = document.getElementById("who");
   jsonrpc.hello.sayHello(cb, whoNode.value);
   alert( 'Called Remote Procedure Asynchronously' );
 }
 function cb(result, exception) {
   if( exception ){
     // exception != null
     alert( 'Asynchronous Call Failed :' + exception );
     return;
   }
   
   alert( 'Asynchronous Call Result :' + result );
 }

↑

参考文献 †

JavaScript?++かも日記, http://jsgt.org/mt/01/
[翻訳]JSON入門, http://d.hatena.ne.jp/brazil/20050915/1126709945
JSON-RPC-Java, http://oss.metaparadigm.com/jsonrpc/

Java#AJAX

AJAX JSON RPC JAVA ORB

目次

訪問者

更新

最新の10件

人気の10件

MenuBar

JSONとは？ †

JSON RPC JAVA ORB とは？ †

JSONのインストール †

JSONサンプルプログラム †

JSON Bridgeの初期化 †

Hello JSON †

いろいろな引数でJSON Bridgeを呼び出す †

いろいろな返値をJSON Bridgeから受け取る †

JSON Bridgeによる例外の搬送 †

その他の機能 †

参考文献 †