学习文档

开始

起步

安装

npm install --save next react react-dom

Next.js 只支持 React 16

由于某些原因我们不得不放弃支持 React 15

添加下面的配置到package.json 的script字段中

{
    "script": {
        "dev": "next",
        "build": "next build"
        "start": "next start"
    }
}

之后,文件系统就是主要的API。每一个.js文件都成为一条被自动处理和呈现的路径

在项目中创建 ./pages/index.js

 export default () => <div>Welcome to next.js!</div>

运行 npm run dev 跳转 http://localhost:3000 ,如果想要使用其他端口,你可以使用 npm run dev -- -p <your port here>

目前为止我们做到:

  • 代码的自动的转换与打包(使用webpack和babel)
  • 代码热更新
  • 服务器端渲染 ./pages
  • 静态文件服务 ./static/ 映射到 /static/

很简单吧!看看这个案列 sample app - nextgram

代码的自动拆分

您声明的每个import都会捆绑并与每个页面一起提供。 这意味着页面从不加载不必要的代码

import cowsay from 'cowsay-browser'

export default () =>
  <pre>
    {cowsay.say({ text: 'hi there!' })}
  </pre>

CSS

内联css支持

案例

我们支持 styled-jsx 书写CSS, The aim is to support "shadow CSS" similar to Web Components, which unfortunately do not support server-rendering and are JS-only.

export default () =>
  <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>

更多案例请查看 styled-jsx 文档

css-in-js

案列

可以使用现有的 CSS-in-JS 方案,最简单的方式是使用内联

export default () => <p style={{ color:'red' }}>hi</p>

要使用更复杂的CSS-in-JS解决方案,您通常必须为服务器端呈现实现样式刷新。我们通过允许您定义自己的包装每个页面的自定义<Document>组件来实现这一点。(To use more sophisticated CSS-in-JS solutions, you typically have to implement style flushing for server-side rendering. We enable this by allowing you to define your own custom <Document> component that wraps each page.)

引入 CSS / Sass / Less / Stylus files

要支持导入.css、.scss、.less或.styl文件,您可以使用这些模块,它们为服务器呈现的应用程序配置合理的默认值

静态文件服务(比如图片)

在你的项目根目录创建一个static文件,在你的代码里可以引入这些静态文件

export default ()=> <img src="/static/my-image.png" alt='my image' />

head

案列

我们公开了一个内置组件,用于向<head>内追加元素, 类似于react-helmet

import Head from 'next/head'
export default () => 
  <div>
    <Head>
      <title>My page title</title>
      <meta name="viewport" content="initial-scale=1.0, width=device-width" />
    </Head>
    <p>Hello world!</p>
  </div>

为了避免重复标签在你的<head>,你可以使用key属性,这将确保标签只呈现一次:

import Head from 'next/head'
export default () => (
  <div>
    <Head>
      <title>My page title</title>
      <meta name="viewport" content="initial-scale=1.0, width=device-width" key="viewport" />
    </Head>
    <Head>
      <meta name="viewport" content="initial-scale=1.2, width=device-width" key="viewport" />
    </Head>
    <p>Hello world!</p>
  </div>
)

上面的案列只有第二个会被渲染

在组件被卸载时,<head>内的内容也会卸载,请不要假设组件更换追加head

请求数据与组件的生命周期

案列

当您需要状态、生命周期钩子或初始数据填充时,您可以导出一个 React.Component(而不是无状态函数,如上面所示)
(When you need state, lifecycle hooks or initial data population you can export a React.Component (instead of a stateless function, like shown above):)

import React from 'react'

export default class extends React.Component {
  static async getInitialProps({ req }) {
    const userAgent = req ? req.headers['user-agent'] : navigator.userAgent
    return { userAgent }
  }

  render() {
    return (
      <div>
        Hello World {this.props.userAgent}
      </div>
    )
  }
}

在页面加载时加载数据,我们使用 getInititialProps, 它是一个异步的静态方法,它可以异步地获取任何解析为JavaScript普通对象的内容,去填充部分props

从getInitialProps返回的数据在服务器呈现时被序列化,类似于JSON.stringify。确保getInitialProps返回的对象是一个普通对象,而不使用Date、Map或者set

初始加载的页面,getInititialProps是仅在服务器上执行的,getInitialProps只有在切换路由或者使用Link路由api时才会在客户端执行

getInitialProps不可以使用在 children components 只可以使用在 Page

如果在getInitialProps中使用一些服务器模块,请确保正确地使用它们。否则,它导致你的app变慢

您还可以为无状态组件定义getInitialProps生命周期方法:

const Page = ({stars}) =>
  <div>
    Next stars :{stars}
  </div>

Page.getInitialProps = async({req}) => {
  const res = await fetch('https://api.github.com/repos/zeit/next.js')
  const json = await res.json()
  return { stars: json.stargazers_count }
}

export default Page

getInitialProps接收一个 context object 有如下属性:

  • pathname - path section of URL
  • query - query string section of URL parsed as an object
  • asPath - String of the actual path (including the query) shows in the browser
  • req - HTTP request object (server only)
  • res - HTTP response object (server only)
  • jsonPageRes - Fetch Response object (client only)
  • err - Error object if any error is encountered during the rendering

路由

With<Link>

案列

在两个页面之间,客户端可以使用Link实现页面之间的切换

// pages/index.js
import Link from 'next/link'

export default () =>
  <div>
    Click{' '}
    <Link href="/about">
      <a>here</a>
    </Link>{' '}
    to read more
  </div>
// pages/about.js
export default () => <p>Welcome to About!</p>

使用<Link prefetch>可以达到最大的性能,同时在后台跳转和数据预取 prefetch&Link

客户端路由的行为与浏览器完全相同

  1. 获取组件
  2. 如果定义了getInitialProps,则获取数据。 如果发生错误,则呈现_error.js
  3. 在第1步和第2步完成后,pushState才会执行,然后组件渲染

每个顶级组件都使用以下API接收url属性:

  • pathname - String of the current path excluding the query string
  • query - Object with the parsed query string. Defaults to {}
  • asPath - String of the actual path (including the query) shows in the browser
  • push(url, as=url) - performs a pushState call with the given url
  • replace(url, as=url) - performs a replaceState call with the given url

第二个作为pushreplace的参数是URL的可选装饰。 在服务器上配置自定义路由时很有用。

With URL Object

案例

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容