如何轻松使用optionparser处理命令行参数

一、什么是optionparser

optionparser是一个方便易用的Ruby命令行参数处理库，它可以根据您的参数规则和约定自动生成帮助信息，并以此验证和处理您的命令行参数。它旨在提供快速，简单和灵活的命令行解析器。

下面是一个简单的 example.rb，使用optionparser库来解析命令行参数：

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
    options[:verbose] = v
  end
  opts.on("-n", "--name NAME", "Your name") do |n|
    options[:name] = n
  end
end.parse!

puts "Hello, #{options[:name]}" if options[:name]
puts "Running verbosely" if options[:verbose]

二、optionparser的基本用法

在上面的example.rb中，我们使用OptionParser.new方法来创建一个新的OptionParser实例，使用opts.on方法来定义选项和参数。在 opts.on 方法的第一个参数中，我们列出了立即触发此选项的字符串，然后在第二个参数中，我们定义了我们的选项的用途。

在解析器定义完毕后，我们调用parse! 方法来真正解析命令行参数，并在解析结束后定义一个Hash来存储选项。

使用 i 参数来编写代码实现的功能，再次运行code：

ruby example.rb -n John -v

可以得到以下输出结果：

Hello, John
Running verbosely

三、optionparser库的高级用法

除了基本用法外，optionparser内置了许多高级方法来帮助您处理更复杂的命令行参数解析。以下是optionparser的一些高级功能。

1. 隐藏参数

您可以使用 opts.on 方法以外的其他方法来处理无关选项。例如，您可能需要在 opts.on 方法中定义单个选项，但仍然需要访问该选项之外的其他参数。

下面的示例将隐式处理文件路径参数：

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options] file1 file2 ..."

  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
    options[:verbose] = v
  end
end.parse!

if ARGV.count > 0
  puts "Files to process: #{ARGV.join(', ')}"
else
  puts "No files to process."
end

puts "Running verbosely" if options[:verbose]

使用以下命令运行代码：

ruby example.rb -v file1.txt file2.txt

将得到以下输出结果：

Files to process: file1.txt, file2.txt
Running verbosely

2. 参数处理器

使用选项时，您可能希望对传递给选项作为参数的值进行某些处理。

例如，您可以使用Integer.parse 方法将字符串转换为整数：

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on("-a", "--age AGE", Integer, "Your age") do |a|
    options[:age] = a
  end
end.parse!

puts "You are #{options[:age]} years old." if options[:age]

使用以下命令运行代码：

ruby example.rb -a 30

将得到以下输出结果：

You are 30 years old.

3. 参数解析器

参数解析器是一种尝试将传递给选项的字符串值转换为期望类型的一种方法。

以下代码示例演示了如何使用 Date.parse 来解析日期字符串作为选项参数：

require 'optparse'
require 'date'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on("-b", "--birthdate BIRTHDATE", Date, "Your birthdate") do |b|
    options[:birthdate] = b
  end
end.parse!

puts "Your birthdate is: #{options[:birthdate].strftime("%B %d, %Y")}" if options[:birthdate]

使用以下命令运行代码：

ruby example.rb -b "1970-01-01"

将得到以下输出结果：

Your birthdate is: January 01, 1970

4. 显示帮助信息

OptionParser提供了一个 –help 选项，它会自动生成您定义的选项清单。如果您定义了一个新选项，则它将显示在列表中；否则它将显示为通用文本。

下面的示例将演示如何生成帮助文本：

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on("-a", "--age AGE", Integer, "Your age") do |a|
    options[:age] = a
  end

  opts.on("-n", "--name NAME", "Your name") do |n|
    options[:name] = n
  end

  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
    options[:verbose] = v
  end

  opts.on("-h", "--help", "Prints this help") do
    puts opts
    exit
  end
end.parse!

puts "Hello, #{options[:name]}" if options[:name]
puts "You are #{options[:age]} years old." if options[:age]
puts "Running verbosely" if options[:verbose]

使用如下命令运行代码：

ruby example.rb -h

将得到以下输出结果：

Usage: example.rb [options]
        --age AGE                    Your age
        --name NAME                  Your name
    -v, --[no-]verbose                Run verbosely
    -h, --help                       Prints this help