laravel5.5入门(dingo+jwt)

SilentVoidCan

已于 2024-09-13 16:36:39 修改

阅读量717

点赞数 10

分类专栏： php 文章标签： php laravel

于 2024-09-13 14:53:50 首次发布

本文链接：https://blog.csdn.net/SilentVoidCan/article/details/142208930

版权

php 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

首先我们确保本机已经配置好PHP和mysql。

一、创建项目

composer create-project --prefer-dist laravel/laravel hello "5.5.*"

所有问题默认回答y，等待命令执行完毕。laravel的脚手架确实还是非常好用，这样一个新的项目就已经创建完毕了，可以直接运行查看。

cd hello
php artisan serve

正常的话我们就可以在浏览器输入http://127.0.0.1:8000看到Laravel样式的输出。

二、VUE2环境配置

首先需要确保本机安装好了node.js，我这里用的是nvm来管理的，安装的版本是15.14.0

因为laravel内置的依赖有些过时，我们需要对package.json做一些调整，如下：

（注意：后续的操作将在phpstorm中进行）

"devDependencies": {
        "axios": "0.17",
        "bootstrap-sass": "3.3.7",
        "cross-env": "5.1",
        "jquery": "3.2",
        "laravel-mix": "5.0.9",
        "lodash": "4.17.4",
        "node-sass": "^5.0.0",
        "resolve-url-loader": "^3.1.0",
        "sass": "^1.78.0",
        "sass-loader": "10.0.5",
        "vue": "2.7.16",
        "vue-template-compiler": "^2.7.16"
    }

配置好后执行下面的命令安装依赖：

npm install

注意：这里npm安装可能不成功，可以考虑换cnpm或者设置代理，具体怎么操作请自行百度。

三、测试VUE2

因为VUE2版本的问题laravel自带的示例不能直接编译通过的，这里我们需要修改三个文件，如下图所示：

welcome.blade.php内容如下：

<!doctype html>
<html lang="{{ app()->getLocale() }}">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>Laravel</title>
        <!-- Fonts -->
        <link href="https://fonts.googleapis.com/css?family=Raleway:100,600" rel="stylesheet" type="text/css">
    </head>
    <body>
        <div id="app">
        </div>
    </body>
    <script src="{{ mix('js/app.js') }}"></script>
</html>

app.js内容如下：

require('./bootstrap');

window.Vue = require('vue');
import Hello from './components/Hello.vue'; // 引入Hello 组件

const app = new Vue({
    el: '#app',
    render: h => h(Hello)
});

Hello.vue内容如下：

<template>
  <div>
    <h1>Hello, Laravel</h1>
    <p class="hello">{{ msg }}</p>
  </div>
</template>

<script>
export default {
  data() {
    return {
      msg: '欢迎使用vue2.0！'
    }
  }
}
</script>

<style>
.hello {
  font-size: 2em;
  color: green;
}
</style>

然后在项目目录执行如下命令：

npm run dev

编译通过后我们可以再次启动网站，命令如下：

php artisan serve

打开浏览器输入：http://127.0.0.1:8000，正常应该会得到如下的页面显示：

四、配置config/app.php

这里我们仅仅简单调整一下时区和语言配置

'timezone' => 'Asia/Shanghai',
    'locale' => 'zh-CN',
    'faker_locale' => 'zh_CN',

配置生效：

php artisan config:clear

五、创建自己的路由

5.1、创建控制器

在项目目录下执行命令：

php artisan make:controller Home/IndexController

修改IndexController.php内容如下：

<?php

namespace App\Http\Controllers\Home;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class IndexController extends Controller
{
    public function index()
    {
        return 'ok';
    }
}

5.2、路由配置

在routes/web.php中添加到index()方法的路由：

<?php

Route::get('/', function () {
    return view('welcome');
});

Route::get('/home', 'Home\IndexController@index')->name('home');

再次运行网站：

php artisan serve

在浏览器中输入：http://127.0.0.1:8000/home

六、dingo+jwt依赖安装及配置

6.1、升级依赖

修改composer.json添加相关依赖，最终的文件内容如下：

{
    "name": "laravel/laravel",
    "description": "The Laravel Framework.",
    "keywords": ["framework", "laravel"],
    "license": "MIT",
    "type": "project",
    "require": {
        "php": ">=7.0.0",
        "fideloper/proxy": "~3.3",
        "laravel/framework": "5.5.*",
        "laravel/tinker": "~1.0",
        "dingo/api": "2.4.7",
        "tymon/jwt-auth": "1.0.2"
    },
    "require-dev": {
        "filp/whoops": "~2.0",
        "fzaninotto/faker": "~1.4",
        "mockery/mockery": "~1.0",
        "phpunit/phpunit": "~6.0",
        "symfony/thanks": "^1.0"
    },
    "autoload": {
        "classmap": [
            "database/seeds",
            "database/factories"
        ],
        "psr-4": {
            "App\\": "app/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Tests\\": "tests/"
        }
    },
    "extra": {
        "laravel": {
            "dont-discover": [
            ]
        }
    },
    "scripts": {
        "post-root-package-install": [
            "@php -r \"file_exists('.env') || copy('.env.example', '.env');\""
        ],
        "post-create-project-cmd": [
            "@php artisan key:generate"
        ],
        "post-autoload-dump": [
            "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
            "@php artisan package:discover"
        ]
    },
    "config": {
        "preferred-install": "dist",
        "sort-packages": true,
        "optimize-autoloader": true,
        "allow-plugins": {
            "kylekatarnls/update-helper": true,
            "symfony/thanks": true
        }
    }
}

添加的部分内容如下：

"dingo/api": "2.4.7",
"tymon/jwt-auth": "1.0.2"

安装dingo/api的时候会需要访问github得到token，申请的网址为：https://github.com/settings/tokens

如果不想申请也可以考虑把这个依赖降级为2.2.3。

配置完成后我们升级一下依赖：

composer update

6.2、配置config/app.php

找到providers配置，在数组最后添加如下内容：

Dingo\Api\Provider\LaravelServiceProvider::class,
Tymon\JWTAuth\Providers\LaravelServiceProvider::class,

找到aliases配置，在数组最后添加如下内容：

'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
'JWTFactory' => Tymon\JWTAuth\Facades\JWTFactory::class,

6.3、发布配置文件

生成config/api.php

php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"

生成config/jwt.php

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

6.4、生成 JWT_SECRET

php artisan jwt:secret

6.5、配置config/api.php

auth部分添加下面的代码(数组中)：

'jwt' => Dingo\Api\Auth\Provider\JWT::class

6.6、环境变量（.env文件）配置dingo

# 环境
API_STANDARDS_TREE=vnd
# 子类型
API_SUBTYPE=hello
# 前缀
API_PREFIX=api
# 子域名  （前缀和子域名只能存在一个）可选，不用就必须注释掉
#API_DOMAIN=localhost
# 版本
API_VERSION=v1
# 名字（使用API Blueprint命令才会用到）
API_NAME='HelloApi'
# 带条件的请求
API_CONDITIONAL_REQUEST=false
# Strict模式
API_STRICT=false
# 响应格式
API_DEFAULT_FORMAT=json
# 调试模式
API_DEBUG=true

七、数据库准备

7.1、建库

在mysql数据库中建立laravel5数据库：

create database if not exists laravel5 default character set utf8mb4 default collate utf8mb4_general_ci;

7.2、数据库连接配置(.env文件)

请根据实际情况来配置：

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3326
DB_DATABASE=laravel5
DB_USERNAME=root
DB_PASSWORD=yujsh123456

7.3、生成数据库

执行命令如下：

php artisan migrate

最后查看数据库创建情况：

八、API权限示例

8.1、创建AuthController

php artisan make:controller Home/AuthController

具体代码如下：

<?php

namespace App\Http\Controllers\Home;

use App\Http\Controllers\Controller;
use Dingo\Api\Routing\Helpers;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Log;
use App\User;

class AuthController extends Controller
{
    use Helpers;

    protected $guard = 'api';
    public function __construct()
    {
        $this->middleware('auth:api', ['except' => ['login','register']]);
    }

    public function test(){
        echo "test!!";
    }

    public function register(Request $request)
    {
        $payload = $request->only('name', 'email', 'password');
//        Log::info($payload);
        $result = User::create([
            'name' => $payload['name'],
            'email' => $payload['email'],
            'password' => bcrypt($payload['password']),
        ]);
        if ($result) {
            return $this->response->array(['success' => '创建用户成功']);
        } else {
            return $this->response->array(['error' => '创建用户失败']);
        }
    }

    public function login(Request $request)
    {
        $credentials = $request->only('email', 'password');
        if ($token = $this->guard()->attempt($credentials)) {
            return $this->respondWithToken($token);
        }
        return $this->response->errorUnauthorized('登录失败');
    }

    public function me()
    {
        return $this->response->array($this->guard()->user());
    }

    public function logout()
    {
        $this->guard()->logout();
        return $this->response->array(['message' => '退出成功']);
    }

    public function refresh()
    {
        return $this->respondWithToken($this->guard()->refresh());
    }

    protected function respondWithToken($token)
    {
        return response()->json([
            'access_token' => $token,
            'token_type' => 'bearer',
            'expires_in' => $this->guard()->factory()->getTTL() * 60
        ]);
    }

    public function guard()
    {
        return Auth::guard($this->guard);
    }
}

8.2、调整app/User.php

我们需要增加对jwt的支持，具体调整后的代码如下：

<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Tymon\JWTAuth\Contracts\JWTSubject;

class User extends Authenticatable implements JWTSubject
{
    use Notifiable;
    protected $fillable = [
        'name', 'email', 'password',
    ];
    protected $hidden = [
        'password', 'remember_token',
    ];

    public function getJWTIdentifier()
    {
        return $this->getKey();
    }

    public function getJWTCustomClaims()
    {
        return [];
    }
}

8.3、配置config/auth.php

<?php

return [
    'defaults' => [
        'guard' => 'api',
        'passwords' => 'users',
    ],
    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],

        'api' => [
            'driver' => 'jwt',
            'provider' => 'users',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\User::class,
        ],
    ],
    'passwords' => [
        'users' => [
            'provider' => 'users',
            'table' => 'password_resets',
            'expire' => 60,
        ],
    ],

];

8.4、配置路由（routes/api.php）

<?php
use Illuminate\Support\Facades\Log;
//接管路由
$api = app('Dingo\Api\Routing\Router');

Auth::routes();

app('Dingo\Api\Exception\Handler')->register(function (Illuminate\Validation\ValidationException $exception) {
    $errors = array_values($exception->errors());
    app('Dingo\Api\Exception\Handler')->setErrorFormat([
        'message' => $errors[0][0],
        'code' => ':code',
        'status_code' => ':status_code',
        'debug' => ':debug'
    ]);

});

app('Dingo\Api\Exception\Handler')->setErrorFormat([
    'message' => ':message',
    'errors' => ':errors',
    'code' => ':code',
    'status_code' => ':status_code',
    'debug' => ':debug'
]);

app('Dingo\Api\Exception\Handler')->register(function (Illuminate\Auth\AuthenticationException $exception) {
    return Response::make(['message' => trans('auth.user_not_logged_in'), 'status_code' => 401], 401);
});

app('Dingo\Api\Exception\Handler')->register(function (Symfony\Component\HttpKernel\Exception\NotFoundHttpException $exception) {
//    Log::info($exception);
    return Response::make(['message' => trans('exception.data_not_exist'), 'status_code' => 404], 404);
});

$api->version('v1',['namespace'=>'App\Http\Controllers\Home'], function ($api) {
    $api->group(['prefix'=>'auth'],function ($api){
        $api->get('test', 'AuthController@test');
        $api->post('register', 'AuthController@register');
        $api->post('login', 'AuthController@login');
        $api->post('logout', 'AuthController@logout');
        $api->post('refresh', 'AuthController@refresh');
        $api->post('me', 'AuthController@me');
    });

});