PowerShell でハッシュテーブルを "指定の順序で" JSON 化する方法

とある事情から、某M社の某製品Vに読み込ませるとある JSON ファイルを PowerShell で自動生成する案件が発生。

ということで、昨今の PowerShell で JSON ファイルを生成する方法をネットで検索してみる。
結果、次のような手法がよさそうであることがわかった。

• PowerShell のハッシュテーブルでモデルを組み立てる
• そうして組み立てたハッシュテーブルを、PowerShell 備え付けの ConvertTo-Json コマンドレットで JSON 化

これを踏まえて早速実装してみる。

まずはこんな感じでハッシュテーブルを生成して変数 $catalog に格納。

$catalog = @{

  manifestVersion = "1.1";

  info = @{

    id = "foobar";

  };

  packages= @();

}

この変数 $catalog をパイプを経由して (パイプ経由じゃなくてもいいんだけどとりあえず) ConvertTo-Josn に読み込ませてみる。

$catalog | ConvertTo-Json

すると下記のような結果が得られた。

{

  "info": {

    "id": "foobar"

  },

  "manifestVersion": "1.1",

  "packages": []

}

JSON 化すると、プロパティの出現順が、PowerShell コード上でハッシュテーブルを組み立てたときと違うのに気づく（manifestVersion プロパティと info プロパティの出現順が入れ替わってる）。

しかし、まぁ、ハッシュテーブルって、実装原理からしてそういうものであり、順序に意味はないコレクションなのだから、そんなもんだろ、と気に留めずにいた。

ではこの JSON を読み込ませてみましょう

さてこうして生成した JSON をファイルに保存し、いよいよ某M社の某製品Vに読み込ませると...

オマエの JSON は壊れてて読めん

という趣旨のエラーを吐くではないか。

※The catalog in the vsix is not valid. と言われてしまっている

経緯の詳細は省くが、小一時間ほど格闘した結果、どうやら、読み込ませる JSON 中、
manifestVersion プロパティがいちばんはじめに出現しないといけない
様子であるらしいことが見えてきた。

よもや、JSON でデータを供給するのに、そのプロパティ出現順序に制約があるとは思わなかった。

とにかく、某M社の某製品Vがそのような仕様・振る舞いになっている以上、こちらが生成する JSON をどうにかするしかなるまい。

しかしハッシュテーブルというものは、先に書いたとおり、たしか実装原理からしてプロパティ (というかハッシュテーブル上ではキー) の順序は指定や維持ができないのではなかったか。
これは面倒なことになった。

どうやって解決する?

...と思いつつ、念のためと思い「powershell ハッシュ」で検索すると、その検索結果の中に...

PowerShellのHashtableの並び替えを制御したい

という題の、ぎたぱそ氏の記事が目に飛び込んできた。

PowerShellのHashtableの並び替えを制御したい (2013年3月20日)
http://tech.guitarrapc.com/entry/2013/03/20/200351

早速読んでみると、なになに、PowerShell v.3.0 で、"[ordered]" というキーワードが追加装備され、これをハッシュテーブルを記述する先頭に付記すれば、キーの順序が維持されるとのこと!

ということで実装を変えてみた。

$catalog = [ordered]@{

  manifestVersion = "1.1";

  info = @{

    id = "foobar";

  };

  packages= @();

}



$catalog | ConvertTo-Json

その結果、下記のとおり、PowerShell のコード上で記述したのと同じプロパティの出現順序で JSON 上にも記載されるようになった。

{

  "manifestVersion": "1.1",

  "info": {

    "id": "foobar"

  },

  "packages": []

}

こうして出来上がった JSON をファイルに保存し、某M社の某製品Vに読み込ませたところ、今度は無事、正しく認識されるようになった。

おまけ

なお、最終的に生成する JSON は、改行やインデントといった書式整形は不要である。
そのため、ConvertTo-Json コマンドレットに対し、-Compress スイッチを付けて JSON 生成を行っている。

すなわち、

$catalog | ConvertTo-Json -Compress

を実行することで、

{"manifestVersion":"1.1","info":{"id":"foobar"},"packages":[]}

を得ている。