>  기사  >  PHP 프레임워크  >  laravel에서 api 라우팅의 auth:api 및 api_token 작업 중

laravel에서 api 라우팅의 auth:api 및 api_token 작업 중

藏色散人
藏色散人앞으로
2021-04-30 09:23:052223검색

다음 laravel 튜토리얼 칼럼에서는 laravel의 api 라우팅에 대한 auth:api와 api_token을 소개하겠습니다. 도움이 필요한 친구들에게 도움이 되길 바랍니다!

laravel에서 api 라우팅의 auth:api와 api_token을 작업해 보겠습니다

저도 요즘 이것저것 고민하다가 정보를 찾다가 이 문제를 발견했습니다. 그런데 파헤쳐보겠습니다. 앞으로 누군가가 질문하지 않도록 하기 위한 과정입니다. 왜, 오랫동안 검색해도 중국어 정보가 하나도 나오지 않았습니다. 마치 개인 노트와 같고 별로 건조하지도 않습니다.

질문 주소:
https ://segmentfault.com/q/1010000008388170/a-1020000009910771

이 토큰 기반 인증은 5.2에 나타났습니다. 그럼 시작해 보겠습니다.

먼저 /config/의 <code>guards 필드를 살펴보세요. auth: /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')->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路由来测试了.

之后你可以看看官网的 passportrrreee

위의 두 Guard의 경우 {project}/vendor/laravel/framework/src/Illuminate/Auth/SessionGuard.php{project 경로에 있습니다. }/vendor/laravel/framework/src/ Illuminate/Auth/TokenGuard.php에서 볼 수 있습니다.
TokenGuard에서 user() 메소드를 볼 수 있습니다. code>Auth::user() 사용자가 반환되고 이 메서드가 호출됩니다.

그런 다음 {project}/vendor/laravel/framework/src/Illuminate/Auth/AuthManager를 살펴보세요. Auth::guard('api')->check() 또는 와 같은 코드가 실행될 때 호출되는 <code>guard 메서드가 포함된 php >Auth::check()는 무엇을 하는지 rrreee그럼 resolve가 무엇을 하는지 볼까요

rrreee
getConfig의 첫 번째 단계 :
rrreee🎜처음에 언급된 것을 찾으세요 config/auth의 구성 항목 예를 들어 api에서 얻는 것은 구성 항목을 얻은 후 🎜rrreee🎜입니다. , resolve에서 계속 🎜rrreee🎜 해당 이름의 사용자 정의 드라이버가 있으면 호출합니다(기본 2개 이전입니다). 내장 드라이버가 있으면 해당 를 호출합니다. createXXXXXDriver 메서드를 $name$config에 전달합니다.🎜🎜그런 다음 계속 읽으세요.🎜rrreee🎜여기의 사용자가 반드시 생성되지 않을 수도 있습니다. 다른 곳에 있을 수도 있지만 laravel 여기의 공급자는 기본적으로 EloquentUserProvider이므로 데이터베이스 테이블에서만 찾을 수 있습니다.🎜TokenGuard를 인스턴스화했습니다.🎜rrreee 🎜기존 사용자가 있다면 getTokenForRequest를 사용해 만들어 보겠습니다.🎜rrreee🎜기본적으로 요청의 $this->inputKey 필드를 처리합니다.🎜이것입니다. 속성은 생성자에서 기본값으로 설정되어 있습니다. $this->inputKey = 'api_token'.🎜즉, API 요청에 🎜rrreee🎜🎜🎜다음과 같은 내용이 있어야 합니다. 찾을 수 없습니다. 🎜🎜이제 결론은 매우 간단합니다. laravel의 자체 auth:api를 사용하여 API를 작성하려는 경우 span>이면 다음과 같습니다. 🎜
  • 인증이 필요한 게시물이나 API 요청에는 api_token 필드가 있어야 합니다.
  • 🎜사용자 테이블 api_token, bcrypt 무엇이든 필드가 있어야 합니다.🎜
  • 🎜그런 다음 routes/api에서 테스트할 API 경로를 여러 개 작성할 수 있습니다.🎜
🎜그 후 공식 홈페이지에서 passport 문서를 살펴보실 수 있습니다.🎜🎜🎜🎜🎜관련 추천: 🎜라라벨 최신 5개 비디오 튜토리얼🎜🎜🎜🎜

위 내용은 laravel에서 api 라우팅의 auth:api 및 api_token 작업 중의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
이 기사는 segmentfault.com에서 복제됩니다. 침해가 있는 경우 admin@php.cn으로 문의하시기 바랍니다. 삭제