首頁  >  文章  >  php框架  >  去搞laravel裡api路由的auth:api和api_token

去搞laravel裡api路由的auth:api和api_token

藏色散人
藏色散人轉載
2021-04-30 09:23:052249瀏覽

下面由laravel教學專欄來介紹laravel裡api路由的 auth:api 和 api_token,希望對需要的朋友有幫助!

搞一搞laravel裡api路由的auth:api 和api_token

我這幾天正好在琢磨這個東西, 找資料的時候也找到了這個問題. 順帶寫一下挖的過程, 省得以後有人想問個為啥, 卻搜半天搜不到點中文資料. 就是怕像個人筆記,不太乾.

問題的地址:
https://segmentfault.com/q/1010000008388170/a-1020000009910771

這個東西(token based authentication )是在5.2中出現的.那麼下面開始:

首先看 /config/auth 中的guards 字段:

  'guards' => [
      'web' => [
          'driver' => 'session',
          'provider' => 'users',
      ],
  
      'api' => [
          'driver' => 'token',
          'provider' => 'users',
      ],
  ]

對於上面兩個東西(guards), 在路徑{project}/vendor/laravel/framework/src /Illuminate/Auth/SessionGuard.php{project}/vendor/laravel/framework/src/Illuminate/Auth/TokenGuard.php 裡面可以看到.

在TokenGuard裡面可以看到user() 方法, 例如Auth::user() 會回傳一個使用者, 呼叫的就是這個方法.

然後看 {project}/vendor/laravel/framework/src/Illuminate/Auth/AuthManager.php, 這個裡面的guard 方法, 就是Auth::guard('api')-&gt ;check()Auth::check() 之類的程式碼執行時候會呼叫的方法. 它乾了什麼呢

  public function guard($name = null)
  {
      //这里就是没有提供名字,就默认用web
      $name = $name ?: $this->getDefaultDriver();
      //然后如果已经有这个guard,就返回; 没有的话,就resolve这个名字
      return isset($this->guards[$name])
                  ? $this->guards[$name]
                  : $this->guards[$name] = $this->resolve($name);
  }

那麼接著看resolve 做了什麼

    protected function resolve($name)
    {
        $config = $this->getConfig($name);

        if (is_null($config)) {
            throw new InvalidArgumentException("Auth guard [{$name}] is not defined.");
        }

        if (isset($this->customCreators[$config['driver']])) {
            return $this->callCustomCreator($name, $config);
        }

        $driverMethod = 'create'.ucfirst($config['driver']).'Driver';

        if (method_exists($this, $driverMethod)) {
            return $this->{$driverMethod}($name, $config);
        }

        throw new InvalidArgumentException("Auth guard driver [{$name}] is not defined.");
    }

第一步的getConfig :

    protected function getConfig($name)
    {
        return $this->app['config']["auth.guards.{$name}"];
    }

去找開頭提到的config/auth 裡面的配置項目. 例如api 得到的就是

      [
          'driver' => 'token',
          'provider' => 'users',
      ],

搞到設定項以後, 在resolve 裡面繼續

    $driverMethod = 'create'.ucfirst($config['driver']).'Driver';

    if (method_exists($this, $driverMethod)) {
        return $this->{$driverMethod}($name, $config);
    }

如果有對應名字的custom的driver,呼叫, (這個在預設的兩個之前)
如果存在自帶的Driver的話, 呼叫對應的createXXXXXDriver 方法. 傳進去$name $config.

那麼繼續看:

public function createTokenDriver($name, $config)
    {
        // The token guard implements a basic API token based guard implementation
        // that takes an API token field from the request and matches it to the
        // user in the database or another persistence layer where users are.
        $guard = new TokenGuard(
            $this->createUserProvider($config['provider']),
            $this->app['request']
        );

        $this->app->refresh('request', $guard, 'setRequest');

        return $guard;
    }

注意這裡用戶未必一定是資料庫裡面搞出來的. 也可能是別的地方, 然而要看你的provider. laravel這裡的provider 預設是EloquentUserProvider, 那顯然呵呵了, 你只能從資料庫表裡面找.
實例化了一個TokenGuard :

public function user()
    {
        if (! is_null($this->user)) {
            return $this->user;
        }

        $user = null;

        $token = $this->getTokenForRequest();

        if (! empty($token)) {
            $user = $this->provider->retrieveByCredentials(
                [$this->storageKey => $token]
            );
        }

        return $this->user = $user;
    }

如果麼有已經存在的用戶,就用getTokenForRequest 來搞一個.

    public function getTokenForRequest()
    {
        $token = $this->request->query($this->inputKey);
        
        if (empty($token)) {
            $token = $this->request->input($this->inputKey);
        }

        if (empty($token)) {
            $token = $this->request->bearerToken();
        }

        if (empty($token)) {
            $token = $this->request->getPassword();
        }

        return $token;
    }

基本上都是在搞request裡面的$this->inputKey 字段. 劃重點.
這個屬性在建構器裡面預設了: $this->inputKey = 'api_token'.
也就是你的api request 裡面, 應該是有一個

[
  api_token => '  一堆随便什么字符串OUVjkknag89s8c987235iohiscovy89q235 '
]

這樣的東西

我確實沒在文檔裡找見.

那麼現在結論反而很簡單, 如果你想用laravel 自帶的auth:api來寫API,  那麼:

  • 你的post或任何需要驗證的api請求, 都應該有一個api_token的欄位.
  • 你的使用者表裡面應該有個欄位api_token, 隨便什麼東西bcrypt一下.

  • #然後你routes/api 下面就可以寫一堆api路由來測試了.

之後你可以看看官網的passport 文檔之類的.

以上是去搞laravel裡api路由的auth:api和api_token的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文轉載於:segmentfault.com。如有侵權,請聯絡admin@php.cn刪除