概要
bind() メソッドが呼ばれると、this キーワードに引数 thisArg がセットされた新しい関数をつくり出します。その新しい関数に引数を与えて呼び出すと、bind() の際に与えた2個目以降の引数の後にその引数がつなげられて実行されます。
構文
fun.bind(thisArg[, arg1[, arg2[, ...]]])
引数
-
thisArg -
束縛された関数が呼ばれるとき、
thisになるものとしてターゲット関数に渡される値を指定します。束縛された関数がnew演算子を使って呼び出された場合、この引数は無視されます。 -
arg1, arg2, ... - ターゲット関数が呼ばれるとき、束縛された関数に与えた引数がターゲット関数の最初の引数として挿入されます。
説明
bind() 関数は、新たな関数(束縛された関数 = a bound function)をつくって返します。この新たな関数の本体(ECMAScript 5 の観点では内部の call プロパティ)は call() が呼ばれた関数(束縛された関数のターゲット関数)【訳注: fun.bind(thisArg) での fun 】 と同じものですが、その内側での this の値は code() に与えた第1引数になり(束縛され)、それを上書きすることはできません。また bind() で、ターゲット関数の先頭部分のデフォルト引数を指定することもできます。この引数は束縛された関数が呼ばれたときターゲット関数に渡されます。また、束縛された関数を new することで新たなオブジェクトを構築することもできます。この場合、新しいオブジェクトは、あたかも(束縛された関数ではなく)ターゲット関数が構築されたかのように振る舞います。this 値を与えても無視されますが、それに続けて与えたパラメータは、エミュレートされている関数に渡されます。
例
束縛された関数をつくる
最もシンプルな bind() の使い方は、どのように呼び出された場合でも同じ this 値を持つ関数をつくることです。初心者の JavaScript プログラマーがよくやる間違いは、あるオブジェクトからあるメソッドを取り出して、あとでその関数を呼び出すとき、その内側の this 値が元々のオブジェクトになると考えてしまうことです(例えばそのメソッドをコールバック関数に使うケース)。しかし、特別に配慮しなければ、元々のオブジェクトはどこかへ行ってしまいます【訳注: 取り出した関数内の this としては使えなくなる】。その関数に元々のオブジェクトを bind() して束縛された関数をつくり出せば、この問題をきちんと解決することができます:
var x = 9;
var module = {
x: 81,
getX: function() { return this.x; }
};
module.getX(); // 81
var getX = module.getX;
getX(); // 9, この場合 "this" はグローバルオブジェクトを参照するため
// 'this' を module に結びつけた新しい関数を作成
var boundGetX = getX.bind(module);
boundGetX(); // 81
Partial Functions
もうひとつの、最もシンプルな bind() の使い方は、あらかじめ引数が指定されている関数をつくることです。この引数を指定するには(指定しないことも可能)、this 値の後に並べます。すると、ターゲット関数がいつ呼ばれたときでも、その引数が、ターゲット関数に渡される引数の先頭部分に挿入されます。
function list() {
return Array.prototype.slice.call(arguments);
}
var list1 = list(1, 2, 3); // [1, 2, 3]
// 先頭の引数がプリセットされた関数をつくる
var leadingThirtysevenList = list.bind(undefined, 37);
var list2 = leadingThirtysevenList(); // [37]
var list3 = leadingThirtysevenList(1, 2, 3); // [37, 1, 2, 3]
setTimeout とともに
デフォルトでは、 window.setTimeout() 内部の this キーワードは window(あるいは global オブジェクト)に設定されます。this がクラスインスタンスを参照していることが必要なクラスメソッドを使う場合、this とコールバック関数とを明確に結びつけ(バインドして/束縛して)、インスタンスを維持することができます。
function LateBloomer() {
this.petalCount = Math.ceil( Math.random() * 12 ) + 1;
}
// 1秒遅延させてから bloom を宣言する
LateBloomer.prototype.bloom = function() {
window.setTimeout( this.declare.bind( this ), 1000 );
};
LateBloomer.prototype.declare = function() {
console.log('I am a beautiful flower with ' + this.petalCount + ' petals!');
};
束縛された関数をコンストラクタとして使う
bind() メソッドのエッジケースを説明していますが、以下の方法がベストなわけではなく、むしろプロダクション環境では推奨されない方法です。束縛された関数は自動的に、new演算子を使ってターゲット関数の新しいインスタンスをつくれるようになっています。新たな値を構築するために束縛された関数を使うと、thisを与えても無視されます。しかし、同時に与える引数はコンストラクタ呼び出しの先頭部分に挿入されます:
function Point(x, y) {
this.x = x;
this.y = y;
}
Point.prototype.toString = function() {
return this.x + "," + this.y;
};
var p = new Point(1, 2);
p.toString(); // "1,2"
var emptyObj = {};
var YAxisPoint = Point.bind(emptyObj, 0 /* x */);
var YAxisPoint = Point.bind(null,0 /*x*/); // doesn't support in the above polyfill
// works fine with native bind
var axisPoint = new YAxisPoint(5);
axisPoint.toString(); // "0,5"
axisPoint instanceof Point; // true
axisPoint instanceof YAxisPoint; // true
new Point(17, 42) instanceof YAxisPoint; // false
束縛された関数を new とともに使えるようにするのに、特別な設定は必要ないことを忘れないでください。なので当然、普通に呼び出されるような束縛された関数をつくる際も特別なことは必要ありません。もしその関数を new 演算子とともに呼び出すことにしか使いたくないと思っても、普通に呼び出すことはできてしまいます。
// この例は JavaScript コンソールで直接実行できます // ...上の例のつづき // 普通の関数としても実行できます(あまり必要にはなりませんが) YAxisPoint(13); emptyObj.x + "," + emptyObj.y; // > "0,13"
束縛された関数を new でしか使えないように制限したい場合、または通常の呼び出しだけに制限したい場合には、ターゲット関数がその制限を強制するようにしなければなりません。
ショートカットをつくる
bind() は、特定の this を必須とするような関数のショートカットを作成するのにも便利です。
例として Array.prototype.slice を取り上げます。この関数は、配列に似たオブジェクトを本物の配列へ変換するために使えます。まず、次のようにショートカットをつくることができます:
var slice = Array.prototype.slice; // ... slice.call(arguments);
bind() を使うともっとシンプルにできます。次のコードでは、slice は Function.prototype.call() 関数に結びつけられた関数となり、その中での this 値は Array.prototype.slice() 関数となります。こうすると、いちいち call() を呼び出す必要がなくなります:
var unboundSlice = Array.prototype.slice; // ひとつ前の例の "slice" と同じ var slice = Function.prototype.call.bind(unboundSlice); // ... slice(arguments);
Polyfill
bind 関数は ECMA-262 第5版に最近追加されたので、すべてのブラウザに存在するわけではありません。以下のコードをあなたのスクリプトの先頭に挿入すれば、その状況をいくらか変えることができます。ネイティブにはサポートされていない実装において、bind() の多くの機能を使えるようになります。
if (!Function.prototype.bind) {
Function.prototype.bind = function (oThis) {
if (typeof this !== "function") {
// closest thing possible to the ECMAScript 5 internal IsCallable function
throw new TypeError("Function.prototype.bind - what is trying to be bound is not callable");
}
var aArgs = Array.prototype.slice.call(arguments, 1),
fToBind = this,
fNOP = function () {},
fBound = function () {
return fToBind.apply(this instanceof fNOP && oThis
? this
: oThis,
aArgs.concat(Array.prototype.slice.call(arguments)));
};
fNOP.prototype = this.prototype;
fBound.prototype = new fNOP();
return fBound;
};
}
このアルゴリズムと仕様上のアルゴリズムとの間には、いくつか大きな違いがあります(真剣に網羅することを目指したわけではないので、他にも差はあるかもしれません):
- この部分的な実装は
Array.prototype.slice,Array.prototype.concat,Function.prototype.call,Function.prototype.applyという、それぞれオリジナルの値を持つ組み込みメソッドに依存している。 - この不完全な実装がつくり出す関数は、不変の(immutable) "poison pill"
callerプロパティとargumentsプロパティ(get, set, delegate の際にTypeErrorを投げる【訳注: strict mode での話をしているようだ】)を持たない(Object.definePropertyをサポートする実装の上ではこれを追加することができる。あるいは__defineGetter__と__defineSetter__をサポートする実装上でも部分的に実装可能だが、delegate の際に例外を投げるようにはできない)。 - この不完全な実装は
prototpyeプロパティを持つ関数をつくり出す(正規の束縛された関数には存在しない)。 - この不完全な実装でつくられた束縛された関数の
lengthプロパティは、ECMA-262 で示されているものと一致しない。この実装がつくる関数のlengthは常に 0 だが、完全な実装においては、ターゲット関数と先行定義引数の長さ次第で、0 ではない長さになりうる。
もしこの不完全な実装を使うことを選ぶなら、ECMA-262 第5版の定義から外れる挙動に依存しないように! ただし、いくらか気をつければ(特定の要望に適するような追加修正も必要かもしれません)、この不完全な実装は、bind() が広く仕様通りに実装されるまでの悪くないつなぎとして使えるでしょう【訳注: Prototype.js の Function#bind、jQuery の jQeury.proxy()、Underscore.js の _.bind() など多数のライブラリでも提供されています】。
Specifications
| Specification | Status | Comment |
|---|---|---|
| ECMAScript Language Specification 5.1th Edition (ECMA-262) | Standard | Initial definition. Implemented in JavaScript 1.8.5 |
| ECMAScript Language Specification 6th Edition (ECMA-262) | ドラフト |
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|
| Basic support | 7 | 4.0 (2) | 9 | 11.60 | 5.1.4 |
| Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | 4.0 | 0.16 | 4.0 (2) | ? | 11.50 | 6.0 |
Based on Kangax's compat tables.