本文系统研究在springboot启动时传入参数,对于非springboot的普通 java项目也是相同的。
传参的参数类型
- 程序参数(Program arguments)
- 虚拟机选项(VM options)
- 环境变量(Environment variables)
后续为了方便,有时会称呼为:程序参数,vm参数,环境变量
如何传参,如图:
1、在IDEA等工具中是如何传的?
export MY_ENV_VAR=myEnvVarValue
java -Dmy.vm.options=myVmOptionsValue -jar app.jar programArgs1 programArgs2
如图:
注意:环境变量的命名建议不要用 my.env.var (带点的格式),虽然在idea里支持,但是在命令行上支持不好
2、在命令行中是如何传
export MY_ENV_VAR=myEnvVarValue
java -Dmy.vm.options=myVmOptionsValue -jar app.jar programArgs1 programArgs2
说明:
程序参数:在app.jar后列出
vm参数:传的时候用 -D,格式 -Dvar_name=var_value。(vm参数不限于虚拟机参数,可以自定义)
环境变量:
- 需要两行命令实现,提前通过 export 设置(该设置当前会话有效)
- 设置的环境变量不支持点号,如export my.env.var=xxxx 会报错
- 是可以获取到设置在/ect/profile等地方的环境变量的,但是根据执行命令的用户不一样,可能可见性有差别,建议如果要传环境变量,通过本例子直接设置的方式
如何读取:
- 程序变量只能传给main方法,即入口方法
- vm变量,读取用 System.getProperty(...)
- 环境变量,读取用 System.getenv(...)
public static void main(String[] args) {
// 程序变量
System.out.println(Arrays.toString(args));
// vm变量
String myVmOptions = System.getProperty("my.vm.options");// 正确
String myVmOptions2 = System.getenv("my.vm.options");// 错误,读到null
Properties vmProps = System.getProperties();// 读取所有
// 环境变量(命名规范建议不用点,在idea里没问题,在命令行出错)
String myEnvVar = System.getenv("MY_ENV_VAR");// 正确
String myEnvVar2 = System.getProperty("MY_ENV_VAR");// 错误,null值
Map<String, String> envMap = System.getenv();// 读取所有
SpringApplication.run(VmOptionsSystemPropertyApplication.class, args);
3、补充
对于vm参数,除了自己设定的,其实还有很多默认就有的,可能是vm虚拟机设入的。常见的有:line.separator、file.separator、path.separator、user.name如下代码运行后可以打印出vm参数
public class AllVmOptionsAndEnvVaribles {
private static ObjectMapper objectMapper = new ObjectMapper();
public static void main(String[] args) throws JsonProcessingException {
System.out.println(objectMapper.writeValueAsString(new HashMap<>(System.getProperties())));
System.out.println("----------------------------------------");
System.out.println(objectMapper.writeValueAsString(System.getenv()));
}
}