AngularJSのドキュメントには、サービスがシングルトンであることが明記されています。
AngularJS services are singletons
直感に反して、module.factory
はシングルトンインスタンスも返します。
非シングルトンサービスには多くのユースケースがあるため、ファクトリのメソッドを実装してサービスのインスタンスを返す最良の方法は何ですか。したがって、ExampleService
依存関係が宣言されるたびに、 ExampleService
の別のインスタンス?
ファクトリがnew
able関数を返すようにする必要はないと思います。これにより、依存関係の注入が中断され始め、ライブラリは、特にサードパーティにとっては扱いにくいものになります。要するに、シングルトン以外のサービスの正当な使用例があるかどうかはわかりません。
同じことを達成するためのより良い方法は、ファクトリーをAPIとして使用して、オブジェクトのコレクションにgetterメソッドとsetterメソッドを付加して返すことです。その種のサービスの使用方法を示す擬似コードを次に示します。
.controller( 'MainCtrl', function ( $scope, widgetService ) {
$scope.onSearchFormSubmission = function () {
widgetService.findById( $scope.searchById ).then(function ( widget ) {
// this is a returned object, complete with all the getter/setters
$scope.widget = widget;
});
};
$scope.onWidgetSave = function () {
// this method persists the widget object
$scope.widget.$save();
};
});
これは、IDでウィジェットを検索し、レコードに加えられた変更を保存できるようにするための単なる擬似コードです。
以下は、サービスの擬似コードです。
.factory( 'widgetService', function ( $http ) {
function Widget( json ) {
angular.extend( this, json );
}
Widget.prototype = {
$save: function () {
// TODO: strip irrelevant fields
var scrubbedObject = //...
return $http.put( '/widgets/'+this.id, scrubbedObject );
}
};
function getWidgetById ( id ) {
return $http( '/widgets/'+id ).then(function ( json ) {
return new Widget( json );
});
}
// the public widget API
return {
// ...
findById: getWidgetById
// ...
};
});
この例には含まれていませんが、これらの種類の柔軟なサービスも状態を簡単に管理できます。
今は時間がありませんが、役に立つ場合は、後で簡単なPlunkerを組み立ててデモンストレーションできます。
あなたがどのようなユースケースを満たそうとしているのか、私には完全にはわかりません。しかし、ファクトリにオブジェクトのインスタンスを返すことは可能です。ニーズに合わせてこれを変更できるはずです。
var ExampleApplication = angular.module('ExampleApplication', []);
ExampleApplication.factory('InstancedService', function(){
function Instance(name, type){
this.name = name;
this.type = type;
}
return {
Instance: Instance
}
});
ExampleApplication.controller('InstanceController', function($scope, InstancedService){
var instanceA = new InstancedService.Instance('A','string'),
instanceB = new InstancedService.Instance('B','object');
console.log(angular.equals(instanceA, instanceB));
});
更新済み
非シングルトンサービス の次のリクエストを検討してください。ブライアンフォードは次のように述べています。
すべてのサービスがシングルトンであるという考えは、新しいオブジェクトをインスタンス化できるシングルトンファクトリの記述を妨げるものではありません。
そして、工場からインスタンスを返す彼の例:
myApp.factory('myService', function () {
var MyThing = function () {};
MyThing.prototype.foo = function () {};
return {
getInstance: function () {
return new MyThing();
}
};
});
また、コントローラーでnew
キーワードを使用する必要がないため、彼の例は優れていると主張します。サービスのgetInstance
メソッド内にカプセル化されます。
別の方法は、angular.extend()
を使用してサービスオブジェクトをコピーすることです。
app.factory('Person', function(){
return {
greet: function() { return "Hello, I'm " + this.name; },
copy: function(name) { return angular.extend({name: name}, this); }
};
});
そして、例えば、あなたのコントローラーで
app.controller('MainCtrl', function ($scope, Person) {
michael = Person.copy('Michael');
peter = Person.copy('Peter');
michael.greet(); // Hello I'm Michael
peter.greet(); // Hello I'm Peter
});
plunk です。
この投稿にはすでに回答がありますが、まだシングルトン以外のサービスが必要な正当なシナリオがあると思います。複数のコントローラー間で共有できる再利用可能なビジネスロジックがあるとします。このシナリオでは、ロジックを配置するのに最適な場所はサービスですが、再利用可能なロジックの状態を維持する必要がある場合はどうでしょうか。次に、アプリ内の異なるコントローラー間で共有できるように、シングルトン以外のサービスが必要です。これは私がこれらのサービスを実装する方法です:
angular.module('app', [])
.factory('nonSingletonService', function(){
var instance = function (name, type){
this.name = name;
this.type = type;
return this;
}
return instance;
})
.controller('myController', ['$scope', 'nonSingletonService', function($scope, nonSingletonService){
var instanceA = new nonSingletonService('A','string');
var instanceB = new nonSingletonService('B','object');
console.log(angular.equals(instanceA, instanceB));
}]);
これは、シングルトン以外のサービスの例です。これはORMが取り組んでいるものです。この例では、services( 'users'、 'documents')が継承して拡張する可能性のあるベースモデル(ModelFactory)を示しています。
私のORMでは、ModelFactoryは他のサービスを注入して、モジュールシステムを使用してサンドボックス化された追加機能(クエリ、永続性、スキーママッピング)を提供します。
この例では、ユーザーとドキュメントサービスの両方に同じ機能がありますが、独自の独立したスコープがあります。
/*
A class which which we want to have multiple instances of,
it has two attrs schema, and classname
*/
var ModelFactory;
ModelFactory = function($injector) {
this.schema = {};
this.className = "";
};
Model.prototype.klass = function() {
return {
className: this.className,
schema: this.schema
};
};
Model.prototype.register = function(className, schema) {
this.className = className;
this.schema = schema;
};
angular.module('model', []).factory('ModelFactory', [
'$injector', function($injector) {
return function() {
return $injector.instantiate(ModelFactory);
};
}
]);
/*
Creating multiple instances of ModelFactory
*/
angular.module('models', []).service('userService', [
'ModelFactory', function(modelFactory) {
var instance;
instance = new modelFactory();
instance.register("User", {
name: 'String',
username: 'String',
password: 'String',
email: 'String'
});
return instance;
}
]).service('documentService', [
'ModelFactory', function(modelFactory) {
var instance;
instance = new modelFactory();
instance.register("Document", {
name: 'String',
format: 'String',
fileSize: 'String'
});
return instance;
}
]);
/*
Example Usage
*/
angular.module('controllers', []).controller('exampleController', [
'$scope', 'userService', 'documentService', function($scope, userService, documentService) {
userService.klass();
/*
returns
{
className: "User"
schema: {
name : 'String'
username : 'String'
password: 'String'
email: 'String'
}
}
*/
return documentService.klass();
/*
returns
{
className: "User"
schema: {
name : 'String'
format : 'String'
formatileSize: 'String'
}
}
*/
}
]);
angularはsingleton service/factoryオプションのみを提供します。それを回避する1つの方法は、コントローラーまたは他のコンシューマーインスタンス内に新しいインスタンスを構築するファクトリーサービスを持つことです。注入されるのは、新しいインスタンスを作成するクラスだけです。これは、他の依存関係を挿入したり、新しいオブジェクトをユーザーの仕様に合わせて初期化する(サービスまたは構成を追加する)のに適した場所です
namespace admin.factories {
'use strict';
export interface IModelFactory {
build($log: ng.ILogService, connection: string, collection: string, service: admin.services.ICollectionService): IModel;
}
class ModelFactory implements IModelFactory {
// any injection of services can happen here on the factory constructor...
// I didnt implement a constructor but you can have it contain a $log for example and save the injection from the build funtion.
build($log: ng.ILogService, connection: string, collection: string, service: admin.services.ICollectionService): IModel {
return new Model($log, connection, collection, service);
}
}
export interface IModel {
// query(connection: string, collection: string): ng.IPromise<any>;
}
class Model implements IModel {
constructor(
private $log: ng.ILogService,
private connection: string,
private collection: string,
service: admin.services.ICollectionService) {
};
}
angular.module('admin')
.service('admin.services.ModelFactory', ModelFactory);
}
次に、コンシューマインスタンスでファクトリサービスが必要になり、ファクトリでbuildメソッドを呼び出して、必要なときに新しいインスタンスを取得します
class CollectionController {
public model: admin.factories.IModel;
static $inject = ['$log', '$routeParams', 'admin.services.Collection', 'admin.services.ModelFactory'];
constructor(
private $log: ng.ILogService,
$routeParams: ICollectionParams,
private service: admin.services.ICollectionService,
factory: admin.factories.IModelFactory) {
this.connection = $routeParams.connection;
this.collection = $routeParams.collection;
this.model = factory.build(this.$log, this.connection, this.collection, this.service);
}
}
工場の段階では利用できない特定のサービスを注入することができます。すべてのモデルインスタンスで使用されるファクトリインスタンスでインジェクションをいつでも実行できます。
注意してくださいいくつかのコードを削除する必要がありましたので、いくつかのコンテキストエラーが発生する可能性があります...動作するコードサンプルが必要な場合はお知らせください。
NG2には、DOMの適切な場所にサービスの新しいインスタンスを挿入するオプションがあるため、独自のファクトリ実装を構築する必要はありません。待つ必要があります:)
サービス内にオブジェクトの新しいインスタンスを作成する正当な理由があると思います。このようなことは絶対にしないでくださいと言うのではなく、心を開いておく必要がありますが、シングルトンが理由でそのように作成されました。コントローラーは、アプリのライフサイクル内で頻繁に作成および破棄されますが、サービスは永続的でなければなりません。
支払いを受け入れるなどの何らかのワークフローがあり、複数のプロパティが設定されているユースケースを考えることができますが、顧客のクレジットカードが失敗し、別のフォームを提供する必要があるため、支払いタイプを変更する必要があります支払い。もちろん、これはアプリの作成方法と多くの関係があります。支払いオブジェクトのすべてのプロパティをリセットすることも、サービス内でオブジェクトの新しいインスタンスを作成するにすることもできます。ただし、サービスの新しいインスタンスは必要ありません。また、ページを更新する必要もありません。
ソリューションは、新しいインスタンスを作成して設定できるオブジェクトをサービス内に提供することだと思います。ただし、明確にするために、コントローラーは何度も作成および破棄される可能性がありますが、サービスには永続性が必要であるため、サービスの単一インスタンスが重要です。探しているのはAngular内の直接的な方法ではなく、サービス内で管理できるオブジェクトパターンです。
例として、resetボタンを作成しました。 (これはテストされていません。実際には、サービス内で新しいオブジェクトを作成するためのユースケースの簡単なアイデアです。
app.controller("PaymentController", ['$scope','PaymentService',function($scope, PaymentService) {
$scope.utility = {
reset: PaymentService.payment.reset()
};
}]);
app.factory("PaymentService", ['$http', function ($http) {
var paymentURL = "https://www.paymentserviceprovider.com/servicename/token/"
function PaymentObject(){
// this.user = new User();
/** Credit Card*/
// this.paymentMethod = "";
//...
}
var payment = {
options: ["Cash", "Check", "Existing Credit Card", "New Credit Card"],
paymentMethod: new PaymentObject(),
getService: function(success, fail){
var request = $http({
method: "get",
url: paymentURL
}
);
return ( request.then(success, fail) );
}
//...
}
return {
payment: {
reset: function(){
payment.paymentMethod = new PaymentObject();
},
request: function(success, fail){
return payment.getService(success, fail)
}
}
}
}]);
特に高度な最適化が有効になっているClosure Compilerと組み合わせて使用した場合、私が満足した問題に対する別のアプローチを次に示します。
var MyFactory = function(arg1, arg2) {
this.arg1 = arg1;
this.arg2 = arg2;
};
MyFactory.prototype.foo = function() {
console.log(this.arg1, this.arg2);
// You have static access to other injected services/factories.
console.log(MyFactory.OtherService1.foo());
console.log(MyFactory.OtherService2.foo());
};
MyFactory.factory = function(OtherService1, OtherService2) {
MyFactory.OtherService1_ = OtherService1;
MyFactory.OtherService2_ = OtherService2;
return MyFactory;
};
MyFactory.create = function(arg1, arg2) {
return new MyFactory(arg1, arg2);
};
// Using MyFactory.
MyCtrl = function(MyFactory) {
var instance = MyFactory.create('bar1', 'bar2');
instance.foo();
// Outputs "bar1", "bar2" to console, plus whatever static services do.
};
angular.module('app', [])
.factory('MyFactory', MyFactory)
.controller('MyCtrl', MyCtrl);