Chapter2. Sub command

[robert-min]

서브커맨드 구현

• 논리적으로 개별의 기능에 대해 커맨드 라인 애플리케이션을 독립적인 별도의 커맨드와 옵션, 인수를 갖도록 분리

[robert-min]

Sub Command Example

• cmd-a, cmd-b 분리해서 처리

  
  package main

import ( "flag" "fmt" "io" "os" )

func handleCmdA(w io.Writer, args []string) error { var v string fs := flag.NewFlagSet("cmd-a", flag.ContinueOnError) fs.SetOutput(w) fs.StringVar(&v, "verb", "argument-value", "Argument 1") err := fs.Parse(args) if err != nil { return nil } fmt.Fprintf(w, "Executing command A") return nil }

func handleCmdB(w io.Writer, args []string) error { var v string fs := flag.NewFlagSet("cmd-b", flag.ContinueOnError) fs.SetOutput(w) fs.StringVar(&v, "verb", "argument-value", "Argument 1") err := fs.Parse(args) if err != nil { return err } fmt.Fprintf(w, "Executing command B") return nil }

func printUsage(w io.Writer) { fmt.Fprintf(w, "Usage: %s [cmd-a|cmd-b] -h\n", os.Args[0]) handleCmdA(w, []string{"-h"}) handleCmdB(w, []string{"-h"}) }

func main() { var err error if len(os.Args) < 2 { printUsage(os.Stdout) os.Exit(1) } switch os.Args[1] { case "cmd-a": err = handleCmdA(os.Stdout, os.Args[2:]) case "cmd-b": err = handleCmdB(os.Stdout, os.Args[2:]) default: printUsage(os.Stdout) }

if err != nil {
    fmt.Fprint(os.Stdout, err)
    os.Exit(1)
}

}

[robert-min]

서브커맨드 주도 어플리케이션 아키텍쳐

• 커맨드 라인 어플리케이션 개발 과정에서 메인 패키지는 가급적 최소화
• 실질적인 기능은 별도의 패키지로 분리하여 확장성을 높임
• 메인 패키지는 라인 인수를 파싱하여 서브 커맨드 핸들러 함수를 호출

[robert-min]

main package

package main

import (
    "errors"
    "fmt"
    "io"
    "os"

    "github.com/handson-go/chap2/sub-cmd-arch/cmd"
)

var errInvalidSubCommand = errors.New("Invalid sub-command specified")

// Print usage
func printUsage(w io.Writer) {
    fmt.Fprintf(w, "Usage: mync [http|grpc] -h\n")
    cmd.HandleHttp(w, []string{"-h"})
    cmd.HandleGrpc(w, []string{"-h"})
}

// Handling command
func handleCommand(w io.Writer, args []string) error {
    var err error

    if len(args) < 1 {
        err = errInvalidSubCommand
    } else {
        switch args[0] {
        case "http":
            err = cmd.HandleHttp(w, args[1:])
        case "grpc":
            err = cmd.HandleGrpc(w, args[1:])
        case "-h":
            printUsage(w)
        case "-help":
            printUsage(w)
        default:
            err = errInvalidSubCommand
        }
    }

    if errors.Is(err, cmd.ErrNoServerSpecified) || errors.Is(err, errInvalidSubCommand) {
        fmt.Fprintln(w, err)
        printUsage(w)
    }
    return err

}

func main() {
    err := handleCommand(os.Stdout, os.Args[1:])
    if err != nil {
        os.Exit(1)
    }
}

[robert-min]

cmd/httpCmd.go

package cmd

import (
    "flag"
    "fmt"
    "io"
)

type httpConfig struct {
    url  string
    verb string
}

func HandleHttp(w io.Writer, args []string) error {
    var v string

    fs := flag.NewFlagSet("http", flag.ContinueOnError)
    fs.SetOutput(w)
    fs.StringVar(&v, "verb", "GET", "HTTP method")

    fs.Usage = func() {
        var usageString = `
http: A HTTP client.

http: <options> server`
        fmt.Fprintf(w, usageString)

        fmt.Fprintln(w)
        fmt.Fprintln(w)
        fmt.Fprintln(w, "Options: ")
        fs.PrintDefaults()
    }

    err := fs.Parse(args)
    if err != nil {
        return err
    }

    if fs.NArg() != 1 {
        return ErrNoServerSpecified
    }

    c := httpConfig{verb: v}
    c.url = fs.Arg(0)
    fmt.Fprintln(w, "Executing http command")
    return nil
}