ソフトライディングのためのPowershell

オープンソースカンファレンス 2024 Osaka のセミナーで発表したスライドです。

イベントのページ:
https://event.ospn.jp/osc2024-osaka/

セミナーのページ：
https://event.ospn.jp/osc2024-osaka/session/1349446

Transcript

1. ソフトライディングの ためのPowershell
2. 自己紹介
3. 今回の話の指針
4. 今回の話の内容 今回の話は、具体的なテクニッ クではありません。上手いこと Powershellを使いこなすため の考え方のようなものです。 具体的なテクニックは、この話 を聞いた後にこの本を読んでく ださい。
5. ソフトライディングとは ソフトランディングとは、日本語で軟着陸を意味し、本来飛行機 が緩やかに地面に降下する意味を表します。 これは景気循環に も使われ、好景気が最終段階を迎え調整に入ったとき、成長の速 度を少しずつ低下させることを表します。 事故らない使い方と 考えてください。
6. 目指すは「無難に使える」 今回の話では、「すごい」を目指して滑るより、「無難」を選ん で安定した操作ができることを目指し、 • そこそこの練度で無難に使いこなす。 • Powershellの特徴を掴んで無難に使う。 • サーカスみたいなことをしない。 の三つを指針としてPowershellの使い方を説明します。
7. そこそこの練度で無難に使いこなす Powershellでテクニックを追求しても、芸術点ばかり上がって実 用性は上がりません。何だかんだ、迷わずに書ける無難な処理が 一番早い。そこを目指します。 また、主だって利用するコマンドレットや書き方にはパターンが あります。多くのコマンドレットを覚えるより、よく使うコマン ドレットを使いこなすことに重点を置きましょう。
8. Powershellの特徴を掴んで使う Unix由来の直感でPowershellを見たら理不尽極まりない言語で す。Powershellの作法を知った上で使わないと、ツールの有効 性が発揮できません。
9. サーカスみたいなことをしない Excelでお絵描きしたり、VBAでドラクエ作るようなことを、 Powershellでするのは止めましょう。やるなら「ネタ」と明言 した上でやりましょう。 (そういう曲芸をスキルと勘違いする人はけっこういるので注意) 何でもできるが故に 暴走しやすいので注意しましょう！
10. Powershellで 何をやるの？
11. Powershellで行う主な処理 • ファイルシステムの操作 • 高度なテキスト処理 • 軽めの演算 • システムの設定や情報取得 • ネットワークの疎通確認 基本的にこれらの組み合わせです。 (このくらいでカテゴライズすると整理がつきやすいです。)
12. 大体覚えればいいコマンドレット 1 ディレクトリ参照系 • Set-Location • Get-ChildItem ネットワーク疎通確認 • Resolve-DnsName • Test-Connection • Test-NetConnection
13. 大体覚えればいいコマンドレット 2 ファイル操作系 • アイテムの情報取得: Get-ITem • アイテムの作成: New-Item • アイテムの移動: Move-Item • アイテム削除: Remove-Item • アイテムの名前変更: Rename-Item
14. 大体覚えればいいコマンドレット 3 プロセスやサービスの確認 • Get-Process • Get-Servece Windowsのログの確認 • Get-WinEvent
15. 使い方はググってください。
16. Powershellでできること 1 標準で以下のようなことがPowershellのCLIからできる。 • Windowsの設定の制御 (Linuxではここが抜ける) • Windowsのサービスの制御 (Linuxではここが抜ける) • ネットワーク関連の制御 (Linuxではここの一部が抜ける) • ファイルシステムの制御 • (M言語っぽい計算)
17. Powershellでできること 2 モジュール等を追加することで、以下のような処理をできるよう になる。 • AD等のWindowsのサーバコンポーネントの制御 • Azure や AWS などのクラウドサービスの制御 • Microsoftの提供する M365 の制御 • スクレイピング ……等々。
18. まとめ Powershellの用途はソフトウェアの記述ではなく、 何かを制御するために利用することになる。
19. なんで PowerShellを 使うのか
20. Powershellを使うメリット • Windowsの標準で使えるから。 • やり方を覚えれば、複雑な計算もこなせる。 • オペミスが発生しにくい。 • モジュールで機能拡張できる。
21. Windowsの標準で使える • Windows標準で使えるので、どんな現場に行っても使える。 • Windowsサーバでも標準で動くのでサーバのメンテナンス作業 などで役に立つ。
22. 複雑な計算もこなせる PowerShellの機能を使いこなすと、出力されるデータをExcelの 表のように加工することができる。 パイプラインでデータを扱えたり、CLIでの演算するための仕組 みがそろっている。 最終的な結果を標準機能でJSONやCSVに出力できる。これがか なり強い。
23. オペミスが発生しにくい Powershellのコマンドレットは、Verb-Noun (動詞 - 名詞)の構 造になっている。こういう構造になっているため、 • Verbが「Get」なら変更が発生しないことが保証されている • Nounの部分を見れば対象が分かるので初見でも見当がつく • 面倒くさいサブコマンドが無い のような利点があり、けっこう初見に優しい仕様になっている。
24. モジュールで機能拡張できる 「あれがやりたい」「これがやりたい」など、標準の機能ででき ないことがあっても、モジュールを追加するとできたりする。 • AWSやAzureの制御 • M365系のアカウント管理諸々 • 僕の考えた最強パワーシェルコマンドレット などなど、いろいろなモジュールが揃っている。
25. どうやって使 うといいのか
26. Powershellを使う時のコツ • 補完を前提で使う • Unixのノリで使わない • もりもりパイプラインで繋ぐ • テキストを追わない Powershellを嫌う人は、ここら辺を踏襲していないことが多い。
27. 補完を前提で使う 1 Powershell のコマンドラインは長いです。なので、プロンプト で補完することを前提に使いましょう。補完の仕方も、Tabの補 完だけでなく、Ctrl + Space の候補表示も活用しよう。 Tab みんなおなじみの補完 Ctrl + Space 候補表示。候補がカーソルで選べる！ しかも、説明も表示される。
28. 補完を前提で使う 2 Powershell の補完は、色々なものが補完や候補表示ができる。 • コマンドレット • ファイルパス • オプション • オプションに渡すパラメータ(一部) コマンドレットの構造が統一されているため、 補完を使うときのテンポが良い。
29. コマンドを暗記する努力は 止めよう。
30. Unixのノリで使わない 1 Powershellで出力されるのはオブジェクトです。なので、メ ソッドやパラメータがついていたりする。 Unixのシェルと比べると、書き方がプログラミング言語っぽく なる。 文字列にメソッドを付けて、 メソッドを実行したりできる。
31. Unixのノリで使わない 2 Powershellのコマンドレットは名前が長いが、Unixのコマンド のようなサブコマンドが無い。基本的に操作はコマンド一つで完 了する。 サブコマンドを覚えずに済むので、直観的な操作ができる。
32. もりもりパイプラインで繋ぐ パイプラインでデータを次の処理に渡していくことで、大量の処 理を一行で済ますことができる。 ......どうも、Powershellのドキュメントを読んでいると、そうい う想定が強い感じを受ける。
33. パイプの説明する時間が 無いので、 各自ググってください。
34. テキストを追わない 1 Powershellの出力は、PSCustomObjectで出力される。コンソー ルに出力されるテキストをそのまま処理しようとすると、いろい ろと操作で詰みます。
35. PSCustomObjectとは 実はよくわからない。イメージとしては、Excelの表の行のデー タのようなオブジェクト。 コレが配列で出力されて、CLI上で表のようなデータが表示され る。
36. PSCustomObjectを 説明するのが面倒なので、 各自ググってください。
37. テキストを追わない 2 処理を行う対象はオブジェクト。データの処理をしたい場合、以 下のデータをインポートしてオブジェクト変換できる。 • CSV • JSON • XML 保存するときはフォーマットを決めてファイルにエクスポートで きる。
38. Powershellの 使い方に 困ったら
39. 使い方に困ったときの対処 • 気合を入れてコマンド名を十回読む • Ctrl +Space で出てきた補完の内容をよく読む • Get-Command -Online
40. 気合を入れてコマンド名を十回読む Verb-Noun (動詞 - 名詞) の Noun 部分だが、よく読むと、 <目的のステム><コンポーネント>.....<コンポーネント> のような構成になっていることが多い。コマンド名を十回読み返 すと、何となく何をするコマンドレットかが分かることも多々あ る。
41. Ctrl +Space の補完内容をよく読む Ctrl + Shift で補完すると、コマンドでは候補になるコマンドが 全てコンソールに出力される。オプションを補完すると、オプ ションのとる値の型まで表示される。これを眺めているだけでも、 使い方が分かることがある。
42. Get-Command -Online Get-Command -Online でコマンドを調べると、Webページが開 きます。意外と便利。
43. 実践編
44. 滑らないPowershellの使い方 • クソ長いコードは書かない • パターンを掴む • スクリプトとCLIで書き分ける この三つを心掛けてPowerShellを使うと、大きなミスをしない で済む。
45. クソ長いコードは書かない1 .Netのライブラリを取り込めたり、.Netに寄せた書き方でスクリ プトを書くことができます。 その反面、コマンドレットの長さがネックになったり、 Powershellを使う利点が薄れてくる。 大規模なプログラムを組むニーズであれば、C#で書く方がメ リットが大きい。
46. クソ長いコードは書かない2 Powershellは.Netのライブラリを扱えるため、非常に拡張性が高 い。半面、VBAのように「何でもできてしまう」が故のデメリッ トも多い。 「何でもPowershell」ではなく、作りたいものに合わせた言語 を利用しましょう。
47. パターンを掴む 1 Powershell を使うときに一番多いパターンはこれです。 <コマンド実行・データ出力> | <フィルタリング> | <出力加工 > | (<データのエクスポート>) Powershell では、システムに対して変更を行った際も、結果を 出力します。Getを実行した時と同じオブジェクトが出力される ので、証跡を取るときに便利。
48. パターンを掴む 2 Powershell でスクリプトを書くときに多いパターンです。 1. 処理前のログ出力 2. コマンドレットによる処理 3. 処理後のログ出力 このくらいの単位の処理を関数化して処理を組み立てていくとや りやすい。
49. 関数名について 関数名も Verb-Noun (動詞 - 名詞) でかくのか？ -> 人それぞれ。特に機能上の制約は無い。
50. スクリプトとCLIで書き分ける スクリプトのとき -> 普通のプログラムの感覚で書くと分かり易い。 シェルで実行するとき -> ある程度の処理の塊をパイプラインでまとめて処理をする。 それぞれの書き方にそれぞれの利点があるので使い分けましょう。
51. 準アンチパターン • GUIの作成 -> C#でやろう • 大規模なアプリケーションの作成 -> C#でやろう • ビックデータの処理 -> そんなに早くない
52. 結論 • あくまでシェルです。 • Powershellの機能やコンセプトを押さえて活用しよう。 • 自分のパターンを見つけてシンプルに使おう。
53. 以上、終了。