Laravel Valet

• 介紹
  • Valet 與 Homestead
• 安裝
  • 升級
• 啟動專案
  • 「Park」指令
  • 「Link」指令
  • 使用 TLS 保護
• 共享網站
• 自訂 Valet 驅動
  • 本機驅動
• 其它 Valet 指令

介紹

Valet 是專屬於 MacOS 的 Laravel 開發環境。既不用 Vagrant，也不用 /etc/hosts 檔案，就能夠使用本機終端機來公開並共享你的網站。沒錯！我們也很喜歡。

Laravel Valet 設定 MacOS 在啟動伺服器時會在背景執行 Nginx。然後，使用 DnsMasq，Valet 會將所有本機伺服器上安裝的專案全都代理到 *.test 網域上。

換句話說，這個極快的 Laravel 開發環境只會用到 7 MB 的記憶體。Valet 並非能完全取代 Vagrant 或 Homestead，但如果你想要靈活、極快、或更輕盈的開發環境，這會是一個很好的選擇。

Valet 預設就支援以下這些內容，當然，實際支援的內容還有更多：

對了，你可以使用自訂驅動來擴展 Valet。

Valet 與 Homestead

就如你所知的那樣，Laravel 提供了另一個開發環境，也就是 Homestead。Homestead 和 Valet 不同的地方在於他們主要客群想使用什麼方式來建立開發環境。Homestead 提供一個完整的 Ubuntu 虛擬機，並自動化 Nginx 設定。如果你想要完全虛擬化的 Linux 開發環境或者在 Windows / Linux 系統環境上開發，Homestead 會是一個很好的選擇。

Valet 只支援 MacOS，並且會要求你在本機環境上直接安裝 PHP 和資料庫伺服器。你可以使用 Homebrew 的 brew install php72 和 brew install mysql 指令來輕鬆的安裝。Valet 提供了一個極快的本機開發環境，且只會佔用到極小的資源，所以這對於只會用到 PHP 和 MySQL 而不需要完整的虛擬開發環境的開發者而言真的很好！

不論是 Valet 還是 Homestead 都是設定 Laravel 開發環境的最佳選項。請根據你與團隊的喜好與需求來做選擇。

安裝

Valet 的基本要求是 macOS 系統並安裝 Homebrew。在安裝之前，你應該確認沒有像是 Apache 或 Nginx 的程式有占用到本機的 80 Port

Valet 一旦安裝好了，就可以在終端機上使用像是 ping foobar.test 指令來測試任何 *.test 網域的連線狀態。如果有成功安裝 Valet ，你應該會看到這個網域回應 127.0.0.1。

Valet 會在每次被啟動時自動開啟他的守護行程。一旦完成了第一次的 Valet 安裝，就不需要再執行 valet start 或 valet install 指令了。

使用其它的網域

預設的 Valet 能為你的專案來使用 .test TLD。如果你不滿意這個網域，你能使用 valet domain tld-name 指令來使用想要的其它網域。

例如，如果你想要使用 .app 網域，而不是 .test。請執行 valet domain app，Valet 會自動在 *.app 網域來開始你的專案。

資料庫

如果你需要一個資料庫，請你在指令列上執行 brew install mysql 來安裝 MySQL。MySQL 一旦安裝好了，你就能使用 brew services start mysql 指令來啟動 MySQL。接著，你能使用 root 帳號與空字串的密碼來連線 127.0.0.1 的資料庫。

升級

你可以在終端機中使用 composer global update 來更新 Valet 安裝。在升級之後，最好執行一下 valet install 指令，讓 Valet 能夠針對設定檔來做額外的升級。

升級到 Valet 2.0

Valet 2.0 將 Valet 的底層網頁伺服器從 Caddy 移植到 Nginx。在升級到這個版本前，你應該執行下列指令來停止並移除現有的 Caddy 守護行程：

valet stop
valet uninstall

接著，你開始將 Valet 升級到最後版本。請依據你擅長的 Valet 安裝方式來升級，通常是使用 Git 或 Composer。如果你透過 Composer 來安裝 Valet，你應該使用以下指令來更新主要版本到最新版：

composer global require laravel/valet

一旦下載完最新的 Valet 原始碼，你就能執行 install 指令：

valet install
valet restart

在升級之後，可能會需要重新放置或連結你的專案。

啟動專案

Valet 一旦安裝好了，你可以開始準備啟動專案。Valet 提供兩種指令來協助你啟動 Laravel 專案：park 和 link。

park 指令

就只有這些步驟！現在任何在被「Park」標記的目錄中的 Laravel 專案會自動使用 http://folder-name.test 慣例來啟動。

link 指令

link 指令也可以被用於啟動你的 Laravel 專案。這個指令有助於只啟動目錄中一個專案，而不是整個目錄。

若要查詢所有已連結目錄的清單，請執行 valet links 指令。你可以使用 valet unlink app-name 指令來取消某個連結符號。

{tip} 你能從多個（子）網域中使用 valet link 來啟動想同的專案。若要將子網域或另一個網域新增到專案中，請從專案資料夾中執行 valet link subdomain.app-name 指令。

使用 TLS 保護

預設的 Valet 只會啟動未加密的 HTTP。然而，如果你想要使用 HTTP/2 的加密 TLS 來啟動專案，請使用 secure 指令。例如，如果你的專案被啟動在 Valet 上的 laravel.test 網域，你你應該執行以下指令來保護它：

valet secure laravel

若要「解除」專案的安全協定，並恢復到未加密的 HTTP，請使用 unsecure 指令。就像使用 secure 指令一樣，這個指令接受你想要解除的主機名稱：

valet unsecure laravel

共享專案

Valet 甚至包括與世界分享你的本機網站的指令。一旦安裝了 Valet，就不需要安裝額外的軟體。

若要共享專案，請導航到終端機中的專案目錄，並執行 valet share 指令。會將可被公開存取的 URL 放入剪貼簿中，並準備貼到瀏覽器。就這樣。

若要停止共享專案，請點擊 Control + C 來終止共享。

{note} valet share 目前還不支援使用 valet secure 指令來保護的網頁。

自訂 Valet 驅動

你能夠撰寫屬於自己的 Valet「驅動」來啟動 Valet 不支援的其他框架或 CMS 的 PHP 應用程式。當你安裝 Valet 的時候，會建立一個包含 SampleValetDriver.php 檔案的 ~/.valet/Drivers 目錄。這個檔案包含一個簡易的驅動實作來示範如何撰寫自訂驅動。撰寫一個驅動只需要你實作三種方法：serves、isStaticFile 和 frontControllerPath。

這三種方法都接受 $sitePath、$siteName 和 $uri 的值作為它們的參數。$sitePath 會是在本機上的專案完整路徑，像是 /Users/Lisa/Sites/my-project。$siteName 會是網域（my-project）的「主機」或專案名稱的部分。$uri 則是傳入請求的 URI (/foo/bar)。

你一旦完成了自訂 Valet 驅動，請使用 FrameworkValetDriver.php 慣例命名方式將它放置於 ~/.valet/Drivers 目錄中。例如，如果你正在為 WordPress 撰寫自訂的 Valet 驅動，你的檔名應該會是 WordPressValetDriver.php。

讓我們來看看自訂 Valet 驅動應該實作的每種方法的簡單實作。

serves 方法

如果你的驅動會去處理傳入請求，serves 方法會回傳 true。反之，該方法則回傳 false。因此，在這個方法中，你應該嘗試確認給定的 $sitePath 是否有你想要啟動的類型專案。

例如，讓我們假設正在撰寫 WordPressValetDriver。我們的 serve 方法看起來會像是這樣：

/**
 * 檢查該驅動是否有被需要。
 *
 * @param  string  $sitePath
 * @param  string  $siteName
 * @param  string  $uri
 * @return bool
 */
public function serves($sitePath, $siteName, $uri)
{
    return is_dir($sitePath.'/wp-admin');
}

isStaticFile 方法

isStaticFile 會去檢查傳入的請求是不是「靜態」檔案，像是圖像或樣式表。如果該檔案為靜態，該方法會回傳硬碟上的靜態檔案的完整路徑。如果傳入請求不是靜態檔案，該方法會回傳 false：

/**
 * 檢查傳入的請求是否為靜態檔案。
 *
 * @param  string  $sitePath
 * @param  string  $siteName
 * @param  string  $uri
 * @return string|false
 */
public function isStaticFile($sitePath, $siteName, $uri)
{
    if (file_exists($staticFilePath = $sitePath.'/public/'.$uri)) {
        return $staticFilePath;
    }

    return false;
}

{note} isStaticFile 方法只會在 serves 方法回傳 true 的時候傳入請求，並且該請求的 URL 不是 / 時呼叫該方法。

frontControllerPath 方法

frontControllerPath 方法會回傳符合條件的完整路徑到應用程式的「前端控制器」，這通常是你的「index.php」或相同性質的檔案：

/**
 * 取得符合條件的完整路徑到應用程式的前端控制器。
 *
 * @param  string  $sitePath
 * @param  string  $siteName
 * @param  string  $uri
 * @return string
 */
public function frontControllerPath($sitePath, $siteName, $uri)
{
    return $sitePath.'/public/index.php';
}

本機驅動

如果你想要為專為一個應用程式定義一個自訂的 Valet 驅動，請在應用程式的根目錄中建立 LocalValetDriver.php。你自訂的驅動會去繼承底層的 ValetDriver 類別或指定繼承現有的驅動，像是 LaravelValetDriver：

class LocalValetDriver extends LaravelValetDriver
{
    /**
     * 檢查該驅動是否有被需要。
     *
     * @param  string  $sitePath
     * @param  string  $siteName
     * @param  string  $uri
     * @return bool
     */
    public function serves($sitePath, $siteName, $uri)
    {
        return true;
    }

    /**
     * 取得應用程式的前端控制器完整路徑。
     *
     * @param  string  $sitePath
     * @param  string  $siteName
     * @param  string  $uri
     * @return string
     */
    public function frontControllerPath($sitePath, $siteName, $uri)
    {
        return $sitePath.'/public_html/index.php';
    }
}

其它 Valet 指令