Powershellで文字リソースを含む.resxを作ってみる

コンピュータ
PowerShellのあれこれ

アプリケーションで利用する文字や画像などのリソースはプログラムソースに直接記述するのではなく、リソースファイルで管理するのが一般的です。個人的には必要となる場面に遭遇したことは、ほぼ無いので今まで触ったことが無かったのですが.Net Frameworkでリソースファイルを作れるようなので試してみたいと思います。

まずはリソースファイルを作成します。
ファイル名:resx.ps1

<#
.SYNOPSIS
 文字列を含むリソースファイルを作成するサンプル
#>

using namespace System
using namespace System.Resources

Set-StrictMode -Version Latest
$ErrorActionPreference = "STOP"


function Main
{
    try {
        $resx = [ResXResourceWriter]::new(".\sample.resx") | % {
            $_.AddResource("key1","値1")
            $_.AddResource("key2","値2")
            $_.AddResource("key3","値3")
            $_
        }
    } finally {
        $resx.Close()
    }

}
Main

key1~3と名前を付けた文字リソースを作成しました。
実行するとカレントディレクトリにsample.resxが出来上がります。

ファイル名:sample.resx

<?xml version="1.0" encoding="utf-8"?>
<root>
  <!-- 
    Microsoft ResX Schema 
    
    Version 2.0
    
    The primary goals of this format is to allow a simple XML format 
    that is mostly human readable. The generation and parsing of the 
    various data types are done through the TypeConverter classes 
    associated with the data types.
    
    Example:
    
    ... ado.net/XML headers & schema ...
    <resheader name="resmimetype">text/microsoft-resx</resheader>
    <resheader name="version">2.0</resheader>
    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
        <value>[base64 mime encoded serialized .NET Framework object]</value>
    </data>
    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
        <comment>This is a comment</comment>
    </data>
                
    There are any number of "resheader" rows that contain simple 
    name/value pairs.
    
    Each data row contains a name, and value. The row also contains a 
    type or mimetype. Type corresponds to a .NET class that support 
    text/value conversion through the TypeConverter architecture. 
    Classes that don't support this are serialized and stored with the 
    mimetype set.
    
    The mimetype is used for serialized objects, and tells the 
    ResXResourceReader how to depersist the object. This is currently not 
    extensible. For a given mimetype the value must be set accordingly:
    
    Note - application/x-microsoft.net.object.binary.base64 is the format 
    that the ResXResourceWriter will generate, however the reader can 
    read any of the formats listed below.
    
    mimetype: application/x-microsoft.net.object.binary.base64
    value   : The object must be serialized with 
            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
            : and then encoded with base64 encoding.
    
    mimetype: application/x-microsoft.net.object.soap.base64
    value   : The object must be serialized with 
            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
            : and then encoded with base64 encoding.

    mimetype: application/x-microsoft.net.object.bytearray.base64
    value   : The object must be serialized into a byte array 
            : using a System.ComponentModel.TypeConverter
            : and then encoded with base64 encoding.
    -->
  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
    <xsd:element name="root" msdata:IsDataSet="true">
      <xsd:complexType>
        <xsd:choice maxOccurs="unbounded">
          <xsd:element name="metadata">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0" />
              </xsd:sequence>
              <xsd:attribute name="name" use="required" type="xsd:string" />
              <xsd:attribute name="type" type="xsd:string" />
              <xsd:attribute name="mimetype" type="xsd:string" />
              <xsd:attribute ref="xml:space" />
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="assembly">
            <xsd:complexType>
              <xsd:attribute name="alias" type="xsd:string" />
              <xsd:attribute name="name" type="xsd:string" />
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="data">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
              </xsd:sequence>
              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
              <xsd:attribute ref="xml:space" />
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="resheader">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
              </xsd:sequence>
              <xsd:attribute name="name" type="xsd:string" use="required" />
            </xsd:complexType>
          </xsd:element>
        </xsd:choice>
      </xsd:complexType>
    </xsd:element>
  </xsd:schema>
  <resheader name="resmimetype">
    <value>text/microsoft-resx</value>
  </resheader>
  <resheader name="version">
    <value>2.0</value>
  </resheader>
  <resheader name="reader">
    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name="writer">
    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <data name="key1" xml:space="preserve">
    <value>値1</value>
  </data>
  <data name="key2" xml:space="preserve">
    <value>値2</value>
  </data>
  <data name="key3" xml:space="preserve">
    <value>値3</value>
  </data>
</root>

リソース3つでこれほどの長さ。xmlですのでテキストエディタでも作れるかと思いましたが、人間が正しく入力することを期待するには無理がある長さです。

今度は作成したsample.resxを読み込んでみます。

ファイル名:resx2.ps1

<#
.SYNOPSIS
 文字列を含むリソースファイルから文字列を取りだすサンプル
#>

using namespace System
using namespace System.Resources

Set-StrictMode -Version Latest
$ErrorActionPreference = "STOP"


function Main
{
    $resx_path = ".\sample.resx"
    try {
        $resx = [ResXResourceSet]::new($resx_path) 
        Write-Host ("key1:{0}" -f $resx.GetString("key1"))
        Write-Host ("key2:{0}" -f $resx.GetString("key2"))
        Write-Host ("key3:{0}" -f $resx.GetString("key3"))
    } finally {
        $resx.Close()
    }

}
Main

結果

PS H:\ps1\resx_string> H:\ps1\resx_string\resx2.ps1
key1:値1
key2:値2
key3:値3

値が取りだすことが出来ました。

コメント