在java中"模拟" XMLHttpRequest

关键字: java, ajax, xmlhttprequest
这里所说的"模拟" 是指 : 在java中,使用类似 XMLHttpRequest 的方式来实现"同步/异步的HttpRequest"功能.


  用 java 实现一个HTTPRequest 并不难. 通过 java.net 包内提供的东东 可以很容易的实现.
  而且我们还有 apache 的 HttpClient 一类的组件可供我们使用 .
  实现 异步的HTTPRequest 当然同样简单 , 再使用一个 Thread就ok了.
  但是 使用上面的 方法 , 实现的往往只是一个 "异步的HTTPRequest"的功能而已,
  使用方式上 还是 很 java的.
 
我在这里所要介绍的 则是使用很"ajax"的方式来实现"异步的HTTPRequest"的功能.
这个 AjaxHttpRequest 类  模仿了 XMLHttpRequest 的实现,
从属性 方法 使用方式上 都尽量的和 XMLHttpRequest 接近.

利用 AjaxHttpRequest 类 可以更自然的实现 ajax请求的服务端代理 等工作.

=============================

当然 本文的技术研究的价值 也许远远大于 实用的价值. :P .


我先来举一个例子 ,  AjaxHttpRequest 类的代码&注释 在后面附上 附件中也会提供该java文件.

大家注意看代码注释 ,我要说的东西更多的都在注释里呢.

一个 用 java 来调用 google 翻译服务的例子 (利用了后面附上的 AjaxHttpRequest 类) :

Java代码
  1. /**  
  2.  * 利用这个AjaxHttpReuqest类来实现 对google translate服务的访问 .  
  3.  * 只演示了 "英-->汉"的翻译.  
  4.  * 返回的是JSON字符串,需要使用Json工具类进行转换,这个不难 就不详细举例了.  
  5.  */  
  6. public static void testGoogleTranslate(String words,boolean async) throws IOException {   
  7.     Map params=new HashMap();   
  8.     params.put("q",words);   
  9.     params.put("v","1.0");   
  10.     params.put("langpair","en|zh-CN");   
  11.     String url="http://ajax.googleapis.com/ajax/services/language/translate";   
  12.        
  13.     // 以上为 调用google翻译服务所需要的参数.   
  14.     // 下面 是用java 来调用这个 翻译服务.   
  15.     // 在 AjaxHttpRequest 类的 帮助下 我们可以使用 类似操作浏览器XHR对象的方式来 实现该功能.   
  16.   
  17.        
  18.     // 创建 AjaxHttpRequest对象 相当于 创建 XHR对象.   
  19.     // 这里的final 主要是为了"使监听器内部能够调用ajax对象"而加的.   
  20.     final AjaxHttpRequest ajax=new AjaxHttpRequest();   
  21.        
  22.     // 设置状态监听器,类似 XHR对象的 onreadystatechange 属性.   
  23.     // 由于js 和java的本质区别 导致这里可能和 xhr有点不一样,但是应该不难理解.   
  24.     ajax.setReadyStateChangeListener(   
  25.             // 监听器, 根据需求 实现onReadyStateChange方法即可.   
  26.             new AjaxHttpRequest.ReadyStateChangeListener(){   
  27.                     public void onReadyStateChange() {   
  28.                         int readyState = ajax.getReadyState();   
  29.                         //判断状态 然后做出相应处理.   
  30.                         if (readyState==AjaxHttpRequest.STATE_COMPLETE){   
  31.                             System.out.println( ajax.getResponseText() );   
  32.                         }   
  33.                     }              
  34.             }   
  35.     );   
  36.        
  37.     // 这里就和 xhr 几乎完全一样了   
  38.     ajax.open("POST", url, true);   
  39.        
  40.     //这里这个send方法接受的参数是一个map ,当然AjaxHttpRequest类也提供了string的方法   
  41.     ajax.send(params);   
  42.   
  43. }  
	/**
	 * 利用这个AjaxHttpReuqest类来实现 对google translate服务的访问 .
	 * 只演示了 "英-->汉"的翻译.
	 * 返回的是JSON字符串,需要使用Json工具类进行转换,这个不难 就不详细举例了.
	 */
	public static void testGoogleTranslate(String words,boolean async) throws IOException {
		Map params=new HashMap();
		params.put("q",words);
		params.put("v","1.0");
		params.put("langpair","en|zh-CN");
		String url="http://ajax.googleapis.com/ajax/services/language/translate";
		
		// 以上为 调用google翻译服务所需要的参数.
		// 下面 是用java 来调用这个 翻译服务.
		// 在 AjaxHttpRequest 类的 帮助下 我们可以使用 类似操作浏览器XHR对象的方式来 实现该功能.
	
		
		// 创建 AjaxHttpRequest对象 相当于 创建 XHR对象.
		// 这里的final 主要是为了"使监听器内部能够调用ajax对象"而加的.
		final AjaxHttpRequest ajax=new AjaxHttpRequest();
		
		// 设置状态监听器,类似 XHR对象的 onreadystatechange 属性.
		// 由于js 和java的本质区别 导致这里可能和 xhr有点不一样,但是应该不难理解.
		ajax.setReadyStateChangeListener(
				// 监听器, 根据需求 实现onReadyStateChange方法即可.
				new AjaxHttpRequest.ReadyStateChangeListener(){
						public void onReadyStateChange() {
							int readyState = ajax.getReadyState();
							//判断状态 然后做出相应处理.
							if (readyState==AjaxHttpRequest.STATE_COMPLETE){
								System.out.println( ajax.getResponseText() );
							}
						}			
				}
		);
		
		// 这里就和 xhr 几乎完全一样了
		ajax.open("POST", url, true);
		
		//这里这个send方法接受的参数是一个map ,当然AjaxHttpRequest类也提供了string的方法
		ajax.send(params);

	}


有了上面的功能 当页面中要使用google的翻译服务时 就不用在引入google的那些js了.
也不用担心 客户端无法访问google的情况了.



下面附上 AjaxHttpRequest类 的完整代码 ( 附件中有下载 )

Java代码
  1. package com.fins.gt.server;   
  2.   
  3. import java.io.IOException;   
  4. import java.io.InputStream;   
  5. import java.io.OutputStream;   
  6. import java.io.UnsupportedEncodingException;   
  7. import java.net.HttpURLConnection;   
  8. import java.net.MalformedURLException;   
  9. import java.net.Proxy;   
  10. import java.net.URL;   
  11. import java.net.URLConnection;   
  12. import java.net.URLEncoder;   
  13. import java.util.HashMap;   
  14. import java.util.Iterator;   
  15. import java.util.LinkedHashMap;   
  16. import java.util.Map;   
  17. import java.util.StringTokenizer;   
  18. import java.util.logging.Level;   
  19.   
  20.            
  21. /**  
  22.  * AjaxHttpRequest ,用java 模拟 浏览器的 XMLHttpRequest 对象.  
  23.  * 目的是 用 操作浏览器中的XHR对象的 方式来处理java端的 http请求.  
  24.  *   
  25.  * @author fins  
  26.  *   
  27.  * 本类的实现借鉴了 cobra 组件的 org.lobobrowser.html.test.SimpleHttpRequest 类.  
  28.  * 可以看作是对 SimpleHttpRequest 类的一个完善和补充.  
  29.  *   
  30.  * cobra 组件是一个 Java HTML Renderer & Parser,  
  31.  * 官方网站 : http://lobobrowser.org/cobra.jsp  
  32.  */  
  33.   
  34. public class AjaxHttpRequest {   
  35.   
  36.     // 对应 XMLHttpRequest 的5种状态.   
  37.     public static final int STATE_UNINITIALIZED = 0;   
  38.     public static final int STATE_LOADING = 1;   
  39.     public static final int STATE_LOADED = 2;   
  40.     public static final int STATE_INTERACTIVE = 3;   
  41.     public static final int STATE_COMPLETE = 4;   
  42.   
  43.     // 默认的 userAgent    
  44.     public static final String DEFAULT_USERAGENT = "Mozilla/4.0 (compatible; MSIE 6.0;) JavaAjax/1.0";   
  45.   
  46.     // 默认的 编码    
  47.     public static final String DEFAULT_AJAX_CHARSET = "UTF-8";   
  48.     public static final String DEFAULT_HTTP_CHARSET = "ISO-8859-1";   
  49.        
  50.     // 默认的 HTTP method   
  51.     public static final String DEFAULT_REQUEST_METHOD = "POST";   
  52.   
  53.     private int readyState;   
  54.     private int status;   
  55.     private String statusText;   
  56.     private String responseHeaders;   
  57.     private byte[] responseBytes;   
  58.     private Map responseHeadersMap;   
  59.     private Map requestHeadersMap;   
  60.     private ReadyStateChangeListener readyStateChangeListener;   
  61.   
  62.     private boolean async;   
  63.     private boolean sent;   
  64.     private URLConnection connection;   
  65.     private String userAgent = DEFAULT_USERAGENT;   
  66.     private String postCharset = DEFAULT_AJAX_CHARSET;   
  67.     private Proxy proxy;   
  68.        
  69.     private URL requestURL;   
  70.     protected String requestMethod;   
  71.     protected String requestUserName;   
  72.     protected String requestPassword;   
  73.   
  74. /   
  75. /   
  76.   
  77.        
  78.     /**  
  79.      * 构造方法. 自动添加 XMLHttpRequest 的一些缺省头信息.  
  80.      * 如果不需要这些头信息,可在创建 AjaxHttpRequest 实例后,  
  81.      * 通过 setRequestHeader/removeRequestHeader/removeAllRequestHeaders 方法  
  82.      * 进行修改或移除.   
  83.      */  
  84.     public AjaxHttpRequest() {   
  85.         requestHeadersMap = new LinkedHashMap();   
  86.         setRequestHeader("X-Requested-With""XMLHttpRequest");   
  87.         setRequestHeader("Accept",   
  88.                 "text/javascript, text/html, application/xml, application/json, text/xml, */*");   
  89.     }   
  90.   
  91.     /**   
  92.      * 类似 XMLHttpRequest 中的 readyState 属性.   
  93.      */   
  94.     public synchronized int getReadyState() {   
  95.         return this.readyState;   
  96.     }   
  97.   
  98.     /**  
  99.      * 类似 XMLHttpRequest 中的 status 属性.  
  100.      */  
  101.     public synchronized int getStatus() {   
  102.         return this.status;   
  103.     }   
  104.   
  105.     /**  
  106.      * 类似 XMLHttpRequest 中的 statusText 属性.  
  107.      */  
  108.     public synchronized String getStatusText() {   
  109.         return this.statusText;   
  110.     }   
  111.        
  112.     /**  
  113.      * 类似 XMLHttpRequest 中的 setRequestHeader 方法.  
  114.      */  
  115.     public void setRequestHeader(String key, String value) {   
  116.         this.requestHeadersMap.put(key, value);   
  117.     }   
  118.        
  119.     /**  
  120.      * 类似 XMLHttpRequest 中的 open 方法.  
  121.      */  
  122.     public void open(String method, String url, boolean async, String userName, String password)   
  123.             throws IOException {   
  124.         URL urlObj = createURL(null, url);   
  125.         open(method, urlObj, async, userName, password);   
  126.     }   
  127.   
  128.        
  129.     /**  
  130.      * 类似 XMLHttpRequest 中的 open 方法.  
  131.      */  
  132.     public void open(final String method, final URL url, boolean async, final String userName,   
  133.             final String password) throws IOException {   
  134.         this.abort();   
  135.         Proxy proxy = this.proxy;   
  136.         URLConnection c = proxy == null || proxy == Proxy.NO_PROXY ? url.openConnection() : url   
  137.                 .openConnection(proxy);   
  138.         synchronized (this) {   
  139.             this.connection = c;   
  140.             this.async = async;   
  141.             this.requestMethod = method;   
  142.             this.requestURL = url;   
  143.             this.requestUserName = userName;   
  144.             this.requestPassword = password;   
  145.         }   
  146.         this.changeState(AjaxHttpRequest.STATE_LOADING, 0nullnull);   
  147.     }   
  148.   
  149.   
  150.     /**  
  151.      * 类似 XMLHttpRequest 中的 open 方法.  
  152.      * 省略部分参数的形式.  
  153.      */  
  154.     public void open(String url, boolean async) throws IOException {   
  155.         open(DEFAULT_REQUEST_METHOD, url, async, nullnull);   
  156.     }   
  157.        
  158.     /**  
  159.      * 类似 XMLHttpRequest 中的 open 方法.  
  160.      * 省略部分参数的形式.  
  161.      */  
  162.     public void open(String method, String url, boolean async) throws IOException {   
  163.         open(method, url, async, nullnull);   
  164.     }   
  165.        
  166.   
  167.     /**  
  168.      * 类似 XMLHttpRequest 中的 send 方法.  
  169.      * 支持发送 key-value 形式的数据集合(Map).  
  170.      * 传入map参数, 自动转换成string形式 并调用 send(String) 方法发送.  
  171.      */    
  172.     public void send(Map parameters) throws IOException {   
  173.         Iterator keyItr=parameters.keySet().iterator();   
  174.         StringBuffer strb=new StringBuffer();   
  175.         while (keyItr.hasNext()){   
  176.             Object key = keyItr.next();   
  177.             String keyStr = encode(key);   
  178.             String valueStr = encode(parameters.get(key));   
  179.             strb.append(keyStr).append("=").append(valueStr);   
  180.             strb.append("&");   
  181.         }   
  182.         send(strb.toString());   
  183.     }   
  184.        
  185.     /**  
  186.      * 类似 XMLHttpRequest 中的 send 方法.  
  187.      */  
  188.     public void send(final String content) throws IOException {   
  189.         final URL url = this.requestURL;   
  190.         if (url == null) {   
  191.             throw new IOException("No URL has been provided.");   
  192.         }   
  193.         if (this.isAsync()) {   
  194.             new Thread("AjaxHttpRequest-" + url.getHost()) {   
  195.                 public void run() {   
  196.                     try {   
  197.                         sendSync(content);   
  198.                     } catch (Throwable thrown) {   
  199.                         log(Level.WARNING, "send(): Error in asynchronous request on " + url, thrown);   
  200.                     }   
  201.                 }   
  202.             }.start();   
  203.         } else {   
  204.             sendSync(content);   
  205.         }   
  206.     }   
  207.        
  208.     /**  
  209.      * 类似 XMLHttpRequest 中的 getResponseHeader 方法.  
  210.      */  
  211.     public synchronized String getResponseHeader(String headerName) {   
  212.         return this.responseHeadersMap == null ? null : (String) this.responseHeadersMap.get(headerName);   
  213.     }   
  214.        
  215.     /**  
  216.      * 类似 XMLHttpRequest 中的 getAllResponseHeaders 方法.  
  217.      */  
  218.     public synchronized String getAllResponseHeaders() {   
  219.         return this.responseHeaders;   
  220.     }   
  221.        
  222.        
  223.     /**  
  224.      * 类似 XMLHttpRequest 中的 responseText 属性.  
  225.      */  
  226.     public synchronized String getResponseText() {   
  227.         byte[] bytes = this.responseBytes;   
  228.         String encoding = getCharset(this.connection);   
  229.         if (encoding==null){   
  230.             encoding=getPostCharset();   
  231.         }   
  232.         if (encoding == null) {   
  233.             encoding = DEFAULT_HTTP_CHARSET;   
  234.         }   
  235.         try {   
  236.             return bytes == null ? null : new String(bytes, encoding);   
  237.         } catch (UnsupportedEncodingException uee) {   
  238.             log(Level.WARNING, "getResponseText(): Charset '" + encoding + "' did not work. Retrying with "  
  239.                     + DEFAULT_HTTP_CHARSET + ".", uee);   
  240.             try {   
  241.                 return new String(bytes, DEFAULT_HTTP_CHARSET);   
  242.             } catch (UnsupportedEncodingException uee2) {   
  243.                 // Ignore this time   
  244.                 return null;   
  245.             }   
  246.         }   
  247.     }   
  248.   
  249.     /**  
  250.      * 类似 XMLHttpRequest 中的 responseXML 属性.  
  251.      * TODO : 此方法在java中 并不常使用, 而且需要两个额外的包,两个包不是所有的java环境都有的.  
  252.      *   所以我(fins)把此方法注释条了.   
  253.      *   如果确实需要此方法 请自行取消该方法的注释,并引入下面列出的类/接口.  
  254.      *     javax.xml.parsers.DocumentBuilderFactory;  
  255.      *     org.w3c.dom.Document;  
  256.      */  
  257. //        public synchronized Document getResponseXML() {    
  258. //            byte[] bytes =  this.responseBytes;    
  259. //            if (bytes == null) {    
  260. //                return null;    
  261. //            }    
  262. //            InputStream in =  new ByteArrayInputStream(bytes);    
  263. //            try {    
  264. //                return DocumentBuilderFactory.newInstance().newDocumentBuilder() .parse(in);    
  265. //            }catch (Exception err) {    
  266. //                log(Level.WARNING,  "Unable to parse response as XML.", err); return null;   
  267. //            }   
  268. //       }   
  269.        
  270.        
  271.     /**  
  272.      * 类似 XMLHttpRequest 中的 responseBody 属性.  
  273.      * @deprecated 这个方法命名源自XMLHttpRequest中的responseBody属性.  
  274.      * 不过这个名字并不是好名字.建议使用 getResponseBytes 方法代替之.  
  275.      */  
  276.     public synchronized byte[] getResponseBody() {   
  277.         return this.getResponseBytes();   
  278.     }   
  279.        
  280.     /**  
  281.      * 类似 XMLHttpRequest 中的 responseBody 属性.  
  282.      * 建议使用此方法代替 getResponseBody 方法.  
  283.      */  
  284.     public synchronized byte[] getResponseBytes() {   
  285.         return this.responseBytes;   
  286.     }      
  287.        
  288.     /**  
  289.      * 与 XMLHttpRequest 中的 responseStream 属性对应的方法 暂不提供.  
  290.      * 因为1 不常用 2 通常可用 getResponseBytes 方法代替   
  291.      */  
  292.        
  293.        
  294.     /**  
  295.      * 类似 XMLHttpRequest 中的 onreadystatechange 属性.  
  296.      * 设置一个监听器,用来跟踪HttpRequest状态变化.  
  297.      * 参数是一个 ReadyStateChangeListener 对象.  
  298.      * ReadyStateChangeListener 是一个抽象类. 只需 实现 onReadyStateChange方法即可.  
  299.      */  
  300.        
  301.     public void setReadyStateChangeListener(ReadyStateChangeListener listener) {   
  302.         this.readyStateChangeListener = listener;   
  303.     }   
  304.        
  305.     /**  
  306.      * 中断 Request 请求. 类似 XMLHttpRequest 中的 abort.  
  307.      */  
  308.     public void abort() {   
  309.         URLConnection c = null;   
  310.         synchronized (this) {   
  311.             c = this.getConnection();   
  312.         }   
  313.         if (c instanceof HttpURLConnection) {   
  314.             ((HttpURLConnection) c).disconnect();   
  315.         } else if (c != null) {   
  316.             try {   
  317.                 c.getInputStream().close();   
  318.             } catch (IOException ioe) {   
  319.                 ioe.printStackTrace();   
  320.             }   
  321.         }   
  322.     }   
  323.        
  324. ///   
  325.  以上 为 模拟 XMLHttpRequest 对象 相关的方法    
  326. ///   
  327. ///   
  328.        
  329.        
  330.     /**  
  331.      * 返回 此次HttpRequest是否是"异步"的.  
  332.      */  
  333.     public boolean isAsync() {   
  334.         return async;   
  335.     }   
  336.        
  337.     /**  
  338.      * 返回 此次HttpRequest是否已经发送.  
  339.      * 已经发送 且还没有完全处理完此次发送的返回信息时,是不能再次发送的.  
  340.      * 如果需要联系发送请求, 请再另行创建一个 AjaxHttpRequest对象.  
  341.      */  
  342.     public boolean hasSent() {   
  343.         return sent;   
  344.     }   
  345.     protected void setSent(boolean sent) {   
  346.         this.sent=sent;   
  347.     }   
  348.        
  349.     /**  
  350.      * 设置/取得 伪造的  userAgent 信息.通常不用理会.  
  351.      * 很少有http服务会对此做严格的判断.  
  352.      */  
  353.     public void setUserAgent(String userAgent) {   
  354.         this.userAgent = userAgent;   
  355.     }   
  356.     public String getUserAgent() {   
  357.         return this.userAgent;   
  358.     }   
  359.   
  360.     /**  
  361.      * 取得/设置 默认的 AJAX编码.AJAX请求都是UTF-8编码 此属性通常无需改变.  
  362.      */  
  363.     public String getPostCharset() {   
  364.         return this.postCharset;   
  365.     }   
  366.     public void setPostCharset(String postCharset) {   
  367.         this.postCharset = postCharset;   
  368.     }   
  369.    
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值