質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.91%

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

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 1,598

lazex

score 423

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 で操作できるので意味ないです。

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

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

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+2

 WeakMap

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

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

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

 data-* 属性

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

 コード事例

'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 さん

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/03/12 22:30

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

    > 将来的に同じ名前のプロパティが拡張された場合に衝突する危険性
    > 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>`
    みたいに

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

    キャンセル

  • 2017/03/13 01:00

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

    キャンセル

  • 2017/03/18 17:51

    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 から取り出しでも対して変わらなかったです。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.91%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る