在Laravel中使用自己的類庫三種方式

jasonleev發表於2014-04-17
Laravel

雖然Composer使得我們可以重用很多現有的類庫（例如packagist.org中的），但是我們仍然可能用到一些不相容composer的包或者類庫。另外在某一專案中，我們也可能會建立某一類庫，而且可能並沒有製作成為composer package 的打算。這個時候我們可以通過以下方式來使用自己的特有類庫。

增加可直接例項化的類

有些需要直接在專案中使用的類，可以通過以下方式增加到Laravel中

  1. 建立類庫檔案app/libraries/class/myClass.php
  2. 寫入檔案內容
<?php
class Message {
    public static function display() {

    }
}
?>
  1. 在app/start/globals.php中增加類匯入路徑
<?php 
ClassLoader::addDirectories(array(

    app_path().'/commands',
    app_path().'/controllers',
    app_path().'/models',
    app_path().'/database/seeds',
    app_path().'/libaries/class', // 在這裡增加

));
?>
  1. 在composer.json中增加autoload目錄
"autoload": {
    "classmap": [
        "app/commands",
        "app/controllers",
        "app/models",
        "app/database/migrations",
        "app/database/seeds",
        "app/tests/TestCase.php",
        "app/libraries/class"   //在這裡增加
    ]
},
  1. 執行composer dump-autoload來建立匯入對映
  2. 使用自己匯入的類直接呼叫Message::display()即可

這種方法同樣也是增加佇列類的方法，很多人不知道Laravel中佇列處理類應該放在哪裡，其實按照上面的方法，在app目錄下建立一個queues目錄，然後讓其可以直接例項化即可

增加可直接呼叫的函式

有人喜歡用v()來代替var_dump()，想要在Laravel中這麼做也非常容易

  1. 建立一個函式檔案app/libraries/function/helper.php
  2. 寫入檔案內容
<?php 
function v($msg){
    var_dump($msg);
}
?>
  1. 把檔案增加到composer自動匯入列表中
"autoload": {
   "classmap": [
       ...
   ],
   "files": [
       "app/libraries/function/helper.php"
   ],
},

或者在專案中顯示require這個檔案。開啟app/start/global.php，在末尾增加：

require app_path().'/libraries/function/helper.php';

個人感覺這兩種方式都OK，如果想要控制這個檔案載入的時間，甚至可以在filter.php檔案中增加以下內容

App::before( function( $request ) {
    require( "{$GLOBALS['app']['path.base']}/app/libraries/function/helper.php" );
});
  1. 在專案中直接使用函式v('hello world');

增加稍微複雜的類庫

有的時候一個類庫不僅僅是一個檔案那麼簡單，因此下面的方式更加適合有多個檔案多個結構的類庫。

  1. 建立psr0或者psr4標準的目錄結構。
libraries
    Myapp
        Search (note directory is capitalized)
            Search.php
            SearchFacade.php
            SearchServiceProvider.php
        AnotherLib

Myapp/Search/Search.php中Search類的名稱空間為Myapp\Search。

  1. 修改composer中autoload
"autoload": {
    "classmap": [
        "app/commands",
        "app/controllers",
        "app/models",
        "app/libraries",
        "app/database/migrations",
        "app/database/seeds",
        "app/tests/TestCase.php"
    ]
    ,
    "psr-0": {
         "Myapp": "app/libraries"
    }
},
  1. 在專案中使用new Myapp\Search\Search()來例項化某一類

總結

雖然Laravel沒有強制哪種方式最好，但是有一定的標準可以使得專案結構清晰，多人合作開發時省去很多交流成本。

參考

  1. Adding new classes or library to laravel 4
  2. How to autoload 'libraries' in laravel 4?
  3. What are the best practices and best places for laravel 4 helpers or basic functions?

相關文章