【转】AngularJS的$resource

时间:2022-11-25 18:27:52

$http

$http服务是基于$q服务的,提供了promise封装,它接受一个配置对象参数,并返回一个promise对象。同时,它还提供了2个方法用来定义Promise回调:success 和 error。

  1. $http({method:"GET", url:"/someUrl"}).
  2. success(function(data, status, headers, config){
  3. //当异步请求成功返回响应时触发
  4. }).error(function(data, status, headers, config){
  5. //当发生异常时触发
  6. });

由于常用的http请求就那么几种,$http服务实现了对应的简便方法,比方说:
$http.get
$http.post
$http.put
$http.delete
$http.head
$http.jsonp

$http为每次请求自动添加了HTTP header,可通过$httpProvider.defaults.headers来配置相关内容。

$httpProvider.defaults.headers.common设置了所有请求都会包含的头信息:

Accept: application/json, text/plain, * / *
x-Requested-With: XMLHttpRequest

$httpProvider.defaults.headers.post设置了POST请求的默认请求头:

Content-Type: application/json

$httpProvider.defaults.headers.put设置了PUT请求的默认请求头:

Content-Type: application/json

此外,关于$http的cache特性,推荐看一下这篇文章

那么$http的相关内容,就先到此为止。

现在,我们开始看看$resource,需要注意的是,该服务需要我们手动加载angular-resource.js文件~
$resource服务的核心价值在于:提供给开发者与RESTful风格WebServices交互的更好的用户体验,它封装了较为低级的$http,这样就不需要前端开发者写大量的异步请求代码了。

$resource服务的配置方法:

  1. $resource(url[, paramDefaults][, actions]);

url

字符串类型,其中可以出现占位符,占位符要以“:”为前缀,如果系统的域名带端口号的话,需要手动转义:
http://www.codingcool.com:8080/api应该这么传入:

  1. $resource("http://www.codingcool.com\\:8080/api");

这种情况在ng的1.2.0rc1版本已经不存在了,端口号会被识别而不需要手工转义~~

paramDefaults(可选)

对象类型,用于设置参数的默认值,它设置的数值可以被actions(第三个参数)进行覆盖。如果设置的参数值是函数,那么该函数将在每次获取其值时被执行(有那么点废话的意思)。

对于设置的没有出现在url模板(第一个参数)中的参数,将会以search query的方式添加,例如:
如果url模板为/codingcool/:author,paramDefaults为{author:”kazaff”, profession:”geek”},那么最终的请求url会变成:
/codingcool/kazaff?profession=geek

如果参数值是以“@”开头的,那么其真实值将会从数据对象中提取,后面会有例子。

actions(可选)

对象类型,用来定义$resource提供的可以使用方法,声明细节和$http一样。

下面再来看一下$resource的返回值:
返回值的类型是对象,它包含了和指定服务api(即url)进行互动的所有方法,默认会包含如下默认方法:

  1. { 'get':    {method:'GET'},
  2. 'save':   {method:'POST'},
  3. 'query':  {method:'GET', isArray:true},
  4. 'remove': {method:'DELETE'},
  5. 'delete': {method:'DELETE'}
  6. };

这些方法会调用内置的$http服务~

当异步请求成功,数据从服务器端取回后,被封装到一个$resource服务的一个对象实例中,这个对象可以被save,remove,delete方法直接操作,这种封装并提供简单的CRUD操作的方式,使得开发者可以感受到被尊重啊!呵呵~

  1. var User = $resource('/user/:userId', {userId:'@id'});
  2. var user = User.get({userId:123}, function() {
  3. user.abc = true;
  4. user.$save();
  5. });

注意上面代码中的”@id”和”$save()”,使用了@后,当执行$save时,user.id就会被当做userId的值来发送请求。

这种方式封装Ajax,不仅仅使得代码更加优雅,而且还能配合ng的视图渲染:当数据没有返回之前,模板引擎不会渲染,一旦异步数据获取完成,会自动触发模板引擎的渲染机制把数据呈现到视图中。

最后,看一个简单的例子:

AngularJS的$resource
  1. <!DOCTYPE html>
  2. <html ng-app="Demo">
  3. <head>
  4. <meta charset=utf-8 />
  5. <title>ngResource DEMO</title>
  6. </head>
  7. <body>
  8. <div ng-controller="GeekListCtrl">
  9. <ul>
  10. <li ng-repeat="geek in geeks">
  11. <a href="#" ng-click="show({{geek.id}})">{{geek.name}}</a>
  12. </li>
  13. </ul>
  14. <div ng-show="user">
  15. {{user.msg}}
  16. </div>
  17. </div>
  18. <script src="./src/angular.js"></script>
  19. <script src="./src/angular-resource.js"></script>
  20. <script type="text/javascript">
  21. var Demo = angular.module('Demo', ["ngResource"])
  22. .factory('Geek', function ($resource){
  23. return $resource("geek/:geekId.json", {}, {
  24. query: {
  25. method: "GET",
  26. params: {geekId: "list"},
  27. isArray: true
  28. }
  29. });
  30. });
  31. function GeekListCtrl($scope, Geek){
  32. $scope.geeks = Geek.query();
  33. $scope.show = function(id){
  34. $scope.user = Geek.get({geekId: id});
  35. };
  36. }
  37. function GeekDetailCtrl($scope, $routeParams, Geek){
  38. $scope.geek = Geek.get({geekId: $routeParams.geekId}, function(geek){
  39. console.dir(geek);
  40. });
  41. }
  42. </script>
  43. </body>
  44. </html>

转自:

AngularJS的$resource