详解使用抽象语法树AST实现一个AOP切面逻辑

使用抽象语法树AST实现AOP切面逻辑可以让我们在代码运行前或运行后织入一些额外的逻辑，以达到对代码进行横向扩展不修改代码本身的目的。下面是使用AST实现AOP切面逻辑的攻略。

什么是AST？

抽象语法树（Abstract Syntax Tree，AST）是一种树状结构，表示编程语言的语法结构。在编译期间，编译器会将源代码转换为AST，用于后续的代码生成等操作。AST节点包含了源代码中的语法信息，可以通过遍历AST树来获取源代码的信息。

AST工具库

在Javascript中，可以使用Esprima等AST解析库对源代码进行解析，获取AST树。在这里，我们将使用Esprima作为AST工具库。

实现步骤

1. 解析源代码，获取AST树

const esprima = require('esprima');
// source是源代码
const AST = esprima.parseScript(source);

1. 遍历AST树，找出需要织入切面逻辑的节点

const estraverse = require('estraverse');

estraverse.traverse(AST, {
  enter: (node, parent) => {
    // 判断节点类型，找到需要织入切面逻辑的节点
  }
});

1. 插入切面逻辑

const aopCode = `
  // 切面逻辑代码
`;

const injectCode = `
  try {
    ${aopCode}
    // 原代码逻辑
  } catch(err) {
    // 异常处理
  }
`;

// 原节点代码
const beforeCode = source.substr(0, node.start);
const afterCode = source.substr(node.end);
const modifiedCode = `${beforeCode}${injectCode}${afterCode}`;

// 将修改后的代码解析为AST树
const modifiedAST = esprima.parseScript(modifiedCode);

1. 生成新的代码

const escodegen = require('escodegen');

const newSource = escodegen.generate(modifiedAST);

示例

下面是一个简单的示例，实现将函数调用时间打印在控制台上的切面逻辑。

原代码：

function test() {
  console.log('test');
}

test();

修改后代码：

function test() {
  console.log('test');
}

try {
  console.time('test');
  test();
  console.timeEnd('test');
} catch (err) {
  console.error(err);
}

下面的代码实现了将代码中所有的函数调用时间打印在控制台上。

const esprima = require('esprima');
const estraverse = require('estraverse');
const escodegen = require('escodegen');

const source = `
function test() {
  console.log('test');
}

test();
`;

const AST = esprima.parseScript(source);

estraverse.traverse(AST, {
  enter: (node, parent) => {
    if (node.type === 'CallExpression' && node.callee.type === 'Identifier' && node.callee.name !== 'console') {
      const aopCode = `
        console.time('${node.callee.name}');
        ${escodegen.generate(node)}
        console.timeEnd('${node.callee.name}');
      `;

      const injectCode = `
        try {
          ${aopCode}
        } catch (err) {
          console.error(err);
        }
      `;

      const beforeCode = source.substr(0, node.start);
      const afterCode = source.substr(node.end);
      const modifiedCode = `${beforeCode}${injectCode}${afterCode}`;

      const modifiedAST = esprima.parseScript(modifiedCode);
      node = modifiedAST.body[0].expression.arguments[0];
    }
  }
});

const newSource = escodegen.generate(AST);
console.log(newSource);

运行上面的代码，控制台输出：

console.time('test');
test()
console.timeEnd('test');