koa2入门系列 Part 3

koa页面渲染

上一节我们通过koa的路由中间件,在上下文的body属性中渲染页面内容,但那只是基本的一些字符串内容,而我们前端所用的页面,或者浏览器所渲染的,基本都是html标签的页面文件,如果想在koa路由中渲染标签内容,又如何做呢,接下来看代码

1、渲染html内容

就是在body中渲染标签文本,用es6的模版语法把html文本包起来就可以了。

const Koa = require('koa');
const Router = require('koa-router');

const app = new Koa();
const router = new Router();

app.use(async (ctx, next) => {
  await next();
});

router.get('/', async ctx => {
  ctx.type = `text/html;charset=utf-8`;
  ctx.body = `
  <!DOCTYPE html>
    <html lang="en">
      <head>
        <meta charset="UTF-8" />
        <title></title>
      </head>
      <body>
        <h2>test</h2>
      </body>
    </html>

  `;
});

//启动路由
app.use(router.routes());
app.use(router.allowedMethods());

app.listen(3000);

重启服务,刷新浏览器,就会看到浏览器显示加粗的test字样。
众所周知,日常开发中,页面需要展示的标签内容有时候是很庞大的,而这时候body又不可能去填写那么多的内容,这时候就得益于编程中的模块化思想了:就是把想要的内容当成一个模块引入。

2、渲染js标签文件

接下来新建一个html.js文件,把上面要展示的html内容复制过去

module.exports = `
<!DOCTYPE html>
  <html lang="en">
    <head>
      <meta charset="UTF-8" />
      <title></title>
    </head>
    <body>
      <h2>test</h2>
    </body>
  </html>
`;

然后在app.js中引入

const Koa = require('koa');
const Router = require('koa-router');

const testTpl = require('./html.js');
console.log(testTpl);
const app = new Koa();
const router = new Router();

app.use(async (ctx, next) => {
  await next();
});

router.get('/', async ctx => {
  ctx.type = `text/html;charset=utf-8`;
  ctx.body = testTpl;
});

//启动路由
app.use(router.routes());
app.use(router.allowedMethods());

app.listen(3000);

重启服务器,刷新浏览器,这样页面就能展示同样的内容。

3、模版渲染

虽然当作模块引入也能达到我们想要的效果,但html.js毕竟只是一个js文件,跟我们正常使用的html文件还是不一样,如果想要使用html文件,就要使用本节需要用到的koa-views中间件了。

  • 首先下载yarn add koa-views ejs,其中ejs是模版库,用来渲染模版文件的,具体用法参考官网
  • 然后在项目根目录新建views文件夹,并在该目录下新建index.ejsnews.ejsblocks/header.ejs文件,文件内的内容如下
<!DOCTYPE html>
<html lang="en">
  <!-- index.ejs -->
  <head>
    <meta charset="UTF-8" />
    <title>首页</title>
  </head>
  <body>
    <!-- 模版语法,include包含的路径是以views配置的文件夹为准的 -->
    <%- include('blocks/header.ejs') %>
    <p><%= commonData %></p>
    <p><%= title %></p>
    <ul>
      <% for(var i = 0;i < list.length;i++){ %>
      <li><%= list[i] %></li>
      <% } %>
    </ul>
  </body>
</html>
<!DOCTYPE html>
<html lang="en">
  <!-- news.ejs -->
  <head>
    <meta charset="UTF-8" />
    <title>首页</title>
  </head>
  <body>
    <!-- 模版语法,include包含的路径是以views配置的文件夹为准的 -->
    <%- include('blocks/header.ejs') %>
    <p><%= commonData %></p>
    <p><%= title %></p>
    <ul>
      <% for(var i = 0;i < list.length;i++){ %>
      <li><%= list[i] %></li>
      <% } %>
    </ul>
  </body>
</html>
<!-- header.ejs -->
<h1>这是一个头部模块</h1>
  • 最后配置app.js文件,使用模版文件
const Koa = require('koa');
const Router = require('koa-router');
const Views = require('koa-views');

const testTpl = require('./html.js');

const app = new Koa();
const router = new Router();

// 配置模版引擎中间件,.html和.ejs配置取其一
// 匹配.html后缀模版文件
// app.use(
//   Views('views', {
//     map: { html: 'ejs' }
//   })
// );

// 匹配.ejs后缀模版文件
app.use(
  Views('views', {
    extension: 'ejs'
  })
);

app.use(async (ctx, next) => {
  await next();
});

// 配置公共信息的中间件
app.use(async (ctx, next) => {
  ctx.state.commonData = '中间件:公共信息配置,其中commonData是随意起的名字';
  ctx.state.commonData2 =
    '中间件2:公共信息配置,其中commonData2是随意起的名字';
  // 要显式向下继续执行
  await next();
});

// 配置首页模版信息
router.get('/', async ctx => {
  const title = 'Hello world !';
  const list = ['Charles', 'Jack', 'Black', 'Lusy'];

  /**
   * 利用上下文的render函数渲染匹配到的文件
   * index:匹配的中间件views文件夹下的文件名,后缀是.html或.ejs
   * {title,list}:匹配的文件中使用的变量
   */
  await ctx.render('index', { title, list });
});

router.get('/news', async ctx => {
  await ctx.render('news', {});
});

router.get('/html', async ctx => {
  ctx.type = `text/html;charset=utf-8`;
  ctx.body = testTpl;
});

//启动路由
app.use(router.routes());
app.use(router.allowedMethods());

app.listen(3000);

重启node,刷新浏览器


输入对应的/news/html也能看到对应的内容,完美!。
到这里,koa模版渲染中间件的基本使用就完成了。

Ps

模版文件报错,要注意模版文件中路径的引入

  /*
  出现类似这个错误:
      SyntaxError: Unexpected token . in /PATH/index.ejs while compiling ejs  
If the above error is not helpful, you may want to try EJS-Lint:
https://github.com/RyanZim/EJS-Lint
Or, if you meant to create an async function, pass `async: true` as an option.
  是写法  <% include ../PATH/files.ejs %> 导致
  要改成 <%- include('../PATH/files.ejs') %>

  而且模版文件不能写注释: <!-- 注释内容 -->
*/

下一节

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,640评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,254评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,011评论 0 355
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,755评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,774评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,610评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,352评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,257评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,717评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,894评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,021评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,735评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,354评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,936评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,054评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,224评论 3 371
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,974评论 2 355