Next.js 实战 (七):浅谈 Layout 布局的嵌套设计模式

打印 上一主题 下一主题

主题 983|帖子 983|积分 2959

业务场景

在目前常见的中背景管理系统中,比较常见的是固定的布局方式包裹页面,但一些特别页面,好比:登录页面、注册页面、忘记密码页面这些页面是不必要布局包裹的。
但在 Next.js AppRouter 中,必须包含一个根布局文件(RootLayout),默认情况下,文件夹层次布局中的布局也是嵌套的,这意味着它们通过其子布局的属性来包装子布局。这是 Next.js 框架的设计理念,目的是允许你创建复杂的页面布局,同时保持代码的整洁和可维护性。
以官网 Nesting layouts 为例,最后 app/blog/[slug]/page.js 天生的结果为:
  1. <RootLayout>
  2.   <BlogLayout>
  3.     {children}
  4.   </BlogLayout>
  5. </RootLayout>
复制代码
正常页面是这样的:

但登录页面如果不处理就会变成这样:

很明显,这不是我们想要的,我们希望这些特别页面不必要父级 layout 包裹,那这个题目该怎么去办理呢?
办理方案

我在网上险些找不到关于 Next.js layout 嵌套布局 的资料,但我觉得这个题目挺故意思的,以是特地写篇文章讨论一下。
这个题目归根结底就是你要不要在 RootLayout 内里写入布局代码,这时候就会分两种情况:

  • 如果你不嫌贫困,RootLayout 根布局留空,然后在必要的页面下都新建一个 layout.tsx 文件:
  1. export default async function RootLayout({
  2.   children,
  3. }: Readonly<{
  4.   children: React.ReactNode;
  5. }>) {
  6.   return (
  7.     <html lang={locale} suppressHydrationWarning>
  8.       <body>
  9.         {children}
  10.       </body>
  11.     </html>
  12.   );
  13. }
复制代码
我看一些 Next.js 教程的源码就是这样布局的,感觉有点贫困。

  • 另有一种就是默认 RootLayout 是常规布局,我们必要想个办法在一些特别页面把 RootLayout 包裹去掉。
我采用的是后者,确定方案后,决定结合 zustand 来定义一个变量用来是否表现根布局。
具体步调


  • 新建 /store/layoutStore.ts 文件:
  1. import { create } from 'zustand';
  2. type LayoutState = {
  3.   skipGlobalLayout: boolean;
  4.   setSkipGlobalLayout: (skip: boolean) => void;
  5. };
  6. export const useLayoutStore = create<LayoutState>((set) => ({
  7.   skipGlobalLayout: false,
  8.   setSkipGlobalLayout: (skip) => set({ skipGlobalLayout: skip }),
  9. }));
复制代码

  • 新建 /components/GlobalLayout 文件:
  1. 'use client';
  2. import { SessionProvider } from 'next-auth/react';
  3. import AppSideBar from '@/components/AppSideBar';
  4. import GlobalFooter from '@/components/GlobalFooter'; // 底部版权
  5. import GlobalHeader from '@/components/GlobalHeader'; // 头部布局
  6. import PageAnimatePresence from '@/components/PageAnimatePresence';
  7. import { SidebarInset, SidebarProvider } from '@/components/ui/sidebar';
  8. import { useLayoutStore } from '@/store/layoutStore';
  9. type GlobalLayoutProps = {
  10.   children: React.ReactNode;
  11. };
  12. export default function GlobalLayout({ children }: GlobalLayoutProps) {
  13.   // 是否跳过全局布局
  14.   const skipGlobalLayout = useLayoutStore((state) => state.skipGlobalLayout);
  15.   return skipGlobalLayout ? (
  16.     <>{children}</>
  17.   ) : (
  18.     <SessionProvider>
  19.       <SidebarProvider>
  20.         <AppSideBar />
  21.         <SidebarInset>
  22.           {/* 头部布局 */}
  23.           <GlobalHeader />
  24.           <PageAnimatePresence>{children}</PageAnimatePresence>
  25.           {/* 底部版权 */}
  26.           <GlobalFooter />
  27.         </SidebarInset>
  28.       </SidebarProvider>
  29.     </SessionProvider>
  30.   );
  31. }
复制代码

  • 修改根目录 layout.tsx 文件:
  1. import GlobalLayout from '@/components/GlobalLayout'; // 全局布局
  2. export default async function RootLayout({
  3.   children,
  4. }: Readonly<{
  5.   children: React.ReactNode;
  6. }>) {
  7.   return (
  8.     <html lang={locale} suppressHydrationWarning>
  9.       <body>
  10.         <GlobalLayout>{children}</GlobalLayout>
  11.       </body>
  12.     </html>
  13.   );
  14. }
复制代码

  • 在不必要 RootLayout 的页面 layout.tsx 文件中:
  1. 'use client';
  2. import { useMount, useUnmount } from 'ahooks';
  3. import LangSwitch from '@/components/LangSwitch';
  4. import ThemeModeButton from '@/components/ThemeModeButton';
  5. import { useLayoutStore } from '@/store/layoutStore';
  6. export default function LoginLayout({ children }: { children: React.ReactNode }) {
  7.   useMount(() => {
  8.     useLayoutStore.setState({ skipGlobalLayout: true });
  9.   });
  10.   useUnmount(() => {
  11.     // 如果需要在离开页面时重置状态
  12.     useLayoutStore.setState({ skipGlobalLayout: false });
  13.   });
  14.   return (
  15.     <div className="relative flex h-[calc(100vh_-_2rem)] w-[calc(100vw_-_2rem)] overflow-hidden justify-center items-center">
  16.       {children}
  17.       <div className="flex absolute top-0 right-0">
  18.         <ThemeModeButton />
  19.         <LangSwitch />
  20.       </div>
  21.     </div>
  22.   );
  23. }
复制代码
我们根据 skipGlobalLayout 属性来判定是否表现 RootLayout 布局,这样就能达到我们的目的了。

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览

快速回复

您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

来自云龙湖轮廓分明的月亮

金牌会员
这个人很懒什么都没写!
快速回复 返回顶部 返回列表