文件模板变量

文件模板可以包含变量，在应用模板时会将其替换为相应的值。变量是一个以美元符号 $ 开头、后跟变量名的字符串。变量名可以选择用花括号括起来。例如： $MyVariable 和 ${MyVariable} 是同一变量的不同表示方式。

模板正文和文件名中均可使用预定义变量和自定义变量。例如，若在模板的文件名字段中键入 MyFile_${MONTH_NAME_FULL} ，在四月份创建文件时，其文件名将为 MyFile_April。此处， ${MONTH_NAME_FULL} 是一个预定义变量。如果使用自定义变量，GoLand 会在基于该模板创建文件时，提示您输入变量值。

预定义模板变量

以下预定义变量可用于文件模板：

变量	描述
`${GO_PACKAGE_NAME_WITH_TEST_SUFFIX}`	如果是常规文件，则为新建文件所在包的名称；如果是测试文件，则为包名加“_test”后缀
`${GO_PACKAGE_NAME}`	新建文件所在包的名称
`${DATE}`	当前系统日期
`${DAY}`	当前日期的日
`${DAY_NAME_SHORT}`	当前月份名称的前三个字母（Mon、Tue 等）
`${DAY_NAME_FULL}`	当前星期几的完整名称（Monday、Tuesday 等）
`${DIR_PATH}`	新建文件所在目录的路径（相对于项目根目录）
`${DS}`	美元符号 `$`。此变量用于转义美元符号，使其不被视为模板变量的前缀。
`${FILE_NAME}`	新建文件的名称
`${HOUR}`	当前小时
`${MINUTE}`	当前分钟
`${SECOND}`	当前秒数
`${MONTH}`	当前月份
`${MONTH_NAME_FULL}`	当前月份的完整名称（January、February 等）
`${MONTH_NAME_SHORT}`	当前月份名称的前三个字母（Jan、Feb 等）
`${NAME}`	新建实体（文件、类型、接口等）的名称
`${PRODUCT_NAME}`	IDE 的名称（例如，GoLand）
`${PROJECT_NAME}`	当前项目的名称
`${TIME}`	当前系统时间
`${USER}`	当前用户的登录名
`${YEAR}`	当前年份

变量方法

由于 GoLand 使用 Velocity 作为文件模板引擎，因此文件模板中的变量可以使用 Java String 方法。例如，可以执行以下操作：

${NAME.toUpperCase()} ：将新建实体（文件）的名称转换为大写字母。
${PROJECT_NAME.length()} ：输出项目名称的长度。
${PRODUCT_NAME.substring(0,5)} ：输出当前所用 IDE 名称的前五个字符。

自定义模板变量

除了预定义模板变量，您还可以指定自定义变量。如有需要，您可以在模板中使用 #set 指令直接定义自定义变量的值。请在使用相应变量之前写入该指令。

例如，若希望使用您的全名来替代通过预定义变量 ${USER} 定义的登录名，请在自定义变量之前添加以下结构：

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

如果模板中未定义变量的值，GoLand 会在应用模板时提示您指定该值。

最后修改日期： 2025年 9月 26日