AngularJS: внедрение службы в перехватчик HTTP (циклическая зависимость)
Я пытаюсь написать перехватчик HTTP для моего приложения AngularJS для обработки аутентификации.
Этот код работает, но я обеспокоен ручным внедрением службы, поскольку я думал, что Angular должен обрабатывать это автоматически:
app.config(['$httpProvider', function ($httpProvider) {
$httpProvider.interceptors.push(function ($location, $injector) {
return {
'request': function (config) {
//injected manually to get around circular dependency problem.
var AuthService = $injector.get('AuthService');
console.log(AuthService);
console.log('in request interceptor');
if (!AuthService.isAuthenticated() && $location.path != '/login') {
console.log('user is not logged in.');
$location.path('/login');
}
return config;
}
};
})
}]);
То, что я начал делать, но столкнулся с проблемами циклической зависимости:
app.config(function ($provide, $httpProvider) {
$provide.factory('HttpInterceptor', function ($q, $location, AuthService) {
return {
'request': function (config) {
console.log('in request interceptor.');
if (!AuthService.isAuthenticated() && $location.path != '/login') {
console.log('user is not logged in.');
$location.path('/login');
}
return config;
}
};
});
$httpProvider.interceptors.push('HttpInterceptor');
});
Еще одна причина, по которой я обеспокоен, заключается в том, что раздел $http в Angular Docs, кажется, показывает способ получения зависимостей, вводимых "обычным способом" в перехватчик Http. Смотрите их фрагмент кода в разделе "Перехватчики":
// register the interceptor as a service
$provide.factory('myHttpInterceptor', function($q, dependency1, dependency2) {
return {
// optional method
'request': function(config) {
// do something on success
return config || $q.when(config);
},
// optional method
'requestError': function(rejection) {
// do something on error
if (canRecover(rejection)) {
return responseOrNewPromise
}
return $q.reject(rejection);
},
// optional method
'response': function(response) {
// do something on success
return response || $q.when(response);
},
// optional method
'responseError': function(rejection) {
// do something on error
if (canRecover(rejection)) {
return responseOrNewPromise
}
return $q.reject(rejection);
};
}
});
$httpProvider.interceptors.push('myHttpInterceptor');
Куда должен идти приведенный выше код?
Я предполагаю, что мой вопрос в том, как правильно сделать это?
Спасибо, и я надеюсь, что мой вопрос был достаточно ясен.
5 ответов
У вас круговая зависимость между $http и вашим AuthService.
Что вы делаете, используя $injector Служба решает проблему курицы и яйца, задерживая зависимость $http от AuthService.
Я считаю, что то, что вы сделали, на самом деле является самым простым способом сделать это.
Вы также можете сделать это:
- Регистрация перехватчика позже (делает это в
run()блок вместоconfig()блок может уже сделать свое дело). Но можете ли вы гарантировать, что $http еще не был вызван? - "Внедрение" $http вручную в AuthService при регистрации перехватчика путем вызова
AuthService.setHttp()или что-то. - ...
Это то, что я в итоге делал
.config(['$httpProvider', function ($httpProvider) {
//enable cors
$httpProvider.defaults.useXDomain = true;
$httpProvider.interceptors.push(['$location', '$injector', '$q', function ($location, $injector, $q) {
return {
'request': function (config) {
//injected manually to get around circular dependency problem.
var AuthService = $injector.get('Auth');
if (!AuthService.isAuthenticated()) {
$location.path('/login');
} else {
//add session_id as a bearer token in header of all outgoing HTTP requests.
var currentUser = AuthService.getCurrentUser();
if (currentUser !== null) {
var sessionId = AuthService.getCurrentUser().sessionId;
if (sessionId) {
config.headers.Authorization = 'Bearer ' + sessionId;
}
}
}
//add headers
return config;
},
'responseError': function (rejection) {
if (rejection.status === 401) {
//injected manually to get around circular dependency problem.
var AuthService = $injector.get('Auth');
//if server returns 401 despite user being authenticated on app side, it means session timed out on server
if (AuthService.isAuthenticated()) {
AuthService.appLogOut();
}
$location.path('/login');
return $q.reject(rejection);
}
}
};
}]);
}]);
Обратите внимание $injector.get вызовы должны быть внутри методов перехватчика, если вы попытаетесь использовать их в другом месте, вы продолжите получать циклическую ошибку зависимости в JS.
Я думаю, что использование $ инжектора напрямую является антипаттерном.
Чтобы разорвать циклическую зависимость, используйте событие: вместо внедрения $state введите $rootScope. Вместо того, чтобы перенаправлять напрямую, сделайте
this.$rootScope.$emit("unauthorized");
плюс
angular
.module('foo')
.run(function($rootScope, $state) {
$rootScope.$on('unauthorized', () => {
$state.transitionTo('login');
});
});
Плохая логика дала такие результаты
На самом деле нет никакого смысла в поиске, автор создан или нет в Http Interceptor. Я бы рекомендовал обернуть все ваши HTTP-запросы в один.service (или.factory, или в.provider) и использовать его для ВСЕХ запросов. При каждом вызове функции вы можете проверить, вошел ли пользователь в систему или нет. Если все в порядке, разрешите отправить запрос.
В вашем случае приложение Angular отправит запрос в любом случае, вы просто проверяете там авторизацию, а после этого JavaScript отправит запрос.
Суть вашей проблемы
myHttpInterceptor называется под $httpProvider пример. Ваш AuthService использования $http, или же $resourceи здесь у вас есть рекурсия зависимости или циклическая зависимость. Если вы удалите эту зависимость из AuthServiceчем вы не увидите ту ошибку.
Также, как указал @Pieter Herroelen, вы можете поместить этот перехватчик в свой модуль. module.run, но это будет больше похоже на взлом, а не решение.
Если вы хотите делать чистый и информативный код, вы должны придерживаться некоторых принципов SOLID.
По крайней мере, принцип единой ответственности вам очень поможет в таких ситуациях.
Если вы просто проверяете состояние Auth (isAuthorized()), я бы порекомендовал поместить это состояние в отдельный модуль, скажем "Auth", который просто хранит состояние и не использует сам $http.
app.config(['$httpProvider', function ($httpProvider) {
$httpProvider.interceptors.push(function ($location, Auth) {
return {
'request': function (config) {
if (!Auth.isAuthenticated() && $location.path != '/login') {
console.log('user is not logged in.');
$location.path('/login');
}
return config;
}
}
})
}])
Модуль аутентификации:
angular
.module('app')
.factory('Auth', Auth)
function Auth() {
var $scope = {}
$scope.sessionId = localStorage.getItem('sessionId')
$scope.authorized = $scope.sessionId !== null
//... other auth relevant data
$scope.isAuthorized = function() {
return $scope.authorized
}
return $scope
}
(Я использовал localStorage для хранения sessionId здесь на стороне клиента, но вы также можете установить это внутри вашего AuthService после вызова $http, например)