首页 > 其他分享 >5-5 命令行交互原理

5-5 命令行交互原理

时间:2022-12-30 11:45:18浏览次数:79  
标签:function const name x1B 命令行 output 原理 交互 input

1 学习路径

  • 掌握
    • readline -- 输入流
    • events -- 实现 nodejs 事件流
    • stream -- 输入输出流
    • ansi-escapes -- 实现命令行的特殊显示
    • rxjs -- 响应式模型库
  • 掌握命令行交互的实现原理,并实现一个可交互的列表
  • 分析 inquirer 源码掌握其中的关键实现

2 readline 的使用方法和实现原理

逐行读取,该模块提供了一个接口,用于一次一行地从 可读流 中读取数据

2.1 核心用法

const readline = require('readline');

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
})

rl.question('your name: ', (answer => {
  console.log(answer);
  rl.close()
}))

2.2 readline 源码分析

1. 强制将函数转换为构造函数

if(!(this instanceof Interface)) {
  return new Interface(input, output, completer, terminal)
)

2. 继承 EventEmitter

  • 使函数具备事件驱动能力
EventEmitter.call(this);

3. readline键盘输入监听实现原理

  • 关键事件 emitKeyPressEvents()
bak:generator 函数
function* g() {
  console.log('read');
  const ch = yield;
  console.log(ch);
}
const f = g()
console.log(f); // Object [Generator] {}
// 关键点1:使用 next() 执行函数
f.next()
// 关键点2:调用 next() 继续执行yield之后的代码
f.next('a')

4. readline 核心实现原理

注:readline 利用 Generator 函数的特性
Generator 函数语法

Generator 函数
  • Generator 函数是分段执行的,yield 表达式是暂停执行的标记,而 next 方法可以恢复执行

2.3 手写 readline 核心实现

1. 基础架构
function stepRead(callback) {
  const input = process.stdin
  const output = process.stdout
  let line = '' // 存储用户输入的信息
  function onkeypress(s) {
    output.write(s)
  }
  emitKeypressEvents(input)
  input.on('keypress', onkeypress)
  input.setRawMode(true) // 逐个监听
  input.resume()
}
function emitKeypressEvents(stream) {
  function onData(chunk) {
    g.next(chunk.toString())
  }
  const g = emitKeys(stream)
  g.next()
  stream.on('data', onData) // 暂停执行
}
function* emitKeys(stream) {
  while(true) {
    let ch = yield
    stream.emit('keypress', ch)
  }
}
stepRead()
2. 处理各种用户输入的场景
function onkeypress(s) {
  output.write(s)
  line += s
  switch(s) {
    case '\r':
      input.pause()
      callback(line)
      break
  }
}
stepRead(function(s) {
  console.log('answer: ' + s);
})
3. 总结
  1. 获取输入输出流
const input = process.stdin
const output = process.stdout
  1. 存储输入的信息 line

  2. 使用 generator + 绑定输入流--监听用户输入

emitKeypressEvents(input)
function emitKeypressEvents(stream) {
  function onData(chunk) {
    g.next(chunk.toString())
  }
  const g = emitKeys(stream)
  g.next()
  stream.on('data', onData) // 重要:绑定输入流--监听用户输入
}
function* emitKeys(stream) {
  while(true) {
    let ch = yield
    stream.emit('keypress', ch)
  }
}
  1. 打印输入的内容 + 监听用户输入'回车'就终止
input.on('keypress', onkeypress)
function onkeypress(s) {
  // 打印输入的内容
  output.write(s)
  line += s
  // 监听用户输入'回车'就终止input执行
  switch(s) {
    case '\r':
      input.pause()
      callback(line)
      break
 }
}

3 命令行样式修改的核心原理:ansi转移序列

ansi-escape-code 查阅文档

3.1 color

  • console.log('\x1B[41m%s\x1B[0m', 'your name:');

数值41 0 表示改变的color

3.2 CSI 序列

  • console.log('\x1B[2B%s', 'your name2:');

2B 表示光标下移2行

4 响应式库 rxjs

  • 将数据处理与展示分离
const { range } = require('rxjs');
const { map, filter } = require('rxjs/operators');
 
const pipe = range(1, 200).pipe(
  filter(x => x % 2 === 1),
  map(x => x + x),
  filter(x => x % 3 === 0)
)

pipe.subscribe(x => console.log(x));
pipe.subscribe(x => console.log(x + 1));

5 手写命令行交互式列表组件

  • 实现原理

5.1 准备 options

const option = {
  type: 'list',
  name: 'name',
  message: 'select your name:',
  choices: [
    { name: 'zmoon', value: 'zmoon' },
    { name: 'zhangsan', value: 'zhangsan' },
    { name: 'lisi', value: 'lisi' }
  ]
}

5.2 inquirer.Prompt() 返回promise对象

function Prompt(option) {
  return new Promise((resolve, reject) => {
    try {
      const list = new List(option)
      list.render() // 渲染列表
    } catch(e) {
      reject(e)
    }
  })
}
Prompt(option).then(answers => {
  console.log(answers);
})

5.3 交互列表组件

class List extends EventEmitter {
  constructor(option) {}
  // 关键:处理用户输入的信息
  onkeypress = (keymap) => {}
  // 实现列表渲染
  render() {}
  // 关键:渲染用户输入的信息
  getContent() {}
  // 清屏
  clean() {}
}

1. constructor

  1. 继承 events 类 -- 实现 nodejs 事件流
  2. MuteStream 实例化 -- 使得输出可控
  3. 获取输入输出流
  4. readline 实例化 -- 逐行读取
  5. 键盘事件监听
  6. 参数解析
constructor(option) {
  super()
  this.name = option.name
  this.message = option.message
  this.choices = option.choices
  this.input = process.stdin
  // 使得输出可控 -- mute-stream
  const ms = new MuteStream()
  ms.pipe(process.stdout)
  this.output = ms
  this.rl = readline.createInterface({
    input: this.input,
    output: this.output
  })
  this.selected = 0
  this.height = 0
  this.keypress = fromEvent(this.rl.input, 'keypress')
    .forEach(this.onkeypress)
  this.haveSelected = false; // 是否已选择完毕
}

2. 实现列表渲染

  1. 解除对 output 的禁用
  2. 清屏
  3. 生成打印内容 -- this.getContent()
  4. 打印内容
  5. 禁用 output
render() {
  this.output.unmute()
  this.clean()
  this.output.write(this.getContent())
  this.output.mute()
}

3. 关键:渲染用户输入的信息

getContent() {
  if(!this.haveSelected) {
    let title = this.message + '(Use arrow keys)'
    this.choices.forEach((choice, index) => {
      if(index === this.selected) {
        // 判断是否为最后一个元素,如果是则不加\n
        if(index === this.choices.length - 1) {
          title += '> ' + choice.name
        } else {
          title += '> ' + choice.name + '\n'
        }
      } else {
        if(index === this.choices.length - 1) {
          title += '  ' + choice.name
        } else {
          title += '  ' + choice.name + '\n'
        }
      }
    })
    return title
  } else {
    // 输入结束后的逻辑
  }
}
添加特殊显示
  • let title = '\x1B[32m?\x1B[39m \x1B[1m' + this.message + '\x1B[22m\x1B[0m\x1B[0m\x1B[2m(Use arrow keys)\x1B[22m\n'
if(index === this.choices.length - 1) {
  title += '\x1B[36m> ' + choice.name + '\x1B[39m'
} else {
  title += '\x1B[36m> ' + choice.name + '\n' + '\x1B[39m'
}

4. 关键:处理用户输入的信息

  1. up down 按键 ?
  • 是则更新 selected
  1. enter 按键 ?
  2. 是则关闭输入流
  3. 设置 haveSelectedtrue
  4. 列表渲染
  5. emit exit
onkeypress = (keymap) => {
  const key = keymap[1];
  if(key.name === 'down') {
    this.selected++
    if(this.selected > this.choices.length - 1) {
      this.selected = 0
    }
    this.render()
  } else if(key.name === 'up') {
    this.selected--
    if(this.selected < 0) {
      this.selected = this.choices.length - 1
    }
    this.render()
  } else if(key.name === 'return') {
    this.haveSelected = true
    this.render()
    this.close()
    this.emit('exit', this.choices[this.selected])
  }
}
function Prompt(option) {
  return new Promise((resolve, reject) => {
    try {
      const list = new List(option)
      list.render() // 渲染列表
      list.on('exit', answers => {
        resolve(answers)
      })
    } catch(e) {
      reject(e)
    }
  })
}

5. 清屏

clean() {
  // 生成空行数量
  const emptyLines = ansiEscapes.eraseLines(this.height)
  this.output.write(emptyLines)
}
getContent() {
  // ...
  this.height = this.choices.length + 1
  return title
}

6. 输入结束后的逻辑

getContent() {
  if(!this.haveSelected) {
    // ...
  } else {
    const name = this.choices[this.selected].name
    let title = '\x1B[32m?\x1B[39m \x1B[1m' + this.message + '\x1B[22m\x1B[0m\x1B[0m\x1B[36m' + name + '\x1B[39m\x1B[0m\n'
    return title
  }
}
onkeypress = (keymap) => {
  // ...
  // if() {}...
  // else if(key.name === 'return') {
    this.haveSelected = true
    this.render()
    this.close()
    this.emit('exit', this.choices[this.selected])
  // }
}
close() {
  this.output.unmute() // 解除对output的禁用
  // 结束readline 输入流
  this.rl.output.end()
  this.rl.pause() // 使当前rl停止监听
  this.rl.close()
}

标签:function,const,name,x1B,命令行,output,原理,交互,input
From: https://www.cnblogs.com/pleaseAnswer/p/17014511.html

相关文章

  • 手撕fft算法--fft原理和源码解析
    一前言 在音频信号处理中,fft变换是一个无法绕过过去的存在。借着一次算法出来的机会,把fft熟悉一下不为过啊。 二问题 这里,其实是由一个问题驱动的,那......
  • Double Machine Learning(DML) 原理及其应用
    DoubleMachineLearning(DML)原理及其应用​​1.为什么需要DML?​​​​2.DML原理​​​​2.1符号定义​​​​2.2DML训练过程​​​​2.3为什么残差正交化可得到无偏......
  • Flutter异常监控 - 贰 | 框架Catcher原理分析
    前言在给Flutter应用做异常监控的时候,一开始我是拒绝滴,如果不考虑FlutterEngine和native侧的监控,用我另一篇文章中不得不知道的Flutter异常捕获知识点提到的方......
  • Dubbo 3 之 Triple 流控反压原理解析
    作者:顾欣Triple是Dubbo3提出的基于HTTP2的开放协议,旨在解决Dubbo2私有协议带来的互通性问题。Triple基于HTTP/2定制自己的流控,支持通过特定的异常通知客户......
  • IP基本原理
    以太网帧结构传统以太网帧结构 8字节的前导符:标识已经到数据帧6字节目的MAC地址6字节源MAC地址2字节类型:标识上层协议IP(0x0800)ARP(0x0806)46-1500:数据4字节FCS......
  • Dubbo 3 之 Triple 流控反压原理解析
    作者:顾欣Triple是Dubbo3提出的基于HTTP2的开放协议,旨在解决Dubbo2私有协议带来的互通性问题。Triple基于HTTP/2定制自己的流控,支持通过特定的异常通知客户......
  • 4.3前后端交互Node+Gulp
    Node开发概述为什么要学习服务器端开发基础?能够和后端程序员更加紧密的配合网站业务逻辑前置【原本需要后端人员去做的事情,交由前端人员去处理】,学习前端技术需要后端技术......
  • Redis数据结构存储系统:第四章:底层实现原理
    应用场景:设置限制的优惠活动的信息;一些及时需要更新的数据,积分排行榜;手机验证码的时间;限制网站访客访问频率;Redis数据结构存储系统:第四章:底层实现原理Redis以什么形......
  • 容斥原理+简单博弈论
    容斥原理2个韦恩图的面积并:\(S_1+S_2-S_1S_2\)3个韦恩圆的面积并:\(S_1+S_2+S_3-S_1S_2-S_1S_3-S_2S_3+S_1S_2S_3\)n个韦恩圆的面积并:\(S_1+S_2+...+S_n-S_1S_2-...-S......
  • 重磅直播|ORB-SLAM3经典单目初始化模块原理及实现
    主讲人对该领域的核心和主流技术进行了详解,干货满满,线下的答疑更是赢得了同学们的好评。本期由在国内知名研究院就职,具有多年机器人从业经验的单鹏辉工程师分享,分享的主题为......