提供：扩展接口命令列表、扩展公共命令参数

dogstar · dogstar · commit acc87dade93c · 2022-12-08T19:01:04.000+08:00
diff --git a/README.md b/README.md
@@ -103,7 +103,9 @@ Service: App.User_User.Register
 ![20221208-174039](https://user-images.githubusercontent.com/12585518/206418256-59df5a90-8707-465f-b93d-f7e4db09d938.png)
 
 
-## 扩展帮助说明  
+## 扩展
+
+### 扩展帮助说明  
 
 如果需要定制你的命令脚本的帮助说明，可以重载```PhalApi\CLI\Lite::getHelpText($text)```方法。例如，修改```./bin/phalapi-cli```脚本，改为： 
  
@@ -128,6 +130,7 @@ $cli->response();
 
 ```
 
+
 执行后效果是：  
 ```bash
 $ php ./bin/phalapi-cli
@@ -144,6 +147,70 @@ Service:
 缺少service参数，请使用 -s 或 --service 指定需要调用的API接口
 ```
 
+### 扩展接口命令列表
+
+可以重载扩展 ```PhalApi\CLI\Lite::getServiceList()```方法。返回一个数组，在里面配置：  
+```
+array(
+  编号 => array('service接口服务名称', '功能说明'),
+)
+```
+
+例如，  
+```php
+class MyCLI extends PhalApi\CLI\Lite {
+
+    // 提供接口列表，service -> 接口功能说明
+    protected function getServiceList() {
+        return array(
+            1 => ['App.Hello.World', '演示接口'],
+        );
+    }
+}
+
+```
+
+运行效果是：  
+```bash
+$ ./bin/phalapi-cli
+Usage: ./bin/phalapi-cli [options] [operands]
+
+Options:
+  -s, --service <arg>  接口服务
+  -h, --help           查看帮助信息
+
+
+--- 自定义的帮助说明 ---
+
+Service: 
+1)  App.Hello.World       演示接口
+
+缺少service参数，请使用 -s 或 --service 指定需要调用的API接口。
+```
+
+然后，可以使用快速编号执行对应的接口命令，如：  
+```bash
+$ ./bin/phalapi-cli -s 1
+
+Service: App.Hello.World
+{
+    "ret": 200,
+    "data": {
+        "content": "Hello World!"
+    },
+    "msg": ""
+}
+```
+
+### 扩展公共命令参数  
+
+可以加工处理以下方法：  
+```
+    // 完成命令行参数获取后的操作，方便追加公共参数
+    protected function afterGetOptions($options) {
+        return $options;
+    }
+```
 
 ## 参考和依赖  
 
diff --git a/src/Lite.php b/src/Lite.php
@@ -50,6 +50,12 @@ public function response() {
             $getOpt->process();
 
             $service = $getOpt['service'];
+
+            // 转编号
+            $serviceList = $this->getServiceList();
+            if ($service !== NULL && isset($serviceList[$service])) {
+                $service = $serviceList[$service][0];
+            }
         } catch (\Exception $ex) {
             // 后续统一处理
         }
@@ -132,7 +138,14 @@ public function response() {
             }
 
 
-            \PhalApi\DI()->request = new Request($getOpt->getOptions());
+            $options = $getOpt->getOptions();
+            // 同步转编号后的service
+            $options['s'] = $options['service'] = $service;
+
+            $options = $this->afterGetOptions($options);
+
+            // 构建全部命令行参数
+            \PhalApi\DI()->request = new Request($options);
 
             // 转交PhalApi重新响应处理
             $api = new PhalApi();
@@ -144,11 +157,44 @@ public function response() {
         } catch (\Exception $ex) {
             echo $this->getHelpText($getOpt->getHelpText());
             echo PHP_EOL . $this->colorfulString('Service: ' . $service, 'NOTE');
+            if ($service === NULL) {
+                echo PHP_EOL . $this->getServiceListHelpText();
+            }
             echo PHP_EOL . $this->colorfulString($ex->getMessage(), 'FAILURE') . PHP_EOL . PHP_EOL;
             exit(1);
         }
     }
 
+    // 完成命令行参数获取后的操作，方便追加公共参数
+    protected function afterGetOptions($options) {
+        return $options;
+    }
+
+    // 提供接口列表，service -> 接口功能说明
+    protected function getServiceList() {
+        return array(
+            // 1 => ['App.Hello.World', '演示接口'],
+        );
+    }
+
+    // 提示输出
+    protected function getServiceListHelpText() {
+        $list = $this->getServiceList();
+
+        $topLen = 20;
+        foreach ($list as $pos => $it) {
+            $topLen = max(strlen($it[0]), $topLen);
+        }
+        $topLen += 2;
+
+        $text = '';
+        foreach ($list as $pos => $it) {
+            $text .= $this->colorfulString($pos . ') ', 'NOTE') . $this->colorfulString(sprintf(" %-{$topLen}s", $it[0]), 'NOTE') . $it[1] . PHP_EOL;
+        }
+
+        return $text;
+    }
+
     // 自定义帮助说明
     protected function getHelpText($text) {
         return $text;
