JWT安装配置

目录

• 1.JWT安装配置
  • 1.1安装JWT
  • 1.2syl/settings.py配置JWT载荷中有效期设置
  • 1.3 syl/settings.pyJWT结合DRF进行认证权限配置
  • 1.4 user/urls.py增加获取token接口和刷新token接口
  • 1.5在user.utils.py中重写jwt_response_payload_handler
• 2.postman测试接口
  • 2.1测试登录接口，获取token
  • 2.2使用获取的token获取所有用户信息

1.JWT安装配置

1.登录接口 
2.刷新接口 
3.自定义返回格式

1.1安装JWT

pip install djangorestframework-jwt==1.11.0

1.2syl/settings.py配置JWT载荷中有效期设置

# jwt载荷中的有效期设置
JWT_AUTH = {
    # 1.token前缀：headers中Authorization值的前缀
    'JWT_AUTH_HEADER_PREFIX': 'jwt',
    # 2.token有效期：一天有效
    'JWT_EXPIRATION_DEFRESH',
    # 3.刷新token：允许使用旧的token换新的token
    'JWT_ALLOW_REFRESH': True,
    # 4.token有效期：token在24小时内过期，可续期token
    'JWT_REFRESH_EXPIRATION_DELTA': datetime.timedalta(hours=24),
    # 5.自定义JWT载荷信息：自定义返回格式，需要手工创建
    'JWT_RESPONSE_PAYLOAD_HANDLER': 'user.utils.jwt_response_payload_handler',
}

1.3 syl/settings.pyJWT结合DRF进行认证权限配置

# 在DRF配置文件中开启认证和权限
REST_FRAMEWORK = {
    ...
    # 用户登录认证方式
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework_jwt.authentication.JSONNWebTokenAuthentication',  # 在DRF中配置JWT认证
        #  'rest_framework.authentication.SessionAuthentication', # 使用session时 的认证器 
        # 'rest_framework.authentication.BasicAuthentication' # 提交表单时的认 证器
    ],
    # 权限配置，顺序靠上的严格
    'DEFAULT_PERMISSION_CLASSES': [
        # 'rest_framework.permissions.IsAdminUser',  # 管理员可以访问
        'rest_framework.permissions.IsAuthenticated',  # 全局配置只有认证用户可以访问接口
        # 'rest_framework.permissions.IsAuthenticatedOrReadOnly',  # 认证用户可以访问，否则只能读取
        # 'rest_framework.permissions.AllowAny',  # 所有用户都可以访问
    ]
    ...
}

1.4 user/urls.py增加获取token接口和刷新token接口

from django.urls import include, path
from rest_framework.authtoken.views import obtain_auth_token
from user import views
from rest_framwork.routers import SimpleRouter, DefaultRouter
from rest_framwork_jwt.views import obtain_jwt_token, refresh_jwt_token

# 自动生成路由方法，必须使用视图集
# router = SimpleRouter()  # 没有根路由 /user/ 无法识别 
router = DefaultRouter() # 有根路由 
router.register(r'user', views.UserViewSet)

urlpatterns = [
    path("index/", views.index), # 视图函数
    path("login/", obtain_jwt_token),  # 获取token，登录试图
    path("refresh/", refresh_jwt_token),  # 刷新token
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),  # 认证地址
]

urlpatterns += router.urls  # 模块地址
# print(router.urls)

1.5在user.utils.py中重写jwt_response_payload_handler

def jwt_response_payload_handler(token, user=None, request=None, role=None):
    """
    自定义jwt认证成功返回数据
    ：token  返回jwt
    ：user   当前登录的用户信息[对象]
    ：request 当前本次客户端提交过来的数据
    ：role   角色
    """
    if user.first_name:
        name = user.first_name
    else:
        name = user.username
    return {
		'authenticated': 'true',
        'id': user.id,
        'role': role,
        'name': name,
        'username': user.username,
        'email': user.email,
        'token': token,
    }

2.postman测试接口

2.1测试登录接口，获取token

http://192.168.56.100:8888/user/login/

'''自定义认证和权限优先级更高，可以覆盖settings.py中的'''
# 自定义权限类
permission_classes = (MyPermission, )
# 子定义认证类，自定义会覆盖全局配置
authentication_classes = (JSONWebTokenAuthentication, )

2.2使用获取的token获取所有用户信息