Laravelコントローラーとは？基礎知識を理解しよう
Laravelでアプリケーションを開発する際、コントローラーは非常に重要な役割を果たします。このセクションでは、コントローラーの基本的な概念から、なぜ使用する必要があるのかまで、分かりやすく解説していきます。
MVCアーキテクチャーにおけるコントローラーの役割
MVCアーキテクチャーは、アプリケーションを以下の3つの要素に分割する設計パターンです：
- Model（モデル）
- データベースとの通信を担当
- ビジネスロジックを含む
- データの検証や加工を行う
- View（ビュー）
- ユーザーに表示する画面の作成
- HTMLの生成
- データの表示形式の決定
- Controller（コントローラー）
- HTTPリクエストの受付
- ModelとViewの仲介役
- ビジネスロジックの振り分け
コントローラーは、この中で「交通整理係」のような役割を果たします。具体的には：
- ユーザーからのリクエストを最初に受け取る
- リクエストの内容に応じて適切なModelを呼び出す
- Modelから受け取ったデータを適切なViewに渡す
- 最終的なレスポンスの生成を管理する
例えば、ブログアプリケーションでの記事表示の流れは以下のようになります：
class ArticleController extends Controller
{
public function show($id)
{
// 1. Modelを使って記事データを取得
$article = Article::find($id);
// 2. 取得したデータをViewに渡して表示
return view('articles.show', ['article' => $article]);
}
}
なぜLaravelでコントローラーを使う必要があるのか
コントローラーを使用する主な理由は以下の4つです：
1. コードの整理と管理のしやすさ
- 関連する処理をまとめられる
- ユーザー関連の処理は
UserController - 記事関連の処理は
ArticleController - 商品関連の処理は
ProductController - コードの見通しが良くなる
- 機能ごとにファイルが分かれる
- 処理の流れが分かりやすい
- チーム開発での分担がしやすい
2. セキュリティの向上
コントローラーを使用することで、以下のようなセキュリティ対策が実装しやすくなります：
class UserController extends Controller
{
// ミドルウェアでアクセス制御
public function __construct()
{
$this->middleware('auth');
$this->middleware('role:admin')->only(['delete', 'update']);
}
// CSRFトークンの自動検証
public function update(Request $request)
{
// LaravelがCSRFトークンを自動的に検証
}
}
3. 保守性とテスタビリティの向上
- 単一責任の原則に従った設計が可能
- ユニットテストが書きやすい
- 機能の追加・変更が容易
4. Laravelの機能を最大限活用できる
Laravelのコントローラーを使用することで：
- ルーティングとの連携が簡単
Route::resource('articles', ArticleController::class);
- バリデーションが実装しやすい
public function store(Request $request)
{
$validated = $request->validate([
'title' => 'required|max:255',
'content' => 'required',
]);
}
- 依存性注入が活用できる
public function index(ArticleRepository $repository)
{
$articles = $repository->getAllPublished();
return view('articles.index', compact('articles'));
}
このように、コントローラーを使用することで、アプリケーションの品質と開発効率を大きく向上させることができます。コードの管理がしやすくなり、セキュリティも向上し、さらにはLaravelの強力な機能を簡単に活用できるようになります。
次のセクションでは、実際のコントローラーの作成方法について、具体的な手順とともに解説していきます。
コントローラーを作成する3つの方法
Laravelでは、目的や用途に応じて異なる種類のコントローラーを作成することができます。このセクションでは、3つの主要な作成方法について、それぞれの特徴と具体的な実装方法を解説します。
artisanコマンドを使った基本的な作成方法
最も基本的なコントローラーの作成方法は、artisanコマンドを使用する方法です。
基本的なコントローラーの作成
# 基本的なコントローラーを作成 php artisan make:controller UserController
このコマンドを実行すると、app/Http/Controllers/UserController.phpに以下のようなファイルが生成されます：
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
class UserController extends Controller
{
// コントローラーのメソッドをここに追加
}
メソッドの追加例
class UserController extends Controller
{
// ユーザー一覧の表示
public function index()
{
$users = User::all();
return view('users.index', compact('users'));
}
// ユーザーの詳細表示
public function show($id)
{
$user = User::findOrFail($id);
return view('users.show', compact('user'));
}
}
リソースコントローラーの作成方法と使いどころ
リソースコントローラーは、CRUD（Create, Read, Update, Delete）操作を一括で実装する場合に便利です。
リソースコントローラーの作成
# リソースコントローラーを作成 php artisan make:controller ProductController --resource
このコマンドで生成されるコントローラーには、以下の7つのメソッドが自動的に含まれます：
class ProductController extends Controller
{
/**
* 一覧表示
*/
public function index()
{
$products = Product::paginate(10);
return view('products.index', compact('products'));
}
/**
* 作成フォームの表示
*/
public function create()
{
return view('products.create');
}
/**
* 新規作成の処理
*/
public function store(Request $request)
{
$validated = $request->validate([
'name' => 'required|max:255',
'price' => 'required|numeric',
'description' => 'required'
]);
Product::create($validated);
return redirect()->route('products.index')
->with('success', '商品が登録されました');
}
/**
* 詳細表示
*/
public function show(Product $product)
{
return view('products.show', compact('product'));
}
/**
* 編集フォームの表示
*/
public function edit(Product $product)
{
return view('products.edit', compact('product'));
}
/**
* 更新の処理
*/
public function update(Request $request, Product $product)
{
$validated = $request->validate([
'name' => 'required|max:255',
'price' => 'required|numeric',
'description' => 'required'
]);
$product->update($validated);
return redirect()->route('products.index')
->with('success', '商品が更新されました');
}
/**
* 削除の処理
*/
public function destroy(Product $product)
{
$product->delete();
return redirect()->route('products.index')
->with('success', '商品が削除されました');
}
}
ルーティングの設定
リソースコントローラーを使用する場合、ルーティングは以下のように簡単に設定できます：
// routes/web.php
Route::resource('products', ProductController::class);
これにより、以下のルートが自動的に生成されます：
| メソッド | URI | アクション | ルート名 |
|---|---|---|---|
| GET | /products | index | products.index |
| GET | /products/create | create | products.create |
| POST | /products | store | products.store |
| GET | /products/{product} | show | products.show |
| GET | /products/{product}/edit | edit | products.edit |
| PUT/PATCH | /products/{product} | update | products.update |
| DELETE | /products/{product} | destroy | products.destroy |
シングルアクションコントローラーの作成とユースケース
シングルアクションコントローラーは、1つのアクションのみを持つコントローラーです。特定の処理に特化した場合に使用します。
作成方法
# シングルアクションコントローラーを作成 php artisan make:controller ConfirmEmailController --invokable
このコマンドで生成されるコントローラーは、以下のような構造になります：
class ConfirmEmailController extends Controller
{
/**
* 単一のアクションを処理
*/
public function __invoke(Request $request, $token)
{
$user = User::where('confirmation_token', $token)->firstOrFail();
$user->update([
'email_verified_at' => now(),
'confirmation_token' => null
]);
return redirect()->route('login')
->with('success', 'メールアドレスが確認されました');
}
}
ルーティングの設定
シングルアクションコントローラーのルーティングは以下のように設定します：
// routes/web.php
Route::get('email/confirm/{token}', ConfirmEmailController::class);
使用に適したケース
シングルアクションコントローラーは以下のような場合に適しています：
- メール確認処理
- パスワードリセット
- 支払い処理
- ファイルダウンロード
- APIエンドポイントの単一処理
これらの3つの作成方法は、それぞれ異なるユースケースに最適化されています。アプリケーションの要件に応じて、適切な方法を選択することが重要です。次のセクションでは、これらのコントローラーを実際のプロジェクトで効果的に使用するためのベストプラクティスについて解説していきます。
実践的なコントローラー作成のベストプラクティス
効率的で保守性の高いLaravelアプリケーションを開発するために、コントローラーの実装には一定のベストプラクティスがあります。このセクションでは、実践的なコントローラー作成の手法について詳しく解説します。
コントローラーの命名規則とファイル配置
命名規則
Laravelでは、以下の命名規則に従ってコントローラーを作成することが推奨されています：
- クラス名の規則
- 単数形を使用
- Controllerで終わる
- パスカルケース（PascalCase）を使用
// 良い例 class UserController extends Controller class ArticleController extends Controller class OrderManagementController extends Controller // 悪い例 class usersController extends Controller // パスカルケースを使用していない class ArticlesControllers extends Controller // 複数形を使用している class Manage_Order extends Controller // Controllerで終わっていない
- 名前空間の構造化
// 基本的な配置 app/Http/Controllers/UserController.php // 機能ごとのグループ化 app/Http/Controllers/Admin/UserController.php app/Http/Controllers/Api/V1/UserController.php
ディレクトリ構造のベストプラクティス
app/Http/Controllers/
├── Admin/
│ ├── UserController.php
│ └── ProductController.php
├── Api/
│ ├── V1/
│ │ ├── AuthController.php
│ │ └── UserController.php
│ └── V2/
│ └── UserController.php
└── Frontend/
├── HomeController.php
└── ContactController.php
依存性注入を活用した実装方法
依存性注入（DI）は、コードの結合度を下げ、テスタビリティを向上させる重要な設計パターンです。
サービスクラスの注入
class OrderController extends Controller
{
private $orderService;
private $paymentService;
public function __construct(
OrderService $orderService,
PaymentService $paymentService
) {
$this->orderService = $orderService;
$this->paymentService = $paymentService;
}
public function store(OrderRequest $request)
{
$order = $this->orderService->createOrder($request->validated());
$payment = $this->paymentService->processPayment($order);
return redirect()->route('orders.show', $order)
->with('success', '注文が完了しました');
}
}
リポジトリパターンの活用
// リポジトリインターフェース
interface UserRepositoryInterface
{
public function findActive();
public function create(array $data);
}
// コントローラーでの使用
class UserController extends Controller
{
private $userRepository;
public function __construct(UserRepositoryInterface $userRepository)
{
$this->userRepository = $userRepository;
}
public function index()
{
$users = $this->userRepository->findActive();
return view('users.index', compact('users'));
}
}
バリデーション処理の実装方法
バリデーションは、フォームリクエストクラスを使用して実装することが推奨されます。
フォームリクエストの作成
php artisan make:request StoreUserRequest
class StoreUserRequest extends FormRequest
{
public function authorize()
{
return true;
}
public function rules()
{
return [
'name' => 'required|string|max:255',
'email' => 'required|email|unique:users,email',
'password' => 'required|min:8|confirmed',
'role' => 'required|in:user,admin',
];
}
public function messages()
{
return [
'name.required' => '名前は必須です',
'email.unique' => 'このメールアドレスは既に使用されています',
'password.min' => 'パスワードは8文字以上である必要があります',
];
}
}
コントローラーでの使用
class UserController extends Controller
{
public function store(StoreUserRequest $request)
{
// リクエストは自動的にバリデーションされる
$validated = $request->validated();
$user = User::create($validated);
return redirect()->route('users.show', $user)
->with('success', 'ユーザーが作成されました');
}
}
条件付きバリデーション
class UpdateUserRequest extends FormRequest
{
public function rules()
{
$userId = $this->route('user');
return [
'email' => [
'required',
'email',
Rule::unique('users')->ignore($userId),
],
'password' => $this->filled('password') ? [
'min:8',
'confirmed'
] : [],
];
}
}
レスポンスのベストプラクティス
class UserController extends Controller
{
public function show(User $user)
{
// 認可チェック
$this->authorize('view', $user);
// レスポンスの構造化
return response()->json([
'status' => 'success',
'data' => [
'user' => new UserResource($user),
'meta' => [
'last_login' => $user->last_login_at,
'created_at' => $user->created_at
]
]
]);
}
public function update(UpdateUserRequest $request, User $user)
{
try {
$user->update($request->validated());
return response()->json([
'status' => 'success',
'message' => 'ユーザー情報が更新されました',
'data' => new UserResource($user)
]);
} catch (\Exception $e) {
return response()->json([
'status' => 'error',
'message' => '更新中にエラーが発生しました',
'error' => $e->getMessage()
], 500);
}
}
}
これらのベストプラクティスを採用することで、保守性が高く、テストが容易で、セキュアなアプリケーションを開発することができます。次のセクションでは、これらのプラクティスを実際のユースケースに適用した具体的な実装例を見ていきます。
コントローラーの実装例と解説
ここでは、実際のプロジェクトでよく遭遇する具体的なユースケースに基づいて、コントローラーの実装例を詳しく解説します。
ユーザー登録機能の実装例
ユーザー登録機能は多くのWebアプリケーションで必要とされる基本的な機能です。以下に、セキュアで機能的な実装例を示します。
<?php
namespace App\Http\Controllers\Auth;
use App\Http\Controllers\Controller;
use App\Http\Requests\RegisterUserRequest;
use App\Services\UserRegistrationService;
use App\Events\UserRegistered;
use Illuminate\Support\Facades\Log;
class RegisterController extends Controller
{
private $registrationService;
public function __construct(UserRegistrationService $registrationService)
{
$this->registrationService = $registrationService;
}
/**
* 登録フォームの表示
*/
public function showRegistrationForm()
{
return view('auth.register');
}
/**
* ユーザー登録の処理
*/
public function register(RegisterUserRequest $request)
{
try {
// トランザクション内でユーザーを作成
$user = $this->registrationService->registerUser($request->validated());
// 登録完了イベントの発火
event(new UserRegistered($user));
// ログイン状態にする
auth()->login($user);
return redirect()->route('verification.notice')
->with('success', '登録が完了しました。メールアドレスの確認をお願いします。');
} catch (\Exception $e) {
Log::error('ユーザー登録エラー: ' . $e->getMessage());
return back()->withInput()
->with('error', '登録処理中にエラーが発生しました。');
}
}
}
関連するサービスクラス
<?php
namespace App\Services;
use App\Models\User;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Hash;
class UserRegistrationService
{
public function registerUser(array $data)
{
return DB::transaction(function () use ($data) {
// ユーザーの作成
$user = User::create([
'name' => $data['name'],
'email' => $data['email'],
'password' => Hash::make($data['password']),
]);
// プロフィールの作成
$user->profile()->create([
'bio' => $data['bio'] ?? null,
'phone' => $data['phone'] ?? null,
]);
return $user;
});
}
}
商品管理機能の実装例
ECサイトなどでよく見られる商品管理機能の実装例です。画像アップロード処理も含みます。
<?php
namespace App\Http\Controllers\Admin;
use App\Http\Controllers\Controller;
use App\Http\Requests\StoreProductRequest;
use App\Http\Requests\UpdateProductRequest;
use App\Models\Product;
use App\Services\ImageService;
use App\Repositories\ProductRepository;
class ProductController extends Controller
{
private $productRepository;
private $imageService;
public function __construct(
ProductRepository $productRepository,
ImageService $imageService
) {
$this->productRepository = $productRepository;
$this->imageService = $imageService;
$this->middleware('auth');
$this->middleware('role:admin');
}
/**
* 商品一覧の表示
*/
public function index()
{
$products = $this->productRepository->getPaginatedProducts();
return view('admin.products.index', compact('products'));
}
/**
* 商品の新規作成処理
*/
public function store(StoreProductRequest $request)
{
try {
$data = $request->validated();
// 画像がアップロードされた場合の処理
if ($request->hasFile('image')) {
$data['image_path'] = $this->imageService->uploadImage(
$request->file('image'),
'products'
);
}
$product = $this->productRepository->create($data);
// キャッシュのクリア
cache()->tags('products')->flush();
return redirect()->route('admin.products.show', $product)
->with('success', '商品が登録されました');
} catch (\Exception $e) {
\Log::error('商品登録エラー: ' . $e->getMessage());
return back()->withInput()
->with('error', '商品の登録に失敗しました');
}
}
/**
* 商品の更新処理
*/
public function update(UpdateProductRequest $request, Product $product)
{
try {
$data = $request->validated();
// 画像の更新処理
if ($request->hasFile('image')) {
// 古い画像の削除
$this->imageService->deleteImage($product->image_path);
// 新しい画像のアップロード
$data['image_path'] = $this->imageService->uploadImage(
$request->file('image'),
'products'
);
}
$this->productRepository->update($product, $data);
cache()->tags('products')->flush();
return redirect()->route('admin.products.show', $product)
->with('success', '商品情報が更新されました');
} catch (\Exception $e) {
\Log::error('商品更新エラー: ' . $e->getMessage());
return back()->withInput()
->with('error', '商品の更新に失敗しました');
}
}
}
API用コントローラーの実装例
モダンなWebアプリケーションでは、APIの実装は非常に重要です。以下に、APIコントローラーの実装例を示します。
<?php
namespace App\Http\Controllers\Api\V1;
use App\Http\Controllers\Controller;
use App\Http\Requests\Api\TaskRequest;
use App\Http\Resources\TaskResource;
use App\Models\Task;
use App\Services\TaskService;
use Illuminate\Http\Request;
class TaskController extends Controller
{
private $taskService;
public function __construct(TaskService $taskService)
{
$this->taskService = $taskService;
$this->middleware('auth:sanctum');
}
/**
* タスク一覧の取得
*/
public function index(Request $request)
{
try {
$tasks = $this->taskService->getUserTasks(
$request->user(),
$request->query('status'),
$request->query('sort_by', 'created_at')
);
return TaskResource::collection($tasks)
->additional([
'meta' => [
'total_count' => $tasks->total(),
'current_page' => $tasks->currentPage(),
]
]);
} catch (\Exception $e) {
return response()->json([
'message' => 'タスクの取得に失敗しました',
'error' => $e->getMessage()
], 500);
}
}
/**
* タスクの作成
*/
public function store(TaskRequest $request)
{
try {
$task = $this->taskService->createTask(
$request->user(),
$request->validated()
);
return (new TaskResource($task))
->response()
->setStatusCode(201);
} catch (\Exception $e) {
return response()->json([
'message' => 'タスクの作成に失敗しました',
'error' => $e->getMessage()
], 500);
}
}
/**
* タスクの更新
*/
public function update(TaskRequest $request, Task $task)
{
try {
// タスクの所有者チェック
$this->authorize('update', $task);
$updatedTask = $this->taskService->updateTask(
$task,
$request->validated()
);
return new TaskResource($updatedTask);
} catch (\Exception $e) {
return response()->json([
'message' => 'タスクの更新に失敗しました',
'error' => $e->getMessage()
], 500);
}
}
/**
* タスクの一括更新
*/
public function bulkUpdate(Request $request)
{
try {
$results = $this->taskService->bulkUpdateTasks(
$request->user(),
$request->input('tasks')
);
return response()->json([
'message' => '一括更新が完了しました',
'updated_count' => $results['updated_count'],
'failed_count' => $results['failed_count']
]);
} catch (\Exception $e) {
return response()->json([
'message' => '一括更新に失敗しました',
'error' => $e->getMessage()
], 500);
}
}
}
これらの実装例から、以下のような重要なポイントが分かります：
- 責務の分離
- ビジネスロジックはサービスクラスに委譲
- データアクセスはリポジトリクラスに委譲
- コントローラーは主にリクエスト処理とレスポンス生成に専念
- エラーハンドリング
- try-catchによる適切な例外処理
- エラーログの記録
- ユーザーフレンドリーなエラーメッセージの返却
- セキュリティ対策
- 認証・認可の確実な実装
- バリデーションの徹底
- クロスサイトリクエストフォージェリ（CSRF）対策
- パフォーマンス最適化
- キャッシュの適切な利用
- データベーストランザクションの活用
- 必要に応じた遅延読み込みの実装
これらの実装例を参考に、自身のプロジェクトに合わせてカスタマイズすることで、保守性が高く、セキュアなアプリケーションを開発することができます。
コントローラー作成時の注意点とトラブルシューティング
コントローラーの開発中に遭遇しやすい問題とその解決方法、セキュリティ対策、パフォーマンス最適化について解説します。
よくあるエラーと解決方法
1. ルーティング関連のエラー
Target class [App\Http\Controllers\UserController] does not exist.
原因と解決策：
- 名前空間の問題
// 誤った例 namespace App\Controllers; // 誤った名前空間 // 正しい例 namespace App\Http\Controllers; // 正しい名前空間
- ファイル名とクラス名の不一致
// UserController.php の中で class UsersController extends Controller // ファイル名と不一致 // 正しい例 class UserController extends Controller // ファイル名と一致
- コントローラーの配置場所
# 誤った配置 app/Controllers/UserController.php # 正しい配置 app/Http/Controllers/UserController.php
2. メソッドインジェクション関連のエラー
Target class [App\Services\UserService] does not exist.
解決策：
- サービスクラスの存在確認
- サービスプロバイダーへの登録確認
// app/Providers/AppServiceProvider.php
public function register()
{
$this->app->bind(UserServiceInterface::class, UserService::class);
}
3. バリデーションエラー
Class App\Http\Requests\CreateUserRequest does not exist
解決策：
- フォームリクエストクラスの生成
php artisan make:request CreateUserRequest
- 名前空間とクラス名の確認
namespace App\Http\Requests;
class CreateUserRequest extends FormRequest
{
// ...
}
セキュリティ対策の実装方法
1. CSRF対策
class ProductController extends Controller
{
public function __construct()
{
// Web用ルートのCSRF保護
$this->middleware('web');
// 特定のアクションのみCSRF保護を除外
$this->middleware('csrf')->except(['index', 'show']);
}
}
2. 認可処理の実装
class OrderController extends Controller
{
public function show(Order $order)
{
// Policyを使用した認可
$this->authorize('view', $order);
// 手動での認可チェック
if (! auth()->user()->can('view', $order)) {
abort(403, '注文の閲覧権限がありません。');
}
return view('orders.show', compact('order'));
}
}
3. 入力値の安全な処理
class ArticleController extends Controller
{
public function store(Request $request)
{
// XSS対策
$sanitizedContent = strip_tags(
$request->input('content'),
'<p><br><strong><em><ul><li>' // 許可するタグ
);
// SQLインジェクション対策
$articles = DB::table('articles')
->where('status', '=', '?')
->setBindings([$request->input('status')])
->get();
}
}
4. ファイルアップロードの安全な処理
class FileController extends Controller
{
public function store(Request $request)
{
$request->validate([
'file' => 'required|file|mimes:pdf,doc,docx|max:10240',
]);
try {
$path = $request->file('file')->store('uploads', 'private');
} catch (\Exception $e) {
Log::error('ファイルアップロードエラー: ' . $e->getMessage());
return back()->with('error', 'ファイルのアップロードに失敗しました。');
}
}
}
パフォーマンス最適化のポイント
1. クエリの最適化
class UserController extends Controller
{
public function index()
{
// 悪い例（N+1問題）
$users = User::all();
foreach ($users as $user) {
$user->profile->name; // 追加クエリが発生
}
// 良い例（Eager Loading）
$users = User::with('profile')->get();
}
}
2. キャッシュの活用
class ProductController extends Controller
{
public function index()
{
// キャッシュの活用
$products = Cache::remember('products.all', 3600, function () {
return Product::with('category')
->latest()
->get();
});
return view('products.index', compact('products'));
}
public function update(Request $request, Product $product)
{
$product->update($request->validated());
// 関連キャッシュの削除
Cache::tags(['products'])->flush();
}
}
3. リソースの最適化
class ArticleController extends Controller
{
public function index()
{
// ページネーションの活用
$articles = Article::latest()
->paginate(20);
// 必要なリレーションのみロード
$articles = Article::with(['author', 'category'])
->without(['comments', 'tags'])
->get();
}
}
パフォーマンスモニタリング
class OrderController extends Controller
{
public function process(Request $request)
{
// 処理時間の計測
$startTime = microtime(true);
// 処理の実行
$result = $this->orderService->processOrder($request->all());
// 処理時間のログ記録
$executionTime = microtime(true) - $startTime;
Log::info("注文処理の実行時間: {$executionTime}秒");
return $result;
}
}
主なパフォーマンス改善のためのチェックポイント
- データベースクエリの最適化
- 必要なカラムのみ取得
- インデックスの適切な使用
- N+1問題の解消
- キャッシュ戦略
- 適切なキャッシュキーの設定
- キャッシュの有効期限の管理
- キャッシュクリアのタイミング
- リソース使用の最適化
- メモリ使用量の監視
- 大量データの処理時のチャンク処理
- バックグラウンドジョブの活用
これらの注意点とベストプラクティスを意識することで、より安全で効率的なアプリケーションを開発することができます。エラーが発生した場合は、このガイドを参考に適切な対処を行ってください。
さらなる学習のためのリソースとツール
Laravelコントローラーの開発スキルをさらに向上させるための、おすすめリソースやツール、テスト方法について解説します。
おすすめの学習リソース
1. 公式ドキュメント
Laravel公式ドキュメントは、最も信頼できる情報源です：
2. おすすめの書籍
- 『実践Laravel』
- コントローラーの実装パターン
- ベストプラクティスの解説
- 実践的なユースケース
- 『Laravel Clean Code』
- クリーンアーキテクチャの適用方法
- テスタブルなコントローラーの書き方
- デザインパターンの活用
3. オンラインリソース
- Laracastsのビデオチュートリアル
- Laravel Newsのブログ記事
- PHPUnitの公式ドキュメント
開発効率を上げるVSCode拡張機能
1. 必須の拡張機能
{
"recommendations": [
"onecentlin.laravel-extension-pack",
"amiralizadeh9480.laravel-extra-intellisense",
"calebporzio.better-phpunit",
"ryannaddy.laravel-artisan",
"shufo.vscode-blade-formatter",
"bmewburn.vscode-intelephense-client"
]
}
2. おすすめのVSCode設定
{
"php.suggest.basic": false,
"php.validate.enable": false,
"php.format.codeStyle": "PSR-2",
"laravel-pint.enable": true,
"editor.formatOnSave": true,
"blade.format.enable": true,
"[php]": {
"editor.defaultFormatter": "bmewburn.vscode-intelephense-client"
}
}
3. 便利なスニペット例
{
"Laravel Controller Method": {
"prefix": "lmethod",
"body": [
"public function ${1:methodName}(Request \\$request)",
"{",
" try {",
" \\$validated = \\$request->validate([",
" ${2:'field'} => ${3:'required'},",
" ]);",
"",
" ${0:// Implementation}",
"",
" return redirect()->route('${4:route.name}')",
" ->with('success', '${5:Success message}');",
" } catch (\\Exception \\$e) {",
" Log::error('Error in ${1:methodName}: ' . \\$e->getMessage());",
" return back()->with('error', '${6:Error message}');",
" }",
"}"
],
"description": "Create a new controller method with try-catch"
}
}
コントローラーのテスト方法
1. 基本的なテストの書き方
namespace Tests\Feature;
use Tests\TestCase;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
class UserControllerTest extends TestCase
{
use RefreshDatabase;
public function test_index_displays_users_list()
{
// テストデータの準備
$users = User::factory(3)->create();
// アクションの実行
$response = $this->get(route('users.index'));
// アサーション
$response->assertStatus(200)
->assertViewIs('users.index')
->assertViewHas('users')
->assertSee($users->first()->name);
}
public function test_store_creates_new_user()
{
// テストデータの準備
$userData = [
'name' => 'Test User',
'email' => 'test@example.com',
'password' => 'password',
'password_confirmation' => 'password',
];
// アクションの実行
$response = $this->post(route('users.store'), $userData);
// アサーション
$response->assertRedirect(route('users.index'));
$this->assertDatabaseHas('users', [
'name' => $userData['name'],
'email' => $userData['email'],
]);
}
}
2. モックを使用したテスト
use Mockery;
use App\Services\UserService;
class UserControllerTest extends TestCase
{
public function test_update_user_with_mocked_service()
{
// サービスのモック作成
$mockedService = Mockery::mock(UserService::class);
$mockedService->shouldReceive('updateUser')
->once()
->with(Mockery::any(), Mockery::any())
->andReturn(true);
// モックをコンテナにバインド
$this->app->instance(UserService::class, $mockedService);
// テストの実行
$response = $this->put(route('users.update', 1), [
'name' => 'Updated Name'
]);
$response->assertRedirect();
}
}
3. 認証・認可のテスト
class OrderControllerTest extends TestCase
{
public function test_unauthorized_user_cannot_view_orders()
{
// 未認証ユーザーのテスト
$response = $this->get(route('orders.index'));
$response->assertRedirect(route('login'));
// 権限のないユーザーのテスト
$user = User::factory()->create();
$response = $this->actingAs($user)
->get(route('orders.index'));
$response->assertStatus(403);
// 適切な権限を持つユーザーのテスト
$admin = User::factory()->create(['role' => 'admin']);
$response = $this->actingAs($admin)
->get(route('orders.index'));
$response->assertStatus(200);
}
}
4. APIテスト
class ApiUserControllerTest extends TestCase
{
public function test_api_returns_users_list()
{
Passport::actingAs(
User::factory()->create(),
['view-users']
);
$users = User::factory(3)->create();
$response = $this->getJson('/api/users');
$response
->assertStatus(200)
->assertJsonStructure([
'data' => [
'*' => [
'id',
'name',
'email',
'created_at'
]
],
'meta' => [
'current_page',
'total'
]
]);
}
}
これらのリソースとツールを活用することで、より効率的な開発が可能になり、コードの品質も向上させることができます。特にテストの実装は、アプリケーションの信頼性を高める上で非常に重要です。継続的な学習と実践を通じて、さらなるスキルアップを目指しましょう。