「Develop」の版間の差分
(SQL mode) |
(拡張子、サンプルファイル) |
||
| (同じ利用者による、間の420版が非表示) | |||
| 4行目: | 4行目: | ||
[https://asciiflow.com/#/ ASCIIFlow]: 画面構成図などの作成でテキストなので便利かもしれない。 | [https://asciiflow.com/#/ ASCIIFlow]: 画面構成図などの作成でテキストなので便利かもしれない。 | ||
=== | === Management === | ||
==== | ==== データ管理 ==== | ||
https://chatgpt.com/share/680a33a2-159c-800b-8e8f-020f3d9ac921 | |||
時間ベースとカテゴリーベースがある。それぞれ利点と欠点がある。 | |||
* カテゴリーベース: 検索・アクセスが有利。プロジェクト、業務単位。長期にわたって使うもの。 | |||
* 時間ベース: 保管・バックアップ効率。経理関係。一時保管など。 | |||
基本はカテゴリーベースで、契約書とか、一時保管が必要なものは、時間ベースにも保管する。こうすると、いいかもしれない。 | |||
コピーする場合、どこからどこのコピーかわかるように、ショートカットも配置しておく。また、コピーであることがわかるディレクトリーにしておく。 | |||
==== バックアップ ==== | |||
VCSなしの場合のバックアップファイルの命名規則。 | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_28297f6a-2ff6-4a9d-af38-5e729e65d9ed | |||
filename.YYYYmmdd.ext | |||
この形式がいい。拡張子の前に日付を入れる。拡張子の後に入れてしまうと、アプリが拡張子を認識できなくて困る。 | |||
=== Project === | |||
* [https://gigazine.net/news/20240217-open-source-non-code-contribution/ オープンソースの開発プロジェクトではコーディング以外のドキュメント化やサポートなどの貢献が特に重要 - GIGAZINE] | |||
* [https://gigazine.net/news/20240229-open-source-project-business/ オープンソースプロジェクトを有料化して月収100万円の事業家に転身したソフトウェア開発者 - GIGAZINE] | |||
=== 名簿付きの寄付 === | |||
* Vim: <nowiki>https://vim-jp.org/vimdoc-ja/sponsor.html</nowiki> | |||
* Vim (list): <nowiki>https://www.vim.org/sponsor/hall_of_honour.php</nowiki> | |||
* KDE: <nowiki>https://relate.kde.org/</nowiki> | |||
* KDE (list): <nowiki>https://relate.kde.org/civicrm/profile?gid=18&search=0</nowiki> | |||
* Conservancy (list): <nowiki>https://sfconservancy.org/sponsors/</nowiki> | |||
* Conservancy: <nowiki>https://sfconservancy.org/donate/</nowiki> | |||
=== Kanboard === | |||
==== クローズ時に自動移動 ==== | |||
[Configure project]-[Automatic actions] | |||
* action=[Move the task to another project] | |||
* Event name=Closing a task | |||
* Column=Done | |||
* Project= | |||
これでDoneをclose時にアーカイブ用のプロジェクトに移動できる。 | |||
=== Product === | |||
==== 会員番号の設計 ==== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_db01208a-8222-4d9b-900e-2bb429417296 | |||
ポイントカードは番号だけでためたり、使えたりしちゃう。流出すると不正利用の可能性がある。dポイントとか楽天ポイントとか。既存のポイントシステムは、固定番号を採用している。 | |||
アプリでタイムスタンプを付けたら、流出漏洩ガードができる。が、即時性を優先して固定番号も併用している模様。後は、不正監視システムでカバーとか。 | |||
ポイントは換金性が高いが、そんなに金額が大きくならずに消費される想定だから、リスクはあっても問題ない感じなのだと思われる。 | |||
==== バーコード ==== | |||
* [https://www.keyence.co.jp/ss/products/autoid/codereader/basic-types.jsp?msockid=39c0e5811530653525dcf3e014af64bb バーコードの種類 | バーコード講座 | キーエンス] | |||
* [https://github.com/zxing/zxing/ zxing/zxing: ZXing ("Zebra Crossing") barcode scanning library for Java, Android] | |||
形式が複数ある。 | |||
{| class="wikitable" | |||
!1D product | |||
!1D industrial | |||
!2D | |||
|- | |||
|UPC-A | |||
|Code39 | |||
|QR Code | |||
|- | |||
|UPC-E | |||
|Code93 | |||
|Data Matrix | |||
|- | |||
|EAN-8 | |||
|Code128 | |||
|Aztec | |||
|- | |||
|EAN-13 | |||
|Codabar | |||
|PDF 417 | |||
|- | |||
|UPC/EAN Extension 2/5 | |||
|ITF | |||
|MaxiCode | |||
|- | |||
| | |||
| | |||
|RSS-14 | |||
|- | |||
| | |||
| | |||
|RSS-Expanded | |||
|} | |||
==== 緯度経度の順番 ==== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_4f7c43b1-51f2-4cf4-b832-b108d74c7705 | |||
地理情報の座標は、緯度経度の順番で表記することが多い。ただ、数学的にはx,yの順番。メルカトル図法の一般的な地図の資格情報的には、経度緯度がx,yと対応する。順番が違うのが気になる。 | |||
結論: 外部公開APIは、緯度経度。内部で緯度経度を変換して、x,yにしたら、x,yの順番で扱う。 | |||
理由: 地理学的には、経度は特定が難しくて、緯度が先に特定されて、世界で先に使われるようになった。そのため、緯度経度の順番になって、世間で定着している。ISOなどの標準も緯度経度の順番。GeoJSONとかITシステムでは経度緯度の順番。 | |||
===== チェックイン機能 ===== | |||
====== 方式 ====== | |||
<nowiki>https://grok.com/share/c2hhcmQtMw%3D%3D_792c1e8e-5fcd-429b-a7cd-1e116addbf39</nowiki> | |||
{| class="wikitable" | |||
|+ | |||
!方式 | |||
!内容 | |||
!利点 | |||
!欠点 | |||
!不正 | |||
!対策 | |||
|- | |||
|Geolocation API | |||
|店舗でマイページボタン押下 | |||
|追加設備不要 | |||
|不正完全防止不能 | |||
|位置偽装 | |||
|ユーザー特定可能なので、運用で不正をカバーする。 | |||
|- | |||
|動的QR | |||
|店頭動的QRコードの読取 | |||
|不正完全防止 | |||
|表示端末設置必要、サーバー追加実装必要 | |||
| | |||
| | |||
|- | |||
|固定QR | |||
|店頭固定QRコード読取 | |||
|サーバー追加実装不要 | |||
|不正完全防止不能 | |||
|QRコード撮影持帰 | |||
|固定QRを定期更新。 | |||
|- | |||
|NFC | |||
|店頭NFC読取 | |||
| | |||
|タグ設置必要、端末限定 | |||
| | |||
| | |||
|- | |||
|Bluetooth Beacon | |||
|店頭Beacon通信 | |||
| | |||
|Beacon設置必要 | |||
| | |||
| | |||
|} | |||
* 手間最小はGeolocation API。位置偽装がありえるので、アカウントの定期監視は必要。付与の頻度や上限の制限ロックなど必要。 | |||
* 不正防止+低コストは固定QR。定期的なQR更新が必要。 | |||
* 不正完全防止で手間最小は動的QR。ただし、表示端末設置、追加サーバー実装必要。 | |||
====== 動的QR ====== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_57855e1c-bae0-4fd9-99f5-622979149ff3 | |||
トークン管理用のテーブルを用意。 | |||
CREATE TABLE checkin_history ( | |||
id INT AUTO_INCREMENT PRIMARY KEY, | |||
store_id INT NOT NULL, | |||
token VARCHAR(255) NOT NULL, | |||
checkin_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, | |||
FOREIGN KEY (store_id) REFERENCES stores(store_id) | |||
); | |||
トークン作成用のAPIを用意。アクセスが来たら、tokenを作って、それや店舗IDを埋め込んだQR/URLを作成 (?store_id=XXX&token=XXX)。 | |||
該当トークンを検証して、処理実施。GPS不要になる。 | |||
== Communication == | |||
=== Backlog === | |||
==== メール通知 ==== | |||
[https://yoshikazu-komatsu.com/backlog-notification-customize-guide/ Backlogの通知設定をカスタマイズする手順|チーム効率を2倍にする最適化テクニック | こまろぐ] | |||
[個人設定]-[メール設定] で全体設定する。 | |||
ただ、コメント記入時に、[コメントをお知らせしたいユーザー] に入っていると、通知が来る。メールフィルターで対応するしかない。 | |||
=== Skype === | |||
[https://support.microsoft.com/ja-jp/skype/%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AE%E3%82%A8%E3%83%A2%E3%83%BC%E3%83%86%E3%82%A3%E3%82%B3%E3%83%B3%E3%81%AE%E3%83%AA%E3%82%B9%E3%83%88%E3%81%AF%E3%81%82%E3%82%8A%E3%81%BE%E3%81%99%E3%81%8B-01af0c65-529f-4a4d-8e3a-a393033a359a すべてのエモーティコンのリストはありますか? - Microsoft サポート] | |||
Skyepで使用可能な絵文字の一覧。 | |||
=== Slack === | |||
==== チャンネル ==== | |||
https://slack.com/intl/ja-jp/help/articles/205239967-%E3%83%81%E3%83%A3%E3%83%B3%E3%83%8D%E3%83%AB%E3%81%AB%E5%8F%82%E5%8A%A0%E3%81%99%E3%82%8B | |||
===== 一覧表示 ===== | |||
[ホーム]-[チャンネル]-[管理する]-[チャンネル一覧] でチャンネル一覧を閲覧可能。 | |||
==== パーマリンク ==== | |||
Slackの投稿パーマリンクをWebブラウザーで開くと、該当箇所にジャンプできない。デスクトップアプリがあると開ける。それでしのぐ。 | |||
=== JIRA === | |||
==== 関連チケット ==== | |||
[修正するバージョン]/[影響するバージョン] のリンクをクリックすると、関連するissueが一覧表示される。これで未クローズチケットを確認するといい。 | |||
==== 履歴 ==== | |||
[アクティビティ]-[履歴] のタブを選ぶと、変更履歴を確認できる。 | |||
=== Confluence === | |||
ページの中で、 [作成] を選んでページを作ると、階層が勝手にできて、子ページへのリンクもできる。 | |||
==== ショートカットキー ==== | |||
キーボード ショートカット | |||
https://ja.confluence.atlassian.com/doc/keyboard-shortcuts-139456.html | |||
===== エディタ ===== | |||
* {code: コードブロック (https://shinkufencer.hateblo.jp/entry/2018/10/17/235900 Confluenceのエディタは { でマクロのショートカット入力ができるし、{ code } でコードスニペット領域が作れる)。 | |||
ブロック フォーマット | |||
{| class="wikitable" | |||
!Windows | |||
!操作 | |||
!Mac | |||
|- | |||
|Ctrl + 0 | |||
|Paragraph | |||
|⌘+ 0 | |||
|- | |||
|Ctrl+ (1 ~ 6) | |||
|(選択した番号の)見出しレベル | |||
|⌘+ (1—6) | |||
|- | |||
|Ctrl + 7 | |||
|Preformatted | |||
|⌘+ 7 | |||
|- | |||
|Ctrl + 8 | |||
|Quote | |||
|⌘+ 8 | |||
|- | |||
|Ctrl + Shift + B、または | |||
<nowiki>*</nowiki> + Space | |||
|箇条書きリストを追加 | |||
|⌘ + Shift + B、または | |||
<nowiki>*</nowiki> + Space | |||
|- | |||
|Ctrl + Shift + N、または | |||
<nowiki>#</nowiki> + space | |||
|番号付きリストを追加 | |||
|⌘ + Shift + N、または | |||
<nowiki>#</nowiki> + space | |||
|- | |||
|Ctrl + Shift + S | |||
|Strikethrough | |||
|⌘ + Shift + S | |||
|- | |||
|Ctrl + Shift + | |||
|Subscript | |||
|⌘ + Shift + , | |||
|- | |||
|Ctrl + Shift + | |||
|Superscript | |||
|⌘ + Shift + . | |||
|- | |||
|Ctrl + Shift + M | |||
|Monospace | |||
|⌘ + Shift + M | |||
|- | |||
|Ctrl + \ | |||
|Clear formatting | |||
|⌘ + \ | |||
|} | |||
豊富なフォーマット | |||
{| class="wikitable" | |||
|CTRL + Shift + V | |||
''サファリのみ:''Ctrl + Shift + Alt + V | |||
|書式設定なしでテキストを貼り付け | |||
|⌘ + Shift + V | |||
''Safari のみ:''⌘ + Shift + Option + V | |||
|- | |||
|Ctrl+M | |||
|Files and images | |||
|⌘+ M | |||
|- | |||
|Ctrl+K | |||
|リンク([リンクの挿入] ダイアログが開く) | |||
|⌘ + K | |||
|- | |||
|Ctrl + Shift + D | |||
|マークアップを挿入([マークアップの挿入] ダイアログが開く) | |||
|⌘ + Shift + D | |||
|- | |||
|Ctrl+Shift+A | |||
|マクロ([マクロの選択] ダイアログが開く) | |||
|⌘ + Shift + A | |||
|- | |||
|Ctrl + Shift + O | |||
|次のインライン コメントに切り替え | |||
|⌘ + Shift + O | |||
|- | |||
|Ctrl + Shift + L | |||
|前のインライン コメントに切り替え | |||
|⌘ + Shift + L | |||
|- | |||
|CTRL + Shift + Z | |||
|インライン コメントを閉じる | |||
|⌘ + Shift + Z | |||
|- | |||
|Ctrl + Shift + I | |||
|表 | |||
|⌘ + Shift + I | |||
|- | |||
|Alt + 上矢印 | |||
|行を上に挿入 | |||
|Alt + 上矢印 | |||
|- | |||
|Alt + 下矢印 | |||
|下に行を挿入 | |||
|Alt + 下矢印 | |||
|- | |||
|Ctrl + Shift + X | |||
|行を切り取り | |||
|⌘ + Shift + X | |||
|- | |||
|Ctrl + Shift + C | |||
|行をコピー | |||
|⌘ + Shift + C | |||
|- | |||
|Ctrl + Shift + Y | |||
|行を上に貼り付け | |||
|⌘ + Shift + Y | |||
|- | |||
|Ctrl + Shift + ; | |||
|絵文字メニュー | |||
|⌘ + Shift + ; | |||
|- | |||
|CTRL + Shift + V | |||
|書式設定なしで貼り付け | |||
|⌘ + Shift + V | |||
|- | |||
| | |||
|書式設定なしで貼り付け (Safari) | |||
|⌘ + Shift + Option + V | |||
|} | |||
===== オートコンプリート ===== | |||
[] が勝手にリンクになるのが困る。 | |||
リンク、ファイル、マクロ、メンション、絵文字のオートコンプリート | |||
https://ja.confluence.atlassian.com/doc/autocomplete-for-links-files-macros-mentions-and-emojis-249858190.html | |||
オートコンプリートの無効化方法。 | |||
プロフィール画像を選択-[設定]-[エディター]-[☑️オートコンプリートの無効化] | |||
ただ、オートコンプリートの丸ごと無効化は、便利な機能がなくなるので不味い。 | |||
一時的に回避したい場合、[の直前に何か文字があれば解釈されない。スペース開けて[があるとオートコンプリート扱いになる。 | |||
===== 書式なしペースト ===== | |||
[https://qiita.com/kentoak/items/fbba0b9e3e735893a35e Confluenceで書式なしペースト(Ctrl+Shift+V)を有効にする #Confluence - Qiita] | |||
[?]-[キーボードショートカット]-[General]-[▫️Enable General Shortcuts] にしてオフにすると有効になる。 | |||
[表の上部にペースト] と競合していたらしい。 | |||
==== マクロ ==== | |||
[https://ja.confluence.atlassian.com/doc/macros-139387.html マクロ | Confluence Data Center 9.2 | アトラシアン製品ドキュメント] | |||
いくつか有用なマクロがある。 | |||
* [https://ja.confluence.atlassian.com/doc/children-display-macro-139501.html 子ページ表示マクロ | Confluence Data Center 9.2 | アトラシアン製品ドキュメント] | |||
* [https://www.ricksoft.jp/blog/articles/001510.html Confluence(コンフルエンス)の一部内容を折りたたみで非表示できる「展開」マクロを使ってみよう - リックソフトブログ] | |||
==== Other ==== | |||
===== パーマリンク ===== | |||
[https://confluence.atlassian.com/confkb/the-differences-between-various-url-formats-for-a-confluence-page-278692715.html The Differences Between Various URL Formats for a Confluence Page | Confluence | Atlassian Documentation] | |||
Confluenceのページ新規作成時、パーマリンクが自動生成される。規則がある。 | |||
以下の条件にマッチしたら、padeId URLになる。それ以外は、タイトル名のURLになる。 | |||
* [% & ? / ¥ ; " + :] などのようなURLの予約文字。 | |||
* 非ラテン文字。 | |||
* ページタイトル末尾が英数字以外の場合。 | |||
===== ページ履歴 ===== | |||
ページ右上のメニュー-[ページ履歴]から履歴を確認できる。差分も確認できる。 | |||
===== ページ移動 ===== | |||
[https://ja.confluence.atlassian.com/doc/move-and-reorder-pages-146407727.html ページの移動と順序の変更 | Confluence Data Center 9.2 | アトラシアン製品ドキュメント] | |||
ページ右上のメニュー-[移動] | |||
== Tool == | |||
=== General === | |||
==== Call tree ==== | |||
kcachegrindだったかな。 | |||
kscopeもこれか。 | |||
Doxygen+GraphVizで関数コールグラフ | |||
==== kscope ==== | |||
https:/github.com/ivan0124/Linux-programming/wiki/How-to-use-KScope-to-trace-code | |||
https:/sourceforge.net/projects/kscope/ | |||
http:/www.lemis.com/grog/software/kscope.php | |||
==== cscope ==== | |||
cbrowser/kbrowserというGUIもある。 | |||
cscopeの大文字小文字無視検索 | |||
<nowiki>http://vim.1045645.n5.nabble.com/how-to-search-with-cscope-ignoring-case-td5715043.html</nowiki> | |||
DBを別にする必要がありそう。 | |||
==== expect ==== | |||
端末の手動操作を自動化するソフト。 | |||
* <nowiki>*</nowiki> ^と$は使えない。代わりに、\nを使う。 | |||
* <nowiki>*</nowiki> 文字列の囲みに一重引用符 (') は使えない。二重引用符 (") のみ有効。 | |||
* <nowiki>*</nowiki> expect文はawkみたいな感じ。 | |||
* <nowiki>*</nowiki> ただし、expectは注意が必要。最初のexpectにマッチしないと先に進めない。タイムアウトとかするしかない。 | |||
expect -c "set timeout 5; spawn cat cat.txt; expect \nFAIL {send pwd/n; expect :; exit}" | |||
https:/linuxjm.osdn.jp/html/expect/man1/expect.1.html | |||
sh -eux <<-"EOT" | |||
expect -c "set timeout 5; spawn ssh senooken@senooken-linux; expect :; send ieneko/n; expect aho {send echo aho} +x {send pwd/n}; expect /$; exit" | |||
expect -c "set timeout 5; spawn ssh senooken@senooken-linux; expect :; send ieneko/n; expect + {send pwd/n}; expect /$; exit" | |||
expect -c "set timeout 5; spawn cat cat.txt; expect \nFAIL {send pwd/n; expect :; exit}" | |||
expect -c 'set timeout 10; spawn cat cat.txt; expect "aa F" {set AAA "abc"}; expect FAIL {send "$AAA/n"; expect " "; exit}' | |||
EOT | |||
===== 踏み台サーバーログイン ===== | |||
expectのオプションに-cで細切れにするのもOK | |||
<nowiki> </nowiki> | |||
connect 'xxx.xxx.xxx.xxx /ssh /auth=password /user=id /passwd=pw' | |||
wait <nowiki>''</nowiki> | |||
sendln 'ssh root@<ここにIPアドレスを記入>' | |||
wait 'Password:' | |||
sendln 'pw' | |||
connect 'ip1 /ssh /auth=password /user=sef19a /passwd=ipscp19a' | |||
wait <nowiki>''</nowiki> | |||
sendln 'expect -c "spawn ssh root@ip2; expect :; send pelican/n; interact"' | |||
sendln 'expect -c "spawn ssh root@ip2" -c "expect :" -c "send pelican/n" -c "interact"' | |||
==== GNU screen ==== | |||
[https://qiita.com/SAITO_Keita/items/b79ebc5af64aad28fc4a#:~:text=%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%BB%E3%83%83%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AB%E6%8E%A5%E7%B6%9A%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E7%8A%B6%E6%85%8B%E3%81%A7%E3%82%AD%E3%83%BC,%E6%A8%AA%E3%81%AB%E5%88%86%E5%89%B2%E3%81%A7%E3%81%8D%E3%81%BE%E3%81%99%E3%80%82 GNU Screenコマンドをつかってみる #screen - Qiita] | |||
screenコマンド実行後に、C-a押下後に対応するキーを押して各種操作を実行する。 | |||
キー操作以外に、コマンドも用意されている。C-a :でコマンドラインモードに入る。 | |||
特に重要な操作。 | |||
* Help | |||
** C-a ? | |||
** Command:help | |||
* Window | |||
** C-a c/C-a C/Command:screen=Windowを生成。 | |||
** C-a space/C-a n/C-a C-n/Command:next=次のWindowへ移動。 | |||
** C-a p/C-a C-p/C-a C-h/C-a Backspace/Command:prev=前のWindowへ移動。 | |||
* 画面分割: Regionを分割してそこにWindowを割り当てる。 | |||
** C-a S=横分割 | |||
** C-a |=縦分割 | |||
** C-a TAB/Command:focus=分割画面の移動。 | |||
* クローズ | |||
** C-a X/Command:remove=現在のRegionを終了。 | |||
** C-a Q/Command:Only=現在以外のRegionを終了。 | |||
===== .screenrc ===== | |||
====== スタートアップメッセージ ====== | |||
startup_message off | |||
====== スクロール ====== | |||
[https://www.robotech-note.com/entry/2017/01/27/082929 linux screen中にマウスホイールでスクロールする方法 - 技術メモ集] | |||
デフォルトだとマウススクロールなどに対応していない。以下の設定で対応でき、通常使用で問題なくなる。 | |||
termcapinfo xterm* ti@:te@ | |||
defscrollback 100000 | |||
=== File === | |||
==== Binary ==== | |||
===== .so ===== | |||
ソフトウェアの依存関係などの調査で.soファイルの分析を行うことがある。 | |||
[https://zenn.dev/nyoho/scraps/3651de0bd0b313 .soファイルの中のシンボル探し] | |||
* nm | |||
* ldd | |||
* string | |||
==== 設定ファイル ==== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_fb839660-c036-4484-b24f-aa77107db9b3 | |||
xml/json/yaml/iniなど設定ファイルの形式がいろいろある。それぞれ長所短所があって使い分けがある。 | |||
* json: パースが高速。コメント未対応。複雑な構文をサポート可能で、データの交換などで使う。 | |||
* xml: 表現力が高い。が、パースはjsonよりは遅い。名前空間など意味論の厳密性が必要な時。 | |||
* yaml: 可読性が高い。コメント対応。人間が頻繁に編集するタイプのデータに使う。 | |||
* ini: シンプルで高速。ネストの表現不能。単純なキーバリューのシンプルな設定だけ。 | |||
* toml | |||
* HCL (HashiCorp Configuration Language) | |||
* Protocol Buffers (Protobuf) | |||
* EDN (Extensible Data Notation) | |||
* CSV | |||
yamlかjsonで作っておくと無難。 | |||
==== YAML ==== | |||
===== About ===== | |||
* [https://ja.wikipedia.org/wiki/YAML YAML - Wikipedia] | |||
* [https://yaml.org/ The Official YAML Web Site] | |||
YAML 1.2.2 (2021-10-01) が最新。2001-05-11が初版。dockerなどの設定ファイルで採用されていて一部で人気。可読性が高くて、コメントを記入できて、データ量も少ない。人が手作業で記入する形式として適しているとの評判。 | |||
YAML Ain’t Markup Language (YAML™) | |||
===== Basic ===== | |||
====== General ====== | |||
インデントで階層構造を表現。インデントはスペースのみ。スペース2個でインデントが主流。 | |||
<nowiki>#</nowiki>は行コメント。 | |||
---は1ファイル内に複数YAML記載時のセパレーター | |||
====== リスト ====== | |||
ブロック形式とインライン形式/フロー形式の2種類の記載方法がある。 | |||
--- # お好みの映画、ブロック形式 | |||
- Casablanca | |||
- Spellbound | |||
- Notorious | |||
--- # 買い物リスト、インライン形式、またはフロー形式 | |||
[milk, bread, eggs] | |||
- {name: John Smith, age: 33} | |||
- name: Mary Smith | |||
age: 27 | |||
ハッシュのリストのブロック形式はバレットが1個しかつかないのでちょっと気持ち悪いので注意。 | |||
====== 連想配列・ハッシュ ====== | |||
--- # ブロック | |||
name: John Smith | |||
age: 33 | |||
--- # インライン | |||
{name: John Smith, age: 33} | |||
men: [John Smith, Bill Jones] | |||
women: | |||
- Mary Smith | |||
- Susan Williams | |||
リストのハッシュ。 | |||
====== Scalars ====== | |||
1文字目を|にして改行すると、データ内の改行を維持。>にすると、改行をスペースに置換。 | |||
data: | | |||
There was a young fellow of Warwick | |||
Who had reason for feeling euphoric | |||
For he could, by election | |||
Have triune erection | |||
Ionic, Corinthian, and Doric | |||
data: > | |||
Wrapped text | |||
will be folded | |||
into a single | |||
paragraph | |||
Blank lines denote | |||
paragraph breaks | |||
===== Other ===== | |||
====== ブロック/インライン・フローの混在 ====== | |||
Swaggerのプロパティーのdescriptionで区分値の説明用に箇条書きを使いたい。 | |||
content: | |||
application/json: | |||
schema: | |||
type: "object" | |||
required: ["customerNo", "eventNo"] | |||
properties: | |||
customerNo: {title: "会員番号", description: "会員番号", type: string} | |||
actionType: | |||
title: アクションタイプ | |||
description: | | |||
ユーザーのアクション種別。 | |||
- 1: セミナー申込 | |||
- 2: 動画視聴, | |||
type: integer | |||
enum: [1, 2] | |||
default: 1 | |||
基本はswaggerやyamlはブロック形式が基本になっている。短くてシンプルなところだけインライン・フロー形式を使う。長くなるならブロック形式にする。 | |||
親のpropertiesのブロック形式にする必要がある。 | |||
=== Diff === | |||
差分確認ツール。コードレビューなどで重要。 | |||
==== About ==== | |||
Macが鬼門。 | |||
M1 Macで使用可能なものの選択肢が極端に狭い。 | |||
https://chatgpt.com/c/678e249e-84f0-800b-b8da-7385d9aaf819 | |||
{| class="wikitable" | |||
|+ | |||
!name | |||
!OS | |||
!Free | |||
!GUI | |||
!directory | |||
!image | |||
!comment | |||
|- | |||
|FileMerge | |||
|Mac | |||
|x | |||
|x | |||
|x | |||
| | |||
|Xcode付属ツール。悪くない。が、Mac専用。 | |||
|- | |||
|P4Merge | |||
|x | |||
|x | |||
|x | |||
| - | |||
|x | |||
|ディレクトリー比較ができないのが惜しい。 | |||
|- | |||
|DiffMerge | |||
|x | |||
|x | |||
|x | |||
|x | |||
| - | |||
|悪くない。が開発停止。MacはIntel版のみ。 | |||
|- | |||
|WinMerge | |||
|Windows | |||
|x | |||
|x | |||
|x | |||
| | |||
|使いやすい。 | |||
|- | |||
|Meld | |||
|Windows/Linux | |||
|x | |||
|x | |||
|x | |||
| | |||
|Linux系の標準。悪くない。 | |||
|- | |||
|kdiff3 | |||
|Windows/Linux | |||
|x | |||
|x | |||
|x | |||
| | |||
|開発停止。使えなくはない。 | |||
|- | |||
|vimdiff | |||
|x | |||
|x | |||
|x | |||
|x | |||
| - | |||
|使いにくい。 | |||
|- | |||
|Visual Studio Code | |||
|x | |||
|x | |||
|x | |||
|x | |||
|x | |||
|ディレクトリー比較は [[https://marketplace.visualstudio.com/items?itemName=moshfeu.compare-folders Compare Folders - Visual Studio Marketplace]] 拡張機能。 画像比較は [Image Preview] らしい。 | |||
|- | |||
|Intellij IDARE | |||
|x | |||
| - | |||
|x | |||
|x | |||
|x | |||
| | |||
|- | |||
|Beyond Compare | |||
|x | |||
| - | |||
|x | |||
|x | |||
|x | |||
| | |||
|- | |||
|DiffImg | |||
|Windows/Linux | |||
|x | |||
|x | |||
| | |||
|x | |||
| | |||
|- | |||
|PerceptuallDiff | |||
|x | |||
| | |||
| - | |||
| | |||
|x | |||
| | |||
|- | |||
|PixelCompare | |||
| | |||
| | |||
|x | |||
| | |||
|x | |||
| | |||
|} | |||
DiffMerge一択になる。ファイルサイズも小さい。大きくても11 MB。 | |||
Visual Studio Codeが汎用的だから、こちらでいいかもしれない。 | |||
==== DiffMerge ==== | |||
[https://note.com/modern_ferret431/n/nbb5061ddf08c mac で WinMerge |東京 AI 研究所] | |||
==== FileMerge ==== | |||
[https://reasonable-code.com/filemerge/ Mac純正のファイル差分確認ツール「FileMerge」が使いやすい - Reasonable Code] | |||
[/Applications/Xcode.app]-右クリック-[Show content]-[Contents/Applications/FileMerge.app] | |||
コマンドラインからだとopendiff。 | |||
==== Visual Studio Code ==== | |||
===== About ===== | |||
ディレクトリー比較は [[https://marketplace.visualstudio.com/items?itemName=moshfeu.compare-folders Compare Folders - Visual Studio Marketplace]] 拡張機能。 画像比較は [Image Preview] らしい。 | |||
[https://www.javadrive.jp/vscode/editor/index3.html VSCode | 2つのファイルの内容を比較して差分を表示する] | |||
code -d <file1> <file2> | |||
上記コマンドで差分表示できる。外部の差分ツールとして使う際は、上記コマンドになるように指定する。 | |||
GUIからだと、[View]-[Command Pallete]-[Compare] から比較できる。 | |||
比較のモードがいくつかある ([https://zenn.dev/haretokidoki/articles/dae3536ea55f49 VS Codeでファイル・ソースコードの差分を比較(diff)する2通りの方法])。 | |||
{| class="wikitable" | |||
!No. | |||
!比較モード | |||
!用途 | |||
|- | |||
|1 | |||
|ファイル: アクティブ ファイルを比較しています... | |||
File: Compare Active File With... | |||
|現在のアクティブファイル と 指定したファイル を比較する。 | |||
|- | |||
|2 | |||
|ファイル: クリップボードとアクティブ ファイルを比較 | |||
File: Compare Active File with Clipboard | |||
|<code>Ctrl + C</code>でクリップボードに保存された文字列 と 現在のアクティブファイル を比較する。 | |||
|- | |||
|3 | |||
|ファイル: 新しい無題のテキスト ファイルの比較 | |||
File: Compare New Untitled Text Files | |||
|比較モードで新規テキストファイルを2つ開いた状態となる。 | |||
|- | |||
|4 | |||
|ファイル: 保存済みファイルと作業中のファイルを比較 | |||
File: Compare Active File with Saved | |||
|未編集状態のアクティブファイル と 前回保存したアクティブファイル を比較する。 | |||
|- | |||
|5 | |||
|マージの場合: 現在の競合を比較 | |||
Merge Conflict: Compare Current Conflict | |||
|Git環境でブランチをマージした時にコンリクト(競合)が発生していないか比較する。 | |||
|} | |||
File: Compare Active File Withが素直か。 | |||
===== Diff Folders ===== | |||
[https://untic.blog/blogs/468 VSCode拡張機能「Diff Folders」でフォルダ間の違いを簡単に比較しよう! | UNTIC | Web担当者のための仕事メディア] | |||
Diff Foldersの他に、Compare Foldersというのもある。が、Diff Foldersのほうが直感的で使いやすいらしい ([https://stackoverflow.com/questions/70159358/is-there-a-compare-folders-feature-in-vs-code is there a compare folders feature in VS Code? - Stack Overflow])。ただ、Compare Foldersのほうがダウンロード数が多い。 | |||
標準ではディレクトリー比較はできない。Diff Foldersの拡張機能が必要。 | |||
# Diff Foldersをインストール | |||
# c-P-[Diff Folders]-[New Diff Panel] またはc-L | |||
===== Compare Folders ===== | |||
[https://amateur-engineer-blog.com/vscode-compare-folders VSCodeでフォルダ丸ごと比較する] | |||
==== format ==== | |||
[https://qiita.com/bitnz/items/725350b614bafedc581a わかりやすい差分(diff)の取り方いろいろメモ #Git - Qiita] | |||
diffコマンドの差分表示の形式がいくつかある。 | |||
# ノーマル | |||
# context | |||
# unified | |||
contextとunified形式には差分に対象ファイルの情報がある。パッチファイルを作成するなら、この2種にすべきになる。 | |||
ノーマル形式は、本当に変更行のピンポイントの情報だけ。 | |||
===== normal ===== | |||
the | |||
quick | |||
brown | |||
fox | |||
jumps | |||
over | |||
the | |||
lazy | |||
dog | |||
the | |||
quick | |||
brown | |||
fox | |||
jumped | |||
over | |||
the | |||
lazy | |||
dogs | |||
% diff a.txt b.txt | |||
5,6c5 | |||
< | |||
< jumps | |||
--- | |||
> jumped | |||
8a8 | |||
> | |||
10c10 | |||
< dog | |||
--- | |||
> dogs | |||
5,6行目と5行目で開業+jumpsのjumpedへの変更 (c=changed)。d=deleted。a=added。こういう形式。 | |||
===== context ===== | |||
% diff -c a.txt b.txt | |||
*** a.txt 2016-08-29 06:43:45.000000000 +0900 | |||
--- b.txt 2016-08-29 06:43:59.000000000 +0900 | |||
*************** | |||
*** 2,10 **** | |||
quick | |||
brown | |||
fox | |||
! | |||
! jumps | |||
over | |||
the | |||
lazy | |||
! dog | |||
--- 2,10 ---- | |||
quick | |||
brown | |||
fox | |||
! jumped | |||
over | |||
the | |||
+ | |||
lazy | |||
! dogs | |||
2行目から10行目にかけて。 | |||
!は変更。+は追加。 | |||
===== unified ===== | |||
[https://den8.hatenadiary.org/entry/20100622/1277226958 diffによるunified形式の意味について - プログラミング以外 - k.bigwheelの日記] | |||
gitなど差分ツールでよく使われるunified形式。形式が独特で知っていないと意味不明なので注意する。diff -uオプションでこの形式になる。 | |||
$ diff -u test.txt.orig test.txt | |||
--- test.txt.orig 2007-06-10 22:13:55.718311614 +0900 | |||
+++ test.txt 2007-06-10 22:54:23.038008776 +0900 | |||
@@ -2,9 +2,10 @@ | |||
かきくけこ | |||
さしすせそ | |||
たちつてと | |||
-なにぬねの | |||
+なにぬねのん | |||
はひふへほ | |||
まみむめも | |||
やゆよ | |||
らりるれろ | |||
わをん | |||
+がぎぐげご | |||
@@の行がが特に重要。 | |||
@@ -R +R @@ | |||
この書式。-Rが元ファイルの変更箇所、+Rが変更後ファイルの変更箇所。 | |||
Rはl,sという形式。lは変更箇所の開始行、sは変更箇所の行数。 | |||
-2,9は2行目から9行分変更箇所がある。という意味。 | |||
変更箇所の前後の情報を@@で表現している。 | |||
ただ、このunified形式は中途半端。視認性重視。 | |||
===== 2カラム ===== | |||
diff -yかicdiff --line--numbersは2列で表示してくれるから、視認性が高い。 | |||
== UML == | |||
=== Tool === | |||
https://chatgpt.com/c/67441feb-d004-800b-96fd-0d9b04ffc628 | |||
[https://www.quora.com/What-are-the-best-UML-tools-for-macOS What are the best UML tools for macOS? - Quora] | |||
* デスクトップ | |||
** StarUML | |||
** ArgoUML | |||
** UMLet | |||
** OmniGraffle | |||
** edraw: 有料。 | |||
** Umbrello | |||
** Modelio | |||
* クラウド | |||
** Visual Paradigm | |||
** Lucidchart: 有料。 | |||
** Creately: 有料。 | |||
** diagrams.net: モデルじゃない。 | |||
*その他 | |||
**PlantUML | |||
UmbrelloとModelioはそれらと比較して何がよかったのだっけ? | |||
Eclipse Papyrusが動作するならこれがいい。Eclipseは安定しているから、これのプラグインで動作するなら信頼できるだろう。 | |||
papyrusは一度試してダメだった気がするが。 | |||
=== Diagram === | |||
==== クラス図 ==== | |||
A=自分 (矢印の元)。B=相手 (矢印の先) | |||
* 継承関係 | |||
** 汎化 (generalization): 実線白矢印。継承。 | |||
** 実現 (realization): 点線矢印。interfaceの継承。 | |||
* プロパティー単位 | |||
**関連 (association): 実線。あるクラスが他のクラスのインスタンスを持つ。ただし、所有までいかない。コンストラクターのDIも含む。人と車のように全体-部分の関係がない場合これ。困ったらこれでもいい。 | |||
** 集約 (aggregation): 白菱形実線。関連の特殊系。所有者の方が菱形。所有される側は線。全体-部分の関係。ただし、部分は他の全体からも共有可能。List<T>やSet<T>のメンバー変数があれば集約の可能性が高い。 | |||
** コンポジション (composition): 黒ひし形。子が単体で存在できない場合。親と生存期間が同一の場合。部分が他から共有されない。集約の特殊系。 | |||
** リンク (link): 実線。クラスのインスタンス間の関係。クラス図ではなく、オブジェクト図で使われる。 | |||
* メソッド単位 | |||
** 依存 (dependency): 点線矢印。引数か返却値に使っていて、Bの変更が影響を与える場合。 | |||
** 使用 (usage): 点線矢印。引数と戻り値に使わず、関数内で一時的に使うだけ。依存の特殊系。 | |||
==== ER図 ==== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_49664566-4833-490d-9309-e69597a6ac12 | |||
実態関連モデル。Entity-Relationshp Model。関係データベースを抽象的な表現手法。 | |||
格納されたデータが、他のデータとどう関係しているかを表現する。 | |||
1975年にPeter Chenが発表した。 | |||
* Entyty/実体: 現実世界のものや概念相当。オブジェクト指向のオブジェクト相当。DBではテーブル相当。四角形で描画。 | |||
* Attribute/属性: Entityの特徴や詳細情報。オブジェクト指向のプロパティー。DBではテーブルカラム相当。楕円で描画。 | |||
* Relationship/関係: Entity同士のつながり。オブジェクト指向のメソッド?DBではテーブル間の関係 (外部キーによるリンク相当)。菱形で描画。 | |||
* Instance/インスタンス: DBのレコード (行) 相当。 | |||
===== Relationship ===== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_861bd847-f9c8-4c01-8887-9802dad8f6e3 | |||
関係がわかりにくいので整理する。 | |||
Entity (テーブル相当) 動詞の関係をカーディナリティー (多重度) で表現する。3個の関係がある。 | |||
{| class="wikitable" | |||
|+ | |||
!関係 | |||
!関係名 | |||
!例 | |||
!意味 | |||
! | |||
|- | |||
|1:1 (One-to-One) | |||
|<Master> has one <Master> | |||
|Person/Passport: 1人1パスポート。それぞれ重複がない。PassportにPersonの外部キーを持つ。 | |||
Employee/EmployeeDetail: EmployeeDetailのEmployeeの外部キーを持つ。 | |||
|一方のEntityのインスタンス (行) がもう一方のEntityの1個だけのインスタンスに対応し、逆も同じ場合。情報が密接に関連していて、分離する必要はないが、管理・整理のために分けるケース。 | |||
詳細テーブルのパターン。テーブルに持ってもいいが、整理のために別テーブルにしている。 | |||
1:多の特殊ケースとみなせる。 | |||
実際のところ、1:1が本当に対等ということはほぼない。外部キーを片方に持たせる都合、親子関係がある。子が1個だけという話。逆に、そうできていないなら、Entityの選定・設計の問題を疑ったほうがいい。 | |||
| | |||
|- | |||
|1:多 (One-to-Many) | |||
|<Master> has <Transactions> | |||
|Department/Employee: Departmentが親でEmployeeが子。Departmentの1行 (ID=営業部) を、Employeeの複数行 (所属従業員) に対応。1従業員1所属の場合。EmployeeにDepartment IDを外部キーとして持つ。親の部門を削除すると子の従業員も影響を受ける。 | |||
Customer/Order: Customer (ID=1のA) はOrderの複数行 (注文1-3) に対応。注文は1顧客だけに連動。 | |||
|一方のEntityのInstanceがもう一方のEntityの複数のインスタンスに対応。逆は多:1だが、1:多でどちらも表現。親子関係のような階層構造で使用する。マスター:トランザクションの関係でも使う。 | |||
| | |||
|- | |||
|多:多 (Many-to-Many) | |||
|<Master> has many <Master> | |||
|Stundent/Course: Stundentの1行 (ID=1 学生A) はCourseの複数行 (数学、英語) に対応。Courseの1行 (数学) はStundentの複数行 (学生A,B,C) に対応。実装時はEnrollmentテーブル (登録) を作成して、これにStundent IDとCourse IDの相関テーブル+追加情報 (成績) などを入れる。 | |||
Product (製品)/Supplier (仕入先): 1商品が複数仕入れ先から調達可能。1仕入れ先が複数商品を供給。 | |||
|一方のEntityがもう一方の複数のEntityに対応。逆も同じ。両側が独立して複数関連づく場合。DBでは直接実装不能なので、中間テーブルを通常使う。2個の1:多に分解。 | |||
| | |||
|} | |||
マスターテーブルは親的な役割。トランザクションテーブルは子的な関係。通常、マスターテーブル:トランザクションテーブル=1:多。トランザクションテーブルにマスターテーブルの外部キーを持つ。 | |||
関係の命名。業務ロジックにあった命名ができればべストだが、一貫性がない。関係からある程度機械的に名前を決める。 | |||
* 1:1=has one | |||
* 1:多=has | |||
* 多:多=has many | |||
これがスマート。多対多はis related toもよく使うが、他をhasで表現するなら、こうしないと気持ち悪い。 | |||
=== PlantUML === | |||
==== About ==== | |||
* [https://www.plantuml.com PlantUML Web Server] | |||
* [https://plantuml.com/ja/ シンプルなテキストファイルで UML が書ける、オープンソースのツール] | |||
シンプルなテキストでUMLの作成ツール。ツールで機械的に生成できるのがポイント。細かいレイアウトの調整とか、複雑なことをしたい場合、けっこう難しくなる。 | |||
そうでなくて、機械的に作成することで、誰がやっても同じで、形式や配置が統一される。それが利点。 | |||
==== Other ==== | |||
===== 対話AI ===== | |||
自分で作成するより、対話AIにお願いして作ってもらって、それを改造する形で作るのが手っ取り早い模様。 | |||
シーケンス図やクラス図なんかはそれでいける。 | |||
==== VS Code ==== | |||
===== About ===== | |||
[https://qiita.com/Charotarou/items/10bd47c68a1190061858 Visual Studio CodeでPlantUMLを利用する方法(2020/10/30作成) #Java - Qiita] | |||
さっと書くだけなら、Webだけでもいい。機密情報とか扱う場合、ローカルでやるといい。 | |||
VSCodeの拡張機能でインストールする場合、JavaとGraphvizだけでいい。本体は拡張機能インストール時に同梱される模様。 | |||
===== 出力ディレクトリー ===== | |||
[https://oboe2uran.hatenablog.com/entry/2025/07/02/215013 VScode PlantUMLで作成するUML画像の出力先を設定する。 - Oboe吹きプログラマの黙示録] | |||
デフォルト状態だと、ファイル出力時に以下の形式になる。 | |||
out/.puファイル名/@startumlのタイトル.拡張子 | |||
最初のoutがうっとうしいのでpuと同じところに出力してほしい。 | |||
plantuml.exportOutDir: ".", | |||
plantuml.exportSubFolder: false, | |||
上記設定にするとよい。 | |||
==== ステート図/状態遷移図 ==== | |||
[https://plantuml.com/ja/state-diagram 状態遷移図の構文と機能] | |||
画面遷移図にも使える。 | |||
===== Alias ===== | |||
ステート・状態部分には、スペースや記号を使えない。以下の構文で別名を使って、表示用と内部用をわける。 | |||
state "display" as internal | |||
===== 合成状態 ===== | |||
状態は合成可能。ブロックにまとめたりできる。 state 状態名 {} で定義する。 | |||
@startuml | |||
scale 350 width | |||
[*] --> NotShooting | |||
state NotShooting { | |||
[*] --> Idle | |||
Idle --> Configuring : EvConfig | |||
Configuring --> Idle : EvConfig | |||
} | |||
state Configuring { | |||
[*] --> NewValueSelection | |||
NewValueSelection --> NewValuePreview : EvNewValue | |||
NewValuePreview --> NewValueSelection : EvNewValueRejected | |||
NewValuePreview --> NewValueSelection : EvNewValueSaved | |||
state NewValuePreview { | |||
State1 -> State2 | |||
} | |||
} | |||
@enduml | |||
共通処理を中でまとめたりするのに便利そう。 | |||
===== 画面遷移図 ===== | |||
https://chatgpt.com/share/6867298c-09bc-800b-89ec-de487215192b | |||
Webアプリケーションの設計書として、画面遷移図が必要なことがある。 | |||
UMLでやる場合、アクティビティー図か、ステート図 (状態遷移図) がうってつけ。画面とその遷移アクションの両方を記載できるので申し分ない。 | |||
他、一覧表もあり。 | |||
実際にいくつか状態遷移図をステートマシン図で書いてみたところ、問題があった。 | |||
共通ヘッダーやモーダルの表現が難しかった。コンポーネント化的なことができなくて、同じ画面遷移・状態を複数書く必要があった。モーダルを開いて閉じるというのは、repeatでループで表現できるが、他の画面遷移との併記が難しかった。 | |||
これを考えると、ステート図のほうが、矢印の方向が柔軟で、共通化なことができた。 | |||
ステートマシン図の例 | |||
[[ファイル:画面遷移図-ステートマシン図での例.png|なし|サムネイル|[*] --> ログイン画面ログイン画面 --> ホーム画面 : ログイン成功 | |||
ログイン画面 --> [*] : ログイン失敗 | |||
ホーム画面 --> 設定画面 : 設定をクリック | |||
ホーム画面 --> [*] : ログアウト]] | |||
アクティビティー図の例 | |||
[[ファイル:画面遷移図-アクティビティー図の例.png|なし|サムネイル|@startuml(*) --> 個人設定一覧 | |||
個人設定一覧 --> [ヘッダー選択] 共通ヘッダー | |||
個人設定一覧 --> [サイドバー選択] サイドバー | |||
個人設定一覧 --> [リスト選択] センター | |||
@enduml]]https://grok.com/share/c2hhcmQtMw%3D%3D_832592cf-86dd-41eb-a0fa-2fbd656e9299 | |||
ステート図で画面遷移図作成時のポイント。 | |||
Webページの場合はURLでやるのがいいと思う。 | |||
ただ、PlantUML内の状態名は、プログラミング言語の変数名相当だから、_以外の記号は使えない。 | |||
state <display> as <name> でnameを定義するといい。_をスラッシュとみなして、全小文字とか。 | |||
state "www.example.com" as wwww | |||
state "www.example.com/mypage" as www_mypage | |||
[*] -> www | |||
root -> www_mypage | |||
複数サイトになることがあるから、サブドメイン (なければwww) をベースの名前空間にするのがよさそう。 | |||
エイリアス名。url内の記号は除去でいい。exmaple.com/user-profile/editとか。www_userprofile_edit。url内のディレクトリーに記号を使うほうが悪い。全小文字区切り文字なしにすべき。短いほうがいいのだから。 | |||
===== 矢印の向き ===== | |||
矢印の向きの制御方法がある。 | |||
* ->: 最短距離。左右になることが多い。 | |||
* -right->/-down->/-up->/-left->: 向きを明示。 | |||
* -->: 長めの矢印。上下になることが多い。 | |||
* -->/..>: 向きには影響しない。 | |||
* top to bottom direction: 全体の向きの明示。 | |||
directionで全体の向きを指定しても、->の最短矢印だと、長さが優先される。矢印内で向きを明示するか、-->の長めの矢印を使うとよい。 | |||
===== 条件分岐 ===== | |||
<<choice>> ステレオタイプで条件付きの状態を指定できる。 | |||
@startuml | |||
state c <<choice>> | |||
Idle --> ReqId | |||
ReqId --> c | |||
c --> MinorId : [Id <= 10] | |||
@enduml | |||
やや使いにくいかもしれない。条件がある場合、矢印に説明を入れるといいかもしれない。 | |||
==== アクティビティー図 ==== | |||
[https://plantuml.com/ja/activity-diagram-beta 新しいアクティビティ図のベータ版の構文と機能] | |||
===== 記法 ===== | |||
https://chatgpt.com/share/68675652-ff90-800b-93ff-19285fe8cf21 | |||
PlantUMLのアクティビティー図の記法はレガシー記法とモダン記法とで2種類ある。 | |||
最大の違いは、分岐。以前は o --> option1, o --> option2で1個のアクティビティーから複数のアクティビティーに分岐できた。が、これがモダン記法だとできない。 | |||
split forkで明確に管理するようになった。パースとかのしやすさ、構文の曖昧性の排除が目的の模様。 | |||
===== split fork ===== | |||
アクティビティーの分岐の記法。2種類ある。紛らわしい。 | |||
splitは条件分岐、forkは並列実行的なイメージになっている。 | |||
以下の構文。 | |||
* split/split again/end split | |||
* fork/fork again/end fork | |||
@startuml | |||
start | |||
split | |||
:A; | |||
split again | |||
:B; | |||
split again | |||
:C; | |||
split again | |||
:a; | |||
:b; | |||
end split | |||
:D; | |||
end | |||
@enduml | |||
見た目の問題で、splitのほうがすっきりしている。 | |||
===== 矢印 ===== | |||
矢印にテキストを添えたり、色、線の形式を指定できる。<syntaxhighlight lang="text"> | |||
@startuml | |||
:foo1; | |||
-> You can put text on arrows; | |||
if (test) then | |||
-[#blue]-> | |||
:foo2; | |||
-[#green,dashed]-> The text can | |||
also be on several lines | |||
and **very** long...; | |||
:foo3; | |||
else | |||
-[#black,dotted]-> | |||
:foo4; | |||
endif | |||
-[#gray,bold]-> | |||
:foo5; | |||
@enduml | |||
</syntaxhighlight> | |||
===== モーダル ===== | |||
モーダルのような一時的に開いて戻る場合、反復可能なので、repeatで表現するとエレガント。 | |||
@startuml | |||
' PlantUMLソースコード | |||
start | |||
repeat :ホーム; | |||
->モーダルを開く; | |||
:モーダル; | |||
repeat while ([閉じる] 選択) is (yes) | |||
stop | |||
@enduml | |||
ただ、モーダル以外の他の画面遷移が少々苦しくなる。repeat内でsplitすればいけなくはないが。 | |||
モーダルを閉じる動きはstopでいいかもしれない。 | |||
==== ER図 ==== | |||
* [https://plantuml.com/ja/er-diagram Entity Relationship diagram (Chen's notation)] | |||
* [https://plantuml.com/ja/ie-diagram ER図の文法と機能] | |||
PlantUMLでは2種類のER図に対応している。Chen's notationは2024-04導入の新しい模様 ([https://github.com/plantuml/plantuml/blob/master/CHANGES.md#v120244-april-6-2024 plantuml/CHANGES.md at master · plantuml/plantuml])。 | |||
===== Chen notation ===== | |||
[https://plantuml.com/ja/er-diagram Entity Relationship diagram (Chen's notation)] | |||
chenの記法がER図そのものできれい。これを使う。ただ、Chen notationはnoteの注釈機能が使えなくて、見た目はいいけど、機能不十分。IEのほうがよさそう。 | |||
@startchen | |||
entity "DJ.CUSTOMER" as DJ_CUSTOMER { | |||
Number <<key>> | |||
Name | |||
} | |||
entity MOVIE { | |||
Code <<key>> | |||
} | |||
relationship RENTED_TO { | |||
Date | |||
} | |||
RENTED_TO =1= DJ_CUSTOMER | |||
RENTED_TO -N- MOVIE | |||
@endchen | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_db38ab26-68a2-4a0b-b1e4-dc231e51279b | |||
* entity=テーブル。属性がなくても改行した波括弧が必要。少々気持ち悪いが。 | |||
* attribute=属性: entityの波括弧内に記述。<<key>>のステレオタイプでキーを表現。下線がつく。 | |||
* relationship=関係: has/belongs_toとかを記載するのが無難。user-order=places/student-courses=enrollsとかわかるなら動詞も。 | |||
** 太字 (total participation): 親テーブルに埋め込まれている外部キーがNOT NULLの場合。単独存在がなくて存在必須なので。 | |||
entity名に.とかは入れられないのでasで別名で回避 (https://grok.com/share/c2hhcmQtMw%3D%3D_1d81495e-fd3c-4f3c-8fc4-19b2d4f391b2<nowiki/>)。 | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_aa8d7730-69dd-4d58-b88a-8edea922b3c8 | |||
属性はネストできる。これは概念的な話。例えば、住所は市区町村や番地、建物名とかに分解できる。が、物理DBだとこれらは展開済み。グループ化の話。別にネストしなくてもいい。 | |||
====== 親子関係 ====== | |||
オブジェクト指向の継承関係を表現できる。 | |||
* ->-: 矢印の方向が親。 | |||
@startchen | |||
entity CUSTOMER { | |||
} | |||
entity PARENT { | |||
} | |||
entity MEMBER { | |||
} | |||
CUSTOMER ->- PARENT | |||
MEMBER -<- CUSTOMER | |||
@endchen | |||
====== ステレオタイプ ====== | |||
* <<key>>: 主キー。 | |||
* <<derived>>: 他の属性からの計算カラム。 | |||
* <<multi>>: enum形式。 | |||
===== IE ===== | |||
[https://plantuml.com/ja/ie-diagram ER図の文法と機能] | |||
Information EngineeringベースのER図。既存のクラス図の拡張記法。クラス図でできることは全部できる。 | |||
classの代わりにentityを使うところが主な違い。 | |||
====== インフォメーションエンジニアリングの関係線 ====== | |||
{| class="wikitable" | |||
|'''Type''' | |||
|'''記号''' | |||
|- | |||
|0か1 | |||
|<code><nowiki>|o--</nowiki></code> | |||
|- | |||
|1のみ | |||
|<code><nowiki>||--</nowiki></code> | |||
|- | |||
|0以上 | |||
|<code>}o--</code> | |||
|- | |||
|1以上 | |||
|<code><nowiki>}|--</nowiki></code> | |||
|} | |||
波括弧}が複数。|が1、oが0を意味する。 | |||
関係線の記法だけ注意が必要。 | |||
====== エンティティ ====== | |||
基本はクラス図と同じ文法。他の違い。* は必須を意味する。 | |||
==== シーケンス図 ==== | |||
[https://plantuml.com/ja/sequence-diagram シーケンス図の構文と機能] | |||
->でメッセージを描く。参加者の明示的な宣言は不要。 | |||
===== 分類子の宣言 ===== | |||
参加者の宣言は不要だが、デフォルトだと四角になる。actorとかDatabaseとか見た目を調整したい場合、participantでを宣言しておく。 | |||
変数の型名のように、以下の分類子 | |||
* <code>actor</code> | |||
* <code>boundary</code> | |||
* <code>control</code> | |||
* <code>entity</code> | |||
* <code>database</code> | |||
* <code>collections</code> | |||
* <code>queue</code> | |||
* participant (初期値) | |||
<分類子> <参加者>[ as 別名] | |||
@startuml | |||
participant Participant as Foo | |||
actor Actor as Foo1 | |||
boundary Boundary as Foo2 | |||
control Control as Foo3 | |||
entity Entity as Foo4 | |||
database Database as Foo5 | |||
collections Collections as Foo6 | |||
queue Queue as Foo7 | |||
Foo -> Foo1 : To actor | |||
Foo -> Foo2 : To boundary | |||
Foo -> Foo3 : To control | |||
Foo -> Foo4 : To entity | |||
Foo -> Foo5 : To database | |||
Foo -> Foo6 : To collections | |||
Foo -> Foo7: To queue | |||
@enduml | |||
===== メッセージに付けるノート ===== | |||
メッセージのすぐ後ろにキーワード note left または note right を使用し、メッセージにノートを付けることが可能です。 | |||
end note キーワードを使って、複数行のノートを作ることができます。 | |||
@startuml | |||
Alice->Bob : hello | |||
note left: this is a first note | |||
Bob->Alice : ok | |||
note right: this is another note | |||
Bob->Bob : I am thinking | |||
note left | |||
a note | |||
can also be defined | |||
on several lines | |||
end note | |||
@enduml | |||
===== メッセージのグループ化 ===== | |||
次のキーワードを使えば、メッセージをまとめてグループ化できます。 | |||
alt/else | |||
opt | |||
loop | |||
par | |||
break | |||
critical | |||
group表示するテキスト | |||
ヘッダ部分に文字列を追加することが可能です。(groupについては、後述の「groupの2つ目のラベル」を参照) | |||
グループを閉じるにはキーワード end を使用します。 | |||
@startuml | |||
Alice -> Bob: Authentication Request | |||
alt successful case | |||
Bob -> Alice: Authentication Accepted | |||
else some kind of failure | |||
Bob -> Alice: Authentication Failure | |||
group My own label | |||
Alice -> Log : Log attack start | |||
loop 1000 times | |||
Alice -> Bob: DNS Attack | |||
end | |||
Alice -> Log : Log attack end | |||
end | |||
else Another type of failure | |||
Bob -> Alice: Please repeat | |||
end | |||
@enduml | |||
<code>group</code>では、<code>[</code>と<code>]</code>の間に2つ目のラベルを設定し、ヘッダに表示させることができます。 | |||
@startuml | |||
Alice -> Bob: Authentication Request | |||
Bob -> Alice: Authentication Failure | |||
group My own label [My own label 2] | |||
Alice -> Log : Log attack start | |||
loop 1000 times | |||
Alice -> Bob: DNS Attack | |||
end | |||
Alice -> Log : Log attack end | |||
end | |||
@enduml | |||
===== ライフラインの活性化と破棄 ===== | |||
activateとdeactivateで分類子の活性化を表現。例えば、関数の実行中とかが四角になってわかりやすい。 | |||
が、やや記述が複雑になるので注意する。 | |||
@startuml | |||
participant User | |||
User -> A: DoWork | |||
activate A | |||
A -> B: << createRequest >> | |||
activate B | |||
B -> C: DoWork | |||
activate C | |||
C --> B: WorkDone | |||
destroy C | |||
B --> A: RequestCreated | |||
deactivate B | |||
A -> User: Done | |||
deactivate A | |||
@enduml | |||
autoactivate onにすると勝手に活性化してくれる。returnで解除する。昔はなかった気がする。このautoactivate on。 | |||
ただ、これを使うと、途中でif文でreturnする倍とかの表現が面倒になるので注意する。 | |||
@startuml | |||
autoactivate on | |||
alice -> bob : hello | |||
bob -> bob : self call | |||
bill -> bob #005500 : hello from thread 2 | |||
bob -> george ** : create | |||
return done in thread 2 | |||
return rc | |||
bob -> george !! : delete | |||
return success | |||
@enduml | |||
returnを使うと自動的に活性化してくれるのでこれを活用するのがいい。 | |||
@startuml | |||
Bob -> Alice : hello | |||
activate Alice | |||
Alice -> Alice : some action | |||
return bye | |||
@enduml | |||
===== 活性化、非活性化、生成のショートカット記法 ===== | |||
対象の分類子を記述した直後に、次の記法を使うことができます。 | |||
* <code>++</code> 対象を活性化する (続けて[[/plantuml.com/ja/color|色]]を記述することもできます) | |||
* <code>--</code> 起点側を非活性化する | |||
* <code>**</code> 対象のインスタンスを生成する | |||
* <code>!!</code> 対象のインスタンスを破棄する | |||
==== クラス図 ==== | |||
[https://plantuml.com/ja/class-diagram クラス図の構文と機能] | |||
===== メソッド ===== | |||
クラス名:に続けて記載する。他に波括弧。 | |||
丸括弧があればメソッド。なければプロパティー。 | |||
@startuml | |||
Object <|-- ArrayList | |||
Object : equals() | |||
ArrayList : Object[] elementData | |||
ArrayList : size() | |||
@enduml | |||
@startuml | |||
class Dummy { | |||
String data | |||
void methods() | |||
} | |||
class Flight { | |||
flightNumber : Integer | |||
departureTime : Date | |||
} | |||
@enduml | |||
===== 可視性 ===== | |||
{| class="wikitable" | |||
|'''文字''' | |||
|'''可視性''' | |||
|- | |||
|<code>-</code> | |||
|<code>private</code> | |||
|- | |||
|<code>#</code> | |||
|<code>protected</code> | |||
|- | |||
|<code>~</code> | |||
|<code>package private</code> | |||
|- | |||
|<code>+</code> | |||
|<code>public</code> | |||
|} | |||
===== 注釈とステレオタイプ ===== | |||
===== 注釈の詳細 ===== | |||
===== フィールド(フィールド、属性、メンバー)またはメソッドへの注釈 ===== | |||
フィールド (フィールド、属性、メンバー) に注釈を追加できる。 | |||
left/rightのみ可能。名前空間区切り文字列に::を指定した場合、使用不能。 | |||
@startuml | |||
class A { | |||
{static} int counter | |||
+void {abstract} start(int timeout) | |||
} | |||
note right of A::counter | |||
This member is annotated | |||
end note | |||
note right of A::start | |||
This method is now explained in a UML note | |||
end note | |||
@enduml | |||
以下の書式。 | |||
note <direction> of <class>::<attribute> | |||
end note | |||
インラインは不能。 | |||
==== Reference ==== | |||
[https://plantuml.com/ja/guide PlantUML Language Reference Guide] | |||
===== Creole ===== | |||
[https://plantuml.com/ja/creole Use creole syntax to style your texts] | |||
====== 特殊文字 ====== | |||
&#XXXXまたは、<U+XXXX>の構文、または直接記述することで、任意のUnicode文字を使うことができます。 | |||
らしいが、&#XXXX形式は解釈されなかった。<U+XXXX>は有効だった。 | |||
[https://blog.jawira.com/2022/10/30/escaping-special-characters-in-plantuml.html Escaping special characters in PlantUML | Jawira blog] | |||
noteのブロックの先頭に'を書きたい場合、コメント扱いされてしまう。 | |||
<U+0027>でユニコード文字表記にすれば回避できる。 | |||
===== 21 共通コマンド ===== | |||
[https://plantuml.com/ja/commons General and common command to handle graphic layout in diagrams.] | |||
====== コメント ====== | |||
* シングルコメント: シングルクォート'で始まる行はコメント。 | |||
* ブロックコメント: C言語と同様だが/' '/ で囲む。 | |||
====== タイトル ====== | |||
title タイトル | |||
title | |||
end title | |||
タイトル部分は\nで改行できる。他にブロック形式だと改行を含められる。 | |||
====== キャプション ====== | |||
captionでキャプション。 | |||
====== フッターとヘッダー ====== | |||
footer/headerブロック。 | |||
====== 凡例 ====== | |||
legend/end legend | |||
====== 21.9 メインフレーム ====== | |||
mainframe This is a **mainframe* | |||
タイトルみたいに枠で囲んでくれて見た感じがよくなる。 | |||
===== 25 前処理 ===== | |||
====== 25.5 プロシージャー [!procedure, !endprocedure] ====== | |||
テキストを出力する。 | |||
====== 25.6 return関数 [!function, !endfunction] ====== | |||
[https://messykitchen.hateblo.jp/entry/2022-05-23_plantuml_function_procedure マクロの扱い [脱W〇rd, 脱E×cel, 脱@st@h : #14] - messyなkitchenなブログ] | |||
過去の!define相当。テキストの値として使う。 | |||
=== Umbrello === | |||
==== Problem ==== | |||
altなどの重なり順番、アクティブの下になっちゃう | |||
optの条件が表示されない。 | |||
=== Papyrus === | |||
[https://eclipse.dev/papyrus/download.html Papyrus Dowloads] | |||
[https://eclipse.dev/papyrus/documentation.html Papyrus Documentation] | |||
==== Tutorial ==== | |||
公式の[A slide-ware tutorial on Eclipse Papyrus usage for starters (2010-10-01)]を参考に基本的な使い方を学ぶ。 | |||
[File]-[New]-[Papyrus prooject] | |||
これでプロジェクトを作ると、以下が [Project Explorer] に作られる。 | |||
* <project name> | |||
** <project name> | |||
*** di: ツールメタデータ。モデル作成のエントリーポイント。 | |||
*** notation: 画像データ。 | |||
*** uml: UMLモデルデータ。 | |||
このdiをダブルクリックして描画を開始する。 | |||
1個のプロジェクトでいろんな図に対応していて、モデルを流用できる形になっている。悪くない。これを使う。 | |||
画面構成 | |||
# Project explorer | |||
# Model explorer: 一番重要。ここでモデル全体をツリーベースで管理する。 | |||
# Outline view: アウトライン | |||
# Main toolber: ツールバー。 | |||
# Perspective: Model explorerの内容を使って作図する領域。 | |||
# Property view: モデルのエディター画面。 | |||
Model explorerがPapyrusの本質。ここでクラスとかインタラクションを定義しておいて、この定義をperspectiveの作図に使うイメージ。 | |||
クラス図やシーケンス図もModel explorerに所属していて、好きなだけ作れる。[New diagram]から作れる。 | |||
[New Child] でいくつか重要なモデルがある。 | |||
* Package: ディレクトリ・フォルダーみたいなもの。これで他のモデルをまとめて整理できる。 | |||
* Interaction: シーケンス図表現用のモデル。 | |||
* Class: クラス。Interactionの型だったりする。UMLのベースで非常に重要。 | |||
==== Class ==== | |||
===== 属性表示 ===== | |||
クラス図にクラスモデルを配置しても、プロパティーやメソッドが表示されない。 | |||
右クリック-[Filters] で制御できる。 | |||
* [Synchronized with Model] を選ぶと同期されて全部表示される。基本はこれで、一部だけ表示したい場合にここを外すのだろうと思う。 | |||
* [Show/Hide Contents] で表示可否をチェックボックスで選べる。 | |||
===== Modelへのジャンプ ===== | |||
クラス図などからオブジェクトのModel Explorerの元データにジャンプしたいことがある。 | |||
オブジェクト右クリック-[Navigate]-[Go to ...]-[Model Explorer] を選ぶ。 | |||
===== Comment ===== | |||
https://chatgpt.com/c/67aec9f8-6be0-800b-b6eb-6300425ad1d4 | |||
メソッドなどにコメントを入れたいことがある。このコメントがわかりにくい。 | |||
[Properties]-[Comments]-[Owned comments]-[Body] に入力する。初回+で作ったダイアログのBodyに入力したものは反映されなくて、一度空のコメントを作った後に、洗濯後横のBodyに入力すると反映される模様。 | |||
* Applied comments=他のモデルのコメントを取り込みたい場合に使う。 | |||
* Owned comments=自分自身のコメント。コメントに対してコメントをつけることもできるので、[Create a new Comment] はさらに [Comments] タブを持っている。このタブがコメントのコメント。基本は使う必要ない。 | |||
[Annotated element] でたぶん、Bodyに入力したコメントを複数の要素に適用したい場合の適用先だと思う。 | |||
==== Sequence diagrams ==== | |||
https://eclipse.dev/papyrus/resources/PapyrusTutorial_OnSequenceDiagrams_v0.1_d2010100.pdf | |||
===== 2.2 Adding messages (basic - asynchronous) ===== | |||
コミュニケーションは、メッセージの交換で描写される。 | |||
メッセージはoperationCall (同期/非同期) かsignal (非同期) コミュニケーションとして表現される。 | |||
synchronousCall作成時は、replyMessageも期待される。 | |||
createMessageとdeleteMesageの指定は、ライフラインの動的な有無を意味する。 | |||
Papyrusでのメッセージ作成は以下の手順で構成される。 | |||
# パレットからツールを選択。 | |||
# ソースLifelineの開始点をクリック。 | |||
# ターゲットLifelineの終了点をクリック。 | |||
# ポップアップの該当するsignal/operationを選択。 | |||
記法 | |||
* 非同期メッセージは中抜き矢尻 (arrow head)。 | |||
* 同期メッセージは塗りつぶし矢尻。 | |||
* 返信メッセージは波線 (dashed line)。 | |||
* オブジェクト作成メッセージは波線+中抜き矢尻。 | |||
* Lost Messageは黒丸矢尻。 | |||
* Found Messageは黒丸矢柄。 | |||
====== 2.2.1 Select desired tool from the palette ====== | |||
* Message SyncとMessage Replyは [Execution Specifications] がないと使えない。 | |||
* Message createはターゲットポイントが存在時に使用可能。 | |||
====== 2.2.2 Select source and target points ====== | |||
ソースとターゲットポイントは2の異なるライフライン (通常) か、同じライフライン (再帰) が選択可能。 | |||
ターゲットポイントの制限は、対象の要素に依存する。例えば、Synchronous CallはExecution Specificationから始まる必要がある。 | |||
===== 2.3 Adding execution specification ===== | |||
ここまでのシーケンス図では、通信シナリオだけを想定してきた。が、実際には、完全な実行トレースを表現できる。Execution Specification (ES) は実行を表す抽象概念で、Action Execution SpecificationとBehavior Execution Specificationの2種類がある。 | |||
PapyrusではライフラインにESをセットして行う。ESをセットしたら、同期メッセージを追加できる。 | |||
開発プロセスでは、予備設計では全メッセージを非同期とみなしておいて、設計時にESを設定して、同期メッセージをする感じ。 | |||
ただ、同期メッセージは、応答メッセージが入ってごちゃごちゃする。単にシーケンス図を書くだけなら、非同期で全部書いてもいいと思う。 | |||
===== Undoで破損 ===== | |||
シーケンス図を作成して、削除のUndoを何回かやると、データが破損して開けなくなる。対応方法不明。GitでPapyrusのファイルを管理しておいて、破損に対応しておいた方がいい。 | |||
===== 再帰自己呼び出しシーケンス図 ===== | |||
シーケンス図の描画に癖があるので、方針を固めて使用する。 | |||
# 自己関数の呼び出しはMessage Async/Message Reply。Message Syncは期待通りに配置されないので、自己関数には使わない。他のライフラインには使う。 | |||
# 関数の呼び出し期間はAction Execution Specificationを配置。 | |||
# 矢印の端にESを配置する形にする。 | |||
===== オブジェクトの移動 ===== | |||
オブジェクトの移動に癖がある。基本的に、メッセージは始点、終点で別々に移動させるしかない。まとめて選択して一括移動ができない。 | |||
終点を移動させると、その下のオブジェクトも追随する。追加はこれで対応できる。減らすのは手間になる。 | |||
シーケンス図が大きくなりすぎないように注意する。 | |||
== Coding == | |||
=== タイムゾーン === | |||
[https://qiita.com/dmikurube/items/15899ec9de643e91497c タイムゾーン呪いの書 #timezone - Qiita] | |||
3文字形式は避けたほうが無難。 | |||
タイムゾーン名で判定する実装があるので、UTC-9なども避けたほうがいい。 | |||
tz databaseのAsia/Tokyoなどの確実性が高い。 | |||
=== Regular Expression === | === Regular Expression === | ||
* [https://ja.wikipedia.org/wiki/%E6%AD%A3%E8%A6%8F%E8%A1%A8%E7%8F%BE 正規表現 - Wikipedia] | |||
* [https://pubs.opengroup.org/onlinepubs/9699919799.2008edition/basedefs/V1_chap09.html Regular Expressions] | |||
正規表現。重要。覚えにくいが重要なものをメモしておく。 | 正規表現。重要。覚えにくいが重要なものをメモしておく。 | ||
==== BRE ==== | |||
===== BREs Matching Multiple Characters ===== | |||
複数文字に一致するBREを作成する記法 (量指定子) がある。 | |||
単一文字、部分式、後方参照のいずれかに一致するBREの後に、'\{m\}', '\{m,\}', '\{m,n\}' の形式の配置で、指定回数の連続に一致する。 | |||
* mとnの範囲: 0<=m<=n<={RE_DUP_MAX}の範囲の10進数。 | |||
* mは最小出現回数、nは最大出現回数。 | |||
* \{m\}: m回出現 | |||
* \{m,\}: m回以上 | |||
* \{m,n\}: m-n回出現 | |||
例: abababccccccdに対する"c\{3^}"は7-9文字目でマッチ。 | |||
{| class="wikitable" | |||
|+単一文字の量指定子 | |||
|<code>*</code> | |||
|<code>{0,}</code> と同じ | |||
|- | |||
|<code>+</code> | |||
|<code>{1,}</code> と同じ | |||
|- | |||
|<code>?</code> | |||
|<code>{0,1}</code> と同じ | |||
|} | |||
===== POSIXクラス ===== | |||
言語によって、アルファベット順が違うことがある。エストニア語ではsの後にzがあり、[a-z]では全ての英字にマッチしない。ロケールに依存する。 | |||
これの排除のために、文字の区分を定義している。 | |||
{| class="wikitable" | |||
|+ | |||
!POSIXクラス | |||
!対応正規表現 | |||
!意味 | |||
|- | |||
|<nowiki>[[:upper:]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:lower:]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:alpha:]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:alnum:]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:digit:]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:xdigit]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:punct:]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:blank:]]</nowiki> | |||
|[ \t] | |||
|スペースとタブ。 | |||
|- | |||
|<nowiki>[[:space:]]</nowiki> | |||
|[ \t\n\r\f\v] | |||
|スペースとタブ+改行類。 | |||
|- | |||
|<nowiki>[[:cntrl:]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:graph:]]</nowiki> | |||
| | |||
| | |||
|- | |||
|<nowiki>[[:print:]]</nowiki> | |||
| | |||
| | |||
|} | |||
特に以下が重要。 | |||
* <nowiki>[[:alnum:]]</nowiki> | |||
* <nowiki>[[:space:]]</nowiki> | |||
[:X:]が[]内で使える構文の扱い。組み合わせる場合、[[:upper:]ab]という感じで外側各括弧に収める。 | |||
==== ERE ==== | |||
基本はBREと同じ。エスケープ\が不要になっている。 | |||
多くのプログラミング言語などでは、EREが基本。grep -E相当。 | |||
==== PCRE ==== | |||
* [https://www.php.net/manual/ja/reference.pcre.pattern.syntax.php PHP: PCRE 正規表現構文 - Manual] | |||
* [https://www.pcre.org/current/doc/html/pcre2syntax.html pcre2syntax specification] | |||
EREをさらに以下で拡張したもの。 | |||
* POSIXクラスの拡張表現の文字クラス | |||
* 量指定子の追加構文 (+ ?) | |||
* 言明/assertion | |||
===== 量指定子/Quantifiers ===== | |||
? 0 or 1, greedy | |||
?+ 0 or 1, possessive | |||
?? 0 or 1, lazy | |||
* 0 or more, greedy | |||
*+ 0 or more, possessive | |||
*? 0 or more, lazy | |||
+ 1 or more, greedy | |||
++ 1 or more, possessive | |||
+? 1 or more, lazy | |||
{n} exactly n | |||
{n,m} at least n, no more than m, greedy | |||
{n,m}+ at least n, no more than m, possessive | |||
{n,m}? at least n, no more than m, lazy | |||
{n,} n or more, greedy | |||
{n,}+ n or more, possessive | |||
{n,}? n or more, lazy | |||
{,m} zero up to m, greedy | |||
{,m}+ zero up to m, possessive | |||
{,m}? zero up to m, lazy | |||
BRE/EREで登場した量指定子。デフォルトではgreedy (貪欲) マッチで、最長マッチ。 | |||
量指定子の末尾に?で最短マッチ (lazy)。 | |||
量指定子の末尾に+で独占的 (possessive)。マッチを消費する。処理の高速化になる。 | |||
===== 言明/assertion ===== | |||
* [https://www.php.net/manual/ja/regexp.reference.anchors.php PHP: アンカー - Manual] | |||
* [https://www.php.net/manual/ja/regexp.reference.assertions.php PHP: 言明 - Manual] | |||
言明 (assertion) はカレントマッチング位置の直前・直後の文字に対するテスト、条件付け。文字を消費しない。テストのみ。 | |||
if文相当。直接マッチしないで、条件へのマッチ。マッチ対象文字を消費しない。 | |||
正規表現内で、if文相当の条件判定する際に使用する。 | |||
BREの段階で^$ (アンカー/anchor) があった。これの大幅拡張。 | |||
例えば、フォームの検証で「特定文字種が含まれていること」+9-12文字のような複数の条件指定を実現できる。 | |||
複雑な言明はサブパターン (言明サブパターン/assetion subpattern) を用いる。カレント位置の先と後とで2種類ある。 | |||
====== anchors ====== | |||
^ start of subject | |||
also after an internal newline in multiline mode | |||
(after any newline if PCRE2_ALT_CIRCUMFLEX is set) | |||
$ end of subject | |||
also before newline at end of subject | |||
also before internal newline in multiline mode | |||
====== simple assertions ====== | |||
\b word boundary | |||
\B not a word boundary | |||
\A start of subject | |||
\Z end of subject | |||
also before newline at end of subject | |||
\z end of subject | |||
\G first matching position in subject | |||
====== LOOKAHEAD AND LOOKBEHIND ASSERTIONS ====== | |||
(?=...) ) | |||
(*pla:...) ) positive lookahead | |||
(*positive_lookahead:...) ) | |||
(?!...) ) | |||
(*nla:...) ) negative lookahead | |||
(*negative_lookahead:...) ) | |||
(?<=...) ) | |||
(*plb:...) ) positive lookbehind | |||
(*positive_lookbehind:...) ) | |||
(?<!...) ) | |||
(*nlb:...) ) negative lookbehind | |||
(*negative_lookbehind:...) ) | |||
肯定否定。=で肯定、!で否定。 | |||
* (?: 先読み。言明の次、右側を判定。 | |||
* (?<: 戻読み。言明の前、左側を判定。 | |||
先読み言明 (lookahead assertion) | |||
例えば、以下のパターンはセミコロンが後に続く単語にマッチする。 | |||
\w+(?=;) | |||
言明は複数同じ場所に配置可能で、AND条件になる。ORにしたかったら、(?<=abc|abde) のように選択肢にする。 | |||
以下はbarが後ろに続かないfooにマッチする。 | |||
foo(?!bar) | |||
以下はfoo以外の後のbarではない。 | |||
(?!foo)bar | |||
全部のbarにマッチする。この言明の直後の3文字がbarの場合、(?!foo)が常に真になるから。 | |||
言明の先読みは、基本は右端に配置する。右端の後に何か続ける場合、\w+とか使う。言明自体は文字を消費しないから、言明部分をカバーできるタイプの文字クラスの併用が必要。 | |||
echo preg_match('/foo(?=bar)\w+$/', 'foobar.'); # 0 | |||
==== Case ==== | |||
後ろからマッチ。cが置換対象。 | 後ろからマッチ。cが置換対象。 | ||
/[^c]*$/ | |||
cより右端 | |||
===== マッチの前後の挿入 ===== | |||
https:/vim.fandom.com/wiki/Power_of_g | |||
:g/GST_.*("/s/^/LOG(INFO) << "DEBUG";/r/ | |||
行頭・行末で引っ掛ける。 | |||
===== 関数にログ ===== | |||
:%s/([^")]*)/) /([a-z]* /)*{/&/rLOG(INFO) << "/1";/r/g | |||
考慮するケース | |||
double currentTime() const override { return m_element->currentTime(); } | |||
===== フォーム検証 ===== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_0c3a03bf-35f1-4594-a5d8-21673072ada5 | |||
英字と数字がそれぞれ1文字以上、かつ9-12文字。 | |||
戻読み言明と量指定を併用する。 | |||
$password = "123456333d78"; // テスト用のパスワード | |||
$options = [ | |||
'options' => [ | |||
'regexp' => '/^(?=.*<nowiki>[[:alpha:]]</nowiki>)(?=.*\d).{9,12}$/' | |||
] | |||
]; | |||
if (filter_var($password, FILTER_VALIDATE_REGEXP, $options)) { | |||
echo "パスワードは有効です。"; | |||
} else { | |||
echo "パスワードが条件を満たしていません。"; | |||
ただ、filter_inputだと検証失敗の理由まで特定して取得できない。面倒だが1個ずつやるしかない。関数化すれば1回で済む。 | |||
=== glob === | |||
* [https://pubs.opengroup.org/onlinepubs/9699919799.2008edition/functions/glob.html glob] | |||
* [https://pubs.opengroup.org/onlinepubs/9699919799.2008edition/utilities/V3_chap02.html#tag_18_13 Shell Command Language] | |||
重要。正規表現とは似ているが異なる、パターンマッチング記法 (Pattern Matching Notation)。主に、globで採用されており、ディレクトリー・ファイルのマッチングで使われる。 | |||
使用可能な記号は以下3個。以下の3文字は\でエスケープできる。 | |||
* ?: 任意の1文字にマッチ。 | |||
* *: 任意の0以上の文字にマッチ。 | |||
* [: []内の1文字にマッチ。正規表現の各括弧と同じ。ただし、先頭の否定が^ではなく、!。 | |||
ファイル名マッチ時には、追加で特殊なルールがある。 | |||
.から始まるファイル名へのマッチには、.が必要。つまり、*?は先頭の.にはマッチしない。[!a] のような否定形の各括弧記法も.にはマッチしない。加えて、先頭の[.]もマッチするかは不定(unspecified)。 | |||
globで.ファイルを含めたい場合、工夫が必要 ([https://www.php.net/manual/ja/function.glob.php PHP: glob - Manual])。 | |||
.[!.]* * | |||
上記のように.ファイルのマッチとそれ以外を指定する必要がある。 | |||
<code>.[!.]*</code> は、<code>.</code>と<code>..</code>以外の.<code>.</code>始まりのファイルにマッチする。 | |||
<code>.*</code>を指定すると、<code>.</code>/<code>..</code>がマッチするので注意する。最近のシェルは、シェル側で気を利かせているようで、<code>.*</code>だと<code>.</code> /<code>..</code>はマッチしない。 | |||
=== 引用符のネスト === | |||
シェルやプログラミング言語で、文字列リテラルの表現などで、一重引用符'と二重引用符"を使う。 | |||
JSON作成や変数展開などで、これらをネストさせたいことがある。その基本的な考え方を整理する。 | |||
交互にしていい場合は簡単二重。引用符内に一重引用符を配置、一重引用符内に二重引用符を配置すればいい。 | |||
問題はこれがNGな場合。特にありがちなのが、JSONの生成。JSONの引用符は二重引用符のみ。一重引用符の中だと、二重引用符の変数展開が使用不能。外側を二重引用符にする必要がある。 | |||
二重引用符は、内部で変数展開が可能。この都合で、バックスラッシュ\によるエスケープが有効。 | |||
基本的な方法。 | |||
# 既存の一重/二重引用符などをバックスラッシュでエスケープ。 | |||
# 全体を一重/二重引用符で囲む。 | |||
何かAwkの本か何かで、基本的な考え方の説明の記載があった気がする。 | |||
[{"ke\y":"valu\e"}] を例として考える。 | |||
# {"ke\y":"valu\e"} | |||
# エスケープ: {\"ke\\y\":\"valu\\e\"} | |||
# 全体囲み: "{\"ke\\y\":\"valu\\e\"}" | |||
これでOK。また何か考慮不足があればそのときに考える。 | |||
ただ、元データに修正が必要なので、そのまま行きたい。ヒアドキュメント的なものが使えるならそれを使うのがいい。 | |||
例えば、シェルなら、catコマンドとコマンド置換で生テキストを使える。 | |||
echo $(cat <<-'EOT' | |||
{"ke\y":"valu\e"} | |||
EOT | |||
) | |||
.envなどで使える技?いや使えない。.envではシンプルなコマンドしか使えず、ヒアドキュメントは使えない模様。 | |||
* [https://stackoverflow.com/questions/15637429/how-to-escape-double-quotes-in-json How to escape double quotes in JSON - Stack Overflow] | |||
* [https://stackoverflow.com/questions/64011248/how-to-handle-double-quotes-in-json-value python - How to handle double quotes in JSON value? - Stack Overflow] | |||
JSONのvalue部分に適用したい場合。データの二重引用符をバックスラッシュでエスケープする。これはこうするしかない。JSONが二重引用符しか認めないから。 | |||
基本的な考え方がある。 | |||
# JSON value用に二重引用符"を\"で置換。 | |||
# \"がPHP/JavaScriptで二重引用符に扱いにならないように、\を\\に置換。 | |||
# JSON項目の二重引用符"を\"で置換。 | |||
# 全体を二重引用符"で囲む。 | |||
こういう感じ。JSONはawkでも任意の最終データで考える。途中にプログラミング言語でのパースがあるので、それを考慮する必要がある。 | |||
=== | === ケース変換 === | ||
[https://stackoverflow.com/questions/63116039/camelcase-to-kebab-case javascript - camelCase to kebab-case - Stack Overflow] | |||
キャメルケースをチェインケースにしたり、逆にしたりなどケース変換したいことがある。正規表現を駆使して実現する。 | |||
=== encode === | |||
[https://www.sejuku.net/blog/25909 【PHP入門】URLエンコードする方法(urlencode) | 侍エンジニアブログ] | |||
日本語や記号を他のコードに変換 (エンコード) する方式が何通りかある。把握しておくと役立つ。 | |||
* | * パーセントエンコーディング/URLエンコード: URLで使用不能な文字を%16進数で連結。 | ||
* | * UTF-8 | ||
* | * base64: 全データを「A-Z」「a-z」「0-9」「+」「/」の64文字で表現。文末に=を使うので実質は65文字。 | ||
* HTMLエンコード: HTMLで特殊な意味を持つ文字を&lt;などに変換する。 | |||
==== Percent-encoding ==== | |||
* [https://ja.wikipedia.org/wiki/%E3%83%91%E3%83%BC%E3%82%BB%E3%83%B3%E3%83%88%E3%82%A8%E3%83%B3%E3%82%B3%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0 パーセントエンコーディング - Wikipedia] | |||
[https:// | * [https://developer.mozilla.org/ja/docs/Glossary/Percent-encoding Percent-encoding (パーセントエンコーディング) - MDN Web Docs 用語集: ウェブ関連用語の定義 | MDN] | ||
* [https://datatracker.ietf.org/doc/html/rfc3986 RFC 3986 - Uniform Resource Identifier (URI): Generic Syntax] | |||
unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" | |||
上記文字はエンコードの対象外。 | |||
==== | ==== 英数変換 ==== | ||
[https://stackoverflow.com/questions/28110062/php-how-to-encode-all-characters-with-rawurlencode string - PHP How to encode all characters with rawurlencode - Stack Overflow] | |||
変数名への変換などで、日本語や記号を英数字 [0-9a-zA-Z] に変換したいことがある。 | |||
こういう目的だと%エンコーディングが適している。 | |||
ただし、一部の記号を許可しているので、自前で変換する。 | |||
function encode_all($str) { | |||
$hex = unpack('H*', $str); | |||
return preg_replace('~..~', '%$0', strtoupper($hex[1])); | |||
} | |||
$str = 'big ƒüßchen'; | |||
print_r(encode_all($str)); | |||
==== | ==== Term ==== | ||
紛らわしい用語がある。 | |||
- | * ミドルウェア: 名前通り中間のソフトウェア。DBやアプリケーションサーバーなどが該当。単独で動作が重要なポイント ([https://sackle.co.jp/blog/detail/1248-2 ミドルウェアとは何か?代表的な製品や使用例とあわせて解説! - サックルMAGAZINE]、[https://system-kanji.com/posts/middleware-development ミドルウェアとは?アプリ・システム開発との関係・仕組み・役割・具体例を解説【2024年最新版】 | システム幹事])。 | ||
* フレームワーク: 単体で動作しない。アプリ開発のテンプレート。Django/Ruby on Rails/Vue.jsなど ([https://www.pentasecurity.co.jp/pentapro/entry/framework_library 【3分ITキーワード】 フレームワークとライブラリの違いは? - ペンタPRO:ペンタセキュリティが提供するセキュリティ情報まとめサイト])。 | |||
* ライブラリー: 単体で動作しない。よく使われるコードの集まり。機能単位。jQuery/Numpy/matplotlib/Qtなど。 | |||
フレームワークの中にライブラリーも含めていいと思う。 | |||
「[https://webbigdata.jp/what-is-ai/page-6804/page-8359/page-12091/ Pythonのモジュールとパッケージとライブラリとフレームワークの違い]」がわかりやすい。 | |||
フレームワークはライブラリーを含んでいる。ライブラリーで共通でいいと思う。 | |||
=== | ==== Category ==== | ||
「[https://ja.wikipedia.org/wiki/%E3%82%BD%E3%83%95%E3%83%88%E3%82%A6%E3%82%A7%E3%82%A2%E9%96%8B%E7%99%BA%E5%B7%A5%E7%A8%8B ソフトウェア開発工程 - Wikipedia]」 | |||
ソフトウェアの分類、ページ分類時に役立つ。 | |||
* 言語 | |||
* ツール: 静的解析、テスト、文書など。 | |||
* フレームワーク | |||
MediaWikiのページ名は全体で固有が条件なので、言語名+分類名でページを作るといい。 | |||
例 | |||
* PHP language | |||
* PHP tool | |||
* PHP framework | |||
== | ==== 成功時連続継続処理 ==== | ||
一度の取得件数の上限が決まっていて、終了・失敗するまで取得を継続したいという処理がそれなりに発生する。 | |||
# 処理実行。 | |||
# 成功ならA、失敗なら終了。 | |||
# 処理実行。 | |||
# 成功ならA、失敗なら終了。 | |||
こういうパターン。いくつか実装方法があるが、while (true) のパターンが重複がなくてベストだと思う。 | |||
/* | |||
// 無限ループで終了条件でブレイク | |||
while (true) { | |||
// 処理実行 | |||
if (失敗) { | |||
break; | |||
} | |||
成功時処理 | |||
} | |||
// do while | |||
do { | |||
処理実行 | |||
if (成功時) {} | |||
} while (); | |||
// for (初期化; 継続判定・終了判定; 成功時式) { | |||
処理実行 | |||
} | |||
*/ | |||
do-whileは成功・終了判定を2回書く必要がある。 | |||
forだと成功処理を式でしか書けない。成功処理を関数や即時実行関数式などで書くなら悪くはないし、ベストになりえる。 | |||
いや、成功時処理内の処理の結果次第で反復の終了条件などが追加で入るならNGになる。なので、やっぱりwhile(true)が無難。コード行数もそんなに変わらない。 | |||
これにさらに初回だけ、ヘッダーの取得、書き込み処理などが発生する場合、初回だけループの外でやるのがきれいだろうか?初回処理が2回登場することになるけれど。 | |||
=== | offsetなどで初回の判定が反復内でできるから、それで分けるのがいいか? | ||
$offset = 0; | |||
while (true) { | |||
$currentReturnCode = $service->sendRequest(Raku2Config::API_TYPE_CSV_EXPORT, Raku2Config::CONFIG_API_URL_MULTI_API, [ | |||
json_encode([ | |||
'dbSchemaId' => $table_info['dbSchemaId'], | |||
'offset' => $offset, | |||
'limit' => $limit, | |||
]) | |||
]); | |||
$response = $service->getApiResultJson(); | |||
// 終了条件: 戻り値が成功以外、か応答本体が1行 (ヘッダーのみ) の時。 | |||
if (($currentReturnCode !== Raku2Config::EXIT_SUCCESS) || (substr_count($response, "\n") <= 1)) break; | |||
@ | // 2回目からはヘッダー除去して書き込み。 | ||
$start = strpos($response, "\n") + 1; | |||
$flat = FILE_APPEND; | |||
if ($offset === 0) { | |||
$start = $flag = 0; | |||
$path = stream_get_meta_data($fp = tmpfile())['uri']; | |||
} | |||
file_put_contents($path, substr($response, $start), $flag); | |||
$offset += $limit; | |||
sleep(3); | |||
} | |||
for ($offset = 0; | |||
($currentReturnCode === Raku2Config::EXIT_SUCCESS) && (substr_count($response, "\n") > 1); | |||
(function() use (&$offset, $limit, $response) { | |||
// 2回目からはヘッダー除去して書き込み。 | |||
$start = strpos($response, "\n") + 1; | |||
$flag = FILE_APPEND; | |||
if ($offset === 0) { | |||
$start = $flag = 0; | |||
$path = stream_get_meta_data($fp = tmpfile())['uri']; | |||
} | |||
file_put_contents($path, substr($response, $start), $flag); | |||
$offset += $limit; | |||
sleep(3); | |||
})() | |||
) { | |||
$currentReturnCode = $service->sendRequest(Raku2Config::API_TYPE_CSV_EXPORT, Raku2Config::CONFIG_API_URL_MULTI_API, [ | |||
json_encode([ | |||
'dbSchemaId' => $table_info['dbSchemaId'], | |||
'offset' => $offset, | |||
'limit' => $limit, | |||
]) | |||
]); | |||
$response = $service->getApiResultJson(); | |||
} | |||
=== character === | |||
==== BOM ==== | |||
UTF-8のBOM | |||
\xef\xbb\xbf | |||
この文字を先頭につけるとUTF-8のBOMになる。 | |||
=== Convert === | |||
==== IP/CIDR ==== | |||
// JavaScript | |||
<nowiki> </nowiki> /** | |||
<nowiki> </nowiki> * サブネットマスクをIPアドレス形式 (x.x.x.x/255.255.255.0) からCIDR形式 (x.x.x.x/24) に変換する。 | |||
<nowiki> </nowiki> * @param {string} ipaddress - IPアドレス文字列 (x.x.x.x/x.x.x.x形式)。 | |||
<nowiki> </nowiki> */ | |||
<nowiki> </nowiki> toCIDR(ipaddress) { | |||
<nowiki> </nowiki> const [address, mask] = ipaddress.split('/') | |||
<nowiki> </nowiki> const segments = mask.split('.') | |||
<nowiki> </nowiki> const CIDR = segments | |||
<nowiki> </nowiki> .map((e) => Number(e).toString(2)) | |||
<nowiki> </nowiki> .join(<nowiki>''</nowiki>) | |||
<nowiki> </nowiki> .replace(/0*$/, <nowiki>''</nowiki>).length | |||
<nowiki> </nowiki> return address + '/' + CIDR | |||
<nowiki> </nowiki> }, | |||
<nowiki> </nowiki> /** | |||
<nowiki> </nowiki> * サブネットマスクのCIDR形式 (24) をIPアドレス形式 (255.255.255.0)に変換する。 | |||
<nowiki> </nowiki> * @param {number} cidr - ciderの数字。 | |||
<nowiki> </nowiki> * @return {string} x.x.x.x形式のIPアドレス文字列。 | |||
<nowiki> </nowiki> */ | |||
<nowiki> </nowiki> cidrToIp(cidr) { | |||
<nowiki> </nowiki> const digit = 32 | |||
<nowiki> </nowiki> const ip = ('1'.repeat(cidr) + '0'.repeat(digit)).substr(0, digit) | |||
<nowiki> </nowiki> return ip | |||
<nowiki> </nowiki> .match(/.{8}/g) | |||
<nowiki> </nowiki> .map((e) => parseInt(e, 2)) | |||
<nowiki> </nowiki> .join('.') | |||
<nowiki> </nowiki> }, | |||
=== Algorithm === | |||
==== 再帰処理 ==== | |||
https://chatgpt.com/c/673d9bfe-2414-800b-9922-f94be6dbe950 | |||
配列の配列、オブジェクトのオブジェクトなど、再帰的な構造はけっこう遭遇する。 | |||
再帰関数で実装するほかに、スタックで処理する方法がある。 | |||
再帰関数のほうが簡単に実装できるが、関数呼び出しのオーバーヘッドがある。ネスト10-100程度くらいなら問題ない。 | |||
パフォーマンスや再帰中の細かい制御が必要なら、スタックが有利。ただし、実装がやや複雑。 | |||
最初は再帰関数で実装して、後でボトルネックになったらスタックというのも手。 | |||
https://chatgpt.com/c/6745228f-8b20-800b-8a41-bdaece8c03f5 | |||
再帰関数とスタックの他に、JSONなどの文字列にシリアライズして、文字列処理で対応するという手もある。 | |||
JSONPath/XPathなどの方法もあるが、基本的には外部ライブラリーが必要。 | |||
シンプルなケース以外は、再帰関数で処理したほうが結局シンプルな感じがする。 | |||
=== Other === | |||
==== コメントの著者名 ==== | |||
https://chatgpt.com/c/67469d8d-7e64-800b-b82d-8c74f4e13c08 | |||
GNU socialのソースコードのコメントに著者名が大量にあった鬱陶しい。 | |||
大規模プロジェクトになると、編集者が膨大になる。VCSに任せて、本文には記載しなくていいと思う。 | |||
git blameで行単位で編集者が分かる。 | |||
==== 確率処理 ==== | |||
https://chatgpt.com/share/68145e5c-9d14-800b-9cca-1cd9e46e2dd6 | |||
ある確率で処理をしたり、しなかったりしたいことがある。 | |||
$chance = 30; // 30%の確率 | |||
if (mt_rand(1, 100) <= $chance) { | |||
// 30%の確率でここに入る | |||
echo "当たり!"; | |||
} else { | |||
// 70%の確率でこっちに入る | |||
echo "はずれ..."; | |||
} | |||
乱数を作成して、それで確率値の超過判定で表現できる。 | |||
=== Architecture === | |||
==== About ==== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_d762a384-9703-4539-b8e7-022bc680d88f | |||
* MVC | |||
* MVVM | |||
* クリーンアーキテクチャー | |||
このあたりが有名。MVCが一番無難。MVCでは厳しいような大規模になったら、他を検討する価値がある感じ。 | |||
==== Clean Architecture ==== | |||
クリーンアーキテクチャー。最近よく聞く設計手法。 | |||
* [https://zenn.dev/muno/articles/introduce-clean-architecture クリーンアーキテクチャに入門する] | |||
* https://chatgpt.com/share/6870b175-d394-800b-a885-b41600d128cd | |||
「[https://blog.cleancoder.com/uncle-bob/2011/11/22/Clean-Architecture.html Clean Coder Blog]」で2011-11-22にRobert C. Martinによって提唱さえたアーキテクチャー。ソフトウェアの開発・展開・運用・保守を簡単にして、プログラマーの生産性の最大化が目的。 | |||
多くのアーキテクチャーでは、関心を分離して、異なる役割や責務を分離して、変更の影響を最小限にしている。これの実現に、ソフトウェアをレイヤー (層) に分けている。クリーンアーキテクチャーは、このアイデアの1個のガイドラインになっている。 | |||
中心にビジネスルールがあって、玉ねぎのように、中心から外に向かって、層構造になっている。 | |||
# エンティティ: ビジネスロジック (ドメイン層)。外部の影響 (FWの更新など) に影響を受けない。 | |||
# ユースケース: アプリのビジネスルール。interface adapterから受け取ったデータをもとに、entityのビジネスロジックを組み合わせて、アプリ特有のロジックを実現。 | |||
# Interface Adapter (Controller/Gateway/Presenter): 外部システムと内部システムのデータを変換する。例えば、コントローラーはリクエストをUsecaseが利用できる形式に変換 (4->2) し、プレゼンターはユースケースの出力を外部システムが理解できる形式に変換 (2->4) する。 | |||
# Framework/Driver (DB/Device/Web Framework/UI/外部Web API): WebアプリケーションFW、DBなど。外部エージェントとの通信処理。基本的にはライブラリーやFWを使う。 | |||
基本はこれだけ。 | |||
既存のMVC型アプリをクリーンアーキテクチャーにする場合の対応。 | |||
* Controller: Interface adapter | |||
* Model: Entity (domain/repository interface) | |||
* View: Framework | |||
たまねぎの層構造の表現は、ディレクトリーの親子関係で表現できるときれいなんだけど。層ごとでグループ化したり、継承したりする場合に、ディレクトリーを作れなくて困る。大規模になるならなおさら。 | |||
中小規模や、うまく分割してきれいにまとめられるならあり。 | |||
一般的には、機能を最上位において、その下で4の層をディレクトリーで配置するというのが多い模様。 | |||
src/ | |||
└── Article/ | |||
├── Domain/ | |||
├── Application/ | |||
├── Interface/ | |||
└── Infrastructure/ | |||
=== | ==== SSR+CSR ==== | ||
=== | ===== About ===== | ||
https://chatgpt.com/c/6747e923-6174-800b-8816-dd741721de45 | |||
バックエンドとフロントエンドの分離の話。 | |||
SPA (Single Page Application) やJAMStackの影響で、バックエンドはデータを返すだけで、画面描画はフロントエンドが全部する (CSR) というのが最近の流行。 | |||
SSR (Server Side Rendering) とCSR (Client Side Rendering) の違い。フロントエンドの高度化や分業などが理由とのこと。 | |||
SSRの利点。 | |||
* SEO | |||
* 初期表示。 | |||
* 匿名。 | |||
SSRの課題。 | |||
* サーバー負荷: データとHTML作成を同時に行うから。 | |||
* 分散困難: | |||
キャッシュの活用がポイントになるとのこと。 | |||
===== リダイレクト ===== | |||
https://chatgpt.com/share/6886c2c2-b5cc-800b-8e03-e301c22d5eff | |||
CSRでやる場合、最終的にCSRの成果物をstaticに生成して、それをサーバー側のpublicに配置する感じになる。 | |||
npm run generateの生成先をpublicに直接してもOKだと思う。いや、これは既存のindex.phpとかが消えるのでまずい。シンボリックリンクにするとか。 | |||
1台でフロントとサーバーの両方を扱う場合、/apiなどサーバーリクエストに使うURLはindex.phpに、それ以外はindex.htmlなどにするようなリダイレクト設定が必要。 | |||
以下のようなイメージ。 | |||
<IfModule mod_rewrite.c> | |||
<IfModule mod_negotiation.c> | |||
Options -MultiViews -Indexes | |||
</IfModule> | |||
RewriteEngine On | |||
# Handle Authorization Header | |||
RewriteCond %{HTTP:Authorization} . | |||
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}] | |||
# Send Requests To Front Controller... | |||
RewriteCond %{REQUEST_URI} ^/(api|sanctum)(/|$) | |||
RewriteRule ^ index.php [L] | |||
# Nuxtのビルド済み静的ファイル (_nuxt/) は除外 | |||
RewriteCond %{REQUEST_URI} ^/_nuxt/ | |||
RewriteRule ^ - [L] | |||
# RewriteCond %{REQUEST_FILENAME} !-f [OR] | |||
RewriteCond %{REQUEST_FILENAME} !-d | |||
RewriteRule ^ - [L] | |||
RewriteRule ^ index.html [L] | |||
</IfModule> | |||
=== Naming === | |||
==== Code ==== | |||
===== camelCase ===== | |||
https://gnusocial.jp/notice/7694551 | |||
!it 命名規則のキャメルケース。これ英語前提です。関数名に英語以外を使うと破綻します。 | |||
getキーバリュー()みたいな関数の定義。日本語ですると境界がわからなくなるので、getキー_バリューみたいにアンダーバーで区切ったほうが分かりやすい。なるほど… | |||
===== getMyVariable() vs myVariable() ===== | |||
* [https://stackoverflow.com/questions/3532828/php-methods-getmyvariable-vs-myvariable naming conventions - PHP methods: getMyVariable() vs myVariable() - Stack Overflow] | |||
* [https://stackoverflow.com/questions/139427/which-coding-convention-to-follow-for-php Which Coding convention to follow for PHP? - Stack Overflow] | |||
getterとsetterの命名規則。 | |||
getVar()にするか、Var()にするか。C++だと後者のパターンがあったりする。getを省略できるので、省スペースになる。 | |||
ただ、コード補完で探しやすさがちょっと変わる。getを前置したほうがわかりやすいか。 | |||
==== | ===== namePrefixed() vs prefixedName() ===== | ||
https://chatgpt.com/c/673bd358-3dc8-800b-8ec9-d745cc0eba85 | |||
名詞+修飾語 (形容詞) の場合のメソッドの命名規則。name+修飾語が複数ある場合name+修飾語がいい。オブジェクト指向でnameをオブジェクトとして扱う形に近い。name.methodみたいな。 | |||
例えば、nameMax、nameMinのような場合は後ろのほうが都合がいい。ただ、こういう場合はそもそもnameをオブジェクトにしてname.max()、name.min()にしたほうがいいという説がある。 | |||
そうではないならば、getPrefixedName()などが自然。getQueryString()など。StringQueryではない。 | |||
PHPでは以下のような命名規則が好まれる。 | |||
* 動詞+修飾対象=getPrefixedName/isPrefixed() | |||
* 修飾対象+状態/修飾語=prefixdName | |||
getPrefixedNameがいいか。後置修飾にしたいならば、そもそもオブジェクト+メソッドにすることを検討する。 | |||
===== map ===== | |||
連想配列とかハッシュ、オブジェクトなどでキーバリュー形式のデータ構造を扱うことがある。そういう変数の命名規則。 | |||
<code>map_[key]_[value]</code> のような形式にすると、キーとバリューが何を意味するか分かってわかりやすい。 | |||
https://chatgpt.com/c/67ca84e0-9018-800b-9674-035ae9f4bbaf | |||
* [key]_[value]_map | |||
* [key]_to_[value] | |||
上記のどちらかがいいだろう。toがkey_valueの区切りが明示的でいいかもしれない。 | |||
=== | ===== array/foreach ===== | ||
* [https://wiki.senooken.jp/PHP#Name_2 PHP - senooken JP Wiki] | |||
[https:// | * https://chatgpt.com/c/6747aee4-ab64-800b-88d7-940a5c4201bf | ||
foreach系のfor文ではキーとバリューを変数に格納して反復する。ファイルや配列に対して行うことが多い。 | |||
foreach (table as $row => $line) | |||
その際の変数名は、上記のように$row/$lineにすると、行番号と行の値がはっきりしてわかりやすい。 | |||
いいえ。これは問題がある。ネストした場合などに命名規則を維持できない。 | |||
* 配列、コレクション類: 複数形があるなら複数形。困ったらListの接尾辞。 | |||
* 反復時。キーバリュー形式の場合、単数形_key/_value。valueだけの場合、単数形。また、_valueは単数形でもいいかもしれない。 | |||
==== | 上記の命名規則だとわかりやすい。 | ||
$rows = [[]]; | |||
foreach ($rows as $row_key => $row_value) { | |||
foreach ($row_value as $column_key => $column_value) {} | |||
} | |||
foreach ($row_list as $row_key => $row) { | |||
foreach ($row as $column_key => $column) { | |||
} | |||
} | |||
foreach ($rows as $row_index => $row_value) { | |||
foreach ($row_value as $column_index => $column_value) { | |||
} | |||
} | |||
value部分に単数形を使うと、検索時にkey部分もヒットして、作業しにくいかもしれない。基本はkey/valueの接尾辞がよいと感じる。 | |||
もっというなら、接尾辞の文字数が揃うので、keyよりindexのほうがよいかもしれない。ただ、indexは添え字の数字の意味合いが強いので、やっぱりkey/valueでいいか。 | |||
===== Function argument order ===== | |||
関数の引数は入力、変更、出力の順番にする。理由はこの順番で使うから。<blockquote><nowiki>https://social.senooken.jp/notice/67270</nowiki> | |||
うーん。今晩は,CODE COMPLETEでC言語の関数の引数の順番を調べたりしていて,勉強時間がないな… | |||
int func(入力,変更,出力) | |||
この順番。理由は,この順番で使うから。 | |||
memcpyとかは例外が多い。 | |||
= | x = bの語順からきているからとの憶測がある。 | ||
<nowiki>https://okwave.jp/qa/q4202225.html</nowiki></blockquote> | |||
===== get/fetch ===== | |||
https://chatgpt.com/c/67bd1a05-d3a0-800b-88d8-f4f47b995560 | |||
* fetch=外部から取得する意味。DBや外部Web APIから取得する場合にfetchがいい。 | |||
* get=手元から取得する意味。プロパティーなど内部から取得する場合。 | |||
===== list/data ===== | |||
fetchList/fetchDataのどちらがいいか? | |||
* list=配列。必ず配列。 | |||
* data=全部。配列以外にnullや単一データがあるならこちら。 | |||
基本はfetchListでいいと思う。 | |||
==== | ===== Order ===== | ||
https://chatgpt.com/c/67ca7edf-f92c-800b-8174-9706bfba3ff3 | |||
関数実行の順番が大事なときと、そうでないときがある。区別し難い。 | |||
順序を明示したい場合、メソッドチェーンを使うのが確実。 | |||
他に、前の関数の結果、戻り値を後続の引数に渡すなら、それも悪くない。 | |||
===== privateの先頭_ ===== | |||
privateなメソッド、プロパティーで、先頭に_をつけることがある。 | |||
https://chatgpt.com/c/67da92b1-1650-800b-b347-f16f76fd549a | |||
privateのアクセス権、可視性の機能があるなら、それを使えばいいので、_は不要。むしろないほうがいいらしい。PHPのPSR-12では禁止されている。 | |||
「[https://www.php-fig.org/psr/psr-12/ PSR-12: Extended Coding Style - PHP-FIG]」<blockquote>Property names MUST NOT be prefixed with a single underscore to indicate protected or private visibility. That is, an underscore prefix explicitly has no meaning.</blockquote>Pythonのように、言語的にないなら、やむを得ない。 | |||
PHPは昔privateがなかったので、そういう古いコードとの一貫性の維持が目的なら、先頭_もあり。 | |||
===== 配列の要素数 ===== | |||
https://chatgpt.com/c/67ecd6ff-b06c-800b-8f44-cfeb9c5768bb | |||
配列の要素数、長さを変数に格納して使うことがけっこうある。その際の変数名。 | |||
オブジェクト指向に従うなら、配列名_size/countの接尾辞がいい。 | |||
C++のvectorなどのコンテナーだと.size()でとれる。変数に格納せずにsizeでいい。 | |||
変数にあえて代入するならば、配列名_sizeが自然。 | |||
= | ただ、PHPだと、countで要素数を取得する。その都合で、_countがよい。 | ||
item_list = []; | |||
item_list_size | |||
item_list_count | |||
==== | ===== 例外前提関数 ===== | ||
https://grok.com/share/c2hhcmQtMw%3D%3D_359ae291-e39d-42cd-9a8f-e6453b388993 | |||
APIのパラメーターチェックとかで、チェック関数を何個も書くなら、例外を投げる形にして、それを補足する形が楽になる。 | |||
$result = $this->locationCheck($mbrcode, $latitude, $longitude, $ostype); | |||
if ($result['status']) | |||
return ['message' => $result['message'], 'status' => $result['status']]; | |||
$result = $this->isCheckedIn($mbrcode); | |||
if ($result['status']) | |||
return ['message' => $result['message'], 'status' => $result['status']]; | |||
$store = $this->isStoreNearby($latitude, $longitude); | |||
if (!$store['status']) | |||
return ['message' => $result['message'], 'status' => self::STATUS_STORE_NOT_FOUND]; | |||
$result = $this->addPoint($mbrcode, $ostype, $store['pattern'], $store['shpcode'], $store['point']); | |||
if (!$result['status']) | |||
return ['message' => $result['message'], 'status' => self::STATUS_ERROR]; | |||
try { | |||
$this->locationCheck($mbrcode, $latitude, $longitude, $ostype); | |||
$this->isCheckedIn($mbrcode); | |||
$store = $this->isStoreNearby($latitude, $longitude); | |||
$this->addPoint($mbrcode, $ostype, $store['pattern'], $store['shpcode'], $store['point']); | |||
} catch (Exception $e) { | |||
return ['status' => $e->getCode(), 'message' => $e->getMessage(), 'point' => 0]; | |||
} | |||
関数の戻り値を都度if文でチェックする必要がなくなってスマートになる。 | |||
そういう、例外前提関数の名前。isXXXとかにするとboolを期待する。 | |||
assertXXXにするとわかりやすい。assertは例外を投げたり、中断するイメージがあるから。 | |||
validateだとどっちもありえるからわかりにくい。 | |||
===== 条件のbool変数・関数化 ===== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_dabd40dd-e42b-44be-931c-b1cc18425c5d | |||
if文の条件式の内容は、複雑になるなら基本的に変数・関数に括り出して適切な名前を付けたほうがいい。 | |||
コメントで記載することもできるが、コメントが古くなるリスクがある。 | |||
==== | ===== 拡張子、サンプルファイル ===== | ||
https://grok.com/share/c2hhcmQtMw%3D%3D_d3c100c1-f1be-47c4-8f36-1710af04a2c1 | |||
app/config.php.sampleのように、アプリのデフォルト設定をファイル末尾に追記する形でファイルを用意することがある。これの是非。 | |||
基本は、app/config.sample.phpのように、拡張子は意味のあるものにする。 | |||
Webアプリの公開ディレクトリーなどで、誤動作を抑止するなら、拡張子を明示的に分ける意味がある。 | |||
が、他のアプリや構文強調などはファイル拡張子で判断するので、普通は困る。 | |||
=== Other === | |||
=== | ==== Document ==== | ||
設計文書を作成する際、MS Word系で作るのが無難。 | |||
画面系の設計の場合、1画面に入りきらないかもしれないが、部分ごとに分割画像にして、1ページに画像と説明を併記する形にして、縦に長い文書にするほうが管理しやすいと思う。 | |||
ExcelやPowerpointで1枚丸ごとにしてい気持ちもあるが。だったら、Figmaとかそういうデザインツールとか、Inkscape/LibreOfficeDrawとかだろうか。 | |||
ただ、やっぱり目次とか欲しいからMS Word系がいいと思う。 | |||
== | ==== Atomic Design ==== | ||
* [https://atomicdesign.bradfrost.com/chapter-2/ Atomic Design Methodology | Atomic Design by Brad Frost] | |||
* [https://zenn.dev/bizlink/articles/b5c8985af8407a Atomic Designの概念] | |||
最近のUIのコンポーネントの組み方。UIコンポーネントを粒度に分けて、ディレクトリー分けして流用するという考え方。 | |||
* atoms: 原子。これ以上分割不能な最小単位。input/label/buttonなど。 | |||
* molecules: 分子。atomsを組み合わせたり、atomsに多少修正したもの。入力フォーム、ナビゲーション、カードなど。 | |||
* organisms: 有機体。分子+アルファ。入力フォーム+ヘッダーなど。複数の分子。 | |||
* templates: テンプレート。複数の有機体。ヘッダー、メイン、フッターなど。 | |||
* pages: ページ。テンプレートを使用したページ。 | |||
==== インターフェイスと抽象クラス ==== | |||
* | * [https://qiita.com/nogson/items/e6575d6617f854ed6e25 PHPでインターフェイスと抽象クラスを使う #PHP - Qiita] | ||
* | * https://chatgpt.com/c/6796dd25-2380-800b-9d87-847c60e6f546 | ||
オブジェクト指向でよく登場するインターフェイス、抽象クラス、クラスの違い。 | |||
* インターフェイスは、クラスに複数実装できるが、抽象クラスは1つしか継承できない。→不特定のクラスで、共通のメソッドを定義したい場合。 | |||
* インターフェイスは、実装のあるメソッドを持つことができないが、抽象クラスは、実装のあるメソッドを持つことができる。→抽象クラスは、複数のクラスの、共通処理の中に、一部違う処理が入る場合、プロパティーが必要な場合などに使用する。 | |||
インターフェイス | |||
* メソッド宣言のみ。 | |||
* static/constの場合に限定して、メソッド定義、定数もOK。 | |||
* 多重継承可能。 | |||
* tagのイメージ。 | |||
例えば、複数のクラスで共通の処理がある場合、その共通部分をInterfaceにして、それを継承すると良い。その部分だけ取り出して流用できる。 | |||
例えば、[Animal<-Duck] のような関係がある時、Duckは空も飛べるし、泳ぐこともできるとしたら、飛べることと泳げることの機能はAnimalの中でも対応がわかれる。こういうところをInterfaceにしておくと、振る舞いを統合できる。 | |||
抽象クラスは一部共通にしたい場合に使う。Interfaceは指定機能を全部共通。 | |||
ベースは抽象クラス、クラスにしておいて、複数クラスで共通にしたい場合interfaceで定義するときれいに実装できる。 | |||
==== Config class ==== | |||
* [https://softwareengineering.stackexchange.com/questions/197272/best-practice-for-creating-a-global-config-class-used-by-numerous-components c++ - Best practice for creating a 'global' config class used by numerous components - Software Engineering Stack Exchange] | |||
* [https://softwareengineering.stackexchange.com/questions/386212/best-way-to-provide-configuration-parameters-for-objects-far-away-from-the-start Best way to provide configuration parameters for objects far away from the starting point - Software Engineering Stack Exchange] | |||
* [https://softwareengineering.stackexchange.com/questions/114924/config-class-struct-pattern-or-anti-pattern-alternatives?newreg=b46538fc865f46b08f6bf06d317925bf design - Config Class/Struct: Pattern or Anti-Pattern? Alternatives? - Software Engineering Stack Exchange] | |||
* [https://softwareengineering.stackexchange.com/questions/441985/best-practice-design-pattern-for-working-with-a-config-file json - Best practice/design pattern for working with a config file - Software Engineering Stack Exchange] | |||
アプリケーションの設定を管理するクラスの設計方法。いくつか方法があり、議論がある。「[https://softwareengineering.stackexchange.com/questions/386212/best-way-to-provide-configuration-parameters-for-objects-far-away-from-the-start Best way to provide configuration parameters for objects far away from the starting point - Software Engineering Stack Exchange]」で特によく議論されている。 | |||
# シングルトン/グローバル変数: ただし、テストなどで並列アクセスが必要な場合に困ることがあるらしい。 | |||
# DI/設定クラス引数: これがよく支持されている。テストしやすいなど。グローバル変数への参照を渡すようなイメージ。ただし、依存性の伝播のように、上から下に設定を渡す際に、関係ない大量の設定を渡すことがあったりする。 | |||
2のDIが最近の主流。引数で値渡し相当にすれば、並列アクセス時も無影響。伝播の問題は設計の問題。 | |||
メソッドをmain関数で呼び出すことを想定して、必要なものだけ渡るようにして、余計なものは削除する。上位・下位の関係を明確にすれば、渡すだけのパラメーターを排除できる。 | |||
==== do-while/if ==== | |||
複雑なif文と相性がいい。 | |||
for whileの無限ループで最後にbreakでも同じか | |||
do { | |||
if (true) break; | |||
} while(false); | |||
if文が複雑な場合、do-whileで囲んで、breakでスキップできる。gotoに近い。 | |||
==== GoF ==== | |||
[https://ja.wikipedia.org/wiki/%E3%83%87%E3%82%B6%E3%82%A4%E3%83%B3%E3%83%91%E3%82%BF%E3%83%BC%E3%83%B3_(%E3%82%BD%E3%83%95%E3%83%88%E3%82%A6%E3%82%A7%E3%82%A2) デザインパターン (ソフトウェア) - Wikipedia] | |||
基本的に、具象クラスを使わずに、インターフェイスや抽象クラスを使ってインスタンスを生成するというのが、共通する基本パターン。 | |||
これにより、いろんなケースに同じコードで対応できる。 | |||
23パターンある。23パターンのうち16パターンは言語サポートで単純化か除去できる。 | |||
* 生成5個 | |||
*# Abstract Factory | |||
*# Builder | |||
*# Factory Method | |||
*# Prototype | |||
*# Singleton | |||
* 構造7個 | |||
*# Adapter | |||
*# Bridge | |||
*# Composite | |||
*# Decorator | |||
*# Facade | |||
*# Flyweight | |||
*# Proxy | |||
* 振る舞い11個 | |||
*# Chain of Responsibility | |||
*# Command | |||
*# Interpreter | |||
*# Iterator | |||
*# Mediator | |||
*# Memento | |||
*# Observer | |||
*# State | |||
*# Strategy | |||
*# Template Method | |||
*# Visitor | |||
特に頻出パターン | |||
* | * Strategy | ||
* | * Observer | ||
* | * Decorator | ||
* | * Factory Method | ||
* Adapter | |||
* Singleton | |||
このほかに、アーキテクチャーごとに、パターンがある。 | |||
* | * Repository: DDD、クリーンアーキテクチャー。Adapterパターン内部で使っているデータ保持用の役割。 | ||
=== | ===== Factory Methodパターン ===== | ||
[https://blog.ecbeing.tech/entry/2021/01/20/114000 なぜあんなに難しい?Factory Methodパターン - ecbeing labs(イーシービーイング・ラボ)] | |||
コンストラクターの代わりに、インスタンスを生成 (工場=factory) となるメソッドを使うから、FactoryMethodパターン。 | |||
引数の内容に応じて、異なるクラスを作成する。 | |||
import java.util.ArrayList; | |||
import java.util.Arrays; | |||
import java.util.Collections; | |||
import java.util.Comparator; | |||
import java.util.List; | |||
// Creatorに相当する | |||
abstract class ListPrinter { | |||
// anOperationに相当する | |||
public void printList(List<String> list) { | |||
} | |||
// factoryMethodに相当する | |||
protected abstract Comparator<String> createComparator(); | |||
} | |||
// ConcreteCreatorに相当する | |||
class DictionaryOrderListPrinter extends ListPrinter { | |||
@Override | |||
protected Comparator<String> createComparator() { | |||
return new DictionaryOrderComparator(); | |||
} | |||
} | |||
// ConcreteCreatorに相当する | |||
class LengthOrderListPrinter extends ListPrinter { | |||
@Override | |||
protected Comparator<String> createComparator() { | |||
return new LengthOrderComparator(); | |||
} | |||
} | |||
// メインクラス | |||
public class FactoryMethodSample { | |||
public static void main(String args[]) { | |||
List<String> list = Arrays.asList("いちご", "もも", "いちじく"); | |||
System.out.println("五十音順で表示:"); | |||
new DictionaryOrderListPrinter().printList(list); | |||
System.out.println("長さ順で表示:"); | |||
new LengthOrderListPrinter().printList(list); | |||
} | |||
} | |||
return new <Class> 的なことをするメソッドのパターン。 | |||
* オブジェクトの生成処理を1か所に集約できて、生成処理が複雑な場合 (前準備や引数が多い場合など) 使う側をシンプルにできる。 | |||
* 条件によって別の子クラスを返したり、キャッシュを使ったりできる。 | |||
ただ、Factory Methodパターンを採用すると、コード量が増えて複雑になる。 | |||
Factory MethodとAdapterを併用すると、OSごとやDBの違いを吸収することができる。 | |||
https://chatgpt.com/share/6876fa52-d850-800b-81f0-78bb0d44a7ba | |||
FactorySelectorみたいなクラスで、createAdapter的なので、違いを隠蔽して取得するとよさそう。 | |||
===== Adapterパターン ===== | |||
重要。FWやライブラリーを抽象化するパターン。 | |||
XxxAdapterというクラスを作って、特定のメソッド経由で、目的のクラスにアクセスする。 | |||
interface ProductPrice{ | |||
public int getPrice(); | |||
} | |||
class Product{ | |||
private int cost; | |||
public int getCost(){ | |||
return cost; | |||
} | |||
} | |||
class ProductAdapter extends Product implements ProductPrice{ | |||
public int getPrice(){ | |||
return this.getCost(); | |||
} | |||
} | |||
継承の他に、移譲 (Adapter内でのインスタンス生成) でも実現できる。DIと相性がいいかもしれない。 | |||
interface ProductPrice{ | |||
public int getPrice(); | |||
} | |||
class Product{ | |||
private int cost; | |||
public int getCost(){ | |||
return cost; | |||
} | |||
} | |||
class ProductAdapter implements ProductPrice{ | |||
private Product product = new Product(); | |||
public int getPrice(){ | |||
return product.getCost(); | |||
} | |||
} | |||
上記では、Product.getCost (製品価格) をProductAdapter.getPriceのメソッド名でアクセスする。既存のクラスを一切変更することなく、getPriceという別のメソッド名で、目的のメソッドにアクセスする。 | |||
例えば、Windows/Mac/Linuxのように、異なるOSでOSのバージョン番号を取得するような場合、Adapter経由でアクセスすれば、同じメソッド名で異なるOSのAPIにアクセスできる。FWやライブラリーのバリエーションの違いを吸収できる。 | |||
==== OOP ==== | |||
== | ===== 継承とtrait ===== | ||
https://chatgpt.com/c/67cea053-9f50-800b-b22f-67aea7ac0dfe | |||
apcとstaticのキャッシュクラスがあって、それとは別にビジネスロジックの共通化をしたい場合、いくつか方法がある。 | |||
# apc と static を統合した親クラスで trait を use し、子クラスで継承する | |||
# apc と static を子クラスで直接継承し、trait を use | |||
# 継承(extends)ではなく、キャッシュクラスを別のクラスとして利用する という考え方です。 | |||
===== 依存注入(DI)・継承・trait の使い分けまとめ ===== | |||
https://chatgpt.com/c/67cea053-9f50-800b-b22f-67aea7ac0dfe | |||
キャッシュやORMのような、切り替え可能な機能の場合、DIで実装してプロパティーに格納して使うのが使いやすい。DIはテストのしやすさに勝る。 | |||
継承は親子関係が明確な場合。 | |||
===== コンストラクターのアクセス権 ===== | |||
基本はpublicだが、privateとprotectedを指定する場面がある。デザインパターンと関係している。 | |||
https://chatgpt.com/c/67fdac9a-2fac-800b-91bf-460c10fd72f5 | |||
* protected: 継承先のみ。ベースクラスや抽象クラスで使用する。ベースクラスや抽象クラスは継承を前提とするから、直接インスタンス生成してほしくないから。ファクトリーパターンと組み合わせる。 | |||
* private: クラス内部のみ。シングルトン・ユーティリティー (静的ファクトリーメソッド専用クラス) 系クラスで、インスタンスを作って欲しくない、1個だけのように、インスタンスの生成数を制限したい場合。 | |||
=== | ===== 例外の扱い ===== | ||
https://chatgpt.com/share/68118e39-40d0-800b-9bd8-43da8908bfcd | |||
DBアクセス系のメソッドは例外を基本的に出す。 | |||
DBアクセス系メソッドを使って、特定のデータを取得するようなメソッドを使った場合に、例外をどこで処理すべきかという話。 | |||
現代的なフレームワークだと、アプリのエントリーポイント (index.php) などにtry-catchが1個あって、そこで自分で処理しなかったらデフォルトの例外処理で処理する形になる。 | |||
なお、try-catchは並列実行、マルチスレッド環境では問題があったりする。 | |||
throwにコストがかかる。だから、頻繁に失敗するような処理は、try-catch (throw) を使わない形で実装したほうがいい。リアルタイム性や超ハイパフォーマンスが必要なところとか。 | |||
PHPはリクエスト単位で、プロセス・スレッド起動する設計になっている。ApacheやFPMがそういう動作になっているから。だから、マルチスレッドは考えなくていい。並列実行は、別リクエストみたいな扱い。 | |||
APIに複数アクセスする場合、curl_multiで1プロセスでうまくやる方法があるらしい。 | |||
===== 関数戻値と例外 ===== | |||
https://chatgpt.com/share/6833c48c-ce58-800b-a4d7-f389d15167e9 | |||
関数が失敗した場合に、戻り値nullで返すか、戻り値false相当で返すか、例外で返すかという議論。 | |||
例えば、配列を返すようなメソッドで、処理失敗時に空配列ではなくて、nullを返して失敗を表すか、あるいは例外で返すべきかという議論。 | |||
[ | nullの代わりにデータ型でboolになる値を返す (配列なら[]、数値系なら0、文字列なら<nowiki>''</nowiki>)。 | ||
{| class="wikitable" | |||
|+ | |||
!項目 | |||
!利点 | |||
!欠点 | |||
|- | |||
|ブール | |||
|型が同じなので扱いやすい。 | |||
|失敗と結果を厳密に区別したいときに、できないことがある。 | |||
|- | |||
|null | |||
|失敗と結果を厳密に区別可能。 | |||
|使う側で常にnullチェック必要。 | |||
|- | |||
|例外 | |||
|型を統一でき、失敗も区別できる。 | |||
|エントリーポイントにtry/catchがないとtry/catch地獄。 | |||
|} | |||
基本は型は同じで、どうしても処理失敗の区別が必要なら、例外にする。これにするとシンプルで融通がきく。 | |||
例外にする内容。 | |||
* 処理続行が不能な場合 (DBアクセス失敗)。 | |||
* ビジネスロジックで意図的に続行不能にしたい場合 (想定外の頻繁アクセス、保安対策?)。 | |||
* 期待と異なる場合 (1件取得できないといけないのにできないとき)。 | |||
===== DI ===== | |||
https://chatgpt.com/share/682e8fd6-376c-800b-a01e-faa832b0fd07 | |||
Dependency Injection。主にテストしやすさを向上させるための手法。 | |||
クラスやメソッド内部で、他のクラスを使う場合、コンストラクターや、メソッドで該当クラスを受け取って、プロパティーや変数として参照する。クラス (依存性) を外部から渡す (注入) すること。 | |||
こうすることで、該当メソッドのテスト時に、中で使用する外部クラスを外部から置換できる。これにより、テスト対象メソッドの処理だけをテストできる。 | |||
DIの注入方法で2通りある。 | |||
* コンストラクターDI: public/protectedメソッド向き。一般的にDIという場合これ。 | |||
* メソッドDI: privateメソッド向き。特定メソッドだけでしか使わない場合、あまり使わない場合。 | |||
使用する外部クラスが複数ある場合、DIでその分指定する。あまりにも数が多い場合、DTOやデリゲートなど複数クラスを保有するクラスを作って、それを引数に渡す。あるいは、依存クラスが多すぎる場合、設計に問題がある。適切に分割した方がいい | |||
なお、メソッドDIにする場合、DI対象は引数の先頭の方に指定する。必須で省略不能だから。 | |||
==== DB ==== | |||
[http://blog.tojiru.net/article/277021312.html PDOの真の力を開放する - PHPでデータベースを扱う(3): Architect Note] | |||
DBアクセスのモデル化。行をクラスとする (entity/エンティティークラス) と扱いやすい模様。 | |||
getterを作ったり、データの妥当性のチェックなどもできる。 | |||
select/insert/などはmapperでクラスとDB列名を対応付けて処理する。自前で実装する場合はこういうつくりがいいらしい。 | |||
データベース関係のデザインパターンがいくつかある。 | |||
* Active Record | |||
* Data Mapper | |||
=== | ===== Active Record pattern ===== | ||
* [https://ja.wikipedia.org/wiki/Active_Record Active Record - Wikipedia] | |||
* [https://www.techscore.com/tech/Ruby/Rails/other/designpattern/ デザインパターンから見たActive Record | TECHSCORE(テックスコア)] | |||
テーブルレコードに対応するクラスを用意して、そのクラス自体にDB操作もさせる。 | |||
シンプルだが、複雑な操作が苦手。 | |||
エンティティーがテーブルと密接なため、例えばテーブル構造が変わった場合に大量に修正必要。 | |||
Ruby on Rails/Laravel+Eloquentなどで採用。 | |||
[ | ===== Data Mapper pattern ===== | ||
[https://gihyo.jp/dev/serial/01/ruby/0014 第14回 DataMapperの使い方 | gihyo.jp] | |||
テーブルのレコードをクラスにするのはARと共通。 | |||
ただし、DB操作用のクラスを用意してそちらでDB操作する。 | |||
その都合、1テーブルに2クラス必要。 | |||
User/UserMapperのような対応関係。 | |||
2クラス必要だが、テーブル構造が変わった場合でも基本はMapperで吸収できる。 | |||
=== | ===== JOIN ===== | ||
Active RecordもData MapperもJOIN時の扱いが一番重要。単一エンティティーしか扱わないならどちらも同じ。 | |||
基本はエンティティーのプロパティーに持たせる感じ。 | |||
<blockquote>datamapperパターンでjoinする場合、エンティティーの扱いはどうなるの? | |||
`DataMapper`パターンで`JOIN`を行う場合、エンティティの扱いは設計次第ですが、いくつかの注意点があります。`DataMapper`パターンは、データベースのテーブルとエンティティの間にマッピングを行い、エンティティはドメインロジックを持ち、データベースアクセスの責務を持たないことが特徴です。そのため、`JOIN`の処理をどの層で行うかを慎重に設計する必要があります。 | |||
以下、`JOIN`を行う際のエンティティの扱いと実装方法について解説します。 | |||
### 1. マッパークラスでの`JOIN`実装 | |||
`JOIN`を伴う複雑なクエリが必要な場合、マッパーが直接`JOIN`を使って複数テーブルを組み合わせた結果を取得し、それを複数のエンティティとしてマッピングする方法があります。例えば、ユーザーと注文を持つシステムで、ユーザーとその注文を一緒に取得したい場合、`UserMapper`で`JOIN`を行い、結果セットを`User`と`Order`エンティティに分割してマッピングします。 | |||
```python | |||
class UserMapper: | |||
def find_user_with_orders(self, user_id): | |||
sql = """ | |||
SELECT * FROM users | |||
= | JOIN orders ON users.id = orders.user_id | ||
WHERE users.id = %s | |||
""" | |||
results = self.db.execute(sql, (user_id,)) | |||
= | user = User(results[0]['user_id'], results[0]['user_name']) | ||
orders = [Order(row['order_id'], row['product_name'], user) for row in results] | |||
= | user.orders = orders | ||
return user | |||
``` | |||
この方法では、1つのSQLクエリで必要なデータをすべて取得し、エンティティのプロパティにそれぞれのデータを設定します。 | |||
### 2. リポジトリでの集約 | |||
`JOIN`を使わず、各エンティティを個別に取得した後、リポジトリが集約の役割を担う方法もあります。リポジトリが各エンティティの`Mapper`を呼び出し、必要なエンティティ同士を関連付けることで`JOIN`を再現します。例えば、まず`UserMapper`でユーザー情報を取得し、次に`OrderMapper`で該当ユーザーの注文を取得してエンティティ間で関連付けます。 | |||
```python | |||
class UserRepository: | |||
def __init__(self, user_mapper, order_mapper): | |||
self.user_mapper = user_mapper | |||
= | self.order_mapper = order_mapper | ||
def get_user_with_orders(self, user_id): | |||
user = self.user_mapper.find(user_id) | |||
= | orders = self.order_mapper.find_by_user_id(user_id) | ||
user.orders = orders | |||
return user | |||
```</blockquote>UserテーブルとOrderテーブルがあって、あるユーザーの注文一覧を取得したい場合を考える。 | |||
結局、user.ordersみたいな感じで、エンティティーに外部テーブルのレコードを配列で持たせるつくりになる。 | |||
クロス集計する場合は、users[0].orderみたいな感じ。メインのエンティティーのプロパティーに持たせる。フラットじゃないのでちょっと気持ち悪い。が、まあ構造としてこうなるのは順当。 | |||
方法として、1回のSQLで取得するか、それぞれのエンティティーを取得してマージするか。1回のSQLでやったほうが当然いい。 | |||
==== Other ==== | |||
===== 1対1-多対多 ===== | |||
プログラミング言語でデータの関連付けをすることがある。 | |||
1対1の場合、配列、連想配列のキーバリュー形式のデータがぴったり。 | |||
多対多の場合。これも配列。二次元配列で基本は0要素目など。 | |||
[ | $array[][] | ||
===== 1対多 ===== | |||
https://chatgpt.com/share/683faf08-f374-800b-ac40-b96b427d7365 | |||
例えば、DBからデータを取得した場合など、1行のデータに複数列あって、列を特定したい場合、連想配列で、バリューをさらに連想配列にするのが普通。ただ、1:1ならただの連想配列でよかったのが、連想配列の配列になるのがイマイチ。 | |||
['row1' => ['col1' => 'value1', 'col2' => 'value2']] | |||
いくつか方法がある。 | |||
= | # ネスト連想配列。無難。 | ||
# 連想配列の代わりにオブジェクト。これができるならこれが素直。 | |||
# 連想配列の代わりにリスト。ただし、列の意味が分かりにくい。foreach ($map as $interface => [$property, $defaultClass]) | |||
# 値部分を意味のある文字列で使うところで分割とか。 | |||
手短にしたいなら、3のリストになるかも。 | |||
==== レガシープロジェクトの立て直し ==== | |||
https://chatgpt.com/c/67481a93-adc0-800b-81c4-20d763133002 | |||
1. 現状分析 | |||
(1) ソフトウェアの動作確認 | |||
現在の環境でアプリケーションを動作させる。 | |||
どの部分が機能していて、どこが問題かを確認する。 | |||
必要であればエラーログを確認する。 | |||
(2) 依存関係の調査 | |||
アプリケーションのライブラリやフレームワークのバージョンを調査。 | |||
サポートが終了しているもの、互換性が失われたものを特定。 | |||
(3) コードベースの状態評価 | |||
コードの品質 (可読性、設計、テストカバレッジ) を確認。 | |||
セキュリティリスクを特定する (例えば、脆弱性が放置されていないか)。 | |||
2. 計画立案 | |||
(1) ゴール設定 | |||
具体的な目標を設定 (例: パフォーマンス改善、保守性向上、セキュリティ強化)。 | |||
(2) 優先順位の決定 | |||
どの機能を維持し、どの機能を削除または置き換えるか決定。 | |||
ユーザーに直接影響を与える部分を優先。 | |||
(3) リスク評価とバックアップ | |||
修正に伴うリスクを評価し、現行システムのバックアップを取得。 | |||
3. 環境整備 | |||
(1) 開発環境のモダナイズ | |||
ローカル環境やコンテナ (Docker) を用意してテストを容易にする。 | |||
CI/CD パイプラインの整備。 | |||
(2) 依存関係の更新 | |||
サポートされていないライブラリやフレームワークをアップグレードまたは置き換える。 | |||
(3) セキュリティの確保 | |||
古いOSSの脆弱性を修正。 | |||
HTTPSの導入、認証強化、インプット検証など。 | |||
4. コードのモダナイズ | |||
(1) リファクタリング | |||
レガシーコードをよりモダンで可読性の高いコードに変換。 | |||
デザインパターンを適用して保守性を向上。 | |||
(2) テストの追加 | |||
ユニットテスト、統合テストを導入。 | |||
既存の機能が壊れないことを確認するための自動化されたテスト。 | |||
(3) フロントエンド/バックエンドの分離 | |||
必要に応じてモノリシック構造を分離し、モダンなアーキテクチャ (SPA、Microservices など) に移行。 | |||
5. 機能拡張とデプロイ | |||
(1) 新しい機能の追加 | |||
必要に応じて、現代のニーズに合った新機能を実装。 | |||
(2) 運用環境でのテスト | |||
新しい環境で徹底的にテストし、問題がないことを確認。 | |||
(3) 本番環境にデプロイ | |||
ロールバック計画を準備しつつ、安全にデプロイ。 | |||
6. 継続的改善 | |||
(1) モニタリングの導入 | |||
エラーログやパフォーマンスを監視し、迅速に対応できる仕組みを導入。 | |||
(2) 定期的なアップデート | |||
フレームワークやライブラリを継続的に更新し、レガシー化を防ぐ。 | |||
(3) コミュニティへの貢献 | |||
OSSとしての性質を活かし、変更内容をコミュニティに共有することでフィードバックを得る。 | |||
このプロセスを通じて、安定した動作を保ちながら徐々に近代化することが可能です。特に、「現状分析」と「環境整備」をしっかり行うことで、後続の作業がスムーズになります。 | |||
== AI == | |||
=== 対話AI === | |||
==== About ==== | |||
===== List ===== | |||
[https://notepm.jp/blog/24168 【2024年版】対話型AIサービスおすすめ11選を徹底比較!チャットボットとの違い・メリット・課題・選び方なども紹介 - NotePM] | |||
= | いろいろある。 | ||
{| class="wikitable" | |||
|+ | |||
!Name | |||
! | |||
! | |||
! | |||
|- | |||
|Bing | |||
| | |||
| | |||
| | |||
|- | |||
|Perplexity AI | |||
| | |||
| | |||
| | |||
|- | |||
|ChatGPT | |||
| | |||
| | |||
| | |||
|- | |||
|Google Gemini | |||
| | |||
| | |||
| | |||
|} | |||
===== 書きかけ送信 ===== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_ca8dab5f-1012-4dd4-841f-7340186071d7 | |||
書きかけの状態で誤送信することがある。 | |||
元の質問を編集するのではなく、続きに「これが正しいです」とか書いて送信すると、AIが認知して対応してくれるらしい。 | |||
編集すると、ややこしくなる。 | |||
==== Grok ==== | |||
===== Xアカウント ===== | |||
https://x.com/i/grok/share/oeybkVEqzC4NNpH8whCdM7pl7 | |||
grok.comのgrokはスタンドアローン。x.com/i/grokはXアカウントを考慮する。後、xのほうは制限が厳しめ。 | |||
grok.comにXアカウントでログインできる。その場合、多少Xアカウントを考慮したりする。が、設定でオフにもできる。 | |||
Xアカウントでログインでいい気がする。 | |||
===== 感想 ===== | |||
https://grok.com/share/c2hhcmQtMw%3D%3D_abb58ded-75b5-470e-a6c3-586a53904071 | |||
==== ChatGPT ==== | |||
===== Plan ===== | |||
[https://openai.com/chatgpt/ ChatGPT | OpenAI] | |||
Free/Plusの2のプランがある。 | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |||
! | ! | ||
! | !Free | ||
! | !Plus | ||
|- | |- | ||
| | |金額 [USD/月] | ||
|0 | |||
| | |20 | ||
| | |||
|- | |- | ||
| | |機能 | ||
|基本 | |||
|アーリーアクセス | |||
| | |||
|- | |- | ||
| | |エンジン | ||
| | |GPT-4o mini | ||
| | |GPT-4/GPT-4o/GPT-4o mini | ||
|- | |- | ||
| | |制限 | ||
| | | - | ||
| | |GPT-4oの5倍以上のメッセージ送信 | ||
|- | |- | ||
| | |その他 | ||
| - | |||
|データ分析、ファイルアップロード、ビジョン、Webブラウジング | |||
| | |||
| | |||
|- | |- | ||
| | |画像生成 | ||
| - | |||
| | |DALL-E | ||
|} | |} | ||
送信可能なメッセージ数、エンジン、画像生成などが大きな違いだろう。 | |||
===== Account ===== | |||
公式サイトにアカウントの意味の説明がない。しかたないので、ChatGPTに質問。<blockquote>ChatGPTに会員登録する意味は何ですか? | |||
ChatGPTに会員登録する主な利点はいくつかあります。 | |||
1. **パーソナライズされた体験**: 登録すると、あなたの好みや過去のやり取りに基づいて、よりカスタマイズされた応答が得られます。 | |||
2. **履歴の管理**: 過去のチャット履歴を保存し、いつでも見返すことができるため、情報の確認が簡単になります。 | |||
* | 3. **新機能へのアクセス**: 登録ユーザーは新しい機能やアップデートを優先的に利用できる場合があります。 | ||
* | 4. **プレミアム機能**: 一部のサービスでは、会員登録をすることで、より高度な機能やサポートが提供されることがあります。 | ||
5. **セキュリティとプライバシー**: アカウントを持つことで、データの管理やプライバシーの設定をより細かく調整できます。 | |||
興味があれば、ぜひ登録を検討してみてください!他に質問があればお知らせください。</blockquote>自分の過去の質問の履歴を見れるだけでも便利かも。 | |||
==== | ===== 方法 ===== | ||
====== 質問の分割 ====== | |||
https://chatgpt.com/c/673bdc0d-e0e0-800b-a22b-4fa19e64476c | |||
Q. chatgptで質問するとき、連続して質問すると、同じURLで複数の質問が表示される。リロードして質問を分けたほうがいいのか? | |||
A. どちらでも問題ない。が、質問が関連しているなら同じチャットで継続したほうがいい。直前の質問も文脈を考慮できる。完全に話が異なるなら分けたほうが後で整理したり、URLを共有したときにわかりやすい。 | |||
=== | ===== 感想 ===== | ||
==== | ====== 2024-11-14 Thu ====== | ||
https://gnusocial.jp/notice/7806505<blockquote>[[/gnusocial.jp/group/32/id|!it]] [[/gnusocial.jp/group/28/id|!ai]] 業務でPHPの開発作業をしていて、ChatGPTを使いだして便利に感じています。検索エンジンの代わりに使っています。 | |||
例えば、「laravel eloquentでリレーション先のテーブルの主キー名の取得方法は?」と質問します。 | |||
[[/chatgpt.com/c/67354314-fbdc-800b-a4e4-65f96d1a8fb2|https://chatgpt.com/c/67354314-fbdc-800b-a4e4-65f96d1a8fb2]] | |||
[ | |||
getRelatedというややマニアックなメソッドを教えてくれます[eloquent getrelated] で検索してもなかなかたどり着けないです。 | |||
こういう検索エンジンで検索しにくい質問で便利だなと思います。 | |||
検索エンジンで検索すると、的外れな情報も大量にヒットします。対話AIはそのごみの混ざった検索結果を分析した結果をコンパクトに返してくれます。対話AI使わなくても、検索エンジンで時間かければわかりますが、大幅に時間短縮できます。 | |||
大量の凡人健常者が取り組んだ方法論として決まりきったものは、記憶の問題、ただの神経衰弱です。こういうのを検索エンジンの改良版としてAIに任せるのはいい使い方だと思います。 | |||
個人的に、ただの知識、事実は重要度高くないと思いますが、一般社会では評価する側の頭が悪いので、これが重宝されます。 | |||
同僚や先輩に聞くより対話AIのほうがよほど頭いいです。話すことないです。聞くほうが時間の無駄なので。凡人はどんどん要らなくなります。 | |||
一方、私みたいなキチガイのデータは少ないので、検索エンジンやAIに聞いても出てこないです。世界で自分だけのオリジナルに専念するのがたぶんいいです。</blockquote> | |||
==== | ====== 2024-11-19 Tue ====== | ||
https://gnusocial.jp/notice/7867350<blockquote>[[/gnusocial.jp/group/28/id|!ai]] ChatGPTが検索エンジンの改良版としてやっぱり便利。さっきこういう質問しました。 | |||
phpのメソッド名で、英単語の修飾語は前と後ろどちらがいい?例えば、namePrefixed()とprefixedName()のどちらがいい? [[/chatgpt.com/c/673bd358-3dc8-800b-8ec9-d745cc0eba85|https://chatgpt.com/c/673bd358-3dc8-800b-8ec9-d745cc0eba85]] | |||
[https:// | |||
私はこのレベルの細かい疑問がすぐ浮かぶのです。これを人間にきくと、頓珍漢な回答だったり、そもそも回答してもらえないし、何ならこういう質問した私がなぜかキチガイ扱いされて、微妙な雰囲気になって、質問できなくなって、ストレスが溜まって、居づらくなって早期退職になるんです。意味不明です。ただの質問にお気持ちの配慮とか面倒なので。 | |||
この間、 [[/misskey-square.net/users/9g2o6eycu3|@yuriha]] に突っ込まれた件も、たぶん対話AIとお互い会話したほうが有意義だったんじゃないかとすら思います。相手も私に突っ込む前に対話AIと会話したほうが自分の主張の自己矛盾、頓珍漢さに気づけたんじゃないかとすら思えます。私が突っ込んでまーた私がキチガイ扱いされるのも回避されます。対話AIからの客観的な指摘なら、同じ内容であっても、キチガイの私が言うより納得しやすいでしょう?同じ内容なら対話AIのほうが凡人健常者にとっては、信じ込みやすいでしょ? | |||
対話AIだとお気持ちの配慮いらないし、当たり前ですけど、キチガイ扱いされることもないので、快適です。元々対話AIには懐疑的でしたが、どちらかというと私のようなキチガイが凡人健常者の知識を拝借するためにあるような印象を持ちます。 | |||
検索エンジンでも調べることはできますが、めちゃくちゃ時間かかるんです。自分で複数の意見をみつけて、頭の中で比較検討して整理するので。これを一瞬でやってくれるのが楽。途中のデータ整理、目視は単純作業に近いのです。他のことに頭使えます。 | |||
もはや技術とか、ただの暗記の神経衰弱は別にいらないです。一般企業の上長とか、士業のように、単純知識でマウント取るタイプの仕事はこれで確かに駆逐されます。どうせ対話AIのほうが賢いのだから。知識量で勝てるわけないです。全世界の情報の集積結果なんだから。 | |||
凡人健常者の知識を拝借して、世界でだれにも真似できないキチガイ部分に専念できます。GNU socialの開発もこれでいけると思います。</blockquote> | |||
=== AI Coding === | |||
[https://techblog.lycorp.co.jp/ja/20250626a AIコーディング:「Vibe Coding」からプロフェッショナルへ] | |||
[https://zenn.dev/yoshiko/articles/my-vibe-coding 個人的 Vibe Coding のやりかた] | |||
雰囲気だけを伝えて、AIにアプリ開発を任せる手法。一切自分でコーディングしなくてもアプリ開発可能。 | |||
== Shell == | |||
=== 2 Shell Command Language === | |||
==== 2.9 Shell Commands ==== | |||
===== 2.9.2 Pipelines ===== | |||
[https://pubs.opengroup.org/onlinepubs/9699919799.orig/utilities/V3_chap02.html#tag_18_09_02 Shell Command Language] | |||
pipelineは|で区切られた1以上のコマンド群のこと。標準出力を次のコマンドに接続する。 | |||
パイプラインの書式は以下となる。 | |||
[!] <command1> [ | <command2> ...] | |||
予約語の!がなければ、最後のコマンドの終了ステータスがpipeline全体のステータスになる。!があれば、ステータスの否定になる。つまり、0なら1、0超過なら0になる。 | |||
パイプラインだが、ifやtest以外のどこでも使える。 | |||
ただし、対話シェルだと!は履歴置換になることがあるので注意する。 | |||
===== 2.9.4 Compound Commands ===== | |||
[https://pubs.opengroup.org/onlinepubs/9699919799.2008edition/utilities/V3_chap02.html#tag_18_09_04 Shell Command Language] | |||
====== Case Conditional Construct ====== | |||
case word in | |||
[(]pattern1) compound-list;; | |||
[[(]pattern[ | pattern] ... ) compound-list;;] ... | |||
[[(]pattern[ | pattern] ... ) compound-list] | |||
esac | |||
* 未マッチで終了ステータス0。 | |||
* pattern部分: シェル展開が有効。他はglob。 | |||
* |でOR検索相当。 | |||
* 最後のパターンの;;は省略可能。if文のようにも使える。 | |||
* 全パターンの捕捉は最後に*。空でもマッチする。?は最低1文字必要。 | |||
BREでは未対応な|のORマッチに対応しているのが最大の特徴。文法なのでコマンドを実行せず早い。grepを使わずにできるだけこちらを使ったほうがいい。 | |||
=== ワイルドカード === | |||
ワイルドカードで.始まりのファイルをマッチさせたい。 | |||
以下ならマッチするが、ブレース展開 (brace expansion) はPOSIX shでは使えなかった気がする。 | |||
echo {.*,*} | |||
=== | === BOM === | ||
[https:// | [https://stackoverflow.com/questions/3127436/adding-bom-to-utf-8-files unicode - Adding BOM to UTF-8 files - Stack Overflow] | ||
ExcelでUTF-8ファイルを開けるように、UTF-8のBOMをファイルにつけたい。 | |||
printf '\xEF\xBB\xBF' > with_bom.txt | |||
上記コードでBOMを最初に書き込んで、後は追記する。 | |||
=== Command === | |||
==== awk ==== | |||
[https://pubs.opengroup.org/onlinepubs/9699919799.2008edition/ The Open Group Base Specifications Issue 7] | |||
=== | ===== 変数 ===== | ||
==== | ====== 特別 ====== | ||
* NF: 列数。列の全表示などで使う基本的で重要な変数。 | |||
* NR: 行番号。 | |||
====== スコープ ====== | |||
[http://www.fukano.jp/study_of_awk/basic/basic08.htm 変数のスコープ] | |||
関数の仮引数のみ、ローカル変数扱いで、それ以外はグローバル変数。 | |||
===== 文/statement ===== | |||
* actions | |||
** if/else | |||
** while/do...while/for | |||
** break/continue | |||
** delete | |||
** next | |||
** exit | |||
* output | |||
** print | |||
** printf | |||
===== 関数 ===== | |||
====== 組込関数 ====== | |||
* Arithmetic | |||
** atan2 | |||
** cos | |||
** sin | |||
** exp | |||
** log | |||
** sqrt | |||
** int | |||
** rand | |||
** srand | |||
* String | |||
** gsub | |||
** index | |||
** length | |||
** match | |||
** split | |||
** sprintf | |||
** sub | |||
** substr | |||
** tolower | |||
** toupper | |||
* I/O | |||
** close | |||
** getline | |||
** system | |||
print/printfは関数ではなく、statement/文扱い。 | |||
===== ヘッダー出力、列別最大長さ出力。 ===== | |||
<nowiki>awk -F, '{if(NR==1) print $0} {for(i=1; i<=NF; ++i){if (line[i] < length($i)) line[i] = length($i)}} END {for (i=1; i<=NF; ++i) {printf line[i]","}}' data/101542.csv</nowiki> | |||
===== CSV ===== | |||
[https://qiita.com/ko1nksm/items/19407c1c53cbbc50569a シェルスクリプトの実験のために作った POSIX 準拠 awk 実装の CSVパーサー (RFC4180対応) #ShellScript - Qiita]<syntaxhighlight lang="awk" line="1"> | |||
# csvparser.awk | |||
## Usage | |||
# awk -f csvparser.awk data.csv | |||
# CSV の論理的な一行毎に呼び出されるコールバック関数(サンプル) | |||
# row: 行番号(最初の行は1) len: フィールド数 fields: フィールドデータ | |||
function callback(row, len, fields, col, field) { | |||
for ( col = 1; col <= len; col++ ) { | |||
field = fields[col] | |||
gsub(/\\/, "&&", field) # \ は \\ にエスケープする | |||
gsub(/\n/, "\\n", field) # 改行は \n にエスケープする | |||
print row ":" col " " field | |||
} | |||
} | |||
BEGIN { row = max_idx = 0 } | |||
{ | |||
idx = 0 | |||
sub(/\r$/, "") | |||
while ($0 != "") { | |||
if (match($0, /^(["]([^"]|["]["])*["]|[^,"]*)(,|$)/)) { | |||
fields[++idx] = "" | |||
} else if (match($0, /^["]/)) { | |||
fields[++idx] = substr($0, 2) | |||
for (;;) { | |||
if (getline == 0) exit 1 | |||
sub(/\r$/, "") | |||
if (match($0, /^([^"]|["]["])*["](,|$)/)) break | |||
gsub(/["]["]/, "\"") | |||
fields[idx] = fields[idx] "\n" $0 | |||
} | |||
fields[idx] = fields[idx] "\n" | |||
} else { | |||
exit 1 | |||
} | |||
field = substr($0, RSTART, RLENGTH) | |||
$0 = substr($0, RSTART + RLENGTH) | |||
lastcomma = sub(/,$/, "", field) > 0 | |||
gsub(/^["]|["]$/, "", field) && gsub(/["]["]/, "\"", field) | |||
fields[idx] = fields[idx] field | |||
} | |||
if (lastcomma) fields[++idx] = "" | |||
while (idx < max_idx) delete fields[max_idx--] | |||
callback(++row, idx, fields) | |||
max_idx = idx | |||
} | |||
</syntaxhighlight>awkのCSVパーサー。先頭のBOMはあると認識できないので、tail -c +4でBOMを除外して使う。 | |||
tail -c +4 data/101543.csv | awk -f csvparser.awk | |||
==== xargs ==== | |||
===== About ===== | |||
[https://pubs.opengroup.org/onlinepubs/9699919799.orig/utilities/xargs.html xargs] | |||
xargsは引数リストを構築して、コマンドを呼び出すコマンド。 | |||
標準入力から受け取った行を任意の場所に引数として配置して、後続のコマンドを実行する。並行実行とかもできる。 | |||
* -I replstr: 行のプレースホルダー文字列を定義。 | |||
* -t: trace mode。実行したコマンドを標準エラー出力に出力する。 | |||
ls -A "$1" | sed -e 's/"/"\\""/g' -e 's/.*/"&"/' | | |||
xargs -E "" -I {} -t mv "$1"/{} "$2"/{} | |||
===== 複数コマンド実行 ===== | |||
https://chatgpt.com/share/6811d6e4-3cdc-800b-946c-305f03df396d | |||
echo "file1 file2 file3" | xargs -n 1 -I{} sh -c 'echo {}; ls -l {}' | |||
sh -cでshの引数の文字列として構築する。こうしないと、内部の;がパースされてうまく解約されない。 | |||
=== Other === | |||
==== patch ==== | |||
===== 文字化け ===== | |||
https://chatgpt.com/share/685cd841-d368-800b-b950-0afc82ea31de | |||
iconvで文字エンコーディングをパッチ適用先ファイルに合わせてから適用する。 | |||
iconv -f UTF-8 -t EUC-JP <<'EOF' | patch -p1 | |||
--- oldfile.php | |||
+++ newfile.php | |||
@@ -1,3 +1,4 @@ | |||
+// これは日本語コメントです | |||
EOF | |||
==== pager ==== | |||
===== lessのオプション ===== | |||
[https://qiita.com/takc923/items/598a68c4684114ffb102 lessのおすすめオプション #Linux - Qiita] | |||
export LESS="-iMR" | |||
* -i: 検索時に大文字小文字無視。 | |||
* -m: 表示中の%のステータスバーへの表示。 | |||
* -M: 表示中の行数・ファイル名などのステータスバーへの表示。 | |||
* -R: ANSI Color Escape Sequenceの解釈。 | |||
==== 破損リンク ==== | |||
https://chatgpt.com/c/68088168-ac54-800b-b78e-e28743b81011 | |||
find path/to/scan -type l ! -exec test -e {} \; -exec rm {} \; | |||
find path/to/scan -type l ! -exec test -e {} \; -print | |||
==== binary ==== | |||
[https://qiita.com/ko1nksm/items/dc8f247cdc5b7b58b736 POSIX準拠のシェルスクリプトでバイナリデータを扱う #Bash - Qiita] | |||
バイナリーデータの読込はodコマンド。なければhexdump。 | |||
書込はprintf。 | |||
head/tailの-cはPOSIXで使えたか? | |||
==== root ==== | |||
===== リダイレクト出力 ===== | |||
[https://blog.shaba.dev/posts/redirect-with-sudo sudo権限でリダイレクト処理を行ってファイルに書き込む方法] | |||
リダイレクトはログインユーザーの権限でなされるらしく、root権限のある場所にファイル出力できない。 | |||
teeコマンドでやる。 | |||
pwd | sudo tee out.dat | |||
teeコマンド実行する側でsudoが必要。 | |||
==== ログインシェルの確認 ==== | |||
[https://docs.oracle.com/cd/E19683-01/816-3946/customize-89075/index.html 第 10 章 動作環境のカスタマイズ (Solaris ユーザ] | |||
ログインシェルはGUIログインでも内部的にある。ログインシェルが読みこむprofileファイルなどは、ログイン時に、1回だけ実行したい処理の記述場所として最適。 | |||
SHELL環境変数にログインシェルのパスが入っている。 | |||
echo $SHELL | |||
/bin/bash | |||
==== OSの判別 ==== | |||
OSTYPE環境変数に値があるのでこれで判別する。 | |||
例えば以下の値が入っている。 | |||
linux-gnu | |||
darwin23 | |||
これらを検知して判定する。 | |||
case $OSTYPE in | |||
linux*) echo 'linux';; | |||
darwin*) echo 'Mac';; | |||
esac | |||
==== Configure ==== | |||
===== profile ===== | |||
[https://blog1.mammb.com/entry/2019/12/01/090000 bash の初期化ファイル .profile, .bashrc, .bash_profile の使い分けと管理方針 - A Memorandum] | |||
# bash_profile | |||
## profile | |||
## bashrc | |||
環境変数など~/.profileに全部のシェルの共通設定を記述。 | |||
上記サイトではこういう方針でやっていた。 | |||
ログイン時に、bash_profileとかzprofileとかがなければ、デフォルトで.profileを読込むようになっている。 | |||
なので、.profile内で、実行シェルを変数で判定して、bashrcやzshrcを読み込むようにするといい。 | |||
上から下にする感じ。ubuntu 22.04のprofileがこういう作りになっている。 | |||
# if running bash, include .bashrc if it exists | |||
[ -n "$BASH_VERSION" ] && [ -f "$HOME/.bashrc" ] && . "$HOME/.bashrc" | |||
.profileはログイン時に1回だけ実行すればいいから。 | |||
===== rc ===== | |||
rc=run configuration. 実行設定。 | |||
シェルごとにいくつかの設定がある。 | |||
====== Bash ====== | |||
[https://manpages.ubuntu.com/manpages/focal/en/man1/bash.1.html Ubuntu Manpage: bash - GNU Bourne-Again SHell] | |||
--loginオプションの指定がある場合や、ログイン対話シェルとして呼び出されるかどうかで変わる。、 | |||
ログイン対話シェルの場合 (SSHも含む?)。 | |||
* /etc/profile があれば実行。 | |||
* ~/.bash_profile ~/.bash_login ~/.profile をこの順番で探して、最初に見つけたファイルを実行して終わる。 | |||
* シェル終了時か、非対話ログインシェルの場合、exitコマンド実行時に、~/.bash_logoutをあれば実行。 | |||
--noprofileオプションを指定した場合、上記の読み込みはしない。 | |||
非ログイン対話シェルの場合。 | |||
* /et/bash.bashrc ~/.bashrcがあればそれぞれ実行。 | |||
--norcの指定で上記も読み込まない。--rcfileで/etc/bash.bashrcと~/.bashrcの代わりのrcファイルを指定できる。 | |||
非対話シェルの場合、BASH_ENV環境変数を展開して、そのファイルを読み込む。 | |||
if [ -n "$BASH_ENV" ]; then . "$BASH_ENV"; fi | |||
~/.profileをスクリプト実行時にも読み込みたい場合、bash_profileでこの環境変数を設定しておくとよいかも。 | |||
== cmd.exe == | |||
=== Control block === | |||
==== for ==== | |||
あくまでコマンド。 | |||
===== nest ===== | |||
* [https://chicagopile1-75.hatenablog.com/entry/2018/05/23/143502 バッチファイルで2重ループ - ハムスターに飼われる院生のブログ] | |||
* [https://web.archive.org/web/20230602041631/https://jj-blues.com/cms/wantto-useloop/ web.archive.org/web/20230602041631/https://jj-blues.com/cms/wantto-useloop/] | |||
ネストはできない。二重ループしたければ、関数にしてそれを呼び出す。 | |||
=== bitsadmin === | |||
Windowsでのファイルダウンロードコマンド | |||
Windows 7以降ではbitsadminコマンドがあり、これがwget相当となる。 | |||
書式: | |||
bitsadmin /transfer <job name> <URL> <output path> | |||
<job name>と<output path>は必須なので注意する。 | |||
=== certutil === | |||
Windowsでのハッシュの確認に使える。 | |||
certutil -hashfile file | |||
SHA1 ハッシュ (対象 C:\moconavi\windows\Moconavi\ext\chromium\moconavium.exe): | |||
e0da85b04b6970ac1f0c33db7a9ad607fdbd44eb | |||
CertUtil: -hashfile コマンドは正常に完了しました。 | |||
=== rlogin.cmd === | |||
コマンドキーの送信を自動化できる? | |||
rem rlogin.cmd | |||
@Echo off | |||
Set SERVER=192.168.0.0 | |||
Set USERNAME= | |||
Set PASSWORD= | |||
Cmdkey /generic:TERMSRV/%SERVER% /user:%USERNAME% /pass:%PASSWORD% | |||
Start mstsc /v:%SERVER% | |||
Timeout 5 | |||
Cmdkey /delete:TERMSRV/%SERVER% | |||
=== 実行中プロセスのパスの確認 === | |||
出典: [https://superuser.com/questions/768984/show-exe-file-path-of-running-processes-on-the-command-line-in-windows Show EXE file path of running processes on the command-line in Windows - Super User]。 | |||
wmic process get ProcessID,ExecutablePath | |||
wmic process where "name='mysqld.exe'" get ProcessID, ExecutablePath | |||
wmic process where "name='mysqld.exe'" get ProcessID, ExecutablePath /FORMAT:LIST | |||
=== 簡易編集モード/挿入モード === | |||
* [https://softantenna.com/blog/windows-10-command-prompt-no-stop/ 【Tips】Windows 10のコマンドプロンプトが意図せず止まってしまう問題を回避する方法 | ソフトアンテナ] | |||
* [https://superuser.com/questions/419717/windows-command-prompt-freezing-randomly Windows command prompt freezing randomly - Super User] | |||
Windows 10のcmd.exeは [簡易編集モード] が有効になっており、コマンドプロンプトを左クリックすると、テキストの選択が始まる。テキスト選択中はコマンドの実行が止まる。長時間かかるコマンドの実行中に誤操作で止まると困るので、これは無効にしたほうがよい。 | |||
cmd.exeを起動-左上のアイコンをクリック-[規定値]/[プロパティ]-[オプション]-[□簡易編集モード] を選ぶ。 | |||
そのほか、 <code>git log</code> のような制御が移るコマンドを実行してしばらくすると、操作できなくなる。 | |||
[□挿入モード] にすると回避できる模様。 | |||
== Vim == | |||
=== vimdiff === | |||
[https://maku77.github.io/vim/file/vimdiff.html 2 つのファイルの差分を取る・マージする (vimdiff, vim -d) - まくまくVimノート] | |||
vimのdiff機能。ファイル同士の差分のチェック、マージで簡易的に使える。 | |||
==== diffモードで起動 ==== | |||
vim -d <file1> <file2> | |||
vimdiff <file1> <file2> | |||
==== 起動中のdiffモード ==== | |||
:diffs[plit] <file> " 上下分割 | |||
:vert[ical] diffs[plit] <file> " 左右分割 | |||
:diffthis " バッファー同士 | |||
==== 移動 ==== | |||
* [c=前の差分に移動。 | |||
* ]c=次の差分に移動。 | |||
==== マージ ==== | |||
* dp=diff put。自分の内容を片方に反映。 | |||
* do=diff obtain。自分の内容に片方を反映。 | |||
=== Other === | |||
==== Async ==== | |||
https:/github.com/skywind3000/asyncrun.vim | |||
asyncrun.vimは1個のバックグラウンド処理しか対応していない。 | |||
<nowiki>https://github.com/skywind3000/asyncrun.vim/issues/12</nowiki> | |||
vim-dispatchならいけるのか? | |||
==== Binary ==== | |||
[https://vim-jp.org/vim-users-jp/2010/03/21/Hack-133.html vim-jp » Hack #133: バイナリファイルを編集する] | |||
==== grep ==== | |||
非同期でgrepする方法。 | |||
<nowiki>https://superuser.com/questions/861783/how-to-run-a-grep-in-vim-asynchronously</nowiki> | |||
<nowiki>https://www.reddit.com/r/vim/comments/5ses2e/async_grep_in_vim_8/</nowiki> | |||
Vim 8の非同期APIはプラグイン用。 | |||
<nowiki>*</nowiki> <nowiki>https://github.com/mhinz/vim-grepper</nowiki> | |||
<nowiki>*</nowiki> <nowiki>https://github.com/skywind3000/asyncrun.vim</nowiki> | |||
<nowiki>*</nowiki> <nowiki>https://github.com/tpope/vim-dispatch</nowiki> | |||
<nowiki>https://wonderwall.hatenablog.com/entry/2017/10/09/210000</nowiki> | |||
asyncrun.vimでやるのがよさそう。 | |||
==== AnsiEsc ==== | |||
<nowiki>*</nowiki> https:/unix.stackexchange.com/questions/444226/how-to-make-vim-interpret-escaped-characters-as-colors | |||
<nowiki>*</nowiki> https:/superuser.com/questions/358409/how-can-i-tell-vim-to-show-ansi-escape-codes-properly | |||
本家は太字に対応していないのでこちらがいいかな。 | |||
- https:/github.com/powerman/vim-plugin-AnsiEsc | |||
ただし、こちらはgvimでクリック時にカーソル位置がずれる。 | |||
=== program === | |||
==== C ==== | |||
[https://daisuzu.hatenablog.com/entry/2012/05/06/204019 ワシのVimプラグインは百八式まであるぞ - daisuzu's notes] | |||
【C/C++】 | |||
87. a.vim | |||
C/C++のヘッダとソースを切り替えます。 | |||
88. c.vim | |||
C/C++のテンプレートやイディオムの入力をサポートしてくれます。 | |||
89. CCTree | |||
cscopeを使って関数のコールグラフを表示してくれます。 | |||
90. Source-Explorer-srcexpl.vim | |||
ソース解析ツール、Source InsightのVim版です。 | |||
91. trinity.vim | |||
taglist, srcexpl, nerdtreeを同時に起動して | |||
VimがIDE画面のような画面になります。 | |||
92. cscope-menu | |||
cscope用のメニューを表示してくれます。 | |||
93. gtags.vim | |||
gtagsを使ってファイルを開けます。 | |||
94. DoxygenToolkit.vim | |||
Doxygenコメントの入力をサポートしてくれます。 | |||
== Visual Studio Code == | |||
=== Keybind === | |||
==== 矩形選択 ==== | |||
Ref: [https://mitomito.hatenablog.jp/entry/2021/01/27/073000#:~:text=VS%20Code%E3%81%AE%E7%9F%A9%E5%BD%A2%E9%81%B8%E6%8A%9E%E3%81%A8%E7%9F%A9%E5%BD%A2%E8%B2%BC%E4%BB%98%E3%81%AE%E6%93%8D%E4%BD%9C%E6%96%B9%E6%B3%95%201%20%E3%83%9E%E3%82%A6%E3%82%B9%E3%81%A7%E6%93%8D%E4%BD%9C%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88%20shift%20%2B%20alt%20%2B,shift%20%2B%20alt%20%2B%20%E7%9F%A2%E5%8D%B0%E3%81%A7%E4%BB%BB%E6%84%8F%E3%81%AE%E7%AF%84%E5%9B%B2%E3%82%92%E9%81%B8%E6%8A%9E%E3%81%97%E3%80%81%20%28or%20%E5%88%87%E3%82%8A%E5%8F%96%E3%82%8A%29%E3%81%99%E3%82%8B%20 VS Codeの矩形選択と矩形貼付の操作方法 - mito’s blog]. | |||
* s-alt-クリック | |||
* c-s-alt-矢印 | |||
ジャンプ | |||
* 括弧ジャンプ: C-S-\ | |||
=== Config === | |||
==== Default terminal ==== | |||
Ref: [https://stackoverflow.com/questions/44435697/change-the-default-terminal-in-visual-studio-code bash - Change the default terminal in Visual Studio Code - Stack Overflow]. | |||
[F1]-[Terminal: Select Default Profile] | |||
=== cscope === | |||
cscope用のプラグインが何個かある。 | |||
* [https://marketplace.visualstudio.com/items?itemName=xulion.codescope scope4code - Visual Studio Marketplace] | |||
* [https://marketplace.visualstudio.com/items?itemName=SeungukShin.cscope-code cscope-code - Visual Studio Marketplace] | |||
scope4codeのほうがいろいろできそうだが、うまく動作しなかった。使い方がよくわからない。 | |||
cscope-codeはシンプルだが動作した。こちらを当分使うことにする。 | |||
Macの場合、control-. sのように、control-.の後に、controlを話してsを押すと発動する。カーソル下のシンボルしか使えない感じなのがネック。まあいい。 | |||
=== Vim === | |||
* [https://marketplace.visualstudio.com/items?itemName=vscodevim.vim Vim - Visual Studio Marketplace] | |||
VSCodedでVimのキー操作を使うためのプラグイン。これが一番人気。いや、Vimのエミューレーターは中途半端な感じだから使わないほうがいいかな。 | |||
=== Extension === | |||
CSS | |||
Tailwind CSS IntelliSense | |||
==== PHP ==== | |||
Laravel Blade Snippets | |||
===== PHP Intelephense ===== | |||
Ref: [https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client PHP Intelephense - Visual Studio Marketplace]. | |||
VSCodeのPHPの補完拡張として人気が高い。 | |||
====== Quick Start ====== | |||
設置後、しておくべき設定がある。 | |||
* Go to <code>Extensions</code>. | |||
* Search for <code>@builtin php</code> | |||
* Disable <code>PHP Language Features</code>. Leave <code>PHP Language Basics</code> enabled for syntax highlighting. | |||
VSCodeの [PHP Language Features] を無効にしておくとのこと。 | |||
後は、.php以外の拡張子でPHPファイルがあれば、関連付けを追加するとか。 | |||
"files.associations": { "*.module": "php" } | |||
====== Module ====== | |||
peclなどPHPの標準モジュールで一部認識できないものがある。 | |||
「[https://stackoverflow.com/questions/62258598/undefined-type-imagick-in-vscodes-intelephense php - Undefined type 'Imagick' in VSCode's intelephense - Stack Overflow]」にあるように、そういう場合は [Settings]-[Stubs] で追加するとよい。 | |||
====== Coding ====== | |||
Ref: [https://beyondjapan.com/blog/2020/02/intelephense-vscode-php/ VSCode で PHP 開発するならインテリセンス最強の intelephense を使おう | 株式会社ビヨンド]. | |||
intelephenseでコード補完を認識しやすい書き方というのがある。 | |||
まず、型をつけられるものはつける。<syntaxhighlight lang="php"> | |||
function superMethod() | |||
{ | |||
/** @var AwesomeService $awesomeService */ | |||
$awesomeService = $this->app->make(AwesomeService::class); | |||
$awesomeService->awesomeMethod(); | |||
} | |||
</syntaxhighlight>ローカル変数も型名を指定する。これをしないと、インスタンスでコード補完が効かない。 | |||
====== include Path ====== | |||
開発対象コードが、.envなどに記載の環境変数を前提として、動きになっていたりすることがある。そうなると、この環境変数を参照できないと、認識できない。 | |||
include Pathsに追加する。 | |||
他、.php以外の拡張子は基本的にinluce pathにあっても認識しない。"intelephense.files.associations":に拡張子を追加する。 | |||
=== Settings === | |||
==== Files: Insert Final Newlines ==== | |||
[https://devcoops.com/resolve-no-newline-at-end-of-file-github/ Resolve 'No newline at end of line' in GitHub | DevCoops] | |||
gitで以下の警告が表示される。 | |||
\ No newline at end of file | |||
デフォルトでファイル終端に改行を挿入しないから。設定がある。 | |||
Settings-Files: Insert Final Newline | |||
これをオンにすると、保存時に自動的にファイル末尾に改行を入れてくれる。設定しておくとよい。 | |||
=== Other === | |||
==== Remote ==== | |||
[https://www.mathkuro.com/vs-code/upload-and-download-remote-file/ 【WinSCPはもう不要?】VS Codeのダウンロード/アップロード機能が便利すぎる!! | マスクロドットコム] | |||
[https://code.visualstudio.com/docs/remote/remote-overview Visual Studio Code Remote Development] | |||
公式拡張機能のVS Code Remote Developmentを使うと、リモートファイルをVS Codeで開いて、ドラッグドロップでファイル送受信ができるらしい。 | |||
[https://qiita.com/c60evaporator/items/26ab9cfb9cd36facc8fd VSCodeのSSH接続機能で、RaspberryPi内のコードを編集してデバッグ #Python - Qiita] | |||
Remote Developmentをインストールすると、左サイドメニューに [Remote Explorer] のマークが追加される。これを選んで [REMOTE EXPLORER]-[Remotes (Tunnnels/SSH)]-[SSH]-[+]-メニューに [usrname@host] の形式で接続情報記入。 | |||
左サイドメニューの [SSH] の節に追加される。右の [Connect in New Window...] を選ぶ。 | |||
接続先マシンのPlatformをLinux/Windows/macOSから選ぶ。 | |||
==== Git ==== | |||
===== blame ===== | |||
行単位での最後の修正コミットの表示。標準であるが、デフォルト非表示になっている。 | |||
git.blame.editorDecoration.enabled: true | |||
これで有効になる。が、いちいち表示されるのがうざいので、デフォルトfalseでいいと思う。 | |||
== PhpStorm == | |||
=== Jump === | |||
* https://chatgpt.com/c/6799c4ec-7660-800b-ad5d-fbc37e16a1a5 | |||
* [https://www.jetbrains.com/help/phpstorm/navigating-through-the-source-code.html#go_to_implementation Source code navigation | PhpStorm Documentation] | |||
includeなどで参照しているファイルパスのファイルを開く方法がいくつかある。 | |||
* C-b | |||
* C-LButton | |||
* C-N/C-O でファイルを開いてファイルパスを貼り付け。 | |||
認識できないことがあるので3番目が汎用的。 | |||
=== Encoding === | |||
* [https://pleiades.io/help/phpstorm/encoding.html エンコード | PhpStorm ドキュメント] | |||
* [https://pleiades.io/help/phpstorm/settings-file-encodings.html ファイルエンコーディング | PhpStorm ドキュメント] | |||
パス単位で文字エンコーディングを設定可能。 | |||
[PhpStorm]-[Settings]-[Editor]-[File Encodings] から行う。 | |||
=== Scratch === | |||
[https://qiita.com/endam/items/cc2c4c2aee8d382acd9e 【New Year Calendar】君はPhpStormのScratch機能を知っているか #NewYearCalendar - Qiita] | |||
メモなどの一時ファイルの作成機能。 | |||
[File]-[New Scratch File] からファイル形式を選んで作る。困ったらMarkdownで良いだろう。 | |||
作成したScratchファイルは [Project]-[Scratches and Consoles]-[Scratches] に格納される。 | |||
=== 矩形選択 === | |||
[https://pleiades.io/help/phpstorm/multicursor.html#find-and-select-multiple-occurrences-of-a-string 複数のカーソルと選択範囲 | PhpStorm ドキュメント] | |||
方法がいくつかある。 | |||
* Cmd-Shift-8 | |||
* Option-Shift-Middle | |||
=== Git === | |||
==== Gitツールウィンドウ ==== | |||
C-9か左下のGitマークを選ぶとGitツールウィンドウの表示になる。ブランチとコミットログが表示される。ここから右クリックを使ってブランチ間の比較などができたりする。 | |||
==== ブランチ比較 ==== | |||
* [https://tech-blog.rakus.co.jp/entry/2017/09/14/112033 PhpStormで始めるGit生活 - RAKUS Developers Blog | ラクス エンジニアブログ] | |||
* [https://pleiades.io/help/phpstorm/manage-branches.html#compare_branches Git ブランチの管理 | PhpStorm ドキュメント] | |||
コードレビューなどでよく使うブランチ同士の比較。 | |||
まず現在ブランチを比較対象ブランチに変更しておく。 | |||
[Git]-[Branches]-比較対象ブランチ-[Compare with] | |||
これで上下に画面分割して、それぞれのブランチで固有のコミットログの一覧が表示される。派生元と派生先があるならば、片方が空になる。違うブランチ同士のマージ用に、こういう作りになっていると思われる。 | |||
差分ファイル一覧を見るには、右側の変更ファイルペーンでC-aを選ぶ。変更のある全ファイルのリストが表示される。 | |||
他に、Gitツールウィンドウを開いて、コミットログで右クリック-[Compare with Local]を選ぶとローカルと対象コミットとの比較になる。これがわかりやすい。 | |||
ただ、基本は現在ブランチか、現在のワーキングツリーとの比較になる。現在ブランチを変更しておくのが基本になる。そこだけ押さえておけば、まあなんとか使えそう。 | |||
==== 元ファイルオープン ==== | |||
差分ビューで差分チェック中に、シンボルや型定義などの確認で元ファイルを開きたいことがある。ジャンプ方法がある。 | |||
左上の [Jump to Source C-Down] の鉛筆マークを選ぶ。これでエディター側で元ファイルを開ける。 | |||
==== サブディレクトリー ==== | |||
* https://chatgpt.com/c/67a330c3-3a9c-800b-b40f-ee80d09f9ec0 | |||
* [https://pleiades.io/help/phpstorm/settings-version-control-directory-mappings.html ディレクトリマッピング | PhpStorm ドキュメント] | |||
PHPStormで親のGitリポジトリーの下に、子のGitリポジトリーのディレクトリーがある場合、親ディレクトリーのGitしか認識してくれない。 | |||
認識してくれる方法がある模様。 | |||
Gitのマルチリポジトリー機能を使うらしい。 | |||
[Settings]-[Version Control]-[Directory Mappings]-[+] | |||
以下を選択して [OK] を選ぶ。 | |||
* ◉Directory: Git子ディレクトリーのパス | |||
* VCS: Git | |||
これで対象ディレクトリーを右クリックでGitを選ぶと良い模様。 | |||
==== Blame ==== | |||
行番号のところを右クリック-[Annotate with Git Blame] で行単位の修正履歴を表示できる。 | |||
* Annotate Revision: 現在の変更コミットを表示。 | |||
* Annotate Previous Revision: 前回のコミットの表示。 | |||
過去の修正履歴の調査で役立つだろう。 | |||
==== 変更ファイル内の検索 ==== | |||
https://chatgpt.com/share/68300fe8-e1cc-800b-8640-66e7c6dc146d | |||
gitでブランチ比較時に、変更ファイル内限定でシンボル検索したいことがある。例えば、使用メソッドに引数追加時の他の場所での確認など。 | |||
若干の工夫が必要。まず、ブランチ比較を行う。 | |||
その後、ファイル一覧画面で、全ファイル選択。 | |||
[Edit]-[Find]-[Find in Files] | |||
=== Search === | |||
https://chatgpt.com/c/6798762a-2c2c-800b-8dab-4a7b8252fe7b | |||
[https://cuore.jp/tec-blog/phpstorm%E3%81%AE%E4%BE%BF%E5%88%A9%E3%82%B7%E3%83%A7%E3%83%BC%E3%83%88%E3%82%AB%E3%83%83%E3%83%88%E3%82%AD%E3%83%BC%EF%BD%9E%E6%A4%9C%E7%B4%A2%E7%B7%A8%EF%BD%9E/ PhpStormの便利ショートカットキー~検索編~] | |||
PHPStormでは検索がいくつかある。 | |||
ファイル名検索 | |||
* Mac以外=C-N | |||
* Mac=C-O | |||
スペース区切りでAND検索になる。パスを含めると、ディレクトリーも絞り込める。 | |||
Search Everywhere | |||
Shift2回押下。 | |||
* C-f: ファイルない検索。 | |||
* C-F: 全体検索。 | |||
=== Other === | |||
==== tsh経由のファイル転送 ==== | |||
===== About ===== | |||
ローカルパソコンでソースコードを修正して、ファイルアップロードでAWS VMに展開して動作確認するという想定で、PhpStormを設定する。 | |||
基本方針として、以下のコマンドによりteleport経由で転送できるので、これをPhpStormにも設定する。IPv4部分は踏み台の~/.ssh/configで設定することで任意の名前を指定可能。 | |||
<code>rsync -zare "tsh ssh -A <踏み台> ssh" ./test.file IPv4:~/</code> | |||
これを念頭にPhpStormを設定する。ただし、PhpStormからのログインのために、多段SSHの設定は必要。ファイル送受信時にtshを経由して監査ログは残るのでよしとする。 | |||
なお、単にファイルをコマンドで転送するだけなら、泥くさいが以下のようにtsh scpで2回実行する手もある。 | |||
<code>FR=test.file TO=/path/to/test.file tsh scp $FR <踏み台>:$TO; tsh ssh -At <踏み台> scp $TO <AWS>:$TO</code> | |||
===== Official ===== | |||
teleport経由のファイル転送の公式情報は以下。 | |||
* [https://goteleport.com/blog/teleport-files/ Teleport Files with SCP] | |||
* [https://goteleport.com/docs/connect-your-client/tsh/ Using the tsh Command Line Tool | Teleport Docs] | |||
* [https://goteleport.com/docs/enroll-resources/server-access/guides/jetbrains-sftp/ JetBrains SFTP | Teleport Docs] | |||
3番目の「JetBrains SFTP | Teleport Docs」がまさにこれに該当するのだが、説明の記述がわかりにくい。踏み台サーバーへのアクセスしかできないように見える。tsh configやssh_configを工夫すれば、うまくできるような気はする。 | |||
===== ssh_config ===== | |||
PhpStormのSSH configurationsのホスト名がスクリプトの引数に渡されるので、踏み台からAWSにsshでログインするホスト名やパソコンの~/.ssh/configのHostとの一致必要な点に注意する。 | |||
USERNAME= | |||
cat <<-EOT >~/.ssh/config | |||
Host dev-jg1 | |||
ForwardAgent yes | |||
User $USERNAME | |||
ServerAliveInterval 30 | |||
ProxyJump $USERNAME@<teleport-host>:3023 | |||
Host $USERNAME | |||
ForwardAgent yes | |||
ProxyJump dev-jg1:22 | |||
User $USERNAME | |||
Hostname %h.<host> | |||
ServerAliveInterval 30 | |||
Host * | |||
AddKeysToAgent yes | |||
PasswordAuthentication no | |||
User $USERNAME | |||
ForwardAgent yes | |||
ServerAliveInterval 30 | |||
IdentityFile ~/.ssh/id_ed25519 | |||
# for macOS | |||
UseKeychain yes | |||
===== rsync executable ===== | |||
rsyncで使用する (-eオプション)、以下の内容のシェルスクリプトを作成して実行権限を付与して任意の場所 (例: ~/project/tsh_ssh.sh) に配置する。 | |||
cd ~/project/ | |||
cat <<-'EOT' >tsh_ssh.sh | |||
tsh ssh -A <host> ssh $@ | |||
EOT | |||
chmod +x tsh_ssh.sh | |||
===== PhpStorm設定 ===== | |||
PhpStormで以下を設定する。 | |||
== | * [Tools]-[Deployment]-[Configuration] | ||
* [+]-[SFTP] | |||
* [Create New Server]-[New server name: 任意の名前]-[OK] | |||
* [Connection] タブを以下に設定。 | |||
*# Type=SFTP | |||
*# SSH configuration=以下を設定。 | |||
*## Host: <ホスト名> (~/.ssh/configと踏み台サーバーの~/.ssh/configのホスト名と同じにする) | |||
*## User name: ユーザー名 | |||
*## Port: 22 | |||
*## Authentication type: OpenSSH config and authentication agent | |||
*# Root path= | |||
*# [☑️Use Rsync for download/upload/sync] | |||
*# Rsync Settings=以下を設定。 | |||
*## Shell executable path=tsh_ssh.shのパス (例=~/project/tsh_ssh.sh) | |||
* [Mappings] タブを以下に設定。 | |||
*# Local path: ローカルパソコンのmonsterディレクトリー | |||
*# Deployment path: / | |||
*# Web path: / | |||
* [Settings]-[Build, Execution, Development]-[Development]-[Options]-[Upload changed files automatically to the default server]=[On explicit save action] | |||
*# ☑️Delete remote files when local are deleted | |||
以上で完了。後は同期したいファイルをPhpStormで開いて、右クリック-[Deployment]-[Upload to]/[Download from] でファイル転送できる。 | |||
[☑️Use Rsync for download/upload/sync] のチェックを外せば、rsyncを使わないファイル転送になる。 | |||
==== | ==== 保存時自動転送 ==== | ||
* | * Prefernce(⌘ + ,)から、Build, Execution, Deployment > Deployment > Option | ||
* | * Upload changed files automatically to default serverを設定 | ||
* | * Alwaysでもいいですが重いのでOn explicit save actionがおすすめです。⌘Sでサーバーにコードをsyncします。 | ||
[https:// | ==== Window ==== | ||
[https://pleiades.io/help/phpstorm/open-close-and-move-projects.html プロジェクトを開く、移動、閉じる | PhpStorm ドキュメント] | |||
ペーンを分離したり移動したりできる。 | |||
[ | ペーン右上[…]-[View Mode]-[Window] を選ぶと、別画面に分離できる。並列時に重宝する。 | ||
[https:// | ==== ディレクトリーの無視 ==== | ||
[https://pleiades.io/help/phpstorm/excluding-files-from-project.html 除外されたファイルとフォルダー | PhpStorm ドキュメント] | |||
[https:// | [https://dev.macha795.com/phpstorm-ignore-dir/ PhpStormでコーディングで使用しないディレクトリを除外してパフォーマンスを改善する | プロガジ.DEV] | ||
シンボリックリンクだったりして、同じファイルが違うパスで表示されることがあって困る。ディレクトリーを除外する。 | |||
右クリック-[Mark Directory as]-[Excluded] を選ぶ。 | |||
==== Bookmark ==== | |||
[https://pleiades.io/help/phpstorm/bookmarks.html#bookmark-files-folders ブックマーク | PhpStorm ドキュメント] | |||
よく参照するコードの行・ファイル・ディレクトリー、をブックマークに登録して、迅速にアクセスできる。 | |||
# 左端のプロジェクトツールウィンドウ (C-1) で対象項目を右クリック-[Bookmarks]-[Add Bookmark] | |||
# [View]-[Tool Windows]-[Bookmarks] を選ぶと、、サイドバーにBookmarkのボタンが表示される。 | |||
==== Web Browsers and Preview ==== | |||
[https://pleiades.io/help/phpstorm/settings-tools-web-browsers.html ウェブブラウザーとプレビュー | PhpStorm ドキュメント] | |||
PHPファイルの編集時に、右上にプレビューボタンが表示されて邪魔。以下の設定で非表示にできる。 | |||
[Cmd-,]-[Settings]-[Tools]-[Web Browsers and Preview]-[Show browser popup in the editor]-[▫️For HTML files] | |||
[https:// | ==== ファイル差分 ==== | ||
[https://pleiades.io/help/phpstorm/differences-viewer.html#diff-merge-viewer ファイルの差分ビューアー | PhpStorm ドキュメント] | |||
ファイル差分の閲覧機能がある。 | |||
右クリック-[Compare with Clipboard] | |||
これが手っ取り早い。 | |||
==== PEARの認識 ==== | |||
1 pear config-showでphp_dir (=/usr/share/php/) を確認する。 | |||
2 このディレクトリーをローカルマシンに保存する (~/projectなど任意の場所)。既存プロジェクトの外に配置した方が都合良いだろう。 | |||
3 PHPStormの[Settings]-[PHP]-[include Path] で2で保存したディレクトリーを指定する。 | |||
==== .bashrc ==== | |||
[https://stackoverflow.com/questions/36592226/bashrc-not-sourced-on-intellij-ideas-terminal bash - .bashrc not sourced on Intellij IDEA's terminal - Stack Overflow] | |||
いくつかの理由で、IntelliJは標準ではBashを対話モードで起動しない。だから.bashrcを読み込まない。 | |||
ただし、これは設定で変更可能。 | |||
[Settings]-[Tools]-[Terminal]-[Shell path] に-iを追加する。だめなら、--loginとか。 | |||
[https:// | ==== 終端スペースの自動除去 ==== | ||
[https://stackoverflow.com/questions/40962197/phpstorm-removing-tabs-spaces-on-every-save PhpStorm removing tabs/spaces on every save - Stack Overflow] | |||
PhpStormでファイルを開いて保存すると、勝手に終端スペースを削除する。デフォルトでそういう設定になっている。 | |||
[Settings/Preferences]-[Editor]-[General]-[Remove trailing spaces]=on | |||
==== Templateエンジンでのシンボルジャンプ ==== | |||
https://chatgpt.com/share/6808ae15-1d60-800b-9e86-78aa131ee066 | |||
Smartyでは新ポルジャンプできない。 | |||
BladeとTwigはシンボルジャンプに対応しているらしい。VSCodeも。じゃあ、こっち優先するか。Laravelは嫌いだからTwig。 | |||
==== 重いとき ==== | |||
https://chatgpt.com/share/681ab545-1814-800b-a019-c6cce4f24a3c | |||
PHPStormを起動したら、CPU使用率がめちゃくちゃ高くてまともに動作しないことがある。 | |||
PHPStorm自体の更新キャッシュファイルの削除などを行なっている模様。 | |||
いくつか対策がある。 | |||
# [File]-[Power Save Mode] を選ぶとJITとGCが安まり軽快になる。 | |||
# Help > Diagnostic Tools > Activity Monitorでなんのプロセスの使用率が高いかわかる。 | |||
# Help > Show Log in Finder/Explorer-idea.logでログがわかる。 | |||
JITやGCの使用率が高い場合、メモリー管理やコードの最適化の負荷が高まっている。メモリー不足でGCが頻発していてCPU使用率が高まっている可能性がある。メモリー割り当てを大きくして、GCの頻発を抑えて、処理を完了させるとまともになる。 | |||
Help > Edit Custom VM Optionsで以下を設定する。 | |||
-Xms1024m | |||
-Xmx4096m | |||
-XX:ReservedCodeCacheSize=512m | |||
-XX:+UseG1GC | |||
8GBの場合。 | |||
< | * <code>Xms</code>:初期メモリサイズ | ||
* <code>Xmx</code>:最大メモリサイズ(あなたのPCのRAMが8GB以上なら <code>4096m</code> でもOK) | |||
* <code>ReservedCodeCacheSize</code>:JIT用のコードキャッシュ領域 | |||
* <code>UseG1GC</code>:ガベージコレクションにG1GCを使用(モダンで安定) | |||
編集後はPHPStormを再起動する。 | |||
==== ローカルPHPインタープリター ==== | |||
PHPStormが端末などでデフォルトで使うPHPを指定できる。 | |||
# Cmd-, (Settings) -[PHP] を選ぶ。 | |||
# [CLI Interpreter] の横の [...] を選ぶ。 | |||
左上の[+]から追加したりできる。 | |||
OS内で認識しているPHPのリストが表示される。ここで設定したPHPが端末起動時のパスに設定される。 | |||
[[Category:IT]] | |||
2025年10月27日 (月) 09:45時点における最新版
ソフトウェア開発作業全般
Other
ASCIIFlow: 画面構成図などの作成でテキストなので便利かもしれない。
Management
データ管理
https://chatgpt.com/share/680a33a2-159c-800b-8e8f-020f3d9ac921
時間ベースとカテゴリーベースがある。それぞれ利点と欠点がある。
- カテゴリーベース: 検索・アクセスが有利。プロジェクト、業務単位。長期にわたって使うもの。
- 時間ベース: 保管・バックアップ効率。経理関係。一時保管など。
基本はカテゴリーベースで、契約書とか、一時保管が必要なものは、時間ベースにも保管する。こうすると、いいかもしれない。
コピーする場合、どこからどこのコピーかわかるように、ショートカットも配置しておく。また、コピーであることがわかるディレクトリーにしておく。
バックアップ
VCSなしの場合のバックアップファイルの命名規則。
https://grok.com/share/c2hhcmQtMw%3D%3D_28297f6a-2ff6-4a9d-af38-5e729e65d9ed
filename.YYYYmmdd.ext
この形式がいい。拡張子の前に日付を入れる。拡張子の後に入れてしまうと、アプリが拡張子を認識できなくて困る。
Project
- オープンソースの開発プロジェクトではコーディング以外のドキュメント化やサポートなどの貢献が特に重要 - GIGAZINE
- オープンソースプロジェクトを有料化して月収100万円の事業家に転身したソフトウェア開発者 - GIGAZINE
名簿付きの寄付
- Vim: https://vim-jp.org/vimdoc-ja/sponsor.html
- Vim (list): https://www.vim.org/sponsor/hall_of_honour.php
- KDE: https://relate.kde.org/
- KDE (list): https://relate.kde.org/civicrm/profile?gid=18&search=0
- Conservancy (list): https://sfconservancy.org/sponsors/
- Conservancy: https://sfconservancy.org/donate/
Kanboard
クローズ時に自動移動
[Configure project]-[Automatic actions]
- action=[Move the task to another project]
- Event name=Closing a task
- Column=Done
- Project=
これでDoneをclose時にアーカイブ用のプロジェクトに移動できる。
Product
会員番号の設計
https://grok.com/share/c2hhcmQtMw%3D%3D_db01208a-8222-4d9b-900e-2bb429417296
ポイントカードは番号だけでためたり、使えたりしちゃう。流出すると不正利用の可能性がある。dポイントとか楽天ポイントとか。既存のポイントシステムは、固定番号を採用している。
アプリでタイムスタンプを付けたら、流出漏洩ガードができる。が、即時性を優先して固定番号も併用している模様。後は、不正監視システムでカバーとか。
ポイントは換金性が高いが、そんなに金額が大きくならずに消費される想定だから、リスクはあっても問題ない感じなのだと思われる。
バーコード
- バーコードの種類 | バーコード講座 | キーエンス
- zxing/zxing: ZXing ("Zebra Crossing") barcode scanning library for Java, Android
形式が複数ある。
| 1D product | 1D industrial | 2D |
|---|---|---|
| UPC-A | Code39 | QR Code |
| UPC-E | Code93 | Data Matrix |
| EAN-8 | Code128 | Aztec |
| EAN-13 | Codabar | PDF 417 |
| UPC/EAN Extension 2/5 | ITF | MaxiCode |
| RSS-14 | ||
| RSS-Expanded |
緯度経度の順番
https://grok.com/share/c2hhcmQtMw%3D%3D_4f7c43b1-51f2-4cf4-b832-b108d74c7705
地理情報の座標は、緯度経度の順番で表記することが多い。ただ、数学的にはx,yの順番。メルカトル図法の一般的な地図の資格情報的には、経度緯度がx,yと対応する。順番が違うのが気になる。
結論: 外部公開APIは、緯度経度。内部で緯度経度を変換して、x,yにしたら、x,yの順番で扱う。
理由: 地理学的には、経度は特定が難しくて、緯度が先に特定されて、世界で先に使われるようになった。そのため、緯度経度の順番になって、世間で定着している。ISOなどの標準も緯度経度の順番。GeoJSONとかITシステムでは経度緯度の順番。
チェックイン機能
方式
https://grok.com/share/c2hhcmQtMw%3D%3D_792c1e8e-5fcd-429b-a7cd-1e116addbf39
| 方式 | 内容 | 利点 | 欠点 | 不正 | 対策 |
|---|---|---|---|---|---|
| Geolocation API | 店舗でマイページボタン押下 | 追加設備不要 | 不正完全防止不能 | 位置偽装 | ユーザー特定可能なので、運用で不正をカバーする。 |
| 動的QR | 店頭動的QRコードの読取 | 不正完全防止 | 表示端末設置必要、サーバー追加実装必要 | ||
| 固定QR | 店頭固定QRコード読取 | サーバー追加実装不要 | 不正完全防止不能 | QRコード撮影持帰 | 固定QRを定期更新。 |
| NFC | 店頭NFC読取 | タグ設置必要、端末限定 | |||
| Bluetooth Beacon | 店頭Beacon通信 | Beacon設置必要 |
- 手間最小はGeolocation API。位置偽装がありえるので、アカウントの定期監視は必要。付与の頻度や上限の制限ロックなど必要。
- 不正防止+低コストは固定QR。定期的なQR更新が必要。
- 不正完全防止で手間最小は動的QR。ただし、表示端末設置、追加サーバー実装必要。
動的QR
https://grok.com/share/c2hhcmQtMw%3D%3D_57855e1c-bae0-4fd9-99f5-622979149ff3
トークン管理用のテーブルを用意。
CREATE TABLE checkin_history (
id INT AUTO_INCREMENT PRIMARY KEY,
store_id INT NOT NULL,
token VARCHAR(255) NOT NULL,
checkin_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (store_id) REFERENCES stores(store_id)
);
トークン作成用のAPIを用意。アクセスが来たら、tokenを作って、それや店舗IDを埋め込んだQR/URLを作成 (?store_id=XXX&token=XXX)。
該当トークンを検証して、処理実施。GPS不要になる。
Communication
Backlog
メール通知
Backlogの通知設定をカスタマイズする手順|チーム効率を2倍にする最適化テクニック | こまろぐ
[個人設定]-[メール設定] で全体設定する。
ただ、コメント記入時に、[コメントをお知らせしたいユーザー] に入っていると、通知が来る。メールフィルターで対応するしかない。
Skype
すべてのエモーティコンのリストはありますか? - Microsoft サポート
Skyepで使用可能な絵文字の一覧。
Slack
チャンネル
一覧表示
[ホーム]-[チャンネル]-[管理する]-[チャンネル一覧] でチャンネル一覧を閲覧可能。
パーマリンク
Slackの投稿パーマリンクをWebブラウザーで開くと、該当箇所にジャンプできない。デスクトップアプリがあると開ける。それでしのぐ。
JIRA
関連チケット
[修正するバージョン]/[影響するバージョン] のリンクをクリックすると、関連するissueが一覧表示される。これで未クローズチケットを確認するといい。
履歴
[アクティビティ]-[履歴] のタブを選ぶと、変更履歴を確認できる。
Confluence
ページの中で、 [作成] を選んでページを作ると、階層が勝手にできて、子ページへのリンクもできる。
ショートカットキー
キーボード ショートカット
https://ja.confluence.atlassian.com/doc/keyboard-shortcuts-139456.html
エディタ
- {code: コードブロック (https://shinkufencer.hateblo.jp/entry/2018/10/17/235900 Confluenceのエディタは { でマクロのショートカット入力ができるし、{ code } でコードスニペット領域が作れる)。
ブロック フォーマット
| Windows | 操作 | Mac |
|---|---|---|
| Ctrl + 0 | Paragraph | ⌘+ 0 |
| Ctrl+ (1 ~ 6) | (選択した番号の)見出しレベル | ⌘+ (1—6) |
| Ctrl + 7 | Preformatted | ⌘+ 7 |
| Ctrl + 8 | Quote | ⌘+ 8 |
| Ctrl + Shift + B、または
* + Space |
箇条書きリストを追加 | ⌘ + Shift + B、または
* + Space |
| Ctrl + Shift + N、または
# + space |
番号付きリストを追加 | ⌘ + Shift + N、または
# + space |
| Ctrl + Shift + S | Strikethrough | ⌘ + Shift + S |
| Ctrl + Shift + | Subscript | ⌘ + Shift + , |
| Ctrl + Shift + | Superscript | ⌘ + Shift + . |
| Ctrl + Shift + M | Monospace | ⌘ + Shift + M |
| Ctrl + \ | Clear formatting | ⌘ + \ |
豊富なフォーマット
| CTRL + Shift + V
サファリのみ:Ctrl + Shift + Alt + V |
書式設定なしでテキストを貼り付け | ⌘ + Shift + V
Safari のみ:⌘ + Shift + Option + V |
| Ctrl+M | Files and images | ⌘+ M |
| Ctrl+K | リンク([リンクの挿入] ダイアログが開く) | ⌘ + K |
| Ctrl + Shift + D | マークアップを挿入([マークアップの挿入] ダイアログが開く) | ⌘ + Shift + D |
| Ctrl+Shift+A | マクロ([マクロの選択] ダイアログが開く) | ⌘ + Shift + A |
| Ctrl + Shift + O | 次のインライン コメントに切り替え | ⌘ + Shift + O |
| Ctrl + Shift + L | 前のインライン コメントに切り替え | ⌘ + Shift + L |
| CTRL + Shift + Z | インライン コメントを閉じる | ⌘ + Shift + Z |
| Ctrl + Shift + I | 表 | ⌘ + Shift + I |
| Alt + 上矢印 | 行を上に挿入 | Alt + 上矢印 |
| Alt + 下矢印 | 下に行を挿入 | Alt + 下矢印 |
| Ctrl + Shift + X | 行を切り取り | ⌘ + Shift + X |
| Ctrl + Shift + C | 行をコピー | ⌘ + Shift + C |
| Ctrl + Shift + Y | 行を上に貼り付け | ⌘ + Shift + Y |
| Ctrl + Shift + ; | 絵文字メニュー | ⌘ + Shift + ; |
| CTRL + Shift + V | 書式設定なしで貼り付け | ⌘ + Shift + V |
| 書式設定なしで貼り付け (Safari) | ⌘ + Shift + Option + V |
オートコンプリート
[] が勝手にリンクになるのが困る。
リンク、ファイル、マクロ、メンション、絵文字のオートコンプリート
オートコンプリートの無効化方法。
プロフィール画像を選択-[設定]-[エディター]-[☑️オートコンプリートの無効化]
ただ、オートコンプリートの丸ごと無効化は、便利な機能がなくなるので不味い。
一時的に回避したい場合、[の直前に何か文字があれば解釈されない。スペース開けて[があるとオートコンプリート扱いになる。
書式なしペースト
Confluenceで書式なしペースト(Ctrl+Shift+V)を有効にする #Confluence - Qiita [?]-[キーボードショートカット]-[General]-[▫️Enable General Shortcuts] にしてオフにすると有効になる。 [表の上部にペースト] と競合していたらしい。
マクロ
マクロ | Confluence Data Center 9.2 | アトラシアン製品ドキュメント
いくつか有用なマクロがある。
- 子ページ表示マクロ | Confluence Data Center 9.2 | アトラシアン製品ドキュメント
- Confluence(コンフルエンス)の一部内容を折りたたみで非表示できる「展開」マクロを使ってみよう - リックソフトブログ
Other
パーマリンク
Confluenceのページ新規作成時、パーマリンクが自動生成される。規則がある。
以下の条件にマッチしたら、padeId URLになる。それ以外は、タイトル名のURLになる。
- [% & ? / ¥ ; " + :] などのようなURLの予約文字。
- 非ラテン文字。
- ページタイトル末尾が英数字以外の場合。
ページ履歴
ページ右上のメニュー-[ページ履歴]から履歴を確認できる。差分も確認できる。
ページ移動
ページの移動と順序の変更 | Confluence Data Center 9.2 | アトラシアン製品ドキュメント
ページ右上のメニュー-[移動]
Tool
General
Call tree
kcachegrindだったかな。
kscopeもこれか。
Doxygen+GraphVizで関数コールグラフ
kscope
https:/github.com/ivan0124/Linux-programming/wiki/How-to-use-KScope-to-trace-code
https:/sourceforge.net/projects/kscope/
http:/www.lemis.com/grog/software/kscope.php
cscope
cbrowser/kbrowserというGUIもある。
cscopeの大文字小文字無視検索
http://vim.1045645.n5.nabble.com/how-to-search-with-cscope-ignoring-case-td5715043.html
DBを別にする必要がありそう。
expect
端末の手動操作を自動化するソフト。
- * ^と$は使えない。代わりに、\nを使う。
- * 文字列の囲みに一重引用符 (') は使えない。二重引用符 (") のみ有効。
- * expect文はawkみたいな感じ。
- * ただし、expectは注意が必要。最初のexpectにマッチしないと先に進めない。タイムアウトとかするしかない。
expect -c "set timeout 5; spawn cat cat.txt; expect \nFAIL {send pwd/n; expect :; exit}"
https:/linuxjm.osdn.jp/html/expect/man1/expect.1.html
sh -eux <<-"EOT"
expect -c "set timeout 5; spawn ssh senooken@senooken-linux; expect :; send ieneko/n; expect aho {send echo aho} +x {send pwd/n}; expect /$; exit"
expect -c "set timeout 5; spawn ssh senooken@senooken-linux; expect :; send ieneko/n; expect + {send pwd/n}; expect /$; exit"
expect -c "set timeout 5; spawn cat cat.txt; expect \nFAIL {send pwd/n; expect :; exit}"
expect -c 'set timeout 10; spawn cat cat.txt; expect "aa F" {set AAA "abc"}; expect FAIL {send "$AAA/n"; expect " "; exit}'
EOT
踏み台サーバーログイン
expectのオプションに-cで細切れにするのもOK connect 'xxx.xxx.xxx.xxx /ssh /auth=password /user=id /passwd=pw' wait '' sendln 'ssh root@<ここにIPアドレスを記入>' wait 'Password:' sendln 'pw' connect 'ip1 /ssh /auth=password /user=sef19a /passwd=ipscp19a' wait '' sendln 'expect -c "spawn ssh root@ip2; expect :; send pelican/n; interact"' sendln 'expect -c "spawn ssh root@ip2" -c "expect :" -c "send pelican/n" -c "interact"'
GNU screen
GNU Screenコマンドをつかってみる #screen - Qiita
screenコマンド実行後に、C-a押下後に対応するキーを押して各種操作を実行する。
キー操作以外に、コマンドも用意されている。C-a :でコマンドラインモードに入る。
特に重要な操作。
- Help
- C-a ?
- Command:help
- Window
- C-a c/C-a C/Command:screen=Windowを生成。
- C-a space/C-a n/C-a C-n/Command:next=次のWindowへ移動。
- C-a p/C-a C-p/C-a C-h/C-a Backspace/Command:prev=前のWindowへ移動。
- 画面分割: Regionを分割してそこにWindowを割り当てる。
- C-a S=横分割
- C-a |=縦分割
- C-a TAB/Command:focus=分割画面の移動。
- クローズ
- C-a X/Command:remove=現在のRegionを終了。
- C-a Q/Command:Only=現在以外のRegionを終了。
.screenrc
スタートアップメッセージ
startup_message off
スクロール
linux screen中にマウスホイールでスクロールする方法 - 技術メモ集
デフォルトだとマウススクロールなどに対応していない。以下の設定で対応でき、通常使用で問題なくなる。
termcapinfo xterm* ti@:te@ defscrollback 100000
File
Binary
.so
ソフトウェアの依存関係などの調査で.soファイルの分析を行うことがある。
- nm
- ldd
- string
設定ファイル
https://grok.com/share/c2hhcmQtMw%3D%3D_fb839660-c036-4484-b24f-aa77107db9b3
xml/json/yaml/iniなど設定ファイルの形式がいろいろある。それぞれ長所短所があって使い分けがある。
- json: パースが高速。コメント未対応。複雑な構文をサポート可能で、データの交換などで使う。
- xml: 表現力が高い。が、パースはjsonよりは遅い。名前空間など意味論の厳密性が必要な時。
- yaml: 可読性が高い。コメント対応。人間が頻繁に編集するタイプのデータに使う。
- ini: シンプルで高速。ネストの表現不能。単純なキーバリューのシンプルな設定だけ。
- toml
- HCL (HashiCorp Configuration Language)
- Protocol Buffers (Protobuf)
- EDN (Extensible Data Notation)
- CSV
yamlかjsonで作っておくと無難。
YAML
About
YAML 1.2.2 (2021-10-01) が最新。2001-05-11が初版。dockerなどの設定ファイルで採用されていて一部で人気。可読性が高くて、コメントを記入できて、データ量も少ない。人が手作業で記入する形式として適しているとの評判。
YAML Ain’t Markup Language (YAML™)
Basic
General
インデントで階層構造を表現。インデントはスペースのみ。スペース2個でインデントが主流。
#は行コメント。
---は1ファイル内に複数YAML記載時のセパレーター
リスト
ブロック形式とインライン形式/フロー形式の2種類の記載方法がある。
--- # お好みの映画、ブロック形式 - Casablanca - Spellbound - Notorious --- # 買い物リスト、インライン形式、またはフロー形式 [milk, bread, eggs]
- {name: John Smith, age: 33}
- name: Mary Smith
age: 27
ハッシュのリストのブロック形式はバレットが1個しかつかないのでちょっと気持ち悪いので注意。
連想配列・ハッシュ
--- # ブロック
name: John Smith
age: 33
--- # インライン
{name: John Smith, age: 33}
men: [John Smith, Bill Jones] women: - Mary Smith - Susan Williams
リストのハッシュ。
Scalars
1文字目を|にして改行すると、データ内の改行を維持。>にすると、改行をスペースに置換。
data: |
There was a young fellow of Warwick
Who had reason for feeling euphoric
For he could, by election
Have triune erection
Ionic, Corinthian, and Doric
data: > Wrapped text will be folded into a single paragraph Blank lines denote paragraph breaks
Other
ブロック/インライン・フローの混在
Swaggerのプロパティーのdescriptionで区分値の説明用に箇条書きを使いたい。
content:
application/json:
schema:
type: "object"
required: ["customerNo", "eventNo"]
properties:
customerNo: {title: "会員番号", description: "会員番号", type: string}
actionType:
title: アクションタイプ
description: |
ユーザーのアクション種別。
- 1: セミナー申込
- 2: 動画視聴,
type: integer
enum: [1, 2]
default: 1
基本はswaggerやyamlはブロック形式が基本になっている。短くてシンプルなところだけインライン・フロー形式を使う。長くなるならブロック形式にする。
親のpropertiesのブロック形式にする必要がある。
Diff
差分確認ツール。コードレビューなどで重要。
About
Macが鬼門。
M1 Macで使用可能なものの選択肢が極端に狭い。
https://chatgpt.com/c/678e249e-84f0-800b-b8da-7385d9aaf819
| name | OS | Free | GUI | directory | image | comment |
|---|---|---|---|---|---|---|
| FileMerge | Mac | x | x | x | Xcode付属ツール。悪くない。が、Mac専用。 | |
| P4Merge | x | x | x | - | x | ディレクトリー比較ができないのが惜しい。 |
| DiffMerge | x | x | x | x | - | 悪くない。が開発停止。MacはIntel版のみ。 |
| WinMerge | Windows | x | x | x | 使いやすい。 | |
| Meld | Windows/Linux | x | x | x | Linux系の標準。悪くない。 | |
| kdiff3 | Windows/Linux | x | x | x | 開発停止。使えなくはない。 | |
| vimdiff | x | x | x | x | - | 使いにくい。 |
| Visual Studio Code | x | x | x | x | x | ディレクトリー比較は [Compare Folders - Visual Studio Marketplace] 拡張機能。 画像比較は [Image Preview] らしい。 |
| Intellij IDARE | x | - | x | x | x | |
| Beyond Compare | x | - | x | x | x | |
| DiffImg | Windows/Linux | x | x | x | ||
| PerceptuallDiff | x | - | x | |||
| PixelCompare | x | x |
DiffMerge一択になる。ファイルサイズも小さい。大きくても11 MB。
Visual Studio Codeが汎用的だから、こちらでいいかもしれない。
DiffMerge
FileMerge
Mac純正のファイル差分確認ツール「FileMerge」が使いやすい - Reasonable Code
[/Applications/Xcode.app]-右クリック-[Show content]-[Contents/Applications/FileMerge.app]
コマンドラインからだとopendiff。
Visual Studio Code
About
ディレクトリー比較は [Compare Folders - Visual Studio Marketplace] 拡張機能。 画像比較は [Image Preview] らしい。
VSCode | 2つのファイルの内容を比較して差分を表示する
code -d <file1> <file2>
上記コマンドで差分表示できる。外部の差分ツールとして使う際は、上記コマンドになるように指定する。
GUIからだと、[View]-[Command Pallete]-[Compare] から比較できる。
比較のモードがいくつかある (VS Codeでファイル・ソースコードの差分を比較(diff)する2通りの方法)。
| No. | 比較モード | 用途 |
|---|---|---|
| 1 | ファイル: アクティブ ファイルを比較しています...
File: Compare Active File With... |
現在のアクティブファイル と 指定したファイル を比較する。 |
| 2 | ファイル: クリップボードとアクティブ ファイルを比較
File: Compare Active File with Clipboard |
Ctrl + Cでクリップボードに保存された文字列 と 現在のアクティブファイル を比較する。
|
| 3 | ファイル: 新しい無題のテキスト ファイルの比較
File: Compare New Untitled Text Files |
比較モードで新規テキストファイルを2つ開いた状態となる。 |
| 4 | ファイル: 保存済みファイルと作業中のファイルを比較
File: Compare Active File with Saved |
未編集状態のアクティブファイル と 前回保存したアクティブファイル を比較する。 |
| 5 | マージの場合: 現在の競合を比較
Merge Conflict: Compare Current Conflict |
Git環境でブランチをマージした時にコンリクト(競合)が発生していないか比較する。 |
File: Compare Active File Withが素直か。
Diff Folders
VSCode拡張機能「Diff Folders」でフォルダ間の違いを簡単に比較しよう! | UNTIC | Web担当者のための仕事メディア
Diff Foldersの他に、Compare Foldersというのもある。が、Diff Foldersのほうが直感的で使いやすいらしい (is there a compare folders feature in VS Code? - Stack Overflow)。ただ、Compare Foldersのほうがダウンロード数が多い。
標準ではディレクトリー比較はできない。Diff Foldersの拡張機能が必要。
- Diff Foldersをインストール
- c-P-[Diff Folders]-[New Diff Panel] またはc-L
Compare Folders
format
わかりやすい差分(diff)の取り方いろいろメモ #Git - Qiita
diffコマンドの差分表示の形式がいくつかある。
- ノーマル
- context
- unified
contextとunified形式には差分に対象ファイルの情報がある。パッチファイルを作成するなら、この2種にすべきになる。
ノーマル形式は、本当に変更行のピンポイントの情報だけ。
normal
the quick brown fox jumps over the lazy dog
the quick brown fox jumped over the lazy dogs
% diff a.txt b.txt 5,6c5 < < jumps --- > jumped 8a8 > 10c10 < dog --- > dogs
5,6行目と5行目で開業+jumpsのjumpedへの変更 (c=changed)。d=deleted。a=added。こういう形式。
context
% diff -c a.txt b.txt *** a.txt 2016-08-29 06:43:45.000000000 +0900 --- b.txt 2016-08-29 06:43:59.000000000 +0900 *************** *** 2,10 **** quick brown fox ! ! jumps over the lazy ! dog --- 2,10 ---- quick brown fox ! jumped over the + lazy ! dogs
2行目から10行目にかけて。
!は変更。+は追加。
unified
diffによるunified形式の意味について - プログラミング以外 - k.bigwheelの日記
gitなど差分ツールでよく使われるunified形式。形式が独特で知っていないと意味不明なので注意する。diff -uオプションでこの形式になる。
$ diff -u test.txt.orig test.txt --- test.txt.orig 2007-06-10 22:13:55.718311614 +0900 +++ test.txt 2007-06-10 22:54:23.038008776 +0900 @@ -2,9 +2,10 @@ かきくけこ さしすせそ たちつてと -なにぬねの +なにぬねのん はひふへほ まみむめも やゆよ らりるれろ わをん +がぎぐげご
@@の行がが特に重要。
@@ -R +R @@
この書式。-Rが元ファイルの変更箇所、+Rが変更後ファイルの変更箇所。
Rはl,sという形式。lは変更箇所の開始行、sは変更箇所の行数。
-2,9は2行目から9行分変更箇所がある。という意味。
変更箇所の前後の情報を@@で表現している。
ただ、このunified形式は中途半端。視認性重視。
2カラム
diff -yかicdiff --line--numbersは2列で表示してくれるから、視認性が高い。
UML
Tool
https://chatgpt.com/c/67441feb-d004-800b-96fd-0d9b04ffc628
What are the best UML tools for macOS? - Quora
- デスクトップ
- StarUML
- ArgoUML
- UMLet
- OmniGraffle
- edraw: 有料。
- Umbrello
- Modelio
- クラウド
- Visual Paradigm
- Lucidchart: 有料。
- Creately: 有料。
- diagrams.net: モデルじゃない。
- その他
- PlantUML
UmbrelloとModelioはそれらと比較して何がよかったのだっけ?
Eclipse Papyrusが動作するならこれがいい。Eclipseは安定しているから、これのプラグインで動作するなら信頼できるだろう。
papyrusは一度試してダメだった気がするが。
Diagram
クラス図
A=自分 (矢印の元)。B=相手 (矢印の先)
- 継承関係
- 汎化 (generalization): 実線白矢印。継承。
- 実現 (realization): 点線矢印。interfaceの継承。
- プロパティー単位
- 関連 (association): 実線。あるクラスが他のクラスのインスタンスを持つ。ただし、所有までいかない。コンストラクターのDIも含む。人と車のように全体-部分の関係がない場合これ。困ったらこれでもいい。
- 集約 (aggregation): 白菱形実線。関連の特殊系。所有者の方が菱形。所有される側は線。全体-部分の関係。ただし、部分は他の全体からも共有可能。List<T>やSet<T>のメンバー変数があれば集約の可能性が高い。
- コンポジション (composition): 黒ひし形。子が単体で存在できない場合。親と生存期間が同一の場合。部分が他から共有されない。集約の特殊系。
- リンク (link): 実線。クラスのインスタンス間の関係。クラス図ではなく、オブジェクト図で使われる。
- メソッド単位
- 依存 (dependency): 点線矢印。引数か返却値に使っていて、Bの変更が影響を与える場合。
- 使用 (usage): 点線矢印。引数と戻り値に使わず、関数内で一時的に使うだけ。依存の特殊系。
ER図
https://grok.com/share/c2hhcmQtMw%3D%3D_49664566-4833-490d-9309-e69597a6ac12
実態関連モデル。Entity-Relationshp Model。関係データベースを抽象的な表現手法。
格納されたデータが、他のデータとどう関係しているかを表現する。
1975年にPeter Chenが発表した。
- Entyty/実体: 現実世界のものや概念相当。オブジェクト指向のオブジェクト相当。DBではテーブル相当。四角形で描画。
- Attribute/属性: Entityの特徴や詳細情報。オブジェクト指向のプロパティー。DBではテーブルカラム相当。楕円で描画。
- Relationship/関係: Entity同士のつながり。オブジェクト指向のメソッド?DBではテーブル間の関係 (外部キーによるリンク相当)。菱形で描画。
- Instance/インスタンス: DBのレコード (行) 相当。
Relationship
https://grok.com/share/c2hhcmQtMw%3D%3D_861bd847-f9c8-4c01-8887-9802dad8f6e3
関係がわかりにくいので整理する。
Entity (テーブル相当) 動詞の関係をカーディナリティー (多重度) で表現する。3個の関係がある。
| 関係 | 関係名 | 例 | 意味 | |
|---|---|---|---|---|
| 1:1 (One-to-One) | <Master> has one <Master> | Person/Passport: 1人1パスポート。それぞれ重複がない。PassportにPersonの外部キーを持つ。
Employee/EmployeeDetail: EmployeeDetailのEmployeeの外部キーを持つ。 |
一方のEntityのインスタンス (行) がもう一方のEntityの1個だけのインスタンスに対応し、逆も同じ場合。情報が密接に関連していて、分離する必要はないが、管理・整理のために分けるケース。
詳細テーブルのパターン。テーブルに持ってもいいが、整理のために別テーブルにしている。 1:多の特殊ケースとみなせる。 実際のところ、1:1が本当に対等ということはほぼない。外部キーを片方に持たせる都合、親子関係がある。子が1個だけという話。逆に、そうできていないなら、Entityの選定・設計の問題を疑ったほうがいい。 |
|
| 1:多 (One-to-Many) | <Master> has <Transactions> | Department/Employee: Departmentが親でEmployeeが子。Departmentの1行 (ID=営業部) を、Employeeの複数行 (所属従業員) に対応。1従業員1所属の場合。EmployeeにDepartment IDを外部キーとして持つ。親の部門を削除すると子の従業員も影響を受ける。
Customer/Order: Customer (ID=1のA) はOrderの複数行 (注文1-3) に対応。注文は1顧客だけに連動。 |
一方のEntityのInstanceがもう一方のEntityの複数のインスタンスに対応。逆は多:1だが、1:多でどちらも表現。親子関係のような階層構造で使用する。マスター:トランザクションの関係でも使う。 | |
| 多:多 (Many-to-Many) | <Master> has many <Master> | Stundent/Course: Stundentの1行 (ID=1 学生A) はCourseの複数行 (数学、英語) に対応。Courseの1行 (数学) はStundentの複数行 (学生A,B,C) に対応。実装時はEnrollmentテーブル (登録) を作成して、これにStundent IDとCourse IDの相関テーブル+追加情報 (成績) などを入れる。
Product (製品)/Supplier (仕入先): 1商品が複数仕入れ先から調達可能。1仕入れ先が複数商品を供給。 |
一方のEntityがもう一方の複数のEntityに対応。逆も同じ。両側が独立して複数関連づく場合。DBでは直接実装不能なので、中間テーブルを通常使う。2個の1:多に分解。 |
マスターテーブルは親的な役割。トランザクションテーブルは子的な関係。通常、マスターテーブル:トランザクションテーブル=1:多。トランザクションテーブルにマスターテーブルの外部キーを持つ。
関係の命名。業務ロジックにあった命名ができればべストだが、一貫性がない。関係からある程度機械的に名前を決める。
- 1:1=has one
- 1:多=has
- 多:多=has many
これがスマート。多対多はis related toもよく使うが、他をhasで表現するなら、こうしないと気持ち悪い。
PlantUML
About
シンプルなテキストでUMLの作成ツール。ツールで機械的に生成できるのがポイント。細かいレイアウトの調整とか、複雑なことをしたい場合、けっこう難しくなる。
そうでなくて、機械的に作成することで、誰がやっても同じで、形式や配置が統一される。それが利点。
Other
対話AI
自分で作成するより、対話AIにお願いして作ってもらって、それを改造する形で作るのが手っ取り早い模様。
シーケンス図やクラス図なんかはそれでいける。
VS Code
About
Visual Studio CodeでPlantUMLを利用する方法(2020/10/30作成) #Java - Qiita
さっと書くだけなら、Webだけでもいい。機密情報とか扱う場合、ローカルでやるといい。
VSCodeの拡張機能でインストールする場合、JavaとGraphvizだけでいい。本体は拡張機能インストール時に同梱される模様。
出力ディレクトリー
VScode PlantUMLで作成するUML画像の出力先を設定する。 - Oboe吹きプログラマの黙示録
デフォルト状態だと、ファイル出力時に以下の形式になる。
out/.puファイル名/@startumlのタイトル.拡張子
最初のoutがうっとうしいのでpuと同じところに出力してほしい。
plantuml.exportOutDir: ".", plantuml.exportSubFolder: false,
上記設定にするとよい。
ステート図/状態遷移図
画面遷移図にも使える。
Alias
ステート・状態部分には、スペースや記号を使えない。以下の構文で別名を使って、表示用と内部用をわける。
state "display" as internal
合成状態
状態は合成可能。ブロックにまとめたりできる。 state 状態名 {} で定義する。
@startuml
scale 350 width
[*] --> NotShooting
state NotShooting {
[*] --> Idle
Idle --> Configuring : EvConfig
Configuring --> Idle : EvConfig
}
state Configuring {
[*] --> NewValueSelection
NewValueSelection --> NewValuePreview : EvNewValue
NewValuePreview --> NewValueSelection : EvNewValueRejected
NewValuePreview --> NewValueSelection : EvNewValueSaved
state NewValuePreview {
State1 -> State2
}
}
@enduml
共通処理を中でまとめたりするのに便利そう。
画面遷移図
https://chatgpt.com/share/6867298c-09bc-800b-89ec-de487215192b
Webアプリケーションの設計書として、画面遷移図が必要なことがある。
UMLでやる場合、アクティビティー図か、ステート図 (状態遷移図) がうってつけ。画面とその遷移アクションの両方を記載できるので申し分ない。
他、一覧表もあり。
実際にいくつか状態遷移図をステートマシン図で書いてみたところ、問題があった。
共通ヘッダーやモーダルの表現が難しかった。コンポーネント化的なことができなくて、同じ画面遷移・状態を複数書く必要があった。モーダルを開いて閉じるというのは、repeatでループで表現できるが、他の画面遷移との併記が難しかった。
これを考えると、ステート図のほうが、矢印の方向が柔軟で、共通化なことができた。
ステートマシン図の例
アクティビティー図の例
https://grok.com/share/c2hhcmQtMw%3D%3D_832592cf-86dd-41eb-a0fa-2fbd656e9299
ステート図で画面遷移図作成時のポイント。
Webページの場合はURLでやるのがいいと思う。
ただ、PlantUML内の状態名は、プログラミング言語の変数名相当だから、_以外の記号は使えない。
state <display> as <name> でnameを定義するといい。_をスラッシュとみなして、全小文字とか。
state "www.example.com" as wwww state "www.example.com/mypage" as www_mypage [*] -> www root -> www_mypage
複数サイトになることがあるから、サブドメイン (なければwww) をベースの名前空間にするのがよさそう。
エイリアス名。url内の記号は除去でいい。exmaple.com/user-profile/editとか。www_userprofile_edit。url内のディレクトリーに記号を使うほうが悪い。全小文字区切り文字なしにすべき。短いほうがいいのだから。
矢印の向き
矢印の向きの制御方法がある。
- ->: 最短距離。左右になることが多い。
- -right->/-down->/-up->/-left->: 向きを明示。
- -->: 長めの矢印。上下になることが多い。
- -->/..>: 向きには影響しない。
- top to bottom direction: 全体の向きの明示。
directionで全体の向きを指定しても、->の最短矢印だと、長さが優先される。矢印内で向きを明示するか、-->の長めの矢印を使うとよい。
条件分岐
<<choice>> ステレオタイプで条件付きの状態を指定できる。
@startuml state c <<choice>> Idle --> ReqId ReqId --> c c --> MinorId : [Id <= 10] @enduml
やや使いにくいかもしれない。条件がある場合、矢印に説明を入れるといいかもしれない。
アクティビティー図
記法
https://chatgpt.com/share/68675652-ff90-800b-93ff-19285fe8cf21
PlantUMLのアクティビティー図の記法はレガシー記法とモダン記法とで2種類ある。
最大の違いは、分岐。以前は o --> option1, o --> option2で1個のアクティビティーから複数のアクティビティーに分岐できた。が、これがモダン記法だとできない。
split forkで明確に管理するようになった。パースとかのしやすさ、構文の曖昧性の排除が目的の模様。
split fork
アクティビティーの分岐の記法。2種類ある。紛らわしい。
splitは条件分岐、forkは並列実行的なイメージになっている。
以下の構文。
- split/split again/end split
- fork/fork again/end fork
@startuml start split :A; split again :B; split again :C; split again :a; :b; end split :D; end @enduml
見た目の問題で、splitのほうがすっきりしている。
矢印
矢印にテキストを添えたり、色、線の形式を指定できる。
@startuml
:foo1;
-> You can put text on arrows;
if (test) then
-[#blue]->
:foo2;
-[#green,dashed]-> The text can
also be on several lines
and **very** long...;
:foo3;
else
-[#black,dotted]->
:foo4;
endif
-[#gray,bold]->
:foo5;
@enduml
モーダル
モーダルのような一時的に開いて戻る場合、反復可能なので、repeatで表現するとエレガント。
@startuml ' PlantUMLソースコード start repeat :ホーム; ->モーダルを開く; :モーダル; repeat while ([閉じる] 選択) is (yes) stop @enduml
ただ、モーダル以外の他の画面遷移が少々苦しくなる。repeat内でsplitすればいけなくはないが。
モーダルを閉じる動きはstopでいいかもしれない。
ER図
PlantUMLでは2種類のER図に対応している。Chen's notationは2024-04導入の新しい模様 (plantuml/CHANGES.md at master · plantuml/plantuml)。
Chen notation
Entity Relationship diagram (Chen's notation)
chenの記法がER図そのものできれい。これを使う。ただ、Chen notationはnoteの注釈機能が使えなくて、見た目はいいけど、機能不十分。IEのほうがよさそう。
@startchen
entity "DJ.CUSTOMER" as DJ_CUSTOMER {
Number <<key>>
Name
}
entity MOVIE {
Code <<key>>
}
relationship RENTED_TO {
Date
}
RENTED_TO =1= DJ_CUSTOMER
RENTED_TO -N- MOVIE
@endchen
https://grok.com/share/c2hhcmQtMw%3D%3D_db38ab26-68a2-4a0b-b1e4-dc231e51279b
- entity=テーブル。属性がなくても改行した波括弧が必要。少々気持ち悪いが。
- attribute=属性: entityの波括弧内に記述。<<key>>のステレオタイプでキーを表現。下線がつく。
- relationship=関係: has/belongs_toとかを記載するのが無難。user-order=places/student-courses=enrollsとかわかるなら動詞も。
- 太字 (total participation): 親テーブルに埋め込まれている外部キーがNOT NULLの場合。単独存在がなくて存在必須なので。
entity名に.とかは入れられないのでasで別名で回避 (https://grok.com/share/c2hhcmQtMw%3D%3D_1d81495e-fd3c-4f3c-8fc4-19b2d4f391b2)。
https://grok.com/share/c2hhcmQtMw%3D%3D_aa8d7730-69dd-4d58-b88a-8edea922b3c8
属性はネストできる。これは概念的な話。例えば、住所は市区町村や番地、建物名とかに分解できる。が、物理DBだとこれらは展開済み。グループ化の話。別にネストしなくてもいい。
親子関係
オブジェクト指向の継承関係を表現できる。
- ->-: 矢印の方向が親。
@startchen
entity CUSTOMER {
}
entity PARENT {
}
entity MEMBER {
}
CUSTOMER ->- PARENT
MEMBER -<- CUSTOMER
@endchen
ステレオタイプ
- <<key>>: 主キー。
- <<derived>>: 他の属性からの計算カラム。
- <<multi>>: enum形式。
IE
Information EngineeringベースのER図。既存のクラス図の拡張記法。クラス図でできることは全部できる。
classの代わりにentityを使うところが主な違い。
インフォメーションエンジニアリングの関係線
| Type | 記号 |
| 0か1 | |o--
|
| 1のみ | ||--
|
| 0以上 | }o--
|
| 1以上 | }|--
|
波括弧}が複数。|が1、oが0を意味する。
関係線の記法だけ注意が必要。
エンティティ
基本はクラス図と同じ文法。他の違い。* は必須を意味する。
シーケンス図
->でメッセージを描く。参加者の明示的な宣言は不要。
分類子の宣言
参加者の宣言は不要だが、デフォルトだと四角になる。actorとかDatabaseとか見た目を調整したい場合、participantでを宣言しておく。
変数の型名のように、以下の分類子
actorboundarycontrolentitydatabasecollectionsqueue- participant (初期値)
<分類子> <参加者>[ as 別名]
@startuml participant Participant as Foo actor Actor as Foo1 boundary Boundary as Foo2 control Control as Foo3 entity Entity as Foo4 database Database as Foo5 collections Collections as Foo6 queue Queue as Foo7 Foo -> Foo1 : To actor Foo -> Foo2 : To boundary Foo -> Foo3 : To control Foo -> Foo4 : To entity Foo -> Foo5 : To database Foo -> Foo6 : To collections Foo -> Foo7: To queue @enduml
メッセージに付けるノート
メッセージのすぐ後ろにキーワード note left または note right を使用し、メッセージにノートを付けることが可能です。
end note キーワードを使って、複数行のノートを作ることができます。
@startuml Alice->Bob : hello note left: this is a first note Bob->Alice : ok note right: this is another note Bob->Bob : I am thinking note left a note can also be defined on several lines end note @enduml
メッセージのグループ化
次のキーワードを使えば、メッセージをまとめてグループ化できます。 alt/else opt loop par break critical group表示するテキスト ヘッダ部分に文字列を追加することが可能です。(groupについては、後述の「groupの2つ目のラベル」を参照) グループを閉じるにはキーワード end を使用します。
@startuml
Alice -> Bob: Authentication Request
alt successful case
Bob -> Alice: Authentication Accepted
else some kind of failure
Bob -> Alice: Authentication Failure
group My own label
Alice -> Log : Log attack start
loop 1000 times
Alice -> Bob: DNS Attack
end
Alice -> Log : Log attack end
end
else Another type of failure
Bob -> Alice: Please repeat
end
@enduml
groupでは、[と]の間に2つ目のラベルを設定し、ヘッダに表示させることができます。
@startuml
Alice -> Bob: Authentication Request
Bob -> Alice: Authentication Failure
group My own label [My own label 2]
Alice -> Log : Log attack start
loop 1000 times
Alice -> Bob: DNS Attack
end
Alice -> Log : Log attack end
end
@enduml
ライフラインの活性化と破棄
activateとdeactivateで分類子の活性化を表現。例えば、関数の実行中とかが四角になってわかりやすい。
が、やや記述が複雑になるので注意する。
@startuml participant User User -> A: DoWork activate A A -> B: << createRequest >> activate B B -> C: DoWork activate C C --> B: WorkDone destroy C B --> A: RequestCreated deactivate B A -> User: Done deactivate A @enduml
autoactivate onにすると勝手に活性化してくれる。returnで解除する。昔はなかった気がする。このautoactivate on。
ただ、これを使うと、途中でif文でreturnする倍とかの表現が面倒になるので注意する。
@startuml autoactivate on alice -> bob : hello bob -> bob : self call bill -> bob #005500 : hello from thread 2 bob -> george ** : create return done in thread 2 return rc bob -> george !! : delete return success @enduml
returnを使うと自動的に活性化してくれるのでこれを活用するのがいい。
@startuml Bob -> Alice : hello activate Alice Alice -> Alice : some action return bye @enduml
活性化、非活性化、生成のショートカット記法
対象の分類子を記述した直後に、次の記法を使うことができます。
++対象を活性化する (続けて色を記述することもできます)--起点側を非活性化する**対象のインスタンスを生成する!!対象のインスタンスを破棄する
クラス図
メソッド
クラス名:に続けて記載する。他に波括弧。
丸括弧があればメソッド。なければプロパティー。
@startuml Object <|-- ArrayList Object : equals() ArrayList : Object[] elementData ArrayList : size() @enduml
@startuml
class Dummy {
String data
void methods()
}
class Flight {
flightNumber : Integer
departureTime : Date
}
@enduml
可視性
| 文字 | 可視性 |
-
|
private
|
#
|
protected
|
~
|
package private
|
+
|
public
|
注釈とステレオタイプ
注釈の詳細
フィールド(フィールド、属性、メンバー)またはメソッドへの注釈
フィールド (フィールド、属性、メンバー) に注釈を追加できる。
left/rightのみ可能。名前空間区切り文字列に::を指定した場合、使用不能。
@startuml
class A {
{static} int counter
+void {abstract} start(int timeout)
}
note right of A::counter
This member is annotated
end note
note right of A::start
This method is now explained in a UML note
end note
@enduml
以下の書式。
note <direction> of <class>::<attribute> end note
インラインは不能。
Reference
PlantUML Language Reference Guide
Creole
Use creole syntax to style your texts
特殊文字
&#XXXXまたは、<U+XXXX>の構文、または直接記述することで、任意のUnicode文字を使うことができます。
らしいが、&#XXXX形式は解釈されなかった。<U+XXXX>は有効だった。
Escaping special characters in PlantUML | Jawira blog
noteのブロックの先頭に'を書きたい場合、コメント扱いされてしまう。
<U+0027>でユニコード文字表記にすれば回避できる。
21 共通コマンド
General and common command to handle graphic layout in diagrams.
コメント
- シングルコメント: シングルクォート'で始まる行はコメント。
- ブロックコメント: C言語と同様だが/' '/ で囲む。
タイトル
title タイトル title end title
タイトル部分は\nで改行できる。他にブロック形式だと改行を含められる。
キャプション
captionでキャプション。
フッターとヘッダー
footer/headerブロック。
凡例
legend/end legend
21.9 メインフレーム
mainframe This is a **mainframe*
タイトルみたいに枠で囲んでくれて見た感じがよくなる。
25 前処理
25.5 プロシージャー [!procedure, !endprocedure]
テキストを出力する。
25.6 return関数 [!function, !endfunction]
マクロの扱い [脱W〇rd, 脱E×cel, 脱@st@h : #14 - messyなkitchenなブログ]
過去の!define相当。テキストの値として使う。
Umbrello
Problem
altなどの重なり順番、アクティブの下になっちゃう
optの条件が表示されない。
Papyrus
Tutorial
公式の[A slide-ware tutorial on Eclipse Papyrus usage for starters (2010-10-01)]を参考に基本的な使い方を学ぶ。
[File]-[New]-[Papyrus prooject]
これでプロジェクトを作ると、以下が [Project Explorer] に作られる。
- <project name>
- <project name>
- di: ツールメタデータ。モデル作成のエントリーポイント。
- notation: 画像データ。
- uml: UMLモデルデータ。
- <project name>
このdiをダブルクリックして描画を開始する。
1個のプロジェクトでいろんな図に対応していて、モデルを流用できる形になっている。悪くない。これを使う。
画面構成
- Project explorer
- Model explorer: 一番重要。ここでモデル全体をツリーベースで管理する。
- Outline view: アウトライン
- Main toolber: ツールバー。
- Perspective: Model explorerの内容を使って作図する領域。
- Property view: モデルのエディター画面。
Model explorerがPapyrusの本質。ここでクラスとかインタラクションを定義しておいて、この定義をperspectiveの作図に使うイメージ。
クラス図やシーケンス図もModel explorerに所属していて、好きなだけ作れる。[New diagram]から作れる。
[New Child] でいくつか重要なモデルがある。
- Package: ディレクトリ・フォルダーみたいなもの。これで他のモデルをまとめて整理できる。
- Interaction: シーケンス図表現用のモデル。
- Class: クラス。Interactionの型だったりする。UMLのベースで非常に重要。
Class
属性表示
クラス図にクラスモデルを配置しても、プロパティーやメソッドが表示されない。
右クリック-[Filters] で制御できる。
- [Synchronized with Model] を選ぶと同期されて全部表示される。基本はこれで、一部だけ表示したい場合にここを外すのだろうと思う。
- [Show/Hide Contents] で表示可否をチェックボックスで選べる。
Modelへのジャンプ
クラス図などからオブジェクトのModel Explorerの元データにジャンプしたいことがある。
オブジェクト右クリック-[Navigate]-[Go to ...]-[Model Explorer] を選ぶ。
Comment
https://chatgpt.com/c/67aec9f8-6be0-800b-b6eb-6300425ad1d4
メソッドなどにコメントを入れたいことがある。このコメントがわかりにくい。
[Properties]-[Comments]-[Owned comments]-[Body] に入力する。初回+で作ったダイアログのBodyに入力したものは反映されなくて、一度空のコメントを作った後に、洗濯後横のBodyに入力すると反映される模様。
- Applied comments=他のモデルのコメントを取り込みたい場合に使う。
- Owned comments=自分自身のコメント。コメントに対してコメントをつけることもできるので、[Create a new Comment] はさらに [Comments] タブを持っている。このタブがコメントのコメント。基本は使う必要ない。
[Annotated element] でたぶん、Bodyに入力したコメントを複数の要素に適用したい場合の適用先だと思う。
Sequence diagrams
https://eclipse.dev/papyrus/resources/PapyrusTutorial_OnSequenceDiagrams_v0.1_d2010100.pdf
2.2 Adding messages (basic - asynchronous)
コミュニケーションは、メッセージの交換で描写される。
メッセージはoperationCall (同期/非同期) かsignal (非同期) コミュニケーションとして表現される。
synchronousCall作成時は、replyMessageも期待される。
createMessageとdeleteMesageの指定は、ライフラインの動的な有無を意味する。
Papyrusでのメッセージ作成は以下の手順で構成される。
- パレットからツールを選択。
- ソースLifelineの開始点をクリック。
- ターゲットLifelineの終了点をクリック。
- ポップアップの該当するsignal/operationを選択。
記法
- 非同期メッセージは中抜き矢尻 (arrow head)。
- 同期メッセージは塗りつぶし矢尻。
- 返信メッセージは波線 (dashed line)。
- オブジェクト作成メッセージは波線+中抜き矢尻。
- Lost Messageは黒丸矢尻。
- Found Messageは黒丸矢柄。
2.2.1 Select desired tool from the palette
- Message SyncとMessage Replyは [Execution Specifications] がないと使えない。
- Message createはターゲットポイントが存在時に使用可能。
2.2.2 Select source and target points
ソースとターゲットポイントは2の異なるライフライン (通常) か、同じライフライン (再帰) が選択可能。
ターゲットポイントの制限は、対象の要素に依存する。例えば、Synchronous CallはExecution Specificationから始まる必要がある。
2.3 Adding execution specification
ここまでのシーケンス図では、通信シナリオだけを想定してきた。が、実際には、完全な実行トレースを表現できる。Execution Specification (ES) は実行を表す抽象概念で、Action Execution SpecificationとBehavior Execution Specificationの2種類がある。
PapyrusではライフラインにESをセットして行う。ESをセットしたら、同期メッセージを追加できる。
開発プロセスでは、予備設計では全メッセージを非同期とみなしておいて、設計時にESを設定して、同期メッセージをする感じ。
ただ、同期メッセージは、応答メッセージが入ってごちゃごちゃする。単にシーケンス図を書くだけなら、非同期で全部書いてもいいと思う。
Undoで破損
シーケンス図を作成して、削除のUndoを何回かやると、データが破損して開けなくなる。対応方法不明。GitでPapyrusのファイルを管理しておいて、破損に対応しておいた方がいい。
再帰自己呼び出しシーケンス図
シーケンス図の描画に癖があるので、方針を固めて使用する。
- 自己関数の呼び出しはMessage Async/Message Reply。Message Syncは期待通りに配置されないので、自己関数には使わない。他のライフラインには使う。
- 関数の呼び出し期間はAction Execution Specificationを配置。
- 矢印の端にESを配置する形にする。
オブジェクトの移動
オブジェクトの移動に癖がある。基本的に、メッセージは始点、終点で別々に移動させるしかない。まとめて選択して一括移動ができない。
終点を移動させると、その下のオブジェクトも追随する。追加はこれで対応できる。減らすのは手間になる。
シーケンス図が大きくなりすぎないように注意する。
Coding
タイムゾーン
3文字形式は避けたほうが無難。
タイムゾーン名で判定する実装があるので、UTC-9なども避けたほうがいい。
tz databaseのAsia/Tokyoなどの確実性が高い。
Regular Expression
正規表現。重要。覚えにくいが重要なものをメモしておく。
BRE
BREs Matching Multiple Characters
複数文字に一致するBREを作成する記法 (量指定子) がある。
単一文字、部分式、後方参照のいずれかに一致するBREの後に、'\{m\}', '\{m,\}', '\{m,n\}' の形式の配置で、指定回数の連続に一致する。
- mとnの範囲: 0<=m<=n<={RE_DUP_MAX}の範囲の10進数。
- mは最小出現回数、nは最大出現回数。
- \{m\}: m回出現
- \{m,\}: m回以上
- \{m,n\}: m-n回出現
例: abababccccccdに対する"c\{3^}"は7-9文字目でマッチ。
*
|
{0,} と同じ
|
+
|
{1,} と同じ
|
?
|
{0,1} と同じ
|
POSIXクラス
言語によって、アルファベット順が違うことがある。エストニア語ではsの後にzがあり、[a-z]では全ての英字にマッチしない。ロケールに依存する。
これの排除のために、文字の区分を定義している。
| POSIXクラス | 対応正規表現 | 意味 |
|---|---|---|
| [[:upper:]] | ||
| [[:lower:]] | ||
| [[:alpha:]] | ||
| [[:alnum:]] | ||
| [[:digit:]] | ||
| [[:xdigit]] | ||
| [[:punct:]] | ||
| [[:blank:]] | [ \t] | スペースとタブ。 |
| [[:space:]] | [ \t\n\r\f\v] | スペースとタブ+改行類。 |
| [[:cntrl:]] | ||
| [[:graph:]] | ||
| [[:print:]] |
特に以下が重要。
- [[:alnum:]]
- [[:space:]]
[:X:]が[]内で使える構文の扱い。組み合わせる場合、[[:upper:]ab]という感じで外側各括弧に収める。
ERE
基本はBREと同じ。エスケープ\が不要になっている。
多くのプログラミング言語などでは、EREが基本。grep -E相当。
PCRE
EREをさらに以下で拡張したもの。
- POSIXクラスの拡張表現の文字クラス
- 量指定子の追加構文 (+ ?)
- 言明/assertion
量指定子/Quantifiers
? 0 or 1, greedy
?+ 0 or 1, possessive
?? 0 or 1, lazy
* 0 or more, greedy
*+ 0 or more, possessive
*? 0 or more, lazy
+ 1 or more, greedy
++ 1 or more, possessive
+? 1 or more, lazy
{n} exactly n
{n,m} at least n, no more than m, greedy
{n,m}+ at least n, no more than m, possessive
{n,m}? at least n, no more than m, lazy
{n,} n or more, greedy
{n,}+ n or more, possessive
{n,}? n or more, lazy
{,m} zero up to m, greedy
{,m}+ zero up to m, possessive
{,m}? zero up to m, lazy
BRE/EREで登場した量指定子。デフォルトではgreedy (貪欲) マッチで、最長マッチ。
量指定子の末尾に?で最短マッチ (lazy)。
量指定子の末尾に+で独占的 (possessive)。マッチを消費する。処理の高速化になる。
言明/assertion
言明 (assertion) はカレントマッチング位置の直前・直後の文字に対するテスト、条件付け。文字を消費しない。テストのみ。
if文相当。直接マッチしないで、条件へのマッチ。マッチ対象文字を消費しない。
正規表現内で、if文相当の条件判定する際に使用する。
BREの段階で^$ (アンカー/anchor) があった。これの大幅拡張。
例えば、フォームの検証で「特定文字種が含まれていること」+9-12文字のような複数の条件指定を実現できる。
複雑な言明はサブパターン (言明サブパターン/assetion subpattern) を用いる。カレント位置の先と後とで2種類ある。
anchors
^ start of subject
also after an internal newline in multiline mode
(after any newline if PCRE2_ALT_CIRCUMFLEX is set)
$ end of subject
also before newline at end of subject
also before internal newline in multiline mode
simple assertions
\b word boundary
\B not a word boundary
\A start of subject
\Z end of subject
also before newline at end of subject
\z end of subject
\G first matching position in subject
LOOKAHEAD AND LOOKBEHIND ASSERTIONS
(?=...) ) (*pla:...) ) positive lookahead (*positive_lookahead:...) ) (?!...) ) (*nla:...) ) negative lookahead (*negative_lookahead:...) ) (?<=...) ) (*plb:...) ) positive lookbehind (*positive_lookbehind:...) ) (?<!...) ) (*nlb:...) ) negative lookbehind (*negative_lookbehind:...) )
肯定否定。=で肯定、!で否定。
- (?: 先読み。言明の次、右側を判定。
- (?<: 戻読み。言明の前、左側を判定。
先読み言明 (lookahead assertion)
例えば、以下のパターンはセミコロンが後に続く単語にマッチする。
\w+(?=;)
言明は複数同じ場所に配置可能で、AND条件になる。ORにしたかったら、(?<=abc|abde) のように選択肢にする。
以下はbarが後ろに続かないfooにマッチする。
foo(?!bar)
以下はfoo以外の後のbarではない。
(?!foo)bar
全部のbarにマッチする。この言明の直後の3文字がbarの場合、(?!foo)が常に真になるから。
言明の先読みは、基本は右端に配置する。右端の後に何か続ける場合、\w+とか使う。言明自体は文字を消費しないから、言明部分をカバーできるタイプの文字クラスの併用が必要。
echo preg_match('/foo(?=bar)\w+$/', 'foobar.'); # 0
Case
後ろからマッチ。cが置換対象。
/[^c]*$/
cより右端
マッチの前後の挿入
https:/vim.fandom.com/wiki/Power_of_g
:g/GST_.*("/s/^/LOG(INFO) << "DEBUG";/r/
行頭・行末で引っ掛ける。
関数にログ
:%s/([^")]*)/) /([a-z]* /)*{/&/rLOG(INFO) << "/1";/r/g
考慮するケース
double currentTime() const override { return m_element->currentTime(); }
フォーム検証
https://grok.com/share/c2hhcmQtMw%3D%3D_0c3a03bf-35f1-4594-a5d8-21673072ada5
英字と数字がそれぞれ1文字以上、かつ9-12文字。
戻読み言明と量指定を併用する。
$password = "123456333d78"; // テスト用のパスワード
$options = [
'options' => [
'regexp' => '/^(?=.*[[:alpha:]])(?=.*\d).{9,12}$/'
]
];
if (filter_var($password, FILTER_VALIDATE_REGEXP, $options)) {
echo "パスワードは有効です。";
} else {
echo "パスワードが条件を満たしていません。";
ただ、filter_inputだと検証失敗の理由まで特定して取得できない。面倒だが1個ずつやるしかない。関数化すれば1回で済む。
glob
重要。正規表現とは似ているが異なる、パターンマッチング記法 (Pattern Matching Notation)。主に、globで採用されており、ディレクトリー・ファイルのマッチングで使われる。
使用可能な記号は以下3個。以下の3文字は\でエスケープできる。
- ?: 任意の1文字にマッチ。
- *: 任意の0以上の文字にマッチ。
- [: []内の1文字にマッチ。正規表現の各括弧と同じ。ただし、先頭の否定が^ではなく、!。
ファイル名マッチ時には、追加で特殊なルールがある。
.から始まるファイル名へのマッチには、.が必要。つまり、*?は先頭の.にはマッチしない。[!a] のような否定形の各括弧記法も.にはマッチしない。加えて、先頭の[.]もマッチするかは不定(unspecified)。
globで.ファイルを含めたい場合、工夫が必要 (PHP: glob - Manual)。
.[!.]* *
上記のように.ファイルのマッチとそれ以外を指定する必要がある。
.[!.]* は、.と..以外の..始まりのファイルにマッチする。
.*を指定すると、./..がマッチするので注意する。最近のシェルは、シェル側で気を利かせているようで、.*だと. /..はマッチしない。
引用符のネスト
シェルやプログラミング言語で、文字列リテラルの表現などで、一重引用符'と二重引用符"を使う。
JSON作成や変数展開などで、これらをネストさせたいことがある。その基本的な考え方を整理する。
交互にしていい場合は簡単二重。引用符内に一重引用符を配置、一重引用符内に二重引用符を配置すればいい。
問題はこれがNGな場合。特にありがちなのが、JSONの生成。JSONの引用符は二重引用符のみ。一重引用符の中だと、二重引用符の変数展開が使用不能。外側を二重引用符にする必要がある。
二重引用符は、内部で変数展開が可能。この都合で、バックスラッシュ\によるエスケープが有効。
基本的な方法。
- 既存の一重/二重引用符などをバックスラッシュでエスケープ。
- 全体を一重/二重引用符で囲む。
何かAwkの本か何かで、基本的な考え方の説明の記載があった気がする。
[{"ke\y":"valu\e"}] を例として考える。
- {"ke\y":"valu\e"}
- エスケープ: {\"ke\\y\":\"valu\\e\"}
- 全体囲み: "{\"ke\\y\":\"valu\\e\"}"
これでOK。また何か考慮不足があればそのときに考える。
ただ、元データに修正が必要なので、そのまま行きたい。ヒアドキュメント的なものが使えるならそれを使うのがいい。
例えば、シェルなら、catコマンドとコマンド置換で生テキストを使える。
echo $(cat <<-'EOT'
{"ke\y":"valu\e"}
EOT
)
.envなどで使える技?いや使えない。.envではシンプルなコマンドしか使えず、ヒアドキュメントは使えない模様。
- How to escape double quotes in JSON - Stack Overflow
- python - How to handle double quotes in JSON value? - Stack Overflow
JSONのvalue部分に適用したい場合。データの二重引用符をバックスラッシュでエスケープする。これはこうするしかない。JSONが二重引用符しか認めないから。
基本的な考え方がある。
- JSON value用に二重引用符"を\"で置換。
- \"がPHP/JavaScriptで二重引用符に扱いにならないように、\を\\に置換。
- JSON項目の二重引用符"を\"で置換。
- 全体を二重引用符"で囲む。
こういう感じ。JSONはawkでも任意の最終データで考える。途中にプログラミング言語でのパースがあるので、それを考慮する必要がある。
ケース変換
javascript - camelCase to kebab-case - Stack Overflow
キャメルケースをチェインケースにしたり、逆にしたりなどケース変換したいことがある。正規表現を駆使して実現する。
encode
【PHP入門】URLエンコードする方法(urlencode) | 侍エンジニアブログ
日本語や記号を他のコードに変換 (エンコード) する方式が何通りかある。把握しておくと役立つ。
- パーセントエンコーディング/URLエンコード: URLで使用不能な文字を%16進数で連結。
- UTF-8
- base64: 全データを「A-Z」「a-z」「0-9」「+」「/」の64文字で表現。文末に=を使うので実質は65文字。
- HTMLエンコード: HTMLで特殊な意味を持つ文字を<などに変換する。
Percent-encoding
- パーセントエンコーディング - Wikipedia
- Percent-encoding (パーセントエンコーディング) - MDN Web Docs 用語集: ウェブ関連用語の定義 | MDN
- RFC 3986 - Uniform Resource Identifier (URI): Generic Syntax
unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
上記文字はエンコードの対象外。
英数変換
string - PHP How to encode all characters with rawurlencode - Stack Overflow
変数名への変換などで、日本語や記号を英数字 [0-9a-zA-Z] に変換したいことがある。
こういう目的だと%エンコーディングが適している。
ただし、一部の記号を許可しているので、自前で変換する。
function encode_all($str) {
$hex = unpack('H*', $str);
return preg_replace('~..~', '%$0', strtoupper($hex[1]));
}
$str = 'big ƒüßchen';
print_r(encode_all($str));
Term
紛らわしい用語がある。
- ミドルウェア: 名前通り中間のソフトウェア。DBやアプリケーションサーバーなどが該当。単独で動作が重要なポイント (ミドルウェアとは何か?代表的な製品や使用例とあわせて解説! - サックルMAGAZINE、ミドルウェアとは?アプリ・システム開発との関係・仕組み・役割・具体例を解説【2024年最新版】 | システム幹事)。
- フレームワーク: 単体で動作しない。アプリ開発のテンプレート。Django/Ruby on Rails/Vue.jsなど (【3分ITキーワード】 フレームワークとライブラリの違いは? - ペンタPRO:ペンタセキュリティが提供するセキュリティ情報まとめサイト)。
- ライブラリー: 単体で動作しない。よく使われるコードの集まり。機能単位。jQuery/Numpy/matplotlib/Qtなど。
フレームワークの中にライブラリーも含めていいと思う。
「Pythonのモジュールとパッケージとライブラリとフレームワークの違い」がわかりやすい。
フレームワークはライブラリーを含んでいる。ライブラリーで共通でいいと思う。
Category
ソフトウェアの分類、ページ分類時に役立つ。
- 言語
- ツール: 静的解析、テスト、文書など。
- フレームワーク
MediaWikiのページ名は全体で固有が条件なので、言語名+分類名でページを作るといい。
例
- PHP language
- PHP tool
- PHP framework
成功時連続継続処理
一度の取得件数の上限が決まっていて、終了・失敗するまで取得を継続したいという処理がそれなりに発生する。
- 処理実行。
- 成功ならA、失敗なら終了。
- 処理実行。
- 成功ならA、失敗なら終了。
こういうパターン。いくつか実装方法があるが、while (true) のパターンが重複がなくてベストだと思う。
/*
// 無限ループで終了条件でブレイク
while (true) {
// 処理実行
if (失敗) {
break;
}
成功時処理
}
// do while
do {
処理実行
if (成功時) {}
} while ();
// for (初期化; 継続判定・終了判定; 成功時式) {
処理実行
}
*/
do-whileは成功・終了判定を2回書く必要がある。
forだと成功処理を式でしか書けない。成功処理を関数や即時実行関数式などで書くなら悪くはないし、ベストになりえる。
いや、成功時処理内の処理の結果次第で反復の終了条件などが追加で入るならNGになる。なので、やっぱりwhile(true)が無難。コード行数もそんなに変わらない。
これにさらに初回だけ、ヘッダーの取得、書き込み処理などが発生する場合、初回だけループの外でやるのがきれいだろうか?初回処理が2回登場することになるけれど。
offsetなどで初回の判定が反復内でできるから、それで分けるのがいいか?
$offset = 0;
while (true) {
$currentReturnCode = $service->sendRequest(Raku2Config::API_TYPE_CSV_EXPORT, Raku2Config::CONFIG_API_URL_MULTI_API, [
json_encode([
'dbSchemaId' => $table_info['dbSchemaId'],
'offset' => $offset,
'limit' => $limit,
])
]);
$response = $service->getApiResultJson();
// 終了条件: 戻り値が成功以外、か応答本体が1行 (ヘッダーのみ) の時。
if (($currentReturnCode !== Raku2Config::EXIT_SUCCESS) || (substr_count($response, "\n") <= 1)) break;
// 2回目からはヘッダー除去して書き込み。
$start = strpos($response, "\n") + 1;
$flat = FILE_APPEND;
if ($offset === 0) {
$start = $flag = 0;
$path = stream_get_meta_data($fp = tmpfile())['uri'];
}
file_put_contents($path, substr($response, $start), $flag);
$offset += $limit;
sleep(3);
}
for ($offset = 0;
($currentReturnCode === Raku2Config::EXIT_SUCCESS) && (substr_count($response, "\n") > 1);
(function() use (&$offset, $limit, $response) {
// 2回目からはヘッダー除去して書き込み。
$start = strpos($response, "\n") + 1;
$flag = FILE_APPEND;
if ($offset === 0) {
$start = $flag = 0;
$path = stream_get_meta_data($fp = tmpfile())['uri'];
}
file_put_contents($path, substr($response, $start), $flag);
$offset += $limit;
sleep(3);
})()
) {
$currentReturnCode = $service->sendRequest(Raku2Config::API_TYPE_CSV_EXPORT, Raku2Config::CONFIG_API_URL_MULTI_API, [
json_encode([
'dbSchemaId' => $table_info['dbSchemaId'],
'offset' => $offset,
'limit' => $limit,
])
]);
$response = $service->getApiResultJson();
}
character
BOM
UTF-8のBOM
\xef\xbb\xbf
この文字を先頭につけるとUTF-8のBOMになる。
Convert
IP/CIDR
// JavaScript
/**
* サブネットマスクをIPアドレス形式 (x.x.x.x/255.255.255.0) からCIDR形式 (x.x.x.x/24) に変換する。
* @param {string} ipaddress - IPアドレス文字列 (x.x.x.x/x.x.x.x形式)。
*/
toCIDR(ipaddress) {
const [address, mask] = ipaddress.split('/')
const segments = mask.split('.')
const CIDR = segments
.map((e) => Number(e).toString(2))
.join('')
.replace(/0*$/, '').length
return address + '/' + CIDR
},
/**
* サブネットマスクのCIDR形式 (24) をIPアドレス形式 (255.255.255.0)に変換する。
* @param {number} cidr - ciderの数字。
* @return {string} x.x.x.x形式のIPアドレス文字列。
*/
cidrToIp(cidr) {
const digit = 32
const ip = ('1'.repeat(cidr) + '0'.repeat(digit)).substr(0, digit)
return ip
.match(/.{8}/g)
.map((e) => parseInt(e, 2))
.join('.')
},
Algorithm
再帰処理
https://chatgpt.com/c/673d9bfe-2414-800b-9922-f94be6dbe950
配列の配列、オブジェクトのオブジェクトなど、再帰的な構造はけっこう遭遇する。
再帰関数で実装するほかに、スタックで処理する方法がある。
再帰関数のほうが簡単に実装できるが、関数呼び出しのオーバーヘッドがある。ネスト10-100程度くらいなら問題ない。
パフォーマンスや再帰中の細かい制御が必要なら、スタックが有利。ただし、実装がやや複雑。
最初は再帰関数で実装して、後でボトルネックになったらスタックというのも手。
https://chatgpt.com/c/6745228f-8b20-800b-8a41-bdaece8c03f5
再帰関数とスタックの他に、JSONなどの文字列にシリアライズして、文字列処理で対応するという手もある。
JSONPath/XPathなどの方法もあるが、基本的には外部ライブラリーが必要。
シンプルなケース以外は、再帰関数で処理したほうが結局シンプルな感じがする。
Other
コメントの著者名
https://chatgpt.com/c/67469d8d-7e64-800b-b82d-8c74f4e13c08
GNU socialのソースコードのコメントに著者名が大量にあった鬱陶しい。
大規模プロジェクトになると、編集者が膨大になる。VCSに任せて、本文には記載しなくていいと思う。
git blameで行単位で編集者が分かる。
確率処理
https://chatgpt.com/share/68145e5c-9d14-800b-9cca-1cd9e46e2dd6
ある確率で処理をしたり、しなかったりしたいことがある。
$chance = 30; // 30%の確率
if (mt_rand(1, 100) <= $chance) {
// 30%の確率でここに入る
echo "当たり!";
} else {
// 70%の確率でこっちに入る
echo "はずれ...";
}
乱数を作成して、それで確率値の超過判定で表現できる。
Architecture
About
https://grok.com/share/c2hhcmQtMw%3D%3D_d762a384-9703-4539-b8e7-022bc680d88f
- MVC
- MVVM
- クリーンアーキテクチャー
このあたりが有名。MVCが一番無難。MVCでは厳しいような大規模になったら、他を検討する価値がある感じ。
Clean Architecture
クリーンアーキテクチャー。最近よく聞く設計手法。
「Clean Coder Blog」で2011-11-22にRobert C. Martinによって提唱さえたアーキテクチャー。ソフトウェアの開発・展開・運用・保守を簡単にして、プログラマーの生産性の最大化が目的。
多くのアーキテクチャーでは、関心を分離して、異なる役割や責務を分離して、変更の影響を最小限にしている。これの実現に、ソフトウェアをレイヤー (層) に分けている。クリーンアーキテクチャーは、このアイデアの1個のガイドラインになっている。
中心にビジネスルールがあって、玉ねぎのように、中心から外に向かって、層構造になっている。
- エンティティ: ビジネスロジック (ドメイン層)。外部の影響 (FWの更新など) に影響を受けない。
- ユースケース: アプリのビジネスルール。interface adapterから受け取ったデータをもとに、entityのビジネスロジックを組み合わせて、アプリ特有のロジックを実現。
- Interface Adapter (Controller/Gateway/Presenter): 外部システムと内部システムのデータを変換する。例えば、コントローラーはリクエストをUsecaseが利用できる形式に変換 (4->2) し、プレゼンターはユースケースの出力を外部システムが理解できる形式に変換 (2->4) する。
- Framework/Driver (DB/Device/Web Framework/UI/外部Web API): WebアプリケーションFW、DBなど。外部エージェントとの通信処理。基本的にはライブラリーやFWを使う。
基本はこれだけ。
既存のMVC型アプリをクリーンアーキテクチャーにする場合の対応。
- Controller: Interface adapter
- Model: Entity (domain/repository interface)
- View: Framework
たまねぎの層構造の表現は、ディレクトリーの親子関係で表現できるときれいなんだけど。層ごとでグループ化したり、継承したりする場合に、ディレクトリーを作れなくて困る。大規模になるならなおさら。
中小規模や、うまく分割してきれいにまとめられるならあり。
一般的には、機能を最上位において、その下で4の層をディレクトリーで配置するというのが多い模様。
src/
└── Article/
├── Domain/
├── Application/
├── Interface/
└── Infrastructure/
SSR+CSR
About
https://chatgpt.com/c/6747e923-6174-800b-8816-dd741721de45
バックエンドとフロントエンドの分離の話。
SPA (Single Page Application) やJAMStackの影響で、バックエンドはデータを返すだけで、画面描画はフロントエンドが全部する (CSR) というのが最近の流行。
SSR (Server Side Rendering) とCSR (Client Side Rendering) の違い。フロントエンドの高度化や分業などが理由とのこと。
SSRの利点。
- SEO
- 初期表示。
- 匿名。
SSRの課題。
- サーバー負荷: データとHTML作成を同時に行うから。
- 分散困難:
キャッシュの活用がポイントになるとのこと。
リダイレクト
https://chatgpt.com/share/6886c2c2-b5cc-800b-8e03-e301c22d5eff
CSRでやる場合、最終的にCSRの成果物をstaticに生成して、それをサーバー側のpublicに配置する感じになる。
npm run generateの生成先をpublicに直接してもOKだと思う。いや、これは既存のindex.phpとかが消えるのでまずい。シンボリックリンクにするとか。
1台でフロントとサーバーの両方を扱う場合、/apiなどサーバーリクエストに使うURLはindex.phpに、それ以外はindex.htmlなどにするようなリダイレクト設定が必要。
以下のようなイメージ。
<IfModule mod_rewrite.c>
<IfModule mod_negotiation.c>
Options -MultiViews -Indexes
</IfModule>
RewriteEngine On
# Handle Authorization Header
RewriteCond %{HTTP:Authorization} .
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
# Send Requests To Front Controller...
RewriteCond %{REQUEST_URI} ^/(api|sanctum)(/|$)
RewriteRule ^ index.php [L]
# Nuxtのビルド済み静的ファイル (_nuxt/) は除外
RewriteCond %{REQUEST_URI} ^/_nuxt/
RewriteRule ^ - [L]
# RewriteCond %{REQUEST_FILENAME} !-f [OR]
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^ - [L]
RewriteRule ^ index.html [L]
</IfModule>
Naming
Code
camelCase
https://gnusocial.jp/notice/7694551
!it 命名規則のキャメルケース。これ英語前提です。関数名に英語以外を使うと破綻します。
getキーバリュー()みたいな関数の定義。日本語ですると境界がわからなくなるので、getキー_バリューみたいにアンダーバーで区切ったほうが分かりやすい。なるほど…
getMyVariable() vs myVariable()
- naming conventions - PHP methods: getMyVariable() vs myVariable() - Stack Overflow
- Which Coding convention to follow for PHP? - Stack Overflow
getterとsetterの命名規則。
getVar()にするか、Var()にするか。C++だと後者のパターンがあったりする。getを省略できるので、省スペースになる。
ただ、コード補完で探しやすさがちょっと変わる。getを前置したほうがわかりやすいか。
namePrefixed() vs prefixedName()
https://chatgpt.com/c/673bd358-3dc8-800b-8ec9-d745cc0eba85
名詞+修飾語 (形容詞) の場合のメソッドの命名規則。name+修飾語が複数ある場合name+修飾語がいい。オブジェクト指向でnameをオブジェクトとして扱う形に近い。name.methodみたいな。
例えば、nameMax、nameMinのような場合は後ろのほうが都合がいい。ただ、こういう場合はそもそもnameをオブジェクトにしてname.max()、name.min()にしたほうがいいという説がある。
そうではないならば、getPrefixedName()などが自然。getQueryString()など。StringQueryではない。
PHPでは以下のような命名規則が好まれる。
- 動詞+修飾対象=getPrefixedName/isPrefixed()
- 修飾対象+状態/修飾語=prefixdName
getPrefixedNameがいいか。後置修飾にしたいならば、そもそもオブジェクト+メソッドにすることを検討する。
map
連想配列とかハッシュ、オブジェクトなどでキーバリュー形式のデータ構造を扱うことがある。そういう変数の命名規則。
map_[key]_[value] のような形式にすると、キーとバリューが何を意味するか分かってわかりやすい。
https://chatgpt.com/c/67ca84e0-9018-800b-9674-035ae9f4bbaf
- [key]_[value]_map
- [key]_to_[value]
上記のどちらかがいいだろう。toがkey_valueの区切りが明示的でいいかもしれない。
array/foreach
foreach系のfor文ではキーとバリューを変数に格納して反復する。ファイルや配列に対して行うことが多い。
foreach (table as $row => $line)
その際の変数名は、上記のように$row/$lineにすると、行番号と行の値がはっきりしてわかりやすい。
いいえ。これは問題がある。ネストした場合などに命名規則を維持できない。
- 配列、コレクション類: 複数形があるなら複数形。困ったらListの接尾辞。
- 反復時。キーバリュー形式の場合、単数形_key/_value。valueだけの場合、単数形。また、_valueは単数形でもいいかもしれない。
上記の命名規則だとわかりやすい。
$rows = [[]];
foreach ($rows as $row_key => $row_value) {
foreach ($row_value as $column_key => $column_value) {}
}
foreach ($row_list as $row_key => $row) {
foreach ($row as $column_key => $column) {
}
}
foreach ($rows as $row_index => $row_value) {
foreach ($row_value as $column_index => $column_value) {
}
}
value部分に単数形を使うと、検索時にkey部分もヒットして、作業しにくいかもしれない。基本はkey/valueの接尾辞がよいと感じる。
もっというなら、接尾辞の文字数が揃うので、keyよりindexのほうがよいかもしれない。ただ、indexは添え字の数字の意味合いが強いので、やっぱりkey/valueでいいか。
Function argument order
関数の引数は入力、変更、出力の順番にする。理由はこの順番で使うから。
https://social.senooken.jp/notice/67270
うーん。今晩は,CODE COMPLETEでC言語の関数の引数の順番を調べたりしていて,勉強時間がないな…
int func(入力,変更,出力)
この順番。理由は,この順番で使うから。
memcpyとかは例外が多い。
x = bの語順からきているからとの憶測がある。
https://okwave.jp/qa/q4202225.html
get/fetch
https://chatgpt.com/c/67bd1a05-d3a0-800b-88d8-f4f47b995560
- fetch=外部から取得する意味。DBや外部Web APIから取得する場合にfetchがいい。
- get=手元から取得する意味。プロパティーなど内部から取得する場合。
list/data
fetchList/fetchDataのどちらがいいか?
- list=配列。必ず配列。
- data=全部。配列以外にnullや単一データがあるならこちら。
基本はfetchListでいいと思う。
Order
https://chatgpt.com/c/67ca7edf-f92c-800b-8174-9706bfba3ff3
関数実行の順番が大事なときと、そうでないときがある。区別し難い。
順序を明示したい場合、メソッドチェーンを使うのが確実。
他に、前の関数の結果、戻り値を後続の引数に渡すなら、それも悪くない。
privateの先頭_
privateなメソッド、プロパティーで、先頭に_をつけることがある。
https://chatgpt.com/c/67da92b1-1650-800b-b347-f16f76fd549a
privateのアクセス権、可視性の機能があるなら、それを使えばいいので、_は不要。むしろないほうがいいらしい。PHPのPSR-12では禁止されている。
「PSR-12: Extended Coding Style - PHP-FIG」
Property names MUST NOT be prefixed with a single underscore to indicate protected or private visibility. That is, an underscore prefix explicitly has no meaning.
Pythonのように、言語的にないなら、やむを得ない。
PHPは昔privateがなかったので、そういう古いコードとの一貫性の維持が目的なら、先頭_もあり。
配列の要素数
https://chatgpt.com/c/67ecd6ff-b06c-800b-8f44-cfeb9c5768bb
配列の要素数、長さを変数に格納して使うことがけっこうある。その際の変数名。
オブジェクト指向に従うなら、配列名_size/countの接尾辞がいい。
C++のvectorなどのコンテナーだと.size()でとれる。変数に格納せずにsizeでいい。
変数にあえて代入するならば、配列名_sizeが自然。
ただ、PHPだと、countで要素数を取得する。その都合で、_countがよい。
item_list = []; item_list_size item_list_count
例外前提関数
https://grok.com/share/c2hhcmQtMw%3D%3D_359ae291-e39d-42cd-9a8f-e6453b388993
APIのパラメーターチェックとかで、チェック関数を何個も書くなら、例外を投げる形にして、それを補足する形が楽になる。
$result = $this->locationCheck($mbrcode, $latitude, $longitude, $ostype);
if ($result['status'])
return ['message' => $result['message'], 'status' => $result['status']];
$result = $this->isCheckedIn($mbrcode);
if ($result['status'])
return ['message' => $result['message'], 'status' => $result['status']];
$store = $this->isStoreNearby($latitude, $longitude);
if (!$store['status'])
return ['message' => $result['message'], 'status' => self::STATUS_STORE_NOT_FOUND];
$result = $this->addPoint($mbrcode, $ostype, $store['pattern'], $store['shpcode'], $store['point']);
if (!$result['status'])
return ['message' => $result['message'], 'status' => self::STATUS_ERROR];
try {
$this->locationCheck($mbrcode, $latitude, $longitude, $ostype);
$this->isCheckedIn($mbrcode);
$store = $this->isStoreNearby($latitude, $longitude);
$this->addPoint($mbrcode, $ostype, $store['pattern'], $store['shpcode'], $store['point']);
} catch (Exception $e) {
return ['status' => $e->getCode(), 'message' => $e->getMessage(), 'point' => 0];
}
関数の戻り値を都度if文でチェックする必要がなくなってスマートになる。
そういう、例外前提関数の名前。isXXXとかにするとboolを期待する。
assertXXXにするとわかりやすい。assertは例外を投げたり、中断するイメージがあるから。
validateだとどっちもありえるからわかりにくい。
条件のbool変数・関数化
https://grok.com/share/c2hhcmQtMw%3D%3D_dabd40dd-e42b-44be-931c-b1cc18425c5d
if文の条件式の内容は、複雑になるなら基本的に変数・関数に括り出して適切な名前を付けたほうがいい。
コメントで記載することもできるが、コメントが古くなるリスクがある。
拡張子、サンプルファイル
https://grok.com/share/c2hhcmQtMw%3D%3D_d3c100c1-f1be-47c4-8f36-1710af04a2c1
app/config.php.sampleのように、アプリのデフォルト設定をファイル末尾に追記する形でファイルを用意することがある。これの是非。
基本は、app/config.sample.phpのように、拡張子は意味のあるものにする。
Webアプリの公開ディレクトリーなどで、誤動作を抑止するなら、拡張子を明示的に分ける意味がある。
が、他のアプリや構文強調などはファイル拡張子で判断するので、普通は困る。
Other
Document
設計文書を作成する際、MS Word系で作るのが無難。
画面系の設計の場合、1画面に入りきらないかもしれないが、部分ごとに分割画像にして、1ページに画像と説明を併記する形にして、縦に長い文書にするほうが管理しやすいと思う。
ExcelやPowerpointで1枚丸ごとにしてい気持ちもあるが。だったら、Figmaとかそういうデザインツールとか、Inkscape/LibreOfficeDrawとかだろうか。
ただ、やっぱり目次とか欲しいからMS Word系がいいと思う。
Atomic Design
最近のUIのコンポーネントの組み方。UIコンポーネントを粒度に分けて、ディレクトリー分けして流用するという考え方。
- atoms: 原子。これ以上分割不能な最小単位。input/label/buttonなど。
- molecules: 分子。atomsを組み合わせたり、atomsに多少修正したもの。入力フォーム、ナビゲーション、カードなど。
- organisms: 有機体。分子+アルファ。入力フォーム+ヘッダーなど。複数の分子。
- templates: テンプレート。複数の有機体。ヘッダー、メイン、フッターなど。
- pages: ページ。テンプレートを使用したページ。
インターフェイスと抽象クラス
オブジェクト指向でよく登場するインターフェイス、抽象クラス、クラスの違い。
- インターフェイスは、クラスに複数実装できるが、抽象クラスは1つしか継承できない。→不特定のクラスで、共通のメソッドを定義したい場合。
- インターフェイスは、実装のあるメソッドを持つことができないが、抽象クラスは、実装のあるメソッドを持つことができる。→抽象クラスは、複数のクラスの、共通処理の中に、一部違う処理が入る場合、プロパティーが必要な場合などに使用する。
インターフェイス
- メソッド宣言のみ。
- static/constの場合に限定して、メソッド定義、定数もOK。
- 多重継承可能。
- tagのイメージ。
例えば、複数のクラスで共通の処理がある場合、その共通部分をInterfaceにして、それを継承すると良い。その部分だけ取り出して流用できる。
例えば、[Animal<-Duck] のような関係がある時、Duckは空も飛べるし、泳ぐこともできるとしたら、飛べることと泳げることの機能はAnimalの中でも対応がわかれる。こういうところをInterfaceにしておくと、振る舞いを統合できる。
抽象クラスは一部共通にしたい場合に使う。Interfaceは指定機能を全部共通。
ベースは抽象クラス、クラスにしておいて、複数クラスで共通にしたい場合interfaceで定義するときれいに実装できる。
Config class
- c++ - Best practice for creating a 'global' config class used by numerous components - Software Engineering Stack Exchange
- Best way to provide configuration parameters for objects far away from the starting point - Software Engineering Stack Exchange
- design - Config Class/Struct: Pattern or Anti-Pattern? Alternatives? - Software Engineering Stack Exchange
- json - Best practice/design pattern for working with a config file - Software Engineering Stack Exchange
アプリケーションの設定を管理するクラスの設計方法。いくつか方法があり、議論がある。「Best way to provide configuration parameters for objects far away from the starting point - Software Engineering Stack Exchange」で特によく議論されている。
- シングルトン/グローバル変数: ただし、テストなどで並列アクセスが必要な場合に困ることがあるらしい。
- DI/設定クラス引数: これがよく支持されている。テストしやすいなど。グローバル変数への参照を渡すようなイメージ。ただし、依存性の伝播のように、上から下に設定を渡す際に、関係ない大量の設定を渡すことがあったりする。
2のDIが最近の主流。引数で値渡し相当にすれば、並列アクセス時も無影響。伝播の問題は設計の問題。
メソッドをmain関数で呼び出すことを想定して、必要なものだけ渡るようにして、余計なものは削除する。上位・下位の関係を明確にすれば、渡すだけのパラメーターを排除できる。
do-while/if
複雑なif文と相性がいい。
for whileの無限ループで最後にbreakでも同じか
do {
if (true) break;
} while(false);
if文が複雑な場合、do-whileで囲んで、breakでスキップできる。gotoに近い。
GoF
基本的に、具象クラスを使わずに、インターフェイスや抽象クラスを使ってインスタンスを生成するというのが、共通する基本パターン。
これにより、いろんなケースに同じコードで対応できる。
23パターンある。23パターンのうち16パターンは言語サポートで単純化か除去できる。
- 生成5個
- Abstract Factory
- Builder
- Factory Method
- Prototype
- Singleton
- 構造7個
- Adapter
- Bridge
- Composite
- Decorator
- Facade
- Flyweight
- Proxy
- 振る舞い11個
- Chain of Responsibility
- Command
- Interpreter
- Iterator
- Mediator
- Memento
- Observer
- State
- Strategy
- Template Method
- Visitor
特に頻出パターン
- Strategy
- Observer
- Decorator
- Factory Method
- Adapter
- Singleton
このほかに、アーキテクチャーごとに、パターンがある。
- Repository: DDD、クリーンアーキテクチャー。Adapterパターン内部で使っているデータ保持用の役割。
Factory Methodパターン
なぜあんなに難しい?Factory Methodパターン - ecbeing labs(イーシービーイング・ラボ)
コンストラクターの代わりに、インスタンスを生成 (工場=factory) となるメソッドを使うから、FactoryMethodパターン。
引数の内容に応じて、異なるクラスを作成する。
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
// Creatorに相当する
abstract class ListPrinter {
// anOperationに相当する
public void printList(List<String> list) {
}
// factoryMethodに相当する
protected abstract Comparator<String> createComparator();
}
// ConcreteCreatorに相当する
class DictionaryOrderListPrinter extends ListPrinter {
@Override
protected Comparator<String> createComparator() {
return new DictionaryOrderComparator();
}
}
// ConcreteCreatorに相当する
class LengthOrderListPrinter extends ListPrinter {
@Override
protected Comparator<String> createComparator() {
return new LengthOrderComparator();
}
}
// メインクラス
public class FactoryMethodSample {
public static void main(String args[]) {
List<String> list = Arrays.asList("いちご", "もも", "いちじく");
System.out.println("五十音順で表示:");
new DictionaryOrderListPrinter().printList(list);
System.out.println("長さ順で表示:");
new LengthOrderListPrinter().printList(list);
}
}
return new <Class> 的なことをするメソッドのパターン。
- オブジェクトの生成処理を1か所に集約できて、生成処理が複雑な場合 (前準備や引数が多い場合など) 使う側をシンプルにできる。
- 条件によって別の子クラスを返したり、キャッシュを使ったりできる。
ただ、Factory Methodパターンを採用すると、コード量が増えて複雑になる。
Factory MethodとAdapterを併用すると、OSごとやDBの違いを吸収することができる。
https://chatgpt.com/share/6876fa52-d850-800b-81f0-78bb0d44a7ba
FactorySelectorみたいなクラスで、createAdapter的なので、違いを隠蔽して取得するとよさそう。
Adapterパターン
重要。FWやライブラリーを抽象化するパターン。
XxxAdapterというクラスを作って、特定のメソッド経由で、目的のクラスにアクセスする。
interface ProductPrice{
public int getPrice();
}
class Product{
private int cost;
public int getCost(){
return cost;
}
}
class ProductAdapter extends Product implements ProductPrice{
public int getPrice(){
return this.getCost();
}
}
継承の他に、移譲 (Adapter内でのインスタンス生成) でも実現できる。DIと相性がいいかもしれない。
interface ProductPrice{
public int getPrice();
}
class Product{
private int cost;
public int getCost(){
return cost;
}
}
class ProductAdapter implements ProductPrice{
private Product product = new Product();
public int getPrice(){
return product.getCost();
}
}
上記では、Product.getCost (製品価格) をProductAdapter.getPriceのメソッド名でアクセスする。既存のクラスを一切変更することなく、getPriceという別のメソッド名で、目的のメソッドにアクセスする。
例えば、Windows/Mac/Linuxのように、異なるOSでOSのバージョン番号を取得するような場合、Adapter経由でアクセスすれば、同じメソッド名で異なるOSのAPIにアクセスできる。FWやライブラリーのバリエーションの違いを吸収できる。
OOP
継承とtrait
https://chatgpt.com/c/67cea053-9f50-800b-b22f-67aea7ac0dfe
apcとstaticのキャッシュクラスがあって、それとは別にビジネスロジックの共通化をしたい場合、いくつか方法がある。
- apc と static を統合した親クラスで trait を use し、子クラスで継承する
- apc と static を子クラスで直接継承し、trait を use
- 継承(extends)ではなく、キャッシュクラスを別のクラスとして利用する という考え方です。
依存注入(DI)・継承・trait の使い分けまとめ
https://chatgpt.com/c/67cea053-9f50-800b-b22f-67aea7ac0dfe
キャッシュやORMのような、切り替え可能な機能の場合、DIで実装してプロパティーに格納して使うのが使いやすい。DIはテストのしやすさに勝る。
継承は親子関係が明確な場合。
コンストラクターのアクセス権
基本はpublicだが、privateとprotectedを指定する場面がある。デザインパターンと関係している。
https://chatgpt.com/c/67fdac9a-2fac-800b-91bf-460c10fd72f5
- protected: 継承先のみ。ベースクラスや抽象クラスで使用する。ベースクラスや抽象クラスは継承を前提とするから、直接インスタンス生成してほしくないから。ファクトリーパターンと組み合わせる。
- private: クラス内部のみ。シングルトン・ユーティリティー (静的ファクトリーメソッド専用クラス) 系クラスで、インスタンスを作って欲しくない、1個だけのように、インスタンスの生成数を制限したい場合。
例外の扱い
https://chatgpt.com/share/68118e39-40d0-800b-9bd8-43da8908bfcd
DBアクセス系のメソッドは例外を基本的に出す。
DBアクセス系メソッドを使って、特定のデータを取得するようなメソッドを使った場合に、例外をどこで処理すべきかという話。
現代的なフレームワークだと、アプリのエントリーポイント (index.php) などにtry-catchが1個あって、そこで自分で処理しなかったらデフォルトの例外処理で処理する形になる。
なお、try-catchは並列実行、マルチスレッド環境では問題があったりする。
throwにコストがかかる。だから、頻繁に失敗するような処理は、try-catch (throw) を使わない形で実装したほうがいい。リアルタイム性や超ハイパフォーマンスが必要なところとか。
PHPはリクエスト単位で、プロセス・スレッド起動する設計になっている。ApacheやFPMがそういう動作になっているから。だから、マルチスレッドは考えなくていい。並列実行は、別リクエストみたいな扱い。
APIに複数アクセスする場合、curl_multiで1プロセスでうまくやる方法があるらしい。
関数戻値と例外
https://chatgpt.com/share/6833c48c-ce58-800b-a4d7-f389d15167e9
関数が失敗した場合に、戻り値nullで返すか、戻り値false相当で返すか、例外で返すかという議論。
例えば、配列を返すようなメソッドで、処理失敗時に空配列ではなくて、nullを返して失敗を表すか、あるいは例外で返すべきかという議論。
nullの代わりにデータ型でboolになる値を返す (配列なら[]、数値系なら0、文字列なら'')。
| 項目 | 利点 | 欠点 |
|---|---|---|
| ブール | 型が同じなので扱いやすい。 | 失敗と結果を厳密に区別したいときに、できないことがある。 |
| null | 失敗と結果を厳密に区別可能。 | 使う側で常にnullチェック必要。 |
| 例外 | 型を統一でき、失敗も区別できる。 | エントリーポイントにtry/catchがないとtry/catch地獄。 |
基本は型は同じで、どうしても処理失敗の区別が必要なら、例外にする。これにするとシンプルで融通がきく。
例外にする内容。
- 処理続行が不能な場合 (DBアクセス失敗)。
- ビジネスロジックで意図的に続行不能にしたい場合 (想定外の頻繁アクセス、保安対策?)。
- 期待と異なる場合 (1件取得できないといけないのにできないとき)。
DI
https://chatgpt.com/share/682e8fd6-376c-800b-a01e-faa832b0fd07
Dependency Injection。主にテストしやすさを向上させるための手法。
クラスやメソッド内部で、他のクラスを使う場合、コンストラクターや、メソッドで該当クラスを受け取って、プロパティーや変数として参照する。クラス (依存性) を外部から渡す (注入) すること。
こうすることで、該当メソッドのテスト時に、中で使用する外部クラスを外部から置換できる。これにより、テスト対象メソッドの処理だけをテストできる。
DIの注入方法で2通りある。
- コンストラクターDI: public/protectedメソッド向き。一般的にDIという場合これ。
- メソッドDI: privateメソッド向き。特定メソッドだけでしか使わない場合、あまり使わない場合。
使用する外部クラスが複数ある場合、DIでその分指定する。あまりにも数が多い場合、DTOやデリゲートなど複数クラスを保有するクラスを作って、それを引数に渡す。あるいは、依存クラスが多すぎる場合、設計に問題がある。適切に分割した方がいい
なお、メソッドDIにする場合、DI対象は引数の先頭の方に指定する。必須で省略不能だから。
DB
PDOの真の力を開放する - PHPでデータベースを扱う(3): Architect Note
DBアクセスのモデル化。行をクラスとする (entity/エンティティークラス) と扱いやすい模様。
getterを作ったり、データの妥当性のチェックなどもできる。
select/insert/などはmapperでクラスとDB列名を対応付けて処理する。自前で実装する場合はこういうつくりがいいらしい。
データベース関係のデザインパターンがいくつかある。
- Active Record
- Data Mapper
Active Record pattern
テーブルレコードに対応するクラスを用意して、そのクラス自体にDB操作もさせる。
シンプルだが、複雑な操作が苦手。
エンティティーがテーブルと密接なため、例えばテーブル構造が変わった場合に大量に修正必要。
Ruby on Rails/Laravel+Eloquentなどで採用。
Data Mapper pattern
第14回 DataMapperの使い方 | gihyo.jp
テーブルのレコードをクラスにするのはARと共通。
ただし、DB操作用のクラスを用意してそちらでDB操作する。
その都合、1テーブルに2クラス必要。
User/UserMapperのような対応関係。
2クラス必要だが、テーブル構造が変わった場合でも基本はMapperで吸収できる。
JOIN
Active RecordもData MapperもJOIN時の扱いが一番重要。単一エンティティーしか扱わないならどちらも同じ。
基本はエンティティーのプロパティーに持たせる感じ。
datamapperパターンでjoinする場合、エンティティーの扱いはどうなるの?
`DataMapper`パターンで`JOIN`を行う場合、エンティティの扱いは設計次第ですが、いくつかの注意点があります。`DataMapper`パターンは、データベースのテーブルとエンティティの間にマッピングを行い、エンティティはドメインロジックを持ち、データベースアクセスの責務を持たないことが特徴です。そのため、`JOIN`の処理をどの層で行うかを慎重に設計する必要があります。
以下、`JOIN`を行う際のエンティティの扱いと実装方法について解説します。
- 1. マッパークラスでの`JOIN`実装
`JOIN`を伴う複雑なクエリが必要な場合、マッパーが直接`JOIN`を使って複数テーブルを組み合わせた結果を取得し、それを複数のエンティティとしてマッピングする方法があります。例えば、ユーザーと注文を持つシステムで、ユーザーとその注文を一緒に取得したい場合、`UserMapper`で`JOIN`を行い、結果セットを`User`と`Order`エンティティに分割してマッピングします。
```python
class UserMapper:
def find_user_with_orders(self, user_id):
sql = """
SELECT * FROM users
JOIN orders ON users.id = orders.user_id
WHERE users.id = %s
"""
results = self.db.execute(sql, (user_id,))
user = User(results[0]['user_id'], results[0]['user_name'])
orders = [Order(row['order_id'], row['product_name'], user) for row in results]
user.orders = orders
return user
```
この方法では、1つのSQLクエリで必要なデータをすべて取得し、エンティティのプロパティにそれぞれのデータを設定します。
- 2. リポジトリでの集約
`JOIN`を使わず、各エンティティを個別に取得した後、リポジトリが集約の役割を担う方法もあります。リポジトリが各エンティティの`Mapper`を呼び出し、必要なエンティティ同士を関連付けることで`JOIN`を再現します。例えば、まず`UserMapper`でユーザー情報を取得し、次に`OrderMapper`で該当ユーザーの注文を取得してエンティティ間で関連付けます。
```python
class UserRepository:
def __init__(self, user_mapper, order_mapper):
self.user_mapper = user_mapper
self.order_mapper = order_mapper
def get_user_with_orders(self, user_id):
user = self.user_mapper.find(user_id)
orders = self.order_mapper.find_by_user_id(user_id)
user.orders = orders
return user
```
UserテーブルとOrderテーブルがあって、あるユーザーの注文一覧を取得したい場合を考える。
結局、user.ordersみたいな感じで、エンティティーに外部テーブルのレコードを配列で持たせるつくりになる。
クロス集計する場合は、users[0].orderみたいな感じ。メインのエンティティーのプロパティーに持たせる。フラットじゃないのでちょっと気持ち悪い。が、まあ構造としてこうなるのは順当。
方法として、1回のSQLで取得するか、それぞれのエンティティーを取得してマージするか。1回のSQLでやったほうが当然いい。
Other
1対1-多対多
プログラミング言語でデータの関連付けをすることがある。
1対1の場合、配列、連想配列のキーバリュー形式のデータがぴったり。
多対多の場合。これも配列。二次元配列で基本は0要素目など。
$array[][]
1対多
https://chatgpt.com/share/683faf08-f374-800b-ac40-b96b427d7365
例えば、DBからデータを取得した場合など、1行のデータに複数列あって、列を特定したい場合、連想配列で、バリューをさらに連想配列にするのが普通。ただ、1:1ならただの連想配列でよかったのが、連想配列の配列になるのがイマイチ。
['row1' => ['col1' => 'value1', 'col2' => 'value2']]
いくつか方法がある。
- ネスト連想配列。無難。
- 連想配列の代わりにオブジェクト。これができるならこれが素直。
- 連想配列の代わりにリスト。ただし、列の意味が分かりにくい。foreach ($map as $interface => [$property, $defaultClass])
- 値部分を意味のある文字列で使うところで分割とか。
手短にしたいなら、3のリストになるかも。
レガシープロジェクトの立て直し
https://chatgpt.com/c/67481a93-adc0-800b-81c4-20d763133002
1. 現状分析
(1) ソフトウェアの動作確認
現在の環境でアプリケーションを動作させる。
どの部分が機能していて、どこが問題かを確認する。
必要であればエラーログを確認する。
(2) 依存関係の調査
アプリケーションのライブラリやフレームワークのバージョンを調査。
サポートが終了しているもの、互換性が失われたものを特定。
(3) コードベースの状態評価
コードの品質 (可読性、設計、テストカバレッジ) を確認。
セキュリティリスクを特定する (例えば、脆弱性が放置されていないか)。
2. 計画立案
(1) ゴール設定
具体的な目標を設定 (例: パフォーマンス改善、保守性向上、セキュリティ強化)。
(2) 優先順位の決定
どの機能を維持し、どの機能を削除または置き換えるか決定。
ユーザーに直接影響を与える部分を優先。
(3) リスク評価とバックアップ
修正に伴うリスクを評価し、現行システムのバックアップを取得。
3. 環境整備
(1) 開発環境のモダナイズ
ローカル環境やコンテナ (Docker) を用意してテストを容易にする。
CI/CD パイプラインの整備。
(2) 依存関係の更新
サポートされていないライブラリやフレームワークをアップグレードまたは置き換える。
(3) セキュリティの確保
古いOSSの脆弱性を修正。
HTTPSの導入、認証強化、インプット検証など。
4. コードのモダナイズ
(1) リファクタリング
レガシーコードをよりモダンで可読性の高いコードに変換。
デザインパターンを適用して保守性を向上。
(2) テストの追加
ユニットテスト、統合テストを導入。
既存の機能が壊れないことを確認するための自動化されたテスト。
(3) フロントエンド/バックエンドの分離
必要に応じてモノリシック構造を分離し、モダンなアーキテクチャ (SPA、Microservices など) に移行。
5. 機能拡張とデプロイ
(1) 新しい機能の追加
必要に応じて、現代のニーズに合った新機能を実装。
(2) 運用環境でのテスト
新しい環境で徹底的にテストし、問題がないことを確認。
(3) 本番環境にデプロイ
ロールバック計画を準備しつつ、安全にデプロイ。
6. 継続的改善
(1) モニタリングの導入
エラーログやパフォーマンスを監視し、迅速に対応できる仕組みを導入。
(2) 定期的なアップデート
フレームワークやライブラリを継続的に更新し、レガシー化を防ぐ。
(3) コミュニティへの貢献
OSSとしての性質を活かし、変更内容をコミュニティに共有することでフィードバックを得る。
このプロセスを通じて、安定した動作を保ちながら徐々に近代化することが可能です。特に、「現状分析」と「環境整備」をしっかり行うことで、後続の作業がスムーズになります。
AI
対話AI
About
List
【2024年版】対話型AIサービスおすすめ11選を徹底比較!チャットボットとの違い・メリット・課題・選び方なども紹介 - NotePM
いろいろある。
| Name | |||
|---|---|---|---|
| Bing | |||
| Perplexity AI | |||
| ChatGPT | |||
| Google Gemini |
書きかけ送信
https://grok.com/share/c2hhcmQtMw%3D%3D_ca8dab5f-1012-4dd4-841f-7340186071d7
書きかけの状態で誤送信することがある。
元の質問を編集するのではなく、続きに「これが正しいです」とか書いて送信すると、AIが認知して対応してくれるらしい。
編集すると、ややこしくなる。
Grok
Xアカウント
https://x.com/i/grok/share/oeybkVEqzC4NNpH8whCdM7pl7
grok.comのgrokはスタンドアローン。x.com/i/grokはXアカウントを考慮する。後、xのほうは制限が厳しめ。
grok.comにXアカウントでログインできる。その場合、多少Xアカウントを考慮したりする。が、設定でオフにもできる。
Xアカウントでログインでいい気がする。
感想
https://grok.com/share/c2hhcmQtMw%3D%3D_abb58ded-75b5-470e-a6c3-586a53904071
ChatGPT
Plan
Free/Plusの2のプランがある。
| Free | Plus | |
|---|---|---|
| 金額 [USD/月] | 0 | 20 |
| 機能 | 基本 | アーリーアクセス |
| エンジン | GPT-4o mini | GPT-4/GPT-4o/GPT-4o mini |
| 制限 | - | GPT-4oの5倍以上のメッセージ送信 |
| その他 | - | データ分析、ファイルアップロード、ビジョン、Webブラウジング |
| 画像生成 | - | DALL-E |
送信可能なメッセージ数、エンジン、画像生成などが大きな違いだろう。
Account
公式サイトにアカウントの意味の説明がない。しかたないので、ChatGPTに質問。
ChatGPTに会員登録する意味は何ですか?
ChatGPTに会員登録する主な利点はいくつかあります。1. **パーソナライズされた体験**: 登録すると、あなたの好みや過去のやり取りに基づいて、よりカスタマイズされた応答が得られます。
2. **履歴の管理**: 過去のチャット履歴を保存し、いつでも見返すことができるため、情報の確認が簡単になります。
3. **新機能へのアクセス**: 登録ユーザーは新しい機能やアップデートを優先的に利用できる場合があります。
4. **プレミアム機能**: 一部のサービスでは、会員登録をすることで、より高度な機能やサポートが提供されることがあります。
5. **セキュリティとプライバシー**: アカウントを持つことで、データの管理やプライバシーの設定をより細かく調整できます。
興味があれば、ぜひ登録を検討してみてください!他に質問があればお知らせください。
自分の過去の質問の履歴を見れるだけでも便利かも。
方法
質問の分割
https://chatgpt.com/c/673bdc0d-e0e0-800b-a22b-4fa19e64476c
Q. chatgptで質問するとき、連続して質問すると、同じURLで複数の質問が表示される。リロードして質問を分けたほうがいいのか?
A. どちらでも問題ない。が、質問が関連しているなら同じチャットで継続したほうがいい。直前の質問も文脈を考慮できる。完全に話が異なるなら分けたほうが後で整理したり、URLを共有したときにわかりやすい。
感想
2024-11-14 Thu
https://gnusocial.jp/notice/7806505
!it !ai 業務でPHPの開発作業をしていて、ChatGPTを使いだして便利に感じています。検索エンジンの代わりに使っています。
例えば、「laravel eloquentでリレーション先のテーブルの主キー名の取得方法は?」と質問します。
https://chatgpt.com/c/67354314-fbdc-800b-a4e4-65f96d1a8fb2
getRelatedというややマニアックなメソッドを教えてくれます[eloquent getrelated] で検索してもなかなかたどり着けないです。
こういう検索エンジンで検索しにくい質問で便利だなと思います。
検索エンジンで検索すると、的外れな情報も大量にヒットします。対話AIはそのごみの混ざった検索結果を分析した結果をコンパクトに返してくれます。対話AI使わなくても、検索エンジンで時間かければわかりますが、大幅に時間短縮できます。
大量の凡人健常者が取り組んだ方法論として決まりきったものは、記憶の問題、ただの神経衰弱です。こういうのを検索エンジンの改良版としてAIに任せるのはいい使い方だと思います。
個人的に、ただの知識、事実は重要度高くないと思いますが、一般社会では評価する側の頭が悪いので、これが重宝されます。
同僚や先輩に聞くより対話AIのほうがよほど頭いいです。話すことないです。聞くほうが時間の無駄なので。凡人はどんどん要らなくなります。
一方、私みたいなキチガイのデータは少ないので、検索エンジンやAIに聞いても出てこないです。世界で自分だけのオリジナルに専念するのがたぶんいいです。
2024-11-19 Tue
https://gnusocial.jp/notice/7867350
!ai ChatGPTが検索エンジンの改良版としてやっぱり便利。さっきこういう質問しました。
phpのメソッド名で、英単語の修飾語は前と後ろどちらがいい?例えば、namePrefixed()とprefixedName()のどちらがいい? https://chatgpt.com/c/673bd358-3dc8-800b-8ec9-d745cc0eba85
私はこのレベルの細かい疑問がすぐ浮かぶのです。これを人間にきくと、頓珍漢な回答だったり、そもそも回答してもらえないし、何ならこういう質問した私がなぜかキチガイ扱いされて、微妙な雰囲気になって、質問できなくなって、ストレスが溜まって、居づらくなって早期退職になるんです。意味不明です。ただの質問にお気持ちの配慮とか面倒なので。
この間、 @yuriha に突っ込まれた件も、たぶん対話AIとお互い会話したほうが有意義だったんじゃないかとすら思います。相手も私に突っ込む前に対話AIと会話したほうが自分の主張の自己矛盾、頓珍漢さに気づけたんじゃないかとすら思えます。私が突っ込んでまーた私がキチガイ扱いされるのも回避されます。対話AIからの客観的な指摘なら、同じ内容であっても、キチガイの私が言うより納得しやすいでしょう?同じ内容なら対話AIのほうが凡人健常者にとっては、信じ込みやすいでしょ?
対話AIだとお気持ちの配慮いらないし、当たり前ですけど、キチガイ扱いされることもないので、快適です。元々対話AIには懐疑的でしたが、どちらかというと私のようなキチガイが凡人健常者の知識を拝借するためにあるような印象を持ちます。
検索エンジンでも調べることはできますが、めちゃくちゃ時間かかるんです。自分で複数の意見をみつけて、頭の中で比較検討して整理するので。これを一瞬でやってくれるのが楽。途中のデータ整理、目視は単純作業に近いのです。他のことに頭使えます。
もはや技術とか、ただの暗記の神経衰弱は別にいらないです。一般企業の上長とか、士業のように、単純知識でマウント取るタイプの仕事はこれで確かに駆逐されます。どうせ対話AIのほうが賢いのだから。知識量で勝てるわけないです。全世界の情報の集積結果なんだから。
凡人健常者の知識を拝借して、世界でだれにも真似できないキチガイ部分に専念できます。GNU socialの開発もこれでいけると思います。
AI Coding
AIコーディング:「Vibe Coding」からプロフェッショナルへ
雰囲気だけを伝えて、AIにアプリ開発を任せる手法。一切自分でコーディングしなくてもアプリ開発可能。
Shell
2 Shell Command Language
2.9 Shell Commands
2.9.2 Pipelines
pipelineは|で区切られた1以上のコマンド群のこと。標準出力を次のコマンドに接続する。
パイプラインの書式は以下となる。
[!] <command1> [ | <command2> ...]
予約語の!がなければ、最後のコマンドの終了ステータスがpipeline全体のステータスになる。!があれば、ステータスの否定になる。つまり、0なら1、0超過なら0になる。
パイプラインだが、ifやtest以外のどこでも使える。
ただし、対話シェルだと!は履歴置換になることがあるので注意する。
2.9.4 Compound Commands
Case Conditional Construct
case word in
[(]pattern1) compound-list;;
[[(]pattern[ | pattern] ... ) compound-list;;] ...
[[(]pattern[ | pattern] ... ) compound-list]
esac
- 未マッチで終了ステータス0。
- pattern部分: シェル展開が有効。他はglob。
- |でOR検索相当。
- 最後のパターンの;;は省略可能。if文のようにも使える。
- 全パターンの捕捉は最後に*。空でもマッチする。?は最低1文字必要。
BREでは未対応な|のORマッチに対応しているのが最大の特徴。文法なのでコマンドを実行せず早い。grepを使わずにできるだけこちらを使ったほうがいい。
ワイルドカード
ワイルドカードで.始まりのファイルをマッチさせたい。
以下ならマッチするが、ブレース展開 (brace expansion) はPOSIX shでは使えなかった気がする。
echo {.*,*}
BOM
unicode - Adding BOM to UTF-8 files - Stack Overflow
ExcelでUTF-8ファイルを開けるように、UTF-8のBOMをファイルにつけたい。
printf '\xEF\xBB\xBF' > with_bom.txt
上記コードでBOMを最初に書き込んで、後は追記する。
Command
awk
The Open Group Base Specifications Issue 7
変数
特別
- NF: 列数。列の全表示などで使う基本的で重要な変数。
- NR: 行番号。
スコープ
関数の仮引数のみ、ローカル変数扱いで、それ以外はグローバル変数。
文/statement
- actions
- if/else
- while/do...while/for
- break/continue
- delete
- next
- exit
- output
- printf
関数
組込関数
- Arithmetic
- atan2
- cos
- sin
- exp
- log
- sqrt
- int
- rand
- srand
- String
- gsub
- index
- length
- match
- split
- sprintf
- sub
- substr
- tolower
- toupper
- I/O
- close
- getline
- system
print/printfは関数ではなく、statement/文扱い。
ヘッダー出力、列別最大長さ出力。
awk -F, '{if(NR==1) print $0} {for(i=1; i<=NF; ++i){if (line[i] < length($i)) line[i] = length($i)}} END {for (i=1; i<=NF; ++i) {printf line[i]","}}' data/101542.csv
CSV
シェルスクリプトの実験のために作った POSIX 準拠 awk 実装の CSVパーサー (RFC4180対応) #ShellScript - Qiita
# csvparser.awk
## Usage
# awk -f csvparser.awk data.csv
# CSV の論理的な一行毎に呼び出されるコールバック関数(サンプル)
# row: 行番号(最初の行は1) len: フィールド数 fields: フィールドデータ
function callback(row, len, fields, col, field) {
for ( col = 1; col <= len; col++ ) {
field = fields[col]
gsub(/\\/, "&&", field) # \ は \\ にエスケープする
gsub(/\n/, "\\n", field) # 改行は \n にエスケープする
print row ":" col " " field
}
}
BEGIN { row = max_idx = 0 }
{
idx = 0
sub(/\r$/, "")
while ($0 != "") {
if (match($0, /^(["]([^"]|["]["])*["]|[^,"]*)(,|$)/)) {
fields[++idx] = ""
} else if (match($0, /^["]/)) {
fields[++idx] = substr($0, 2)
for (;;) {
if (getline == 0) exit 1
sub(/\r$/, "")
if (match($0, /^([^"]|["]["])*["](,|$)/)) break
gsub(/["]["]/, "\"")
fields[idx] = fields[idx] "\n" $0
}
fields[idx] = fields[idx] "\n"
} else {
exit 1
}
field = substr($0, RSTART, RLENGTH)
$0 = substr($0, RSTART + RLENGTH)
lastcomma = sub(/,$/, "", field) > 0
gsub(/^["]|["]$/, "", field) && gsub(/["]["]/, "\"", field)
fields[idx] = fields[idx] field
}
if (lastcomma) fields[++idx] = ""
while (idx < max_idx) delete fields[max_idx--]
callback(++row, idx, fields)
max_idx = idx
}
awkのCSVパーサー。先頭のBOMはあると認識できないので、tail -c +4でBOMを除外して使う。
tail -c +4 data/101543.csv | awk -f csvparser.awk
xargs
About
xargsは引数リストを構築して、コマンドを呼び出すコマンド。
標準入力から受け取った行を任意の場所に引数として配置して、後続のコマンドを実行する。並行実行とかもできる。
- -I replstr: 行のプレースホルダー文字列を定義。
- -t: trace mode。実行したコマンドを標準エラー出力に出力する。
ls -A "$1" | sed -e 's/"/"\\""/g' -e 's/.*/"&"/' |
xargs -E "" -I {} -t mv "$1"/{} "$2"/{}
複数コマンド実行
https://chatgpt.com/share/6811d6e4-3cdc-800b-946c-305f03df396d
echo "file1 file2 file3" | xargs -n 1 -I{} sh -c 'echo {}; ls -l {}'
sh -cでshの引数の文字列として構築する。こうしないと、内部の;がパースされてうまく解約されない。
Other
patch
文字化け
https://chatgpt.com/share/685cd841-d368-800b-b950-0afc82ea31de
iconvで文字エンコーディングをパッチ適用先ファイルに合わせてから適用する。
iconv -f UTF-8 -t EUC-JP <<'EOF' | patch -p1 --- oldfile.php +++ newfile.php @@ -1,3 +1,4 @@ +// これは日本語コメントです EOF
pager
lessのオプション
export LESS="-iMR"
- -i: 検索時に大文字小文字無視。
- -m: 表示中の%のステータスバーへの表示。
- -M: 表示中の行数・ファイル名などのステータスバーへの表示。
- -R: ANSI Color Escape Sequenceの解釈。
破損リンク
https://chatgpt.com/c/68088168-ac54-800b-b78e-e28743b81011
find path/to/scan -type l ! -exec test -e {} \; -exec rm {} \;
find path/to/scan -type l ! -exec test -e {} \; -print
binary
POSIX準拠のシェルスクリプトでバイナリデータを扱う #Bash - Qiita
バイナリーデータの読込はodコマンド。なければhexdump。
書込はprintf。
head/tailの-cはPOSIXで使えたか?
root
リダイレクト出力
sudo権限でリダイレクト処理を行ってファイルに書き込む方法
リダイレクトはログインユーザーの権限でなされるらしく、root権限のある場所にファイル出力できない。
teeコマンドでやる。
pwd | sudo tee out.dat
teeコマンド実行する側でsudoが必要。
ログインシェルの確認
第 10 章 動作環境のカスタマイズ (Solaris ユーザ ログインシェルはGUIログインでも内部的にある。ログインシェルが読みこむprofileファイルなどは、ログイン時に、1回だけ実行したい処理の記述場所として最適。 SHELL環境変数にログインシェルのパスが入っている。
echo $SHELL /bin/bash
OSの判別
OSTYPE環境変数に値があるのでこれで判別する。 例えば以下の値が入っている。
linux-gnu darwin23
これらを検知して判定する。
case $OSTYPE in linux*) echo 'linux';; darwin*) echo 'Mac';; esac
Configure
profile
bash の初期化ファイル .profile, .bashrc, .bash_profile の使い分けと管理方針 - A Memorandum
- bash_profile
- profile
- bashrc
環境変数など~/.profileに全部のシェルの共通設定を記述。
上記サイトではこういう方針でやっていた。
ログイン時に、bash_profileとかzprofileとかがなければ、デフォルトで.profileを読込むようになっている。
なので、.profile内で、実行シェルを変数で判定して、bashrcやzshrcを読み込むようにするといい。
上から下にする感じ。ubuntu 22.04のprofileがこういう作りになっている。
# if running bash, include .bashrc if it exists [ -n "$BASH_VERSION" ] && [ -f "$HOME/.bashrc" ] && . "$HOME/.bashrc"
.profileはログイン時に1回だけ実行すればいいから。
rc
rc=run configuration. 実行設定。
シェルごとにいくつかの設定がある。
Bash
Ubuntu Manpage: bash - GNU Bourne-Again SHell
--loginオプションの指定がある場合や、ログイン対話シェルとして呼び出されるかどうかで変わる。、
ログイン対話シェルの場合 (SSHも含む?)。
- /etc/profile があれば実行。
- ~/.bash_profile ~/.bash_login ~/.profile をこの順番で探して、最初に見つけたファイルを実行して終わる。
- シェル終了時か、非対話ログインシェルの場合、exitコマンド実行時に、~/.bash_logoutをあれば実行。
--noprofileオプションを指定した場合、上記の読み込みはしない。
非ログイン対話シェルの場合。
- /et/bash.bashrc ~/.bashrcがあればそれぞれ実行。
--norcの指定で上記も読み込まない。--rcfileで/etc/bash.bashrcと~/.bashrcの代わりのrcファイルを指定できる。
非対話シェルの場合、BASH_ENV環境変数を展開して、そのファイルを読み込む。
if [ -n "$BASH_ENV" ]; then . "$BASH_ENV"; fi
~/.profileをスクリプト実行時にも読み込みたい場合、bash_profileでこの環境変数を設定しておくとよいかも。
cmd.exe
Control block
for
あくまでコマンド。
nest
ネストはできない。二重ループしたければ、関数にしてそれを呼び出す。
bitsadmin
Windowsでのファイルダウンロードコマンド
Windows 7以降ではbitsadminコマンドがあり、これがwget相当となる。
書式:
bitsadmin /transfer <job name> <URL> <output path>
<job name>と<output path>は必須なので注意する。
certutil
Windowsでのハッシュの確認に使える。
certutil -hashfile file
SHA1 ハッシュ (対象 C:\moconavi\windows\Moconavi\ext\chromium\moconavium.exe): e0da85b04b6970ac1f0c33db7a9ad607fdbd44eb CertUtil: -hashfile コマンドは正常に完了しました。
rlogin.cmd
コマンドキーの送信を自動化できる?
rem rlogin.cmd @Echo off Set SERVER=192.168.0.0 Set USERNAME= Set PASSWORD= Cmdkey /generic:TERMSRV/%SERVER% /user:%USERNAME% /pass:%PASSWORD% Start mstsc /v:%SERVER% Timeout 5 Cmdkey /delete:TERMSRV/%SERVER%
実行中プロセスのパスの確認
出典: Show EXE file path of running processes on the command-line in Windows - Super User。
wmic process get ProcessID,ExecutablePath wmic process where "name='mysqld.exe'" get ProcessID, ExecutablePath wmic process where "name='mysqld.exe'" get ProcessID, ExecutablePath /FORMAT:LIST
簡易編集モード/挿入モード
- 【Tips】Windows 10のコマンドプロンプトが意図せず止まってしまう問題を回避する方法 | ソフトアンテナ
- Windows command prompt freezing randomly - Super User
Windows 10のcmd.exeは [簡易編集モード] が有効になっており、コマンドプロンプトを左クリックすると、テキストの選択が始まる。テキスト選択中はコマンドの実行が止まる。長時間かかるコマンドの実行中に誤操作で止まると困るので、これは無効にしたほうがよい。
cmd.exeを起動-左上のアイコンをクリック-[規定値]/[プロパティ]-[オプション]-[□簡易編集モード] を選ぶ。
そのほか、 git log のような制御が移るコマンドを実行してしばらくすると、操作できなくなる。
[□挿入モード] にすると回避できる模様。
Vim
vimdiff
2 つのファイルの差分を取る・マージする (vimdiff, vim -d) - まくまくVimノート
vimのdiff機能。ファイル同士の差分のチェック、マージで簡易的に使える。
diffモードで起動
vim -d <file1> <file2> vimdiff <file1> <file2>
起動中のdiffモード
:diffs[plit] <file> " 上下分割 :vert[ical] diffs[plit] <file> " 左右分割 :diffthis " バッファー同士
移動
- [c=前の差分に移動。
- ]c=次の差分に移動。
マージ
- dp=diff put。自分の内容を片方に反映。
- do=diff obtain。自分の内容に片方を反映。
Other
Async
https:/github.com/skywind3000/asyncrun.vim
asyncrun.vimは1個のバックグラウンド処理しか対応していない。
https://github.com/skywind3000/asyncrun.vim/issues/12
vim-dispatchならいけるのか?
Binary
vim-jp » Hack #133: バイナリファイルを編集する
grep
非同期でgrepする方法。
https://superuser.com/questions/861783/how-to-run-a-grep-in-vim-asynchronously
https://www.reddit.com/r/vim/comments/5ses2e/async_grep_in_vim_8/
Vim 8の非同期APIはプラグイン用。
* https://github.com/mhinz/vim-grepper
* https://github.com/skywind3000/asyncrun.vim
* https://github.com/tpope/vim-dispatch
https://wonderwall.hatenablog.com/entry/2017/10/09/210000
asyncrun.vimでやるのがよさそう。
AnsiEsc
* https:/unix.stackexchange.com/questions/444226/how-to-make-vim-interpret-escaped-characters-as-colors
* https:/superuser.com/questions/358409/how-can-i-tell-vim-to-show-ansi-escape-codes-properly
本家は太字に対応していないのでこちらがいいかな。
- https:/github.com/powerman/vim-plugin-AnsiEsc
ただし、こちらはgvimでクリック時にカーソル位置がずれる。
program
C
ワシのVimプラグインは百八式まであるぞ - daisuzu's notes
【C/C++】
87. a.vim
C/C++のヘッダとソースを切り替えます。
88. c.vim
C/C++のテンプレートやイディオムの入力をサポートしてくれます。
89. CCTree
cscopeを使って関数のコールグラフを表示してくれます。
90. Source-Explorer-srcexpl.vim
ソース解析ツール、Source InsightのVim版です。
91. trinity.vim
taglist, srcexpl, nerdtreeを同時に起動して
VimがIDE画面のような画面になります。
92. cscope-menu
cscope用のメニューを表示してくれます。
93. gtags.vim
gtagsを使ってファイルを開けます。
94. DoxygenToolkit.vim
Doxygenコメントの入力をサポートしてくれます。
Visual Studio Code
Keybind
矩形選択
Ref: VS Codeの矩形選択と矩形貼付の操作方法 - mito’s blog.
- s-alt-クリック
- c-s-alt-矢印
ジャンプ
- 括弧ジャンプ: C-S-\
Config
Default terminal
Ref: bash - Change the default terminal in Visual Studio Code - Stack Overflow.
[F1]-[Terminal: Select Default Profile]
cscope
cscope用のプラグインが何個かある。
scope4codeのほうがいろいろできそうだが、うまく動作しなかった。使い方がよくわからない。
cscope-codeはシンプルだが動作した。こちらを当分使うことにする。
Macの場合、control-. sのように、control-.の後に、controlを話してsを押すと発動する。カーソル下のシンボルしか使えない感じなのがネック。まあいい。
Vim
VSCodedでVimのキー操作を使うためのプラグイン。これが一番人気。いや、Vimのエミューレーターは中途半端な感じだから使わないほうがいいかな。
Extension
CSS
Tailwind CSS IntelliSense
PHP
Laravel Blade Snippets
PHP Intelephense
Ref: PHP Intelephense - Visual Studio Marketplace.
VSCodeのPHPの補完拡張として人気が高い。
Quick Start
設置後、しておくべき設定がある。
- Go to
Extensions. - Search for
@builtin php - Disable
PHP Language Features. LeavePHP Language Basicsenabled for syntax highlighting.
VSCodeの [PHP Language Features] を無効にしておくとのこと。
後は、.php以外の拡張子でPHPファイルがあれば、関連付けを追加するとか。
"files.associations": { "*.module": "php" }
Module
peclなどPHPの標準モジュールで一部認識できないものがある。
「php - Undefined type 'Imagick' in VSCode's intelephense - Stack Overflow」にあるように、そういう場合は [Settings]-[Stubs] で追加するとよい。
Coding
Ref: VSCode で PHP 開発するならインテリセンス最強の intelephense を使おう | 株式会社ビヨンド.
intelephenseでコード補完を認識しやすい書き方というのがある。
まず、型をつけられるものはつける。
function superMethod()
{
/** @var AwesomeService $awesomeService */
$awesomeService = $this->app->make(AwesomeService::class);
$awesomeService->awesomeMethod();
}
ローカル変数も型名を指定する。これをしないと、インスタンスでコード補完が効かない。
include Path
開発対象コードが、.envなどに記載の環境変数を前提として、動きになっていたりすることがある。そうなると、この環境変数を参照できないと、認識できない。
include Pathsに追加する。
他、.php以外の拡張子は基本的にinluce pathにあっても認識しない。"intelephense.files.associations":に拡張子を追加する。
Settings
Files: Insert Final Newlines
Resolve 'No newline at end of line' in GitHub | DevCoops
gitで以下の警告が表示される。
\ No newline at end of file
デフォルトでファイル終端に改行を挿入しないから。設定がある。
Settings-Files: Insert Final Newline
これをオンにすると、保存時に自動的にファイル末尾に改行を入れてくれる。設定しておくとよい。
Other
Remote
【WinSCPはもう不要?】VS Codeのダウンロード/アップロード機能が便利すぎる!! | マスクロドットコム
Visual Studio Code Remote Development
公式拡張機能のVS Code Remote Developmentを使うと、リモートファイルをVS Codeで開いて、ドラッグドロップでファイル送受信ができるらしい。
VSCodeのSSH接続機能で、RaspberryPi内のコードを編集してデバッグ #Python - Qiita
Remote Developmentをインストールすると、左サイドメニューに [Remote Explorer] のマークが追加される。これを選んで [REMOTE EXPLORER]-[Remotes (Tunnnels/SSH)]-[SSH]-[+]-メニューに [usrname@host] の形式で接続情報記入。
左サイドメニューの [SSH] の節に追加される。右の [Connect in New Window...] を選ぶ。
接続先マシンのPlatformをLinux/Windows/macOSから選ぶ。
Git
blame
行単位での最後の修正コミットの表示。標準であるが、デフォルト非表示になっている。
git.blame.editorDecoration.enabled: true
これで有効になる。が、いちいち表示されるのがうざいので、デフォルトfalseでいいと思う。
PhpStorm
Jump
- https://chatgpt.com/c/6799c4ec-7660-800b-ad5d-fbc37e16a1a5
- Source code navigation | PhpStorm Documentation
includeなどで参照しているファイルパスのファイルを開く方法がいくつかある。
- C-b
- C-LButton
- C-N/C-O でファイルを開いてファイルパスを貼り付け。
認識できないことがあるので3番目が汎用的。
Encoding
パス単位で文字エンコーディングを設定可能。
[PhpStorm]-[Settings]-[Editor]-[File Encodings] から行う。
Scratch
【New Year Calendar】君はPhpStormのScratch機能を知っているか #NewYearCalendar - Qiita
メモなどの一時ファイルの作成機能。
[File]-[New Scratch File] からファイル形式を選んで作る。困ったらMarkdownで良いだろう。
作成したScratchファイルは [Project]-[Scratches and Consoles]-[Scratches] に格納される。
矩形選択
複数のカーソルと選択範囲 | PhpStorm ドキュメント
方法がいくつかある。
- Cmd-Shift-8
- Option-Shift-Middle
Git
Gitツールウィンドウ
C-9か左下のGitマークを選ぶとGitツールウィンドウの表示になる。ブランチとコミットログが表示される。ここから右クリックを使ってブランチ間の比較などができたりする。
ブランチ比較
コードレビューなどでよく使うブランチ同士の比較。
まず現在ブランチを比較対象ブランチに変更しておく。
[Git]-[Branches]-比較対象ブランチ-[Compare with]
これで上下に画面分割して、それぞれのブランチで固有のコミットログの一覧が表示される。派生元と派生先があるならば、片方が空になる。違うブランチ同士のマージ用に、こういう作りになっていると思われる。
差分ファイル一覧を見るには、右側の変更ファイルペーンでC-aを選ぶ。変更のある全ファイルのリストが表示される。
他に、Gitツールウィンドウを開いて、コミットログで右クリック-[Compare with Local]を選ぶとローカルと対象コミットとの比較になる。これがわかりやすい。
ただ、基本は現在ブランチか、現在のワーキングツリーとの比較になる。現在ブランチを変更しておくのが基本になる。そこだけ押さえておけば、まあなんとか使えそう。
元ファイルオープン
差分ビューで差分チェック中に、シンボルや型定義などの確認で元ファイルを開きたいことがある。ジャンプ方法がある。
左上の [Jump to Source C-Down] の鉛筆マークを選ぶ。これでエディター側で元ファイルを開ける。
サブディレクトリー
PHPStormで親のGitリポジトリーの下に、子のGitリポジトリーのディレクトリーがある場合、親ディレクトリーのGitしか認識してくれない。
認識してくれる方法がある模様。
Gitのマルチリポジトリー機能を使うらしい。
[Settings]-[Version Control]-[Directory Mappings]-[+]
以下を選択して [OK] を選ぶ。
- ◉Directory: Git子ディレクトリーのパス
- VCS: Git
これで対象ディレクトリーを右クリックでGitを選ぶと良い模様。
Blame
行番号のところを右クリック-[Annotate with Git Blame] で行単位の修正履歴を表示できる。
- Annotate Revision: 現在の変更コミットを表示。
- Annotate Previous Revision: 前回のコミットの表示。
過去の修正履歴の調査で役立つだろう。
変更ファイル内の検索
https://chatgpt.com/share/68300fe8-e1cc-800b-8640-66e7c6dc146d
gitでブランチ比較時に、変更ファイル内限定でシンボル検索したいことがある。例えば、使用メソッドに引数追加時の他の場所での確認など。
若干の工夫が必要。まず、ブランチ比較を行う。
その後、ファイル一覧画面で、全ファイル選択。
[Edit]-[Find]-[Find in Files]
Search
https://chatgpt.com/c/6798762a-2c2c-800b-8dab-4a7b8252fe7b
PHPStormでは検索がいくつかある。
ファイル名検索
- Mac以外=C-N
- Mac=C-O
スペース区切りでAND検索になる。パスを含めると、ディレクトリーも絞り込める。
Search Everywhere
Shift2回押下。
- C-f: ファイルない検索。
- C-F: 全体検索。
Other
tsh経由のファイル転送
About
ローカルパソコンでソースコードを修正して、ファイルアップロードでAWS VMに展開して動作確認するという想定で、PhpStormを設定する。
基本方針として、以下のコマンドによりteleport経由で転送できるので、これをPhpStormにも設定する。IPv4部分は踏み台の~/.ssh/configで設定することで任意の名前を指定可能。
rsync -zare "tsh ssh -A <踏み台> ssh" ./test.file IPv4:~/
これを念頭にPhpStormを設定する。ただし、PhpStormからのログインのために、多段SSHの設定は必要。ファイル送受信時にtshを経由して監査ログは残るのでよしとする。
なお、単にファイルをコマンドで転送するだけなら、泥くさいが以下のようにtsh scpで2回実行する手もある。
FR=test.file TO=/path/to/test.file tsh scp $FR <踏み台>:$TO; tsh ssh -At <踏み台> scp $TO <AWS>:$TO
Official
teleport経由のファイル転送の公式情報は以下。
- Teleport Files with SCP
- Using the tsh Command Line Tool | Teleport Docs
- JetBrains SFTP | Teleport Docs
3番目の「JetBrains SFTP | Teleport Docs」がまさにこれに該当するのだが、説明の記述がわかりにくい。踏み台サーバーへのアクセスしかできないように見える。tsh configやssh_configを工夫すれば、うまくできるような気はする。
ssh_config
PhpStormのSSH configurationsのホスト名がスクリプトの引数に渡されるので、踏み台からAWSにsshでログインするホスト名やパソコンの~/.ssh/configのHostとの一致必要な点に注意する。
USERNAME=
cat <<-EOT >~/.ssh/config
Host dev-jg1
ForwardAgent yes
User $USERNAME
ServerAliveInterval 30
ProxyJump $USERNAME@<teleport-host>:3023
Host $USERNAME
ForwardAgent yes
ProxyJump dev-jg1:22
User $USERNAME
Hostname %h.<host>
ServerAliveInterval 30
Host *
AddKeysToAgent yes
PasswordAuthentication no
User $USERNAME
ForwardAgent yes
ServerAliveInterval 30
IdentityFile ~/.ssh/id_ed25519
# for macOS
UseKeychain yes
rsync executable
rsyncで使用する (-eオプション)、以下の内容のシェルスクリプトを作成して実行権限を付与して任意の場所 (例: ~/project/tsh_ssh.sh) に配置する。
cd ~/project/ cat <<-'EOT' >tsh_ssh.sh tsh ssh -A <host> ssh $@ EOT chmod +x tsh_ssh.sh
PhpStorm設定
PhpStormで以下を設定する。
- [Tools]-[Deployment]-[Configuration]
- [+]-[SFTP]
- [Create New Server]-[New server name: 任意の名前]-[OK]
- [Connection] タブを以下に設定。
- Type=SFTP
- SSH configuration=以下を設定。
- Host: <ホスト名> (~/.ssh/configと踏み台サーバーの~/.ssh/configのホスト名と同じにする)
- User name: ユーザー名
- Port: 22
- Authentication type: OpenSSH config and authentication agent
- Root path=
- [☑️Use Rsync for download/upload/sync]
- Rsync Settings=以下を設定。
- Shell executable path=tsh_ssh.shのパス (例=~/project/tsh_ssh.sh)
- [Mappings] タブを以下に設定。
- Local path: ローカルパソコンのmonsterディレクトリー
- Deployment path: /
- Web path: /
- [Settings]-[Build, Execution, Development]-[Development]-[Options]-[Upload changed files automatically to the default server]=[On explicit save action]
- ☑️Delete remote files when local are deleted
以上で完了。後は同期したいファイルをPhpStormで開いて、右クリック-[Deployment]-[Upload to]/[Download from] でファイル転送できる。
[☑️Use Rsync for download/upload/sync] のチェックを外せば、rsyncを使わないファイル転送になる。
保存時自動転送
- Prefernce(⌘ + ,)から、Build, Execution, Deployment > Deployment > Option
- Upload changed files automatically to default serverを設定
- Alwaysでもいいですが重いのでOn explicit save actionがおすすめです。⌘Sでサーバーにコードをsyncします。
Window
プロジェクトを開く、移動、閉じる | PhpStorm ドキュメント
ペーンを分離したり移動したりできる。
ペーン右上[…]-[View Mode]-[Window] を選ぶと、別画面に分離できる。並列時に重宝する。
ディレクトリーの無視
除外されたファイルとフォルダー | PhpStorm ドキュメント
PhpStormでコーディングで使用しないディレクトリを除外してパフォーマンスを改善する | プロガジ.DEV
シンボリックリンクだったりして、同じファイルが違うパスで表示されることがあって困る。ディレクトリーを除外する。
右クリック-[Mark Directory as]-[Excluded] を選ぶ。
Bookmark
よく参照するコードの行・ファイル・ディレクトリー、をブックマークに登録して、迅速にアクセスできる。
- 左端のプロジェクトツールウィンドウ (C-1) で対象項目を右クリック-[Bookmarks]-[Add Bookmark]
- [View]-[Tool Windows]-[Bookmarks] を選ぶと、、サイドバーにBookmarkのボタンが表示される。
Web Browsers and Preview
ウェブブラウザーとプレビュー | PhpStorm ドキュメント
PHPファイルの編集時に、右上にプレビューボタンが表示されて邪魔。以下の設定で非表示にできる。
[Cmd-,]-[Settings]-[Tools]-[Web Browsers and Preview]-[Show browser popup in the editor]-[▫️For HTML files]
ファイル差分
ファイルの差分ビューアー | PhpStorm ドキュメント
ファイル差分の閲覧機能がある。
右クリック-[Compare with Clipboard]
これが手っ取り早い。
PEARの認識
1 pear config-showでphp_dir (=/usr/share/php/) を確認する。
2 このディレクトリーをローカルマシンに保存する (~/projectなど任意の場所)。既存プロジェクトの外に配置した方が都合良いだろう。
3 PHPStormの[Settings]-[PHP]-[include Path] で2で保存したディレクトリーを指定する。
.bashrc
bash - .bashrc not sourced on Intellij IDEA's terminal - Stack Overflow
いくつかの理由で、IntelliJは標準ではBashを対話モードで起動しない。だから.bashrcを読み込まない。
ただし、これは設定で変更可能。
[Settings]-[Tools]-[Terminal]-[Shell path] に-iを追加する。だめなら、--loginとか。
終端スペースの自動除去
PhpStorm removing tabs/spaces on every save - Stack Overflow
PhpStormでファイルを開いて保存すると、勝手に終端スペースを削除する。デフォルトでそういう設定になっている。
[Settings/Preferences]-[Editor]-[General]-[Remove trailing spaces]=on
Templateエンジンでのシンボルジャンプ
https://chatgpt.com/share/6808ae15-1d60-800b-9e86-78aa131ee066
Smartyでは新ポルジャンプできない。
BladeとTwigはシンボルジャンプに対応しているらしい。VSCodeも。じゃあ、こっち優先するか。Laravelは嫌いだからTwig。
重いとき
https://chatgpt.com/share/681ab545-1814-800b-a019-c6cce4f24a3c
PHPStormを起動したら、CPU使用率がめちゃくちゃ高くてまともに動作しないことがある。
PHPStorm自体の更新キャッシュファイルの削除などを行なっている模様。
いくつか対策がある。
- [File]-[Power Save Mode] を選ぶとJITとGCが安まり軽快になる。
- Help > Diagnostic Tools > Activity Monitorでなんのプロセスの使用率が高いかわかる。
- Help > Show Log in Finder/Explorer-idea.logでログがわかる。
JITやGCの使用率が高い場合、メモリー管理やコードの最適化の負荷が高まっている。メモリー不足でGCが頻発していてCPU使用率が高まっている可能性がある。メモリー割り当てを大きくして、GCの頻発を抑えて、処理を完了させるとまともになる。
Help > Edit Custom VM Optionsで以下を設定する。
-Xms1024m -Xmx4096m -XX:ReservedCodeCacheSize=512m -XX:+UseG1GC
8GBの場合。
Xms:初期メモリサイズXmx:最大メモリサイズ(あなたのPCのRAMが8GB以上なら4096mでもOK)ReservedCodeCacheSize:JIT用のコードキャッシュ領域
UseG1GC:ガベージコレクションにG1GCを使用(モダンで安定)
編集後はPHPStormを再起動する。
ローカルPHPインタープリター
PHPStormが端末などでデフォルトで使うPHPを指定できる。
- Cmd-, (Settings) -[PHP] を選ぶ。
- [CLI Interpreter] の横の [...] を選ぶ。
左上の[+]から追加したりできる。
OS内で認識しているPHPのリストが表示される。ここで設定したPHPが端末起動時のパスに設定される。
