AngularJSにおけるService
、Provider
、Factory
の違いは何ですか?
AngularJSのメーリングリストから、サービス、ファクトリー、プロバイダー、そしてそれらのインジェクションの使い方を説明した素晴らしいスレッドを入手しました。回答をまとめてみました。
構文です。module.service( 'serviceName', function );
結果です。serviceNameを注入可能な引数として宣言した場合、その関数のインスタンスが提供されます。言い換えるとnew FunctionYouPassedToService()
です。
構文です。module.factory( 'factoryName', function );
結果です。factoryNameを注入可能な引数として宣言すると、module.factoryに渡された関数参照を呼び出したときに返される**値が提供されます。
構文を示します。module.provider( 'providerName', function );
結果です。providerNameを注入可能な引数として宣言すると、** (new ProviderFunction()).$get()
が提供されます。コンストラクタ関数は$getメソッドが呼ばれる前にインスタンス化されます。ProviderFunction
はmodule.providerに渡される関数参照です。
プロバイダは、モジュールのコンフィギュレーションの段階で設定できるという利点があります。
提供されているコードについては、ここを参照してください。
また、Misko氏による素晴らしい解説もあります。
provide.value('a', 123);
function Controller(a) {
expect(a).toEqual(123);
}
この場合、インジェクターは単に値をそのまま返します。しかし、値を計算したい場合はどうしますか?その場合は、ファクトリー
provide.factory('b', function(a) {
return a*2;
});
function Controller(b) {
expect(b).toEqual(246);
}
つまり、factory
は値の作成を担当する関数です。ファクトリー関数は、他の依存関係を求めることができることに注意してください。
しかし、もっとOO的になりたいと思って、Greeterというクラスがあったらどうでしょう?
function Greeter(a) {
this.greet = function() {
return 'Hello ' + a;
}
}
インスタンス化するには、次のように書かなければなりません。
provide.factory('greeter', function(a) {
return new Greeter(a);
});
そして、次のようにコントローラで 'greeter'を求めることができます。
function Controller(greeter) {
expect(greeter instanceof Greeter).toBe(true);
expect(greeter.greet()).toEqual('Hello 123');
}
しかし、これはあまりにも語弊があります。もっと短い書き方は、provider.service('greeter', Greeter);
です。
しかし、もしインジェクションの前に Greeter
クラスを設定したいとしたらどうでしょうか。その場合は次のように書きます。
provide.provider('greeter2', function() {
var salutation = 'Hello';
this.setSalutation = function(s) {
salutation = s;
}
function Greeter(a) {
this.greet = function() {
return salutation + ' ' + a;
}
}
this.$get = function(a) {
return new Greeter(a);
};
});
すると、こんなことができます。
angular.module('abc', []).config(function(greeter2Provider) {
greeter2Provider.setSalutation('Halo');
});
function Controller(greeter2) {
expect(greeter2.greet()).toEqual('Halo 123');
}
余談ですが、service
、factory
、value
はすべてproviderから派生したものです。
provider.service = function(name, Class) {
provider.provide(name, function() {
this.$get = function($injector) {
return $injector.instantiate(Class);
};
});
}
provider.factory = function(name, factory) {
provider.provide(name, function() {
this.$get = function($injector) {
return $injector.invoke(factory);
};
});
}
provider.value = function(name, value) {
provider.factory(name, function() {
return value;
});
};
factory
/ service
/ provider
を使った例です。var myApp = angular.module('myApp', []);
//service style, probably the simplest one
myApp.service('helloWorldFromService', function() {
this.sayHello = function() {
return "Hello, World!";
};
});
//factory style, more involved but more sophisticated
myApp.factory('helloWorldFromFactory', function() {
return {
sayHello: function() {
return "Hello, World!";
}
};
});
//provider style, full blown, configurable version
myApp.provider('helloWorld', function() {
this.name = 'Default';
this.$get = function() {
var name = this.name;
return {
sayHello: function() {
return "Hello, " + name + "!";
}
}
};
this.setName = function(name) {
this.name = name;
};
});
//hey, we can configure a provider!
myApp.config(function(helloWorldProvider){
helloWorldProvider.setName('World');
});
function MyCtrl($scope, helloWorld, helloWorldFromFactory, helloWorldFromService) {
$scope.hellos = [
helloWorld.sayHello(),
helloWorldFromFactory.sayHello(),
helloWorldFromService.sayHello()];
}
<script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.2.23/angular.min.js"></script>
<body ng-app="myApp">
<div ng-controller="MyCtrl">
{{hellos}}
</div>
</body>
プロバイダーを使ってみて、面白いことに気がつきました。
インジェクションの可視性は、プロバイダの場合、サービスやファクトリの場合とは異なります。AngularJSの"constant"(例えば、myApp.constant('a', 'Robert');
)を宣言すると、それをサービス、ファクトリー、プロバイダに注入することができます。
しかし、AngularJSの"value"を宣言した場合(例えば、myApp.value('b', {name: 'Jones'});
)、サービスやファクトリには注入できますが、プロバイダ作成関数には注入できません。ただし、プロバイダ用に定義した $get
関数には注入することができます。これはAngularJSのドキュメントにも記載されていますが、見落としがちです。プロバイダのページのvalueメソッドとconstantメソッドのセクションに記載されています。
<div ng-app="MyAppName">
<div ng-controller="MyCtrl">
<p>from Service: {{servGreet}}</p>
<p>from Provider: {{provGreet}}</p>
</div>
</div>
<script>
var myApp = angular.module('MyAppName', []);
myApp.constant('a', 'Robert');
myApp.value('b', {name: 'Jones'});
myApp.service('greetService', function(a,b) {
this.greeter = 'Hi there, ' + a + ' ' + b.name;
});
myApp.provider('greetProvider', function(a) {
this.firstName = a;
this.$get = function(b) {
this.lastName = b.name;
this.fullName = this.firstName + ' ' + this.lastName;
return this;
};
});
function MyCtrl($scope, greetService, greetProvider) {
$scope.servGreet = greetService.greeter;
$scope.provGreet = greetProvider.fullName;
}
</script>