如何在Django Rest应用中调用集成Keycloak的Spring Boot 2应用的认证API
对接已集成Keycloak的Spring Boot认证服务的可落地步骤
前置对接准备
- 先和Spring Boot侧对齐3个核心对接参数,减少联调反复:
- 认证服务的基础访问地址,确认网络层面Django服务可无拦截访问该地址的对应端口
- 服务间调用的鉴权规则:确认Spring侧对外部调用是要求固定API Key,还是通过Keycloak客户端模式获取服务级Token
- 核心认证接口的出入参规范:覆盖登录、刷新Token、用户信息校验、登出4个核心流程的请求方法、参数结构、错误返回格式
Django 侧基础配置
- 安装必需依赖:
requests:用于发起HTTP请求,选择2.31.0及以上稳定版本django-environ:用于管理敏感配置,避免硬编码服务地址、密钥到代码仓库
- 在
settings.py中新增独立配置块,所有敏感参数通过环境变量注入:# settings.py 配置示例 import environ env = environ.Env() SPRING_BOOT_AUTH_SERVICE = { "BASE_URL": env("SPRING_AUTH_BASE_URL"), "SERVICE_ACCESS_KEY": env("SPRING_AUTH_SERVICE_KEY", default=""), "REQUEST_TIMEOUT": 5, }
统一客户端封装实现
- 在Django应用下新建
auth_client.py文件,对所有Spring侧认证接口的调用做统一封装,不要在视图函数中零散写HTTP请求逻辑:import requests from django.conf import settings class SpringAuthServiceClient: def __init__(self): service_config = settings.SPRING_BOOT_AUTH_SERVICE self.base_url = service_config["BASE_URL"].rstrip("/") self.timeout = service_config["REQUEST_TIMEOUT"] # 统一构造公共请求头,避免每个方法重复写鉴权逻辑 self.common_headers = { "Content-Type": "application/json", "X-Service-Access-Key": service_config["SERVICE_ACCESS_KEY"] } def _generate_full_url(self, path: str) -> str: return f"{self.base_url}{path}" def login(self, username: str, password: str): """调用Spring侧登录接口,获取用户身份Token""" response = requests.post( url=self._generate_full_url("/login"), json={"username": username, "password": password}, headers=self.common_headers, timeout=self.timeout ) return response.json() def refresh_user_token(self, refresh_token: str): """调用Spring侧Token刷新接口""" response = requests.post( url=self._generate_full_url("/refresh"), json={"refresh_token": refresh_token}, headers=self.common_headers, timeout=self.timeout ) return response.json() def validate_access_token(self, user_access_token: str): """转发用户携带的Token到Spring侧做合法性校验,获取解析后的用户信息""" response = requests.get( url=self._generate_full_url("/userinfo"), headers={ **self.common_headers, "Authorization": f"Bearer {user_access_token}" }, timeout=self.timeout ) return response.json() # 全局初始化单例,避免每次请求重复实例化 spring_auth_client = SpringAuthServiceClient()
对接DRF认证流程
- 自定义DRF认证后端,把Token校验逻辑集成到DRF的请求生命周期中,无需在每个视图单独写校验逻辑:
# 新建drf_auth_backend.py import requests from rest_framework import authentication, exceptions from .auth_client import spring_auth_client class SpringKeycloakAuthBackend(authentication.BaseAuthentication): def authenticate(self, request): # 从请求头提取携带的Bearer Token auth_header = request.META.get("HTTP_AUTHORIZATION", "") if not auth_header.startswith("Bearer "): return None # 无合规Token时跳过当前认证,交给其他认证逻辑处理 user_token = auth_header.split(" ")[1].strip() # 调用Spring服务校验Token try: user_info = spring_auth_client.validate_access_token(user_token) except requests.exceptions.RequestException: raise exceptions.AuthenticationFailed("认证服务暂时不可用,请稍后重试") if user_info.get("error"): raise exceptions.AuthenticationFailed("身份凭证无效,请重新登录") # 直接将Keycloak解析出的用户信息传入请求上下文,供视图使用 return (user_info, None) - 在DRF全局配置中启用该自定义认证后端:
# settings.py 中DRF配置 REST_FRAMEWORK = { "DEFAULT_AUTHENTICATION_CLASSES": [ "your_app.drf_auth_backend.SpringKeycloakAuthBackend", "rest_framework.authentication.SessionAuthentication", ], }
落地避坑要点
- 不要在Django侧重复实现Keycloak Token的解析、校验逻辑,所有认证规则完全交由已完成Keycloak集成的Spring Boot应用处理,避免两边逻辑不一致导致的鉴权漏洞
- 所有对外部服务的HTTP请求必须设置超时时间,防止Spring服务异常时占满Django的请求线程引发服务雪崩
- 针对网络波动导致的请求失败,增加最多2次的指数退避重试机制,不要单次请求失败就直接给用户返回错误
- 对所有跨服务的认证请求记录结构化日志,覆盖请求参数、响应结果、接口耗时,出现问题时可快速定位故障节点
- 所有服务地址、访问密钥类敏感配置全部通过环境变量注入,禁止硬编码到代码仓库
内容的提问来源于stack exchange,提问作者Kamil007
相关产品推荐
相关产品推荐

