如何获取Android Studio代码与文件模板可用变量列表?
获取Java代码/文件模板的所有预定义变量
我之前也踩过和你一样的坑——查了Apache VTL文档却找不到想要的模板变量,后来才搞明白:IDE或构建工具的模板虽然可能用到VTL语法,但预定义变量都是工具自身扩展的,和纯VTL的变量体系完全不搭。下面分主流场景给你说怎么找到全部可用变量:
1. IntelliJ IDEA(及JetBrains全家桶)
这是最常用的自定义Java类模板的场景,直接在IDE里就能看全所有变量:
- 打开「Settings/Preferences」(Windows/Linux按
Ctrl+Alt+S,Mac按Cmd+,) - 找到「Editor > File and Code Templates」选项
- 切换到你要编辑的模板标签(比如「Classes」下的Java Class模板)
- 点击编辑框上方的「Insert Variable」按钮(那个长得像变量图标的按钮)
- 弹出的列表里就是当前模板所有可用的预定义变量,举几个常用的:
${USER}:当前系统登录的用户名${DATE}:当前日期(还能自定义格式)${YEAR}:当前年份${NAME}:你创建类时输入的类名${PACKAGE_NAME}:类所在的包路径${PROJECT_NAME}:当前打开的项目名称
- 而且每个变量都有对应的说明,甚至能直接在窗口里调整变量的输出格式(比如把日期改成
yyyy-MM-dd)。
2. Eclipse
如果用的是Eclipse,操作路径稍微不同:
- 打开「Window > Preferences」
- 导航到「Java > Code Style > Code Templates」
- 选中要编辑的模板(比如「Files > Java Class」),点击「Edit」按钮
- 在编辑窗口里点「Variables」,就能看到所有可用的预定义变量,比如:
${user}:当前用户名${date}:当前日期${year}:当前年份${type_name}:你要创建的类/接口名称${package_name}:类所属的包名
3. 构建工具模板(Maven Archetype/Gradle)
要是你用Maven或Gradle的模板生成Java文件,变量由构建工具提供:
- Maven Archetype:变量主要来自
archetype-metadata.xml的定义,加上Maven内置的属性,比如${project.groupId}、${project.artifactId}、${user.name}这些,直接在模板里用就行。 - Gradle:可以通过
project对象访问所有项目属性,也能自己定义变量,常用的比如${project.name}、${System.getProperty('user.name')}等。
最后补一句
别再去VTL文档里找啦,因为这些变量都是工具自己加的,不同版本的IDE还可能新增变量,直接在当前使用的工具里看内置列表才是最准确的。
内容的提问来源于stack exchange,提问作者ErstwhileIII
相关产品推荐
相关产品推荐

