webサイトを制作していて、フロントエンドのコードとデータを分けて管理したい時ってありますよね?
- プロフィールなどのちょっとしたデータのまとまりをページ内に表示したいけど、データベースを作るほどではない…
- ブログページなどで、原稿を書く人とコーディングする人が別の場合、原稿に修正が入る度にコードも書き直さなければいけなくて面倒…
- なるべく素のJavaScriptで処理したい(Node.jsのfsとかを使うほどではない...)
といった場合に、JSONやMarkdownファイルを直接HTMLファイルに読み込む方法を調べました。
XMLHttpRequest APIとFetch API
今回のように外部ファイルの内容を取得・表示する場合、XMLHttpRequestオブジェクトを利用する方法とFetchを利用する方法の2つのやり方があります。
FetchはPromiseベースで設計された新しいAPIで、非同期処理をXMLHttpRequestを利用する場合よりもスマートに実装できるので、Fetchを利用するのがよりモダンな書き方になります。
Fetchを利用する方法はこちら(https://qiita.com/outsider-kithy/items/785685507191014fc834)
本記事では、XMLHttpRequest APIを利用する方法を説明します。
JSONファイルを読み込む場合
まず、JSONファイルを読み込んでDOMに追加する場合のやり方です。
こんな感じのJSONデータをまとめたtigers.json
ファイルがあるとします。
[{"打順":"1番","ポジション":"中堅","選手":"近本"},{"打順":"2番","ポジション":"二塁","選手":"中野"},{"打順":"3番","ポジション":"右翼","選手":"森下"},{"打順":"4番","ポジション":"一塁","選手":"大山"},{"打順":"5番","ポジション":"三塁","選手":"佐藤輝"},{"打順":"6番","ポジション":"左翼","選手":"ノイジー"},{"打順":"7番","ポジション":"捕手","選手":"坂本"},{"打順":"8番","ポジション":"遊撃","選手":"木浪"},{"打順":"9番","ポジション":"投手","選手":"才木"}]
このJSONデータを、index.html
ファイル内のid="exportJson"
を持ったdiv要素内に、table要素として表示したいと思います。
<div id="exportJson">
<!--ここに表形式で出力-->
</div>
//getElementByIdで出力先を指定
var exportJson = document.getElementById("exportJson");
var table = document.createElement("table");
table.innerHTML = "<thead><tr><th>打順</th><th>ポジション</th><th>選手</th></tr></thead>";
var tbody = document.createElement("tbody");
table.appendChild(tbody);
getElementById()
メソッドで出力先を指定し、createElement()
メソッドでtable要素を追加しておきます。
XMLHttpRequestオブジェクトを利用
今回のように、JSONファイルなど外部のファイルを読み込んだり出力したりするためには、JavaScriptのXMLHttpRequest
オブジェクトを利用します。XMLHttpRequest
はJavaScriptでHTTPリクエストを行うための組み込みオブジェクトで、このオブジェクトを通して.json
や.md
ファイルを開いたり読んだりしていきます。
let xhr1 = new XMLHttpRequest();
//.jsonファイルを読み込む
xhr1.open("GET", "tigers.json", true);
xhr1.onreadystatechange = function() {
//レスポンスが正常に返ってきたら
if (xhr1.readyState === 4 && xhr1.status === 200) {
let data = JSON.parse(xhr1.responseText);
//JSONオブジェクトの数だけ<tr>要素を書き出す
for (let key in data) {
if (data.hasOwnProperty(key)) {
let tr = document.createElement("tr");
tr.innerHTML = "<td>" + data[key]["打順"] + "</td><td>" + data[key]["ポジション"] + "</td><td>" + data[key]["選手"] + "</td>";
tbody.appendChild(tr);
table.appendChild(tbody);
exportJson.appendChild(table);
}
}
}
}
//リクエストをサーバーに送信
xhr1.send();
xhr1.readyState === 4
はレスポンスが送信完了されたかどうかを、xhr1.status === 200
は正常にレスポンスが返ってきたかどうかを判定しているので、すなわちJSONデータが末尾まで正常に返ってきた場合、createElement
とappendChild
でDOMに追加する、という流れになっています。
参考:XMLHttpRequest: readyState プロパティ
JSON内の各オブジェクトはdata[key]
で取得でき、オブジェクトのプロパティにはdata[key]["打順"]
のように指定してアクセスすることができます。
これで、index.html
上にJSONデータを元にしたtableが表示されます。
Markdownファイルを読み込む場合
次に、Markdownファイルを読み込んでDOMに追加する方法です。
基本的な方法はJSONファイルの時と同じですが、MarkdownをHTMLに変換するために、
Marked.js
というライブラリを利用します。
参考:marked.js
こんな感じのtigers.md
ファイルがあるとします。
# 六甲颪
## 1番
六甲おろしに颯爽(さっそう)と
蒼天(そうてん)翔ける日輪の
青春の覇気麗しく
輝く我が名ぞ阪神タイガース
オウ オウ オウオウ
阪神タイガース フレ フレフレフレ
(...続く)
この.md
ファイルの内容を、index.html
のid="exportMarkDown"
を持ったdiv要素内に出力します。index.html
上でmarked.js
も忘れずに読み込んでおきます。
<h2>Markdownを読み込む</h2>
<div id="exportMarkDown">
<!--ここにMarkdownを出力-->
</div>
<!--Markd.jsの読み込み-->
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
そして、JavaScriptでJSONファイルの時と同様に、XMLHttpRequest
オブジェクトを利用して.md
ファイルを読み込みます。
//getElementByIdで出力先を指定
var exportMarkdown = document.getElementById("exportMarkDown");
let xhr2 = new XMLHttpRequest();
xhr2.open("GET", "tigers.md", true);
xhr2.onreadystatechange = function(){
if(xhr2.readyState === 4 && xhr2.status === 200){
let data = xhr2.responseText;
//marked.jsを利用してMarkdownをHTMLに変換
exportMarkdown.innerHTML = marked.parse(data);
}
}
xhr2.send();
HTMLへの出力の部分では、Marked.js
のmarked.parse()
メソッドを利用しています。
これで、index.html
上にMarkdownファイルの内容がDOM要素として追加されます。
コードの全文はこちら(https://github.com/outsider-kithy/parseJSON)