web-dev-qa-db-ja.com

RequireJS / AMDで循環依存関係を処理する方法は？

私のシステムでは、多くの「クラス」がブラウザーにロードされており、開発中にそれぞれ個別のファイルが作成され、生産のために連結されています。ロードされると、この例のように、グローバルオブジェクト（ここではG）のプロパティを初期化します。

_var G = {};

G.Employee = function(name) {
    this.name = name;
    this.company = new G.Company(name + "'s own company");
};

G.Company = function(name) {
    this.name = name;
    this.employees = [];
};
G.Company.prototype.addEmployee = function(name) {
    var employee = new G.Employee(name);
    this.employees.Push(employee);
    employee.company = this;
};

var john = new G.Employee("John");
var bigCorp = new G.Company("Big Corp");
bigCorp.addEmployee("Mary");
_

私自身のグローバルオブジェクトを使用する代わりに、 James Burkeの提案 に基づいて、各クラスを独自の AMDモジュール にすることを検討しています。

_define("Employee", ["Company"], function(Company) {
    return function (name) {
        this.name = name;
        this.company = new Company(name + "'s own company");
    };
});
define("Company", ["Employee"], function(Employee) {
    function Company(name) {
        this.name = name;
        this.employees = [];
    };
    Company.prototype.addEmployee = function(name) {
        var employee = new Employee(name);
        this.employees.Push(employee);
        employee.company = this;
    };
    return Company;
});
define("main", ["Employee", "Company"], function (Employee, Company) {
    var john = new Employee("John");
    var bigCorp = new Company("Big Corp");
    bigCorp.addEmployee("Mary");
});
_

問題は、以前はEmployeeとCompanyの間に宣言時の依存関係がなかったということです：宣言を任意の順序で配置できましたが、今ではRequireJSを使用して、ここに（意図的に）循環する依存関係が導入されるため、上記のコードは失敗します。もちろん、addEmployee()に最初の行var Employee = require("Employee");を追加すると 動作させる になりますが、このソリューションはRequireJS/AMDを使用しないより劣っていると思います開発者である私は、この新しく作成された循環依存関係を認識し、それについて何かをする必要があります。

RequireJS/AMDでこの問題を解決するより良い方法はありますか、それとも設計されていないものにRequireJS/AMDを使用していますか？

javascriptcommonjsrequirejs
77
avernet

これは、AMD形式の制限です。エクスポートを使用できれば、その問題はなくなります。エクスポートは見苦しいですが、通常のCommonJSモジュールが問題を解決する方法です。

define("Employee", ["exports", "Company"], function(exports, Company) {
    function Employee(name) {
        this.name = name;
        this.company = new Company.Company(name + "'s own company");
    };
    exports.Employee = Employee;
});
define("Company", ["exports", "Employee"], function(exports, Employee) {
    function Company(name) {
        this.name = name;
        this.employees = [];
    };
    Company.prototype.addEmployee = function(name) {
        var employee = new Employee.Employee(name);
        this.employees.Push(employee);
        employee.company = this;
    };
    exports.Company = Company;
});

それ以外の場合、メッセージで言及したrequire（ "Employee"）も機能します。

一般に、モジュールを使用する場合は、AMDかどうかにかかわらず、循環依存関係をより意識する必要があります。単純なJavaScriptであっても、例ではGオブジェクトのようなオブジェクトを必ず使用する必要があります。

59
jrburke

これは、（複数レベルの）循環依存関係が検出されない大規模なプロジェクトではかなりの欠点だと思います。ただし、 madge を使用すると、循環依存関係のリストを出力して、それらに近づくことができます。

madge --circular --format AMD /path/src
15
Pascalius

開始時に依存関係をロードする必要がない場合（たとえば、クラスを拡張する場合）、次のようにすることができます： http://requirejs.org/docs/ api.html＃circular ）

ファイル内a.js：

    define( [ 'B' ], function( B ){

        // Just an example
        return B.extend({
            // ...
        })

    });

そして、他のファイルb.js：

    define( [ ], function( ){ // Note that A is not listed

        var a;
        require(['A'], function( A ){
            a = new A();
        });

        return function(){
            functionThatDependsOnA: function(){
                // Note that 'a' is not used until here
                a.doStuff();
            }
        };

    });

OPの例では、次のように変化します。

    define("Employee", [], function() {

        var Company;
        require(["Company"], function( C ){
            // Delayed loading
            Company = C;
        });

        return function (name) {
            this.name = name;
            this.company = new Company(name + "'s own company");
        };
    });

    define("Company", ["Employee"], function(Employee) {
        function Company(name) {
            this.name = name;
            this.employees = [];
        };
        Company.prototype.addEmployee = function(name) {
            var employee = new Employee(name);
            this.employees.Push(employee);
            employee.company = this;
        };
        return Company;
    });

    define("main", ["Employee", "Company"], function (Employee, Company) {
        var john = new Employee("John");
        var bigCorp = new Company("Big Corp");
        bigCorp.addEmployee("Mary");
    });
7
redolent

循環依存を避けるだけです。たぶん次のようなもの：

G.Company.prototype.addEmployee = function(employee) {
    this.employees.Push(employee);
    employee.company = this;
};

var mary = new G.Employee("Mary");
var bigCorp = new G.Company("Big Corp");
bigCorp.addEmployee(mary);

この問題を回避し、循環依存関係を維持しようとするのは良い考えではないと思います。一般的な悪い習慣のように感じます。この場合、エクスポートされた関数が呼び出されるときにこれらのモジュールが本当に必要になるため、機能します。しかし、実際の定義関数自体でモジュールが必要で使用される場合を想像してください。回避策はありません。これがおそらく、require.jsが定義関数の依存関係で循環依存関係を検出するとすぐに失敗する理由です。

本当に回避策を追加する必要がある場合、IMOが（この場合はエクスポートされた関数で）すぐに依存関係を要求するようにすれば、定義関数は正常に実行されます。しかし、よりクリーンなIMOは、循環的な依存関係を完全に回避するためのものであり、これは本当に簡単に行えると感じています。

5
Shu

循環依存関係のドキュメントを見ました： http://requirejs.org/docs/api.html#circular

Aとbに循環依存関係がある場合、モジュールにrequireを依存関係としてモジュールに追加するように指示します：

define(["require", "a"],function(require, a) { ....

「a」が必要な場合は、次のように「a」を呼び出します。

return function(title) {
        return require("a").doSomething();
    }

これは私のために働いた

5
yeahdixon

投稿されたすべての回答（ https://stackoverflow.com/a/25170248/14731 を除く）は間違っています。公式文書（2014年11月現在）でさえ間違っています。

私のために働いた唯一の解決策は、「ゲートキーパー」ファイルを宣言し、循環依存関係に依存するメソッドを定義することです。具体例については、 https://stackoverflow.com/a/26809254/14731 を参照してください。

上記のソリューションが機能しない理由は次のとおりです。

  1. できません：
var a;
require(['A'], function( A ){
     a = new A();
});

aを使用するコードブロックの前にこのコードブロックが実行される保証がないため、後でaを使用します。 （このソリューションは、90％の時間で機能するため、誤解を招きます）

  1. exportsが同じ競合状態に対して脆弱ではないと信じる理由はありません。

これに対する解決策は次のとおりです。

//module A

    define(['B'], function(b){

       function A(b){ console.log(b)}

       return new A(b); //OK as is

    });


//module B

    define(['A'], function(a){

         function B(a){}

         return new B(a);  //wait...we can't do this! RequireJS will throw an error if we do this.

    });


//module B, new and improved
    define(function(){

         function B(a){}

       return function(a){   //return a function which won't immediately execute
              return new B(a);
        }

    });

これらのモジュールAとBをモジュールCで使用できるようになりました

//module C
    define(['A','B'], function(a,b){

        var c = b(a);  //executes synchronously (no race conditions) in other words, a is definitely defined before being passed to b

    });
5
Gili

私の場合、「単純な」オブジェクトのコードをより複雑なものに移動することにより、循環依存関係を解決しました。私にとって、それはコレクションでありモデルクラスでした。私はあなたの場合、会社の従業員固有の部分を従業員クラスに追加すると思います。

define("Employee", ["Company"], function(Company) {
    function Employee (name) {
        this.name = name;
        this.company = new Company(name + "'s own company");
    };
    Company.prototype.addEmployee = function(name) {
        var employee = new Employee(name);
        this.employees.Push(employee);
        employee.company = this;
    };

    return Employee;
});
define("Company", [], function() {
    function Company(name) {
        this.name = name;
        this.employees = [];
    };
    return Company;
});
define("main", ["Employee", "Company"], function (Employee, Company) {
    var john = new Employee("John");
    var bigCorp = new Company("Big Corp");
    bigCorp.addEmployee("Mary");
});

少しハックしますが、単純な場合には機能するはずです。また、addEmployeeをリファクタリングしてEmployeeをパラメーターとして使用すると、部外者にとって依存関係はさらに明白になります。

0
Björn Tantau