Next.js 速查表

npx create-next-app@latest
# or
yarn create next-app
# or
pnpm create next-app

或者创建 TypeScript 项目

npx create-next-app@latest --typescript
# or
yarn create next-app --typescript
# or
pnpm create next-app --typescript

运行 npm run dev 或 yarn dev 或 pnpm dev 以在 http://localhost:3000 上启动开发服务器

使用以下内容填充 pages/index.js：

function HomePage() {
  return <div>Welcome to Next.js!</div>
}

export default HomePage

Next.js 是围绕页面的概念构建的。 页面是从 pages 目录中的 .js、.jsx、.ts 或 .tsx 文件导出的 React 组件

import { useState, useEffect } from 'react'

function Profile() {
  const [data, setData] = useState(null)
  const [isLoading, setLoading] = useState(false)

  useEffect(() => {
    setLoading(true)
    fetch('/api/profile-data')
      .then((res) => res.json())
      .then((data) => {
        setData(data)
        setLoading(false)
      })
  }, [])

  if (isLoading) return <p>Loading...</p>
  if (!data) return <p>No profile data</p>

  return (
    <div>
      <h1>{data.name}</h1>
      <p>{data.bio}</p>
    </div>
  )
}

import useSWR from 'swr'

const fetcher = (...args) => fetch(...args).then((res) => res.json())

function Profile() {
  const { data, error } = useSWR('/api/profile-data', fetcher)

  if (error) return <div>Failed to load</div>
  if (!data) return <div>Loading...</div>

  return (
    <div>
      <h1>{data.name}</h1>
      <p>{data.bio}</p>
    </div>
  )
}

Next.js 可以在根目录中名为 public 的文件夹下提供静态文件，如图像。 然后，您的代码可以从基本 URL (/) 开始引用 public 中的文件

import Image from 'next/image'

function Avatar() {
  return (
    <Image
      src="/me.png"
      alt="me"
      width="64"
      height="64"
    />
  )
}

export default Avatar

Next.js 支持零配置的现代浏览器

• Chrome 64+
• Edge 79+
• Firefox 67+
• Opera 51+
• Safari 12+

Next.js 支持在 package.json 文件中配置 Browserslist

{
  "browserslist": [
    "chrome 64",
    "edge 79",
    "firefox 67",
    "opera 51",
    "safari 12"
  ]
}

对于全局样式表，如 bootstrap 或 nprogress，您应该在 pages/_app.js 中导入文件

// pages/_app.js
import 'bootstrap/dist/css/bootstrap.css'

export default function MyApp({
  Component, pageProps
}) {
  return <Component {...pageProps} />
}

从 Next.js 9.5.4 开始，您的应用程序中的任何地方都允许从 node_modules 导入 CSS 文件

Next.js 允许您使用 .scss 和 .sass 扩展名导入 Sass，可以通过 CSS 模块和 .module.scss 或 .module.sass 扩展名使用组件级 Sass

$ npm install --save-dev sass

在使用 Next.js 的内置 Sass 支持之前，请务必安装 sass

最简单的一种是内联样式：

function HiThere() {
  return (
    <p style={{ color: 'red' }}>hi 这里</p>
  )
}

export default HiThere

使用 styled-jsx 的组件如下所示：

function HelloWorld() {
  return (
    <div>
      Hello world
      <p>scoped!</p>
      <style jsx>{`
        p { color: blue; }
        div { background: red; }
        @media (max-width: 600px) {
          div { background: blue; }
        }
      `}</style>
      <style global jsx>{`
        body { background: black; }
      `}</style>
    </div>
  )
}

export default HelloWorld

当然，你也可以使用 styled-components

// components/layout.js
import Navbar from './navbar'
import Footer from './footer'

export default function Layout({ children }) {
  return (
    <>
      <Navbar />
      <main>{children}</main>
      <Footer />
    </>
  )
}

// pages/_app.js
import Layout from '../components/layout'

export default function MyApp({ Component, pageProps }) {
  return (
    <Layout>
      <Component {...pageProps} />
    </Layout>
  )
}

// pages/index.js
import Layout from '../components/layout'
import NestedLayout from '../components/nested-layout'

export default function Page() {
  return (
    /** Your content */
  )
}

Page.getLayout = function getLayout(page) {
  return (
    <Layout>
      <NestedLayout>{page}</NestedLayout>
    </Layout>
  )
}

// pages/_app.js
export default function MyApp({ Component, pageProps }) {
  // 使用在页面级别定义的布局（如果可用）
  const getLayout = Component.getLayout || ((page) => page)
  return getLayout(<Component {...pageProps} />)
}

// components/layout.js
import useSWR from 'swr'
import Navbar from './navbar'
import Footer from './footer'

export default function Layout({ children }) {
  const { data, error } = useSWR('/api/navigation', fetcher)
  if (error) return <div>Failed to load</div>
  if (!data) return <div>Loading...</div>
  return (
    <>
      <Navbar links={data.links} />
      <main>{children}</main>
      <Footer />
    </>
  )
}

import Image from 'next/image'
import profilePic from '../public/me.png'

function Home() {
  return (
    <>
      <h1>My Homepage</h1>
      <Image
        src={profilePic}
        alt="Picture of the author"
        // width={500} 自动提供
        // height={500} 自动提供
        // blurDataURL="data:..." 自动提供
        // placeholder="blur" // 加载时可选的模糊处理
      />
      <p>Welcome to my homepage!</p>
    </>
  )
}

import Image from 'next/image'

export default function Home() {
  return (
    <>
      <h1>My Homepage</h1>
      <Image
        src="/me.png"
        alt="Picture of the author"
        width={500}
        height={500}
      />
      <p>Welcome to my homepage!</p>
    </>
  )
}

要使用远程图像，src 属性应该是一个 URL 字符串，可以是相对的也可以是绝对的

您应该将优先级属性添加到将成为每个页面的 Largest Contentful Paint (LCP) 元素的图像。 这样做允许 Next.js 专门确定要加载的图像的优先级（例如，通过预加载标签或优先级提示），从而显着提高 LCP

import Image from 'next/image'

export default function Home() {
  return (
    <>
      <h1>My Homepage</h1>
      <Image
        src="/me.png"
        alt="Picture of the author"
        width={500}
        height={500}
        priority
      />
      <p>Welcome to my homepage!</p>
    </>
  )
}

const roboto = Roboto({
  weight: ['400', '700'],
  style: ['normal', 'italic'],
  subsets: ['latin'],
})

// pages/_app.js
import { Inter } from '@next/font/google'
const inter = Inter({ subsets: ['latin'] })
export default function MyApp({ Component, pageProps }) {
  return (
    <>
      <style jsx global>{`
        html {
          font-family: ${inter.style.fontFamily};
        }
      `}</style>
      <Component {...pageProps} />
    </>
  )
}

// pages/index.js
import { Inter } from '@next/font/google'

const inter = Inter({ subsets: ['latin'] })

export default function Home() {
  return (
    <div className={inter.className}>
      <p>Hello World</p>
    </div>
  )
}

// pages/_app.js
const inter = Inter({ subsets: ['latin'] })

在 next.config.js 中全局使用所有字体

// next.config.js
module.exports = {
  experimental: {
    fontLoaders: [
      {
        loader: '@next/font/google',
        options: { subsets: ['latin'] }
      },
    ],
  },
}

如果两者都配置，则使用函数调用中的子集

import Script from 'next/script'

export default function Dashboard() {
  return (
    <>
      <Script
        src="https://example.com/script.js"
      />
    </>
  )
}

import Script from 'next/script'

export default function Page() {
  return (
    <>
      <Script
        src="https://example.com/script.js"
        id="example-script"
        nonce="XUENAJFW"
        data-test="script"
      />
    </>
  )
}

import Script from 'next/script'

export default function Page() {
  return (
    <>
      <Script
        src="https://example.com/script.js"
        onLoad={() => {
          console.log('Script has loaded')
        }}
      />
    </>
  )
}

"scripts": {
  "lint": "next lint"
}

然后运行 npm run lint 或 yarn lint：

yarn lint
# 你会看到这样的提示：
#
# ? 您想如何配置 ESLint？
#
# ❯   基本配置 + Core Web Vitals 规则集（推荐）
#     基本配置
#     None

Strict 严格配置：包括 Next.js 的基本 ESLint 配置以及更严格的 Core Web Vitals 规则集

{
  "extends": "next/core-web-vitals"
}

Base 基础配置：包括 Next.js 的基本 ESLint 配置

{
  "extends": "next"
}

项目的根目录中创建一个包含所选配置的 .eslintrc.json 文件

{
  "extends": "next",
  "settings": {
    "next": {
      "rootDir": "packages/my-app/"
    }
  }
}

rootDir 可以是路径（相对或绝对）、glob（即“packages/*/”）或路径和/或 glob 数组

{
  "extends": "next/core-web-vitals"
}

npm install -S eslint-config-prettier
# or
yarn add --dev eslint-config-prettier

{
  "extends": ["next", "prettier"]
}

npx create-next-app@latest --ts
# or
yarn create next-app --typescript
# or
pnpm create next-app --ts

touch tsconfig.json

您还可以通过在 next.config.js 文件中设置 typescript.tsconfigPath 属性来提供 tsconfig.json 文件的相对路径

使用内置类型 AppProps 并将文件名更改为 ./pages/_app.tsx，如下所示：

import type { AppProps } from 'next/app'

export default function MyApp({
  Component, pageProps
}: AppProps) {
  return <Component {...pageProps} />
}

// @ts-check
/**
 * @type {import('next').NextConfig}
 **/
const nextConfig = {
  /* 配置选项在这里 */
}

module.exports = nextConfig

module.exports = {
  typescript: {
    ignoreBuildErrors: true,
  },
}

危险地允许生产构建成功完成，即使您的项目有类型错误

将环境变量从 .env.local 加载到 process.env 中

DB_HOST=localhost
DB_USER=myuser
DB_PASS=mypassword

使用环境变量

// pages/index.js
export async function getStaticProps() {
  const db = await myDB.connect({
    host: process.env.DB_HOST,
    username: process.env.DB_USER,
    password: process.env.DB_PASS,
  })
  // ...
}

# .env
HOSTNAME=localhost
PORT=8080
HOST=http://$HOSTNAME:$PORT

如果您尝试使用实际值中带有 $ 的变量，则需要像这样对其进行转义：\$

# .env
A=abc

# becomes "preabc"
WRONG=pre$A

# becomes "pre$A"
CORRECT=pre\$A

为了向浏览器公开变量，您必须在变量前加上 NEXT_PUBLIC_ 前缀

NEXT_PUBLIC_ANALYTICS_ID=abcdefghijk

NEXT_PUBLIC_ANALYTICS_ID 可以在此处使用，因为它的前缀是 NEXT_PUBLIC_

// pages/index.js
import setupAnalyticsService from '../lib/my-analytics-service'

//
// 它将在构建时转换为 `setupAnalyticsService('abcdefghijk')`
setupAnalyticsService(process.env.NEXT_PUBLIC_ANALYTICS_ID)

function HomePage() {
  return <h1>Hello World</h1>
}

export default HomePage

如果您创建一个名为 pages/posts/[pid].js 的文件，那么它可以在 posts/1、posts/2 等处访问

import { useRouter } from 'next/router'

const Post = () => {
  const router = useRouter()
  const { pid } = router.query

  return <p>Post: {pid}</p>
}

export default Post

使用 useRouter 获取动态路由参数 pid

import Link from 'next/link'

export default function Posts({ posts }) {
  return (
    <Link href={`/blog/${encodeURIComponent(post.slug)}`}>
      标题
    </Link>
  )
}

import Link from 'next/link'

export default function Posts({ posts }) {
  return (
    <Link
      href={{
        pathname: '/blog/[slug]',
        query: { slug: posts.slug },
      }}
    >
      标题
    </Link>
  )
}

工作方式相同。 页面 pages/post/[pid]/[comment].js 将匹配路由 /post/abc/a-comment 并且它的查询对象将是：

{ "pid": "abc", "comment": "a-comment" }

可以通过在括号内添加三个点 (...) 来扩展动态路由以捕获所有路径，pages/post/[...slug].js 匹配 /post/a，也匹配 /post/a/b、/post/a/b/c 等

// /post/a
{ "slug": ["a"] }

// /post/a/b
{ "slug": ["a", "b"] }

使用 [[...slug]]，pages/post/[[...slug]].js 将匹配 /post、/post/a、/post/a/b 等

// GET `/post` (empty object)
{ }
// `GET /post/a` (single-element array)
{ "slug": ["a"] }
// `GET /post/a/b` (multi-element array)
{ "slug": ["a", "b"] }

import { useRouter } from 'next/router'

export default function ReadMore() {
  const router = useRouter()

  return (
    <button
      onClick={() => router.push('/about')}
    >
      点击这里阅读更多
    </button>
  )
}