github 地址
我的项目网址 -pika-music
pika-music api 服务器参考 Binaryify 的 NeteaseCloudMusicApi
我的项目技术特点
- PWA 反对。反对 PWA 的浏览器能够装置到桌面
- 实现 React-SSR 框架
- 实现联合 SSR 的 Dynamic Import
- 实现 webpack 打包反对 module/nomudule 模式
- 实现全站图片懒加载
其余特点:
- http2
- 安卓端反对锁屏音乐管制
- banner 轮播组件
- 视频和音频播放组件
网站截图
技术特点介绍
React-SSR 框架介绍
次要思维参考的是 NextJS。首屏服务端渲染时,调用组件的 getInitialProps(store) 办法,注入 redux store,getInitialProps 获取该页面的数据后,把数据贮存到 redux store 中。在客户端 hydrate 时,从 redux store 中获取数据,而后把数据注入 swr 的 initialData 中,后续页面的数据获取和更新就应用了 swr 的能力。非 SSR 的页面会间接应用 swr。
上面以首页(Discover)为例:
我的项目中有 ConnectCompReducer 这个父类:
class ConnectCompReducer {constructor() {
this.fetcher = axiosInstance
this.moment = moment
}
getInitialData = async () => {throw new Error("child must implememnt this method!")
}
}
每个实现 SSR 的页面都须要继承这个类,比方主页面:
class ConnectDiscoverReducer extends ConnectCompReducer {
// Discover 页面会实现的 getInitialProps 办法就是调用 getInitialData,注入 redux store
getInitialData = async store => {}}
export default new ConnectDiscoverReducer()
Discover 的 JSX:
import discoverPage from "./connectDiscoverReducer"
const Discover = memo(() => {
// banner 数据
const initialBannerList = useSelector(state => state.discover.bannerList)
// 把 banner 数据注入 swr 的 initialData 中
const {data: bannerList} = useSWR(
"/api/banner?type=2",
discoverPage.requestBannerList,
{initialData: initialBannerList,},
)
return (
...
<BannersSection>
<BannerListContainer bannerList={bannerList ?? []} />
</BannersSection>
...
)
})
Discover.getInitialProps = async (store, ctx) => {
// store -> redux store,ctx -> koa 的 ctx
await discoverPage.getInitialData(store, ctx)
}
服务端数据的获取:
// matchedRoutes: 匹配到的路由页面,须要联合 dynamic import,下一大节会介绍
const setInitialDataToStore = async (matchedRoutes, ctx) => {
// 获取 redux store
const store = getReduxStore({
config: {ua: ctx.state.ua,},
})
// 600ms 后超时,中断获取数据
await Promise.race([
Promise.allSettled(
matchedRoutes.map(item => {
return Promise.resolve(
// 调用页面的 getInitialProps 办法
item.route?.component?.getInitialProps?.(store, ctx) ?? null,
)
}),
),
new Promise(resolve => setTimeout(() => resolve(), 600)),
]).catch(error => {console.error("renderHTML 41,", error)
})
return store
}
自行实现联合 SSR 的 Dynamic Import
页面 dynamic import 的封装,重要的解决是加载谬误后的 retry 和 防止页面 loading 闪现:
class Loadable extends React.Component {constructor(props) {super(props)
this.state = {
Comp: null,
error: null,
isTimeout: false,
}
}
// eslint-disable-next-line react/sort-comp
raceLoading = () => {const { pastDelay} = this.props
return new Promise((_, reject) => {setTimeout(() => reject(new Error("timeout")), pastDelay || 200)
})
}
load = async () => {const { loader} = this.props
try {
this.setState({error: null,})
// raceLoading 防止页面 loading 闪现
const loadedComp = await Promise.race([this.raceLoading(), loader()])
this.setState({
isTimeout: false,
Comp:
loadedComp && loadedComp.__esModule ? loadedComp.default : loadedComp,
})
} catch (e) {if (e.message === "timeout") {
this.setState({isTimeout: true,})
this.load()} else {
this.setState({error: e,})
}
}
}
componentDidMount() {this.load()
}
render() {const { error, isTimeout, Comp} = this.state
const {loading} = this.props
// 加载谬误,retry
if (error) return loading({error, retry: this.load})
if (isTimeout) return loading({pastDelay: true})
if (Comp) return <Comp {...this.props} />
return null
}
}
标记动静加载的组件,用于服务端辨认:
const asyncLoader = ({loader, loading, pastDelay}) => {
const importable = props => (
<Loadable
loader={loader}
loading={loading}
pastDelay={pastDelay}
{...props}
/>
)
// 标记
importable.isAsyncComp = true
return importable
}
封装好页面的动静加载后须要思考两点:
- ssr 的时候须要被动去执行动静路由的组件,不然服务端不会渲染组件自身的内容
- 在浏览器端不先去加载动静 split 出的组件的话,会导致组件的 loading 状态闪现。所以,要先加载好动静路由组件,再去渲染页面。
具体代码如下:
服务端加载标记 isAsyncComp 的动静组件:
const ssrRoutesCapture = async (routes, requestPath) => {
const ssrRoutes = await Promise.allSettled([...routes].map(async route => {if (route.routes) {
return {
...route,
routes: await Promise.allSettled([...route.routes].map(async compRoute => {const { component} = compRoute
if (component.isAsyncComp) {
try {const RealComp = await component().props.loader()
const ReactComp =
RealComp && RealComp.__esModule
? RealComp.default
: RealComp
return {
...compRoute,
component: ReactComp,
}
} catch (e) {console.error(e)
}
}
return compRoute
}),
).then(res => res.map(r => r.value)),
}
}
return {...route,}
}),
).then(res => res.map(r => r.value))
return ssrRoutes
}
浏览器端加载动静组件:
const clientPreloadReady = async routes => {
try {
// 匹配以后页面的组件
const matchedRoutes = matchRoutes(routes, window.location.pathname)
if (matchedRoutes && matchedRoutes.length) {
await Promise.allSettled(
matchedRoutes.map(async route => {
if (
route?.route?.component?.isAsyncComp &&
!route?.route?.component.csr
) {
try {await route.route.component().props.loader()} catch (e) {await Promise.reject(e)
}
}
}),
)
}
} catch (e) {console.error(e)
}
}
最初,在浏览器端 ReactDOM.hydrate 的时候先加载动静宰割出的组件:
clientPreloadReady(routes).then(() => {render(<App store={store} />, document.getElementById("root"))
})
module/nomudule 模式
次要实现思路:webpack 先依据 webpack.client.js 的配置打包出反对 es module 的代码,其中产出 index.html。而后 webpack 依据 webpack.client.lengacy.js 的配置,用上一步的 index.html 为 template,打包出不反对 es module 的代码,插入 script nomodule 和 script type=”module” 的脚本。次要依赖的是 html webpack plugin 的相干 hooks。webpack.client.js 和 webpack.client.lengacy.js 次要的不同是 babel 的配置和 html webpack plugin 的 template
babel presets 配置:
exports.babelPresets = env => {
const common = [
"@babel/preset-env",
{// targets: { esmodules: true},
useBuiltIns: "usage",
modules: false,
debug: false,
bugfixes: true,
corejs: {version: 3, proposals: true},
},
]
if (env === "node") {common[1].targets = {node: "13",}
} else if (env === "legacy") {common[1].targets = {
ios: "9",
safari: "9",
}
common[1].bugfixes = false
} else {common[1].targets = {esmodules: true,}
}
return common
}
实现在 html 内插入 script nomodule 和 script type=”module” 的 webpack 插件代码链接:https://github.com/mbaxszy7/p…
全站图片懒加载
图片懒加载的实现应用的是 IntersectionObserver 和浏览器原生反对的 image lazy loading
const pikaLazy = options => {
// 如果浏览器原生反对图片懒加载,就设置懒加载以后图片
if ("loading" in HTMLImageElement.prototype) {
return {
lazyObserver: imgRef => {load(imgRef)
},
}
}
// 以后图片呈现在以后视口,就加载图片
const observer = new IntersectionObserver((entries, originalObserver) => {
entries.forEach(entry => {if (entry.intersectionRatio > 0 || entry.isIntersecting) {originalObserver.unobserve(entry.target)
if (!isLoaded(entry.target)) {load(entry.target)
}
}
})
},
{
...options,
rootMargin: "0px",
threshold: 0,
},
)
return {
// 设置察看图片
lazyObserver: () => {const eles = document.querySelectorAll(".pika-lazy")
for (const ele of Array.from(eles)) {if (observer) {observer.observe(ele)
continue
}
if (isLoaded(ele)) continue
load(ele)
}
},
}
}
PWA
PWA 的缓存管制和更新的能力使用的是 workbox。然而加了缓存删除的逻辑:
import {cacheNames} from "workbox-core"
const currentCacheNames = {
"whole-site": "whole-site",
"net-easy-p": "net-easy-p",
"api-banner": "api-banner",
"api-personalized-newsong": "api-personalized-newsong",
"api-playlist": "api-play-list",
"api-songs": "api-songs",
"api-albums": "api-albums",
"api-mvs": "api-mvs",
"api-music-check": "api-music-check",
[cacheNames.precache]: cacheNames.precache,
[cacheNames.runtime]: cacheNames.runtime,
}
self.addEventListener("activate", event => {
event.waitUntil(caches.keys().then(cacheGroup => {
return Promise.all(
cacheGroup
.filter(cacheName => {return !Object.values(currentCacheNames).includes(`${cacheName}`)
})
.map(cacheName => {
// 删除与以后缓存不匹配的缓存
return caches.delete(cacheName)
}),
)
}),
)
})
我的项目的 PWA 缓存控制策略次要抉择的是 StaleWhileRevalidate,先展现缓存(如果有的话),而后 pwa 会更新缓存。因为我的项目用了 swr,该库会轮询页面的数据或者在页面从暗藏到显示时也会申请更新数据,从而达到了应用 pwa 更新的缓存的目标。
浏览器兼容
IOS >=10,
Andriod >=6