VBAプログラムのサブルーチン化について
<< エクセルVBAで指定したURLをIEで起動する :前の記事
前回は指定したURLをIE(InternetExplorer)で起動する方法について解説しました。今回は少し実用的な話を混ぜて説明していきますが、皆さんがVBAでIE制御を行う目的はどのようなものでしょうか。ほとんどの方がWebページのデータ抽出やログインなどのインターフェースの自動化が挙げられると思います。
データ抽出やインターフェースの自動化にしても必ず最初は指定したURLをIEで起動させるところから始まります。こちらの処理は何度も利用されるプログラムですので、そのような処理をサブルーチン化させると色々なメリットが生まれます。ここでは、そのようなサブルーチン化のメリットも含めて解説していきます。
目次
- サブルーチンとは
- サブルーチンのメリット
- 本サイトとyahooサイトを(InternetExplorer)で起動させる処理の流れ
- 利用するVBA関数・メソッド・プロパティについて
- 本サイトとyahooサイトを(InternetExplorer)で起動させるサンプルコード
- まとめ
サブルーチンとは
サブルーチンとは、プログラム処理の中で繰り返し利用されるルーチン作業をモジュール化(部品化)してまとめたものになります。また、呼び出す側をメインルーチンと呼ぶのに対して「サブルーチン」と呼ばれます。
サブルーチンのメリット
繰り返し利用されるルーチン作業をモジュール化(部品化)することで、同じ処理のプログラムを何度も書く手間が省け、プログラムも全体的に見やすくなります。これによりプログラムソースの可読性や保守性を高く保つことができます。今回の「指定したURLをIEで起動する」プログラムもルーチン作業の1つですので、モジュール化(部品化)していきます。
本サイトとyahooサイトを(InternetExplorer)で起動させる処理の流れ
今回は、本サイトとyahooサイトを同時にIEで起動させるプログラムでサブルーチンについて解説していきますが、まずは以下のサブルーチンを利用しない処理の流れを確認してください。
- ①変数宣言
- ②IEオブジェクトを生成
※IEオブジェクトのメソッド・プロパティを利用できる状態にします。 - ③IEオブジェクトを表示
※ブラウザを視覚的に表示します。 - ④本サイトを表示
- ⑤本サイトのWebページが完全に読み込まれるまで処理を待機
※Webページの表示と読込み完了処理は別のものになります。 - ⑥IEオブジェクト2を生成
※IEオブジェクトのメソッド・プロパティを利用できる状態にします。 - ⑦IEオブジェクト2を表示
※ブラウザを視覚的に表示します。 - ⑧yahooサイトを表示
- ⑨yahooサイトのWebページが完全に読み込まれるまで処理を待機
※Webページの表示と読込み完了処理は別のものになります。
利用するVBA関数・メソッド・プロパティについて
今回利用するVBA関数・メソッド・プロパティは以下になります。
- CreateObject関数
- DoEvents関数
- Now関数
- TimeSerial関数
- Navigateメソッド
- Visibleプロパティ
- Busyプロパティ
- InternetExplorerオオブジェクトのReadyStateプロパティ
- DocumentオブジェクトのReadyStateプロパティ
- Refreshメソッド
CreateObject関数とは
CreateObject関数はオートメーション機能を利用して一時的なオブジェクトを作成する関数です。この関数を利用すると、外部アプリケーションをオブジェクトとして操作することが可能となります。
Set オブジェクト変数名 = CreateObject("アプリケーション名・オブジェクトの種類")
DoEvents関数とは
DoEvents関数は、処理の途中にオペレーティングシステムに制御を移すための関数です。時間のかかる処理やループ処理の場合、処理が完了するまでOS(オペレーティングシステム)は制御を行うことができません。(ループ処理中は、OSやExcelそのものにも再描画をさせる暇さえ与えません。)
そこで、DoEvents関数を利用することで一時的にOS(オペレーティングシステム)に制御を移して、処理を行うことができます。長期のループ処理や無限ループ処理に陥った場合に利用されることが多いですが、使いすぎると処理は安定するものの処理時間が長くなってしまうこともあるので注意しましょう。
DoEvents
Now関数とは
Now関数は、利用しているコンピュータシステムの日付と時刻の設定に基づいて、現在の日付と時刻を表すバリアント型の値を返す関数です。今回は、無限ループ対策で利用されます。
Now
TimeSerial関数とは
TimeSerial関数は、引数で指定した時、分、秒に対応する時刻を含むバリアント型の値を返す関数です。こちらも無限ループ対策で利用されます。
TimeSerial(0, 0, 20)
Navigateメソッドとは
InternetExplorerオブジェクトのNavigateメソッドは指定したURLをIE(InternetExplorer)で表示させます。5つの引数が用意されていますが、こちらでは必須項目であるURLだけを利用していきます。
objIE.Navigate ("IEに表示させるWebページのURL")
Visibleプロパティとは
InternetExplorerオブジェクトのVisibleプロパティはInternetExplorerオブジェクトを表示するか非表示にするかを設定できます。非表示にしたとしても視覚的に見えなくなるだけですので、そのままInternetExplorerオブジェクトを操作することができます。
objIE.Visible = True/False
Busyプロパティとは
InternetExplorerオブジェクトのBusyプロパティはWebページが読み込み中かどうかを示します。Trueは読み込み中でFalseは読み込み完了を表しますが、実際の処理ではTrue→False→True→Falseを繰り返すことがあります。
例えばframeタグやiframeタグを利用しているサイトの場合、最初のフレームの読み込みが完了すると一旦Falseを返しますが、次のフレームの読み込みを開始するとTrueに戻ります。
他にもJavaScriptなどのスクリプト処理でも同様のことが起こる場合がありますので、BusyプロパティだけではWebページの読み込み完了待機処理を補えないことを理解してください。
objIE.Busy = True/False
InternetExplorerオブジェクトのReadyStateプロパティとは
InternetExplorerオブジェクトのReadyStateプロパティはInternetExplorerオブジェクトのドキュメントの読み込み状態を示します。読み込み状態は0~4までの5段階で、Busyプロパティでは不完全だったフレームの読み込みも完全に読み込んでから完了状態を示します。ちなみにWebページの完全読み込み待機処理では、Busyプロパティと併せて利用するのが一般的な方法となります。
objIE.readyState = 0~4
DocumentオブジェクトのReadyStateプロパティとは
DocumentオブジェクトのReadyStateプロパティはDocumentオブジェクトのドキュメントの読み込み状態を示します。読み込み状態は4段階で、文字列で返す点にご注意ください。こちらもWebページの完全読み込み待機処理で利用します。
objIE.document.readyState = "uninitialized"/"loading"/
"interactive"/"complete"
Refreshメソッドとは
InternetExplorerオブジェクトのRefreshメソッドはWebブラウザに表示されているWebページの再読み込み(リフレッシュ)を行うメソッドです。Webブラウザ自体が読み込み失敗している場合などで有効な処理となります。
objIE.Refresh
本サイトとyahooサイトを(InternetExplorer)で起動させるサンプルコード
#If VBA7 Then
Private Declare PtrSafe Sub Sleep Lib "kernel32" (ByVal ms As LongPtr)
#Else
Private Declare Sub Sleep Lib "kernel32" (ByVal ms As Long)
#End If
Sub sample()
Dim objIE As InternetExplorer
Dim objIE2 As InternetExplorer
Dim timeOut As Date
'IE(InternetExplorer)のオブジェクトを作成する
Set objIE = CreateObject("InternetExplorer.Application")
'IE(InternetExplorer)を起動する
objIE.Visible = True
'本サイトを起動する
objIE.Navigate "http://www.vba-ie.net/"
'完全にページが表示されるまで待機する
timeOut = Now + TimeSerial(0, 0, 20)
Do While objIE.Busy = True Or objIE.readyState <> 4
DoEvents
Sleep 1
If Now > timeOut Then
objIE.Refresh
timeOut = Now + TimeSerial(0, 0, 20)
End If
Loop
timeOut = Now + TimeSerial(0, 0, 20)
Do While objIE.document.ReadyState <> "complete"
DoEvents
Sleep 1
If Now > timeOut Then
objIE.Refresh
timeOut = Now + TimeSerial(0, 0, 20)
End If
Loop
'IE(InternetExplorer)のオブジェクトを作成する
Set objIE2 = CreateObject("InternetExplorer.Application")
'IE(InternetExplorer)を起動する
objIE2.Visible = True
'yahooサイトを表示する
objIE2.Navigate "http://www.yahoo.co.jp/"
'完全にページが表示されるまで待機する
timeOut = Now + TimeSerial(0, 0, 20)
Do While objIE2.Busy = True Or objIE2.ReadyState <> 4
DoEvents
Sleep 1
If Now > timeOut Then
objIE2.Refresh
timeOut = Now + TimeSerial(0, 0, 20)
End If
Loop
timeOut = Now + TimeSerial(0, 0, 20)
Do While objIE.document.ReadyState <> "complete"
DoEvents
Sleep 1
If Now > timeOut Then
objIE2.Refresh
timeOut = Now + TimeSerial(0, 0, 20)
End If
Loop
End Sub
実行結果
本サイトとyahooサイトがIE(InternetExplorer)に表示されます。
解説
まず、プログラムの内容についてですが、直接こちらのページを閲覧されている方は「指定したURLをIEで起動するサンプルコードの解説」で詳しく解説していますので、そちらを確認してください。
今回のサンプルコードは2つのサイトを表示させるマクロですが、非常に長いプログラムになっているのが分かるかと思います。サンプルコードでは2つのサイトを開くのに同じプロシージャの中にまとめて書きましたが、それぞれプロシージャを分けて表示させると以下のようになります。
本サイトを表示
#If VBA7 Then
Private Declare PtrSafe Sub Sleep Lib "kernel32" (ByVal ms As LongPtr)
#Else
Private Declare Sub Sleep Lib "kernel32" (ByVal ms As Long)
#End If
Sub sample()
Dim objIE As InternetExplorer
Dim timeOut As Date
'IE(InternetExplorer)のオブジェクトを作成する
Set objIE = CreateObject("InternetExplorer.Application")
'IE(InternetExplorer)を起動する
objIE.Visible = True
'本サイトを起動する
objIE.Navigate "http://www.vba-ie.net/"
'完全にページが表示されるまで待機する
timeOut = Now + TimeSerial(0, 0, 20)
Do While objIE.Busy = True Or objIE.ReadyState <> 4
DoEvents
Sleep 1
If Now > timeOut Then
'ページの再読み込み(リフレッシュ)
objIE.Refresh
timeOut = Now + TimeSerial(0, 0, 20)
End If
Loop
timeOut = Now + TimeSerial(0, 0, 20)
Do While objIE.document.ReadyState <> "complete"
DoEvents
Sleep 1
If Now > timeOut Then
'ページの再読み込み(リフレッシュ)
objIE.Refresh
timeOut = Now + TimeSerial(0, 0, 20)
End If
Loop
End Sub
yahooサイトを表示
#If VBA7 Then
Private Declare PtrSafe Sub Sleep Lib "kernel32" (ByVal ms As LongPtr)
#Else
Private Declare Sub Sleep Lib "kernel32" (ByVal ms As Long)
#End If
Sub sample()
Dim objIE2 As InternetExplorer
Dim timeOut As Date
'IE(InternetExplorer)のオブジェクトを作成する
Set objIE2 = CreateObject("InternetExplorer.Application")
'IE(InternetExplorer)を起動する
objIE2.Visible = True
'yahooサイトを表示する
objIE2.Navigate "http://www.yahoo.co.jp/"
'完全にページが表示されるまで待機する
timeOut = Now + TimeSerial(0, 0, 20)
Do While objIE2.Busy = True Or objIE2.ReadyState <> 4
DoEvents
Sleep 1
If Now > timeOut Then
objIE2.Refresh
timeOut = Now + TimeSerial(0, 0, 20)
End If
Loop
timeOut = Now + TimeSerial(0, 0, 20)
Do While objIE.document.ReadyState <> "complete"
DoEvents
Sleep 1
If Now > timeOut Then
objIE2.Refresh
timeOut = Now + TimeSerial(0, 0, 20)
End If
Loop
End Sub
お気づきの方も多いかと思いますが、2つのプロシージャで異なる点と言えば「表示させるURL」の部分だけで、他の部分は全て同じ内容のプログラムを利用していることが分かります。
このように同じ処理を何度も記述するということは手間でありプログラムが冗長してしまいます。そのような場合に再利用できる部分をサブルーチンとして扱うことでプログラムがスリムになり、プログラムソースの可読性や保守性を高く保つことができます。
文章だけではまだイメージが付かない方もいるかと思いますが、実際に上記の処理をサブルーチン化させると以下のようになります。
サブルーチンを利用したプロシージャ
Sub sample()
Dim objIE As InternetExplorer
Dim objIE2 As InternetExplorer
'本サイトをIEで起動
Call ieView(objIE, "http://www.vba-ie.net/")
'yahooサイトをIEで起動
Call ieView(objIE2, "http://www.yahoo.co.jp/")
End Sub
こちらは再利用できるサブルーチンの部分を除いていますが、非常にスリムで可読性もかなり向上しているのが分かるかと思います。このようにサブルーチン化させると大きなメリットがありますので、再利用できる部分はなるべくサブルーチンにするようにしましょう。
まとめ
今回は、サブルーチンの説明からメリットまで解説しました。サブルーチン化させる部分を見極めながら作業を進めていけば、どんなに複雑なプログラムでも簡単に記述することができます。次回はサブルーチン部分の解説になります。
次の記事: エクセルVBAで指定URLをIEで起動するサブルーチンを作成する >>
近田 伸矢, 植木 悠二, 上田 寛
IEのデータ収集&自動操作のプログラミング本はこの1冊だけ!IEの起動やポップアップウィンドウ、表示を制御する基本的なコードはもちろん、テキストボックスやラジオボタン、表、ハイパーリンクなどのHTML部品を制御する方法など、自動操作に欠かせないノウハウを丁寧に解説。