Java命令长选项参数--name=value与--name value适用场景咨询

以下讨论范围为Java启动器（java命令）本身提供的--开头的标准长选项，不包含应用程序自行解析的业务参数。

必用场景区分 #

必须使用 --<name>=<value> 格式的场景 #

• 参数值为空字符串时
  如果你需要给某个选项传递空值，只能用等号格式实现，空格格式无法区分「选项无值」和「选项值为空」
• 参数值以 - 开头时
  如果值本身是带-前缀的内容，用空格格式的话Java启动器会把值识别为新的选项，抛出无法识别选项的错误，必须用等号明确绑定值和对应选项
• 参数值同时包含空格和特殊shell字符时
  虽然部分场景下空格格式加引号也能实现，但等号格式可以减少shell转义的出错概率，比如值带$、*等通配符时，等号+单引号的组合可以保证值原样传递

优先使用 --<name> <value> 格式的场景 #

虽然没有严格必须使用空格格式的场景，但以下情况用空格格式更稳妥：

• 编写Shell脚本批量拼接启动参数时
  把选项名和参数值作为两个独立的变量/数组元素处理，不需要处理字符串拼接，避免出现变量为空时多出来的等号导致解析错误
• 传递包含多段路径的选项时
  比如--module-path、--class-path这类值本身由多段路径拼接而成的选项，空格格式的可读性更高，也方便后续逐段修改调整

设计原因 #

两种格式的设计完全对齐POSIX命令行工具的通用规范，核心出发点是兼顾灵活性和兼容性：

1. 覆盖所有可能的传值场景：避免出现特殊值无法传递的问题，比如之前提到的空值、带-前缀的值
2. 降低用户学习成本：和ls、git等常用命令的长选项传参规则保持一致，用户不需要额外记忆Java独有的传参规则
3. 适配不同使用场景：交互式命令行输入时用等号格式更快捷，脚本中用空格格式可维护性更高

使用示例 #

等号格式示例 #

1. 传递空值给指定选项

   java --illegal-access= --add-opens java.base/java.lang=ALL-UNNAMED -jar demo.jar
   

2. 传递以-开头的参数值

   java --custom-jvm-arg=-Xdebug -jar demo.jar
   

3. 传递带空格的参数值

   java --app-log-path="/var/log/my app/service.log" -jar demo.jar
   

空格格式示例 #

1. Shell脚本中拼接参数

   #!/bin/bash
   JVM_ARGS=()
   JVM_ARGS+=("--module-path")
   JVM_ARGS+=("./lib:./custom-modules")
   JVM_ARGS+=("--add-modules")
   JVM_ARGS+=("jdk.unsupported,jdk.crypto.ec")
   java "${JVM_ARGS[@]}" -jar demo.jar
   

2. 多段路径类参数传递

   java --class-path ./lib/*:./config:./classes com.example.Main
   

内容的提问来源于stack exchange，提问作者Manuel Jordan