事件监听(Event Listening)在 Web3 开发中扮演着"报警器"的角色。它的主要工作是:当区块链上的智能合约触发了某个动作时,实时通知你的前端网页或后端程序。
由于区块链的交易打包需要时间(通常几秒到十几秒),你不能像调用传统 API 那样立即得到结果。监听就是解决这种"异步性"的最佳方案。
1. 它是如何工作的?
监听本质上是你的程序与区块链节点(RPC Node)建立了一个长连接(通常是 WebSocket)。
- 合约内 :执行某个函数,触发出
emit MyEvent()。 - 节点:捕获到这个日志。
- ethers.js:通过连接接收到通知,并执行你预设的回调函数。
2. ethers.js 监听代码示例
在 ethers.js v6 中,监听非常直观。假设你有一个转账事件 Transfer(address from, address to, uint256 value)。
全局监听(听所有转账):
javascript
// 语法:contract.on("事件名", 回调函数)
contract.on("Transfer", (from, to, value, event) => {
console.log(`收到新转账!`);
console.log(`从: ${from} 到: ${to} 金额: ${ethers.formatEther(value)} ETH`);
// event 对象包含更多细节,如交易哈希、区块号等
console.log(`交易哈希: ${event.log.transactionHash}`);
});
带过滤的监听(只听发给"我"的转账):
如果你只想关注和你有关的交易,可以使用 Filters(过滤器):
javascript
const myAddress = "0xYourAddress...";
// 创建过滤器:只有当 'to' 参数等于 myAddress 时才触发
const filter = contract.filters.Transfer(null, myAddress);
contract.on(filter, (from, to, value) => {
console.log(`有人给我转账了 ${ethers.formatEther(value)} ETH!`);
});
3. 监听的注意事项
-
网络连接类型 :监听通常需要 WebSocket (WSS) 连接(例如
wss://eth-mainnet.g.alchemy.com/...)。普通的 HTTP 连接不支持实时推送,ethers.js 可能会退化为频繁的轮询(Polling),效率较低。 -
停止监听:为了防止内存泄漏,当你不再需要监听时(比如用户关闭了弹窗),记得关闭它:
-
contract.off("Transfer"):停止特定事件。 -
contract.removeAllListeners():停止所有监听。 -
一次性监听 :如果你只想等某个动作发生一次(比如等待部署后的第一次初始化),可以使用
contract.once。
4. 为什么不用"轮询"变量值?
有些开发者会想:我写个 setInterval 每秒查一次余额不行吗?
- 浪费资源:频繁调用节点 API 可能会触发频率限制(Rate Limit)。
- 延迟高:轮询可能有 1-2 秒的滞后。
- 用户体验差:用户在网页上点完按钮,你无法精准地在交易成交的那一刻给出反馈。
总结
- 状态变量 :是合约的大脑(存储数据)。
- 事件监听 :是合约的嘴巴(对外广播)。