fs.watch() 在 Node v13 中是否损坏或者我做错了什么？

Question

我一直在尝试设置一个文件观察器来检测何时将新数据添加到文件中。一般顺序是 1.) 客户端连接到服务器。 2.）服务器日志到文件。 3.) fs.watch() 检测到文件已更改并运行一个函数，在这种情况下是一个简单的console.log('New log entry')

除了fs.watch() 没有检测到新消息何时添加到日志文件之外，一切似乎都正常。但是，如果我单击 VScode 中的日志文件，它似乎会触发它。这是较新版本的 Node 中的错误还是我在这里做错了什么？

我意识到我可以使用fs.watchFile()，但我希望避免轮询的开销......

// src/index.js
const path = require('path');
const express = require('express');
const app = express();
const server = require('http').createServer(app);
const io = require('socket.io')(server);
const logger = require('./logger');
const fs = require('fs');

fs.watch('./logs/combined.log', (event) => {
  if (event === 'change') {
    console.log('New log entry');
  }
});

app.use(express.static(path.join(__dirname, '../public')));
app.get('/', function(req, res, next) {
  res.sendFile(path.join(__dirname, '../public', 'index.html'));
});

io.on('connection', function(socket) {
  logger.info('a user connected');
});

const PORT = process.env.PORT || 8888;

server.listen(PORT, () => {
  logger.info(`Listening at http://localhost:${port}`);
});

-

// src/logger.js
const winston = require('winston');

const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    new winston.transports.File({ filename: 'logs/combined.log' })
  ]
});

module.exports = logger

-

// public/index.html
<script src="/socket.io/socket.io.js"></script>
<script>
  var socket = io.connect('http://localhost:8888');
</script>

-

// simplified test
const logger = require('./logger');
const fs = require('fs');

fs.watch('./logs/combined.log', event => {
  if (event === 'change') {
    console.log('log file has updated');
  }
});

function intervalFunc() {
  logger.info('new log message');
}
setInterval(intervalFunc, 5000);

Answer 1

fs.watch 的节点文档有一个完整的 Caveats 部分，一开始就说明：

fs.watch API 并非 100% 跨平台一致，而是 在某些情况下不可用。

您应该阅读该部分以了解更多信息，但如果您无法让 fs.watch 为您可靠地工作，您最终可能不得不使用 fs.watchfile。

[更新]

Caveats 部分的 Filename Argument 小节也说明了这一点：

即使在受支持的平台上，filename 也不一定总是 假如。因此，不要假设 filename 参数总是 在回调中提供，如果是null，则有一些回退逻辑。

由于您不需要使用 filename 参数（而且您已经知道文件名），因此您的回调不应测试真实的 filename 参数。

Answer 2

更新：

所以它@98​​7654321@。这些监听器的行为类似于文件监听器，并允许您挂钩某些事件。您可以挂钩的事件之一称为“数据” - 这使您可以监听数据何时写入文件，并运行回调函数。

这提供了与file.watch 类似的行为。

它们允许您监听以下事件：

• 关闭
• 数据
• 结束
• 错误
• 可读

我在 Windows 上进行了测试，它运行良好。

这是我正在使用的测试文件：

const winston = require('winston');

const { createLogger, format: { json }, transports: { File } } = winston;

const logger = createLogger({
  level: 'info',
  format: json(),
  transports: [
    new File({ filename: './log.txt' })
  ],  
});

/**
 * Added a built in Winston listener
 */
logger.addListener('data', chunk => {
    console.log('\r\n[winston listener] we have logged some data:\n', chunk)
})

/**
 * Their documentation seems to use the `.on` method.
 * 
 * This appears to provide the same type of behavior that `.addListener` does.
 * 
 * I'm not sure which is best, or recommended, `.addListener` or `.on` - you
 * may want to dig deeper into that.
 */
logger.on('data', chunk => {
    console.log('\r\n[winston on "data"] we have logged some data:\n', chunk);
});

setInterval(() => {
  logger.info('new log message');
}, 5000);

---

所以我一直在考虑这个问题，起初我认为这是因为 Winston 使用写入流来更新文件..

然后我继续尝试复制您的问题，但我无法复制它。

每次更新日志文件时，都会向控制台写入一条消息（意味着fs.watch 正在工作。

您使用的是 Windows 吗？您使用的是哪个版本的 Node？​​p>

这是我正在使用的测试文件：

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

const { createLogger, format: { json }, transports: { File } } = winston;

const logger = createLogger({
  level: 'info',
  format: json(),
  transports: [
    new File({ filename: './log.txt' })
  ]
});

fs.watch('./log.txt', event => { 
  if (event === 'change') {
    console.log('log file has updated');
  }
});

setInterval(() => {
  logger.info('new log message');
}, 5000);