Chapter1. Command line application flag package

[robert-min]

Flag package

• 위치 인수를 파싱하는 순간 -, --으로 시작하는 옵션은 처리하지 않음.
• -n으로 넘기는 값만큼 사용자의 이름을 출력하도록 어플리케이션 작성

사용자 인터페이스 개선

• 중복된 오류 메시지를 제거
• 도움말 사용법 메시지를 사용자 정의
• 위치 인수를 통해 사용자의 이름을 받을 수 있도록 설정

[robert-min]

입력값을 파싱하는 함수

• flag.NewFlagSet() : FlagSet 커맨드 라인 어플리케이션의 인수 처리를 위한 추상 객체 생성
• fs.Parse() : 함수 수행 도중 오류가 발생하는 경우 어떻게 처리할지 설정
  • ContinueOnError 옵션 : Parse 함수에서 nil 외의 오류가 반환되도라도 프로그램을 계속 실행, 파싱 에러를 직접 처리할 대 유용
  • ExitOnError 옵션 : 오류 발생 시 프로그램을 종류
  • PanicOnError 옵션 : 프로그램 종료시 Panic() 함수를 호출, 프로그램 종류 전 recover 함수를 사용하여 마무리 정리 작업이 가능
• SetOutPut() : NewFlagSet() 함수를 사용하여 생성된 FlagSet 객체의 진단 메시지 또는 출력 메시지를 작성하는 데 사용할 writer 지정
• IntVar() : int 타입의 값을 받을 수 있는 옵션 생성
  • 첫번째 매개변수 : 해당 값을 저장할 변수의 주소값
  • 두번째 : 옵션 자체의 이름, 여기서는 "n"
  • 세번째 : 해당 옵션의 기본 값
  • 마지막 : 사용자에게 보여줄 이 옵션의 목적을 나타내는 문자열
• fs.NArgs() : 플래그 옵션이 파싱된 이후에 주어진 위치 인수의 개수를 반환

type config struct {
    numTimes int
}

func parseArgs(w io.Writer, args []string) (config, error) {
    c := config{}

    // create FlagSet object
    fs := flag.NewFlagSet("greater", flag.ContinueOnError)
    fs.SetOutput(w)

    // set flag options
    fs.IntVar(&c.numTimes, "n", 0, "Number of times to great")
    err := fs.Parse(args)
    if err != nil {
        return c, err
    }
    if fs.NArg() != 0 {
        return c, errors.New("Positional arguments specified")
    }
    return c, nil
}

[robert-min]

도움말 사용법 메시지를 사용자가 직접 정의

• flag 패키지의 경우 FlagSet에 정의된 이름과 옵션을 기반으로 사용법 메시지를 자동으로 생성

• 사용자가 직접 정의하려면 Usage 속성값에 함수를 정의해서 사용

  // set help message
  fs.Usage = func() {
  var usageString = `
  A greeter application which prints the name you entered a specified number of times.
  
  Usage of %s: <options> [name]`
  fmt.Fprintf(w, usageString, fs.Name())
  fmt.Fprintln(w)
  fmt.Fprintln(w)
  fmt.Fprintln(w, "Options: ")
  fs.PrintDefaults()
  }

[robert-min]

위치 인수를 통해 사용자의 이름을 받을 수 있도록 설정

type config struct {
    numTimes int
    name     string
}

// 입력값을 파싱하는 함수
func parseArgs(w io.Writer, args []string) (config, error) {
    c := config{}

    // create FlagSet object
    fs := flag.NewFlagSet("greater", flag.ContinueOnError)
    fs.SetOutput(w)

    // set help message
    fs.Usage = func() {
        var usageString = `
        A greeter application which prints the name you entered a specified number of times.

        Usage of %s: <options> [name]`
        fmt.Fprintf(w, usageString, fs.Name())
        fmt.Fprintln(w)
        fmt.Fprintln(w)
        fmt.Fprintln(w, "Options: ")
        fs.PrintDefaults()
    }

    // set flag options
    fs.IntVar(&c.numTimes, "n", 0, "Number of times to great")
    err := fs.Parse(args)
    if err != nil {
        return c, err
    }
    if fs.NArg() > 1 {
        return c, errInvalidPosArgSpecified
    }
    if fs.NArg() == 1 {
        c.name = fs.Arg(0)
    }
    return c, nil
}

func runCmd(rd io.Reader, w io.Writer, c config) error {
    var err error
    // Enter if name is not specified or blank
    if len(c.name) == 0 {
        c.name, err = getName(rd, w)
        if err != nil {
            return err
        }
        greetUser(c, w)
        return nil
    }
    greetUser(c, w)
    return nil
}