首页
/ Supermemory项目中的窗口尺寸Hook实现与SSR兼容性问题解析

Supermemory项目中的窗口尺寸Hook实现与SSR兼容性问题解析

2025-05-25 12:38:41作者:韦蓉瑛

问题背景

在Supermemory项目的前端开发过程中,开发团队遇到了一个典型的服务端渲染(SSR)兼容性问题。当尝试使用自定义Hook useViewport 来获取浏览器窗口尺寸时,系统抛出了"window is not defined"的错误。这个错误揭示了在Node.js环境下直接访问浏览器API的常见陷阱。

技术分析

原始问题代码

项目中的useViewport.ts文件最初是这样实现的:

function getViewport() {
  const { innerWidth: width, innerHeight: height } = window ?? {
    innerWidth: 0,
    innerHeight: 0,
  };
  return { width, height };
}

这段代码试图通过可选链操作符(??)来提供回退值,但实际上在服务端渲染阶段,window对象根本就不存在,导致在访问阶段就直接抛出错误,根本不会执行到回退逻辑。

问题本质

这个错误揭示了前端开发中一个重要概念:环境区分。在以下两种环境下,代码的执行环境有本质区别:

  1. 浏览器环境:拥有完整的DOM API,包括window、document等对象
  2. Node.js环境(SSR):没有浏览器特有的API,执行纯JavaScript

解决方案思路

正确的处理方式应该包含以下几个关键点:

  1. 运行时环境检测:在执行前先判断window对象是否存在
  2. SSR友好设计:在服务端渲染时返回合理的默认值
  3. 动态更新机制:在客户端能够响应窗口尺寸变化

优化后的实现方案

经过修复后的实现应该采用以下模式:

function getViewport() {
  // 首先检查是否在浏览器环境
  const isClient = typeof window !== 'undefined';
  
  if (!isClient) {
    return { width: 0, height: 0 };
  }

  return {
    width: window.innerWidth,
    height: window.innerHeight
  };
}

这种实现方式具有以下优点:

  1. SSR兼容性:在服务端渲染时不会抛出错误
  2. 明确的环境区分:清晰地分离了不同环境的处理逻辑
  3. 可维护性:代码意图明确,便于后续维护

深入思考:React Hook的最佳实践

在实现这类依赖于浏览器API的Hook时,还需要考虑以下方面:

  1. 动态响应:添加resize事件监听器,在窗口尺寸变化时更新状态
  2. 清理机制:在组件卸载时移除事件监听
  3. 性能优化:考虑使用防抖(debounce)技术避免频繁更新

一个完整的实现可能如下:

import { useState, useEffect } from 'react';

function useViewport() {
  const [viewport, setViewport] = useState(() => getViewport());

  useEffect(() => {
    function handleResize() {
      setViewport(getViewport());
    }

    window.addEventListener('resize', handleResize);
    return () => window.removeEventListener('resize', handleResize);
  }, []);

  return viewport;
}

总结

在Supermemory项目中遇到的这个问题,实际上是现代前端开发中服务端渲染架构下的典型挑战。通过这个案例,我们可以学到:

  1. 任何依赖浏览器API的代码都必须考虑SSR场景
  2. 环境检测应该放在实际API调用之前
  3. React Hook的实现需要考虑完整的生命周期
  4. 响应式设计需要配合适当的事件处理机制
登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
178
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
866
513
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
261
302
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
598
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K