Node.js之readline模块的使用详解
什么是readline
readline允许从可读流中以逐行的方式读取数据,比如process.stdin等。 在node.js命令行模式下默认引入了readline模块,但如果是使用node.js运行脚本的话,则需要自己通过require('readline')方式手动引入该模块。
怎么使用readline
创建实例
首先、创建一个接口实例,提供一个object类型的参数。参数如下: input: 监听的可读流(必需) output: 写入readline的可写流(必需) completer: 用于 tab 自动补全的可选函数(不常用) terminal: 如果希望 input 和 output 流像 tty 一样对待,那么传递参数 true ,并且经由 ansi/vt100 转码。 默认情况下检查 istty 是否在 output 流上实例化。(不常用) historysize: 保留行历史纪录最大值,为了禁用该值被设置为0,默认为30,只有在terminal被设置为true或通过一个内部输出检查时,这个选项才有作用,否则历史缓存机制不会初始化。(不常用)
第一种方式:只传入两个必传参数
const readline = require('readline'); let rl = readline.createinterface(process.stdin, process.stdout);
第二种方式:可以传入其他非必需参数
const readline = require('readline'); let rl = readline.createinterface({ input: process.stdin, output: process.stdout, // 其他参数省略 })
实例
const readline = require('readline'); let rl = readline.createinterface({ input: process.stdin, output: process.stdout, prompt: '> 请输入' }) // 调用 rl.prompt(); // 控制台结果显示:>请输入
注意:一旦该代码被调用,node.js程序将不会终止知道readline接口被关闭,因为接口会在输入流中不停的等待数据。
方法
以下所有的实例均依据如下rl所创建:
const readline = require('readline'); let rl = readline.createinterface({ input: process.stdin, output: process.stdout })
1、rl.setprompt([prompt])
设置提示符,当你使用node运行该文件,并且调用rl.prompt()时,会在终端看到你设置的提示prompt,即“> 请输入”
rl.setprompt('> 请输入')
注意:该方法和上面的实例参数配置是一样的效果
2、rl.prompt([preservecursor])
为用户输入准备好readline,将现有的setprompt选项放到新的一行,让用户有一个新的地方开始输入。将preservecursor设为true来防止光标位置被重新设定成0。 如需要换行输入,即在新的一行,输入信息,可在prompt中加入\n。
rl.prompt(); // 控制台结果显示:>请输入
3、rl.write(data[, key])
当使用readline.createinterface()创建实例时,,如果输入流为null或者undefined,则写入数据到输出流。 key是一个表示键序列的字面量对象,如果终端是tty,则可用。
rl.write('delete me!'); // simulate ctrl+u to delete the line written previously rl.write(null, {ctrl: true, name: 'u'});
4、rl.question(query, callback)
预先制定提示内容query,将会在用户输入被应答后,触发执行指定的回掉函数callback。
rl.question('你今年多大了?\n', function(prompt) { console.log('这是你输入的回答结果:' + prompt); rl.close(); })
5、rl.pause()
暂停readline的输入流,可以恢复,rl.resume()、rl.write()、rl.question()和rl.prompt()均可以恢复该输入流。 调用该方法会触发pause事件。
6、rl.resume()
恢复readline的输入流。 调用该方法会触发resume事件。
7、rl.close()
关闭readline创建的实例,不控制输入输出流。 调用该方法会触发close事件。
事件
1、line事件
无论何时,在输入流接收了一个行结束符(\n, \r, 或者 \r\n)时触发,即在用户输入后,按了回车或者返回键时触发该事件。可以用来监听用户输入。
rl.on('line', function (line) { console.log('这是用户输入的内容:' + line); })
2、pause事件
输入流被暂停时触发,即调用了rl.pause(),或者没有暂停输入流,在收到sigcont/sigint,且readline.interfacce实例上并没有注册sigcont/sigint监听器时,也会被触发,并且如果输入流在收到sigtsip之前就已经被暂停了,那么该事件也不会触发。
rl.on('pause', function() { console.log('暂停输入流...') })
3、resume事件
输入流重新启动时被触发,即调用了rl.resume()、或者rl.write()、rl.question()和rl.prompt()。
rl.on('resume', function() { console.log('恢复输入流...') })
4、close事件
调用rl.close()方法时会触发该事件,或者输入流接收到“结束”事件。以下的任意一种情况都会触发close事件。 一旦close事件被触发,则认为readline.interaface实例已经终止。 1)、rl.close()方法被调用后,readline.interaface实例便会放弃输入输出流的控制权。 2)、输入流接收到自己的“end”事件。 3)、输入流接收到-c,发送sigint信号,并且在readline.interfacce实例上并没有注册sigint事件的监听器。 4)、输入流接收到-d,发送传输结束信号(eof,end-of-transmission); 5)、eot:定界符,即输入单个或多个“>”,并按下回车时。
rl.on('close', function() { console.log('关闭输入流...'); process.exit(0); // 退出当前进程 })
5、sigcout(该事件在window系统上不起作用)
当使用-z将node.js进程移动到后台时,sigcont事件将会被触发。然后可以使用 fg(1) 命令将它移动到前台。 如果输入流在收到sigtsip之前就已经被暂停了,那么该事件就不会触发。
6、sigint
当输入流收到-c命令时,我们熟知的sigint事件就会被触发。如果当时并没有注册任何sigint事件监听器,那么当输入流接收到sigint信号时,'pause'事件和'close'事件均会被触发。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。