Windows TIPS
[Scripting]
  Windows TIPS TOPへ
Windows TIPS全リストへ

スクリプトレット・コンポーネントでリソース情報を定義する

解説をスキップして操作方法を読む

山田 祥寛
2004/10/23
 
対象OS
Windows 2000
Windows XP
Windows Server 2003
コード内で頻繁に参照するデータを何度も繰り返しハード・コーディングすることは、コード保守の観点からも好ましくない。
そのようなデータは、リソースとしてスクリプト・ブロックから分離することで、情報を一元化できるのみならず、変更時にもコードそのものに手を加える必要がなくなり、保守性を向上させることができる。
 
解説

 スクリプトレットでコンポーネント開発を行っていると、スクリプト中にハード・コーディングするのは好ましくない情報に遭遇することはないだろうか。

 例えば消費税率のように、コード全体で何度も繰り返し使用するような情報を想定してみよう。このような情報は、定数として<script>ブロック内に記述しても構わないが、将来的に変更の可能性があることを考えれば、コード中に埋没させてしまうのは好ましくない。さりとて、設定ファイルやデータベースとして外部化するほどの情報でもないだろう。そのような情報は「リソース」として、スクリプト・ブロックとは別にXML部分に定義するのが好ましい。もしも将来的にリソースの情報が変更になった場合でも、XML部分に情報が記述してあれば、比較的変更も行いやすい。たとえスクリプト言語を熟知していない運用担当者であっても、XMLのコードならば修正できる可能性が高いだろう。

 それでは、以下に具体的にリソースを利用したコード例を記述してみることにしよう。サンプルはWindows TIPS「ファイルの文字コードを変換する」で使用したkconv.wsfの文字コード変換ロジックをスクリプトレット・コンポーネント化してみることにしよう。なお、本サンプルを動作させるには、Basp21という追加コンポーネントがコンピュータにインストールされていることが条件となる。コンポーネントBasp21の入手先やインストール方法などについては、Windows TIPS「配信リストを使ってメールをいっせいに配信する」の「手順1」を参照してほしい。


操作方法

手順1―テキスト・エディタでスクリプトのコードを入力する

 まずはテキスト・エディタ(メモ帳でも何でもよい)を開き、以下のコードを入力してほしい。なお、引用符(')で始まる行、および、<!--〜-->で囲まれたブロックはコードの概要を解説するためのコメント部分なので、省略しても構わない。なお、大まかなロジックの流れは、別稿「ファイルの文字コードを変換する」で紹介したものをそのまま利用しているので、併せて参照することで理解を深めることができるだろう。

※ファイルconvert.wsc

<?xml version="1.0" encoding="Shift_JIS" standalone="yes" ?>
<package>
  <component id="kconvert">
    <?component error="True" debug="True" ?>
    <comment>文字コード変換コンポーネント</comment>
    <registration progid="Wings.KConvert"
      description="文字コード変換コンポーネント"
      version="1" remotable="True" />
    <!--Convertメソッドとその引数を定義する-->
    <public>
      <method name="Convert" dispid="0">
        <parameter name="path" />
        <parameter name="before" />
        <parameter name="after" />
      </method>
    </public>
    <!--スクリプトレット・コンポーネント内で利用するコンポーネントを定義-->
    <object id="objBsp" progid="Basp21" />
    <object id="objFs"  progid="Scripting.FileSystemObject" />
    <!--文字コードと対応する設定値をリソースとして定義する-->
    <resource id="Unknown">0</resource>
    <resource id="Shift_JIS">1</resource>
    <resource id="EUC-JP">2</resource>
    <resource id="JIS">3</resource>
    <resource id="UCS-2">4</resource>
    <resource id="UTF-8">5</resource>
    <script language="VBScript">
    <![CDATA[
    Sub Convert(path, before, after)
      Set objFld = objFs.GetFolder(path)
      For Each objFl In objFld.Files
        strTmp=objFl.Path
        ' リソースは「getResource(リソース名)」で取得可能
        If objFl.Size>0 And objFs.GetExtensionName(strTmp)="txt" Then
objBsp.KconvFile strTmp, strTmp & ".tmp", getResource(after), getResource(before)
          objFl.Delete
          objFs.MoveFile strTmp & ".tmp",strTmp
        End If
      Next
      For Each objSub In objFld.SubFolders
        Convert objSub.Path,before,after
      Next
    End Sub
    ]]>
    </script>
  </component>
</package>
 
※ファイルconvert.wsf

<?xml version="1.0" encoding="Shift_JIS" standalone="yes" ?>
<package>
  <job id="KConvert">
  <?job error="True" debug="True" ?>
  <!--使用するスクリプトレット・コンポーネントをインスタンス化-->
  <object id="objCnv" progid="Wings.KConvert" />
  <script language="VBScript">
  <![CDATA[
  ' Convertメソッドには、第1引数から「変換対象のフォルダ」
  ' 「変換後の文字ード」「変換前の文字コード」を指定する
  objCnv.Convert WScript.Arguments.Item(0),"Shift_JIS","EUC-JP"
  WScript.Echo("変換処理を完了しました")
  ]]>
  </script>
  </job>
</package>
  • サンプル・ファイル(convert.wscconvert.wsf)のダウンロード
    注:サンプルconvert.wsc、convert.wsfを実行するには、上のファイル名を右クリックして、それぞれconvert.wsc、convert.wsfというファイル名で保存する)

 スクリプトレットの実行ファイルは拡張子「.wsc」(Windows Scripting Components)、WSH(Windows Script Host)スクリプトの実行ファイルは拡張子「.wsf」に、それぞれ指定する必要がある。ファイル名自体は何でもよいが、ここでは「convert.wsc」「convert.wsf」という名前で保存しておこう。また、スクリプトレット・コンポーネントが動作するには、あらかじめスクリプトレットの「登録」という作業を行っておく必要がある。登録作業については、Windows TIPS「よく利用するジョブをスクリプトレットでコンポーネント化する」が詳しいので、そちらを参照いただきたい。

手順1―WSHのコードを実行する

 convert.wsc、convert.wsfを実行するには、エクスプローラでconvert.wsfの格納されたフォルダを開いておき、そのアイコン上に置き換え対象のファイルが収められた「フォルダ」をドラッグ&ドロップするだけだ。だがこのconvert.wsfは複数フォルダの変換には対応していないので、複数フォルダを指定した場合には、最初のフォルダだけが処理される。注意してほしい。

 これによって、ドロップしたフォルダ配下のテキスト・ファイルの文字コードがすべてShift_JISからEUC-JPに変換されていれば成功だ。詳細なロジックの流れは、すでにWindows TIPS「ファイルの文字コードを変換する」で解説しているので、ここでは取り上げない。ここで注目していただきたいのは、リソースを定義することで、コンポーネントを利用するWSHスクリプトから「文字コード名」で文字コードを指定できるようになったという点だ。Windows TIPS「ファイルの文字コードを変換する」のkconv.wsfでは人間にとっては意味のない1、2、……という数値で文字コードを指定していたが、リソースを利用することで、このようなマジック・ナンバーを排除し、コードの可読性/保守性を向上させることができる。End of Article

関連記事
  Windows TIPS:ファイルの文字コードを変換する(Windows Server Insider)
  Windows TIPS:配信リストを使ってメールをいっせいに配信する(Windows Server Insider)
  Windows TIPS:よく利用するジョブをスクリプトレットでコンポーネント化する(Windows Server Insider)
  Windows TIPS:スクリプトレット・コンポーネントでプロパティを定義する(Windows Server Insider)
     
「Windows TIPS」


Windows Server Insider フォーラム 新着記事
@ITメールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)

注目のテーマ

Windows Server Insider 記事ランキング

本日 月間