【入門編】【実務中級者向け】FSO操作中のCtrl+Cや異常終了に備えるテンポラリファイル・ロック自動クリーンアップ – VBScript (Visual Basic Scripting Edition)解析バイブル

スポンサーリンク

皆さん、こんにちは!業務自動化の最前線でVBScriptを駆使している皆さん、日々のルーティン作業をスマートに、そして何よりも「安全に」こなしていますか?

今日は、VBScriptにおけるファイルシステムオブジェクト(FSO)操作の中でも、特にプロのエンジニアがこだわるべき「堅牢性」と「信頼性」について、私の長年の経験と知見を惜しみなく皆さんにお伝えしたいと思います。

【VBScript FSO】業務自動化の生命線!異常終了時も安心なテンポラリファイル・ロック自動クリーンアップの極意

FSOはVBScriptの強力な武器であり、ファイルやフォルダの操作を自在に操ることができます。しかし、その強力さゆえに、一歩間違えれば思わぬトラブルを招くことも少なくありません。

特に、スクリプトが予期せぬエラーで停止したり、ユーザーが我慢できずに「Ctrl+C」で強制終了してしまったりした際、皆さんのスクリプトは後始末をきちんと行っていますか?

「あっ、作業用ファイルが残りっぱなしだ…」
「ロックファイルが解除されなくて、次の処理が動かない!」
「一時的に変更したフォルダ属性が元に戻っていない…」

このような経験、ありませんか?

業務自動化の現場で私が何度も見てきた光景であり、信頼性の低いスクリプトがシステム全体に与える影響は計り知れません。まるで外科医が手術後に器具を全て数えるように、スクリプトも使ったリソースは全て解放し、元の状態に戻す。これがプロの仕事です。

今日は、皆さんがVBScriptの基本から一歩踏み出し、どんな状況でもクリーンな環境を保つ「自動クリーンアップの極意」をマスターするための、堅牢なスクリプト構造をご紹介します。ここをクリアすれば、VBScriptの基本はバッチリですよ!

1. FSOの基本と、そこに潜む「見えない罠」

まずは、FSOの基本を軽くおさらいしましょう。

‘ FileSystemObjectのインスタンスを作成
Dim fso
Set fso = CreateObject(“Scripting.FileSystemObject”)

‘ 例: テキストファイルを作成し、書き込む
Dim objFile
Set objFile = fso.CreateTextFile(“C:\Temp\myLog.txt”, True) ‘ Trueは上書きを許可
objFile.WriteLine “スクリプト実行開始: ” & Now()
objFile.Close ‘ ファイルは必ず閉じましょう!

‘ オブジェクトの解放
Set objFile = Nothing
Set fso = Nothing

FSOを扱う際の非常に基本的なコードです。`CreateObject(“Scripting.FileSystemObject”)` でFSOオブジェクトを生成し、ファイルやフォルダを操作します。そして、重要なのが最後に `Set fso = Nothing` としている点です。

これは単にメモリを解放するだけでなく、FSOオブジェクトが保持していたファイルハンドルなどのシステムリソースを確実に解放するという意味合いも持っています。この「オブジェクトのライフサイクル管理」が、信頼性高いスクリプトの第一歩です。

しかし、ここに「見えない罠」が潜んでいます。もし、`objFile.Close` や `Set fso = Nothing` に到達する前にスクリプトが強制終了されたらどうなるでしょうか?

  • 開いたファイルは閉じられず、他のアプリケーションからアクセスできなくなる可能性があります。
  • 作成した一時ファイルやロックファイルは残り続け、ディスク容量を圧迫したり、次の処理の邪魔になったりします。
  • 一時的に変更したファイルやフォルダの属性(読み取り専用化など)は元に戻らず、手動での修正が必要になります。

これでは、自動化どころか、トラブルの元を自動生成しているようなものですよね。

2. 【極限の知見】堅牢なスクリプト構造の設計思想

VBScriptには、VB.NETやC#のような `Try…Catch…Finally` といった強力なエラーハンドリング機構がありません。そのため、VBScriptで堅牢なスクリプトを書くには、一工夫が必要です。

私が推奨する「堅牢なスクリプト構造」は、以下の三位一体です。

1. メイン処理: スクリプトの本来の目的を実行する部分。
2. クリーンアップ処理: どのような状況でも、作成した一時ファイルやロックファイルを削除し、システムを元の状態に戻す部分。これを独立したサブルーチンとして定義します。
3. エラーハンドリング: `On Error Resume Next` を使いつつ、エラー発生を適切に検知し、必ずクリーンアップ処理を呼び出す仕組み。

この構造を図でイメージしてみてください。

+——————————————————-+
| スクリプト全体 |
| +—————————————————+ |
| | 初期設定(FSOオブジェクト生成など) | |
| | | |
| | +———————————————–+ | |
| | | メイン処理 | | |
| | | – 一時ファイル・ロックファイルの作成 | | |
| | | – 本来の業務ロジック | | |
| | | – … | | |
| | +———————————————–+ | |
| | | |
| | +———————————————–+ | |
| | | エラーハンドリング | | |
| | | – エラー発生時は、メイン処理を中断し、 | | |
| | | 「クリーンアップ処理」を呼び出す | | |
| | +———————————————–+ | |
| | | |
| | +———————————————–+ | |
| | | クリーンアップ処理 | | |
| | | – 作成した一時ファイル・ロックファイルの削除 | | |
| | | – 変更した属性の復元 | | |
| | | – オブジェクトの解放 (Set obj = Nothing) | | |
| | +———————————————–+ | |
| | | |
| | 正常終了時も「クリーンアップ処理」を呼び出す | |
| +—————————————————+ |
+——————————————————-+

この肝となるのが、スクリプトのどの経路(正常終了、エラー終了、強制終了直前)でも、必ずクリーンアップ処理を呼び出すという設計思想です。特に、`WScript.Quit` でスクリプトを終了させる前にクリーンアップを挟むことが重要になります。

3. クリーンアップ戦略の具体化

では、具体的なクリーンアップ戦略を見ていきましょう。

3.1. テンポラリファイルの管理

  • 作成場所: 環境変数 `TEMP` で指定される一時ディレクトリを利用しましょう。他のアプリケーションの一時ファイルと混同せず、OS側も一時ファイルとして認識しやすくなります。`WScript.Shell` オブジェクトを使って取得できます。
  • ファイル名: ユニークなファイル名を生成することが不可欠です。複数のスクリプトが同時に動作しても、ファイル名が衝突しないようにするためです。FSOの `GetTempName` メソッドや、`Now()` や `Timer` を組み合わせる方法があります。
  • 削除: スクリプトの終了時に必ず削除します。

3.2. ロックファイルの活用と解除

複数のスクリプトやプロセスが同じリソース(ファイルやデータベースなど)に同時にアクセスして競合するのを防ぐために、「ロックファイル」が非常に有効です。

  • 作成: 処理を開始する直前に、特定の命名規則(例: `_process.lock`)で空のファイルを作成します。
  • 存在チェック: スクリプト開始時に、このロックファイルが存在するかどうかをチェックします。存在すれば、他のプロセスが稼働中と判断し、自身の処理を中断するなどします。
  • 削除: 処理が完了したら、必ずロックファイルを削除します。

4. 実践!堅牢な自動クリーンアップスクリプトのコード例

それでは、上記の戦略を統合したVBScriptのコードを見ていきましょう。
一時ファイルとロックファイルを作成し、メイン処理を行い、正常終了時も異常終了時もクリーンアップを実行する構造です。

Option Explicit

‘ =========================================================================================
‘ グローバル変数定義
‘ =========================================================================================
Dim fso ‘ FileSystemObjectオブジェクト
Dim objShell ‘ WScript.Shellオブジェクト (環境変数取得用)
Dim strTempPath ‘ 一時ファイルの格納パス
Dim strTempFileName ‘ 作成する一時ファイルのフルパス
Dim strLockFileName ‘ 作成するロックファイルのフルパス
Dim blnIsLocked ‘ ロックファイルを作成したかどうかを示すフラグ
Dim blnTempFileCreated ‘ 一時ファイルを作成したかどうかを示すフラグ

‘ =========================================================================================
‘ メイン処理(スクリプトのエントリポイント)
‘ =========================================================================================
Call Main()
WScript.Quit 0 ‘ メイン処理が終了したら、必ずクリーンアップを呼び出した上でスクリプトを終了

‘ =========================================================================================
‘ Sub Main() – スクリプトの主たるロジック
‘ =========================================================================================
Sub Main()
‘ エラーが発生しても処理を継続し、後でエラーチェックを行う
On Error Resume Next

‘ 初期化処理
Call Initialize()
If Err.Number <> 0 Then
WScript.Echo “初期化中にエラーが発生しました: ” & Err.Description
Call Cleanup()
WScript.Quit 1 ‘ エラー終了
End If

WScript.Echo “スクリプト処理を開始します。”

‘ ロックファイルの作成とチェック
Call CreateLockFile()
If Err.Number <> 0 Then
WScript.Echo “ロックファイルの作成またはチェック中にエラーが発生しました: ” & Err.Description
Call Cleanup()
WScript.Quit 1
End If
If blnIsLocked = False Then
‘ ロックファイルが存在し、他のプロセスが実行中の場合
WScript.Echo “他のスクリプトが実行中のため、処理を中断します。”
Call Cleanup()
WScript.Quit 0 ‘ ロックにより中断した場合は、エラーではないので0で終了
End If

‘ 一時ファイルの作成
Call CreateTempFile()
If Err.Number <> 0 Then
WScript.Echo “一時ファイルの作成中にエラーが発生しました: ” & Err.Description
Call Cleanup()
WScript.Quit 1
End If

‘ =====================================================================================
‘ ★★★ ここに実際の業務ロジックを記述します ★★★
‘ =====================================================================================
WScript.Echo “メイン業務ロジックを実行中…”
WScript.Sleep 3000 ‘ 3秒間待機(処理のシミュレーション)

‘ 例: 意図的にエラーを発生させる(テスト用)
‘ Dim invalidObject
‘ invalidObject.Method() ‘ エラー発生!

‘ 例: 一時ファイルに何か書き込む
Dim objTempFile
Set objTempFile = fso.OpenTextFile(strTempFileName, 8, True) ‘ 8=ForAppending, True=CreateIfNotExist
objTempFile.WriteLine “メイン処理実行中: ” & Now()
objTempFile.Close
Set objTempFile = Nothing ‘ ファイルオブジェクトは必ず解放

WScript.Echo “メイン業務ロジックが完了しました。”
‘ =====================================================================================

‘ 処理中にエラーが発生したか最終チェック
If Err.Number <> 0 Then
WScript.Echo “メイン処理中に予期せぬエラーが発生しました: ” & Err.Description
Call Cleanup()
WScript.Quit 1 ‘ エラー終了
End If

‘ 正常終了の場合もクリーンアップを呼び出す
WScript.Echo “スクリプト処理が正常に完了しました。クリーンアップを実行します。”
Call Cleanup()
End Sub

‘ =========================================================================================
‘ Sub Initialize() – 初期化処理
‘ =========================================================================================
Sub Initialize()
‘ FileSystemObjectを生成
Set fso = CreateObject(“Scripting.FileSystemObject”)
‘ WScript.Shellを生成(環境変数取得用)
Set objShell = CreateObject(“WScript.Shell”)

‘ 環境変数TEMPのパスを取得
strTempPath = objShell.ExpandEnvironmentStrings(“%TEMP%”)

‘ 一時ファイルのパスを生成
‘ スクリプト名とユニークなGUIDを組み合わせることで、衝突しにくいファイル名にする
strTempFileName = fso.BuildPath(strTempPath, fso.GetBaseName(WScript.ScriptFullName) & “_” & fso.GetTempName())

‘ ロックファイルのパスを生成
‘ スクリプト名に”.lock”を付与。同じスクリプトの多重起動防止用
strLockFileName = fso.BuildPath(strTempPath, fso.GetBaseName(WScript.ScriptFullName) & “.lock”)

‘ フラグの初期化
blnIsLocked = False
blnTempFileCreated = False

If Err.Number <> 0 Then
WScript.Echo “初期化処理でエラー: ” & Err.Description
Exit Sub
End If
End Sub

‘ =========================================================================================
‘ Sub CreateLockFile() – ロックファイルの作成とチェック
‘ =========================================================================================
Sub CreateLockFile()
On Error Resume Next ‘ このサブルーチン内でもエラーハンドリングを有効に

If fso.FileExists(strLockFileName) Then
‘ ロックファイルが存在する場合、他のプロセスが実行中と判断
WScript.Echo “警告: ロックファイル ‘” & strLockFileName & “‘ が既に存在します。”
blnIsLocked = False ‘ ロックできなかったことを示す
Else
‘ ロックファイルを作成
Dim objLockFile
Set objLockFile = fso.CreateTextFile(strLockFileName, True) ‘ Trueは上書きを許可(万一の場合)
objLockFile.Close
Set objLockFile = Nothing ‘ ファイルオブジェクトは必ず解放

If Err.Number = 0 Then
WScript.Echo “ロックファイル ‘” & strLockFileName & “‘ を作成しました。”
blnIsLocked = True ‘ ロックできたことを示す
Else
WScript.Echo “ロックファイルの作成に失敗しました: ” & Err.Description
‘ エラーはメインで処理されるため、ここでは特別な処理は不要
End If
End If
End Sub

‘ =========================================================================================
‘ Sub CreateTempFile() – 一時ファイルの作成
‘ =========================================================================================
Sub CreateTempFile()
On Error Resume Next ‘ このサブルーチン内でもエラーハンドリングを有効に

‘ 一時ファイルを作成
Dim objTempFile
Set objTempFile = fso.CreateTextFile(strTempFileName, True) ‘ Trueは上書きを許可
objTempFile.WriteLine “これは一時ファイルです。作成時刻: ” & Now()
objTempFile.Close
Set objTempFile = Nothing ‘ ファイルオブジェクトは必ず解放

If Err.Number = 0 Then
WScript.Echo “一時ファイル ‘” & strTempFileName & “‘ を作成しました。”
blnTempFileCreated = True ‘ 一時ファイルを作成したことを示す
Else
WScript.Echo “一時ファイルの作成に失敗しました: ” & Err.Description
‘ エラーはメインで処理されるため、ここでは特別な処理は不要
End If
End Sub

‘ =========================================================================================
‘ Sub Cleanup() – クリーンアップ処理(重要!)
‘ どの終了パスからも確実に呼び出される
‘ =========================================================================================
Sub Cleanup()
WScript.Echo “クリーンアップ処理を開始します。”
On Error Resume Next ‘ クリーンアップ中にエラーが発生しても処理を継続させるため

‘ 1. 一時ファイルの削除
If blnTempFileCreated Then ‘ 一時ファイルを作成した場合のみ削除を試みる
If fso.FileExists(strTempFileName) Then
fso.DeleteFile strTempFileName, True ‘ Trueは読み取り専用ファイルも削除
If Err.Number = 0 Then
WScript.Echo “一時ファイル ‘” & strTempFileName & “‘ を削除しました。”
Else
WScript.Echo “一時ファイルの削除に失敗しました: ” & Err.Description
Err.Clear ‘ エラーをクリアして次の処理へ
End If
Else
WScript.Echo “一時ファイル ‘” & strTempFileName & “‘ は見つかりませんでした。”
End If
End If

‘ 2. ロックファイルの削除
If blnIsLocked Then ‘ ロックファイルを作成した場合のみ削除を試みる
If fso.FileExists(strLockFileName) Then
fso.DeleteFile strLockFileName, True
If Err.Number = 0 Then
WScript.Echo “ロックファイル ‘” & strLockFileName & “‘ を削除しました。”
Else
WScript.Echo “ロックファイルの削除に失敗しました: ” & Err.Description
Err.Clear
End If
Else
WScript.Echo “ロックファイル ‘” & strLockFileName & “‘ は見つかりませんでした。”
End If
End If

‘ 3. オブジェクトの解放
‘ 開いたファイルオブジェクトはメイン処理やサブルーチン内で随時解放するのが理想
‘ ここではグローバルなFSO, Shellオブジェクトを確実に解放する
If Not fso Is Nothing Then
Set fso = Nothing
WScript.Echo “FileSystemObjectを解放しました。”
End If
If Not objShell Is Nothing Then
Set objShell = Nothing
WScript.Echo “WScript.Shellを解放しました。”
End If

WScript.Echo “クリーンアップ処理が完了しました。”
End Sub

コードのポイント解説

  • `Option Explicit`: 変数の宣言を強制し、タイポによるバグを防ぎます。プロの基本です。
  • グローバル変数: `fso`, `objShell`, `strTempPath` など、スクリプト全体で共有するオブジェクトやパスはグローバル変数として宣言します。
  • `Sub Main()`: スクリプトの主要なロジックをここに集約します。
  • `Sub Initialize()`: FSOやShellオブジェクトの生成、一時ファイルやロックファイルのパス生成など、スクリプト開始時に一度だけ行う初期設定を行います。
  • `objShell.ExpandEnvironmentStrings(“%TEMP%”)`: 環境変数 `TEMP` のパスを安全に取得します。
  • `fso.GetBaseName(WScript.ScriptFullName) & “_” & fso.GetTempName()`: スクリプトのベース名とFSOが生成するユニークな一時ファイル名を組み合わせることで、ほぼ確実にファイル名衝突を避けます。
  • `blnIsLocked`, `blnTempFileCreated` フラグ: ロックファイルや一時ファイルを実際に作成したかどうかを追跡するためのフラグです。これにより、存在しないファイルを削除しようとしてエラーになるのを防ぎます。
  • `On Error Resume Next` と `If Err.Number <> 0 Then`: VBScriptでエラーを捕捉し、適切にハンドリングするための常套手段です。エラーが発生したら、即座に `Cleanup()` を呼び出し、`WScript.Quit 1` で異常終了をOSに通知します(0は正常終了、1は異常終了)。
  • `Sub CreateLockFile()`: ロックファイルの存在チェックと作成を行います。
  • ロックファイルが既に存在する場合は、他のプロセスが実行中と判断し、処理を中断します。
  • `Sub CreateTempFile()`: 作業用の一時ファイルを作成します。
  • `Sub Cleanup()` (重要度MAX!): これこそが本記事の肝です。
  • `On Error Resume Next`: クリーンアップ処理自体もエラーで停止しないようにします。例えば、一時ファイルを削除しようとしたら、すでに他のプロセスが削除済みだった、といった場合にクリーンアップ処理全体が中断しないようにするためです。
  • `fso.DeleteFile strTempFileName, True`: `True` を指定することで、読み取り専用になっているファイルも強制的に削除できます。
  • オブジェクトの解放: `Set fso = Nothing` や `Set objShell = Nothing` をここで行うことで、スクリプトがどの経路で終了しても、COMオブジェクトが確実に解放され、ファイルハンドルなどのシステムリソースが適切に閉じられます。これは、単なるメモリ解放以上の意味を持ちます。

5. 発展的な考察:よりプロフェッショナルな使い方へ

このクリーンアップ構造をマスターすれば、皆さんのスクリプトは格段に信頼性が向上します。さらに一歩進んだプロの技として、こんなことも考えてみましょう。

  • タイムアウト機能: ロックファイルが残りっぱなしになるケースに備え、ロックファイルの作成日時を記録し、一定時間以上古いロックファイルは強制的に削除するロジックを追加する。
  • ログ出力: クリーンアップの状況やエラーの詳細をログファイルに記録することで、トラブルシューティングを容易にする。
  • 引数によるクリーンアップ: `cscript myscript.vbs /cleanup` のように、スクリプト実行時の引数によってクリーンアップ処理だけを実行できるようにする。これにより、手動でクリーンアップしたい場合に便利です。

まとめ:信頼性こそが業務自動化の生命線

今日の記事では、VBScriptのFSO操作において、スクリプトの異常終了や強制終了に備え、テンポラリファイルやロックファイルを自動でクリーンアップする堅牢な構造を解説しました。

  • FSOの強力さと共に、その背後にある責任を理解すること。
  • `On Error Resume Next` だけでは不十分であり、`Cleanup` サブルーチンを核とした堅牢なスクリプト構造を構築すること。
  • 一時ファイルやロックファイルの作成と、あらゆる終了経路での確実な削除ロジック。
  • そして、COMオブジェクトの確実な解放(`Set obj = Nothing`)が、システムリソースの適正な管理に繋がるという、オブジェクトのライフサイクルに対する深い理解。

これらは、単なるVBScriptのテクニックではなく、業務自動化の現場で信頼されるシステムを構築するための「プロの知見」そのものです。この知見を胸に、皆さんのスクリプトが、どんな状況でも揺るがない、信頼性の高い自動化ソリューションへと進化することを願っています。

さあ、皆さんもこの極意を実践し、真の業務自動化エンジニアへの道を歩み始めてください!応援していますよ!

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