javascriptのクロージャでpublicなオブジェクトを変更したい

Question

javascriptでのプログラミングを勉強しています。

グローバル変数の汚染対策として、モジュールの定義について調べて以下のようなコードを書いています。
まずモジュールを定義し、内部ではobjをpublicな変数として定義しました。その後objを書き換え、結果を出力してみました。

出力結果では、Hello.objもHello.getObj()も{"key": "newvalue"}が出力されることを期待していたのですが、Hello.getObj()は元のまま{"key": "value"}となっていてあれ??となってしまいました。

// モジュールの定義
var Hello = (function() {
  var obj = {"key": "value"};
  var getObj = function() {
    return obj;
  };
  return {"obj": obj, "getObj": getObj};
}());

// publicな変数の変更
Hello.obj = {"key": "newvalue"};

// 出力結果
console.log(Hello.obj); // {"key": "newvalue"}
console.log(Hello.getObj()); // {"key": "value"}

Helloモジュールのreturnでは、objが参照渡しで返されている??と思いますので、値のコピーを変更しているわけではないようです。
例えばモジュール定義の後でobjのキーを直接指定して変更すると、期待している動作になりました。

// publicな変数の変更
Hello.obj.key = "newvalue";

// 出力結果
console.log(Hello.obj); // {"key": "newvalue"}
console.log(Hello.getObj()); // {"key": "newvalue"}

ですので、最初のオブジェクトを上書きしてしまう方法では、モジュール内のobjと参照が切れてしまうということなのでしょうか??
また、参照が切れないようにobj変数をオブジェクトで上書きする方法はありますでしょうか??(setメソッドを用意すれば解決できると思いますが、イコールでオブジェクトを上書きできるように、モジュールを定義する方法があれば教えていただきたいです)

ご回答よろしくお願いいたします。

Answer 1

Object.create や Object.defineProperty で {writable: false} を宣言すれば hello.obj の書き換えは禁止されると思います。
https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Object/create
https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty

getter がメソッド/プロパティの両方で参照出来るコードになっているので、どちらか一つに絞った方がわかりやすいと思います。

Re: zpoket さん

Comments

[zpoket]

ご回答ありがとうございます。

Hello.obj = {"key": "newvalue"};
とした後にHello.getObj()を実行したときに、{"key": "newvalue"}が返ったらよいなと思い、そのためにモジュール定義をどう修正すべきか疑問に思った次第です。（それを実現するために、Object.defineProperty で {writable: false}を設定するのが有効であるということだったのでしょうか??）

[think49]

zpoket さんは obj を参照する getter メソッドとして hello.getObj() を定義しました。
しかし、同じオブジェクトを hello.obj でも参照可能であり、これも getter として機能します。
hello.getObj() を使うなら hello.obj が不要であり、hello.obj を使うなら hello.getObj() が不要でしょう。
ですので、hello.getObj(), hello.obj のどちらか一つは削除して良い存在である、ということです。

Object.defineProperty は hello.obj の再代入による書き換えを禁止出来ます。
hello.getObj() は obj をクロージャに閉じこめることで obj の参照書き換えを禁止する事が可能ですが、hello.getObj() そのものを書き換える事で間接的に hello.getObj() の返り値を書き換える事が出来てしまいます。
これも Object.defineProperty を使うことで回避できます。

[think49]

すみません、質問を誤解していたので Object.defineProperty の下りは忘れて下さい…。
ただ、やはり、hello.getObj() の存在異議が分かりません。
var hello = {obj: {key: 'value'}}; で十分なコードに読めます。

[zpoket]

実際のコードでは、hello.getObj()を用意するつもりはなく、Hello.objでアクセスできればい良いです。Helloモジュールにある関数を定義し、その処理の中でHello.objを参照したとき、想定外のオブジェクトを参照していたため、それをシンプルに表現するためHello.getObj()を用意していました。(説明が不足していて、誤解を招いてしまって申し訳ありません‼︎)

Answer 2

Helloに実行結果を入れるよりはnewしたほうがわかりやすいのでは？

var Hello = new function() {
  this.obj = {"key": "value"};
  this.getObj = function() {
    return this.obj;
  };
  this.setObj = function(arg) {
    return this.obj=arg;
  };
}();
console.log(Hello.obj);
Hello.setObj({"key": "newvalue"});
console.log(Hello.obj);
console.log(Hello.getObj());

Comments

[zpoket]

ご回答ありがとうございます。

newは使わないほうが良いという記事を見たことがあり避けていましたが、わかりやすさを考えると、yambejpさんの記述のほうが良いかもしれませんね。

Answer 3

最初のオブジェクトを上書きしてしまう方法では、モジュール内のobjと参照が切れてしまうということなのでしょうか??

はい、そのとおりです。Hello.obj = {"key": "newvalue"};と書くと、リテラルで生成した新しいオブジェクトを代入することになり、元のobjとは別なオブジェクトになってしまいます。

参照が切れないようにobj変数をオブジェクトで上書きする方法はありますでしょうか??

いちばん手っ取り早いのは、getObj()がHello.objを返すようにしてしまう方法です（もっとも、それが意図したとおりの動作なのかわからない部分はありますが）。

Comments

[zpoket]

ご回答ありがとうございます。
試行錯誤で動かしてみてはいるのですが、確証を得られずにいましたので助かりました。

getObj()がHello.objを返す方法というのは具体的な書き方として、
var getObj = function() {return this.obj;};
とgetObj()を定義するということでしょうか??(動作を確認したところ、意図している動作にはなっておりました!!)

this.objとすることで、var objではなく、Helloモジュールで返されるオブジェクトの中のobjを、getObjが返してくれるようになったのかなと思っていますが、「this」をあまり使用したことがないため、このような書き方で逆に紛らわしいコードを書いていないかだけ心配でおります。