RedwoodJS过滤器：请求过滤与预处理的完整指南

【免费下载链接】redwood The App Framework for Startups 项目地址: https://gitcode.com/gh_mirrors/re/redwood

RedwoodJS过滤器是构建安全、高效Web应用的关键工具，它通过指令系统为GraphQL请求提供强大的请求过滤和预处理能力。作为现代化的全栈框架，RedwoodJS通过内置的验证器和转换器指令，让开发者能够轻松实现身份验证、数据屏蔽、字段格式化等功能。

什么是RedwoodJS过滤器？ 🤔

RedwoodJS过滤器本质上是一种GraphQL指令，它可以在GraphQL执行阶段拦截请求并执行自定义逻辑。这些过滤器分为两大类：

• 验证器（Validators）：在解析字段值之前执行，用于权限检查
• 转换器（Transformers）：在解析字段值之后执行，用于数据转换

核心过滤器类型详解

验证器过滤器（Validators）

验证器过滤器用于确保只有经过授权的用户才能访问特定资源。当验证失败时，它们会抛出错误阻止请求继续执行。

内置验证器过滤器：

• @requireAuth：要求用户必须登录
• @skipAuth：允许公开访问

转换器过滤器（Transformers）

转换器过滤器在数据返回给客户端之前对其进行处理，常见的应用场景包括：

• 邮箱地址脱敏显示
• 日期时间格式化
• 敏感数据屏蔽
• 文本内容截断

快速上手：创建你的第一个过滤器

步骤1：生成过滤器指令

使用Redwood CLI快速创建过滤器：

yarn redwood generate directive emailMask --type transformer

步骤2：实现过滤逻辑

在生成的指令文件中，你可以添加自定义的过滤逻辑：

const transform: TransformerDirectiveFunc = ({ context, resolvedValue }) => {
  return resolvedValue.replace(/[a-zA-Z0-9]/i, '*')
}

步骤3：应用到GraphQL Schema

将过滤器应用到你的数据类型中：

type User {
  id: Int!
  name: String!
  email: String! @maskedEmail
  createdAt: DateTime!
}

过滤器的最佳实践 🚀

1. 安全性优先

默认情况下，所有查询和变更都应该受到保护。RedwoodJS强制要求为每个查询和变更指定验证指令，确保应用的安全性。

2. 过滤器链式组合

你可以将多个过滤器组合使用，实现复杂的数据处理流程：

type User {
  id: Int!
  name: String!
  email: String! @requireAuth @maskedEmail
  createdAt: DateTime! @dateFormat
}

3. 智能数据转换

根据用户角色动态调整数据返回内容：

// 管理员看到完整邮箱，普通用户看到脱敏版本
const transform = ({ context, resolvedValue }) => {
  if (hasRole(context.currentUser, 'ADMIN')) {
    return resolvedValue
  }
  return resolvedValue.replace(/[a-zA-Z0-9]/i, '*')

实际应用场景

场景1：用户权限管理

type Query {
  users: [User!]! @requireAuth(roles: ["ADMIN"])
  user(id: Int!): User @requireAuth
}

场景2：数据格式化

type Post {
  id: Int!
  title: String! @uppercase
  content: String! @truncate(length: 100)
  createdAt: DateTime! @dateFormat
}

配置GraphQL处理器

在api/src/functions/graphql.ts中配置过滤器：

import { createGraphQLHandler } from '@redwoodjs/graphql-server'
import directives from 'src/directives/**/*.{js,ts}'

export const handler = createGraphQLHandler({
  directives,
  // 其他配置...
})

总结

RedwoodJS过滤器为现代Web应用提供了强大的请求过滤和预处理能力。通过验证器和转换器指令的组合使用，开发者可以轻松实现：

• 🔐 细粒度的权限控制
• 📊 动态数据格式化
• 🛡️ 敏感信息保护
• ⚡ 性能优化处理

掌握RedwoodJS过滤器的使用，将帮助你构建更加安全、高效和用户友好的Web应用程序。开始使用这些强大的工具，让你的应用在数据安全和用户体验方面都达到新的高度！

【免费下载链接】redwood The App Framework for Startups 项目地址: https://gitcode.com/gh_mirrors/re/redwood