標籤彙整： laravel

programming

Composer進階原理：PHP命名空間與PSR-0

2 則迴響

上次的Composer設計原理與基本用法說明了PHP套件管理的歷史與社群提出的解決之道，本篇文章接著談類別管理的進階議題。

當類別名稱一樣…

當專案大了起來，有時候會有類別名稱重複的問題。
假設今天要撰寫一個論壇模組，提供討論區與留言板功能。
你一定很想將討論區的文章與留言板的文章都命名類別為Article：

// BoardArticle.php


// ForumArticle.php


當然了，這麼做會得到一個結果：


Fatal error: Cannot redeclare class Article



這種問題有一個簡單的解決辦法，就是加上前綴字。

類別分別命名為ForumArticle與BoardArticle就可以了。


Q1: 等一下！這個解法好陽春！我看到至少4個問題：

1. 類別名稱容易變得冗長。

2. 有些類別一開始你以為不會跟人重複，結果之後真的重複了。難道永遠替類別加前綴字？

3. 類別名稱寫Article俐落多了！文章就是概念上的文章，不要逼我告訴你是討論區還是留言板！如果專案用到兩種留言板模組，分別由以前的兩個前輩寫好，難道還要逼我把作者名稱寫進去？




class TonyBoardArticle{
  //...
}
class JackBoardArticle{
  //...
}





4. 如果我在打造框架(framework)呢？幾乎會把所有常見名詞用過一次(像是Request、Loader、Response、Controller、Model等類別)！難道前面全部前綴？

看看Codeigniter的原始碼，全部用CI_當作前綴。超醜的。




命名空間(namespace)登場


於是PHP從5.3版之後支援了命名空間(namespace)。

所以可以用Article替類別定義了：


// BoardArticle.php


// ForumArticle.php


使用類別時只要加上命名空間即可：


//index.php


如果當前的php檔只用到其中一個Article類別，可以指定當前的php檔只用哪個命名空間+類別的組合：




如此一來，當php找不到Article類別時，便會去使用use關鍵字宣告的組合。

當然了，就算用use指定過，原本的宣告方式還是可以用的。(如最下方兩行所示)


當東西多了起來...


OK，可以繼續完成我們的論壇模組了！

討論區跟留言板有各自的文章，再來還需要「推文」：






使用剛剛學到的命名空間去載入他們：




果然是漂亮的各種命名阿！




Q2: include有好多行！上次的Composer設計原理與基本用法提到了Composer可以解決這種問題，當引入命名空間之後，Composer也能發揮作用嗎？




是的。


Composer登場


跟上次初學Composer一樣，建立一個composer.json檔：


{
    "autoload": {
        "files": [
            "ForumArticle.php",
            "ForumComment.php",
            "BoardArticle.php",
            "BoardComment.php"
        ]
    }
}



注意，上次我們用"classmap"指定資料夾、把資料夾內檔案全掃一次，這次我們用"files"分別設定各個檔案。


再來，在terminal輸入


composer install



執行完畢之後，跟上次一樣，只要載入一個檔案：




就可以使用各個類別囉！




Q3: 等一下！看起來跟沒有命名空間的時候差不多啊！一樣是把php檔自動require進去而已？




對啊，你最上面的原始寫法，也只是手動載入好幾個檔案，在載入的時候本來就沒有特別之處：




載入php檔就只是載入，跟命名空間是兩回事。




Q4: 還是不太對啊！上次我用classmap一次把好幾個資料夾內容掃過，這次我用files分別指定每個檔案幹嘛？Composer不是厲害在能指定資料夾去自動掃過？




......你說的沒錯。

開個my_lib資料夾，把4個php檔都丟進去吧。composer.json這樣寫就好了：


{
    "autoload": {
        "classmap": [
            "my_lib"
        ]
    }
}



再來，在terminal輸入


composer install



這樣就搞定了！

其實我只是想示範，除了用classmap設定資料夾之外，也可以用files直接指定檔案。



Q5: OK，原諒你。不過，我必須說，我今天什麼都沒學到。最後還是在composer.json寫classmap而已，跟上次一模一樣。



是的...我剛說了，載入php檔就只是載入，跟命名空間是兩回事。

我今天介紹的namespace功能是PHP本身提供的。而Composer只是協助你載入的工具、當然不可能改變程式語言本身。

Composer只是幫助你少打那一串require而已。




Q6: ㄟ等等...有個地方我覺得很醜。我們現在的my_lib資料夾裏面有4個檔案，檔名很醜：




"ForumArticle.php"
"ForumComment.php"
"BoardArticle.php"
"BoardComment.php"





類別名稱本身都是俐落的Article跟Comment了，檔案名稱還是有前綴字。但也不可能有兩個Article.php、兩個Comment.php。你有沒有辦法解決這個美感問題？




這個問題簡單，把那個my_lib資料夾刪掉，開一個Forum資料夾、一個Board資料夾。本來的ForumArticle.php改成Article.php丟進Forum資料夾、本來的BoardArticle.php改成Article.php丟進Board資料夾。composer.json改寫成這樣：


{
    "autoload": {
        "classmap": [
            "Board",
            "Forum"
        ]
    }
}



再來，在terminal輸入


composer install



這招不錯吧！檔案名稱就是類別名稱，乾淨俐落！

而且資料夾的名字本身就是namespace的名稱！

以後都這樣做啦！一用到命名空間就開個同名資料夾把檔案丟進去！



Q7: 這招我覺得還好耶...。本來檔案都放在my_lib，我在composer.json只要填my_lib一行就好，現在變成要填兩行。要是我這個論壇模組有一大堆類別、用了一大堆命名空間呢？那我classmap底下不就要填入好幾行？那我寧可全部丟進my_lib，只填my_lib一行！




唔，這樣說也是有道理。那重新建立my_lib資料夾，把Board跟Forum資料夾丟進my_lib資料夾。composer.json改回這樣寫：


{
    "autoload": {
        "classmap": [
            "my_lib"
        ]
    }
}



再來，在terminal輸入


composer install



classmap不只是告訴Composer去載入哪幾個資料夾內的檔案，還會把資料夾內的資料夾也全部掃過一次。

怎麼樣，Composer夠神吧。




Q8: 原來classmap底下會遞迴掃描下去...。我決定了，我的Forum跟Board都是在提供線上討論功能，我決定替我這個模組命名為Discussion。我要在my_lib底下開Discussion資料夾，然後把原本的Forum跟Board資料夾都丟進去。你覺得這個想法如何？




還不錯。一個Discussion資料夾就是你的整個Discussion模組。

提供了討論區、留言板功能的Discussion模組，我喜歡。




Q9: 好像忘了什麼...。啊，剛剛說命名空間跟檔案結構符合會最漂亮。那我要把那4個檔案的namespace改成這樣：








剛剛說了，載入檔案就只是載入檔案，跟命名空間無關。

現在檔案結構沒變，所以我應該不用重新輸入composer install。

讓我試試...。

靠！怎麼噴error了！你騙我？




Fatal error: Class 'Discussion\Forum\Comment' not found 



呃...，我前面的說法確實有點誤導。

PHP自動載入的基本函式長這樣：


void __autoload ( string $class )



如你所見，PHP至少需要Composer提供資訊指出$class該去哪個檔案找。

namespace改變之後，PHP會找不到對應的$class在哪。

所以還是輸入一下composer install吧！Composer會把需要的資訊整理好的。




Q10: OKOK，我知道了，我駕馭這一切了。我覺得這個Dicsussion模組真的超屌的，不但命名空間漂亮，連檔案結構都漂亮。我要把這個Discussion資料夾整個丟給我朋友，他們公司最近需要論壇模組。

讓我打電話給他...。

「什麼？你們已經做好半個論壇模組了？你只需要我模組的其中幾個功能？你們的模組也是放在Discussion資料夾？」

糟糕，資料夾名稱重複了！所以我的模組拿給別人還是有不相容的可能，怎麼辦？




沒有錯..還記得你Q1提到的第3個狀況嗎？確實有把作者名稱加進去的必要！

別怕，我教你。你開一個Tony資料夾，把整個Discussion資料夾丟進去。

接著所有檔案namespace改成像這樣：




要用的時候就這樣喔：




是變得有點長啦。

但這下搞定了吧！作者名稱再撞到的話，就改個獨特的名稱就是了！


終於。讓我們談談PSR-0


你一定常聽到PSR-0對吧！

PSR-0是PHP跨框架相容性統一標準組織訂出來的自動載入慣例。


來談談PSR-0幾個最重要的要求吧！


* 命名空間加上類別名稱一定要長這樣： 


\\(\)*



* 前面一定要是作者名稱

* 中間可以有任意層次的命名空間、最後是類別名稱。

* 中間任意層次的命名空間直接對應到檔案結構。


發現了嗎？在剛剛Q1~Q10的過程中，其實你已經把PSR-0學完了，連設計原理都一起搞懂了。


懂這些之後，你也可以做好自己的模組、發佈到Packagist給全世界透過composer下載、使用了！


最後，如果遵守psr-0的話，composer.json可以這樣寫：


{
    "autoload": {
        "psr-0": {
            "Tony\\Discussion\\": "my_lib/"
        }        
    }
}



注意，雙引號、兩次反斜線並沒有特別意思，只是json規定的格式。


跟classmap一樣都可以完成任務。兩者其實是有差別的...，我們下次再談。


結語


Composer工具以及PHP-FIG組織的出現，讓一直以來散落各地的PHP社群開始有集中的趨勢。

換句話說，各社群終於能共享彼此的library了。

然而，如你所見，psr-0不但導致檔案結構容易變得深層，還要求檔案結構必須配合程式碼，這也招致了不少批評。

除此之外，composer autoload內的classmap跟psr-0到底如何分工？效能差異又為何？這些問題也都還在爭論與驗證當中。


不過，PSR-0在各框架已被廣泛支援，因此建議你還是需要有所瞭解。


最後...


現在已經出現psr-0的替代方案，稱為psr-4。


PSR-0從2014-10-21開始被註明為不建議使用。

至於PSR-4..我們下次再談。
programming

Laravel：20分鐘完成Facebook登入功能

發表迴響

要實作Facebook的OAuth 2.0登入流程，最基本的方法是先瞭解OAuth 2.0協定內容，接著到Facebook官網下載程式語言的SDK、註冊應用程式，然後照著官方文件實作。

但如果使用Laravel的話，直接使用社群提供的package就可以囉。本文介紹artdarek/oauth-4-laravel的使用。

首先要下載這個套件。在指令列輸入：

composer require 'artdarek/oauth-4-laravel:dev-master'

自動下載完畢之後，在’app/config/app.php’內加入兩個value：

'providers' => array(
    // ...

    'Artdarek\OAuth\OAuthServiceProvider'
)

'aliases' => array(
    // ...

    'OAuth' => 'Artdarek\OAuth\Facade\OAuth',
)

Laravel就知道去哪找這個套件了。

然後在’app/config/’底下建立’oauth-4-laravel.php’設定檔：

 'Session', 

    /**
     * Consumers
     */
    'consumers' => array(

        /**
         * Facebook
         */
        'Facebook' => array(
            'client_id'     => '',
            'client_secret' => '',
            'scope'         => array(),
        ),      

    )

);

其中的client_id跟client_secret需要跟Facebook取得，請到Facebook Developers註冊一個app：
上面的Apps => Add a New App => Website => 輸入app名稱 => Create New Facebook App ID => 搞定。
把id 跟 secret複製貼上到這邊。
scopte留空陣列，只會跟臉書拿到基本公開資料。如果想要email的話，就在陣列內加入’email’。
關於權限請參考官網：Permissions with Facebook Login

然後在’app/routes.php’加入你希望的route：
(假設你有個負責會員資料的controller稱為MemberController)

Route::get('/auth/facebook', 'MemberController@loginWithFacebook');

在你希望提供facebook登入的頁面加入：

    Login with Facebook

然後到你的MemberController加入這段程式碼：

public function loginWithFacebook() {

    // get data from input
    $code = Input::get( 'code' );

    // get fb service
    $fb = OAuth::consumer( 'Facebook' );

    // check if code is valid

    // if code is provided get user data and sign in
    if ( !empty( $code ) ) {

        // This was a callback request from facebook, get the token
        $token = $fb->requestAccessToken( $code );

        // Send a request with it
        $result = json_decode( $fb->request( '/me' ), true );

        $message = 'Your unique facebook user id is: ' . $result['id'] . ' and your name is ' . $result['name'];
        echo $message. "
";

        //Var_dump
        //display whole array().
        dd($result);

    }
    // if not ask for permission first
    else {
        // get fb authorization
        $url = $fb->getAuthorizationUri();

        // return to facebook login url
         return Redirect::to( (string)$url );
    }

}

大功告成！按下你剛設定的’Login with Facebook’按鈕，你會看到Faecbok要求授權、之後會在你的網站上顯示從Facebook撈到的個資。如何使用這些個資就看您打算如何應用囉。

Q&A

Q: 雖然很神奇，但這從頭到尾黑箱作業。背後到底發生什麼事我都不知道，要我如何敢照做？

問得好。其實，會這麼神奇是因為…

套件管理使用了Composer，所以只要輸入composer require就會自動下載完畢。不放心的話請到Composer官網逛逛，或是閱讀我之前寫的Composer設計原理與基本用法。

除此之外，一般來說載好第3方套件之後，通常你至少需要初始化這個第3方類別、接著設定幾個值之類的：

$coolLibrary = new ThirdPartyLibrary();
$coolLibrary->setParameter($paramater)

但是Laravel提供Service Provider功能，讓package的初始化在Service Provider內完成，然後Laravel又提供Facades功能，讓你可以使用類別靜態函式去操作某個實體。
結果就是你只需要寫這行：

 $fb = OAuth::consumer( 'Facebook' );

你就可以用這$fb變數去進行各種操作…驗證、發送API request、等等。
當然這種靜態函式包裝某個實體的作法，有些人不喜歡、認為這反OOP。參見：讓你少打很多字：Facades。

programming

Laravel確保資料庫正確：transaction與lock

發表迴響

最近在開發上碰到一個request要執行的任務比較多、後面的任務牽扯到第3方API因此有可能fail，此時前面執行的任務需要將資料回溯的問題。

另外還碰到race condition的資料庫資料同步問題：當兩個使用者同時按下某個按鈕時，資料庫的資料會出現問題。

前者需要利用資料庫的transaction功能確保任務全執行或是全不執行、後者需要用到lock/unlock將某些資料表鎖住不讓其他程序修改。

在Laravel中，該怎麼做呢？查了一下，大概整理出來。

Transaction

有兩種作法，第1種使用closure：

DB::transaction(function()
 {
      // do something
 });

第2種也許比較親切，

try {
    DB::connection()->getPdo()->beginTransaction();
    // database queries here
    DB::connection()->getPdo()->commit();
} catch (\PDOException $e) {
    // Woopsy
    DB::connection()->getPdo()->rollBack();
}

在Laravel facades的協助下，這兩種作法都滿簡潔有力的。
要注意的是，在第1種情況下，若是closure要使用到執行closure之前定義的變數，記得使用關鍵字「use」：

DB::transaction(function() use ($user_id)
{
    // do something with $user_id
});

Lock

要保證一次只有一個程序在修改某幾張資料表，以Mysql來說有LOCK跟UNLOCK可以用。Laravel並沒有直接支援此功能，不過這樣變通就可以了：

DB::connection()->getPdo()->exec( 'LOCK TABLES items WRITE, accounts WRITE, orders WRITE' );
// blah blah
DB::connection()->getPdo()->exec( 'UNLOCK TABLES' );

這邊一次用WRTIE LOCK鎖住三張資料表。當然也有READ LOCK可以使用。