Download to read offline
![PHPCSの実行結果
FILE: /var/www/php/src/Phpcs/PhpcsSample.php
----------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
----------------------------------------------------------------------------
9 | ERROR | [x] Expected 1 space(s) after IF keyword; 0 found
14 | ERROR | [x] Expected 1 space between comma and argument "$b"; 0 found
----------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------
行数と警告メッセージ
ファイルパス
[x]となっているものは、
PHPCSと同時にインストールされるPHPCBFで自動修正可能
⇒ PHPCBFはこの後説明します！
15](https://image.slidesharecdn.com/phpdevelopmentefficiencyimprovement-180724100318/75/Php-development-efficiency-improvement-15-2048.jpg)
Php development efficiency improvement
- 1.
- 2. 自己紹介 • 株式会社 Rosso技術推進室 TechLead • 主な業務 • Webアプリケーション開発・保守 • 言語 • PHP、Ruby • フレームワーク • Laravel、ZendFramework、Rails 茂木 伸幸 も ぎ の ぶ ゆ き Qiita(n_mogi) 2
- 3. 本日のアジェンダ • PHPの概要 • 静的コード解析ツールの説明 •PHPUnitの説明 • 「Laravel」の便利機能の紹介 3
- 4.
- 5.
- 6. PHPとは？ • Webアプリ開発の世界で広く使用されているスクリプト言語。 • HTMLの親和性が高い。 •すぐに画面を表示させることが可能で学習コストも比較的低い。 • LaravelやCakePHPなど、web開発を円滑に進めるためのFWも 多く存在する。 6
- 7.
- 8. 静的コード解析ツールとは？ • PHPのソースコードのチェックをしてくれるツール。 • コーディング規約違反、冗長なコードを見つけてくれるなど、 複数のものが存在する。 •メリット • 人が手動でチェック・修正するよりもツールに任せた方が効率がかな り高くなる。 8
- 9. 今回紹介するツール • PHPCS • PHPMD ⇒コーディング規約違反をチェック ⇒ 冗長なコードをチェック 9
- 10. ツールその① 〜PHPCS〜 • 「PHP_CodeSniffer」の略称。 •PHPパッケージ管理ツール「composer」でインストールでき る。 • 機能 • コードがコーディング規約に合っているかをチェックしてくれる。 10
- 11. PSR-2 • 今回採用するコーディング規約名は「PSR-2」。 • そもそもPSRとは？ •PHP-FIGが策定しているコーディング規約で、世界で知られている。 • PSR-0、PSR-1というような連番になっている。 • PSR-2とは？ • 多くのPJや一部のFW(Laravel)でも採用されているコーディング規約。 11
- 12. PHPCSの実行 • 実行方法 • AtomなどのエディタにPHPCSのプラグインを入れる。 •コマンドで実行する。 ⇒ 今回はコマンドで実行します！ 12
- 13. PHPCSの実行 • コマンド説明 • 例 $phpcs --standard=規約名 ファイルパス $ phpcs --standard=PSR2 ./ PSR2を指定 13
- 14.
- 15. PHPCSの実行結果 FILE: /var/www/php/src/Phpcs/PhpcsSample.php ---------------------------------------------------------------------------- FOUND 2ERRORS AFFECTING 2 LINES ---------------------------------------------------------------------------- 9 | ERROR | [x] Expected 1 space(s) after IF keyword; 0 found 14 | ERROR | [x] Expected 1 space between comma and argument "$b"; 0 found ---------------------------------------------------------------------------- PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY ---------------------------------------------------------------------------- 行数と警告メッセージ ファイルパス [x]となっているものは、 PHPCSと同時にインストールされるPHPCBFで自動修正可能 ⇒ PHPCBFはこの後説明します！ 15
- 16. PHPCBFについて • 機能 • 規約違反のコードを自動修正してくれる。 •PHPCSと同じようなコマンドで実行できる。 • コマンド説明 • 例 $ phpcbf --standard=規約名 ファイルパス $ phpcbf --standard=PSR2 ./ 同様にPSR2を指定 16
- 17. PHPCBFの実行結果 PHPCBF RESULT SUMMARY ------------------------------------------------------------------------------------------ ------------------------ FILEFIXED REMAINING ------------------------------------------------------------------------------------------ ------------------------ /var/www/php/src/Phpcs/PhpcsSample.php 2 0 ------------------------------------------------------------------------------------------ ------------------------ A TOTAL OF 2 ERRORS WERE FIXED IN 1 FILE ------------------------------------------------------------------------------------------ ------------------------ Time: 872ms; Memory: 4Mb 修正済の数 修正できていない数 修正したファイル ⇒ 修正方法が複数パターンあるものについては 修正できないこともある 17
- 18. ツールその② 〜PHPMD〜 • 冗長なPHPのコードをチェックして警告してくれる。 •PHPパッケージ管理ツール「composer」でインストールでき る。 • 主なチェック内容 • 短すぎるor長すぎるプロパティ名、変数名などのチェック。 • 複雑すぎる表現、例えばif文の多用などをチェック。 • 未使用の引数、メソッド、プロパティをチェック。 18
- 19. PHPMDで使用するルール ルール名 説明 Clean CodeRules 綺麗なコードを保つためのルール。 Code Size Rules コードのサイズに関連するルール。 Controversial Rules PJのコーディングルールによっては採用しても良いルール。 チェック対象からは外しても問題ないことが多い。 Design Rules コード設計の問題を無くすためのルール。 危険なPHPの関数を使用していないかなどをチェックする。 Naming Rules 命名に関するルール。 プロパティ名や変数名が長すぎないかなど。 Unused Code Rules 未使用の定義に関するルール。 未使用のプロパティや変数がないかをチェックする。 19
- 20. PHPMDの実行 • 実行方法 • AtomなどのエディタにPHPMDのプラグインを入れる。 •コマンドで実行する。 ⇒ PHPCSと同じくコマンドで実行します！ 20
- 21. PHPMDの実行 • コマンド説明 • 例 $phpmd ファイルパス 出力形式 ルール1,ルール2,・・・ $ phpmd ./ text cleancode,codesize,controversial,design,naming,unusedcode 21
- 22.
- 23. PHPMDの実行結果 /path/to/PhpmdSample.php:7 Avoid variableswith short names like $a. Configured minimum length is 3. 違反内容 対象ファイル：行数 ⇒ PHPMDは自動修正の機能が無いため手動での修正が必要 23
- 24.
- 25. PHPUnitとは？ • ユニットテストを自動化するためのツール。 • テストコードを書くための機能が様々存在する。 •PHPパッケージ管理ツール「composer」でインストールでき る。 25
- 26. テストコードのメリット • 人が手で画面のテストをするよりもテストコードを書いて自動 実行させた方が正確で速い。 • 修正作業の際に、予想外のところでバグが新たに生まれた時に 気がつくことができる。 •テストコードを書くことで、対象のメソッドがどういう振る舞 いをするのが正解なのかが実装者以外にも分かる。 ⇒ PHPUnitの基本的な書き方を見ていきます 26
- 27.
- 28.
- 29. PHPUnitの実行 • コマンド説明 • 例 $phpunit ファイルパス(ディレクトリ or ファイル名) $ phpunit ./tests/ 29
- 30. PHPUnitの実行結果 bash-4.2# phpunit ./tests/ PHPUnit7.2.7 by Sebastian Bergmann and contributors. . 1 / 1 (100%) Time: 419 ms, Memory: 4.00MB OK (1 test, 1 assertion) テストが通った数と割合 実行に要した時間とメモリ テストメソッドの数と アサーションメソッドの数 30
- 31. 基本的な書き方を紹介した上で… • データプロバイダの使い方 • モックの使い方 ⇒他に便利なPHPUnitの機能を紹介します！ 31
- 32.
- 33.
- 34. モックの使い方 • そもそもモックとは？ • あるクラスのメソッドの戻り値をダミー値にすることができる。 •そうすることでメソッドの振る舞い（処理内容）を意識しなくて済む。 • モックが使用される場面 • メソッドの中で他のクラスのメソッドを呼んでいる場合 • 他のクラスのメソッド振る舞いを意識せずに自分のメソッドの処理だ けに集中してテストをしたい場合 ⇒ モック使用対象となるコードをまずは見ていきます 34
- 35. モック化のイメージ ⇒ 実際のコードを見ていきます 【Class A】 とあるメソッド 【ClassB】 Aから呼び出されているメソッド テスト対象のメソッド モック化対象 35
- 36.
- 37.
- 38.
- 39.
- 40. Laravelとは？ • PHPのフレームワークで最近人気が出てきた。 • 基本はMVCモデルが採用されているフレームワーク。 •公式ドキュメントが分かりやすく、翻訳も比較的早い。 • artisanコマンドで様々な機能が提供されていて場合によっては 開発工数を大きく削減できる。 40
- 41. 紹介するLaravelの機能 • マイグレーション • 認証機能の自動生成 •ルーティング • ミドルウェア ⇒ webアプリケーション開発で良く使いそうな機能 41
- 42. マイグレーション • 役割 • データベーステーブルのバージョンコントロール。 •テーブル定義が記載されているマイグレーションファイルを利用して テーブルを作成する。 • Artisanコマンドで実行可能 • php artisan migrate（テーブル作成） • php artisan migrate:rollback（マイグレーションの巻き戻し） 42
- 43. マイグレーションファイルの中身 • ソースコード（一部抜粋） public functionup() { Schema::create('users', function (Blueprint $table) { $table->increments('id'); $table->string('name'); }); } テーブル名 increments：主キー string：VARCHARカラム 43
- 44. 認証機能の自動生成 • Artisanコマンド • phpartisan make:auth • 自動生成されるもの • ユーザ情報テーブルのマイグレーションファイル • 認証関連の画面（ログイン、ユーザ登録等） • パスワード暗号化 ⇒ まともに自作しようとすると数日かかりそうな認証機能を 一瞬で作成してくれる 44
- 45. ルーティング • そもそもルーティングとは？ • ここではURLのパスを定義しているもの。 •特定のコントローラの特定のメソッドがどのURLパスに該当するか。 • 特徴 • 単純な記述でルーティングを定義することが可能。 • Laravelの定義は自由度が高く、好きなURLパス名に簡単に出来る。 • 他のフレームワークでは、コントローラ名やメソッド名にURLパス名 が依存することが多い。 45
- 46.
- 47. ミドルウェア • 役割 • URLにアクセスした際、画面を表示させる前にフィルターをかける。 •例）標準で用意されている認証のミドルウェア（auth） • ⇒未ログイン状態では見れない画面を定義できる。 • ルーティング定義の部分に適用させたいミドルウェア名を記載するこ とで特定のURLのみに適用させることが出来る。 47
- 48. ミドルウェア使用例 Route::middleware('auth')->group(function () { Route::get(‘path1/',’HogeController@index'); Route::get(‘path2/', ’HugaController@create'); }); ⇒ この単純な記述で未ログインでのアクセスを拒否できます ミドルウェア名 ミドルウェアを 適用させたいURLパス 48
- 49. まとめ • 静的コード解析ツール • 整ったコードの作成を補助してくれるので効率良く実装を進められる。 •PHPUnit • テストコードツールを使用することで品質を担保することができる。 • Laravel • 自動生成機能などを駆使することで開発工数の削減につながる。 49
- 50. 参考・引用リンク • PHPCS • https://github.com/squizlabs/PHP_CodeSniffer •PHPMD • https://phpmd.org/ • PHPUnit • http://phpunit.readthedocs.io/ja/latest/ • Laravel • https://laravel.com/docs/ 50
- 51.