JavaScript实现模板文件属性替换及保存函数的方法

作为经常处理这类需求的开发者，我给你一个基于Node.js核心模块的实现方案，完全不用额外依赖，新手也能轻松理解：

核心思路 #

咱们要做的就是三步：

• 读取服务器上的模板文件内容
• 匹配模板里的key = value格式属性，替换成传入变量对应的值
• 将替换后的内容写入新文件路径

异步实现（推荐，服务器端优先用异步避免阻塞） #

用fs.promises结合async/await，代码可读性更高：

// 引入Node.js核心模块，处理文件和路径
const fs = require('fs').promises;
const path = require('path');

/**
 * 替换模板文件属性并保存到新路径
 * @param {string} templatePath - 模板文件的路径
 * @param {string} newFilePath - 新文件要保存的路径
 * @param {object} variables - 替换用的变量，格式如 { name: 'hello', source: 'source1' }
 */
async function replaceTemplateAndSave(templatePath, newFilePath, variables) {
  try {
    // 1. 读取模板文件内容，指定utf8编码避免Buffer格式
    const templateContent = await fs.readFile(path.resolve(templatePath), 'utf8');

    // 2. 用正则匹配并替换属性：匹配`key = 任意内容`的格式
    // 正则解释：(\w+) 匹配属性名（字母数字下划线），\s*=\s* 匹配等号前后的空格，.+? 匹配属性值（非贪婪模式）
    const updatedContent = templateContent.replace(/(\w+)\s*=\s*.+/g, (match, key) => {
      // 如果变量里有对应的key，就替换成新值，否则保留原内容
      return variables.hasOwnProperty(key) ? `${key} = ${variables[key]}` : match;
    });

    // 3. 将替换后的内容写入新文件，不存在的话会自动创建，存在则覆盖
    await fs.writeFile(path.resolve(newFilePath), updatedContent, 'utf8');

    console.log('文件替换并保存成功！');
  } catch (error) {
    // 捕获并处理错误，比如文件不存在、权限问题等
    console.error('操作失败：', error.message);
    throw error; // 可以选择抛出错误让调用者自行处理
  }
}

// 示例调用
replaceTemplateAndSave('./template.txt', './new-file.txt', {
  name: 'hello',
  source: 'source1'
});

同步实现（适合简单场景，但会阻塞事件循环） #

如果你的场景非常简单，也可以用同步版本，但服务器端不推荐频繁使用：

const fs = require('fs');
const path = require('path');

function replaceTemplateAndSaveSync(templatePath, newFilePath, variables) {
  try {
    const templateContent = fs.readFileSync(path.resolve(templatePath), 'utf8');
    const updatedContent = templateContent.replace(/(\w+)\s*=\s*.+/g, (match, key) => {
      return variables.hasOwnProperty(key) ? `${key} = ${variables[key]}` : match;
    });
    fs.writeFileSync(path.resolve(newFilePath), updatedContent, 'utf8');
    console.log('文件替换并保存成功！');
  } catch (error) {
    console.error('操作失败：', error.message);
    throw error;
  }
}

// 示例调用
replaceTemplateAndSaveSync('./template.txt', './new-file.txt', {
  name: 'hello',
  source: 'source1'
});

注意事项 #

• 确保模板文件里的属性格式是key = value（等号前后可以有空格），如果格式不一样，需要调整正则表达式
• 变量对象的键要和模板里的属性名完全一致（比如模板里是name，变量里也要是name）
• 用path.resolve()处理路径可以避免相对路径的坑，尤其是在不同目录下运行脚本时
• 错误处理很重要，要捕获文件读取/写入时的异常（比如文件不存在、没有权限等）

内容的提问来源于stack exchange，提问作者mi.mo