跳到主要内容

App Layout

提示
  • 适用场景
    • 营销
    • 电商产品页
    • 信息页
  • 不适用
    • 全局状态
    • 上下文
    • 单页面应用
警告

src/app

📂 src/app
├─ 📄 page.tsx
├─ 📄 layout.tsx
├─ 📄 template.tsx
├─ 📄 head.tsx
├─ 📄 loading.tsx
├─ 📄 error.tsx
├─ 📄 not-found.tsx
└─ 📂 path

文件命名约定

  • src/app/
    • page.tsx - 页面内容
    • layout.tsx
      • 布局 - Root 布局必须存在
      • 替代 _app.js, _document.js
      • 没有 searchParams
      • 不应该添加 <head>, 使用 metadata API
      • 支持多个分组布局 - 会导致整页刷新
        • app/(shop)/layout.js
        • app/(marketing)/layout.js
    • template.tsx - 模板
      • 类似 layout 但不会持续存在
    • head.tsx - head 标签内容 - title,meta,link,script
    • loading.tsx - Suspense, Loading 时显示的内容
    • error.tsx
    • not-found.tsx
  • https://nextjs.org/docs/app/api-reference/file-conventions

config

// 'auto' | 'force-dynamic' | 'error' | 'force-static'
export const dynamic = 'auto';
export const dynamicParams = true;
// false | 'force-cache' | 0 | number
export const revalidate = false;
// 'auto' | 'default-cache' | 'only-cache'
// 'force-cache' | 'force-no-store' | 'default-no-store' | 'only-no-store'
export const fetchCache = 'auto';
// 'experimental-edge' | 'nodejs'
export const runtime = 'nodejs';
// 'auto' | 'home' | 'edge' | 'string'
export const preferredRegion = 'auto';
export function generateStaticParams() {}

// ISR
export const revalidate = 3600; // revalidate every hour
  • dynamic
    • auto - 通过 fetch 检测,避免 dynamic
    • force-dynamic
      • 类似于 getServerSideProps
      • fetchCache=force-no-store
    • error
      • 类似 getStaticProps
      • fetchCache=force-cache
    • force-static - 让 cookies(), headers(), useSearchParams() 返回空
  • dynamicParams
    • generateStaticParams
  • revalidate
  • https://beta.nextjs.org/docs/api-reference/segment-config
page.tsx
import { notFound } from 'next/dist/client/components/not-found';

export default function Page({ params, searchParams }: { params: { slug: string }; searchParams: { id: string } }) {
// 返回 NotFound 页面内容
if (!params.slug) {
return notFound();
}
return (
<>
<p>{params.slug}</p>
<p>{searchParams.id}</p>
</>
);
}

export async function generateStaticParams() {
// 同 getStaticPaths
return [{ slug: 'a' }];
}
layout.tsx
export default function RootLayout({ children, params }: { children: React.ReactNode; params?: any }) {
return (
<html lang='en'>
<head>
<title>Next.js</title>
</head>
<body>{children}</body>
</html>
);
}

// ISG
// export const revalidate = 60;
template.tsx
export default function Template({ children }: { children: React.ReactNode }) {
return <div>{children}</div>;
}
head.tsx
async function getPost(slug) {
const res = await fetch('...');
return res.json();
}

export default async function Head({ params }) {
const post = await getPost(params.slug);

return (
<>
<title>{post.title}</title>
</>
);
}
error.tsx
import { useEffect } from 'react';

export default function Error({ error, reset }: { error: Error; reset: () => void }) {
useEffect(() => {
// Log the error to an error reporting service
console.error(error);
}, [error]);

return (
<div>
<p>Something went wrong!</p>
<button onClick={() => reset()}>Reset error boundary</button>
</div>
);
}
not-found.tsx
export default function NotFound() {
return '';
}
  • Server Components
    • 支持的场景
      • 获取数据
      • 访问后端服务
      • 避免敏感信息泄露到前端
      • 大依赖
    • 不支持场景
      • React.Component = null
      • React.PureComponent = null
      • hooks
      • Context - 无 createContext 方法
    • 可 import server-only 包确保模块只在服务端
      • 通过 exports 只有 react-server 实现
      • exports.default 会直接 throw 异常
    • 类似的有 client-only 包
    • fetch
      • 默认 force-cache
      • 支持 react cache - 相同请求只会发出一次
  • Layout 默认为 Server Component
  • 在 app 目录下的都是 Server Component
    • 可在 app 目录下放任意组件,只有特殊文件会被处理

Only async functions are allowed to be exported in a "use server" file

middleware

  • #34179
    • 只能运行在 edge runtime
    • 一般来说不能操作数据库
  • 不能 warp - 获取不到 响应
import type { NextRequest } from 'next/server';
import { NextResponse } from 'next/server';

export async function middleware(req: NextRequest) {
const { url, method, nextUrl } = req;
console.log(`${method} ${nextUrl}`);
// let accessToken = request.cookies.get('access_token');
// if (!accessToken) {
// return NextResponse.redirect(new URL('/auth/login', request.url));
// }
}

export const config = {
matcher: [
/*
* Match all request paths except for the ones starting with:
* - api (API routes)
* - _next/static (static files)
* - _next/image (image optimization files)
* - favicon.ico (favicon file)
*/
'/((?!api|_next/static|_next/image|favicon.ico).*)',
],
};