djangorestframework-simplejwt入门教程

系统管理员 2023-01-21 05:24 63阅读 0赞

# djangorestframework-simplejwt入门教程 #

### 文章目录 ###

*  djangorestframework-simplejwt入门教程
 *   *  环境说明
     *  安装
     *  配置settings.py
     *   *  在 \`INSTALLED\_APPS\` 中注册
         *  配置 \`DRF\`
         *  配置 \`simplejwt\`
     *  编写路由 urls.py
     *  创建数据库并添加用户
     *  运行项目并查看效果
     *   *  获取Token
         *  验证Token
         *  刷新Token
     *  Postman请求方式
     *   *  获取Token
         *  自定义的视图
     *  开始新的征程

## 环境说明 ##

<table> 
 <thead> 
  <tr> 
   <th>环境</th> 
   <th>版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Python</td> 
   <td>3.6.8</td> 
  </tr> 
  <tr> 
   <td>Django</td> 
   <td>3.1</td> 
  </tr> 
  <tr> 
   <td>djangorestframework （DRF）</td> 
   <td>3.12.4</td> 
  </tr> 
  <tr> 
   <td>djangorestframework-simplejwt</td> 
   <td>4.4.0</td> 
  </tr> 
 </tbody> 
</table>

**注意：是`djangorestframework-simplejwt`不是`djangorestframework-jwt`，后者已停止维护。**

> 约定：
> 
>  *  `djangorestframework` 本文后续统一称为： `DRF`
>  *  `djangorestframework-simplejwt`本文后续统一称为`simplejwt`

## 安装 ##

`simplejwt`是 `DRF`的插件，所以安装之前需要先安装`DRF`

pip install djangorestframework
    pip install markdown
    pip install django-filter
    
    # 下面安装 simplejwt
    pip install  djangorestframework-simplejwt

## 配置settings.py ##

### 在 `INSTALLED_APPS` 中注册 ###

INSTALLED_APPS = [
        'django.contrib.admin',
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',
        # 自己的应用
    	...
        'rest_framework',  # 注册DRF应用
    ]

### 配置 `DRF` ###

REST_FRAMEWORK = {
        
        'DEFAULT_AUTHENTICATION_CLASSES': [
            'rest_framework_simplejwt.authentication.JWTAuthentication',  # 使用rest_framework_simplejwt验证身份
            'rest_framework.authentication.SessionAuthentication',
            'rest_framework.authentication.BasicAuthentication'
        ],
        'DEFAULT_PERMISSION_CLASSES': [
            'rest_framework.permissions.IsAuthenticated'    # 默认权限为验证用户
        ],
    }

### 配置 `simplejwt` ###

# simplejwt配置， 需要导入datetime模块
    SIMPLE_JWT = {
        
        # token有效时长
        'ACCESS_TOKEN_LIFETIME': datetime.timedelta(minutes=30),
        # token刷新后的有效时间
        'REFRESH_TOKEN_LIFETIME': datetime.timedelta(days=1),
    }

## 编写路由 urls.py ##

这里直接编写项目下的根路由文件

from django.contrib import admin
    from django.urls import path, include
    
    # 导入 simplejwt 提供的几个验证视图类
    from rest_framework_simplejwt.views import (
        TokenObtainPairView,
        TokenRefreshView,
        TokenVerifyView
    )
    
    urlpatterns = [
        # Django 后台
        path('admin/', admin.site.urls),
        # DRF 提供的一系列身份认证的接口，用于在页面中认证身份，详情查阅DRF文档
        path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
        # 获取Token的接口
        path('api/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'),
        # 刷新Token有效期的接口
        path('api/refresh/', TokenRefreshView.as_view(), name='token_refresh'),
        # 验证Token的有效性
        path('api/token/verify/', TokenVerifyView.as_view(), name='token_verify'),
    ]

## 创建数据库并添加用户 ##

1.  执行模型变更命令初始化数据库

python manage.py migrate

1.  添加用户，直接生成超级用户

python manage.py createsuperuser

然后按照步骤输入邮箱用户名和密码就可以了

## 运行项目并查看效果 ##

浏览器打开`http://127.0.0.1:8000/`应该就能看到URL提示了，下面进入刚刚配置的url查看一下效果

### 获取Token ###

进入 `http://127.0.0.1:8000/api/token/`， 一切正常的话应该会看到`DRF`提供的页面，提示`GET方法不被允许`，并且下面有用户名和密码的输入框。

\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ygPU8R5j-1620982718776)(C:\\Users\\Administrator\\AppData\\Roaming\\Typora\\typora-user-images\\image-20210514154143145.png)\]

在输入库中输入刚刚创建的用户信息就能得到系统返回的信息了。返回的信息包括`refresh`和`access`两个字段。其中`refresh`是用于`刷新token`的（每个Token都是有时间限制的，过了时间就生效了），`access`是用于后续的请求时验证身份的。

![671071e702bb0e26e606e294e36fd387.png][]

### 验证Token ###

进入`http://127.0.0.1:8000/api/token/verify/`, 下面提示输入`Token`， 输入刚刚过去到的`access`的值，验证成功。注意，验证成功没有提示信息反悔，只有一个200的响应码

![c72dca4451bc2bbbf2edd36ae975b8a1.png][]

如果验证失败，则响应码为401，且下方有提示信息

![2b52939a492094319a9b423e0696bf5d.png][]

### 刷新Token ###

进入 `http://127.0.0.1:8000/api/refresh/`，下面提示填写`refresh`，在里面填写上面获取到的`refresh`值，如果填写的正确，则会获取到新的`Token`，否则会提示验证失败

![d2f92879a2c1b93ac1971d1151aa14a7.png][]

## Postman请求方式 ##

上面的操作都是在`DRF`提供的页面里面进行的，实际使用的时候都是Ajax请求，下面讲解使用`Postman`进行请求的方法，以`获取Token`和自定义的视图

### 获取Token ###

在Postman中正常填写请求信息即可， 获取Token、刷新Token和验证Token都是直接填写即可

![b10a7841465322195826747ee2de71be.png][]

### 自定义的视图 ###

上面的三个Token相关的接口是插件提供的，内部已经做了配置，免身份认证，但是我们自己的接口是需要做身份校验的。我们先创建一个自定义的视图，然后在路由中注册。为了便于演示，这里直接在`urls.py`中创建视图，之后，我们完整的`urls.py`文件如下

from django.contrib import admin
    from django.urls import path, include
    
    from rest_framework.views import APIView, Response
    # 导入 simplejwt 提供的几个验证视图类
    from rest_framework_simplejwt.views import (
        TokenObtainPairView,
        TokenRefreshView,
        TokenVerifyView
    )
    
    
    # 创建一个自定义的视图，仅实现get方法做测试
    class IndexView(APIView):
        def get(self, request):
            return Response('This is Index Page!', status=200)
    
    
    urlpatterns = [
        path('admin/', admin.site.urls),
        # DRF 提供的一系列身份认证的接口，用于在页面中认证身份，详情查阅DRF文档
        path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
        # 获取Token的接口
        path('api/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'),
        # 刷新Token有效期的接口
        path('api/refresh/', TokenRefreshView.as_view(), name='token_refresh'),
        # 验证Token的有效性
        path('api/token/verify/', TokenVerifyView.as_view(), name='token_verify'),
        # 自定义视图
        path('index/', IndexView.as_view(), name='index')
    ]

> 这里为了省事将视图写在了`urls.py`里面，实际开发请单独建立`views.py`，保持良好的代码风格

此时，我们使用Postman执行`GET`请求访问自定义接口为得到提示信息， 这就是在提示我们需要传递`Token`给后台认证了

![ab776ff4a24572e10035f5a0e7a04e82.png][]

`simplejwt`的身份认证方式为：在请求的`Headers`里面里面添加设置参数，名称为：`Authorization`, 值是一个固定组成的字符串： `Bearer` \+`空格` \+ `access`， 例如：`Bearer [token值]`。 正确的效果如下

![9d65c3f03e081050a62f90dd5bc4a781.png][]

## 开始新的征程 ##

本文主要讲述了`djangorestframework-simplejwt`的使用入门，这里还有很多问题：

1.  怎么将提示信息改为中文？
2.  如何往获取Token的接口中添加自定义的响应数据，比如用户名，头像，权限码？
3.  如何往`playload`中添加自定义的信息，比如用户手机号码？
4.  怎么获取`playload`里面的信息？
5.  注册接口不需要身份验证怎么跳过验证？

这些问题，下一篇带你解锁~

[671071e702bb0e26e606e294e36fd387.png]: /images/20221020/479b88b09c9841e78145027579c3c749.png
[c72dca4451bc2bbbf2edd36ae975b8a1.png]: /images/20221020/bb5109193f95412b9e564d8e4f30841a.png
[2b52939a492094319a9b423e0696bf5d.png]: /images/20221020/be04f3d5a1e84c288d383697cf6c41ff.png
[d2f92879a2c1b93ac1971d1151aa14a7.png]: /images/20221020/7300fff8face400180103b3c8a9f3bdb.png
[b10a7841465322195826747ee2de71be.png]: /images/20221020/11b3618b750545679f6f118f2e1bb109.png
[ab776ff4a24572e10035f5a0e7a04e82.png]: /images/20221020/873903ff408d47b2a7b12295ea7fd8c2.png
[9d65c3f03e081050a62f90dd5bc4a781.png]: /images/20221020/d0721bbd449346a2b17773c9db4637e5.png