安科网

服务计算 - 3 | CLI 命令行实用程序开发基础

oHongZuo

oHongZuo

2019-06-28

关注 关注

服务计算 - 3 | CLI 命令行实用程序开发基础

概述

CLI（Command Line Interface）实用程序是Linux下应用开发的基础。正确的编写命令行程序让应用与操作系统融为一体，通过shell或script使得应用获得最大的灵活性与开发效率。Linux提供了cat、ls、copy等命令与操作系统交互；go语言提供一组实用程序完成从编码、编译、库管理、产品发布全过程支持；容器服务如docker、k8s提供了大量实用程序支撑云服务的开发、部署、监控、访问等管理任务；git、npm等都是大家比较熟悉的工具。尽管操作系统与应用系统服务可视化、图形化，但在开发领域，CLI在编程、调试、运维、管理中提供了图形化程序不可替代的灵活性与效率。

基本要求

参阅 Selpg命令行程序设计逻辑，实现一个selpg页选择程序，满足selpg设计要求。

程序实现

流程分析

服务计算 - 3 | CLI 命令行实用程序开发基础

程序按照读取参数、判断参数是否合规、读取文件、确定输出位置并输出顺序执行。当发现错误时抛出错误并终止流程。

代码实现

  1. selpg所需参数有必须的开始页码-s以及结束页码-e，可选的输入文件名、自定页长-l、遇换页符换页-f和输出地址。其中自定页长和遇换页符换页两个选项是互斥的，不能同时使用。

    • 定义保存参数数据的结构体

      type selpgArgs struct {
    startPage  int
    endPage    int
    inFileName string
    pageLen    int
    pageType   bool
    printDest  string
}

    • 输入参数使用 github.com/spf13/pflag 包提供的pflag进行处理，pflag包于flag用法类似，但pflag相对于flag能够更好地满足 Unix 命令行规范。参考：Golang pflag

      func getArgs(args *selpgArgs) {
    pflag.IntVarP(&(args.startPage), "startPage", "s", -1, "Define startPage")
    pflag.IntVarP(&(args.endPage), "endPage", "e", -1, "Define endPage")
    pflag.IntVarP(&(args.pageLen), "pageLength", "l", 72, "Define pageLength")
    pflag.StringVarP(&(args.printDest), "printDest", "d", "", "Define printDest")
    pflag.BoolVarP(&(args.pageType), "pageType", "f", false, "Define pageType")
    pflag.Parse()

    argLeft := pflag.Args()
    if len(argLeft) > 0 {
        args.inFileName = string(argLeft[0])
    } else {
        args.inFileName = ""
    }
}
      • pflag包中的函数XXXVarP（XXX为Int、String、Bool等可选类型）可以取出命令行参数名称shorthand的参数的值，value指定*p的默认值，name为自定的名称，usage为自定的该参数的描述。该函数无返回值。
      • func XXXVarP(p *XXX, name, shorthand string, value XXX, usage string)
      • 获得flag参数后，要用pflag.Parse()函数才能把参数解析出来。这里还有一个东西，解析完指定的参数后，可以通过调用argLeft := pflag.Args()来获得未定义但输入了的参数如文件名。

  2. 命令行参数获取之后，首先要进行参数检查以尽量避免参数谬误。出现错误时输出问题并正常结束程序。参数正确则将各个参数值输出到屏幕上。

    func checkArgs(args *selpgArgs) {
    if (args.startPage == -1) || (args.endPage == -1) {
        fmt.Fprintf(os.Stderr, "\n[Error]The startPage and endPage can't be empty! Please check your command!\n")
        os.Exit(2)
    } else if (args.startPage <= 0) || (args.endPage <= 0) {
        fmt.Fprintf(os.Stderr, "\n[Error]The startPage and endPage can't be negative! Please check your command!\n")
        os.Exit(3)
    } else if args.startPage > args.endPage {
        fmt.Fprintf(os.Stderr, "\n[Error]The startPage can't be bigger than the endPage! Please check your command!\n")
        os.Exit(4)
    } else if (args.pageType == true) && (args.pageLen != 72) {
        fmt.Fprintf(os.Stderr, "\n[Error]The command -l and -f are exclusive, you can't use them together!\n")
        os.Exit(5)
    } else if args.pageLen <= 0 {
        fmt.Fprintf(os.Stderr, "\n[Error]The pageLen can't be less than 1 !\n")
        os.Exit(6)
    } else {
        pageType := "page length."
        if args.pageType == true {
            pageType = "The end sign /f."
        }
        fmt.Printf("\n[ArgsStart]\n")
        fmt.Printf("startPage: %d\nendPage: %d\ninputFile: %s\npageLength: %d\npageType: %s\nprintDestation: %s\n[ArgsEnd]", args.startPage, args.endPage, args.inFileName, args.pageLen, pageType, args.printDest)
    }
}
    • 在这个函数中，首先检查了开始页args.startPage和结束页args.endPage是否被赋值，然后检查开始页args.startPage和结束页args.endPage是否为正数，接下来检查开始页args.startPage是否大于结束页args.endPage，然后检查自定页长-l和遇换页符换页-f是否同时出现，最后判断当自定页长-l出现时args.pageLen是否小于1。遇到不合规的地方正常结束程序，全部合规则输出得到的参数。

  3. 参数检查结束之后，程序开始调用excuteCMD函数执行命令。

    func checkError(err error, object string) {
    if err != nil {
        fmt.Fprintf(os.Stderr, "\n[Error]%s:", object)
        panic(err)
    }
}

func excuteCMD(args *selpgArgs) {
    var fin *os.File
    if args.inFileName == "" {
        fin = os.Stdin
    } else {
        checkFileAccess(args.inFileName)
        var err error
        fin, err = os.Open(args.inFileName)
        checkError(err, "File input")
    }

    if len(args.printDest) == 0 {
        output2Des(os.Stdout, fin, args.startPage, args.endPage, args.pageLen, args.pageType)
    } else {
        output2Des(cmdExec(args.printDest), fin, args.startPage, args.endPage, args.pageLen, args.pageType)
    }
}

func checkFileAccess(filename string) {
    _, errFileExits := os.Stat(filename)
    if os.IsNotExist(errFileExits) {
        fmt.Fprintf(os.Stderr, "\n[Error]: input file \"%s\" does not exist\n", filename)
        os.Exit(7)
    }
}
    • 第一步检查输入。如果没有给定文件名，则从标准输入中获取；如果给出读取的文件名，则调用函数checkFileAccess检查文件是否存在。
    • 第二步是打开文件，使用函数checkError检查是否出现错误。如果打开出错则输出错误并抛出恐慌。
    • 第三步判断是否有-d参数。如果没有-d参数，选择的页直接从os.Stdout标准输出中输出。如果-d存在，则从指定的打印通道中输出。

  4. 在-d参数存在时，涉及到了os/exec包的使用，这里可以参考golang中os/exec包用法。

    func cmdExec(printDest string) io.WriteCloser {
    cmd := exec.Command("lp", "-d"+printDest)
    fout, err := cmd.StdinPipe()
    checkError(err, "StdinPipe")
    cmd.Stdout = os.Stdout
    cmd.Stderr = os.Stderr
    errStart := cmd.Run()
    checkError(errStart, "CMD run")
    return fout
}
    • 其中printDest就是获取的打印地址，将命令行的输入管道cmd.StdinPipe()获取的指针赋值给fout，然后再将fout返回给output2Des函数中的作为输出位置参数的输入，最后在output2Des中将需要的页输出到fout。

  5. 输出函数output2Des将输入的文件，按页码要求读取并输出到fout中。

    func output2Des(fout interface{}, fin *os.File, pageStart int, pageEnd int, pageLen int, pageType bool) {

    lineCount := 0
    pageCount := 1
    buf := bufio.NewReader(fin)
    for true {

        var line string
        var err error
        if pageType {
            //If the command argument is -f
            line, err = buf.ReadString('\f')
            pageCount++
        } else {
            //If the command argument is -lnumber
            line, err = buf.ReadString('\n')
            lineCount++
            if lineCount > pageLen {
                pageCount++
                lineCount = 1
            }
        }

        if err == io.EOF {
            break
        }
        checkError(err, "file read in")

        if (pageCount >= pageStart) && (pageCount <= pageEnd) {
            var outputErr error
            if stdOutput, ok := fout.(*os.File); ok {
                _, outputErr = fmt.Fprintf(stdOutput, "%s", line)
            } else if pipeOutput, ok := fout.(io.WriteCloser); ok {
                _, outputErr = pipeOutput.Write([]byte(line))
            } else {
                fmt.Fprintf(os.Stderr, "\n[Error]:fout type error. ")
                os.Exit(8)
            }
            checkError(outputErr, "Error happend when output the pages.")
        }
    }
    if pageCount < pageStart {
        fmt.Fprintf(os.Stderr, "\n[Error]: startPage (%d) greater than total pages (%d), no output written\n", pageStart, pageCount)
        os.Exit(9)
    } else if pageCount < pageEnd {
        fmt.Fprintf(os.Stderr, "\n[Error]: endPage (%d) greater than total pages (%d), less output than expected\n", pageEnd, pageCount)
        os.Exit(10)
    }
}
    • bufio包实现了带缓存的 I/O 操作，在文件读取中十分方便。具体使用参见Golang学习 - bufio 包。这里使用buf.ReadString(symbol),每次读取字符串直到遇到字符symbol为止。
    • 由于fout存在两种输入-io.Stdout标准输出作为输入、cmd.StdinPipe()管道作为输入。所以使用空接口interface{}作为fout的类型，借助类型断言stdOutput, ok := fout.(*os.File)和pipeOutput, ok := fout.(io.WriteCloser)来判断fout具体类型并调用相应函数。

程序测试

  • 按文档 使用 selpg 章节要求测试该程序
  • 测试文档input_file.txt包含两个换页符
    服务计算 - 3 | CLI 命令行实用程序开发基础
  1. ./selpg -s1 -e1 input_file.txt

    服务计算 - 3 | CLI 命令行实用程序开发基础

  2. ./selpg -s1 -e1 input_file.txt

    服务计算 - 3 | CLI 命令行实用程序开发基础

  3. ./selpg -s1 -e2 input_file.txt >output_file

    服务计算 - 3 | CLI 命令行实用程序开发基础
    服务计算 - 3 | CLI 命令行实用程序开发基础

  4. ./selpg -s1 -e4 input_file.txt 2>error_file

    服务计算 - 3 | CLI 命令行实用程序开发基础
    服务计算 - 3 | CLI 命令行实用程序开发基础

  5. ./selpg -s1 -e3 input_file.txt >output_file 2>error_file

    服务计算 - 3 | CLI 命令行实用程序开发基础
    服务计算 - 3 | CLI 命令行实用程序开发基础

  6. ./selpg -s1 -e2 -f input_file.txt

    服务计算 - 3 | CLI 命令行实用程序开发基础

  7. ./selpg -s1 -e1 -dCups-PDF selpg.go

    服务计算 - 3 | CLI 命令行实用程序开发基础
    服务计算 - 3 | CLI 命令行实用程序开发基础

    • 借助虚拟打印机插件Cups-PDF，打印输出结果是代码的前72行，所以结果正确。

GITHUB项目地址

命令行

oHongZuo

oHongZuo

0 关注 0 粉丝 0 动态

关注 关注

相关推荐

命令行生存指南：强制早睡

你会不会经常陷入这么一个情景：计划晚上早点睡叫，然而无奈总是一不小心玩过头了。你需要一种方法强制让你到时间了就要关机去睡觉了，这该怎么做呢？Kgotobed 是一个很变态的内核模块。它会强制 Linux 在特定时间关闭，而你却毫无办法。内核模块允许 Lin

吹云 2020-11-05

命令行生存指南：监视命令输出

有时候需要不断的执行某个命令并追踪其输出产生的变化情况。一种常见的方法是通过写一段死循环的 shell 脚本来实现，不过 Linux 本身已经提供了一个工具来帮你定期执行指定的程序并将结果全屏输出，本节将会介绍该工具。进程将从标准输入文件中得到输入数据，将

84407805 2020-11-01

使用curl从命令行访问互联网

下载我们整理的 curl 备忘录。要在不使用图形界面的情况下从互联网上获取所需的信息，curl 是一种快速有效的方法。curl通常被视作一款非交互式 Web 浏览器，这意味着它能够从互联网上获取信息，并在你的终端中显示，或将其保存到文件中。从表面看，这是

曾是土木人 2020-10-31

在Linux命令行内的大小写转换

在编辑文本时大小写常常是需要注意的地方，大小写的转换是很枯燥而繁琐的工作，所幸，Linux 提供了很多能让这份工作变得容易的命令。接下来让我们看看都有哪些完成大小写转换的命令。tr 是能运用在命令行或者脚本上的最简单的大小写转换命令之一。例如如果你想

87201442 2020-10-15

程序员直呼瑞思拜！这7个命令行工具你还没尝试过吗？

本文转载自公众号“读芯术”。终端/命令行是可能是程序员最常用的工具。这或许是因为它是轻量型的，可以用来做很多事，一些开发人员甚至不遗余力地在终端内部进行操作。本文将分享一些我每天都会大量使用的CLI工具。有哪种终端机列表不包含vim?对于那些不熟悉vim的

java0 2020-09-29

GitHub命令行工具1.0版正式上线，从此告别网页管理

经过大半年的迭代与完善，今天GitHub CLI已经成功从beta版升级为1.0正式版，可供所有用户使用。GitHub CLI让开发者在终端里使用命令行管理代码项目，不必打开网页，工作效率更高。GitHub在官方博客中表示，自年初发布测试版以来，用户使用G

81437716 2020-09-18

提升开发效率N倍的20+命令行神器，赶紧收藏了

訰騰poé “Shell ”é蓤è”èéè° Shell ¨èè Linux è Mac ¨··¤¤。éèè¤è§é¨¤· è·°éè°èè°é訰 cmd --help è man cmd¨¤¨¤°±èè°。nginx è¤ HTTP

81437716 2020-09-13

在命令行中使用nmcli来管理网络连接

nmcli 命令赋予你直接在 Linux 命令行操作 NetworkManager 工具的能力。它是 NetworkManager 软件包集成的一部分，通过使用一些应用程序接口来获取 NetworkManager 的功能。nmcli发布于 2010 年，用

bluecarrot 2020-09-11

在 Linux 命令行里与其他用户通信

在 Linux 命令行里向其他用户发送信息很简单，很多命令都可以做到这点，麻烦的是你需要从众多命令中挑选一个合适的命令来使用。因此，我挑选了四种常用的 Linux 用户通信命令分享给大家并为你们讲解这四种命令是如何工作的。wall 命令允许你向所有在系统

myCat 2020-09-09

命令行版的斗地主你玩过没？

相信大家都玩过斗地主游戏，或在现实中斗地主或在电脑和手机上斗地主，但你想过用命令行界面进行斗地主吗?是不是觉得挺有意思，下面就带大家一起玩一下吧~该项目是基于java开发的，因此需要部署java运行环境及 maven。你可以创建私人服务器与好友一起斗地主，

83427718 2020-09-07

使用命令行工具 Graudit 来查找你代码中的安全漏洞

测试是软件开发生命周期的重要组成部分，它有几个阶段。今天，我想谈谈如何在代码中发现安全问题。这就是为什么有一个术语叫 DevSecOps，它的基本职责是识别和解决应用中的安全漏洞。有一些用于检查 OWASP 漏洞 的开源解决方案，它将通过创建源代码的威胁模

85560694 2020-09-03

在Linux命令行中使用计算器的5个命令

大家好，我是良许。在使用 Linux 时，我们有时会需要做一些计算，那么我们就可能需要用到计算器。在 Linux 命令行里，有许多计算器工具，这些命令行计算器可以让我们执行科学计算、财务计算或者一些简单的计算。当然，我们也可以在 Shell 脚本中使用

89520991 2020-08-21

5款超级好用的命令行工具，提升你的开发效率！

如果你是一个喜欢使用Linux系统，或者经常和Linux打交道的开发人员。那么，终端和命令行一定是接触很频繁的工具之一。Linux不像Windows那样，有丰富的桌面应用，但是，却有很多开源、免费的命令行工具，这也恰好符合Linux的应用场景。找到一款优秀

89550191 2020-08-09

Linux系统中玩到让你停不下来的命令行游戏！

在使用 Linux 系统时，命令行不仅可以让我们在工作中提高效率，它还可以在生活上给我们提供各种娱乐活动，因为你可以使用它玩许多非常有意思的游戏，这些游戏可都不需要使用专用显卡。命令行游戏尽管比较简单，看上去只是一行行枯燥的代码，但有，还是有不少的 Lin

katie000 2020-08-04

终端命令行生存之——网络冲浪篇

Linux命令行是强大的工具，命令行是我们的日常工作，命令行更是我们日常生活。之前虫虫给大家写过一些命令的的介绍，命令行的工具，命令行下的开发。实际上命令行也是我们不可或缺的生活。本文我们来介绍一下命令行下的网络冲浪工具命令行浏览器。lynx一个历史悠久纯

hunningtu 2020-07-30

Github标星24.1K！一个命令行就可以把网站变成电脑App

现如今，我们大多数人都拥有多台设备，至少用两个系统，除非你对苹果生态系统十分着迷，否则这些设备没有办法达到你想象中的那样无缝协作，尽管人们一直致力于不同设备之间的沟通差距。例如许多应用程序是为计算机准备的，即便你离开手机也可以使用。有时候开发人员只是发布一

89961330 2020-07-28

Unix命令行中的Ctrl + Z和Ctrl + C的区别

Control+ Z用于通过向其发送信号来暂停进程，该信号SIGSTOP不能被程序拦截。而Control+ C用来杀死带有信号的进程SIGINT，并且可以被程序截获，因此它可以在退出之前清理自身，或者根本不退出。但是，如果您杀死了一个，则除了被退回到She

yuzhongdelei0 2020-07-28

使用git命令行撤销之前的代码更新提交

哈哈哈 这样就大功告成了，也不是很麻烦哦！

ameng 2020-07-27

Windows下使用命令行编译Qt项目（解决DLL丢失问题）

我之前用Qt做了个hello world，结果各种报错，一大堆DLL找不到，今天用命令行编译就通过了

yuzhongdelei0 2020-07-27

Centos命令行报bash:.....:command not found的解决办法

命令行输入命令执行后报“bash:....:command not found”这是由于系统PATH设置问题，PATH没有设置对，系统就无法找到精确命令了。命令执行完之后先不要关闭终端。我的Linux系统是由于设置JAVA环境变量时设置PATH属性导致co

haitianisgood 2020-07-21
oHongZuo

oHongZuo

W3CSchool教程
HTML 教程
CSS 教程
Bootstrap 教程
Javascript 教程
jQuery 教程
后端教程
C 教程
Java 教程
PHP 教程
Python 教程
Go 教程
移动开发
Android 教程
Swift 教程
Kotlin 教程
jQuery Mobile 教程
ionic 教程
关于我们
新闻动态
联系方式
招聘英才
安科实验室
帮助与反馈

安科网(Ancii)，中国第一极客网

Copyright © 2013 - 2019 Ancii.com

京ICP备18063983号 京公网安备11010802014868号