脢廬隆壟脙眉脕卯脨脨鹿隴戮脽 · tp5文檔

# 快速入門（十）：命令行工具 `ThinkPHP5.0`開始增加了一個命令行工具`think`，并且內置了一些指令，可以幫助開發者在開發或者運維階段執行一些指令，本章我們來了解下命令行工具的使用和指令開發。 - - [查看指令](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u67E5u770Bu6307u4EE4) - [生成模塊](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u751Fu6210u6A21u5757) - [生成文件](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u751Fu6210u6587u4EF6) - [生成類庫映射文件](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u751Fu6210u7C7Bu5E93u6620u5C04u6587u4EF6) - [生成路由緩存文件](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u751Fu6210u8DEFu7531u7F13u5B58u6587u4EF6) - [指令擴展示例](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u6307u4EE4u6269u5C55u793Au4F8B) - [命令行調試](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u547Du4EE4u884Cu8C03u8BD5) - [命令行顏色支持](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u547Du4EE4u884Cu989Cu8272u652Fu6301) - [調用命令](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/176628#u8C03u7528u547Du4EE4) ## 查看指令 > 命令行工具需要在命令行下面執行，請先確保你的`php.exe`已經加入了系統環境變量。應用的命令行入口文件是應用根目錄的`think`文件，其內容如下： ``` <pre class="calibre18"> ``` // 定義項目路徑 define('APP_PATH', './application/'); // 加載框架命令行引導文件require './thinkphp/console.php'; ``` ``` > 你也可以自定義`think`文件，更改應用目錄。要執行命令，首先進入命令行，并切換當前目錄到應用的根目錄（也就是`think`文件所在目錄）下面，執行： ``` <pre class="calibre18"> ``` php think ``` ``` 會顯示當前支持的所有指令： ``` <pre class="calibre18"> ``` >php think Think Console version 0.1Usage: command [options] [arguments] Options: -h, --help Display this help message -V, --version Display this console version -q, --quiet Do not output any message --ansi Force ANSI output --no-ansi Disable ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug Available commands: build Build Application Dirs help Displays help for a command list Lists commands make make:controller Create a new controller classmake:model Create a new model class optimize optimize:autoload Optimizes PSR0 and PSR4 packages to be loaded with classmaps too, good for production. ``` ``` > #### 注意 > > - - - - - - > > 在win10的周年版中運行會出現亂碼，請使用`PowerShell`運行。使用 ``` <pre class="calibre18"> ``` >php think list ``` ``` 可以獲得相同的結果。如果輸入一個不存在的指令，系統會自動搜索相關的指令并提示，例如： ``` <pre class="calibre18"> ``` >php think make ``` ``` 會顯示 ![](https://img.kancloud.cn/ca/bc/cabcd0aa20452d7b39dbd4f6217751b0_507x240.png) ## 生成模塊下面我們給應用生成一個新的模塊`test`，首先需要在`application`目錄下面創建一個`build.php`定義文件，文件內容如下： ``` <pre class="calibre18"> ``` return [ // 定義test模塊的自動生成'test' => [ '__dir__' => ['controller', 'model', 'view'], 'controller' => ['User', 'UserType'], 'model' => ['User', 'UserType'], 'view' => ['index/index', 'index/test'], ], ]; ``` ``` 然后在命令行下面，執行： ``` <pre class="calibre18"> ``` >php think build Successed ``` ``` 如果顯示Successed則表示生成成功。 > 注意，命令行指令是區分大小寫的，所以如果執行 > > ``` > <pre class="calibre25"> > ``` > >php think Build > ``` > > ``` > > 會報錯。我們可以看到`application`目錄下面已經生成了一個`test`模塊目錄，包括下面的子目錄及文件： ``` <pre class="calibre18"> ``` test ├─controller │ ├─Index.php │ ├─User.php │ └─UserType.php ├─model │ ├─User.php │ └─UserType.php ├─view │ └─index │ ├─index.html │ └─test.html ├─common.php └─config.php ``` ``` 接下來，我們可以訪問 ``` <pre class="calibre18"> ``` http: //tp5.com/test/ ``` ``` 會顯示： ![](https://img.kancloud.cn/4d/fc/4dfc5f50230f86a15331f1b14ed12833_711x427.png) 我們在`build.php`文件中并沒有定義`Index`控制器，但仍然生成了一個默認的`Index`控制器文件以及歡迎頁面，這是為了避免模塊訪問出錯。 ## 生成文件還可以用`make`指令單獨生成某個應用類庫文件，例如： ``` <pre class="calibre18"> ``` php think make:controller test/Blog ``` ``` 會自動為test模塊生成一個 Blog控制器文件。 > 注意，默認生成的控制器類是屬于資源控制器，并且繼承了\\think\\Controller。如果希望生成一個空的控制器，可以使用 ``` <pre class="calibre18"> ``` php think make:controller test/Blog --plain ``` ``` 又或者生成一個模型文件 ``` <pre class="calibre18"> ``` php think make:model test/Blog ``` ``` ## 生成類庫映射文件在生成類庫文件之后，我們強烈建議使用命令行生成類庫映射文件，可以提高自動加載的性能，用法如下： ``` <pre class="calibre18"> ``` >php think optimize:autoload ``` ``` 執行完畢，會在`RUNTIME_PATH`目錄下面生成一個`classmap.php`文件，包括了系統和應用的所有類庫文件的映射列表。 ## 生成路由緩存文件如果你的應用定義了大量的路由規則，那么建議在實際部署后生成路由緩存文件，可以免去路由注冊的開銷，從而改善路由的檢測效率，用法如下： ``` <pre class="calibre18"> ``` >php think optimize:route ``` ``` 執行完畢，會在`RUNTIME_PATH`目錄下面生成一個`route.php`文件，包括了應用的所有路由規則定義列表。 > #### 注意 > > - - - - - - > > 路由緩存文件只會緩存在application/route.php文件中配置和動態注冊的路由規則，因此請確保你沒有在其它的文件中進行路由的注冊。 ## 指令擴展示例命令行的作用遠不止生成文件這么簡單，同時應用也可以很方便的擴展自己的指令，我們來擴展一個用于清理緩存目錄的指令`clear`。 > #### 注意 > > - - - - - - > > 最新版本已經內置`clear`指令了，下面的示例可以直接使用內置的`clear`指令進行學習和測試。首先，我們創建一個指令類 `app\console\Clear`，內容如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\console; use think\console\command\Command; use think\console\Input; use think\console\input\Option; use think\console\Output; class Clear extends Command{ protected function configure(){ // 指令配置$this ->setName('clear') ->addOption('path', 'd', Option::VALUE_OPTIONAL, 'path to clear', null) ->setDescription('Clear runtime file'); } protected function execute(Input $input, Output $output){ $path = $input->getOption('path') ?: RUNTIME_PATH; $files = scandir($path); if ($files) { foreach ($files as $file) { if ('.' != $file && '..' != $file && is_dir($path . $file)) { array_map('unlink', glob($path . $file . '/*.*')); } elseif (is_file($path . $file)) { unlink($path . $file); } } } $output->writeln("Clear Successed"); } } ``` ``` > 一個合法的指令類，沒有固定的目錄和命名空間要求，但必須繼承`think\console\command\Command`或者其子類，并且定義`configure`和`execute`兩個方法。然后，在application目錄下面的`command.php`（如果不存在則創建）文件中添加如下內容： ``` <pre class="calibre18"> ``` return [ '\app\console\Clear', ]; ``` ``` 表示給應用增加一個命令行`Clear`指令，我們可以用`list`指令來驗證是否已經成功注冊`Clear`指令： ``` <pre class="calibre18"> ``` >php think list ``` ``` 運行后如果看到 ![](https://img.kancloud.cn/c0/c1/c0c1be5a8d3976bd31882fac60c7131c_859x386.png) 表示指令注冊成功，接下來可以測試下該指令： ``` <pre class="calibre18"> ``` >php think clear Clear Successed ``` ``` > 該指令并不會刪除目錄，僅僅刪除目錄下面（包括子目錄）的文件。 `clear`指令還定義了一個`--path`參數用于指定目錄，下面是一個指定目錄刪除文件的用法，我們僅僅需要刪除日志文件： ``` <pre class="calibre18"> ``` >php think clear --path d:\www\tp5\runtime\log\ Clear Successed ``` ``` `--path`參數還有一個簡化用法`-d` ``` <pre class="calibre18"> ``` >php think clear -d d:\www\tp5\runtime\log\ Clear Successed ``` ``` ## 命令行調試命令行一旦執行錯誤，只能看到簡單的錯誤信息，如果需要調試詳細的Trace信息，可以使用 `-v` 參數來顯示，例如：假設Clear指令文件中使用了一個未定義的變量`pathp`，那么我們可以使用 ``` <pre class="calibre18"> ``` >php think clear ``` ``` 會顯示如下錯誤： ![](https://img.kancloud.cn/6b/c8/6bc8d6a743de61af507dbb3bb10953a6_327x141.png) 我們需要查看具體的Trace信息，可以使用 ``` <pre class="calibre18"> ``` >php think clear -v ``` ``` 會看到類似下面的錯誤信息： ![](https://img.kancloud.cn/13/16/1316db65bdf92a9375d7298d810389e5_731x355.png) ## 命令行顏色支持為了讓命令行工具更加有趣，`think`命令行支持顏色輸出，并且內置了幾種顏色樣式，還可以自己自定義顏色樣式輸出。 > #### windows下面命令行顏色輸出支持需要`windows 10.0.10580`以上版本支持我們添加一個`color`指令用于演示顏色輸出效果，代碼如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\console; use think\console\command\Command; use think\console\Input; use think\console\Output; use think\console\output\formatter\Style; class Color extends Command{ protected function configure(){ $this ->setName('color') ->setDescription('Show Color text'); } protected function execute(Input $input, Output $output){ // 輸出info樣式$output->writeln("<info>this is info</info>"); // 輸出error樣式$output->writeln("<error>this is error</error>"); // 輸出comment樣式$output->writeln("<comment>this is comment</comment>"); // 輸出question樣式$output->writeln("<question>this is question</question>"); // 輸出highlight樣式$output->writeln("<highlight>this is highlight</highlight>"); // 輸出warning樣式$output->writeln("<warning>this is warning</warning>"); // 輸出混合樣式$output->writeln("this is <info>info</info>, this is <error>error</error>,this is <comment>comment</comment>,this is <question>question</question>,this is <highlight>highlight</highlight>, this is <warning>warning</warning>"); // 自定義輸出樣式$output->getFormatter()->setStyle('custom', new Style('black', 'white')); $output->writeln("<custom>this is style</custom>"); } } ``` ``` `command.php`定義修改如下： ``` <pre class="calibre18"> ``` return [ '\app\console\Clear', '\app\console\Color', ]; ``` ``` 然后執行下面的指令： ``` <pre class="calibre18"> ``` >php think color ``` ``` 運行后就可以看到： ![](https://img.kancloud.cn/85/ea/85ead9f581d1ce03f2fcf512250b6f07_1187x314.png) ## 調用命令在代碼里面可以直接調用執行命令行的某個命令，例如： ``` <pre class="calibre18"> ``` namespace app\index\controller; use think\Console; class Index{ public function index(){ // 調用命令行的指令$output = Console::call('make:model',['index/Blog']); return $output->fetch(); } } ``` ``` > Console::call方法的第一個參數就是指令名稱，后面的第二個參數是一個數組，表示調用的參數。 > 如果我們要創建一個`demo`模塊的話，應該是： > > ``` > <pre class="calibre21"> > ``` > Console::call('build',['--module', 'demo']); > ``` > > ``` 當訪問 ``` <pre class="calibre18"> ``` http: //tp5.com ``` ``` 頁面會輸出 ``` <pre class="calibre18"> ``` Model created successfully. ``` ``` 可以在`application/index/model/`目錄下面發現已經生成了一個`Blog`模型文件。當我們再次刷新頁面的話，會看到頁面輸出 ``` <pre class="calibre18"> ``` Model already exists! ``` ``` 表示模型已經創建過了，無需再次創建。 > 使用`Console::call`方法調用指令執行不會看到最終的輸出結果，需要使用fetch方法獲取輸出信息，一旦發生錯誤，則會拋出異常。