JavaScriptでヒアドキュメントを実装する方法を現役エンジニアが解説【初心者向け】

初心者向けにJavaScriptでヒアドキュメントを実装する方法について解説しています。ここではfunctionを使う方法、DOM要素を使う方法、ES6のテンプレートリテラルを使う方法を説明します。それぞれの書き方を見ていきましょう。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

JavaScriptでヒアドキュメントを実装する方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

そもそもJavaScriptについてよく分からないという方は、JavaScriptとは何なのかについて解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプJavaScript/jQuery講座の内容をもとにしています。

 

田島悠介

今回は、JavaScriptに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

ヒアドキュメントを実装する方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

ヒアドキュメントとは

ヒアドキュメントとは、特殊な記号などを含む文字列リテラルをプログラム中に記述するための特別な記法のことです。Unix系のシェルスクリプトや、Rubyなどに代表されるスクリプト言語などで利用されることが多いです。

ただし、JavaScriptでは提供されていない機能なので、幾つかのワザを利用するか、ES6のテンプレートリテラルを使って、似たような機能を実現します。

 

[PR] フロントエンドで挫折しない学習方法を動画で公開中

ヒアドキュメントを使うメリットと使われるケース

ヒアドキュメントは、書いたそのままをプログレミングに反映させるとこが出来ます。その為、読みやすいコーディングが行えます。また、シェルプログラムなどは、他のプログラムやスクリプトを呼び出すときにコマンドケースで呼び出すことが可能になります。

 

ヒアドキュメントを実装する方法

JavaScriptでは提供されていないため、少し方法を変えて実装をします。方法は「function」「DOM」「ES6のテンプレートリテラル」を使う3通りあります。

ちなみに、他の言語では

purint << heredoc
Test1
Test2
Test3
heredoc

のようにヒアドキュメントの開始と終了を宣言(今回の場合は 「<< heredoc」「heredoc」)し、その間にドキュメントを記載します。※言語によって多少の記載の仕方の違いがありますので、それぞれの言語で利用方法を確認してください。

 

functionを使って実装する方法

JavaScriptの関数にはひとつ面白い特徴があり、中身の無い関数を呼び出すと「関数のコードがそのまま出力される」のです。

const heredoc = function () {/*
  <div>
    <h1> JavaScriptで作成</h1>
  </div>
*/}

console.log(heredoc);

これを実行すると下記のように出力されます。

function () {/*
  <div>
    <h1> JavaScriptで作成</h1>
  </div>
*/}

この特徴を生かして、且つ余計な部分を出力されないように正規表現で対応すると

const heredoc = (function () {/*

  <div>

    <h1> JavaScriptで作成</h1>

  </div>

*/}).toString().match(/(?:/*(?:[sS]*?)*/)/).pop().replace(/^/*/, "").replace(/*/$/, "");

console.log(heredoc);

として、ヒアドキュメントの代わりに使うことが出来ます。

 

DOM要素を使って実装する方法

次の方法はDOMを利用する方法です。JavaScriptでは、他の言語と違いDOMを操作することが出来ますので、それを利用します。DOMでもいくつか方法があるのですが、今回はTEXTAREAを利用する方法です。

理屈は簡単で、非表示にしたTEXTAREAにヒアドキュメントを記載しておき、それを利用する。というものです。

【HTML】
<textarea id="heredoc" style="display:none">

  <div>

    <h1> JavaScriptで作成</h1>

  </div>

</textarea>
【JavaScript】
var heredoc_text = document.getElementById("heredoc").innerText;

console.log(heredoc_text);

注意点としては、ヒアドキュメント内にTEXTAREAを利用するときはTEXTAREAの閉じタグの方を「&lt;/textarea>」と記載する必要があるところです。

 

ES6のテンプレートリテラルを使って実装する方法

最後にご紹介するのは、ES6のテンプレートリテラルを使う方法です。これが一番簡単なのですが、IEでは利用できないなどの問題もあります。使い方は簡単で、「`(バッククォート)」で囲むことで出来ます。

const heredoc_temp = `

<div>

  <h1> JavaScriptで作成</h1>

</div>

`;

console.log(heredoc_temp );

とても簡単ですね。テンプレートリテラルは内部に変数を埋め込めたり、とても便利です。

 

実際に書いてみよう ・まとめ

今回はES6のテンプレートリテラルを使用したサンプルを紹介します。

<!DOCTYPE html>

  <html lang="ja">

  <head>

    <meta charset="utf-8">

    <title>heredoc JavaScript</title>

  </head>

  <body>

    <div class="heredoc"></div>

    <script type="text/javascript">

      //終了時間

      var EndTime_str = "2030/01/01 00:00:00"

      var EndTime = new Date(EndTime_str)

      //今時間

      var NowTime = Date.now();

      // 経過時間をミリ秒で取得

      var ms = EndTime.getTime() - NowTime;

      // ミリ秒を日に変換(端数切捨て)

      day = Math.floor(ms / (24*60*60*1000));

      var day;

      //ヒアドキュメントを作成

      heredoc_tmp = `

        <h1 value="${EndTime_str}">${EndTime_str}</h1>

        <p>

          <label>残り${day}日</label>

        </p>

      `;

      //ヒアドキュメントを使って、DOMを生成

      document.body.innerHTML= heredoc_tmp;

    </script>

  </body>

</html>
ヒアドキュメントを使用しなくても、実現したいことは実装することが出来かと思います。しかし、ヒアドキュメントを使用したほうが読みやすくなる為、不具合の介入も少なくすることが出来ると思いますので、今後覚えていきましょう。

 

監修してくれたメンター

小宮山晃史(こみやまこうじ)

現在はOracle系システムの導入コンサルに勤め、仕事でコーディングをする機会は少なくなくなっているが、ライフワークで数多くの言語を勉強中。

iphoneのアプリ開発やWEBサーバの構築など幅広く挑戦しています。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でもJavaScript・jQueryを使ったWebサービス公開を習得できるオンラインブートキャンプJavaScript/jQuery講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。