如何在 Node.js 中基于条件向文件追加注解(如 @Circuit)

落杰同学_6599

落杰同学_6599

2026-10-09

832人浏览

原创

如何在 Node.js 中基于条件向文件追加注解(如 @Circuit)

本文介绍使用 Node.js 的 readline 模块逐行读取 Java 文件,当检测到包含 createEvent 且未存在 @Circuit(name = backendB) 注解的行时,在该行末尾自动插入注解;若全文件未匹配,则在文件末尾追加该注解。

本文介绍使用 node.js 的 `readline` 模块逐行读取 java 文件,当检测到包含 `createevent` 且未存在 `@circuit(name = backendb)` 注解的行时,在该行末尾自动插入注解;若全文件未匹配,则在文件末尾追加该注解。

在 Node.js 中处理大文件或需精确控制行级逻辑的场景下,直接读取整个文件(如 fs.readFileSync)可能导致内存压力,而基于流(Stream)配合 readline 模块是更健壮、内存友好的方案。它允许我们以行为单位高效解析内容,并在匹配条件时进行精准修改。

核心思路如下:

  • 使用 fs.createReadStream 读取源文件;
  • 通过 readline.createInterface 创建逐行读取接口;
  • 遍历每一行,检查是否同时满足两个条件:
    ✅ 包含 createEvent 字符串;
    ❌ 不包含目标注解 @Circuit(name = backendB);
  • 若满足,则用正则将 createEvent 替换为 createEvent @Circuit(name = backendB)(保持原有结构,避免误改方法签名);
  • 全程维护一个标志位 annotationAdded,用于跟踪是否已注入注解;若遍历结束仍未添加,则在输出文件末尾追加一行注解。

以下是完整可运行的实现代码:

Browser Js
Browser Js

轻量级CDP浏览器控制,适用于AI代理。相较于内置浏览器工具,token消耗降低3‑10倍,仅在浏览时使用。

下载
const fs = require('fs');
const readline = require('readline');

async function appendData() {
  const file_path = './File/controller.java';
  const output_path = './FileUpload/auditcontroller_test.java';
  const annotation = '@Circuit(name = backendB)';

  const readstream = fs.createReadStream(file_path);
  const writestream = fs.createWriteStream(output_path);
  const rl = readline.createInterface({
    input: readstream,
    crlfDelay: Infinity, // 支持 \r\n 和 \n 换行符
  });

  let annotationAdded = false;

  try {
    for await (const line of rl) {
      let updatedLine = line;

      // 精准匹配:行中含 createEvent 但不含已有注解
      if (line.includes('createEvent') && !line.includes(annotation)) {
        // 在 createEvent 后插入注解(不破坏原有空格与参数)
        updatedLine = line.replace(/(createEvent\s*\()/, `$1 ${annotation} `);
        annotationAdded = true;
      }

      writestream.write(updatedLine + '\n');
    }

    // 若全文未命中,追加到文件末尾(可选策略,按需启用)
    if (!annotationAdded) {
      writestream.write(`${annotation}\n`);
    }
  } catch (err) {
    console.error('处理文件时发生错误:', err);
    throw err;
  } finally {
    readstream.destroy();
    writestream.end();
  }
}

// 调用函数
appendData();

⚠️ 注意事项:

  • 此方案默认不覆盖原文件,而是写入新路径(output_path),推荐先验证结果再替换原文件,避免误操作;
  • 正则 /createEvent\s*\(/ 更安全地匹配 createEvent( 形式(常见于方法定义),避免误匹配变量名或字符串字面量;若需更严格语义分析(如仅匹配方法声明),建议结合 AST 解析器(如 javacc 或 tree-sitter);
  • readline 在 Node.js ≥12.0 中原生支持 for await...of,确保运行环境兼容;
  • 流关闭使用 destroy() 和 end() 显式管理,避免资源泄漏。

该方法兼顾性能、可读性与可靠性,适用于自动化构建流程、CI/CD 中的代码增强场景。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js node.js node

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4646

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1149

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4564

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

920

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1816

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3305

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4313

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2800

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习