偷懶是程設師的美德
使用 phpStorm 版本 2019.1.3 進行教學，首先設定，我們在快捷鍵按下 Ctrl + Shift + A 輸入 Edit Configurations
接著我們下快捷鍵 Ctrl + Shift + A 輸入 Settings，進入 Languages & Frameworks > PHP > Test Frameworks
接下來打開測試檔案，我們可以直接在 methods 左側的綠色箭頭，點擊後會自動運行測試
Laravel 整合了 phpunit 製作單元/功能測試，我們以空專案 blog 來進行範例。
|
1 2 3 4 |
cd blog composer create-project --prefer-dist laravel/laravel . |
寫測試的時候，建立一份專門提供給測試的資料庫，避免與實際運作的開發環境共用。根目錄底下，複製一份 .env 為 .env.testing 並修改內容，運行測試的時候透過 artisan 指令添加參數 –env=testing 將會覆蓋 .env 的值
|
1 2 3 4 5 6 7 |
// .env.testing .... DB_DATABASE=測試資料庫名稱 DB_USERNAME=測試使用者帳號 DB_PASSWORD=測試使用者密碼 |
若出現 Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes 那麼請修改 app/Providers/AppServiceProvider.php
|
1 2 3 4 5 6 7 8 |
use Illuminate\Support\Facades\Schema; public function boot() { Schema::defaultStringLength(191); } |
一開始先建立 DB Schema
|
1 2 3 |
php artisan make:migration create_posts_table |
|
1 2 3 4 5 6 7 8 9 10 11 12 |
// database\migrations\2019_08_19_071005_create_posts_table.php public function up() { Schema::create('posts', function (Blueprint $table) { $table->bigIncrements('id'); $table->string('title', 50); $table->longText('content'); $table->timestamps(); }); } |
記住，我們要運行在測試資料庫
|
1 2 3 4 |
php artisan config:clear // 記得清除快取，使之可以讀取 testing php artisan migrate --env=testing |
|
1 2 3 |
php artisan make:model Post |
這裡的工廠 PostFactory 負責定義我們的假資料工廠，只要返回我們需要的欄位即可
|
1 2 3 |
php artisan make:factory PostFactory --model=Post |
|
1 2 3 4 5 6 7 8 9 |
// database\factories\PostFactory.php $factory->define(Post::class, function (Faker $faker) { return [ 'title' => $faker->word, 'content' => $faker->paragraph ]; }); |
我們在單元測試中會做這幾件事情
|
1 2 3 |
php artisan make:test PostTest --unit |
可以建立多個方法來進行測試，命名的規則例如
我們嘗試編寫
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
// tests\Unit\PostTest.php use App\Post; class PostTest extends TestCase { // 可以重整資料表，避免測試資料不斷累積。注意這會刪除所有資料，不要用在正式環境 use RefreshDatabase; public function testExample() { // 建立5筆資料 factory(Post::class, 5)->create(); // 取得所有資料 $posts = Post::all(); // 斷言結果 $this->assertCount(5, $posts); } } |
接著運行測試，但很重要的記得清除緩存 config:clear，讓測試環境能抓取 .env.testing。
|
1 2 3 4 5 6 7 8 9 |
php artisan config:clear (Windows) vendor\bin\phpunit (Linux) vendor/bin/phpunit |
上面做的是單元測試，那假設我們要測試 API 是否符合預期，我們則要使用功能測試。
新增一個 Controller
|
1 2 3 |
php artisan make:controller ProductController |
|
1 2 3 4 5 6 7 8 9 10 11 12 |
class ProductController extends Controller { public function store(Request $request) { return [ 'id' => (int) $request->id, 'title' => 'productTitle' ]; } } |
現在新增路由
|
1 2 3 4 |
// api.php Route::post('products', 'ProductController@store'); |
接著下指令產生功能測試
|
1 2 3 |
php artisan make:test ProductTest |
接著嘗試訪問 API，並斷言回傳的 JSON 符合我們的結構
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
public function testExample() { $pid = 100; $response = $this->json('POST', 'api/products', [ 'id' => $pid ]); // 斷言結構是否相符合 $response->assertExactJson([ 'id' => $pid, 'title' => 'productTitle' ]); // 斷言回傳值是否相等 $response->assertJson([ 'id' => $pid, 'title' => true ]); } |
|
1 2 3 4 5 6 7 8 9 |
php artisan config:clear (Windows) vendor\bin\phpunit (Linux) vendor/bin/phpunit |
如果要在 Request 加入 Header 可以這麼寫
|
1 2 3 4 5 6 7 8 9 10 11 |
$response = $this->withHeaders([ 'X-Header' => 'Value', ])->json('POST', '/user', ['name' => 'Sally']); $response ->assertStatus(201) ->assertJson([ 'created' => true, ]); |
若要為 Response 除錯，可以選用添加
|
1 2 3 4 |
$response->dumpHeaders(); $response->dump(); |
如果使用 phpStorm 進行測試，我們可以透過設定進行測試，請參考這篇。
首先安裝這個套件，先匯出 DB Schema 到 migration
|
1 2 3 |
composer require --dev "xethron/migrations-generator" |
Laravel 5.5 以後的版本，下載好後就不需安裝任何的 Providers。使用方法如：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
// 所有資料表 php artisan migrate:generate // 指定資料表 php artisan migrate:generate table1,table2,table3,table4,table5 // 所有資料表但排除某些表，可加參數 --ignore="table3,table4,table5" // 檢視所有可選用的參數 php artisan help migrate:generate |
不過資料表欄位的型態，若是 Enum 的時候，目前版本 v2.0.2 會出錯，請修改 src/Xethron/MigrationsGenerator/Generators/FieldGenerator.php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
protected function setEnum(array $fields, $table) { foreach ($this->getEnum($table) as $column) { $column_name = isset($column->column_name) ? $column->column_name : $column->COLUMN_NAME; $column_type = isset($column->column_type) ? $column->column_type : $column->COLUMN_TYPE; $fields[$column_name]['type'] = 'enum'; $fields[$column_name]['args'] = str_replace('enum(', 'array(', $column_type); } return $fields; } |
主要是 MySQL 8 返回的欄位名稱是大寫， MariaDB 返回的是小寫，需要稍作修改就可以了。我提出了合併請求，不過我看目前開發者合併停滯在 2017 年，因為這個功能僅單次使用，我也就不再 fork 了，手改一下就好。
接著產出 seed，就下載這個套件
|
1 2 3 |
composer require orangehill/iseed |
一樣 Laravel 5.4 以後不需要做任何安裝設定。比較麻煩的是要個別指定匯出的資料表名稱，使用方法如
|
1 2 3 4 5 6 7 8 9 10 11 |
// 匯出所需資料 php artisan iseed my_table php artisan iseed my_table,another_table // 產出的 seeder class 名稱加入前綴 php artisan iseed my_table --classnamesuffix=Customizations // 強制覆蓋已存在的 seed php artisan iseed users --force |
預設只推送給 connect 單一 client 端，那如果要推送給所有人呢？可以藉由搭配訂閱的功能。
除了透過 composer 安裝 workerman 之外，還需要安裝 Channel分佈式通訊組件： workerman/channel
|
1 2 3 4 |
composer require workerman/workerman composer require workerman/channel |
接著貼上 start.php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
<?php require_once __DIR__ . '/vendor/autoload.php'; use Workerman\Worker; use Channel\Client; use Channel\Server; // 初始化一个Channel服务端 $channel_server = new Server('0.0.0.0', 2206); // Create a Websocket server $ws_worker = new Worker("websocket://0.0.0.0:2346"); // 4 processes $ws_worker->count = 4; $ws_worker->onWorkerStart = function ($worker) { // Channel客户端连接到Channel服务端 Client::connect('0.0.0.0', 2206); // 订阅broadcast事件，并注册事件回调 Client::on('broadcast', function ($event_data) use ($worker) { // 向当前worker进程的所有客户端广播消息 foreach ($worker->connections as $connection) { $connection->send($event_data); } }); }; // Emitted when data received $ws_worker->onMessage = function ($connection, $data) use ($ws_worker) { // 向所有worker进程发布broadcast事件 Channel\Client::publish('broadcast', $data); }; // Emitted when connection closed $ws_worker->onClose = function ($connection) { echo "Connection closed\n"; }; // Run worker Worker::runAll(); |
接著啟動服務，我們透過 php 運行
|
1 2 3 |
php start.php |
建立 Client 端部分
|
1 2 3 4 |
<input type="text" class="name" placeholder="請輸入姓名" autofocus> <input type="submit" value="發送" onclick="send_msg(); "> |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
var wsServer = 'ws://0.0.0.0:2346'; var websocket = new WebSocket(wsServer); websocket.onopen = function (evt) { console.log("成功連接到 WebSocket 服務"); }; websocket.onclose = function (evt) { console.log("關閉連接 WebSocket 服務"); }; websocket.onmessage = function (evt) { console.log('伺服器顯示:' + evt.data); }; websocket.onerror = function (evt, e) { console.log('發生錯誤: ' + evt.data); }; // 發送訊息給所有人 const send_msg = function (){ var name = document.getElementsByClassName('name')[0].value; var msg = JSON.stringify({ message: '你好，我是' + name, }) websocket.send(msg) } |
把 hostname 位置在 127.0.0.1 的資料庫 testdb ，匯出到 dump.sql
|
1 2 3 |
mysqldump -h 127.0.0.1 -u root -p testdb > dump.sql |
將 dump.sql 匯入到資料庫 testdb
|
1 2 3 |
mysql -u root -p testdb < dump.sql |