Улучшить эту документацию Посмотреть исходный код $resource
- $resourceProvider
- сервис в модуле ngResource
Обзор
Фабрика, которая создаёт объект ресурса, позволяющий взаимодействовать с RESTful источниками данных на стороне сервера.
Возвращаемый объект ресурса имеет методы действий, которые обеспечивают высокоуровневое поведение без необходимости взаимодействия с низкоуровневым сервисом $http.
Требуется модуль ngResource для установки.
По умолчанию, конечные слэши будут удалены из рассчитанных URL-адресов, что может вызвать проблемы с серверными бэкендами, которые не ожидают такого поведения. Это можно отключить, настроив $resourceProvider следующим образом:
app.config(['$resourceProvider', function($resourceProvider) {
// Don't strip trailing slashes from calculated URLs
$resourceProvider.defaults.stripTrailingSlashes = false;
}]);
Зависимости
Использование
$resource(url, [paramDefaults], [actions], options);
Аргументы
| Параметр | Тип | Подробности |
|---|---|---|
| url | string | Шаблон параметризованного URL-адреса с параметрами, префикс которых Если вы используете URL-адрес с суффиксом, просто добавьте суффикс, например: |
| paramDefaults (необязательно) | Object | Значения по умолчанию для параметров Каждое ключевое значение в объекте параметра сначала привязывается к шаблону URL, если он присутствует, а затем любые лишние ключи добавляются к поисковой строке URL после Учитывая шаблон Если значение параметра имеет префикс |
| actions (необязательно) | Object.<Object>= | Хеш с объявлением настраиваемых действий, которые будут доступны помимо стандартного набора действий ресурса (см. ниже). Если настраиваемое действие имеет тот же ключ, что и стандартное действие (например, Объявление должно быть создано в формате $http.config: {action1: {method:?, params:?, isArray:?, headers:?, ...},
action2: {method:?, params:?, isArray:?, headers:?, ...},
...}
Где:
|
| options | Object | Хеш с настраиваемыми параметрами, которые должны расширять стандартное поведение
|
Возвращаемое значение
Object |
Объект ресурса "класса" с методами для набора стандартных действий с ресурсом, которые можно дополнить настраиваемыми { 'get': {method:'GET'},
'save': {method:'POST'},
'query': {method:'GET', isArray:true},
'remove': {method:'DELETE'},
'delete': {method:'DELETE'} };
Вызов этих методов вызывает var User = $resource('/user/:userId', {userId:'@id'});
var user = User.get({userId:123}, function() {
user.abc = true;
user.$save();
});
Важно понимать, что вызов метода объекта $resource немедленно возвращает пустую ссылку (объект или массив в зависимости от Методы действий для объекта класса или экземпляра могут вызываться со следующими параметрами:
При вызове методов экземпляра сам экземпляр используется в качестве тела запроса (если действие должно иметь тело). По умолчанию тела запроса имеют только действия, использующие Функция обратного вызова при успехе вызывается с аргументами (значение (Объект/Массив), заголовки ответа (Функция), код состояния (число), текст состояния (строка)), где значение — это заполненный экземпляр или коллекция ресурса. Функция обратного вызова при ошибке вызывается с аргументом (ответ HTTP). Действия класса возвращают пустой экземпляр (с дополнительными свойствами ниже). Действия экземпляра возвращают обещание действия. Экземпляры и коллекции ресурсов имеют следующие дополнительные свойства:
|
Примеры
Ресурс карты кредита
// Define CreditCard class
var CreditCard = $resource('/user/:userId/card/:cardId',
{userId:123, cardId:'@id'}, {
charge: {method:'POST', params:{charge:true}}
});
// We can retrieve a collection from the server
var cards = CreditCard.query(function() {
// GET: /user/123/card
// server returns: [ {id:456, number:'1234', name:'Smith'} ];
var card = cards[0];
// each item is an instance of CreditCard
expect(card instanceof CreditCard).toEqual(true);
card.name = "J. Smith";
// non GET methods are mapped onto the instances
card.$save();
// POST: /user/123/card/456 {id:456, number:'1234', name:'J. Smith'}
// server returns: {id:456, number:'1234', name: 'J. Smith'};
// our custom method is mapped as well.
card.$charge({amount:9.99});
// POST: /user/123/card/456?amount=9.99&charge=true {id:456, number:'1234', name:'J. Smith'}
});
// we can create an instance as well
var newCard = new CreditCard({number:'0123'});
newCard.name = "Mike Smith";
newCard.$save();
// POST: /user/123/card {number:'0123', name:'Mike Smith'}
// server returns: {id:789, number:'0123', name: 'Mike Smith'};
expect(newCard.id).toEqual(789);
Объект, возвращаемый по результатам выполнения этой функции, — это ресурс "класса", который имеет "статический" метод для каждого действия в определении.
Вызов этих методов вызывает $http на шаблоне url с заданными method, params и headers.
Ресурс пользователя
Когда данные возвращаются с сервера, объект становится экземпляром типа ресурса, и все методы, отличные от GET, доступны с префиксом $. Это позволяет легко поддерживать операции CRUD (создание, чтение, обновление, удаление) с данными на стороне сервера.
var User = $resource('/user/:userId', {userId:'@id'});
User.get({userId:123}, function(user) {
user.abc = true;
user.$save();
});
Стоит отметить, что функция обратного вызова при успехе для get, query и других методов получает ответ с сервера, а также функцию получения заголовков $http, поэтому можно переписать вышеприведенный пример и получить доступ к заголовкам HTTP следующим образом:
var User = $resource('/user/:userId', {userId:'@id'});
User.get({userId:123}, function(user, getResponseHeaders){
user.abc = true;
user.$save(function(user, putResponseHeaders) {
//user => saved user object
//putResponseHeaders => $http header getter
});
});
Также можно получить доступ к исходному обещанию $http через свойство $promise возвращаемого объекта
var User = $resource('/user/:userId', {userId:'@id'});
User.get({userId:123})
.$promise.then(function(user) {
$scope.user = user;
});
Создание пользовательского запроса 'PUT'
В этом примере мы создаём пользовательский метод для нашего ресурса, чтобы выполнить запрос PUT
var app = angular.module('app', ['ngResource', 'ngRoute']);
// Some APIs expect a PUT request in the format URL/object/ID
// Here we are creating an 'update' method
app.factory('Notes', ['$resource', function($resource) {
return $resource('/notes/:id', null,
{
'update': { method:'PUT' }
});
}]);
// In our controller we get the ID from the URL using ngRoute and $routeParams
// We pass in $routeParams and our Notes factory along with $scope
app.controller('NotesCtrl', ['$scope', '$routeParams', 'Notes',
function($scope, $routeParams, Notes) {
// First get a note object from the factory
var note = Notes.get({ id:$routeParams.id });
$id = note.id;
// Now call update passing in the ID first then the object you are updating
Notes.update({ id:$id }, note);
// This will PUT /notes/ID with the note object in the request payload
}]);
Отмена запросов
Если конфигурация действия указывает, что оно отменяемо, можно отменить запрос, связанный с экземпляром или коллекцией (пока это результат вызова "не экземпляра"):
// ...defining the `Hotel` resource...
var Hotel = $resource('/api/hotel/:id', {id: '@id'}, {
// Let's make the `query()` method cancellable
query: {method: 'get', isArray: true, cancellable: true}
});
// ...somewhere in the PlanVacationController...
...
this.onDestinationChanged = function onDestinationChanged(destination) {
// We don't care about any pending request for hotels
// in a different destination any more
this.availableHotels.$cancelRequest();
// Let's query for hotels in '<destination>'
// (calls: /api/hotel?location=<destination>)
this.availableHotels = Hotel.query({location: destination});
};
© 2010–2018 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.6.9/docs/api/ngResource/service/$resource
