ファイルテンプレートの変数

ファイルテンプレートは変数を含むことができ、テンプレートの適用時にその値に置き換えられます。変数はドル記号 $ で始まる文字列です。変数名は中括弧で囲むこともできます。例えば: $MyVariable と ${MyVariable} は同じ変数の異なる表記です。

事前定義された変数とカスタム変数は、テンプレート本体とファイル名で使用できます。例: テンプレートのファイル名フィールドに MyFile_${MONTH_NAME_FULL} と入力した場合、4 月に作成すると、結果のファイルの名前は MyFile_April になります。ここで、 ${MONTH_NAME_FULL} は事前定義された変数です。代わりにカスタム変数を使用する場合、IntelliJ IDEA は、このテンプレートに基づいてファイルを作成するときに変数値を入力するように求めます。

定義済みテンプレート変数

次の事前定義された変数をファイルテンプレートで使用できます。

変数	説明
`${DATE}`	現在のシステム日付
`${DAY}`	現在の月の日
`${DIR_PATH}`	コンテンツルートからの新しいファイルのディレクトリへのパス
`${DS}`	ドル記号 `$`。この変数はドル記号文字をエスケープするために使用され、テンプレート変数のプレフィックスとして扱われません。
`${FILE_NAME}`	新しいファイルの名前
`${HOUR}`	現在の時間
`${MINUTE}`	現在の分
`${SECOND}`	現在の秒
`${MONTH}`	現在の月
`${MONTH_NAME_FULL}`	現在の月のフルネーム (January、February など)
`${MONTH_NAME_SHORT}`	現在の月名の最初の 3 文字 (Jan、Feb など)
`${NAME}`	新しいエンティティの名前 (ファイル、クラス、インターフェースなど)
`${PACKAGE_NAME}`	新しいクラスまたはインターフェースファイルが作成されるターゲットパッケージの名前
`${PRODUCT_NAME}`	IDE の名前 (たとえば、IntelliJ IDEA)
`${PROJECT_NAME}`	現在のプロジェクトの名前
`${TIME}`	現在のシステム時刻
`${USER}`	現在のユーザーのログイン名
`${YEAR}`	現在の年

変数メソッド

IntelliJ IDEA はファイルテンプレートのテンプレートエンジンとして Velocity を使用するため、ファイルテンプレートの変数は Java 文字列メソッドを使用できます。例: 次のことが可能です。

${NAME.toUpperCase()}: 新しいエンティティ (ファイル) の名前を大文字に変換します。
${PROJECT_NAME.length()}: プロジェクト名の長さを出力します。
${PRODUCT_NAME.substring(0,5)}: 使用している IDE の名前の最初の 5 文字を出力します。

カスタムテンプレート変数

事前定義されたテンプレート変数に加えて、カスタム変数を指定することができます。必要に応じて、 #set ディレクティブを使用して、テンプレート内でカスタム変数の値を定義できます。対応する変数が使用される前にディレクティブを記述します。

例: 事前定義された変数 ${USER} で定義されたログイン名の代わりにフルネームを使用する場合は、カスタム変数の前に次の構成を追加します。

            #set( $MyName = "John Smith" )
            Created by: $MyName

変数の値がテンプレート内で定義されていない場合、IntelliJ IDEA はテンプレートが適用されたときにそれを指定するように求めます。

例: このテンプレートに基づいて新しいファイルを作成するたびに、メソッドの名前とそのメソッドのパラメーターを入力するように求める次の Java ファイルテンプレートを作成できます。

                #if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

                public class ${NAME} {
                    static void ${MethodName}(String ${Parameter}) {
                        System.out.println(${Parameter});
                    }
                }
            
  

この例では、 ${MethodName} 変数と ${Parameter} 変数を使用し、それらの値を設定しません。このテンプレートに基づいてファイルを作成すると、IntelliJ IDEA はこれらの変数の値を指定するように要求します。

結果のファイルでは、変数は新しいファイルダイアログに入力した値（この例ではメソッド名とパラメーター名）に置き換えられます。

                package com.example.somepackage;

                public class newClass {
                    static void newMethod(String myName) {
                        System.out.println(myName);
                    }
                }
            
  

2026 年 3 月 30 日