logologo
文档仓库
文档仓库
logologo
开始

概述

第一步
控制器
提供者
模块
中间件
异常过滤器
管道
守卫
拦截器
自定义装饰器

基础

自定义提供程序
异步提供者
动态模块
注入作用域
循环依赖
模块引用
懒加载模块
执行上下文
生命周期事件
发现服务
平台无关
单元测试

技术

配置
SQL
Mongo
验证
缓存
序列化
版本控制
任务调度
队列
日志
Cookies
事件
压缩
文件上传
文件流
HTTP 模块
Session
MVC
性能(Fastify)
SSE

安全

认证
授权
加密与哈希
Helmet
CORS
CSRF
速率限制

GraphQL

快速开始
解析器
变更
订阅
标量
指令
接口
联合与枚举
字段中间件
类型映射
插件
复杂度
扩展
CLI 插件
生成SDL
共享模型
其他功能
联邦

WebSocket

网关
异常过滤器
管道
守卫
拦截器
适配器

微服务

基础
Redis
MQTT
NATS
RabbitMQ
Kafka
gRPC
自定义传输
异常过滤器
管道
守卫
拦截器
部署
独立应用程序

CLI

概述
工作区
库
用法
脚本

OpenAPI

介绍
装饰器
类型映射
操作
其他特性
安全
类型与参数
CLI 插件

实用示例

REPL
CRUD生成器
SWC
Passport(认证)
热重载
MikroORM
TypeORM
Mongoose
Sequelize
路由模块
Swagger
健康检查
CQRS
Compodoc
Prisma
Sentry
静态资源
Commander
异步本地存储
Necord
套件(原Automock)

常见问题

Serverless
HTTP 适配器
长连接
全局前缀
原始请求体
混合应用
HTTPS & 多服务器
请求生命周期
错误

开发工具

概述
CI/CD
迁移指南
API参考(官方)

生态与案例

谁在用
精彩资源

支持

支持

社区

贡献者

最后更新于: 2025/11/18 02:11:37

上一页复杂度
下一页CLI 插件

#扩展功能

警告

本章仅适用于代码优先方法。

扩展是一项高级底层特性 ,允许您在类型配置中定义任意数据。通过为特定字段附加自定义元数据,您可以创建更复杂、通用的解决方案。例如,借助扩展功能,您可以定义访问特定字段所需的字段级角色。这些角色可在运行时反映,以确定调用者是否具备检索特定字段的足够权限。

#添加自定义元数据

要为字段附加自定义元数据,请使用从 @nestjs/graphql 包导出的 @Extensions() 装饰器。

@Field()
@Extensions({ role: Role.ADMIN })
password: string;

在上面的示例中,我们将 role 元数据属性赋值为 Role.ADMIN。Role 是一个简单的 TypeScript 枚举,用于分组系统中所有可用的用户角色。

注意,除了在字段上设置元数据外,您还可以在类级别和方法级别(例如查询处理程序上)使用 @Extensions() 装饰器。

#使用自定义元数据

利用自定义元数据的逻辑可以根据需要变得非常复杂。例如,您可以创建一个简单的拦截器来存储/记录每次方法调用的事件,或者创建一个字段中间件来匹配检索字段所需的角色与调用者权限(字段级权限系统)。

出于演示目的,我们定义一个 checkRoleMiddleware 中间件,用于比较用户角色(此处硬编码)与访问目标字段所需的角色:

export const checkRoleMiddleware: FieldMiddleware = async (
  ctx: MiddlewareContext,
  next: NextFn
) => {
  const { info } = ctx;
  const { extensions } = info.parentType.getFields()[info.fieldName];

  /**
   * In a real-world application, the "userRole" variable
   * should represent the caller's (user) role (for example, "ctx.user.role").
   */
  const userRole = Role.USER;
  if (userRole === extensions.role) {
    // or just "return null" to ignore
    throw new ForbiddenException(
      `User does not have sufficient permissions to access "${info.fieldName}" field.`
    );
  }
  return next();
};

完成上述定义后,我们可以为 password 字段注册中间件,如下所示:

@Field({ middleware: [checkRoleMiddleware] })
@Extensions({ role: Role.ADMIN })
password: string;