Next.js实战项目 | 青训营笔记

373 阅读7分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 8 天

一、课程目标

具备C端Web应用开发的基本能力

二、CSR、SSR、SSG

1. CSR

客户端渲染(Client- -Side Rendering)。常见B端WEB应用开发模式,前后端分离,服务器压力相对更轻,渲染工作在客户端进行,服务器直接返回不加工的HTML用户在后续访问操作
SPA:单页面应用,它所需的资源(HTMLCSSJS等),在一次请求中就加载完成,不需刷新地动态加载,首屏时间更长

image-20230201213056648.png

2. SSR

SSR(Server- side Rendering)。 原先的 JSP / PHP就已经体现了服务器端渲染。

代码耦合度高,且模板语言中混杂编程语言对于一些复杂的功能,维护起来很棘手

这种模式下Java, PHP负责渲染的逻辑,而前端只负责UI和交互

image-20230201213320469.png

3. 同构SSR

BFF: Backend For Frontend,服务于前端应用的后端。

前后端一体化,一套React 代码在服务器上运行一遍,到达浏览器又运行一遍。前端后端都要参与渲染,而且首次渲染出的HTML要一样。 

image-20230201213734240.png

image-20230201213809929.png

4. SSG

静态站点生成(Static Site Generation),在构建的时候直接把结果页面输出html到磁盘,每次访问直接把html返回给客户端,相当于一个静态资源

CDN:建立并覆盖在Internet之上,由分布在不同区域的边缘节点服务器群组成的分布式网络

相比SSR,因为不需要每次请求都由服务器端处理,所以可以大幅减轻服务器端的
压力

缺陷在于只能用于偏静态的页面,无法生成与用户相关的内容,也就是所有的用户访问的页面都是相同的。

image-20230201214032578.png

5. SSR、SSG的优势

  • 利于SEO

    浏览器的推广程度,取决于搜索引擎对站点检索的排名,搜索引擎可以理解是一种爬虫,它会爬取指定页面的HTML,并根据用户输入的关键词对页面内容进行排序检索,最后形成我们看到的结果。
    
  • 更短的首屏时间

    SSR/ SSG只需要请求一个HTML文件就能展现出页面,虽然在服务器上会调取接口,但服务器之间的通信要远比客户端快,甚至是同一台服务器上的本地接口调取。因为不再需要请求大量js文件,这就使得SSR/SSG可以拥有更短的首屏时。
    

image-20230201184225971.png

三、什么是Next.js

1. SSR的实现

基于React提供的相关服务器端渲染API实现,整个过程实现比较繁琐重复,从零
实现对新上手同学很不友好

迫切需要个封装好的集合来快速上手服务器端渲染

仓库地址: https://github.com/czm1290433700/ssr-server

image-20230201184714924.png

2. Next.js

Next.js是一个构建于Node.js之上的开源Web开发框架,支持基于React的Web应用程序功能,例如服务端渲染和生成静态网站。

上手快,能力集全,而且覆盖了足够多的性能优化和生态。

对于新同学掌握前后端一体化的开发模式很友好。

CMS仓库地址: https://github.com/czm1 290433700/nextjs-cms
Demo仓库地址: https://github.com/czm1 290433700/nextjs-demo

四、Next.js客户端开发

1. Next.js初始化

  • 初始化

    npx create-next-app@latest --typescript
    
  • 目录结构

    next-env.d.ts --->
    	确保TypeScript编译器选择Next.js类型,可以放到.gitignore中,不需要变更
    
    next.config ---> 
    	nextjs的配置,我们可 以补充webpack的一些配置进行
    

    image-20230201190548769.png

// next. config.js 
const path = require("path");
module.exports = {
  reactStrictMode: true,
  SWCMinify: true,
  webpack: (config) => {
    config.resolve.alias = { 
      config. resolve.alias,
      // 补充一些别名
      "@": path. resolve(__ dirname), 
    };
    return config;
  },
};

2. 数据注入

image-20230201190958250.png

image-20230201191205621.png

3. getInitialProps

在服务器端执行,只能在页面层面进行绑定,采用同构,首次渲染服务器端渲染,路由跳转使用客户端路由

意味着如果使用router跳转当前页,会在客户端执行这部分逻辑

image-20230201191619715.png

4. getServerSideProps

SSR,与getlnitialProps不同的是即使使用router跳转当前页,也只会在服务端执行这部分逻辑

image-20230201191640367.png

5. getStaticProps

SSG,在服务器端构建时执行如果涉及动态路由(带参数)需要使用getStaticPaths配置所有可能的参数情况

image-20230201191852318.png

6. CSS Modules

Next.js支持使用文件命名约定的CSS模块。[name].module.css

image-20230201192025621.png

7. Layout

通过在入口文件导入layout,可以实现每个页面公共的页眉页脚

image-20230201192302911.png

image-20230201215712868.png

8. 文件式路由

Next.js有一个基于页面概念的基于文件系统的路由器。当一个文件被添加到pages目录中时,它会自动作为一个路径可用

预定义路由优先级更高,预定义路由能直接匹配的路由就不会分发给下面的动态路由

image-20230201192642912.png

9. BFF层的路由文件

BFF,作为服务器构建包,不影响客户端构建bundle体积。相同的router生成方式,不过是作为API层访问,而不是page。

image-20230201192830004.png

10. 路由跳转

  • next/link跳转
import Link from "next/link"

<Link href={item.link} key={index}>
    <div className={styles.card}>
        <h2>{fitem.label} &rarr;</h2>
        <p>{item.info}</p>
    </div>
</Link>
  • useRouter跳转
import { useRouter } from' next/router

function ActiveLink({ children, href }) {
	const router = useRouter (
	const style = {
		marginRight: 10,
		color: router.asPath === href ? 'red' : 'black' ,
	}
const handleclick = (e) => {
	e.preventDefault()
	router.push(href)
}
	return (
        <a href={href} onClick={handleclick} style={sty1e}>
            {children}
        </a>
	)
}
export default Act iveLink
除了这些外,还可以使用原生方法跳转,不过原生的方法不会进行Diff比对渲染,性能上Nextjs提供的路由跳转会更好

11. header的修改

可用于修改TDK( title,description,keywords)
<Head>
	<title>{`A Demo for《SSR实战:官网开发指南》(${
		isMobile ?“移动端”: "pc端"
	})`}</title>
	<meta
		name=" description"
		content={`A Demo forSSR实战:官网开发指南》(${
            isMobile ? "移动端: "pc端"
		})`}
	/>
	<meta name=”viewport" content=”user-scalable=no" / > 
	<meta name= "viewport" content=”initial-scale=1, 			maximum-scale=1" /> 
	<link rel="icon" href="/favicon.ico" />
</Head>

12. 多媒体

  • CSS适配

    image-20230201203656979.png

    image-20230201203724188.png

  • JS适配

export const UserAgentProvider = ({ children }: IProps): JSX.Element => {
  const [ userAgent, setUserAgent] = useState<Environment>(Environment .none); //服务器渲染初始化渲染未必是预期效果,none缓 冲切换视觉)

  //监听本地缓存来同步不同页面间的主题(当前页面无法监听到,直接在顶部兰进行了类的切换)
  useEffect(() => {
    const checkUserAgent = (): void => {
    const width = document.body.offsetWidth;
    //用宽度去判断,是为了适配不改机型,仅拉扯屏幕宽度的情况
    if (width < 768) {
      //手机端
      setUserAgent( Environment.mobile);
    } else if (width >= 768 && width < 1200) {
      // ipad端
      setUserAgent( Environment . ipad);
    } else if (width >= 1200) {
      //pc端
      setUserAgent( Environment.pc);
    } else {
      setUserAgent( Environment. none); //增加none类型来缓冲默认类型样式切换时的视觉突变
    };
    checkUserAgent();
    window.addEventListener("resize", checkUserAgent); //监听屏幕宽度变化,及时适配当前页面样式
    return (): void => {
      window.removeEventListener("resize",checkUserAgent ) ;
    }
  }, [typeof document !== "undefined" & document.body.offsetWidth]);
  return (
    <UserAgentContext.Provider value={{ userAgent }}>
      { children}
    </UserAgentContext.Provider>
  );
};

13. 大图优化

image-20230201211136375.png

image-20230201211155622.png

五、Next.js服务端开发

1. BFF层开发

和Express等开发类似,
区别是并没有参数可以直接区别请求类型
import type { NextApiRequest, NextApiResponse } from "next" ;
import axios from "axios";
import { CMSDOMAIN } from "@/utils";
import { IArticleProps } from ”../article/[articleId]";

const getArticleInfoData = (
	req: NextApiRequest, 
	res: NextApiResponse< IArticleProps>
) => {
	const { articleId } = req.query;
	axios.get(`${CMSDOMAIN}/api/article-infos/${articleId}`).then((result) => {
		const data = result.data || {};
    	res.status(200).json(data);
	});
};
export default getArticleInfoData;
export default (req, res) =》{
    if (req.method === 'GET') {
    	// do something for the get scene
    } else if (req.method === 'POST') {
    	// do something for the post scene
    }
}

2. 调试方式

image-20230201211848906.png

image-20230201211913339.png

image-20230201211935279.png

3. Strapi - headless CMS

仓库: htps://github.com/strapi/strapi
初始化: npx create- strapi- app my - project -- quickstart 

一个接口的生成有以下几个过程:

1. content- type builder 编辑结构体
2. content manager 配置数据源,并且发布
3. settingsroles里选择对应角色并勾选要发布的接口类型
4. 如果涉及嵌套,在接口后加上populate=deep参数
(npm install strapi- plugin-populate-deep --save),没安装加参数populate=*,但只能嵌套一层

六、核心功能讲解

1. 首页功能实现

  • 页面&动画&多媒体适配

  • BFF

  • Strapi

2. 文章页实现

  • 页面&动画&多媒体适配

  • BFF

  • Strapi分页(/apiarticles?pagination[page]=1&pagination[pageSize]=10
    // 按10个/页分页,返回第一页的数据)

  • 多媒体格式的转换

    • markdown转html: npm install showdown --save

    • html转dom: dangerouslySetlnnerHTML

  • 公共样式的定义

3. 主体化功能实现

  • 基础样式和背景的抽离
  • 主题化context全局注入
  • 从注入数据中取出theme和setTheme
  • 多进程间的主题同步
思考题: http://localhost:3000, 和http://127.0.0.1:3000主题可以共享吗?
​
不会共享,主体化是采用localStorage控制的,同一域名下使用同一套localStorage,但是localhost和127.0.0.1是跨域的