教程 - 静态资源 - 《Egg.js v2.28 开发指南》

title: 静态资源
页面渲染
构建工具

title: 静态资源

egg-view-assets 提供了通用的静态资源管理和本地开发方案，有如下功能

一体化本地开发方案
生产环境静态资源映射
和模板引擎集成
在约定下可使用多种构建工具，如 webpack、roadhog、umi 等

可以先查看示例

页面渲染

可通过自动或手动的方式添加静态资源，以下有两种方式

使用 assets 模板引擎

assets 模板引擎并非服务端渲染，而是以一个静态资源文件作为入口，使用基础模板渲染出 html，并将这个文件插入到 html 的一种方式，查看使用 roadhog 的例子。

配置插件

// config/plugin.js
exports.assets = {
  enable: true,
  package: 'egg-view-assets',
}

配置 assets 模板引擎

// config/config.default.js
exports.view = {
  mapping: {
    '.js': 'assets',
  },
};

添加静态资源入口文件 app/view/index.js，然后调用 render 方法进行渲染

// app/controller/home.js
module.exports = class HomeController extends Controller {
  async render() {
    await this.ctx.render('index.js');
  }
}

渲染的结果如下

<!doctype html>
<html>
  <head>
    <link rel="stylesheet" href="http://127.0.0.1:8000/index.css"></link>
  </head>
  <body>
    <div id="root"></div>
    <script src="http://127.0.0.1:8000/index.js"></script>
  </body>
</html>

注意：这个路径生成规则是有映射的，如 index.js -> http://127.0.0.1:8000/index.js。如果本地开发工具不支持这层映射，比如自定义了 entry 配置，可以使用其他模板引擎。

全局自定义 html 模板

一般默认的 html 无法满足需求，可以指定模板路径和模板引擎。

// config/config.default.js
module.exports = appInfo => ({
  assets: {
    templatePath: path.join(appInfo.baseDir, 'app/view/template.html'),
    templateViewEngine: 'nunjucks',
  },
});

添加模板文件

<!doctype html>
<html>
  <head>
    {{ helper.assets.getStyle() | safe }}
  </head>
  <body>
    <div id="root"></div>
    {{ helper.assets.getScript() | safe }}
  </body>
</html>

egg-view-assets 插件提供了 helper.assets 根据自己的场景调用，helper.assets.getScript() 可以不用传参，会将 render 函数的参数透传。

页面自定义 html 模板

支持根据不同页面指定模板，可以在 render 方法传参

// app/controller/home.js
module.exports = class HomeController extends Controller {
  async render() {
    await this.ctx.render('index.js', {}, {
      templatePath: path.join(this.app.config.baseDir, 'app/view/template.html'),
      templateViewEngine: 'nunjucks',
    });
  }
}

修改静态资源目录

以上例子是将静态资源放到 app/view 目录下，但大部分情况希望放到独立目录，如 app/assets。因为 assets 模板引擎使用 egg-view 的加载器，所以直接修改其配置

// config/config.default.js
module.exports = appInfo => ({
  view: {
    // 如果还有其他模板引擎，需要合并多个目录
    root: path.join(appInfo.baseDir, 'app/assets'),
  },
});

使用其他模板引擎

如果无法满足文件映射，可以配合其他模板引擎使用，这时不需要配置 assets 模板引擎，查看使用 umi 的例子。

// config/config.default.js
exports.view = {
  mapping: {
    '.html': 'nunjucks',
  },
};

渲染模板

// app/controller/home.js
module.exports = class HomeController extends Controller {
  async render() {
    await this.ctx.render('index.html');
  }
}

添加模板文件（简化了 umi 的模板）

<!doctype html>
<html>
  <head>
    {{ helper.assets.getStyle('umi.css') | safe }}
  </head>
  <body>
    <div id="root"></div>
    {{ helper.assets.getScript('umi.js') | safe }}
  </body>
</html>

在其他模板中必须添加参数生成需要的静态资源路径

上下文数据

有时候前端需要获取服务端数据，所以在渲染页面时会向 window 全局对象设置数据。

assets 模板引擎可直接传入参数，默认前端代码可以从 window.context 获取数据。

// app/controller/home.js
module.exports = class HomeController extends Controller {
  async render() {
    await this.ctx.render('index.js', { data: 1 });
  }
}

其他模板引擎需要调用 helper.assets.getContext(__context__) 并传入上下文的参数

// app/controller/home.js
module.exports = class HomeController extends Controller {
  async render() {
    await this.ctx.render('index.html', {
      __context__: { data: 1 },
    });
  }
}

默认属性为 context，这个可以通过配置修改

exports.assets = {
  contextKey: '__context__',
};

构建工具

这种模式最重要的是和构建工具整合，保证本地开发体验及自动部署，所以构建工具和框架需要有一层约定。

下面以 roadhog 为例

映射关系

构建工具的 entry 配置决定了映射关系，如基于 webpack 封装的 roadhog、umi 等工具内置了映射关系，如果单独使用 webpack 需要根据这层映射来选择用哪种方式。

文件源码 app/assets/index.js，对应的 entry 为 index.js
本地静态服务接收以此为 entry，如请求 http://127.0.0.1:8000/index.js
构建生成的文件需要有这层映射关系，如生成 index.{hash}.js 并生成 manifest 文件描述关系如
```
{
  "index.js": "index.{hash}.js"
}
```

roadhog 完全满足这个映射关系使用 assets 模板引擎。而 umi 不满足文件映射，因为他只有一个入口 umi.js 文件，所以选择其他模板引擎的方案。

其他构建工具的接入需要满足这层映射关系。

本地开发

查看示例配置，本地服务配置成 roadhog dev，配置 port 来检查服务是否启动完成，因为 roadhog 默认启动端口为 8000，所以这里配置成 8000。

exports.assets = {
  devServer: {
    command: 'roadhog dev',
    port: 8000,
  },
};

部署

静态资源部署之前需要构建，配置 roadhog build 命令，并执行 npm run build

{
  "scripts": {
    "build": "SET_PUBLIC_PATH=true roadhog build"
  }
}

注意：这里添加了 SET_PUBLIC_PATH 变量是因为 roadhog 这样才能开启 publicPath

构建的结果根据 .webpackrc 配置的 output 决定，示例是放到 app/public 目录下，由 egg-static 提供服务。

同时根据 .webpackrc 配置的 manifest 生成一个 manifest.json 文件到 config 目录下（egg 需要读取这个文件作为映射关系）。

应用提供服务

现在应用启动后可以通过 http://127.0.0.1:7001/public/index.{hash}.js 访问静态资源，发现这里多了一层 public 的路径，所以需要添加 publicPath 配置。

// config/config.prod.js
exports.assets = {
  publicPath: '/public/',
};

使用 CDN

一般静态资源都会发到 CDN，所以在构建完成后需要平台将构建产物发布到 CDN 上，如 https://cdn/myapp/index.{hash}.js。

现在除了 publichPath 还需要修改静态资源地址

// config/config.prod.js
exports.assets = {
  url: 'https://cdn',
  publicPath: '/myapp/',
};