在Superset中配置SecurityManager的OAuth用户信息获取装饰器

我之前在给Superset做自定义OAuth用户信息映射的时候，也碰到过和你一模一样的问题——把oauth_user_info_getter装饰器直接丢在superset_config.py里完全没生效，折腾了好一阵才搞清楚正确的姿势，分享给你：

为什么直接在superset_config.py里用装饰器不行？ #

Flask-AppBuilder的oauth_user_info_getter装饰器是绑定到SecurityManager实例上的，而不是类本身。你直接在superset_config.py里用@SupersetSecurityManager.oauth_user_info_getter装饰函数，只是给类绑定了一个方法，但Superset启动时会初始化自己的SecurityManager实例，并不会继承这个绑定的方法，所以你的自定义逻辑根本不会被调用。

正确的实现方式 #

方法一：自定义SecurityManager子类（推荐） #

这是官方推荐的标准做法，扩展性最强，也最容易维护：

1. 新建一个Python文件（比如custom_security.py），放在Superset能导入的路径下（比如和superset_config.py同目录），编写自定义SecurityManager类：

from superset.security import SupersetSecurityManager

class CustomSecurityManager(SupersetSecurityManager):
    @SupersetSecurityManager.oauth_user_info_getter
    def get_oauth_user_info(self, provider, response=None):
        # 这里写你的自定义用户信息获取逻辑
        # 示例：针对特定OAuth提供商处理字段映射
        if provider == "your_oauth_provider":  # 要和你OAUTH_PROVIDERS里的name一致
            # 通过OAuth远程客户端获取用户信息（根据你的提供商API调整）
            user_info = self.oauth_remotes[provider].get("userinfo").json()
            
            # 返回Superset需要的用户字段格式
            return {
                "username": user_info.get("login", user_info.get("email").split("@")[0]),
                "first_name": user_info.get("given_name", ""),
                "last_name": user_info.get("family_name", ""),
                "email": user_info.get("email"),
                # 可选：如果需要同步用户组，可以添加"roles"字段
                # "roles": [role["name"] for role in user_info.get("roles", [])]
            }
        
        # 其他提供商或默认逻辑，调用父类方法
        return super().get_oauth_user_info(provider, response)

2. 在superset_config.py里指定使用这个自定义类：

# 替换成你的自定义类的导入路径
SECURITY_MANAGER_CLASS = "custom_security.CustomSecurityManager"

方法二：用APP_INITIALIZERS钩子动态绑定 #

如果不想单独写子类，也可以通过Superset的初始化钩子，在SecurityManager实例创建后动态绑定装饰器：

在superset_config.py里添加以下代码：

from superset.security import SupersetSecurityManager

def customize_oauth_user_info(security_manager):
    @security_manager.oauth_user_info_getter
    def get_oauth_user_info(provider, response=None):
        # 同样的自定义逻辑
        if provider == "your_oauth_provider":
            user_info = security_manager.oauth_remotes[provider].get("userinfo").json()
            return {
                "username": user_info.get("login"),
                "email": user_info.get("email"),
                "first_name": user_info.get("given_name", ""),
                "last_name": user_info.get("family_name", "")
            }
        # 回退到默认逻辑
        return security_manager.get_oauth_user_info(provider, response)

# 注册初始化钩子，Superset启动时会调用这个函数
APP_INITIALIZERS = {
    "custom_oauth": customize_oauth_user_info
}

注意事项 #

• 确保OAUTH_PROVIDERS配置里的name字段和你在自定义逻辑里判断的provider名称完全一致。
• 测试前请清除浏览器缓存或使用隐身窗口，避免之前的OAuth会话残留导致的问题。
• 如果用方法一，要确保自定义类的路径能被Superset的Python环境找到（可以把文件放在PYTHONPATH包含的目录下）。

内容的提问来源于stack exchange，提问作者Sayat Satybald