添加curl命令

Author: lishipeng

BaseCurlHttp.php

@@ -269,7 +269,7 @@ public function refreshCurl()
  $this->_curl = null;
  }
 
- public static function requestByUrl($url, $params = [], $method = self::METHOD_GET)
+ public static function getObjectByUrl($url, &$action=null, $method = self::METHOD_GET)
  {
  $data = parse_url($url);
  $config = [];
@@ -288,6 +288,13 @@ public static function requestByUrl($url, $params = [], $method = self::METHOD_G
  }
  $config['class'] = get_called_class();
  $obj = Yii::createObject($config);
+ return $obj; 
+ }
+
+ public static function requestByUrl($url, $params = [], $method = self::METHOD_GET)
+ {
+ $action = null;
+ $obj = self::getObjectByUrl($url, $action, $method);
  return $obj->httpExec($action, $params);
  }
 }

README.md

@@ -117,6 +117,32 @@ Usage
 - 如果需要传文件，我们需要formData方式时，可以加上setFormData()来实现。
 - 正常如果beforeRequest和AfterRequest较长的话，不建议写配置中。建议通过类的继承来实现。
 
+4、console模式
+正常情况下，我们经常需要在命令行发出一些命令，来跟baidu通信，调试api接口。因此，我们可以使用代码提供的工具来调试：
+
+首先，在`console/controllers/main-local.php`中加入如下的配置：
+
+```php
+return [
+ // 其它配置
+ 'modules' => [
+ // ...
+ 'curl' => ['class' => 'lspbupt\curl\module\Module'],
+ // ...
+ ],
+ // 其它配置
+];
+```
+
+其次，我们就可以在命令行使用它进行调试了：
+
+```bash
+./yii curl baiduApi "/apistore/iplookupservice/iplookup?ip=1.1.1.1"
+#更多帮助
+./yii curl -h
+```
+
+
 广告
 --------------
 

module/Module.php

@@ -0,0 +1,31 @@
+<?php
+namespace lspbupt\curl\module;
+
+use Yii;
+use yii\base\BootstrapInterface;
+use yii\helpers\Json;
+use yii\web\ForbiddenHttpException;
+
+/**
+ * To use Curl, include it as a module in the application configuration like the following:
+ *
+ * ~~~
+ * return [
+ * 'modules' => [
+ * 'curl' => ['class' => 'yii\curl\Module'],
+ * ],
+ * ]
+ * ~~~
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @since 2.0
+ */
+class Module extends \yii\base\Module implements BootstrapInterface
+{
+ public $controllerNamespace = 'lspbupt\curl\module\controllers';
+
+
+ public function bootstrap($app)
+ {
+ }
+}

module/controllers/DefaultController.php

@@ -0,0 +1,145 @@
+<?php
+namespace lspbupt\curl\module\controllers;
+
+use Yii;
+use lspbupt\curl\CurlHttp;
+use yii\di\Instance;
+use yii\validators\UrlValidator;
+
+class DefaultController extends \yii\console\Controller
+{
+ /**
+ * @var string 对应curl的--data-raw, -d选项。后面可以跟"a=b&c=d"也可以跟json数据
+ */
+ public $dataRaw = "";
+ /**
+ * @var bool 对应curl -v, --verbose选项。如果设置，会打印出整个请求的过程
+ */
+ public $verbose = false;
+ /**
+ * @var string 对应curl的-H, --header选项。注意：不能多个-H使用，多个header请用|分隔，如："Content-type: xxx|User-Agent: xxx"
+ */
+ public $header = ""; 
+ /**
+ * @var string 对应curl的-x, --request选项。本软件只支付get, post, postjson, formdata。如果不设置，系统会自行判断
+ */
+ public $request = "";
+
+ public static $allowMethods = ["get", "post", "postjson", "formdata"];
+
+ public $defaultScheme = "http";
+
+ /**
+ * 通过系统的实例来发起http请求
+ */
+ public function actionIndex($instance, $action = "")
+ {
+ $params = [];
+ //规范化method
+ $method = "GET";
+ $isFormData = false;
+ if($this->dataRaw !== "") {
+ $method = "POST";
+ //判断dataRaw是否为json
+ $ret = json_decode($this->dataRaw);
+ if(!is_null($ret)) {
+ $method = "POSTJSON";
+ $params = $ret;
+ } else {
+ parse_str($this->dataRaw, $params);
+ if(is_null($params)) {
+ echo "-d 参数错误，请传输有意义的data数据";
+ return 1;
+ }
+ foreach($params as $key => $value) {
+ if(is_string($value) && substr($value, 0, 1) === "@") {
+ $method = "POST";
+ $isFormData = true;
+ $file = substr($value, 1);
+ $params[$key] = new \CURLFile(realpath($file));
+ }
+ }
+ }
+ }
+ 
+ //规范化method
+ empty($this->request) && $this->request = $method;
+ $this->request = strtolower($this->request);
+ if(!in_array($this->request, self::$allowMethods)) {
+ $this->request = "get"; 
+ }
+ //规范化headers
+ $this->header = $this->parseHeader($this->header);
+
+
+ $obj = $this->getInstance($instance, $action);
+ call_user_func([$obj, "set".$this->request]);
+ $ret = $obj->setDebug((bool)$this->verbose)
+ ->setHeaders($this->header)
+ ->setFormData($isFormData)
+ ->httpExec($action, $params);
+ if(!$this->verbose) {
+ if(is_string($ret)) {
+ echo $ret;
+ }else {
+ var_dump($ret);
+ }
+ }
+ return 0;
+ }
+
+ public function options($actionID)
+ {
+ return array_merge(parent::options($actionID), [
+ 'dataRaw',
+ 'verbose',
+ 'header',
+ 'request'
+ ]);
+ }
+
+ public function optionAliases() 
+ {
+ return array_merge(parent::optionAliases(), [
+ 'd' => 'data-raw',
+ 'v' => 'verbose',
+ 'H' => 'header',
+ 'X' => 'request'
+ ]); 
+ }
+
+ private function parseHeader($headers)
+ {
+ $headers = explode("|", $headers);
+ $arr = [];
+ foreach($headers as $str) {
+ $index = strpos($str, ":");
+ if($index !== false) {
+ $headKey = trim(substr($str, 0, $index));
+ $headValue = trim(substr($str, $index+1));
+ $arr[$headKey] = $headValue;
+ }
+ }
+
+ return $arr; 
+ }
+ 
+ private function getInstance($key, &$action)
+ {
+ $key = trim($key);
+ $obj = null;
+ //先判断是否为Url
+ $validator = new UrlValidator([
+ 'defaultScheme' => $this->defaultScheme,
+ ]);
+ if($validator->validate($key)) {
+ if(strpos($key, '://') === false) {
+ $key = $this->defaultScheme . "://". $key;
+ }
+ $obj = CurlHttp::getObjectByUrl($key, $action);
+ }else {
+ $obj = Instance::ensure($key);
+ }
+ return $obj;
+ }
+}