Award

Edit

自定义server服务

开始

Award提供的基于API形式的启动服务，区别于命令行形式

server.js

const Server = require('award/server');

// 实例化，获取app，构造函数接收对象
const app = new Server({
  ...
});

// 监听端口
app.listen(3000);

开发 node server.js dev

需添加dev参数

# 内置了mock
$ node server.js dev

断点调试 node server.js debug

⚠️ vscode需要进行如下设置

  1. 项目根目录创建.vscode文件夹，这个是vscode的配置文件所在的文件夹

  2. 在.vscode创建settings.json文件

    // settings.json文件内容
{
  "debug.javascript.autoAttachFilter": "onlyWithFlag",
}

  3. 可以进行如下操作，开启vscode的断点调试了

    • 命令行启动：执行award-debug dev命令

    • Api启动：执行node server.js debug

编译后，部署启动

$ node server.js

Server构造函数参数说明

参数说明类型默认值
isProxy标识是否启用proxy获取数据booleanfalse
port指定当前服务器的端口号number1234
ignore忽略显示系统默认错误，仅在开发环境生效，主要用于错误页面开发booleanfalse

中间件

通过app.core()区分了，award核心中间件执行之前和之后进行自定义中间件的添加

app.use接收koa形式的中间件写法，同时也接受引用相对地址

通过相对地址的引用，award内部可以对其实现热更新

...

// 这种引用，不会热更新，需要重启服务
app.use(async (ctx, next) => {
  console.log('start', ctx.path);
  await next();
});

// 当use引用相对地址文件，或者数组的时候，开发模式会对中间件热更新
app.use('./middleware.js');

// 一旦执行了app.core()
// 那么其代码后面use引用的中间件，将会在Award核心中间件执行完触发
app.core();

// 也可以是数组形式的多个文件引用
app.use(['./middleware.js']);

// 引用的文件模块，支持返回数组形式的中间件，也可以单独导出中间件
app.use('./a.js');

// a.js内容如下
module.exports = [mid1, mid2];

// OR
module.exports = mid1;


...

日志处理

禁用console.log

为了提升服务端运行性能，award禁用了服务端的所有console.log的执行

不过console的其他函数可以执行，请慎用，防止出现性能问题

正常使用console.log

Award提供了日志打印过滤器，仅在生产环境生效

通过日志打印过滤器，过滤出需要打印的日志


...

// 那么console.log的第一个参数是 
// show或者test的都将在终端进行console.log打印
app.logFilter('show', 'test');

app.use(async (ctx, next) => {
  await next();
  if (ctx.award) {
    const url = ctx.request.url;
    console.log(
      'show',
      `[user-agent]${url}: ${ctx.request.headers['user-agent']}`,
    );
    console.log('show', 'test', `[host]${url}: ${ctx.request.headers.host}`);
    console.log('show', '[renderTime]' + url, ctx.renderTime);
    console.log('test', '[responseTime]' + url, ctx.responseTime);
  }
});

...

自动打开Chrome

如果没有做任何设置，启动服务后，award内部会自动打开Chrome浏览器

同时会访问指定的端口，如果需要打开自定义的页面怎么处理呢？

通过app.listen第二个参数，执行回调，通过open打开浏览器

// node server.js dev
const Server  = require('award/server');

const app = new Server();

app.listen(1234, (listen, url, open) => {
  open('http://dev.example.com:1234/');
});

终极错误捕获及自定义处理

这里统一处理node服务端的每次产生的错误，即这个地方就是node服务的错误边界

  • 开发者可以根据node产生的错误进行自定义过滤出来
  • 回调参数的error对象数据仅生产环境生效
  • 如果没有将errLogs返回，那么将不会打印错误日志
...

app.catch((errLogs, ctx) => {
  // 处理errLogs是否落盘逻辑，对errLogs的字段进行判断处理
  // 根据业务需求，确认是否需要需要返回errLogs，将errLogs落盘到日志
  // 如果不需要落盘日志，可以不返回，或者返回null
  // ctx 表示当前发生错误的请求的上下文
  return errLogs
})

...
Last updated on 2021-7-22 by topthinking
← DOM文档组件生产环境部署 →