前端缓存最佳实践

前言

缓存，这是一个老生常谈的话题，也常被作为前端面试的一个知识点。

本文，重点在与探讨在实际项目中，如何进行缓存的设置，并给出一个较为合理的方案。

在介绍缓存的时候，我们习惯将缓存分为强缓存和协商缓存两种。两者的主要区别是使用本地缓存的时候，是否需要向服务器验证本地缓存是否依旧有效。顾名思义，协商缓存，就是需要和服务器进行协商，最终确定是否使用本地缓存。

两种缓存方案的问题点

强缓存

我们知道，强缓存主要是通过 http 请求头中的 Cache-Control 和 Expire 两个字段控制。Expire 是 HTTP1.0 标准下的字段，在这里我们可以忽略。我们重点来讨论的 Cache-Control 这个字段。

一般，我们会设置 Cache-Control 的值为 “public, max-age=xxx”，表示在xxx秒内再次访问该资源，均使用本地的缓存，不再向服务器发起请求。

显而易见，如果在xxx秒内，服务器上面的资源更新了，客户端在没有强制刷新的情况下，看到的内容还是旧的。如果说你不着急，可以接受这样的，那是不是完美？然而，很多时候不是你想的那么简单的，如果发布新版本的时候，后台接口也同步更新了，那就gg了。有缓存的用户还在使用旧接口，而那个接口已经被后台干掉了。怎么办？

协商缓存

协商缓存最大的问题就是每次都要向服务器验证一下缓存的有效性，似乎看起来很省事，不管那么多，你都要问一下我是否有效。但是，对于一个有追求的码农，这是不能接受的。每次都去请求服务器，那要缓存还有什么意义。

最佳实践

缓存的意义就在于减少请求，更多地使用本地的资源，给用户更好的体验的同时，也减轻服务器压力。所以，最佳实践，就应该是尽可能命中强缓存，同时，能在更新版本的时候让客户端的缓存失效。

在更新版本之后，如何让用户第一时间使用最新的资源文件呢？机智的前端们想出了一个方法，在更新版本的时候，顺便把静态资源的路径改了，这样，就相当于第一次访问这些资源，就不会存在缓存的问题了。

伟大的 webpack 可以让我们在打包的时候，在文件的命名上带上 hash 值。

1. entry:{

2. main: path.join(__dirname, ./main.js ),

3. vendor: [ react , antd ]

4. },

5. output:{

6. path:path.join(__dirname, ./dist ),

7. publicPath: /dist/ ,

8. filname: bundle.[chunkhash].js

9. }

综上所述，我们可以得出一个较为合理的缓存方案：

1. HTML：使用协商缓存。

2. CSS&JS&图片：使用强缓存，文件命名带上hash值。

哈希也有讲究

webpack 给我们提供了三种哈希值计算方式，分别是 hash、chunkhash 和 contenthash。那么这三者有什么区别呢？

1. hash：跟整个项目的构建相关，构建生成的文件hash值都是一样的，只要项目里有文件更改，整个项目构建的hash值都会更改。

2. chunkhash：根据不同的入口文件(Entry)进行依赖文件解析、构建对应的chunk，生成对应的hash值。

3. contenthash：由文件内容产生的hash值，内容不同产生的contenthash值也不一样。

显然，我们是不会使用第一种的。改了一个文件，打包之后，其他文件的 hash 都变了，缓存自然都失效了。这不是我们想要的。

那 chunkhash 和 contenthash 的主要应用场景是什么呢？

在实际在项目中，我们一般会把项目中的 css 都抽离出对应的 css 文件来加以引用。如果我们使用 chunkhash，当我们改了 css 代码之后，会发现 css 文件 hash 值改变的同时，js 文件的 hash 值也会改变。这时候，contenthash 就派上用场了。

ETag计算

Nginx

Nginx 官方默认的 ETag 计算方式是为"文件最后修改时间16进制-文件长度16进制"。

例：ETag：“59e72c84-2404”

Express

Express 框架使用了 serve-static 中间件来配置缓存方案，其中，使用了一个叫 etag 的 npm 包来实现 etag 计算。从其源码可以看出，有两种计算方式：

方式一：使用文件大小和修改时间

1. function stattag (stat) {

2. var mtime = stat.mtime.getTime().toString(16)

3. var size = stat.size.toString(16)

5. return " + size + - + mtime + "

6. }

方式二：使用文件内容的hash值和内容长度

1. function entitytag (entity) {

2. if (entity.length === 0) {

3. // fast-path empty

4. return "0-2jmj7l5rSw0yVb/vlWAYkK/YBwk"

5. }

7. // compute hash of entity

8. var hash = crypto

9. .createHash( sha1 )

10. .update(entity, utf8 )

11. .digest( base64 )

12. .substring(0, 27)

14. // compute length of entity

15. var len = typeof entity === string

16. ? Buffer.byteLength(entity, utf8 )

17. : entity.length

19. return " + len.toString(16) + - + hash + "

20. }

ETag 与 Last-Modified 谁优先

协商缓存，有 ETag 和 Last-Modified 两个字段。那当这两个字段同时存在的时候，会优先以哪个为准呢？

在 Express 中，使用了 fresh 这个包来判断是否是最新的资源。主要源码如下：

1. function fresh (reqHeaders, resHeaders) {

2. // fields

3. var modifiedSince = reqHeaders[ if-modified-since ]

4. var noneMatch = reqHeaders[ if-none-match ]

6. // unconditional request

7. if (!modifiedSince && !noneMatch) {

8. return false

9. }

11. // Always return stale when Cache-Control: no-cache

12. // to support end-to-end reload requests

13. // https://tools.ietf.org/html/rfc2616#section-14.9.4

14. var cacheControl = reqHeaders[ cache-control ]

15. if (cacheControl && CACHE_CONTROL_NO_CACHE_REGEXP.test(cacheControl)) {

16. return false

17. }

19. // if-none-match

20. if (noneMatch && noneMatch !== * ) {

21. var etag = resHeaders[ etag ]

23. if (!etag) {

24. return false

25. }

27. var etagStale = true

28. var matches = parseTokenList(noneMatch)

29. for (var i = 0; i < matches.length; i++) {

30. var match = matches[i]

31. if (match === etag || match === W/ + etag || W/ + match === etag) {

32. etagStale = false

33. break

34. }

35. }

37. if (etagStale) {

38. return false

39. }

40. }

42. // if-modified-since

43. if (modifiedSince) {

44. var lastModified = resHeaders[ last-modified ]

45. var modifiedStale = !lastModified || !(parseHttpDate(lastModified) <= parseHttpDate(modifiedSince))

47. if (modifiedStale) {

48. return false

49. }

50. }

52. return true

53. }

我们可以看到，如果不是强制刷新，而且请求头带上了 if-modified-since 和 if-none-match 两个字段，则先判断 etag，再判断 last-modified。当然，如果你不喜欢这种策略，也可以自己实现一个。

后端需要怎么设置

上文主要说的是前端如何进行打包，那后端怎么做呢？我们知道，浏览器是根据响应头的相关字段来决定缓存的方案的。所以，后端的关键就在于，根据不同的请求返回对应的缓存字段。以 nodejs 为例，如果需要浏览器强缓存，我们可以这样设置：

1. res.setHeader( Cache-Control , public, max-age=xxx );

如果需要协商缓存，则可以这样设置：

1. res.setHeader( Cache-Control , public, max-age=0 );

2. res.setHeader( Last-Modified , xxx);

3. res.setHeader( ETag , xxx);

总结

在做前端缓存时，我们尽可能设置长时间的强缓存，通过文件名加 hash 的方式来做版本更新。在代码分包的时候，应该将一些不常变的公共库独立打包出来，使其能够更持久的缓存。