2012/12/14
型を定義する方法 [PS Advent Calendar '12]
本記事はPowerShell Advent Calendar 2012の14日目の記事になります。
前回(アドベントカレンダー1日目)は「PowerShellらしい関数の書き方」と題して、パイプライン内でうまく他のコマンドと連携させるための関数をどう書けばいいのか、ということについて書きました。前回の関数の例では入力型と出力型がstringだったのですが、実際は自分で定義した型を入力、出力値に取るように書くのが普通かと思います。今回は、それをするためにどうやって型を定義するのか、そしてその型を関数にどう指定するのか、という話をします。
PowerShellにはクラス定義構文がない
そもそもの話になるんですが、型を定義する、つまりはクラスを記述するためのPowerShellのステートメントやコマンドレットが無いため、PowerShell単独ではできません。なので無理です以上おしまい。…というわけにはいかないので、実際はどうするのがいいのかという話をしていきます。
方法としては大きく分けて二つあると思います。
1.C#など他の.NET言語を用いてクラスを記述する
2.ユーザー定義オブジェクトを作成する
今回は1の方法を説明します。
C#を用いてクラスを記述する
つまりはPowerShellでクラスを定義できないなら、C#を使えばいいじゃない。ということです。幸いPowerShell 2.0からはAdd-Typeというコマンドレットを用いると、C#やVBなど.NET言語のソースをその場でコンパイルしてアセンブリとして現在のセッションに読み込むことが可能です。
たとえば、論理ドライブを表すDriveというクラスを定義してみます。
Add-Type -TypeDefinition @" namespace Winscript { public enum DriveType { Unknown, NoRootDirectory, RemovableDisk, LocalDisk, NetworkDrive, CompactDisc, RAMDisk } public class Drive { public string Name {get;set;} public string VolumeName {get;set;} public DriveType Type {get;set;} public long Size {get;set;} public long FreeSpace {get;set;} public long UsedSpace {get;set;} public string RootPath {get;set;} } } "@ -Language CSharpVersion3
このようにC#のコードを文字列として-TypeDefinitionパラメータに与えると、コンパイルされて指定のクラス(ここではWinscript.Drive)がロードされます。
ここで-Language CSharpVersion3というパラメータは指定コードをC# 3.0としてコンパイルすることを指定するため、今回使用している自動実装プロパティなどC# 3.0の構文が利用できます。なおこのパラメータはPowerShell 3.0では不要です。ただし明示しておくとPowerShell 2.0でも正しく動作します。というのも-Languageパラメータ省略時はPowerShell 2.0ではC# 2.0でコンパイルされるのですが、PowerShell 3.0ではC# 3.0でコンパイルするためです(逆にPSv3でC#2.0でコンパイルするには”CSharpVersion2”という新しく追加されたパラメータ値を指定します)。
なお、ここでは-TypeDefinitionパラメータを用いてクラス全体を記述しましたが、この例のように列挙体も定義してそれをプロパティの型にするなどせず、すべて基本型のプロパティで完結するのならば、-MemberDefinitionパラメータを使ってメンバ定義だけを行う方が記述が短くなります。以下はWinscript.Manというクラスを定義する例です。
Add-Type -Namespace Winscript -Name Man -MemberDefinition @" public int Age {get;set;} public string Name {get;set;} "@ -Language CSharpVersion3
例のようにC#のコード内には特にロジックを記述せず、単にデータの入れ物となるクラスにとどめておくのが良いかと思います。別にロジックを書いてもいいのですが、ISEで記述する限りはC#の編集に関してはただのテキストエディタレベルの恩恵しか受けないですし、それなら最初からVisual Studio使ってC#で全部コマンドレットとして書けばいいのに、ともなりかねないので。PowerShellでは実現困難な処理などがあればそれをメソッドとして書く程度ならいいかもしれません。ただしメソッドを記述してもそれをユーザーに直接使わせるというよりも、関数でラップして使わせる形が望ましいでしょう。
さて、次はこのクラスのオブジェクトを扱う関数を記述していきます。
定義した型のオブジェクトを扱う関数の記述
ここでは3つの関数を定義しています。Get-Drive関数はシステムに含まれるすべての論理ドライブを取得、Show-Drive関数は指定のDriveオブジェクトをエクスプローラで開く、Set-Drive関数は指定のDriveオブジェクトのボリューム名(VolumeNameプロパティ)を変更するものです。
ちなみに関数の動詞部分(ここではGet, Show, Set)は、Get-Verb関数で取得できるリスト以外のものは基本的に使わないようにします。モジュールに組み込んだ場合、インポートのたびに警告が出てしまうので。
関数の基本については前回に書いているので、今回のコードはそれを踏まえて読んでみてください。
function Get-Drive { [OutputType([Winscript.Drive])] param( [string[]]$Name, [Winscript.DriveType]$Type ) Get-WmiObject -Class Win32_LogicalDisk | ForEach-Object { if($null -ne $Name -and $Name -notcontains $_.Name) { } elseif($Type -ne $null -and $_.DriveType -ne $Type) { } else { New-Object Winscript.Drive -Property @{ Name = $_.Name VolumeName = $_.VolumeName Type = [enum]::Parse([Winscript.DriveType],$_.DriveType) RootPath = if($_.ProviderName -ne $null){$_.ProviderName}else{$_.Name + "\"} Size = $_.Size FreeSpace = $_.FreeSpace UsedSpace = $_.Size - $_.FreeSpace } } } }
(↑10:33 foreachステートメントではなくForEach-Objectコマンドレットを使うように修正。Get-*な関数のようにパイプラインの先頭で実行する関数でも、内部でPowerShellのコマンドレットや関数の出力を利用する場合は、配列化してforeachするよりも、ForEach-Objectで出力を逐次処理した方が良いですね。内部関数の出力がすべて完了してから一気に出力するのではなく、内部関数が1個オブジェクトを出力するたびに出力するようにできるので。)
function Show-Drive { [OutputType([Winscript.Drive])] param( [Parameter(ValueFromPipeline=$true,Mandatory=$true)] [Winscript.Drive[]] $Drive, [switch] $PassThru ) process { foreach($d in $Drive) { Start-Process $d.Name if($PassThru) { $d } } } }
function Set-Drive { param( [Parameter(ValueFromPipeline=$true,Mandatory=$true)] [Winscript.Drive] $Drive, [Parameter(Mandatory=$true)] [string] $VolumeName ) process { Get-WmiObject Win32_LogicalDisk -Filter "DeviceID='$($Drive.Name)'" | Set-WmiInstance -Arguments @{VolumeName=$VolumeName} | Out-Null } }
細かい説明は省きますが、前回説明した関数の基本フォーマットに、自分で定義した型を適用してロジックを書くとこうなる、という参考例としてとらえてください。
一つだけ前回に説明し忘れてたことがあります。それは[OutputType]属性です。これは文字通り、関数の出力型を指定するものです。この属性を指定しておくと何が嬉しいかというと、関数の出力を変数に代入したりWhere-Objectコマンドレットでフィルタをかけるコードを記述する際、関数の実行「前」にもプロパティ名をちゃんとタブ補完してくれるようになります。残念ながらこの静的解析機能はPowerShell 3.0からのものなので2.0だとできませんが、OutputType属性自体は2.0でも定義可能なので、定義しておくことを推奨します。
さて、型の定義と関数の定義をしたので実際に関数を実行してみます。
PS> Get-Drive # 全ドライブ取得 Name : C: VolumeName : Type : LocalDisk Size : 119926681600 FreeSpace : 12262494208 UsedSpace : 107664187392 RootPath : C:\ Name : D: VolumeName : Type : LocalDisk Size : 500086886400 FreeSpace : 198589583360 UsedSpace : 301497303040 RootPath : D:\ Name : Q: VolumeName : Type : CompactDisc Size : 0 FreeSpace : 0 UsedSpace : 0 RootPath : Q:\ Name : V: VolumeName : Type : NetworkDrive Size : 1500299390976 FreeSpace : 571001868288 UsedSpace : 929297522688 RootPath : \\server\D PS> Get-Drive | where {$_.Size -gt 1TB} # Where-Objectでフィルタ Name : V: VolumeName : Type : NetworkDrive Size : 1500299390976 FreeSpace : 571001868288 UsedSpace : 929297522688 RootPath : \\server\D PS> Get-Drive -Type NetworkDrive | Show-Drive -PassThru | ConvertTo-Csv #ネットワークドライブのみエクスプローラーで開く。取得結果はCSVとして出力。 #TYPE Winscript.Drive "Name","VolumeName","Type","Size","FreeSpace","UsedSpace","RootPath" "V:","","NetworkDrive","1500299390976","571001868288","929297522688","\\server\D" PS> Get-Drive -Name D: | Set-Drive -VolumeName 新しいドライブ # D:ドライブのボリューム名を指定。(管理者権限で)
関数をきちんとPowerShellの流儀に従って記述したおかげで、このようにPowerShellの他の標準コマンドレットと同様の呼び出し方ができ、自作関数やそれ以外のコマンド同士をうまくパイプラインで繋げて実行することができています。
さて、おそらく一つ気になる点があるとすれば、ドライブの容量表示が見づらいということでしょう。容量であればGBとかの単位で表示してほしいですし、大きい数字は,で桁を区切ってほしいですよね。じゃあそういう値を文字列で返すプロパティを定義してやる必要があるというかと言えばそんなことはなく、PowerShellには型に応じた表示フォーマットを指定する方法が用意されています。次回はそのあたりを解説しようと思います。
また、C#とかめんどくさいしもうちょっと楽な方法はないのか?ということで、最初の方でちょっと触れた、ユーザー定義オブジェクトを利用する方法も、余裕があれば次回に。
さて、PSアドベントカレンダー、明日はsunnyoneさんです。よろしくお願いします!
プライバシーポリシー