$resource in AngularJS

时间 2020-05-24

原文原文链接

$httpjavascript

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

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

因为经常使用的http请求就那么几种，$http服务实现了对应的简便方法，比方说：
$http.get
$http.post
$http.put
$http.delete
$http.head
$http.jsonp前端

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

$httpProvider.defaults.headers.common设置了全部请求都会包含的头信息：json

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

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

Content-Type: application/json服务器

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

Content-Type: application/json异步

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

$resource服务的配置方法

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

url

字符串类型，其中能够出现占位符，占位符要以“:”为前缀，若是系统的域名带端口号的话，须要手动转义：
http://www.codingcool.com:8080/api应该这么传入：

$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）进行互动的全部方法，默认会包含以下默认方法：

{
    'get': {
        method: 'GET'
    },
    'save': {
        method: 'POST'
    },
    'query': {
        method: 'GET',
        isArray: true
    },
    'remove': {
        method: 'DELETE'
    },
    'delete': {
        method: 'DELETE'
    }
};

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

当异步请求成功，数据从服务器端取回后，被封装到一个$resource服务的一个对象实例中，这个对象能够被save,remove,delete方法直接操做，这种封装并提供简单的CRUD操做的方式。

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

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

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

最后，看一个简单的例子：

AngularJS的$resource

<!DOCTYPE html>
<html ng-app="Demo">

<head>
    <meta charset=utf-8 />
    <title>ngResource DEMO</title>
</head>

<body>
    <div ng-controller="GeekListCtrl">
        <ul>
            <li ng-repeat="geek in geeks">
                <a href="#" ng-click="show(`geek`.`id`)">`geek`.`name`</a>
            </li>
        </ul>
        <div ng-show="user">
            `user`.`msg`
        </div>
    </div>
    <script src="./src/angular.js"></script>
    <script src="./src/angular-resource.js"></script>
    <script type="text/javascript">
    var Demo = angular.module('Demo', ["ngResource"]).factory('Geek', function($resource) {
        return $resource("geek/:geekId.json", {}, {
            query: {
                method: "GET",
                params: {
                    geekId: "list"
                },
                isArray: true
            }
        });
    });

    function GeekListCtrl($scope, Geek) {
        $scope.geeks = Geek.query();
        $scope.show = function(id) {
            $scope.user = Geek.get({
                geekId: id
            });
        };
    }

    function GeekDetailCtrl($scope, $routeParams, Geek) {
        $scope.geek = Geek.get({
            geekId: $routeParams.geekId
        }, function(geek) {
            console.dir(geek);
        });
    }
    </script>
</body>

</html>
</span>