Update examples

Author: devlights

examples/basic/cmdexec/README.md

@@ -13,3 +13,4 @@
 | withenv.go                 | cmdexec_env                     | *exec.Cmd 実行時に追加の環境変数を指定するサンプルです                     |
 | withdir.go                 | cmdexec_dir                     | *exec.Cmd 実行時にワーキングディレクトリを指定するサンプルです             |
 | withslice.go               | cmdexec_slice                   | *exec.Cmd 実行時にスライスの値をコマンドの引数で指定するサンプルです       |
+| ospipe.go                  | cmdexec_ospipe                  | (*Cmd).Stdout に os.Pipe の io.Writer を接続して処理するサンプルです |

examples/basic/cmdexec/ospipe.go

@@ -2,7 +2,8 @@ package cmdexec
 
 import (
 	"bufio"
-	"log"
+	"fmt"
+	"io"
 	"os"
 	"os/exec"
 )
@@ -12,17 +13,46 @@ import (
 // # REFERENCES
 //   - https://pkg.go.dev/os@go1.24.4#Pipe
 func OsPipe() error {
+	//
+	// (*Cmd).StdoutPipe()で同じことが出来るが
+	// os.Pipe()の使い方を勉強するために
+	// 意図的に利用している
+	//
+
+	///////////////////////////////////
+	// パイプ取得
+	///////////////////////////////////
+
 	var (
 		pr  *os.File
 		pw  *os.File
 		err error
 	)
-	pr, pw, err = os.Pipe()
-	if err != nil {
+	if pr, pw, err = os.Pipe(); err != nil {
 		return err
 	}
 	defer pr.Close()
 
+	///////////////////////////////////
+	// コマンド実行
+	//
+	// git log コマンドを実行しているため
+	// リポジトリによっては長大な出力が発生する。
+	//
+	// 簡易なコマンド実行である (*Cmd).Output() で取得しようとすると
+	// OSのバッファが一杯になってしまう可能性があるため、このような場合は
+	// ストリーミング処理が必須となる。
+	//
+	// 以下で実行している git コマンドのオプションは以下の通り
+	//   - --no-pager  : ページャーを使用しない
+	//   - log         : ログを表示
+	//   - -m          : マージコミットの差分も表示
+	//   - -r          : 再帰的に処理
+	//   - --name-only : ファイル名のみ表示
+	//   - --pretty=raw: 生フォーマットで表示
+	//   - -z          : NULL文字で区切る
+	///////////////////////////////////
+
 	var (
 		name = "git"
 		args = []string{"--no-pager", "log", "-m", "-r", "--name-only", "--pretty=raw", "-z"}
@@ -34,7 +64,10 @@ func OsPipe() error {
 		return err
 	}
 
-	// 終了待機
+	///////////////////////////////////
+	// 終了待機用のゴルーチンを用意
+	///////////////////////////////////
+
 	var (
 		done = make(chan error, 1)
 	)
@@ -43,26 +76,55 @@ func OsPipe() error {
 		done <- cmd.Wait()
 	}()
 
+	///////////////////////////////////
+	// コマンドの出力を読み出し
+	///////////////////////////////////
+
 	const (
-		MaxTokenSize = 1024 * 1024
+		MaxTokenSize = 1024 * 1024 // 1行のサイズが大きい可能性を考慮してバッファサイズを底上げ
 	)
 	var (
 		scanner = bufio.NewScanner(pr)
 		buf     = make([]byte, MaxTokenSize)
+		count   int
 	)
 	scanner.Buffer(buf, MaxTokenSize)
 
 	for scanner.Scan() {
-		log.Println(scanner.Text())
+		io.Discard.Write(scanner.Bytes())
+		count++
 	}
 
 	if err = scanner.Err(); err != nil {
 		return err
 	}
 
+	///////////////////////////////////
+	// コマンド終了待機
+	///////////////////////////////////
+
 	if err = <-done; err != nil {
 		return err
 	}
 
+	///////////////////////////////////
+	// 結果出力
+	///////////////////////////////////
+
+	fmt.Printf("Total lines: %d\n", count)
+
 	return nil
+
+	/*
+	   $ task
+	   task: [build] go build .
+	   task: [run] ./try-golang -onetime
+
+	   ENTER EXAMPLE NAME: cmdexec_ospipe
+
+	   [Name] "cmdexec_ospipe"
+	   Total lines: 29988
+
+	   [Elapsed] 123.966649ms
+	*/
 }