无外部库的Scala命令行参数解析（支持可选参数及额外参数返回）

核心能力匹配 #

• 可提取预先定义的必填参数，缺失时直接抛出带明确提示的异常
• 支持两类可选参数：带取值的配置项、无取值的布尔开关
• 所有未在解析规则中声明的参数，统一收集为独立列表返回
• 仅基于Scala标准库实现，无任何外部依赖引入

核心实现代码 #

// 统一解析结果结构
case class ParseResult(
  parsedParams: Map[String, String], // 匹配规则的带值参数键值对
  flags: Set[String], // 匹配规则的布尔开关参数
  extraArgs: List[String] // 未命中规则的额外参数
)

object CLIParser {
  /**
   * 参数解析入口
   * @param args 原始命令行入参数组
   * @param requiredParams 必填参数列表，对应长选项格式 --参数名 取值
   * @param optionalParams 可选参数规则，值为None代表布尔开关，Some(默认值)代表带值配置项
   */
  def parse(
    args: Array[String],
    requiredParams: List[String],
    optionalParams: Map[String, Option[String]]
  ): ParseResult = {
    var cursor = 0
    val paramMap = scala.collection.mutable.Map[String, String]()
    val flagSet = scala.collection.mutable.Set[String]()
    val extraList = scala.collection.mutable.ListBuffer[String]()

    while (cursor < args.length) {
      val current = args(cursor)
      // 识别长选项格式
      if (current.startsWith("--")) {
        val paramName = current.drop(2)
        val isPredefined = requiredParams.contains(paramName) || optionalParams.contains(paramName)
        
        if (!isPredefined) {
          extraList.append(current)
          cursor += 1
        } else {
          // 判断参数类型：布尔开关/带值配置
          val isBooleanFlag = optionalParams.get(paramName).contains(None)
          if (isBooleanFlag) {
            flagSet.add(paramName)
            cursor += 1
          } else {
            if (cursor + 1 >= args.length) {
              throw new IllegalArgumentException(s"参数 --$paramName 缺少对应取值")
            }
            val paramValue = args(cursor + 1)
            paramMap.put(paramName, paramValue)
            cursor += 2
          }
        }
      } else {
        // 非--开头的入参直接归入额外列表
        extraList.append(current)
        cursor += 1
      }
    }

    // 校验必填参数完整性
    val missingRequired = requiredParams.filterNot(paramMap.contains)
    if (missingRequired.nonEmpty) {
      throw new IllegalArgumentException(s"缺少必填参数: ${missingRequired.map(p => s"--$p").mkString(", ")}")
    }

    // 给带值可选参数填充默认值
    optionalParams.foreach {
      case (name, Some(defaultVal)) if !paramMap.contains(name) => paramMap.put(name, defaultVal)
      case _ => // 已传入值的参数跳过
    }

    ParseResult(
      parsedParams = paramMap.toMap,
      flags = flagSet.toSet,
      extraArgs = extraList.toList
    )
  }
}

调用示例 #

// 模拟输入命令行参数
val testArgs = Array(
  "--host", "127.0.0.1",
  "--port", "8080",
  "--debug",
  "--log-level", "INFO",
  "input.csv", "output.csv"
)

val parseResult = CLIParser.parse(
  args = testArgs,
  requiredParams = List("host", "port"),
  optionalParams = Map(
    "debug" -> None,
    "log-level" -> Some("WARN")
  )
)

// 实际解析输出
parseResult.parsedParams // Map(host -> 127.0.0.1, port -> 8080, log-level -> INFO)
parseResult.flags // Set(debug)
parseResult.extraArgs // List(input.csv, output.csv)

关键实现细节 #

• 采用游标逐段扫描的方式处理参数列表，无递归逻辑，对超长入参兼容稳定
• 带值参数做了数组越界判断，避免底层运行时异常抛出
• 额外参数完全保留原始入参的顺序和格式，不做内容过滤，满足参数透传类场景需求
• 参数校验逻辑前置，所有规则不匹配的场景都会抛出带明确提示的业务异常，避免后续运行环节报错排查困难

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