基于JavaScript的REST客户端框架

时间:2025-05-05 08:35:44

现在REST是一个比较热门的概念,REST已经成为一个在Web上越来越常用的应用,基于REST的Web服务越来越多,包括Twitter在内的微博客都是用REST做为对外的API,先前我曾经介绍过“基于REST架构的Web Service设计”,并给出了一些服务器端和客户端代码,随着JavaScript的广泛应用,我这里就给出一个轻量级的基于JavaScript的REST客户端框架。

这个JavaScript客户端主要使用了XMLHttpRequest对象来实现通过HTTP对服务器操作GET、PUT、POST和DELETE以检索和修改资源。值得注意的是,由于安全方面的考虑,Javascript被限制了跨域访问的能力,因此在调用XMLHttpRequest的时候,应该注意跨域访问的问题,比如使用同一个域的动态文件做代理,或者其他方法避开跨域访问的问题。我这里给出的代码主要是根据我先前的那段代码修改过来的,其客户端JavaScript代码如下所示:

  1. function httpGet(url, method, data) {
  2. var xmlhttp;
  3. xmlhttp = new XMLHttpRequest();
  4. xmlhttp.open (method, url + "?" + data, false);
  5. xmlhttp.setRequestHeader ("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
  6. xmlhttp.setRequestHeader ("Content-Length", data.length);
  7. xmlhttp.send (null);
  8. if (xmlhttp.Status = 200) return xmlhttp.responseText;
  9. }
  10. function httpPost(url, method, data) {
  11. var xmlhttp;
  12. xmlhttp = new XMLHttpRequest();
  13. xmlhttp.open (method, url, false);
  14. xmlhttp.setRequestHeader ("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
  15. xmlhttp.setRequestHeader ("Content-Length", data.length);
  16. xmlhttp.send (data);
  17. if (xmlhttp.Status = 200) return xmlhttp.responseText;
  18. }
  19. function httpPut(url, method, data) {
  20. var xmlhttp;
  21. xmlhttp = new XMLHttpRequest();
  22. xmlhttp.open (method, url, false);
  23. xmlhttp.setRequestHeader ("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
  24. xmlhttp.setRequestHeader ("Content-Length", data.length);
  25. xmlhttp.send (data);
  26. if (xmlhttp.Status = 200) return xmlhttp.responseText;
  27. }
  28. function httpDelete(url, method, data) {
  29. var xmlhttp;
  30. xmlhttp = new XMLHttpRequest();
  31. xmlhttp.open (method, url + "?" + data, false);
  32. xmlhttp.setRequestHeader ("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
  33. xmlhttp.setRequestHeader ("Content-Length", data.length);
  34. xmlhttp.send (null);
  35. if (xmlhttp.Status = 200) return xmlhttp.responseText;
  36. }
  37. function test() {
  38. document.write (httpGet("http://localhost/rest/service.asp", "GET", "do=GET"));
  39. document.write (httpGet("http://localhost/rest/service.asp", "POST", "do=POST"));
  40. document.write (httpGet("http://localhost/rest/service.asp", "PUT", "do=PUT"));
  41. document.write (httpGet("http://localhost/rest/service.asp", "DELETE", "do=DELETE"));
  42. }

我这里使用这个代码编写了一个简单的应用例子,就是管理Twitter好友的应用,大家点这里可以下载使用,因为跨域访问的问题,这段JavaScript只支持IE在本地使用。