深入理解Hug框架中的自定义上下文机制-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01169/article/details/148465185

深入理解Hug框架中的自定义上下文机制

hug Embrace the APIs of the future. Hug aims to make developing APIs as simple as possible, but no simpler. 项目地址: https://gitcode.com/gh_mirrors/hu/hug

什么是上下文(Context)

在Web开发中，上下文(Context)是一个贯穿整个请求生命周期的数据容器，用于存储和共享请求相关的信息。Hug框架作为一个现代化的Python API开发框架，提供了强大的上下文机制，允许开发者在不同接口(HTTP、CLI等)中共享数据。

为什么需要自定义上下文

虽然Hug默认会创建一个简单的字典对象作为上下文，但在实际开发中，我们往往需要更复杂的上下文结构：

数据库连接管理
用户认证信息存储
请求级别的缓存
跨接口的数据共享
资源清理和释放

创建自定义上下文

Hug提供了context_factory装饰器来创建自定义上下文：

@hug.create_context()
def context_factory(*args, **kwargs):
    """创建自定义上下文"""
    return {
        'database': DatabaseSession(),
        'cache': RequestCache(),
        'start_time': time.time()
    }

上下文工厂函数接收的参数与指令(directive)相同，包括API版本、接口类型等信息。这使得我们可以根据不同的接口类型创建不同的上下文。

上下文销毁处理

Hug允许我们自定义上下文销毁时的行为，这对于资源清理特别有用：

@hug.delete_context()
def delete_context(context, exception=None, errors=None, lacks_requirement=None):
    """自定义上下文销毁逻辑"""
    if 'database' in context:
        context['database'].close()
    if 'cache' in context:
        context['cache'].flush()
    
    duration = time.time() - context['start_time']
    log_request(duration, errors, exception)

销毁函数接收上下文对象以及执行结果信息，包括异常、验证错误和未满足的需求等。

上下文的应用场景

1. 认证系统

上下文可以增强认证功能，例如结合数据库验证用户凭证：

@hug.authentication.basic
def context_basic_auth(username, password, context):
    """使用上下文的认证示例"""
    user = context['database'].query(User).filter_by(username=username).first()
    if user and user.verify_password(password):
        return user.id
    return None

2. 自定义指令

指令可以通过上下文访问请求级别的数据：

@hug.directive()
def current_user(context=None, **kwargs):
    """获取当前用户的指令"""
    return context.get('user')

3. 数据验证

使用Hug类型验证

@hug.type(extend=hug.types.number, accept_context=True)
def even_number(value, context):
    """验证偶数并记录到上下文"""
    if value % 2 != 0:
        raise ValueError('Must be even number')
    context['even_numbers'] = context.get('even_numbers', 0) + 1
    return value

使用Marshmallow模式验证

class UserSchema(Schema):
    id = fields.Int()
    name = fields.Str()

    @validates_schema
    def validate_name(self, data):
        """使用上下文进行验证"""
        if data['name'] in self.context['banned_names']:
            raise ValidationError('Name is banned')