Element のプロパティに追加するデメリットは？

Question

ES6 で WeakMap があるので、 div などの Element にデータをもたせたいときには WeakMap と言うケースが多いように思います。
私もなんとなくそうやってましたが、考えてみると WeakMap にする必要は本当にあるのだろうかと疑問に思いました。

Element のプロパティと比べると WeakMap のメリットは、

• Element のプロパティに含まれる名前を気にせず使える
• WeakMap インスタンスを Closure で隠せる

くらいに思います。
Weak ならではの GC は、 Element のプロパティでも Element が GC されたときに他に参照がなければプロパティも GC されるので一緒だと思います。

「Closure で隠せる」ですが、本当に隠す必要があるのか、というのが最近思うことです。
WeakMap にデータを保存してるライブラリの拡張したりそのデータを再利用するなど、すでに保存されてるデータを取り出して使いたいことはけっこうあります。
Closure の中にあるとアクセスできないので、そのために global などに WeakMap を置くなら Element のプロパティに、ライブラリ名のオブジェクト作ってそこに入れておくほうが良いように思います。

document.body.mylibrary.flag = 1 みたいなアクセス方法になります。

Closure に隠す理由には「開発者ツールで内部のデータ見るような人に見られたり編集されたくない」というのもあるようですが（ゲームとか？）、開発者ツールで WeakMap が見えるスコープのところに breakpoint 置いて REPL で操作できるので意味ないです。

というわけで、プロパティに直接置けば良いのでは？と思うのですがあまりそういうのを見ないように思います。

プロパティに置くことのデメリットや、普通にプロパティにおいてるけど問題ない、など意見もらえたら、と思います。

Answer 1

WeakMap

要素ノードのプロパティに値を格納した場合、将来的に同じ名前のプロパティが拡張された場合に衝突する危険性があります。
WeakMap は要素ノードそのものを拡張するわけではないので、要素ノードにどんなプロパティが定義されても自由に設定できます。

Closure に隠す理由には「開発者ツールで内部のデータ見るような人に見られたり編集されたくない」というのもあるようですが（ゲームとか？）、開発者ツールで WeakMap が見えるスコープのところに breakpoint 置いて REPL で操作できるので意味ないです。

WeakMap の使いどころはスコープを分割できることにあり、ユーザから値を隠す目的で使うものではないと思います。
例えば、 <p id="sample"> に対して a.js と b.js が別々の WeakMap を定義すれば、それぞれ独立したスコープで値を埋め込む事が出来ます。
a.js で埋め込んだ WeakMap 値が b.js で埋め込んだ WeakMap 値と衝突する可能性はゼロです。

data-* 属性

プリミティブ値で良ければ、定義済みの data-* 属性を使う事も検討に値すると思います。
WeakMap とは逆にスコープが解放されているのが特徴で他の機能からも参照できるのでうまく使い分けると良いでしょう。

コード事例

• 要素ノードに複数の値を関連付ける - JSFiddle

'use strict';
var mylibraryA = {name: 'A', value: 'foo', flag: true},
    mylibraryB = {name: 'B', value: 'bar', flag: false},
    map = new Map([['mylibraryA', mylibraryA], ['mylibraryB', mylibraryB]]),
    p;

/**
 * property
 */
p = document.createElement('p');
map.forEach((object, name) => {
  for (let key of Object.keys(object)) {
    p[name + '-' + key] = object[key];
  }
})
console.log(JSON.stringify(Object.keys(p)));  // ["mylibraryA-name", "mylibraryA-value", "mylibraryA-flag", "mylibraryB-name", "mylibraryB-value", "mylibraryB-flag"]

/**
 * data-* attribute
 */
p = document.createElement('p');
map.forEach((object, name) => {
  for (let key of Object.keys(object)) {
    p.setAttribute('data-' + name + '-' + key, object[key]);
  }
})
console.log(p.outerHTML); // <p data-mylibrarya-name="A" data-mylibrarya-value="foo" data-mylibrarya-flag="true" data-mylibraryb-name="B" data-mylibraryb-value="bar" data-mylibraryb-flag="false"></p>

/**
 * data-* attribute + JSON
 */
p = document.createElement('p');
map.forEach((object, name) => {
  p.setAttribute('data-' + name, JSON.stringify(object));
})
console.log(p.outerHTML); // <p data-mylibrarya="{&quot;name&quot;:&quot;A&quot;,&quot;value&quot;:&quot;foo&quot;,&quot;flag&quot;:true}" data-mylibraryb="{&quot;name&quot;:&quot;B&quot;,&quot;value&quot;:&quot;bar&quot;,&quot;flag&quot;:false}"></p>

/**
 * WeakMap
 */
p = document.createElement('p');
var wmapA = new WeakMap([[p, mylibraryA]]),
    wmapB = new WeakMap([[p, mylibraryB]]);
console.log(JSON.stringify(wmapA.get(p))); // {name: "A", value: "foo", flag: true}
console.log(JSON.stringify(wmapB.get(p))); // {name: "B", value: "bar", flag: false}

Re: lazex さん

Comments

[lazex]

返事遅くなってすみません

> 将来的に同じ名前のプロパティが拡張された場合に衝突する危険性
> WeakMap の使いどころはスコープを分割できること

これらは把握してます
なので `document.body.mylibrary.flag = 1` のようにライブラリなどデータを保存するものの識別子のプロパティ名にそこで使われるデータをオブジェクトで入れようと考えています。

重複が 100% 無いとは言えませんが、ライブラリ名とすればほぼ重複はないでしょうし、あるとしてもそれ以前にロードしたらwindow以下に自動でライブラリ名で設定される変数や jQuery の追加されたメソッド名など別のところで問題がでることが多いと思うので、ライブラリ名のオブジェクトに入れる場合は余り問題と思っていません。

data-* のほうはクローンで引き継がれるメリットもあるのですが、あまりに多い場合にdevtoolsで確認の際にすごくみづらいのが困りどころです。
あと、重複しないようにライブラリ名を入れてるのですが、それがまたHTMLタグ的にすごく辛い長さになるんですよね
`<div data-mylibrary-value="1" data-mylibrary-name="abc" data-mylibrary-flag="1" ...></div>`
みたいに

他の解答もないようですし、仕様的にまずいということがないのがわかったので助かりました。
ありがとうございます。

[think49]

> あと、重複しないようにライブラリ名を入れてるのですが、それがまたHTMLタグ的にすごく辛い長さになるんですよね
"mylibrary-" のような接頭辞に入れる手法を取るのなら、data-* 属性にしろ、プロパティ埋め込みにしろ、key名が冗長になってしまうのは避けられません。
一応、data-* 属性の場合は JSON 化してひとまとまりの値にする方法があります。
全てを解決するのが WeakMap だと思います。
親記事にコード事例を追記しました。

[lazex]

JSON化だと関数が失われたり、プレーンなオブジェクトになってプロトタイプチェーンによるメソッド呼び出しなどできなくなる問題ありますし、WeakMapかプロパティにライブラリ名の2択なんですよね

WeakMap はメリットも大きいですが、そのデータを他から使える形にしたいときに置き場所に困るのが個人的に困るところです
HTML要素に対するデータなのでそのプロパティが直感的で一番いいのですが、それのデメリットはないかというのが気になっていた箇所で、結局アクセスするのに名前が長いくらいしか問題なさそうで、書いてみたら気になるほどではなかったので自分なりに満足できました

[weakmapのばあい]
const elem = document.querySelector("#id")
const data = mylibrary.weakmap.get(elem)
console.log(data.value1)
console.log(data.value2)

[propertyのばあい]
const elem = document.querySelector("#id")
const data = elem.mylibrary
console.log(data.value1)
console.log(data.value2)

基本使うところでローカル変数にいれるので、識別子名が極端にながくなければ weakmap から取り出しでも対して変わらなかったです。