laravel控制器怎么定義

本篇內容主要講解“laravel控制器怎么定義”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“laravel控制器怎么定義”吧!

在laravel中，控制器（Controller）是一個類，用于實現一定的功能；控制器能將相關的請求處理邏輯組成一個單獨的類。控制器中存放中一些方法，實現一定的功能，通過路由調用控制器，不再使用回調函數；控制器被存放在“app/Http/Controllers”目錄中。

控制器介紹

1、控制器是什么？

為了替代在路由文件中以閉包形式定義的所有的請求處理邏輯，你可能想要使用控制類來組織這些行為。控制器能將相關的請求處理邏輯組成一個單獨的類。

Controller，是類，用于實現一定的功能，控制器中存放中一些方法，實現一定的功能，通過路由調用控制器，不再使用回調函數。

2、控制器寫在哪里？

App/Http/Controllers放置控制器

Controller.php是父類文件，別的控制器可以繼承

3、控制器文件如何命名？

大駝峰的控制器名+Controller.php

例如AddDataController.php LoginController.php

4、控制器結構怎么寫？

通過artisan命令自動生成，例如：確保在當前項目的根目錄，命令行輸入：

php artisan make:controller TestController

結構代碼自動完成，

   namespace App\Http\Controller;
   use Illuminate\Http\Request;    
   class TestController extends  Controller{
     //
   }

基礎控制器

定義控制器

下面是一個基礎控制器類的例子。需要注意的是，該控制器繼承了 Laravel 的基礎控制器。該類控制器提供了一些便利的方法，比如  middleware 方法，該方法可以為控制器行為添加中間件：

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\User;

class UserController extends Controller
{
    /**
     * 顯示指定用戶的簡介
     *
     * @param  int  $id
     * @return \Illuminate\View\View
     */
    public function show($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

你可以像這樣定義一個指向控制器行為的路由：

use App\Http\Controllers\UserController;

Route::get('user/{id}', [UserController::class, 'show']);

當一個請求與指定路由的 URI 匹配時， UserController 控制器中的 show 方法將會執行。路由參數也將會被傳遞給該方法。

技巧：控制器并不是 必需 繼承基礎類。如果控制器沒有繼承基礎類，你將無法使用一些便捷的功能，比如 middleware，validate，和 dispatch 方法。

單行為控制器

如果你想要定義一個只處理單個行為的控制器，你可以在控制器中放置一個 __invoke 方法：

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\User;

class ShowProfile extends Controller
{
    /**
     * 顯示指定用戶的簡介
     *
     * @param  int  $id
     * @return \Illuminate\View\View
     */
    public function __invoke($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

當注冊單個行為控制器的路由時不需要指名方法：

use App\Http\Controllers\ShowProfile;

Route::get('user/{id}', ShowProfile::class);

你可以通過 Artisan 命令工具里的 make:controller 命令中的 --invokable 選項來生成一個可調用的控制器

php artisan make:controller ShowProfile --invokable

技巧：可以使用 stub 定制 自定義控制器模板

控制器中間件

中間件 可以在路由文件中分配給控制器的路由：

Route::get('profile', [UserController::class, 'show'])->middleware('auth');

然而，在控制器的構造函數中指定中間件更為方便。使用控制器構造函數中的 middleware 方法，可以輕松地將中間件分配給控制器。你甚至可以將中間件限制為只在控制器中的某些方法生效：

class UserController extends Controller
{
    /**
     * 實例化一個新的控制器實例
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');

        $this->middleware('log')->only('index');

        $this->middleware('subscribed')->except('store');
    }
}

同時，控制器還允許你使用一個閉包來注冊中間件。這為不定義整個中間件類的情況下為單個控制器定義中間件提供了一種便捷的方法：

$this->middleware(function ($request, $next) {
    // ...

    return $next($request);
});

技巧：你可以將中間件分配給控制器操作的一個子集。然而，它可能表明你的控制器正在變得復雜。建議你將控制器拆分為多個較小的控制器。

資源型控制器

Laravel 的資源路由通過單行代碼即可將典型的「CURD (增刪改查)」路由分配給控制器。例如，你希望創建一個控制器來處理保存 “照片” 應用的所有 HTTP 請求。使用 Artisan 命令 make:controller 可以快速創建這樣一個控制器：

php artisan make:controller PhotoController --resource

這個命令將會生成一個控制器 app/Http/Controllers/PhotoController.php。 其中包括每個可用資源操作的方法。

接下來，你可以給控制器注冊一個資源路由：

Route::resource('photos', PhotoController::class);

這個單一的路由聲明創建了多個路由來處理資源上的各種行為。生成的控制器為每個行為保留了方法，包括了關于處理 HTTP 動詞和 URLs 的聲明注釋。

你可以通過將數組傳參到 resources 方法中的方式來一次性的創建多個資源控制器：

Route::resources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
]);

資源控制器操作處理

指定資源模型

如果你使用了路由模型綁定，并且想在資源控制器的方法中使用類型提示，你可以在生成控制器的時候使用 --model 選項：

php artisan make:controller PhotoController --resource --model=Photo

部分資源路由

當聲明資源路由時，你可以指定控制器處理的部分行為，而不是所有默認的行為：

Route::resource('photos', PhotoController::class)->only([
    'index', 'show'
]);

Route::resource('photos', PhotoController::class)->except([
    'create', 'store', 'update', 'destroy'
]);

API 資源路由

當聲明用于 APIs 的資源路由時，通常需要排除顯示 HTML 模板的路由（如 create 和 edit ）。為了方便起見，你可以使用 apiResource 方法自動排除這兩個路由：

Route::apiResource('photos', PhotoController::class);

你也可以傳遞一個數組給 apiResources 方法來同時注冊多個 API 資源控制器：

Route::apiResources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
]);

要快速生成不包含 create 或 edit 方法的用于開發接口的資源控制器，請在執行 make:controller 命令時使用 --api 參數:

php artisan make:controller API/PhotoController --api

嵌套資源

有時可能需要定義一個嵌套的資源型路由。例如，照片資源可能被添加了多個評論。那么可以在路由中使用 “點” 符號來聲明資源型控制器：

Route::resource('photos.comments', PhotoCommentController::class);

該路由會注冊一個嵌套資源，可以使用如下 URI 訪問:

/photos/{photo}/comments/{comment}

限定嵌套資源的范圍

Laravel 的 隱式模型綁定 特性可以自動限定嵌套綁定的范圍，因此已解析的子模型會自動屬于父模型。定義嵌套路由時，使用 scoped 方法，可以開啟自動范圍限定，也可以指定 Laravel 應該按照哪個字段檢索子模型資源

Route::resource('photos.comments', PhotoCommentController::class)->scoped([
    'comment' => 'slug',
]);

這個路由會注冊一個限定范圍的嵌套資源路由，可以像下面這樣來訪問：

/photos/{photo}/comments/{comment:slug}

淺層嵌套

通常，并不完全需要在 URI 中同時擁有父 ID 和子 ID ，因為子 ID 已經是唯一的標識符。當使用唯一標識符（如自動遞增的主鍵）來標識 URI 中的模型時，可以選擇使用「淺嵌套」的方式定義路由：

Route::resource('photos.comments', CommentController::class)->shallow();

上面的路由定義方式會定義以下路由：

命名資源路由

默認情況下，所有的資源控制器行為都有一個路由名稱。你可以傳入 names 數組來覆蓋這些名稱：

Route::resource('photos', PhotoController::class)->names([
    'create' => 'photos.build'
]);

命名資源路由參數

默認情況下，Route::resource 會根據資源名稱的「單數」形式創建資源路由的路由參數。你可以在選項數組中傳入 parameters 參數來輕松地覆蓋每個資源。parameters 數組應該是資源名稱和參數名稱的關聯數組：

Route::resource('users', AdminUserController::class)->parameters([
    'users' => 'admin_user'
]);

上例將會為資源的 show 路由生成如下的 URI ：

/users/{admin_user}

限定范圍的資源路由

有時，在定義資源路由時隱式綁定了多個 Eloquent 模型，你希望限定第二個 Eloquent 模型必須為第一個 Eloquent 模型的子模型。例如，考慮這樣一個場景，通過 slug 檢索某個特殊用戶的一篇文章：

use App\Http\Controllers\PostsController;Route::resource('users.posts', PostsController::class)->scoped();

你可以通過給 scoped 方法傳遞一個數組來覆蓋默認的模型路由鍵：

use App\Http\Controllers\PostsController;Route::resource('users.posts', PostsController::class)->scoped([
    'post' => 'slug',
]);

當使用一個自定義鍵的隱式綁定作為嵌套路由參數時，Laravel 會自動限定查詢范圍，按照約定的命名方式去父類中查找關聯方法，然后檢索到對應的嵌套模型。在這種情況下，將假定 User 模型有一個叫 posts（路由參數名的復數）的關聯方法，通過這個方法可以檢索到 Post 模型。

本地化資源 URI

默認情況下，Route::resource 將會用英文動詞創建資源 URI。如果需要自定義 create 和 edit 行為的動作名，可以在 AppServiceProvider 的 boot 中使用 Route::resourceVerbs 方法實現:

use Illuminate\Support\Facades\Route;

/**
 * 引導任何應用服務。
 *
 * @return void
 */
public function boot()
{
    Route::resourceVerbs([
        'create' => 'crear',
        'edit' => 'editar',
    ]);
}

動作被自定義后，像 Route::resource('fotos', 'PhotoController') 這樣注冊的資源路由將會產生如下的 URI：

/fotos/crear

/fotos/{foto}/editar

補充資源控制器

如果您需要增加額外的路由到默認的資源路由之中，您需要在 Route::resource 前定義它們；否則， resource 方法定義的路由可能會無意間優先于您定義的路由：

Route::get('photos/popular', [PhotoController::class, 'popular']);

Route::resource('photos', PhotoController::class);

技巧：記得保持您的控制器的專一性。如果您需要典型的資源操作以外的方法，請考慮將您的控制器分割為兩個更小的控制器。

依賴注入 & 控制器

構造注入

Laravel 服務容器 被用于解析所有的 Laravel 控制器。因此，您可以在控制器的構造函數中使用類型提示需要的依賴項。聲明的解析會自動解析并注入到控制器實例中去：

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepository;

class UserController extends Controller
{
    /**
     * 用戶 repository 實例。
     */
    protected $users;

    /**
     * 創建一個新的控制器實例。
     *
     * @param  UserRepository  $users
     * @return void
     */
    public function __construct(UserRepository $users)
    {
        $this->users = $users;
    }
}

您亦可類型提示 Laravel 契約 ，只要它能夠被解析。取決于您的應用，注入依賴到控制器可能會提供更好的可測試性。

方法注入

除了構造器注入以外，您亦可在控制器方法中類型提示依賴。最常見的用法便是注入 Illuminate\Http\Request 到您的控制器方法中：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * 保存一個新用戶。
     *
     * @param  Request  $request
     * @return Response
     */
    public function store(Request $request)
    {
        $name = $request->name;

        //
    }
}

如果您的控制器方法要從路由參數中獲取輸入內容，請在您的依賴項之后列出您的路由參數。例如，您可以像下方這樣定義路由：

Route::put('user/{id}', [UserController::class, 'update']);

如下所示，您依然可以類型提示 Illuminate\Http\Request 并通過定義您的控制器方法訪問 id 參數：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * 修改指定的用戶。
     *
     * @param  Request  $request
     * @param  string  $id
     * @return Response
     */
    public function update(Request $request, $id)
    {
        //
    }
}

路由緩存

如果您的應用僅使用了基于路由的控制器，您應該充分利用 Laravel 路由緩存。使用路由緩存將會大幅降低您的應用路由的注冊時間。有時，您的路由注冊的速度可能會提高 100 倍。要生成路由緩存，僅需執行  route:cache Artisan 命令：

php artisan route:cache

在運行該命令后，每次請求將會加載您緩存的路由文件。請記住，您每次添加新路由后均需要生成新的路由緩存。因此，您應該在項目部署時才運行 route:cache 命令。

您亦可使用 route:clear 來清除路由緩存：

php artisan route:clear

到此，相信大家對“laravel控制器怎么定義”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！