RSS2.02011/12/13
バックグラウンドジョブとの通信 [PS Advent Calendar '11]
はじめに
この記事はPowerShell Advent Calendar 2011の13日目、そして私の2回目の記事となります。
今日のテーマは前回の続きで、PowerShellのバックグラウンドジョブの結果を読み取ったり、バックグラウンドジョブに値を与えたりして、ジョブと通信を行う方法を解説します。
ジョブから呼び出し元に値を返却する
ジョブの結果を取得するにはReceive-Jobコマンドレットを使用すれば良いと前回書きましたが、今回はジョブ側から結果を返す実際の方法を示します。
基本的にPowerShellのスクリプトやスクリプトブロックが呼び出し元に返却する値というのは、そのスクリプト（or ブロック）でパイプラインを通じて最終的にデフォルト出力に渡されたすべての値です。複数行に渡って出力されている場合は、呼び出し元にはその配列(object[])として返却されます。
ジョブにおいてもそれは同様で、基本的にStart-Jobなどで生成したスクリプトやスクリプトブロックが出力したすべての値がジョブの出力となり、呼び出し元からはReceive-Jobコマンドレットで受け取ることができます。
以下に現在の日付時刻を出力するサンプルを示します。サンプルなのでジョブなのに同期的な処理になってますがご了承を。
$job=Start-Job {
Start-Sleep -sec 5
Get-Date
}
Wait-Job $job|Receive-Job
複数だと以下のようになります。
$job=Start-Job {
Start-Sleep -sec 1
"Give me job."
Get-Date
1+1
}
Wait-Job $job|Receive-Job
この場合だと文字列、日付時刻、数値の3種類のオブジェクトが出力されますので、結果は長さ3のobject配列になります。そのためこれらの値を個別に取り出す場合は次のようにします。
$job=Start-Job {
Start-Sleep -sec 1
"Give me job."
Get-Date
1+1
}
$result=Wait-Job $job|Receive-Job
Write-Host $result[0]
Write-Host $result[1].ToString("yyyyMMdd")
Write-Host $result[2]
このように配列のインデックスで各値にアクセスできますが、これだと受け取り側での処理が分かりにくいと思われるかもしれませんね。
そこでお勧めなのが、このように複数値を返却するのではなく、カスタムオブジェクトを1つだけ返却するようにする方法です。
$job = Start-Job {
Start-Sleep -sec 1
$ret = New-Object PSObject -property @{
String = "Give me job.";
Date = Get-Date;
Number = 1+1
}
$ret
}
$result = Wait-Job $job|Receive-Job
Write-Host $result.String
Write-Host $result.Date.ToString("yyyyMMdd")
Write-Host $result.Number
この方法ではジョブの中でNew-Objectコマンドレットでカスタムオブジェクトを作成し、それを返却しています。返却値は1つのオブジェクトでそのプロパティに値が格納されているのでドット演算子で値を参照できるようになりました。
ただしこの方法にも欠点があって、Receive-Objectで結果を参照するとき、ジョブが終了するまですべての値が参照できません。実はジョブが完了してない段階でも、Receive-Objectを実行するとジョブがそこまで出力した値を逐次取得することができるのです。よって
$job=Start-Job {
Start-Sleep -sec 3
"Give me job."
Start-Sleep -sec 3
Get-Date
Start-Sleep -sec 3
1+1
}
のようにしてジョブを走らせた後、適当な間隔で
$job|Receive-Job
を実行すると、それまでに出力した部分までを取得して書き出します。先程の例のように出力をカスタムオブジェクトでまとめてしまうとこの手法が使えなくなってしまいます。
どちらもメリット、デメリットがあるのでうまく使い分けると良いかと思います。具体的にはジョブの実行途中では結果を取得せず、ジョブ完了後の最終的な結果のみまとめて参照したい場合はカスタムオブジェクトで返却し、それ以外はそのまま随時値を返却するようにすればいいと思います。
さて、ジョブの結果を受け取る際にもう一点注意しなければならないことがあります。それはジョブが返すオブジェクトの型です。PowerShellのジョブ機能はリモーティング機構の上に構築されているというのは前回も書きましたが、その関係上、呼び出し元とジョブとの間でオブジェクトを受け渡しする場合は一度シリアル化され、受け取り側でデシリアライズされます。
オブジェクトのクラスもしくは構造体がシリアライズ可能（Serializable属性がついている）なら、PowerShellによりシリアル化→デシリアライズされたオブジェクトはシリアル化される前のオブジェクトと同一のものです。しかしそうではないオブジェクトの場合だと完全に元と同じオブジェクトには復元されません。
たとえば(Get-Process)[0]をジョブで実行するとSystem.Diagnostics.Processオブジェクトが得られますが、それをジョブの呼び出し元に返却するとDeserialized.System.Diagnostics.Processというカスタムオブジェクトに変換されます。このオブジェクトは各プロパティ値は（シリアル化可能なものだけ）保持しているものの、メソッド定義などは消失しているのでこのオブジェクトのメソッドを実行することはできません。
ちなみにSystem.StringクラスやSystem.Int32やSystem.DateTime構造体はSerializable属性がついているのでジョブの結果として取得しても元のオブジェクトと同一なので、メソッドなどが呼び出し可能です。
ジョブに呼び出し元の値を渡す
今度は逆の場合です。ジョブを走らせるとき、呼び出し元からジョブに値を渡す方法です。
$job = Start-Job {
param($date,$value)
Start-Sleep -sec 1
"${date}の${value}日後の日付は" + $date.AddDays($value).ToString("yyyy/MM/dd") + "です。"
} -argumentList @((Get-Date),1)
Wait-Job $job|Receive-Job
このようにStart-Jobコマンドレットの-argumentListパラメータに、ジョブに渡したい値を指定すればOKです。複数ある場合はこのように配列指定も可能です。
ジョブ側ではparamキーワードで仮引数を指定しておけば、スクリプトブロック内で呼び出し元の値が格納された変数を使用できます。ここではparamを使いましたが、paramを使用しない場合は$argsに実引数が配列として格納されているので、これを利用するのでもOKです。
値を渡す場合でもシリアライズとデシリアライズが行われるので、その点だけは注意が必要です。
ジョブは呼び出し元と別インスタンスなので、呼び出し元に読み込まれた関数を参照することはできません。よってジョブでも呼び出し元で定義した関数を実行したい場合は同様に-argumentListで関数の実体であるスクリプトブロックを送ってやる必要があります。
function Get-Test
{
"テスト！" + (1+1)
}
$job = Start-Job {
param($sb)
&([scriptblock]::Create($sb))
} -argumentList (Get-Item Function:\Get-Test).ScriptBlock
Wait-Job $job|Receive-Job
-argumentListでスクリプトブロックを渡すとStringにキャストされてしまうので、ジョブ内でそれをCreateメソッドでスクリプトブロックに戻してから実行演算子&で実行するという回りくどいことになってしまいました。関数にこだわらなければ呼び出し側でスクリプトブロックを作って変数に入れ、それを-argumentListに入れてやると少しだけ記述がシンプルになりますが、ジョブ内でスクリプトブロックを復元しなければならないのは同様です。
いずれにせよあんまり美しくないのでお勧めしません。こんなことをやるくらいならジョブの中あるいは -InitializationScriptパラメータの中で関数やスクリプトブロックを定義してやるか、関数を別スクリプトファイルに切り出して、そのスクリプトファイルをジョブ内で読み込むほうが良いかと思います。前者の場合だと呼び出し元とジョブ内で関数を共有することはできませんが、後者の方法だとファイルとしては分割してしまいますが可能です。
おわりに
今回はジョブと通信する方法として、ジョブから結果を出力したり、ジョブに値を渡したりする方法をまとめました。意外と落とし穴が多いので注意してください。
このシリーズはあと1回だけ続く予定です。お楽しみに。
2011/11/14
TechNet マガジン Oct. 2011のPowerShell記事（コード整形）に対する意見
TechNet マガジン October 2011内のWindows PowerShell: 空白文字を入れてくださいという記事に対する意見です。
PowerShellスクリプトを記述するときは適宜空白文字やインデントを入れて見やすくしましょう、という趣旨の記事なんですが、その趣旨には同意するものの、どうも実際にインデントを入れたスクリプトの例がいけてない気がしました。
ここでインデントや改行などを適切に追加して体裁を整えたとされるコードは次のようなものです。
（ブログのスタイルに起因する見え方の違いが考えられるので、比較のためにオリジナルも再掲させていただきます）
function Get-PCInfo {
[CmdletBinding()]
param(
[Parameter(Mandatory=$True,
ValueFromPipeline=$True,
ValueFromPipelineByPropertyName=$True)]
[string[]]$computername
)
PROCESS {
Write-Verbose "Beginning PROCESS block"
foreach ($computer in $computername) {
Write-Verbose "Connecting to $computer"
try {
$continue = $true
$cs = Get-WmiObject -EV mybad -EA Stop `
-Class Win32_computersystem `
-ComputerName $computer
} catch {
$continue = $false
$computer |
Out-File -FilePath oops.txt -append
Write-Verbose "$computer failed"
$mybad | ForEach-Object { Write-Verbose $_ }
}
if ($continue) {
$proc = Get-WmiObject win32_processor `
-ComputerName $computer |
select -first 1
$obj = new-object -TypeName PSObject
$obj | add-member NoteProperty ComputerName $computer
$obj | add-member NoteProperty ProcArchitecture $proc.addresswidth
$obj | add-member NoteProperty Domain $cs.domain
$obj | add-member NoteProperty PCModel $cs.model
$obj.psobject.typenames.insert(0,'MyPCInfo')
write-output $obj
}
}
}
}
最初見た時、全体的に何がなんだか分からなかったのですが、よくよく見てみると一応ルールはあるようで、一つの文を改行して複数行に記述する場合は、二行目以降は文頭から詰めて記述する、というルールに従っているようです。
こういう書き方はかえって読みづらいと感じてしまうのは私だけでしょうか？ 確かに、Webページや書籍などで一行がスペースに収まらないときに強制的に改行して表示する場合にこのような体裁になることはありますが、これははっきり言って読みづらいです。
せっかく自分で改行を入れるわけですから、改行したときも読みやすくしたほうがいいでしょう（そもそも強制改行されて読みづらくなるというのを防ぐというのも、自分で改行を入れる意義の一つなわけですから）。
あとparam()やforeach{}のインデント位置はそもそもなぜそうなのかよくわかりませんね（単なる編集ミスだろうか？）。
この辺を踏まえて、私流にインデントを入れるとこんな感じです。
function Get-PCInfo
{
[CmdletBinding()]
param
(
[Parameter(
Mandatory=$True,
ValueFromPipeline=$True,
ValueFromPipelineByPropertyName=$True
)]
[string[]]$computername
)
process
{
Write-Verbose "Beginning PROCESS block"
foreach ($computer in $computername)
{
Write-Verbose "Connecting to $computer"
try
{
$continue = $true
$cs = Get-WmiObject -EV mybad -EA Stop `
-Class Win32_computersystem -ComputerName $computer
}
catch
{
$continue = $false
$computer |
Out-File -FilePath oops.txt -append
Write-Verbose "$computer failed"
$mybad | ForEach-Object { Write-Verbose $_ }
}
if ($continue)
{
$proc = Get-WmiObject win32_processor `
-ComputerName $computer |
select -first 1
$obj = new-object -TypeName PSObject
$obj | add-member NoteProperty ComputerName $computer
$obj | add-member NoteProperty ProcArchitecture $proc.addresswidth
$obj | add-member NoteProperty Domain $cs.domain
$obj | add-member NoteProperty PCModel $cs.model
$obj.psobject.typenames.insert(0,'MyPCInfo')
write-output $obj
}
}
}
}
こんな感じでPowerShellも基本的には他の言語のコード整形の流儀に準じればいいと思います。唯一PowerShellで特徴的なのは複数行に渡るパイプラインの記述方法になると思いますが、そこも特に深く考えずに一段インデントを深くする程度でいいのではないかと思います。
あと「一貫性」の節で、「{」を改行の前に入れるか後に入れるかは統一させよとありますが、基本的にはそれでいいと思います。ただ改行の後に「{」を入れるスタイル（私の書いた例）でも、改行後に「{」や「(」を入れるとコードの意味が変わったりエラーになったりする場合が出てくるので、その場合はわざわざ継続文字「`」を入れてやらずとも、その部分だけは改行前に入れてやってもいいかなと思います。
具体的にはこのコードでいうと「[Parameter( 」のところなどですね。あとスクリプトブロックをパラメータに取るコマンドレットの場合なんかもそうです。
@(1..12)|ForEach-Object {
Write-Host $_
Write-Host ($_ * $_)
}
こういうのですね。この場合ForEach-Objectコマンドレットの-processパラメータ（ここではパラメータ名は省略されている）にスクリプトブロックを指定しているのですが、「{」はスクリプトブロックリテラルの開始文字なので、改行後に入れると正しく動作しません。
PowerShell ISEはまだVisual Studioなどに比べると編集機能が貧弱で、構文を元に自動的に整形してくれたりしないので、ユーザーが自分ルールで整形していかないといけないです。しかし基本的には他の言語と同様な、素直な整形を施してやれば特に読みづらくなるということもないかなと思います。
元記事：http://blogs.wankuma.com/mutaguchi/archive/2011/11/14/212009.aspx2011/09/08
クリップボードアクセス完結編
PowerShellでクリップボードを読み書きする方法については5年ほど前にクリップボードアクセス（未完）II という記事を書きました。タイトル通り未完でして、このたび完結編を書こうと思いました。
System.Windows.Forms.Clipboardクラスを使う場合は先の記事にあるようにPowerShellをSTAで動作させる必要があります。ver.1の当時はその方法がありませんでしたが、ver.2ではpowershell.exeに-staパラメータが追加され、STAでの実行が可能となっています。
-staパラメータを使用しない場合は相変わらずこの方法は使えません。powershell.exe –staのプロセスを逐次起こして、クリップボードアクセス部分だけSTAの子プロセスでやらせることも不可能ではないですが、冗長ですしパフォーマンスの点で難があります。
ver.2ではAdd-Typeコマンドレットが追加され、任意のC#コードを動的に読み込むことができるようになりました。これを利用してクリップボードアクセスクラスを書くという手もあると思います。その中ではSTAのスレッドを起こしてクリップボードアクセスをすることになります。実際PowerShell Community Extensionsに含まれるOut-Clipboard/Get-Clipboardコマンドレットはそのような実装がされているようです。ですが動的にコードを読み込みコンパイルはやはりパフォーマンス上不利ですし、PSCXをインストールできない場合などもあるでしょう。
ところでSystem.Windows.Formsに含まれるTextBoxクラスはその名の通りテキストボックスコントロールなのですが、このコントロールにはCopy()メソッドとPaste()メソッドがあり、これらを使うとクリップボードに書き込み、クリップボードから読み込みが可能です。TextBoxクラスの良いところは、STAである必要がないところです。この方法を最初に提唱したのはこちらの方かな？
この方法を用いた関数もすでに公開されているのですが、PowerShellの作法に則った使い方ができるように少し改良を加えました。具体的には
Set-ClipBoard: 配列の指定、パイプラインからの入力を可能にした。
Get-ClipBoard: クリップボードの中身が複数行のテキストの場合、文字列配列を返すようにした。(Get-Contentと同様)
という変更を加えています。
function Set-ClipBoard
{
param([parameter(Mandatory=$true,
ValueFromPipeline=$true)][object[]]$InputObject)
begin
{
Add-Type -AssemblyName System.Windows.Forms
$tb = New-Object System.Windows.Forms.TextBox
$tb.Multiline = $true
$out=@()
}
process
{
$out+=$InputObject
}
end
{
$tb.Text = $out -join "`r`n"
$tb.SelectAll()
$tb.Copy()
}
}
function Get-ClipBoard
{
Add-Type -AssemblyName System.Windows.Forms
$tb = New-Object System.Windows.Forms.TextBox
$tb.Multiline = $true
$tb.Paste()
$tb.Text -replace "`r`n","`n" -replace "`r","`n" -split "`n"
}
使い方例
# ファイルのフルパスをクリップボードに格納 Get-ChildItem|select -expand fullname|Set-ClipBoard # CSV文字列がクリップボードに入っている場合以下のコマンドを実行すると、 # クリップボードの中身が対応するHTML tableタグに置換される Get-ClipBoard|ConvertFrom-Csv|ConvertTo-Html -Fragment|Set-ClipBoard
やっぱりパイプで繋ぐのがPowerShellの醍醐味ですよね！
元記事：http://blogs.wankuma.com/mutaguchi/archive/2011/09/08/202547.aspx2011/03/25
ジャグ配列も、多次元配列も、あるんだよ
PowerShellは一次元のobject配列を多用しますが、実は他言語と同様に、多次元配列やジャグ配列（配列の配列）もちゃんとあります。
ジャグ配列
ジャグ配列の作成
PS > $array = @(@("a","b"),@("c","d","e"))
配列の参照
PS > $array a b c d e PS > $array.Length 2 PS > $array[0] a b PS > $array[0][1] b
ジャグ配列の作成は、配列をまず作って、その配列を要素に持つ配列を作成するとできます。とても直感的かと思います。ただしここで注意しなければならない点は、
PS > $array = @(@("a","b") + @("c","d","e"))
のように、配列を+演算子で連結するのは駄目であるという点です。こうしてしまうと単に一次元配列同士が連結された要素数5の一次元配列が生成されてしまいます。
さて、このようにジャグ配列に含まれる配列とその数があらかじめ分かっている場合はこのように,演算子を使えば問題ありませんが、そうではない場合はちょっと工夫が必要です。たとえば「テキストファイルの一行ごとにchar[]配列を作り、それらを要素に持つジャグ配列を作成する」ことを考えてみましょう。まず最初に駄目な例。
$lines = @(Get-Content file.txt)
$array = @()
foreach($line in $lines)
{
$array += [char[]]$line
}
これは一見うまくいきそうですが、先ほどと同じパターンで$arrayは単なるchar[]の一次元配列になってしまいます。目的のジャグ配列を得るには次のようにします。
$lines = @(Get-Content file.txt)
$array = @()
foreach($line in $lines)
{
$array += ,[char[]]$line
}
ここでは配列要素の追加処理の際、配列に「,」を前置することによって「配列要素を展開することなく、配列そのものとして扱う」ようにしています。こうすることで$arrayにはchar[]配列そのものが要素として追加され、結果としてジャグ配列が格納されます。
多次元配列
2x2の多次元配列を作成
PS > $array = New-Object "object[,]" 2,2
要素に値を代入
PS > $array[0,0] = "a" PS > $array[0,1] = "b" PS > $array[1,0] = "c" PS > $array[1,1] = "d"
配列の参照
PS > $array a b c d
配列のスライス
PS > $array[@(0,0)] a PS > $array[@(0,0),@(0,1)] a b PS > $array[@(0,0),@(1,0)] a c
配列の作成の仕方がちょっと気持ち悪いですが、これはサイズ固定の一次元配列を作るときと同じ要領です。
配列のスライスも可能で、切り出したい要素のインデックスを「要素のインデックスを表す配列」で指定します。たとえば$array[0,0]を取り出したい場合は$array[@(0,0)]になるわけですね。複数の要素を切り出したい場合は「要素のインデックスを表す配列」の配列（つまりはジャグ配列）を指定することになります。
おまけ：一次元配列のちょっとしたtips
変数、プロパティ、コマンドレットの戻り値などで、その値が配列かそうでないかが事前に分からない場合でも、必ず配列として処理したい場合には@を用います。
$lines = Get-Content file.txt
Get-Contentコマンドレットはテキストファイルが1行の場合は、$linesには文字列の配列ではなく文字列が格納されます（複数行なら行ごとの文字列が格納された配列になる）。よってこの場合$linesが配列かどうかは事前には分からないことになります。テキストファイルの1行目を取得するつもりで $lines[0] とやっても、もしテキストファイルが1行だった場合は、その1行の一文字目が返ってきてしまいます。このような事態を防ぐには、
$lines = @(Get-Content file.txt)
のようにすると、$linesには必ず配列が格納されます。たとえテキストファイルが1行でも、要素数1の配列になります。
これとは逆のケースで、「配列か非配列かわからないが、必ず非配列として扱いたい」場合は次のようにするのも手でしょう。
$value = @($unknown)[0]
この場合だともし$unknownが配列だったとしても、その1要素目をとってきて$valueに格納してくれます。本来なら$unknownが配列かどうか確かめて、その要素数がいくつであるかなどを確認すべきなんですが、「非配列か要素数1の配列どちらかが返されるパターン」というのはADSIやXMLなど扱う際に意外と多くて、そういう場合に有用かと思います。
JavaScriptの配列操作と同じようなことをする方法
$array = @(1..5) # push(配列末尾に値を追加) $array += 6 # unshift（配列先頭に値を追加） $array = @(0) + $array # shift（配列先頭の値を削除） $array[0]; $array = $array[1..($array.length-1)] # pop（配列末尾の値を削除） $array[$array.length-1]; $array=$array[0..($array.length-2)]元記事：http://blogs.wankuma.com/mutaguchi/archive/2011/03/25/197857.aspx
2010/02/13
PowerShell基礎文法最速マスター
PowerShellは.NET Framework 2.0を利用するWindowsのシステム管理用シェルである。シェルであるためコンソールで対話的にコマンドを実行することができるのはもちろん、スクリプトファイル(*.ps1)を記述しバッチ的に実行することも可能である。ここではPowerShellスクリプトで（コンソールでも使用は可能だが）用いることのできる基礎文法を紹介する。なお、PowerShellでは文法上、大文字小文字を区別しない。
※（★2.0）の注釈があるものはPowerShell 2.0で新たに追加された要素である。
1.基礎
表示
コンソールに文字列を表示。
"Hello world"
コマンドレット（後述）を使用した場合。
Write-Host "Hello world"
コマンドレット
PowerShellはコマンドレットと呼ばれる100種類以上のコマンドライン・ツール群を単独で、あるいはパイプライン（後述）で連結して使用するのが基本となる。コマンドレットは原則verb-nounという命名規則にしたがっている。パラメータをつける場合は「-パラメータ名」あるいは「-パラメータ名 パラメータ値」を指定する。
# コマンドレットの一覧表示 Get-Command # サービスの一覧を表示 Get-Service # アプリケーション イベントログの最新15個のエントリを表示 Get-EventLog -logName Application -newest 15
パイプライン
コマンドレットが値を返却する場合、.NET Frameworkのオブジェクトが含まれる配列であることが多い。このオブジェクト配列がパイプラインを渡って後続のコマンドレットに入力される。
# プロセスのリスト（System.Diagnostics.Processオブジェクトの配列）を取得し、
# Where-Objectコマンドレットでハンドル数（handlesプロパティ）の値が500より大きいものだけを取り出し
# Select-Objectコマンドレットで最初の5つのオブジェクトだけを切りだして表示
Get-Process | Where-Object {$_.handles -gt 500} | Select-Object -first 5
# C:\Windows 配下のフォルダ、ファイルの一覧（System.IO.DirectoryInfo,System.IO.FileInfoオブジェクトの配列）を取得し、
# ForEach-Objectコマンドレットで配列を列挙しすべてのオブジェクトのFullNameプロパティ（フルパス）の値を表示
Get-ChildItem C:\Windows | ForEach-Object {$_.FullName}
# 通常の配列に関してもパイプラインを使用可能。
# 重複を取り除き、ソートをかける
@(3,5,10,1,2,1,1,1,2,6,4,4)|Sort-Object|Get-Unique
コメント
# コメント
マルチラインコメント(★2.0)
<# 複数行に渡る コメントです #>
変数の宣言
PowerShellは変数の宣言をしなくても変数を使用可能。以下のようにするとどのような型でも代入可能な変数が作られる。
$a = 1 $a = $b = $c = 1 #複数変数に一度に同じ値を代入する場合 $items = Get-ChildItem # コマンドレットの戻り値を格納
変数の型を指定することは可能。以下のようにするとint型のみ格納可能な変数が作られる。
[int]$a = 1
あるいは、コマンドレットを用いて$aという変数を宣言することもできる。この場合変数の型は指定できない。
New-Variable -name a
変数のスコープ
# どのスコープからも読み書き可能 $global:a = 1 # 現在のスコープからのみ読み書き可能 $private:a = 1 # 現在のスクリプトからのみ読み書き可能 $script:a = 1
文法チェック
以下を実行することで未定義の変数を参照するとエラーが出るようになる。
Set-PSDebug -strict
スクリプトの実行
デフォルトの実行ポリシーではスクリプトの実行は不許可であるため、以下のようにポリシーを変更しておく。（RemoteSignedはローカルにあるスクリプトファイルは無条件で実行可、リモートにあるスクリプトファイルは署名付きのもののみ実行可）
Set-ExecutionPolicy RemoteSigned
スクリプト/コマンドを実行するにはコマンドラインで次のようにする。
コマンドを実行する
powershell -command {Get-ChildItem C:\}
ファイルを実行する
powershell .\script.ps1
ドットソース（スクリプトの内容をグローバルスコープに読み込む）
powershell . .\script.ps1
ファイルを実行する(★2.0)
powershell -file script.ps1
PowerShellスクリプトから別のスクリプトを実行する場合（関数のインクルードにも用いられる）
.\script.ps1 . .\script.ps1 # ドットソース
デバッガの起動
Set-PSDebug -trace 2
ステップ実行
Set-PSDebug -step
2.数値
数値の表現
PowerShellにおける数値は.NET Frameworkの数値を表す構造体のインスタンスである。数値には整数、浮動小数点があり、変数に代入した段階で適切な型が設定される。
# int型(System.Int32型) $int = 1 # System.Double型 $double = 1.001
四則演算
# 足し算 $i = 1 + 1 # 引き算 $i = 1 - 1 # 掛け算 $i = 1 * 1 # 割り算 $i = 1 / 1
余りと商の求め方
# 割り算の余り $mod = 7 % 3 # 上記の場合の商 $div = (7 - 7 % 3) / 3
べき乗
# 2の8乗 $i = [math]::Pow(2,8)
インクリメントとデクリメント
# インクリメント $i++ # デクリメント $i--
3.文字列
PowerShellにおける文字列は.NET Frameworkの System.Stringクラスのインスタンスである。
文字列の表現
文字列はシングルクォーテーションかダブルクォーテーションで囲む。ダブルクォーテーションの中では`t(タブ)や`r`n(改行)などの特殊文字が使用でき、変数が展開される。
$str1 = 'abc' $str2 = "def" $str3 = "a`tbc`r`n" #変数展開（結果は abc def） $str4 = "$str1 def"
文字列操作
各種文字列操作
# 結合
$join1 = "aaa" + "bbb"
$join2 = [string]::Join(",",@("aaa","bbb","ccc") )
# 結合（★2.0）
$join2 = @("aaa","bbb","ccc") -join ","
# 分割
$record1 = "aaa,bbb,ccc".Split(",")
# 分割（★2.0）
$record2 = "aaa,bbb,ccc" -split ","
# 長さ
$length = "abcdef".Length
# 切り出し
$substr = "abcd".SubString(0,2) # ab
正規表現検索
# hitした場合はTrue,しなかった場合はFalse $result = "abcd" -match "cd" # 最初に見つかった文字列。添え字の1,2…には()内のサブ式にhitした文字列が格納。 $matches[0]
正規表現置換
$result = "abc" -replace "c","d"
4.配列
PowerShellにおける配列は.NET Frameworkの System.Arrayクラスのインスタンスである。
配列の参照と代入
# 5個の要素を持つ配列宣言と代入 $arr1 = @(1,3,5,7,9) # 以下のようにも記述できる $arr1 = 1,3,5,7,9 # 型指定する場合 [int[]]$arr1 = @(1,3,5,7,9) # 1〜10までの要素を持つ配列宣言と代入 $arr2 = @(1..10) # 1要素の配列宣言と代入 $arr3 = @(1) $arr3 = ,1 # 空の配列宣言と代入 $arr4 = @()
配列の要素の参照と代入
# 4番目の要素を参照 $ret = $arr2[3] # 6〜9番目の要素を含んだ配列を参照 $ret = $arr2[5..8] # 1〜4番目と8番目の要素を含んだ配列を参照 $ret = $arr2[0..3+7] # 配列の末尾の要素を取り出す $ret = $arr2[-1] # 5番目の要素に値を代入 $arr2[4] = 11 # 3より小さな要素を含んだ配列を返す $ret = $arr2 -lt 3
配列の個数
$arr1_num = $arr1.Length
配列の操作
$arr1 = @(1,3,5,7,9) $arr2 = @(1..10) # 配列の末尾に要素を加える(push) $arr2 += 50 # 配列を結合し新しい配列を作成 $arr5 = $arr1 + $arr2 # 配列にある要素が含まれるかどうか(ここではTrue) $arr2 -contains 2
5.ハッシュ
PowerShellにおけるハッシュは.NET Frameworkの System.Collections.Hashtableクラスのインスタンスである。
ハッシュ変数の宣言と代入
# 3つの要素を持つハッシュの宣言と代入
$hash1 = @{a=1;b=2;c=3}
# 空のハッシュの宣言と代入
$hash2 = @{}
ハッシュの要素の参照と代入
# 要素の参照 $hash1.a $hash1["a"] #要素の代入 $hash1.b = 5 $hash1["b"] = 5
ハッシュの操作
# ハッシュに要素を追加
$hash1.d = 4
$hash1.Add("e",5)
# ハッシュの要素の削除
$hash1.Remove("a")
# ハッシュのキーの取得
$keys = $hash1.Keys
# ハッシュの値の取得
$values = $hash1.Values
# ハッシュの要素を列挙
foreach ($key in $hash1.Keys)
{
$key + ":" + $hash1[$key]
}
# キーの存在確認
$hash1.Contains("b")
6.制御文
if文
if (条件) {
}
if 〜 else文
if (条件) {
}
else{
}
if 〜 elsif 文
if (条件) {
}
elseif (条件) {
}
while/do文
while (条件) {
}
do {
} while (条件)
for文
for ($i = 0; $i -lt 5; $i++) {
}
foreach文
foreach ($item in $items) {
}
switch文
case を書かないのが特徴的。またスクリプトブロックを条件文に記述できる。
switch ($i) {
1 {"1";break}
2 {"2";break}
{$_ -lt 5} {"5より小さい";break}
default {"default句";break}
}
# ここで$iに配列を指定すると配列要素すべてに対してswitch文が実行される。
比較演算子
比較演算子の一覧。PowerShellではPerlの文字列比較演算子のような記述をおこなうが、Perlとは異なり文字列も数値も同じ書式である。
$num1 -eq $num2 # $num1は$num2と等しい $num1 -ne $num2 # $num1は$num2は等しくない $num1 -lt $num2 # $num1は$num2より小さい $num1 -gt $num2 # $num1は$num2より大きい $num1 -le $num2 # $num1は$num2以下 $num1 -ge $num2 # $num1は$num2以上
論理演算子
# 論理否定 $ret = -not $true $ret = !$true # 論理積 $ret = $true -and $false # 論理和 $ret = $true -or $false # 排他的論理和 $ret = $true -xor $false
ビット演算子
# ビット単位の否定
$ret = -bnot 0x14F4
# ビット単位の積
$ret = 0x14F4 -band 0xFF00
# 上記結果を16進数で表示する場合
$ret = (0x14F4 -band 0xFF00).ToString("X")
# ビット単位の和
$ret = 0x14F4 -bor 0xFF00
# ビット単位の排他的論理和
$ret = 0x14F4 -bxor 0xFF00
7.サブルーチン
PowerShellのサブルーチンには関数とフィルタがある。関数とフィルタは呼び出し行の前で宣言する必要がある。 filter構文もfunction構文と並んで独自関数を記述するものだが、filter構文はパイプラインに渡されたオブジェクトをフィルタするのに用いる。 functionとの違いは、パイプラインに渡した配列を一度に処理するか(function)個別に処理するか(filter)
# 関数宣言の基本
function Get-Test {
return "test"
}
# 注：returnを付けなくても関数内で出力された値はすべて呼び出し元に返却される。返却したくない場合は出力値をを[void]にキャストするか|Out-Nullに渡す。
# 引数を指定する場合
function Get-Test {
param($param1,$param2)
return $param1 + $param2
}
# 引数を指定する場合の簡易的な記述法
function Get-Test($param1,$param2) {
return $param1 + $param2
}
# 引数の型を指定する場合
function Get-Test {
param([string]$param1,[string]$param2)
return $param1 + $param2
}
# 関数の呼び出し方(,区切りではなくスペース区切りであることに注意)
Get-Test "引数1" "引数2"
# 引数の順序はパラメータ名（引数名）を指定すると自由に指定可能
Get-Test -param2 "引数2" -param1 "引数1"
# フィルタ宣言の基本
filter Get-Odd {
if($_ % 2 -eq 1){
return $_
}else{
return
}
}
# フィルタの使用
@(1..10) | Get-Odd
8.テキストファイル入出力
コマンドレットで可能。エンコーディングは日本語環境のデフォルトではShift-JIS。コマンドレット出力のテキストファイルへの書き出しに関してはリダイレクトも可能。この場合エンコーディングはUnicode。
$str1 = "testテスト" Set-Content test.txt $str1 # 書き込み Add-Content test.txt "追記" # 追記 $str2 = Get-Content test.txt # 読み込み Set-Content test.txt $str1 -encoding UTF8 # UTF-8で書き込み # リダイレクト Get-Process > test.txt # 書き込み Get-Process >> test.txt # 追記 Get-Process | Out-File test.txt -encoding UTF8 # エンコーディングを指定する場合
9.例外
PowerShellで例外が発生すると、デフォルトではエラーメッセージを表示し次の行を実行する（シェル変数$ErrorActionPreferenceの設定により挙動の変更可能）。VBでいうとOn Error Resume Nextに近い。エラーが発生すると$Errorにエラー情報の配列が格納され、$?にFalseが格納される。エラーをトラップするには次の構文を使用する。VBでいうとOn Error Goto lineに近い。
# すべてのエラーをトラップ
trap {
}
# エラーの型名を指定してトラップ
trap [System.Management.Automation.CommandNotFoundException] {
}
# エラーを発生させる
throw "エラー"
throw New-Object NullReferenceException
構造化例外処理（★2.0）
# 基本
try{
}
catch{
}
finally{
}
# エラーの型を指定してcatch
try{
}
catch [System.Net.WebException],[System.IO.IOException]{
}
10.知っておいたほうがよい文法
行継続文字
1行にすると長いコードを複数行に書くには行継続文字`を用いる。VBの_。
$items = Get-ChildItem a*,b*,c*,d*,e* ` -force -recurce
ただし以下のような場合は`を使用しなくてもよい
$items =
Get-ChildItem a*,b*,c*,d*,e* -force –recurse
Get-Process |
Where-Object {$_.handles -gt 500} |
Select-Object -first 5
ステートメント分割
ステートメントを分割するには改行コードもしくは;を使用する。VBの:。JavaScriptと同様、文末に;はつけてもつけなくてもよい。
$i = 1; $j = 5; $k = $i + $j
ヒア文字列
複数行の文字列を記述する方法。
$str = @" aaaaaa bbbbb cccc ddd ee "@
.NET Frameworkクラスの利用
.NET Frameworkに含まれているクラスのプロパティやメソッドを使用できる。基本的に完全修飾名を指定しなければいけないが、"System."は省略可能。また、intなど型エイリアスがいくつか定義されている。
# スタティックメンバの使用
[System.Math]::Pow(2,8)
# インスタンスの生成とメソッドの実行
$arrayList = New-Object System.Collections.ArrayList
$arrayList.Add("a")
# コンストラクタがある場合。複数ある場合は配列として指定
$message = New-Object System.Net.Mail.Message from@example.com,to@example.com
# COMオブジェクトの生成
$wshShell = New-Object -com WScript.Shell
# デフォルトで読み込まれていないアセンブリを読み込む
[void] [System.Reflection.Assembly]::LoadWithPartialName("System.Windows.Forms")
[System.Windows.Forms.MessageBox]::Show("hello!")
# クラスにどんなメンバがあるかの確認
# インスタンスメンバ
Get-ChildItem | Get-Member
# スタティックメンバ
[math] | Get-Member -static
キャスト
-asを使った場合はキャスト失敗時もエラーにならずNullが格納される。
$dt = [System.DateTime]"2010/02/13" $dt = "2010/02/13" -as [System.DateTime]
ユーザー定義オブジェクト
PowerShellにはクラスを定義する構文はないが、空のオブジェクト(PSObject)を生成し、任意のプロパティ（ノートプロパティ）を付加することができる。
$obj = New-Object PSObject $property = New-Object System.Management.Automation.PSNoteProperty "Name","名前" $obj.PSObject.Members.Add($property)
シェル変数
あらかじめ定義されている変数。シェル変数には自動変数（変更不可能）とユーザー定義変数（変更すると挙動を変更することができる）がある。自動変数の例を挙げる。
$_ :現在パイプラインにわたっているオブジェクト
$args :関数やスクリプトに与えられたパラメータの配列
$pshome :PowerShellがインストールされているフォルダのフルパス
$MyInvocation :スクリプトの実行情報。$myInvocation.ScriptNameでスクリプトのフルパス取得(★2.0)。$myInvocation.MyCommand.Path（1.0の場合）
$true :true。
$false :false。
$null :null。
サブ式
$()内には複数行のコードが記述できる。
$arr = $(1;2;1+4)
式モードとコマンドモード
PowerShellの構文解析は式モードとコマンドモードがある。式モードは通常のモード。コマンドモードは引用符がなくても文字列を文字列として扱う。コマンドレットのパラメータなどはコマンドモードで扱われる。ただしコマンドモードになるところでも()もしくは$()もしくは@()をつけるとその中身は式モードとして解釈、実行される。
$i = 1 + 1 # 式モード Write-Host aaa # コマンドモード（表示：aaa） Write-Host aaa bbb # コマンドモード（表示：aaa bbb） Write-Host 1+1 # コマンドモード（表示：1+1） Write-Host (1+1) # 式モード（表示：2） $itemCount = @(Get-ChildItem).Length # 式モード
実行演算子とスクリプトブロック
&演算子を用いるとスクリプトブロック{}の内容を実行できる。この場合、スクリプトブロック内のコードは別スコープになる。
$script = {$i = 1+6; Write-Host $i}
&$script
& 'C:\Program Files\Internet Explorer\iexplore.exe' # パスにスペースの含まれるファイルを実行したりするのにも使える
フォーマット演算子
-f演算子を使うと、.NET Frameworkのカスタム書式が使用可能。
"{0:#,##0}Bytes" -f 38731362 # 表示：38,731,362Bytes
バイト数の簡易表記
$i = 1KB # 1024が代入される $i = 1MB # 1048576が代入される $i = 1GB # 1073741824が代入される
そのほかの基礎文法最速マスターへのリンク
プログラミング基礎文法最速マスターまとめ - ネットサービス研究室
http://d.hatena.ne.jp/seikenn/20100203/programmingMaster
PowerShellの詳しい機能解説についてはこちらの記事を参照してください。
PowerShell的システム管理入門 ―― PowerShell 2.0で始める、これからのWindowsシステム管理術 ―― ─ ＠IT
進化したPowerShell 2.0 ─ ＠IT
文法や機能について詳しく学びたい方には書籍もあります
Windows PowerShellポケットリファレンス
PowerShellによるWindowsサーバ管理術
2006/12/23
[WSH]クリップボード内URLのファイルをダウンロード2
http://blogs.wankuma.com/mutaguchi/archive/2006/07/07/31826.aspx
の続きです。クリップボード中に複数URLが複数行に記述されている場合、それらをまとめてダウンロードするように改良しました。
Const adTypeBinary = 1
Const adSaveCreateNotExist = 1
Const adSaveCreateOverWrite = 2
sDLFolder = "C:\download"
Set Ie = WScript.CreateObject("InternetExplorer.Application")
'Ie.Visible = True
Ie.Navigate "about:blank"
Do While Ie.Busy Or Ie.ReadyState<>4
Wscript.Sleep 10
Loop
'クリップボードの文字列を取得。
sClipBoard = Ie.Document.parentWindow.clipboardData.getData("text")
Ie.Quit
If InStr(sClipBoard,vbCrLf) Then
aURLs = Split(sClipBoard,vbCrLf)
Else
aURLs = Array(sClipBoard)
End If
For Each sURL In aURLs
If Left(sURL,5)="http:" Then
sDest = sDLFolder & "\" & Mid(sURL,InStrRev(sURL,"/")+1)
Set oHTTP = WScript.CreateObject("Msxml2.XMLHTTP")
oHTTP.Open "GET", sURL, False
oHTTP.Send
Set Stream = WScript.CreateObject("Adodb.Stream")
Stream.Type = adTypeBinary
Stream.Open
Stream.Write oHTTP.responseBody
Stream.Savetofile sDest, adSaveCreateOverWrite
End If
Next
msgbox "done"
ところがこれをIE7環境で実行すると毎回こんなダイアログがでるんですね。
インターネットゾーンのレベルのカスタマイズで、「スクリプトによる貼り付け処理の許可」を「ダイアログを表示する」から「有効にする」に変えればダイアログは出なくなりますがお勧めしません。それよりは"about:blank"の代わりに何かローカルのファイルを指定してやったほうがいいです。ローカルのファイルはマイコンピュータゾーンで動作するのでダイアログが出ません。
Copyright © 2005-2018 Daisuke Mutaguchi All rights reserved
mailto: mutaguchi at roy.hi-ho.ne.jp
プライバシーポリシー
