Loading article…
コンピュータプログラミングにおいて、定型コード、または単にボイラープレートとは、ほとんどまたはまったく変化なく複数の場所で繰り返されるコードセクションです。冗長と見なされる言語を使用する場合、プログラマーはわずかな機能のみを実現するために大量の定型コードを記述する必要があります。[1]
定型コードの必要性は、メタプログラミング(必要な定型コードをコンピューターが自動的に記述するか、コンパイル時に挿入する)、構成より規約(適切なデフォルト値を提供し、すべてのプロジェクトでプログラムの詳細を指定する必要性を減らす)、モデル駆動型エンジニアリング(モデルとモデルからコードへのジェネレーターを使用して、手動の定型コードの必要性を排除する) などの高レベルのメカニズムを通じて軽減できます。
定型コードを抽象クラスに移動して、任意の数の具象クラスに継承できるようにすることもできます。別のオプションとしては、コードをサブルーチンに移動して、重複するのではなく呼び出せるようにする方法があります。
起源
この用語は新聞業界から生まれた。印刷シンジケートによって配布されたコラムやその他の記事は、用意された印刷版の形で購読している新聞に送られた。ボイラーの製造に使用された金属板に似ていることから、「ボイラープレート」と呼ばれ、そのテキストは「ボイラープレートテキスト」と呼ばれるようになった。ボイラープレートで配布された記事は通常「真面目な」ニュースではなく「フィラー」であったため、この用語は独創性のない繰り返しのテキストと同義になった。 [2] [3]
関連する用語として、ブックキーピング コードがあります。これは、ビジネス ロジックの一部ではないが、データ構造を最新の状態に維持したり、プログラムの 二次的な側面を処理したりするためにビジネス ロジックとインターリーブされるコードを指します。
前文
定型句の 1 つの形式は、プログラム ロジックや言語の基本的な構文の一部ではないものの、カスタムとしてソース ファイルの先頭に追加される宣言で構成されます。次のPerl の例は、定型句を示しています。
#!/usr/bin/perl
警告を使用します。厳密なものを使用します。
最初の行は、ファイルが Unix/Linux システムのコマンド ラインで直接実行できる Perl スクリプトであることを示すshebangです。他の 2 つは、警告と厳密モードをオンにするプラグマで、流行の Perlプログラミング スタイルで義務付けられています。
次の例は、C/C++プログラミング言語の定型句である#includeguardです。
#ifndef MYINTERFACE_H
#define MYINTERFACE_H
...
#終了
これは、ファイル myinterface.h がすでにインクルードされているかどうかをコンパイラーに伝えるグローバル フラグをチェックして設定します。モジュールのコンパイルには相互に依存するファイルが多数含まれる可能性があるため、これにより同じヘッダーが複数回処理されることが回避されます (同じ名前の複数の定義が原因でエラーが発生します)。
Javaおよび類似のプラットフォーム
Javaプログラムでは、DTOクラスにインスタンス変数を取得および設定するためのメソッドが提供されることがよくあります。これらのメソッドの定義は、多くの場合、定型文とみなすことができます。コードはクラスごとに異なりますが、構造が十分に定型的であるため、手動で記述するよりも自動的に生成する方が適しています。たとえば、ペットを表す次のJavaクラスでは、 Pet、name、およびownerの宣言を除いて、ほぼすべてのコードが定型文です。
ジャワ
パブリッククラスPet {プライベート文字列名;プライベートPerson所有者;
public Pet ( String name , Person owner ) { this.name = name ; this.owner = owner ; }
パブリック文字列getName () {戻り値 name ; }
public void setName ( String name ) { this . name = name ; }
パブリックPerson getOwner () {所有者を返します; }
public void setOwner ( Person所有者) { this .owner = owner ; } }
この例の定型文のほとんどは、JavaBeansの要件を満たすために存在します。変数の名前と所有者がpublicとして宣言されている場合、アクセサー メソッドとミューテーター メソッドは必要ありません。
Java 14では、この問題に対処するためにレコードクラスが追加されました。[4] [5] [6]
定型文の量を減らすために、Java用のLombokなど多くのフレームワークが開発されてきました。[7]上記と同じコードは、メタプログラミングの一形態であるJavaアノテーションを使用してLombokによって自動生成されます。
@AllArgsConstructor
@Getter
@Setter
public class Pet { private String name ; private Person owner ; }
スカラ
他のプログラミング言語では、言語にそのような一般的な構造のサポートが組み込まれている場合、より少ない定型文で同じことを実現できる可能性があります。たとえば、上記の Java コードと同等のものは、Scalaでは1 行のコードだけで表現できます。
ケースクラスPet ( var name : String , var owner : Person )
C#
または、 C#では、コンパイラによって生成されたバッキング フィールドを持つ自動プロパティを使用します。
パブリッククラスPet {パブリック文字列Name {取得;設定; }パブリックPerson Owner {取得;設定; } }
C# 9.0 以降では、プロパティを持つクラスを自動的に生成するレコードを使用できるようになりました。
公開レコードPet (文字列名前、所有者) ;
メソッド定型文
宣言に加えて、 OOP 言語のメソッドも定型文の量に影響します。2015 年に行われた Java プロジェクトの人気調査では、メソッドの 60% はトークンの 4.6% の出現によって一意に識別でき、残りの 95.4% の定型文はロジックとは無関係であることが示されています。研究者は、この結果は手続き型言語のサブルーチン全般に当てはまると考えています。[8]
html
HTMLでは、次の定型文が基本的な空のテンプレートとして使用され、ほとんどの Web ページに存在します。
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "UTF-8" />
< title >テスト</ title >
</ head >
< body >
</ボディ>
</ html >
WHATWG HTML Living Standardでは、、、およびタグはほとんどの場合省略しても問題ないと定義されています。<html> [ <head>9 <body>]タグは、文字エンコーディングをHTTPヘッダーで送信するように設定されたWebサーバーから直接送信される場合、技術的には冗長ですが、HTML応答がファイル、キャッシュ、またはWebアーカイブに保存される場合に役立ちます。[10] GoogleのHTML / CSSスタイルガイドでは、すべてのオプションタグを省略することを推奨しており、[11]結果的に定型文が大幅に減ります。ワールドワイドウェブコンソーシアムは、要素を空にしてはならないと述べています。[12]<meta charset="UTF-8">.html <title>
<!DOCTYPE html>
< title >テスト</ title >
パイソン
Pythonでは、次の定型コードを使用して、コードがモジュール コンテキスト内またはモジュール コンテキスト外でのみ実行可能かどうかを変更できます。
if __name__ == '__main__' :
# ここに置かれたものはモジュールコンテキストでは決して実行されません
。
if __name__ != '__main__' :
# ここに置かれたものはすべてモジュールコンテキストでのみ実行されます
。
参照
- ディレクティブ（プログラミング） – コンパイラが入力をどのように処理するかを指定する言語構造
- 汎用マクロ プロセッサ – 特定の言語またはソフトウェアに関連付けられたり統合されたりしないマクロ プロセッサ。
- 「Hello, World!」プログラム – コンピュータプログラミング言語の伝統的な最初の例
- ライブラリ（コンピューティング） – コンピュータプログラムの開発に使用されるリソースのコレクション
- マクロ（コンピュータサイエンス） - 設定された入力を設定された出力に置き換える規則
- プリプロセッサ – 別のプログラムの入力を処理するプログラム
- スキャフォールディング（プログラミング） - コード生成技術またはプロジェクト生成技術
- スニペット（プログラミング） – 再利用可能なソースコード、マシンコード、またはテキストの小さな領域
- テンプレートプロセッサ – テンプレートとデータモデルを組み合わせて結果ドキュメントを生成するように設計されたソフトウェア
- Web テンプレート システム – Web 公開におけるシステム
参考文献
- ^ Lämmel, Ralf; Jones, Simon Peyton (2003)。「定型文を捨てる: ジェネリックプログラミングの実用的なデザインパターン」。2003 ACM SIGPLAN 国際ワークショップ「言語の設計と実装における型」の議事録。TLDI '03。ニューヨーク: ACM。pp. 26–37。doi :10.1145/604174.604179。ISBN 9781581136494. S2CID 9472305。
- ^ 「Boilerplate」. Dictionary.com . 2018年1月27日閲覧。
- ^ 「Boilerplate」。Merriam -Webster 。2018年1月27日閲覧。
- ^ 「レコード クラス」。docs.oracle.com。
- ^ “JEP 395: 記録”. openjdk.org。
- ^ Evans, Ben (2020-11-01). 「レコードが Java に登場」. blogs.oracle.com .
- ^ Frankel, Nicolas (2009-12-07). 「Lombok は定型コードを削減します」. DZone.com . 2017-08-02閲覧。
- ^ Martin Velez、Dong Qiu、You Zhou、Earl T. Barr、Zhendong Su (2015 年 2 月 5 日)。「ソース コードの語彙的区別可能性について [旧題: ソース コードにおける「小麦」と「もみ殻」の研究]」。arXiv : 1502.01410 [cs]。
- ^ 「HTML 標準 - HTML 構文 - オプションのタグ」。WHATWG。2017年5 月 5 日。2017年 5 月 5 日閲覧。
- ^ 「HTML5 では charset メタタグは必須ですか?」。stackoverflow.com。2017年 5 月 5 日閲覧。
- ^ 「Google HTML/CSS スタイル ガイド」。google.github.io 。2017年 5 月 5 日閲覧。
- ^ 「HTML ページに空でないタイトルがあります」。www.w3.org 。2021年7 月 22 日閲覧。