【実務・中級編】【進捗率表示】StdOut.Write を活用したコンソール上でのプログレスバー同一行リアルタイム更新表示 – VBScript (Visual Basic Scripting Edition)解析バイブル

スポンサーリンク

VBScriptを掌握する極限の知見:`StdOut.Write`で実現するコンソールプログレスバーの極意

業務自動化の現場において、VBScript(WSH)は今なおレガシーシステムとの統合や、手軽なキッティング・バッチ処理の基盤として静かなる現役であり続けている。

しかし、君が構築したそのバッチ処理、「黒い画面のまま数分間フリーズしているように見える」という致命的なUX(ユーザーエクスペリエンス)の欠陥を抱えていないか?
数万件のレコード処理や、巨大なファイルのネットワーク転送において、進捗が見えない恐怖は現場のオペレーターに「フリーズしたのでは?」という誤認を招き、無駄なタスクキルや二重実行を引き起こす。

今回は、VBScriptの標準出力 (`StdOut`) とキャリッジリターン (`Chr(13)`) を完璧に制御し、余計なサードパーティ製ツールに頼らず、純粋なWSHの力だけで同一行をリアルタイムに書き換える「プログレスバー実装の極意」を伝授する。

なぜ「ただのログ出力」では業務ツールとして失格なのか

多くのジュニアエンジニアは、ループ処理の中で以下のようなコードを書く。

‘ 【アンチパターン】これではコンソールが流れてしまい、ログが埋まる
WScript.Echo “処理中: ” & i & “件目”

これの何が問題か。`WScript.Echo` は出力の末尾に自動的に改行(CRLF)を付加する。結果として、数千行、数万行のログがコンソールを猛烈なスピードで流れ去り、バッファがあふれるか、人間には到底追えないゴミの山が出来上がる。

真にプロフェッショナルなCLI(コマンドラインインターフェース)ツールとは、限られたコンソール画面のスペースを効率的に使い、「今、全体に対してどこを走っているのか」を視覚的に一目で把握させなければならない。

核心技術:`StdOut.Write` と `Chr(13)` のライフサイクル

同一行でのリアルタイム更新を実現するためのメカニズムは極めてシンプルだ。

1. `WScript.StdOut.Write` を使う(`Echo` と異なり、自動改行されない)。
2. 文字列を出力した後、改行せずにキャリッジリターン(`Chr(13)` / 復帰)のみを送る。
3. 次のループで、同じ位置の上から文字列を上書きする。

ここで重要なのは、CScriptホストで実行されていることが絶対条件である点だ。GUIベースの `WScript.exe` で実行した場合、`StdOut` は存在しないためエラー(オブジェクトは 438 または 501: オブジェクトはプロパティまたはメソッドをサポートしていません)となる。このアーキテクチャ上の制約をハンドリングする堅牢な設計が求められる。

【プロダクションコード】堅牢なプログレスバー実装

以下のコードは、単に動くだけではない。

  • `CScript` 以外での実行時のガード処理
  • ターミナルの文字幅に応じた動的なバー描画
  • 処理速度低下を防ぐための描画頻度制御(全件描画しないスロットリング)

これらを網羅した、そのまま現場の生産システムに投入できる実用スクリプトだ。

‘ ==============================================================================
‘ Script Name: AdvancedProgressBar.vbs
‘ Description: CScript実行環境におけるリアルタイム・プログレスバー実装
‘ Author: Chief Architect
‘ ==============================================================================

Option Explicit

‘ 1. 実行ホストの厳密な検証(WScript.exeでの誤実行をブロック)
If InStr(LCase(WScript.FullName), “cscript.exe”) = 0 Then
MsgBox “このスクリプトは CScript.exe で実行する必要があります。” & vbCrLf & _
“コマンドプロンプトから ‘cscript ” & WScript.ScriptName & “‘ と実行してください。”, _
vbCritical, “ホストエラー”
WScript.Quit 1
End If

Main

Sub Main()
Dim totalRecords, i, percent, barWidth
totalRecords = 1550 ‘ 擬似的な総処理件数(ダミーデータ)
barWidth = 30 ‘ プログレスバーの最大文字数

WScript.StdOut.WriteLine “=== バッチ処理を開始します (Total: ” & totalRecords & “件) ===”

Dim startTime
startTime = Timer

For i = 1 To totalRecords
‘ — 実際の業務ロジック(DBアクセスやファイル操作)をここに記述 —
Call HeavyProcessSimulation()
—————————————————————-

‘ 進捗率の計算
percent = Int((i / totalRecords) 100)

‘ 描画負荷を軽減するため、厳密な全件描画ではなく必要に応じて更新(または全件でも軽微ならOK)
Call DrawProgressBar(i, totalRecords, percent, barWidth)
Next

Dim elapsedTime
elapsedTime = Round(Timer – startTime, 2)

‘ 最後に必ず改行を入れて次のログへ進む
WScript.StdOut.WriteLine vbCrLf & “=== 処理が正常に完了しました (実行時間: ” & elapsedTime & “秒) ===”
End Sub

‘ ——————————————————————————
‘ プログレスバー描画コアプロシージャ
‘ ——————————————————————————
Sub DrawProgressBar(current, total, percent, barWidth)
Dim filledCount, emptyCount, barStr, spaceStr
Dim i

‘ バーの進捗文字数を計算
filledCount = Int(barWidth (current / total))
If filledCount > barWidth Then filledCount = barWidth
emptyCount = barWidth – filledCount

‘ 視覚表現の構築(# と – を使用)
barStr = String(filledCount, “#”)
spaceStr = String(emptyCount, “-“)

‘ 出力文字列の組み立て
‘ 例: [

——] 40% ( 400/1000 )

Dim output
output = “[” & barStr & spaceStr & “] ” & Right(” ” & percent, 3) & “% (” & _
Right(Space(Len(CStr(total))) & current, Len(CStr(total))) & “/” & total & “)”

‘ Chr(13) を先頭(または末尾)に置き、カーソルを常に行頭に戻して上書きする
WScript.StdOut.Write Chr(13) & output
End Sub

‘ ——————————————————————————
‘ 処理負荷シミュレーション(実業務ではここにADOやFileSystemObjectの処理が入る)
‘ ——————————————————————————
Sub HeavyProcessSimulation()
Dim d
For d = 1 to 50000: Next ‘ 擬似ウェイト
End Sub

現場で役立つアーキテクトの知見:ファイル・DB連携時の注意点

このプログレスバーを実際の業務(例えば、数万行のCSV読み込みや、SQL Server / Oracle への一括インサート)に組み込む際、以下の罠に注意せよ。

1. 描画コストの最適化(スロットリング)

ループの1回ごとに `StdOut.Write` を実行すると、コンソールI/O自体がボトルネックになり、本来の業務処理速度が数倍〜数十倍に低下する現象が発生する。
もし総件数が10万件を超えるような場合は、`If i Mod 100 = 0 Then` のように条件を挟み、100件に1回描画を更新するスロットリング設計を取り入れるのがプロの選択だ。

2. エラーハンドリング時のカーソル崩れ

処理中に予期せぬエラー(DB接続断など)が発生して `On Error Resume Next` を抜けた場合、コンソールのカーソルが行の途中で止まり、その後のエラーログが見づらくなる。
例外トラップ時にも、必ず一度 `WScript.StdOut.WriteLine “”` を実行して強制改行を入れるクリーンアップ処理を `Class_Terminate` や終了ルーチンに組み込んでおくこと。

結論

たかが「プログレスバーの表示」と思うなかれ。
コンソールの出力を巧みにコントロールする技術は、ツール自体の「品質へのこだわり」を雄弁に物語る。動くだけの汚いコードから脱却し、オペレーターのストレスをゼロにする洗練されたCLIツールを、君のVBScriptアーセナルに加えてほしい。

タイトルとURLをコピーしました