Egg 静态资源及缓存设置

egg是基于koa框架由阿里团队推出的框架，有很多后端的影子，看着舒服，黑！

egg默认静态文件

egg 默认自动继承静态资源配置，在app/public文件夹，若没有就自动创建目录

访问静态资源
如下所示静态资源，可以通过http://127.0.0.1:7001/public/img/logo.png进行访问；

app/public
|--img
    |--logo.png

egg-static缓存

默认参数配置

egg-static support all configurations in koa-static-cache. and with default configurations below:

• prefix: '/public/'

访问静态化的url前缀

• dir: path.join(appInfo.baseDir, 'app/public')

需要设置静态化的目录

• dynamic: true

如果当前访问的静态资源没有缓存，则缓存静态文件，和preload配合使用；

• preload: false

项目启动的时候是否需要将静态资源缓存，和dynamic配合使用；

• maxAge: 31536000 in prod env, 0 in other envs

默认在prod环境缓存31536000秒，其他环境0秒（不缓存,防止修改代码后给自己挖坑）；

• buffer: true in prod env, false in other envs

是否将缓存文件保存在内存中（默认生产环境会缓存，其他环境实时读取）

我的配置如下：

// static files and cache files
  config.static = {
    // 静态化访问前缀,如：`http://127.0.0.1:7001/static/images/logo.png`
    prefix: '/static', 
    dir: path.join(appInfo.baseDir, 'app/public'), // `String` or `Array:[dir1, dir2, ...]` 静态化目录,可以设置多个静态化目录
    dynamic: true, // 如果当前访问的静态资源没有缓存，则缓存静态文件，和`preload`配合使用；
    preload: false,
    maxAge: 31536000, // in prod env, 0 in other envs
    buffer: true, // in prod env, false in other envs
  };

效果如下：

这是第一次访问的，可以看到status是200，缓存的文件目录是public，缓存有效期是31536000秒；

static.png

当我第二次刷新的时候，状态就是304了，会一直读取缓存中的main.js，如果不强制刷新或者清除缓存或者重启项目等因素，则在31536000秒内会一直读取缓存；

static2.png

• maxFiles选项

egg-static 提供了一个static-cache没有的参数，如下:
maxFiles: the maximum value of cache items, only effective when dynamic is true, default is 1000.

注意事项

如果要使用项目中的静态文件，一定要注意官方默认在生产环境会将静态资源缓存，防止上线后坑了自己，官方静态资源处理的基本很好了，个人感觉只需要改 prefix,dir,maxAge3个参数就好

• prefix 可能需要跟运维小伙伴商量，防止nginx做代理出问题
• dir 静态文件存放的可能不只是public一个目录
• maxAge 官方默认31536000秒（一年）感觉有点长啊，可以适当修改

config.static = {
    prefix: '/static', 
    dir: path.join(appInfo.baseDir, 'app/public'), 
    maxAge: 31536000,
  };

环境变量配置

框架有两种方式指定运行环境：

通过 config/env 文件指定，该文件的内容就是运行环境，如 prod。

通过 EGG_SERVER_ENV 环境变量指定。

框架提供了变量 app.config.env 来表示应用当前的运行环境。

支持按环境变量加载不同的配置文件，如 config.local.js， config.prod.js 等等

EGG_SERVER_ENV 变量说明

• local 本地开发环境
• prod 生产环境

npm install cross-env --save-dev
“scripts”: {
“start”: “cross-env EGG_SERVER_ENV=local egg-bin dev”,
“debug”: “egg-bin debug”
}

参考文档
egg-static
egg-env