一.JSON-RPC-Java简介
JSON-RPC-Java是一个用Java来实现动态JSON-RPC的框架. 利用它内置的一个轻级量JSON-RPC JavaScripIt客户端,可以让你透明地在JavaScript中调用Java代码。JSON-RPC-Java可运行在Servlet容器中如Tomcat也可以运行在JBoss与其它J2EE应用服务器中因此可以在一个基于JavaScript与DHTML的Web应用程序中利用它来直接调用普通Java方法与EJB方法。我们可以很方便的使用JSON-RPC-Java来开发我的们Ajax应用。
二.JSON-RPC-Java实践
1.从http://oss.metaparadigm.com/jsonrpc/download.html下载最新稳定版的JSON-RPC-Java框架并解压。新建一个JavaWeb工程，将jsonrpc-1.0.jar放到/webroot/WEB-INF/lib目录下，将jsonrpc.js放在/webroot下的任意目录下,保证在jsp页面可以引用即可。
2.修改/webroot/WEB-INF/web.xml文件，添加以下代码：
<?xml version="1.0" encoding="UTF-8"?> <web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <servlet> <servlet-name>JSONRPCServlet</servlet-name> <servlet-class> com.metaparadigm.jsonrpc.JSONRPCServlet </servlet-class> </servlet> <servlet-mapping> <servlet-name>JSONRPCServlet</servlet-name> <url-pattern>/JSON-RPC</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>json.jsp</welcome-file> </welcome-file-list> </web-app>
当然这里代码不一定要和上面一模一样，有一点基础即可看出这里只是添加了一个Servlet配置而，只要符合Servlet的配置规则即可。
3.编写Java文件
Example.java 此文件提供各种业务操作,此方件编写没有什么特别的要求。但为了在JSP页面用标签，我们最好提供一个无参的构造方法。
package com.bijian.study;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
public class Example implements Serializable {
private final static long serialVersionUID = 1L;
public String sayString(String name) {
return "Hello " + name + "!";
}
public List sayList(List list) {
list.add(new Integer(6));
return list;
}
public Map sayMap(Map map) {
map.put("age", "23");
return map;
}
public Set saySet(Set set) {
set.add("sex");
return set;
}
public User sayUser(User user) {
user.setAge(25);
return user;
}
public String putSession(String name, HttpServletRequest request) {
HttpSession session = request.getSession();
session.setAttribute("name", name);
return session.getAttribute("name").toString();
}
}User.java 此文件用于自定义数据类型传输数。要求是一个javabean，即要为每一个属性提供set和get方法，还有一个无参的构方法即可。
package com.bijian.study;
import java.io.Serializable;
public class User implements Serializable {
private String name;
private int age;
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
4.编写javascript文件
Example.js 用于此处理客户端操作。
//The javascript file of the JSON-RPC-Java example application.
var jsonrpc = null;
//初始化JSONRpcClient对象
function onLoad() {
jsonrpc = new JSONRpcClient("JSON-RPC");
}
//提交普通的字符串对象
function sayString() {
var who = document.getElementById("who");
var result = jsonrpc.example.sayString(cbString, who.value);
}
function cbString(result, exception) {
if (exception == null) {
document.getElementById("say").innerHTML = "<em>操作提示：提交一个字符串并返回.</em><h2>" + result + "</h2><hr/>";
} else {
alert(exception.message);
}
}
//提交一个list对象并且将其返回
function sayList() {
var list = {"javaClass":"java.util.ArrayList", "list":[1, 2, 3]};
jsonrpc.example.sayList(cbList, list);
}
function cbList(result, exception) {
if (exception == null) {
var list = result.list;
var str = "<em>操作提示：提交一个List并返回.</em>";
for (var value in list) {
str += "<h2>list[" + value + "]=" + list[value] + "</h2><hr/>";
}
document.getElementById("say").innerHTML = str;
//"list"可以直接用下面的语句输出
//document.getElementById("say").innerHTML = "<h2>" + list + "</h2>";
} else {
alert(exception.message);
}
}
//提交一个map对象并且将其返回
function sayMap() {
var map = {"javaClass":"java.util.HashMap", "map":{"name":"bijian", "sex":"男"}};
jsonrpc.example.sayMap(cbMap, map);
}
function cbMap(result, exception) {
if (exception == null) {
var map = result.map;
var str = "<em>操作提示：提交一个Map并返回.</em>";
for (var key in map) {
str += "<h2>" + key + ":" + map[key] + "</h2><hr/>";
}
document.getElementById("say").innerHTML = str;
} else {
alert(exception.message);
}
}
//提交一个set对象并且将其返回
function saySet() {
//set属性是一个数组对象,每个数组元素就是set里的一个元素.
var set = {"javaClass":"java.util.HashSet", "set":{"name":"bijian"}};
jsonrpc.example.saySet(cbSet, set);
}
function cbSet(result, exception) {
if (exception == null) {
var set = result.set;
var str = "<em>操作提示：提交一个Set并返回.</em>";
for (var value in set) {
str += "<h2>" + value + "</h2><hr/>";
}
document.getElementById("say").innerHTML = str;
} else {
alert(exception.message);
}
}
//提交一个自定义的User对象并且将其返回
function sayUser() {
//每个JSON对象属性对应一个User对象属性.
var user = {"javaClass":"com.bijian.study.User", "name":"bijian", "age":23};
jsonrpc.example.sayUser(cbUser, user);
}
function cbUser(user, exception) {
if (exception == null) {
var str = "<em>操作提示：提交一个自定义的User对象并返回.</em><h2>name:" + user.name + "</h2><hr/>" + "<h2>age:" + user.age + "</h2><hr/>";
document.getElementById("say").innerHTML = str;
} else {
alert(exception.message);
}
}
//提交一个字符串将字符串放到"session"中再返回
function putSession() {
var who = document.getElementById("who");
var result = jsonrpc.example.putSession(cbSession, who.value);
}
function cbSession(result, exception) {
if (exception == null) {
document.getElementById("say").innerHTML = "<em>操作提示：提交一个字符串将字符串放到\"session\"中再返回.</em><h2>name:" + result + "</h2><hr/>";
} else {
alert(exception.message);
}
}
此文件中的jsonrpc.hello.say*()方法即是在Example.java中定义的。
5.编写jsp页面
json.jsp这个文件做什么不用说了吧，当然给用户一个操作的界面了。
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<%@ page contentType="text/html; charset=UTF-8"%>
<jsp:useBean id="JSONRPCBridge" scope="session"
class="com.metaparadigm.jsonrpc.JSONRPCBridge" />
<jsp:useBean id="example" scope="session"
class="com.bijian.study.Example" />
<%
JSONRPCBridge.registerObject("example", example);
%>
<html>
<head>
<title>JSON-RPC-Java Example</title>
<script type="text/javascript" src="example.js"></script>
<script type="text/javascript" src="jsonrpc.js"></script>
</head>
<style>
em {
color: red;
}
</style>
<body bgcolor="#ffffff" onLoad="onLoad()">
<center>
<h2>
<em>
<u>JSON-RPC-Java Example by <a href="http://bijian1013.iteye.com/" target='_blank'">bijian1013</a></u>
</em>
</h2>
<p>
The JSON-RPC-Java <em>Example</em> application.
</p>
<p>
<strong>Who:</strong> <input type="text" id="who" size="30" value="bijian" />
<br/><br/>
<input type="button" value="Say String" onclick="sayString()" />
<input type="button" value="Say List" onclick="sayList()" />
<input type="button" value="Say Map" onclick="sayMap()" />
<input type="button" value="Say Set" onclick="saySet()" />
<input type="button" value="Say User" onclick="sayUser()" />
<input type="button" value="Put Session" onclick="putSession()" />
<hr />
</p>
<div id="say" style="width: 520px">
<em>返回值显示区域。</em>
<hr />
</div>
</center>
</body>
</html>
6.运行效果
将其加至Tomcat服务器运行。
点击“Say List”按钮，运行效果如下所示。
json-rpc官方网站：http://www.json-rpc.org/