logo
  • 指南
  • 配置
  • 插件
  • API
  • 示例
  • 社区
  • Modern.js 2.x 文档
  • 简体中文
    • 简体中文
    • English
    • 开始
      介绍
      快速上手
      版本升级
      名词解释
      技术栈
      核心概念
      页面入口
      构建工具
      Web 服务器
      基础功能
      路由
      路由基础
      配置式路由
      数据管理
      数据获取
      数据写入
      数据缓存
      渲染
      服务端渲染(SSR)
      服务端流式渲染(Streaming SSR)
      渲染缓存
      静态站点生成(SSG)
      渲染预处理 (Render Preprocessing)
      样式开发
      引入 CSS
      使用 CSS Modules
      使用 CSS-in-JS
      使用 Tailwind CSS
      HTML 模板
      引用静态资源
      引用 JSON 文件
      引用 SVG 资源
      引用 Wasm 资源
      调试
      数据模拟(Mock)
      网络代理
      使用 Rsdoctor
      使用 Storybook
      测试
      Playwright
      Vitest
      Jest
      Cypress
      路径别名
      环境变量
      构建产物目录
      部署应用
      进阶功能
      使用 Rspack
      使用 BFF
      基础用法
      运行时框架
      扩展 BFF Server
      扩展一体化调用 SDK
      文件上传
      跨项目调用
      优化页面性能
      代码分割
      静态资源内联
      产物体积优化
      React Compiler
      提升构建性能
      浏览器兼容性
      配置底层工具
      源码构建模式
      服务端监控
      Monitors
      日志事件
      指标事件
      国际化
      基础概念
      快速开始
      配置说明
      语言检测
      资源加载
      路由集成
      API 参考
      高级用法
      最佳实践
      自定义 Web Server
      专题详解
      模块联邦
      简介
      开始使用
      应用级别模块
      服务端渲染
      部署
      集成国际化能力
      常见问题
      依赖安装问题
      命令行问题
      构建相关问题
      热更新问题
      已下线功能
      📝 编辑此页面
      上一页运行时框架下一页扩展一体化调用 SDK

      #扩展 BFF Server

      部分应用中,开发者可能希望对所有 BFF 函数做统一的处理,例如鉴权、日志、数据处理等。

      Modern.js 支持用户通过 Middleware 的方式来自由扩展 BFF Server。

      #使用中间件

      开发者可以在 server/modern.server.ts 中通过 配置 middlewares 来使用中间件。下面介绍如何手写一个 BFF 中间件,添加权限校验:

      server/modern.server.ts
      import {
        type MiddlewareHandler,
        defineServerConfig,
        getCookie
      } from '@modern-js/server-runtime';
      
      const requireAuthForApi: MiddlewareHandler = async (c, next) => {
        if (c.req.path.startsWith('/api') && c.req.path !== '/api/login') {
          const sid = getCookie(c, 'sid');
          if (!sid) {
            return c.json({ code: -1, message: 'need login' }, 400);
          }
        }
        await next();
      };
      
      export default defineServerConfig({
        middlewares: [
          {
            name: 'require-auth-for-api',
            handler: requireAuthForApi,
          },
        ]
      });
      

      然后添加一个普通的 BFF 函数 api/lambda/hello.ts:

      api/lambda/hello.ts
      export default async () => {
        return 'Hello Modern.js';
      };

      接下来,在前端 src/routes/page.tsx 添加接口的访问代码,直接使用一体化的方式调用:

      src/routes/page.tsx
      import { useState, useEffect } from 'react';
      import { get as hello } from '@api/hello';
      
      export default () => {
        const [text, setText] = useState('');
      
        useEffect(() => {
          async function fetchMyApi() {
            const { message } = await hello();
            setText(message);
          }
      
          fetchMyApi();
        }, []);
      
        return <p>{text}</p>;
      };

      现在运行 dev 命令启动项目,访问 http://localhost:8080/ 会发现 /api/hello 的请求被拦截了:

      Network

      最后修改前端代码 src/routes/page.tsx,在访问 /api/hello 前先调用登录接口:

      Note

      此处没有真实实现登录接口,代码仅作为演示。

      import { useState, useEffect } from 'react';
      import { get as hello } from '@api/hello';
      import { post as login } from '@api/login';
      
      export default () => {
        const [text, setText] = useState('');
      
        useEffect(() => {
          async function fetchAfterLogin() {
            const { code } = await login();
            if (code === 0) {
              const { message } = await hello();
              setText(message);
            }
          }
          fetchAfterLogin();
        }, []);
      
        return <p>{text}</p>;
      };

      刷新页面,可以看到 /api/hello 访问成功:

      Network

      以上代码模拟了在 server/Modern.server.ts 中定义中间件的方式,实现了简易的登录功能。同样,可以在这个配置文件中实现其他功能来扩展 BFF Server。