雲計算

PHP 中通過 getopt 解析 GNU C 風格命令行選項

127.png
鏡像下載、域名解析、時間同步請點擊 阿里巴巴開源鏡像站

在 PHP 中,當我們在獲取命令行參數時,可以通過遍歷$argv來獲取,其實呢是有規範可循的,也就是 GNU C-style parser for command line options 。
比如使用命令wget下載文件時,使用下面的一些方式來指定option都可以

wget http://mengkang.net/a.jpg -O b.jpg
wget http://mengkang.net/a.jpg -Ob.jpg --tries=3 -b
wget http://mengkang.net/a.jpg -Ob.jpg --tries=3 -bvd

我們整理下command line options的規則,首先參數分為短參數名和完整參數名,而且一些還有映射關係。比如我們使用wget時,-O對應--output-document

總結 options 使用規範

  • 短選項名,有一個限制,只能是一個char字符,只能1字節,不能超過1字節,比如上面的第四個命令的最後一個參數就不知道是一個選項還是三個選項了。
  • 短選項名用單個連字符(-)開始
  • 短選項可以一個-後面跟多個選項名
  • 長選項和短選項可以有映射關係,也可以沒有
  • 長選項名,則是多字節的的,兩個連字符(--)開始
  • 選項與實參之間,可以直接連接,也可以用空格隔開,還可以用等號連接
  • 但是短選項用等號連接值,等號會被視為值的一部分(但是在 php 裡面卻又兼容了這一點)
  • 選項分為沒有值,必須傳值,可選傳值(也就是可傳可不傳)

在 PHP 中的使用

getopt ( string $options [, array $longopts [, int &$optind ]] ) : array

https://www.php.net/manual/zh/function.getopt.php
$options 短參數字符列表,參數字符後面用:標識必須傳值;參數字符後面用::標識可選傳值;只有參數字符表示該參數(或者說選項)不接受傳值
$longopts 長參數由於是多字節,所以必須是數組,否則沒法分隔。長參數同樣遵循上面:::規則

php裡面缺少結構體的支撐,相比c的長選項的配置更加簡潔,但也缺少了長短選項的映射關係配置。

$shortOpts = "O:Vv::dh";
$longOpts = ["output-document:","version","verbose::", "debug", "help"]; 
$options = getopt($shortOpts, $longOpts);
var_export($options);
php getopt.php -Oa.jpg 
array (
  'O' => 'a.jpg',
)
php getopt.php -O=a.jpg
array (
  'O' => 'a.jpg',
)
php getopt.php -O a.jpg                                 
array (
  'O' => 'a.jpg',
)
php getopt.php -O=a.jpg -dhV
array (
  'O' => 'a.jpg',
  'd' => false,
  'h' => false,
  'V' => false,
)
php getopt.php -O=a.jpg -dhV -vvv
array (
  'O' => 'a.jpg',
  'd' => false,
  'h' => false,
  'V' => false,
  'v' => 'vv',
)

上面例子中我的短參數和長參數是對應的,但是沒有數據結構來表示他們的對應關係(在C裡面有option結構體來做這個對應關係的管理),所以我們兩個都傳的話,程序兩個值會收到,然後我們自己判斷短參數和長參數使用哪個。

php getopt.php -O=a.jpg -dhV -vvv --output-document b.jpg --debug
array (
  'O' => 'a.jpg',
  'd' => false,
  'h' => false,
  'V' => false,
  'v' => 'vv',
  'output-document' => 'b.jpg',
  'debug' => false,
)

這樣寫是不規範的,儘量避免這樣的寫法。

php getopt.php -O=a.jpg -dhVvvv  
array (
  'O' => 'a.jpg',
  'd' => false,
  'h' => false,
  'V' => false,
  'v' => 'vv',
)
php getopt.php -O=a.jpg -dhvvvV
array (
  'O' => 'a.jpg',
  'd' => false,
  'h' => false,
  'v' => 'vvV',
)

總結了這個GNU C command line options 使用的套路,命令使用起來就更溜了,不會懵逼為什麼linux下各種工具使用的案例寫法“千奇百怪”了。

注意:在C裡面並不支持短選項用等號連接,在PHP裡卻是可以的。

阿里巴巴開源鏡像站 提供全面,高效和穩定的鏡像下載服務。釘釘搜索 ' 21746399 ‘ 加入鏡像站官方用戶交流群。”

Leave a Reply

Your email address will not be published. Required fields are marked *