文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

laravel中api路由auth:api和api_token的示例分析

2023-06-14 22:58

关注

小编给大家分享一下laravel中api路由auth:api和api_token的示例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!

Laravel 是什么

Laravel 是一套简洁、优雅的PHP Web开发框架。它可以让你从面条一样杂乱的代码中解脱出来;它可以帮你构建一个完美的网络APP,而且每行代码都可以简洁、富于表达力。

这个东西(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')->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,  那么:

以上是“laravel中api路由auth:api和api_token的示例分析”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注编程网行业资讯频道!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯