TECH PLAY

株式会社ラクス

株式会社ラクス の技術ブログ

941

こんにちは、モバイル開発チームのhyoshです。 弊社では各分野の特定のテーマに沿ってエンジニアが議論する「TechCafe」というイベントを定期開催しています。 PHPTechCafe フロントエンドTechCafe そして先日私を含めた弊社モバイル開発チームが初となる「モバイルTechCafe」を開催しました! rakus.connpass.com 本ブログでは開催までの準備過程や当日の内容についてレポーティングさせていただきます。 TechCafeについて 準備編 テーマ選定 参加者選定 打ち合わせ 当日編 紹介したイベント 複雑さに立ち向かうためのコードリーディング入門 認証体験向上のためにpasskeys(パスキー)に対応する 〜 メリット・対応方法について 集まれKotlin好き!Kotlin愛好会 WebViewと向き合う Compose で Android/iOS アプリを作る Androidエンジニアが1人という不安と向き合う Japan IT Week やってみての感想 おわりに TechCafeについて 弊社TechCafeはエンジニア同士の交流の機会を提供する、エンジニアと技術が交差する憩いの場(カフェ)になれるようなイベントを目指しています。 TechCafe というイベントそのものが学びの場となり、運営メンバーも含め、参加者全員がエンジニアとしてレベルアップしていけるように支援することを目的として開催しております。 今回最初に企画が持ち上がった際には、個人でのLT等の活動経験はあるとはいえ組織的な社外向けイベントというのは経験がなく、上手くやれるのかという不安はありました。 ただ上述の目的にもあるように例え上手くできなくても開催すること自体が参加者にとって少しでも学びのきっかけとなり、チームにとっても新たな視点をもたらす糧になるのではと思い「まずはやってみよう」の精神で引き受けました。 準備編 テーマ選定 イベントの肝となるテーマを決めるにあたってはまずはチーム内でブレストを行いました。 折角なので全員で協力して成功を目指すイベントにすべく参加者に限定せず全員で行ったのですが、いざ始めると想像よりも闊達に意見が飛び交い初回は案出しだけで終わることになりました。 ブレストの結果 そして二度目の打ち合わせで候補の絞り込みを行いましたが、選定にあたっては次の観点を重視しました。 レベルを問わずより多くの参加者に新しい気付きをもたらすことができること 時間をかけすぎずに今持っている情報を使って議論ができること 何より自分たちが「楽しんで」話せる内容であること 結果として記念すべき初回テーマは 「モバイルエンジニアにおススメの技術イベントを語る」 に決めました。 参加者選定 参加者については当初は希望者のみで考えていましたが、テーマ的に特定の技術スタックが関係ある訳でもなく誰でも参加可能なのとその方がより当チームの雰囲気が伝わるのではと考え5人全員での参加としました。 他TechCafeでは2~3人程度が基本だったので多いかなという懸念もありましたが、終わってみると初回で不慣れな中、あまり各々が多い量を話せないという状況では丁度よかったと思います。 また役割については ファシリテーター (私)、コメント確認などの分担を決めました。 打ち合わせ 初回という事もあったので当日までの打ち合わせは数回に分けて念入りに行いました。 まずは参加者別にインタビューを行いテーマに対してどのようなネタを持っているかを自身が壁打ち役となり膨らませていきました。 そして全員分出揃ったら全体の繋がり含めて本番タイムラインをイメージして当日shownoteを検討していきました。 最終的に出来上がったshownoteが以下となります。 hackmd.io 最後に全員での本番を想定したリハーサルを行い当日に臨むことになりました。 当日編 紹介したイベント ここでは簡単に当日どのようなイベントを取り上げたかを紹介させていただきます。 複雑さに立ち向かうためのコードリーディング入門 fortee.jp 長期記憶や短期記憶といった 脳科学 側面からコード読解術を解説していく一風変わっていますが納得感のあるセッションです。 モバイルに特化した話ではないですが「確かに思い返すとあの場面では長期記憶が使えていたのかも」といった体験談で当日は盛り上がりました。 認証体験向上のためにpasskeys(パスキー)に対応する 〜 メリット・対応方法について fortee.jp 最近大手企業でも導入事例が増えているpasskeysについて改めて概要から iOS アプリにおける導入方法までが解説されたセッションです。 導入によるメリット・デメリット、特にユーザー目線だとどのような価値があるのかなどの議論で盛り上がりました。 集まれKotlin好き!Kotlin愛好会 love-kotlin.connpass.com Kotlinに関する事ならジャンル問わず何でもOKの定期開催イベントです。 LT中心ですが公式リファレンスを読んで雑談したりなどフリーな雰囲気で、紹介メンバーは何かしら新しい気づきを得ることができているそうです。 ちなみにSwift版も開催されているので iOS エンジニアも安心です。 WebViewと向き合う speakerdeck.com あまり取り上げられる機会の少ないWebViewについて改めて留意すべき点など解説されており、求めている人には非常に有益なセッションです。 ネガティブな方向で語られる事もあるWebViewですが当チームでも改めてその意義や活用できるシーンなどを議論するきっかけにできました。 Compose で Android / iOS アプリを作る speakerdeck.com Compose for iOS と KMP を用いてKotlin100%で iOS アプリを作るまでを解説したセッションです。 当日は クロスプラットフォーム でどこまでネイティブに近づけられるのかといった議論で盛り上がりました。 Android エンジニアが1人という不安と向き合う speakerdeck.com エンジニアが自身1人だけで正解が分からない中でどのように正しい情報や技術を取得していったかという学習方法やキャリアへの考え方が述べられたセッションです。 自分と境遇が似ており参考になったということでメンバーから紹介されましたが、アウトプット(自分で手を動かして物を作ること)の重要さに全員共感しました。 Japan IT Week www.japan-it.jp 特にモバイル特化という訳ではないですが由緒ある大規模ITカンファレンスです。 過去に組み込み開発経験もあり参加したこともあるメンバーからの紹介でしたが、実際に体験できるオンラインイベントならではの面白さといった観点等で語り合いました。 上記元々用意していたイベント紹介以外にも「登壇時の心構え」を語り合ったりもしていると、気づけばあっという間に予定の1時間半を経過し初めてのTechCafeは無事にクロージングを迎えました。 やってみての感想 初めは緊張もあったのですが徐々に慣れていつものチームの空気が出てきてカフェに見合った自然な空気をお届けできたのではと思います。 5人という人数も終わってみれば誰かに偏ることもなくわいがやな雰囲気を作り出すことができたので正解でした。 準備については入念に行ったことで当日つつがなく進行することができましたが、次回もし機会があるならよりライブ感を楽しむためにあえて軽めにというのでも良さそうだなと思いました。 とまぁ色々気づきはあったのですが 何よりも予想以上に楽しかったです! 自分達が楽しめるかというのはテーマにも掲げていましたが、終わってみれば全員が楽しめて業務とはまた違う共同作業を通しての達成感を味わうことができたのが一番の収穫でした。 初めは不安もありましたが得られることも多いので、また機会があれば是非開催できればと思っています。 おわりに 今回は初めてモバイルTechCafeを開催してみた体験をレポートにしてみましたがいかがだったでしょうか? 改めての学習のきっかけや結束力強化にも繋がりますので、このようなイベントを検討されている方の参考になりましたら幸いです。 再掲になりますが弊社では今回のモバイルTechCafe以外にも「 PHP TechCafe」や「フロントエンド TechCafe」といったイベントを定期開催しています。 どのような方にも楽しめて学べる場を目指し活動しておりますのでぜひご参加ください!
こんにちは。大阪楽楽開発課のdaina_rksです。 Laravelの マイグレーション を活用して、テーブル定義を更新しているサービスは多いと思います。 しかしサービスが継続するにつれ、気づけば大量の マイグレーション ファイルが存在している、、、なんて経験はありませんか? 私が携わっていたプロジェクトでも同じ悩みに直面していました。 この悩みに対して、私は マイグレーション ファイルを全て削除する ということを行いました。 今回はそのときの経験について、なぜ マイグレーション ファイルを削除するに至ったのか、削除するにあたって行なったこと、削除した結果どんな効果があったのかをご紹介します! マイグレーションファイルを全て削除するに至った理由 問題 マイグレーションファイルを全て実行するのに時間がかかる マイグレーションファイルのメンテナンスコストがかかる アイデア アクション ダンプ&リストアの仕組み構築 ダンプ リストア マイグレーションファイルの削除 環境変数の更新 ディレクトリ操作 不具合対応 結果 まとめ 参考情報 マイグレーション ファイルを全て削除するに至った理由 問題 私のプロジェクトでは、 マイグレーション ファイルが大量に存在することが原因で以下のような問題がありました。 マイグレーション ファイルを全て実行するのに時間がかかる 実行するファイル数が多いと必然的に完了までの時間が長くなっていました。また、テーブル定義更新以外の処理も行なっている マイグレーション ファイルもあり、その実行にさらに時間がかかっていました。 結果として全て完了するまでにおよそ13分もかかるため、新規DBの構築や自動テスト用のDB構築に時間がかかっていました。 マイグレーション ファイルのメンテナンスコストがかかる 実行済みの マイグレーション ファイルに対しても、 PHP もしくはLaravelのEOL対応が必要であるため、メンテナンスコストがかかっていました。(当時で150個の マイグレーション ファイルが存在していたため、1~2人日ほどコストがかかっていました。) ア イデア この問題の解決策として、 DB再構築時はダンプファイルからリストアする というア イデア を思いつきました。 そうすれば マイグレーション ファイルを実行する必要がなくなるため、DB構築の速度改善が見込めます。 ※実際にア イデア 段階で簡易的に試したところ大幅な速度改善がありました。 またダンプファイルから再構築できるようになるため、1度実行した マイグレーション ファイルは不要となります。このことから既に実行済みの過去の マイグレーション ファイルを削除しても問題がないため、メンテナンスコストの削減も見込めます。 ア イデア アクション 上記のア イデア を実現するためにやるべきことは以下の2つです。 DBのダンプ&リストアの仕組み構築 過去の マイグレーション ファイルの全削除 ダンプ&リストアの仕組み構築 1つ目のアクションとして、 DBのダンプファイルを生成する仕組み と リストアする仕組み が必要となります。 ダンプ ダンプファイルは マイグレーション ファイルが実行された直後のプレーンな状態のDBから、定期的に生成される必要があります。 そこでDBのダンプ処理はJenkinsのジョブで行うこととしました。 私のプロジェクトでは、Jenkinsサーバーでアプリケーションは動いていなかったため、常にプレーンな状態のDBが存在していました。またジョブを定義すれば定期的にダンプ処理を実行することができます。(Jenkinsサーバーで1バージョンの開発が完了するたびに ソースコード のバックアップを取るジョブが実行されていたため、そのジョブの中でダンプ処理を実行するようにしました。) ダンプファイルを生成したタイミングで、実行済みの マイグレーション ファイルを削除する処理をジョブの中に加えると、今後追加される マイグレーション ファイルに関しても、実行後に削除されるという運用に乗せることができました。 ダンプの仕組み リストア 環境構築手順や自動テストの仕組みをなるべく変更したくないため、リストアの処理は LaravelのArtisanコマンド で実行できるように作成しました。( php artisan migrate を実行していた部分を php artisan restoreDb に変更するだけで済むようにしました。) リストア後に確認しなければならないことは、ダンプ元となったDBと差分がないことです。 具体的には スキーマ とテーブルの所有者や権限が同じこと、テーブル定義およびレコードに差分がないことを確認する必要があります。 所有者と権限に関しては目視で確認、テーブルに関しては平文でダンプファイルを取得しdiff コマンドで差分がないことを確認しました。 リストア時に確認すべきこと マイグレーション ファイルの削除 2つ目のアクションは不要となった実行済みの マイグレーション ファイルを削除することです。 本来ならば マイグレーション ファイルはテーブル定義の更新のみを行なっているはずなので、ダンプファイルが正しく生成されていれば削除しても問題はありません。 しかし冒頭の問題で挙げた通り、テーブル定義の更新以外の処理を行なっている マイグレーション ファイルがいくつか存在しているため、何も対応せず削除すると不具合になり得るものがありました。 テーブル定義の更新処理以外の処理を行なっている マイグレーション に関しては、処理の内容に応じて以下の対策を行いました。 環境変数 の更新 私のプロジェクトでは、 環境変数 に変更がある場合は 環境変数 のテンプレートファイル .env.example を修正する運用でした。 しかし開発初期ではこの運用が定められていなかったため、 マイグレーション ファイル内で sed コマンドを実行し、 環境変数 を更新する運用を行なっていたようです。(かなり危ない運用) 環境変数 の更新を行なっている マイグレーション ファイルに関しては更新内容を確認し、最新バージョンの .env.example に存在しない値があれば、追記してから対象の マイグレーション ファイルを削除しました。 ディレクト リ操作 マイグレーション ファイル内でmkdirコマンドやchmodコマンドを実行し、 ディレクト リ操作や権限変更を行なっていました。 おそらく、あるバージョンでファイルアップロード機能が実装された際、 マイグレーション を活用してアップロードファイルの一時置き用 ディレクト リを作成していたようです。 ディレクト リ操作の処理に関しては環境構築用の Ansible のPlaybookに、必要な ディレクト リの作成処理および権限変更処理を記述し、 マイグレーション ファイルを削除しました。 不具合対応 画像のリサイズやファイルの移動など不具合対応用の処理が、 マイグレーション ファイル内で行われていました。 このような処理は今後必要になる可能性がある(実際に複数の マイグレーション ファイルで同様の処理が行われていました)ため、 LaravelのArtisanコマンド で実行できるように処理を切り出し、対象の マイグレーション ファイルを削除しました。 結果 上記のアクションを行い、 DB構築時はダンプファイルからリストアする というア イデア を実現できました。 肝心の結果ですが、DBの構築時間は13分から1.8秒(!!)まで短縮することができました。 これにより新規環境構築時間は10分以上短縮され、DB接続を伴う自動テストの実行は数時間から約10分まで短縮されました。 (DB接続を伴う自動テストに関してはテストメソッドごとに全テーブルを DROP →全 マイグレーション を実行という仕組みだったので、CI完了時間が数時間かかっていました。 そもそも自動テストの仕組みを見直せていなかったことが要因ですが、そのことについては今回は目を瞑リました。 ) メンテナンスコストに関しても、EOL対応ごとに1~2人日分短縮されることになったため、問題を解決することができました。 まとめ 今回は過去の マイグレーション ファイルの削除についてご紹介させていただきました。 マイグレーション ファイルを全て削除した結果、新規環境構築時間や自動テストに係る時間が大幅に短縮でき、メンテナンスコストの削減効果もありました。 冒頭に挙げた問題と似た問題を抱えているエンジニアの方や、今後 マイグレーション ファイルの運用を見直したいエンジニアの方のご参考になれば幸いです。 参考情報 今回のアクションで実施した ダンプ&リストアの仕組み構築 ですが、実はLaravelの Squashing Migrations という機能ですでに実現されています。 ア イデア 段階でこの機能を利用することを検討したのですが、この機能でダンプされる対象が 1 スキーマ のテーブル定義のみ でした。 私のプロジェクトの場合、ダンプ対象は 2つの スキーマ のテーブル定義と初期データ用のレコード であり、Laravelの機能では実現できなかったため利用することを見送りました。 もし マイグレーション ファイルの削除を行う場合、LaravelのSquashing Migrationsを利用できれば運用変更に係るコストを抑えることができるため、ぜひ選択肢に入れていただけたらと思います。 laravel.com
はじめに 配配メール開発課moryosukeです。 2024/02/11(日)に PHPカンファレンス 関西 2024が開催されました。 ラク スはブロンズスポンサーとして協賛させていただいています。 2024.kphpug.jp ラク スからは5人が登壇した他、多くのメンバーが参加しました。 そこで今回は参加者によるレポート、そして ラク スからの登壇者本人によるレポートを紹介させていただきます。 はじめに 参加レポート はじめてのOSSコントリビュート Laravelでミニマム開発からスタートして個人サービスを利益化するまでの経験談! RDBアンチパターンと戦う - 削除フラグ 完全攻略ガイド 令和最新版 PHP メモリ管理術 「"品質"が高いコード」って何? CodeRevieweeが求められること アプリケーションエンジニアこそ「監視」だよね!と私が考える訳 コードを自在に操るためのPHP文法入門 20年の歴史を持つプロダクトの開発チームの変革:技術広報の本質と効果 なんで、ファイル名とクラス名を揃えるの? 知っておきたいautoloadのはなし その条件分岐って本当に必要? 実践、Interface Mutation Testingとはなにか? 〜Laravel(Pest)でInfectionを利用したライブデモ〜 モデルとは何か PHPで学ぶ、セッションの基本と応用 ほげ言語にあってPHPにない機能 擬人化で完全に理解するクリーンアーキテクチャ アンカンファレンス ラクスからの登壇セッションのご紹介 レガシーシステムへのPHPStan導入から半年での課題と効果 レガシーとモダンなシステムが混在する開発環境を改善しよう PHP8.2にバージョンアップしたら文字化けが発生して道頓堀に飛び込みたくなった話 レガシーコードに潜む奇妙なコメント ~信じるか信じないかはあなた次第~ PHP8.1で、リソースがオブジェクトに!? ~マイナーリリースの変更がレガシープロダクトに与えた影響~ まとめ PHPerのためのコミュニティ PHPTechCafe 参加レポート はじめての OSS コントリビュート report by id:takaram PHP のコントリビューターでもある、てきめん ( @youkidearitai ) さんによる発表です。 speakerdeck.com PHP を含む OSS ( オープンソース ソフトウェア)へのコントリビュートというと、ハードルが高いと感じる人も少なくないと思いますが、実際は思ったほど難しくない、だから積極的にコントリビュートしよう!という内容です。 参加者の方の感想にもありましたが、簡単なドキュメント修正や誤字修正でもありがたい、と聞くと意外と気軽にできそうな気がしてきますね! typo の修正、ドキュメントの修正、「コア開発者がコアの開発に集中できるから嬉しい」というのがコントリビューターの口から聞けるの嬉しいな...だいぶ自分の中でハードル下がった #phpkansai #a pic.twitter.com/C60CIrhXcJ — あすみ (@asumikam) 2024年2月11日 Laravelでミニマム開発からスタートして個人サービスを利益化するまでの 経験談 ! report by id:hirobex mukae さんによる発表です fortee.jp レンタルサーバ でも対応していることが多いという PHP の特性を活かして、 うまくコストカットをして運用したア イデア に感心しました。 広報活動についても紹介してくださり、 御堂筋線 に利用した広告効果の落ちが面白かったです。 RDB アンチパターン と戦う - 削除フラグ 完全攻略ガイド report by id:shinzeeyhtb 株式会社リンケージCTOの、曽根 壮大 さんによる発表です speakerdeck.com アンチパターン である削除フラグについて、その具体的なデメリットと、目の前にある削除フラグに対する向き合い方を解説していただきました。 削除フラグを削除するための具体的な移行方法は、膨大な情報を1レコードに持つテーブルを分割する際にも活用できるものであり、明日からデータベースの リファクタリング もやってみたくなる内容でした。 (そして会社にも本があるから読みたくなりました!) 令和最新版 PHP メモリ管理術 report by id:hirobex めもり〜☆ さんによる発表です speakerdeck.com PHP のメモリ管理の仕組みから始まり、メモリ消費が多くなりやすいパターンについて解説していただきました。 日頃の開発で、Zend Memory Managerの仕組みを意識して開発したことがなかったので、非常に参考になりました! 「"品質"が高いコード」って何? report by id:os188 若葉 章 さんによる発表です speakerdeck.com 品質とは何か?というところから、品質が高いコードの達成方法についてお話いただきました。 "品質が高い"とは、"要求を満たしている"状態 実装やテストをしている時、「バグがなければOK」「コーディング規約を守っていればOK」のような考え方に陥りがちでした。 この機能の要求ってなんだっけ?と都度立ち返ることを意識していきたいです。 CodeRevieweeが求められること report by id:ymyhero7 おのぽん さんによる発表です speakerdeck.com CodeReviewerが求めていることを実際のインタビュー調査から分析し、CodeRevieweeが実践するべきことを分かりやすくお話していただきました。 どのようにコードレビューを出すのが正解なのか分からず悩んでいたので大変勉強になりました。 質問されそうな部分は先回りしてコメントをしておくこと、事前に認識のすり合わせをしておくことなど、これから実践していきたいと思います。 何より、同じチームで働く者としてコードレビューを出す際にも思いやりを持つことを忘れないようにしたいと思いました。 アプリケーションエンジニアこそ「監視」だよね!と私が考える訳 report by id:hirobex きんじょうひでき さんによる発表です speakerdeck.com まさにタイトル通り、なぜアプリケーションエンジニアが「監視」に興味を持つべきかということをお話していただきました。 私は、あまり現在のプロダクトの監視には携わっていないのですが、この登壇を聞いて監視も面白そうだなぁと思いました。 たしかに、監視したときに、「なぜそのようなメトリクスになっているのか」のストーリーを組み立てやすいのは インフラエンジニアではなく開発エンジニアだよなぁと頷きながら聞いていました。 コードを自在に操るための PHP 文法入門 report by id:takaram うさみけんた ( @tadsan ) さんによる発表です fortee.jp PHPStanやPsalmといった静的解析ツールは PHP 系のカンファレンスでよく紹介されますが、今回はそれらが利用している 構文解析 ライブラリ PHP -Parserについての トーク でした。 普段コードを書いているだけではあまり意識しない「 構文木 」や「文と式の違い」、また リファクタリング ツールRectorでの 構文木 を使ったコードの書き換え方を知ることができ面白い発表でした! 20年の歴史を持つプロダクトの開発チームの変革:技術広報の本質と効果 report by id:hirobex Yasuharu Sakai さんによる発表です www.docswell.com 20年もののプロダクトが陥っていた暗黒自体から、どのような改革を行い、 チームがどう良くなっていったかが、非常にわかりやすく解説されていました! 弊社もレガシープロダクトが多く、私もレガシープロダクト担当なので、 非常に共感できる箇所が多く、またその改革方法についても興味深くお話を聞かせていただきました。 なんで、ファイル名とクラス名を揃えるの? 知っておきたいautoloadのはなし report by id:dd_fotran 赤塚啓紀 ( @aki_artisan ) さんによる発表です。 speakerdeck.com クラスのオートロードについての話です。普段気にせず使っているのでクラスのオートロードの仕組みを知らない方も多いのではないでしょうか? PSR-4 のautoloadのどのような仕組みでクラスがロードされるのかを、丁寧に説明されているので、初学者の方にもオススメです。 その条件分岐って本当に必要? report by id:hirobex 伊神 誠人 さんによる発表です speakerdeck.com 条件分岐禁止のリストバンドとともに、いかにしてif文をわかりやすくするかというお話をしていただきました。 初心者の方にぜひ聞いていただきたい登壇内容でした。 実践、Interface report by id:yamamuuu おぎ さんによる発表です speakerdeck.com Interfaceを使うと何ができるのか、何がうれしいのか。またどのような場面では使うべきで、どのような場面では使わないべきかがわかりやすく説明されていました。 「Interfaceってイマイチ理解できてない」や「どういうときに使ったらいいか分からない」という方にぜひ聞いていただきたい内容でした。 Mutation Testingとはなにか? 〜Laravel(Pest)でInfectionを利用したライブデモ〜 report by id:hirobex Kanon さんによる発表です speakerdeck.com カバレッジ メトリクスの欠点を上げ、「正しいテストケース」であるかどうか調べるための手法である 「Mutation Test」についての話をしていただきました。 私の開発しているプロダクトにも、一度やってみたいなと思える手法でした。 モデルとは何か report by id:rakusMorita 菱田裕美 さんによる発表です speakerdeck.com 「モデルって何ですか?」と聞かれたときに、わかりやすく伝えられますか? この発表ではプログラミングにおける「モデル」の役割と重要性を、 現実世界の地図やプラモデルを例に、明快にお話されていました。 特に印象的だったのは、「モデルが現実世界の複雑さを抽象化し、重要な部分のみ残して低コストで試行錯誤ができるようにする」ということです。 データベースも、現実世界の記録をモデルにしたもので、菱田さんが出会った最初のデータベースは図書室の貸し出し表だったようです。 発表を通して、複雑な概念であると思い込んでいた「モデル」がイメージしやすい身近なものに変わりました。 PHP で学ぶ、セッションの基本と応用 report by id:hirobex 富所 亮 さんによる発表です speakerdeck.com なぜHTTP(ブラウザ)が Cookie やセッションを持つようになったかという歴史的な経緯から、 どのようにして Cookie やセッションを扱うべきかというお話をしていただきました。 最近は Cookie やセッション管理を フレームワーク に任せることが多いからこそ、 なにをしているのかを理解するべきだよなぁと感じました。 ほげ言語にあって PHP にない機能 report by id:hirobex 田中ひさてる さんによる発表です speakerdeck.com 『ほげ言語の パラドックス 』の紹介から始まり、ほげ言語にあって PHP にない機能を紹介していただきました。 PHP に”ない”機能の話なので当然なのですが、なぜ PHP に無いんだ……!と心のなかで叫びながら聞いていました。 また、肩システム( 原文ママ )の落ちも非常に面白かったです! めちゃめちゃ個人的な話なのですが、年末年始休暇に勉強して挫折したNimが紹介されており、妙に納得感がありました。 擬人化で完全に理解するクリーン アーキテクチャ report by id:uemura_rks しまぶ さんによる発表です speakerdeck.com 書籍「Clean Architecture 達人に学ぶソフトウェアの構造と設計」の内容をかみ砕いて、クリーン アーキテクチャ とは何かを説明されていました。 名前は聞いたことあるけどよく知らない、という私にとっては良いとっかかりとなりました。 「ビジネスルール(方針)に向かって依存の向きを整える。」これは意識していきたいです。 おぎ さんが発表されていた「実践、Interface」も合わせて聞くことで、依存の整理についてより理解を進めることができました。 アンカンファレンス report by id:takaram PHPカンファレンス 関西2024ではアンカンファレンスも開催されました! note.com 事前にプロポーザルを募集して選ばれた通常の トーク と違い、アンカンファレンスは当日の会場で喋りたい人が自由に トーク を行うものです。 ↓ホワイトボードに各々が話したい内容を書いて枠を取っていきます #phpkansai アンカンファレンスも盛り上がってるよ! pic.twitter.com/CoSCS2Vxjy — きしもと (@getKishimoto) 2024年2月11日 Webアクセシビリティ に関する真面目な話もあれば、各々の趣味を紹介する自己紹介LT、さらにはクイズ大会(?)まで、多種多様で自由な内容の トーク が繰り広げられていました! 個人的には、 symfony/console の紹介を symfony /console 自体をスライド代わりにして話す トーク が印象的でした。 コンソールで発表いいなwww #phpkansai pic.twitter.com/dHMwpR3Z2q — やまと | ☕️ | 🐈 (@yamato_sorariku) 2024年2月11日 ラク スからの登壇セッションのご紹介 レガシーシステム へのPHPStan導入から半年での課題と効果 report by id:dd_fortran speakerdeck.com 過去にPHPerKaigiなどのイベントで登壇したことはあったのですが、(コロナ期間中だったこともあり)オンライン開催だったためオフラインでの登壇は初めてかつ、 今回のカンファレンスの中でトップバッターだったので緊張しました。 レガシーシステム にPHPStanを導入した事例についてお話させていただきました。 レガシーシステム を抱えるサービスでは同様の課題をかかえているようで、多くの方に興味を持っていただけたようでした。 数人の方から質問をいただき、導入の際の課題などを共有できたので良かったです。 レガシーとモダンなシステムが混在する開発環境を改善しよう report by id:rakuinoue speakerdeck.com 初めて登壇する機会を頂きました。ありがとうございます。 担当するプロダクトチーム内で行った開発環境改善に関するお話をさせていただきました。 途中、おいしい?音声トラブルもありましたが、無事に時間内で発表を終えることができて良かったなと思います。 もう少し PHP の話を濃くしたほうが良かったのかもと反省しております。 PHP8.2にバージョンアップしたら文字化けが発生して道頓堀に飛び込みたくなった話 report by id:nerobluebros fortee.jp speakerdeck.com 初登壇です。タイトルは採択されるために作ったもので、実際には飛び込んでいません w それはさておき、ゴリゴリの技術系のカンファレンスである一方、私の発表は運用・サポートの話が中心なので、 セッションに来てくださった人たちに「聴きたいのと違う」と刺さるか不安でした。 どれくらい刺さったかはわからないけれど、センションにたくさんの人が来てくださったし、 発表して一定の手応え、ウケもあったので、良かったかなと思っています。 また、セッション後の「Ask the speaker」で PHP のコミッタの方とお話する機会があり、 私たちがおこなった修正方法の是非やなぜ文字化けするか?が聞くことができたので、 登壇して貴重な体験ができたと思います。ありがとうございました! レガシーコードに潜む奇妙なコメント ~ 信じるか信じないかはあなた次第 ~ report by id:yamamuuu speakerdeck.com 私が普段開発をしているメール共有サービス メールディーラーはリリースから20年以上が経つサービスであり、奇妙なコメントが多数存在します。 本LTでは私が実際に遭遇した奇妙なコメントをご紹介し、コメントを信じることが如何に危険なことであるかを知っていただきました。 暇な人は見てみてください。 PHP8.1で、リソースがオブジェクトに!? ~マイナーリリースの変更がレガシープロダクトに与えた影響~ report by id:hirobex speakerdeck.com 登壇しました。 PHP8.0→8.1へバージョンアップした時、下位互換性のない変更により修正が発生した話をしました。 個人的にはウケていたと感じたのでよかったです。 まとめ 6年ぶりとなった PHPカンファレンス 関西でしたが参加者数431人と非常に大盛況でした! 来年の開催も今から楽しみですね! PHPerのためのコミュニティ PHPTechCafe ラク スでは PHP に特化したイベントを毎月開催しております。 その名も「PHPTechCafe」!! 次回は02/28(水)に『 PHPカンファレンス 関西2024を振り返る』 をテーマに開催します! まだまだ参加者を募集していますので、ぜひお気軽にご参加ください。 👉PHPerのための「 PHPカンファレンス 関西2024を振り返る」 PHP TechCafe rakus.connpass.com 最後までお読みいただきありがとうございました!
 弊社で毎月開催し、 PHP エンジニアの間で好評いただいている PHP TechCafe。2023年8月のイベントでは「PHP8.3の新機能」について語り合いました。弊社のメンバーが事前にまとめてきた情報にしたがって、他の参加者に意見を頂いて語り合いながら学びました。今回はその内容についてレポートします。 rakus.connpass.com PHP8.3 新機能について Marking overridden method オブジェクトを継承していることを示すattributeが追加 ※プロパティのオーバーライドは対象外 Type Class Constants class、interface、trait、およびenumの定数に型を設定できるようになった ※継承しているクラス定数の型を拡張することはできない。 mb_str_pad str_padのマルチバイト用関数が追加 Dynamic class constant fetch クラス定数を動的に指定することができるようになった Arbitrary static variable initializers static変数の初期化時に、固定値以外の変数や関数を渡せるようになった Readonly amendment readonlyプロパティをcloneするとき再初期化することが可能になった ※cloneメソッドでreadonlyを変更できるのは一回のみ PDO driver specific sub-classes PDOのサブクラスを追加 PDO::connect Randomizer Admditions Randomizerクラスに以下の関数が追加 getBytesFromString() getFloat() nextFloat() その他の関数追加修正 json_validate() range() mb_strimwidth() その他議題 定数NumberFormatter::TYPE_CURRENCYの削除 定数MT_RAND_PHPの削除 最後に PHP8.3 新機能について PHP8.3の新機能は弊社のメンバーが事前にHackMdの記事としてまとめています。 今回のイベントではこの記事に沿って新機能をみていきました。 hackmd.io すべての機能は今回確認することはできなかった為、 確認する場合はこちらの記事にてよろしくお願いいたします。 Marking overridden method オブジェクトを継承していることを示すattributeが追加 <?php class P { protected function p () : void {} } class C extends P { #[\Override] public function p () : void {} } このことにより、 ・インターフェースを実装してるのか、クラスを継承してオーバーライドしているのか明示 ・親クラスの シグニチャ が変わった場合で、意図しないオーバライドを防ぐ ができます。 メリット、用途が分かりやすく今回の新機能の中で一番注目が集まった機能です。 アトリビュート が追加されたのはPHP8.0からなので、その アトリビュート 機能を使った活用が早いとして 喜々として話されておりました。 コメントからは、「解析ツールを使って自動で付けて回ることが出来そう」と。 可読性、保守性の向上が期待できそうです。 ※プロパティのオーバーライドは対象外 プロパティのオーバーライドは、親クラスと子クラスで意味合いが変わることが多いので、 対象外となります。 Type Class Constants class、interface、trait、および enum の定数に型を設定できるようになった <?php enum E { const string TEST = "Test1" ; // string 型の指定が可能になりました } この議題では、 PHP で今まで出来ていなかったことに驚くかたもおられました。 ※継承しているクラス定数の型を拡張することはできない。 以下コード例で言いますと、 public const mixed C = 0; の部分です。 これは、int ⇒ mixed になっているためできません。 少しややこしいですが、 定義の範囲が広くなったらNG と認識して問題ないです。 コメントでは、子クラスで型を再定義するようなケースに突っ込みがありました。 なるべく避けましょう。 <?php trait T { public const ? array E = [] ; } class Test { use T; private const int A = 1 ; public const mixed B = 1 ; public const int C = 1 ; public const Foo | Stringable | null D = null ; // T::Eが再定義されたときに型を変更することはできないのでNG。 public const array E = [] ; } class Test2 extends Test { // private ⇒ public は 任意に型変更 OK public const string A = 'a' ; // mixed ⇒ int は OK public const int B = 0 ; // int ⇒ mixed は NG public const mixed C = 0 ; // since Foo&Stringable ⇒ Foo|Stringable は OK public const ( Foo & Stringable ) | null D = null ; } enum E { // 定数は共変のコンテキストを提供するのでOK public const static A = E :: Foo; case Foo; } class Foo implements Stringable { public function __toString () { return "" ; } } mb_str_pad str_padのマルチバイト用関数が追加 <?php // This will pad such that the string will become 10 bytes long. var_dump ( str_pad ( 'Français' , 10 , '_' , STR_PAD_RIGHT )) ; // BAD: string(10) "Français_" var_dump ( str_pad ( 'Français' , 10 , '_' , STR_PAD_LEFT )) ; // BAD: string(10) "_Français" var_dump ( str_pad ( 'Français' , 10 , '_' , STR_PAD_BOTH )) ; // BAD: string(10) "Français_" // This will pad such that the string will become 10 characters long, and in this case 11 bytes. var_dump ( mb_str_pad ( 'Français' , 10 , '_' , STR_PAD_RIGHT )) ; // GOOD: string(11) "Français__" var_dump ( mb_str_pad ( 'Français' , 10 , '_' , STR_PAD_LEFT )) ; // GOOD: string(11) "__Français" var_dump ( mb_str_pad ( 'Français' , 10 , '_' , STR_PAD_BOTH )) ; // GOOD: string(11) "_Français_" こちらの議題では、追加された内容よりも、 マルチバイトと PHP の話にスポットが当たっておりました。 というのも、マルチバイト文字と言えば、日本語のひらがな、カタカナ、そして漢字。 国内で苦しめられているエンジニアも少なくありません。 (議題でもマルチバイトの闇がぽつりと溢れだす場面が) しかし世界で見れば需要は少ないのか、 RFC では蔑ろにされるイメージがあり、 今回の追加は珍しいとの反応が。 RFC を確認すると著者はフランスの方で、 例として、フランス語、 ギリシャ 語、絵文字が記載されております。 欧州ではISO8859-1からISO8859-16まであり、 地域によって切替を行う方式なので、追加したくなったのかなと推測されておりました。 Dynamic class constant fetch クラス定数を動的に指定することができるようになった <?php class Foo { const BAR = 'bar' ; } $ bar = 'BAR' ; // PHP8.3 以降は以下の記述が可能 echo Foo :: { $ bar } ; // PHP8.2 までで上記と同様の動作を実現する方法 echo constant ( Foo :: class . '::' . $ bar ) ; 上記コードを一目見て、直感的な理解の難しさ故に「黒魔術に見える」との意見がありました。 echo Foo::{$bar}; ポイントはこの部分で、 文字列"BAR"が格納されている$barを使用し、Foo関数のBAR(文字列bar)を呼び出しております。 enum の使い勝手が向上することは良いですね。 Arbitrary static variable initializers static変数の初期化時に、固定値以外の変数や関数を渡せるようになった <?php function bar () { echo "bar() called \n " ; return 1 ; } function foo () { static $ i = bar () ; // ← 8.2まではこの書き方が出来なかった echo $ i ++ , " \n " ; } foo () ; // bar() called // 1 foo () ; // 2 foo () ; // 3 この議題で良い活用法について思案しており、 コメントの中で「キャッシュの初期値設定は楽になりそう」との意見がありました。 本題とは関係ありませんが、このように皆で活用法を考えて、 共有することができるのは、 PHP TechCafeの良いところですね。 Readonly amendment readonlyプロパティをcloneするとき再初期化することが可能になった cloneは インスタンス をコピーする関数です。 clone時に、readonlyのプロパティを一度だけ変更することが可能になります。 下記コード例で言いますと、 $this->bar = clone $this->bar が新機能にあたります。 <?php // __clone()の実行中のみ、readonlyプロパティを再初期化することができる class Foo { // コンストラクタ public function __construct ( public readonly DateTime $ bar , public readonly DateTime $ baz ) {} // clone public function __clone () { $ this -> bar = clone $ this -> bar; // OK $ this -> cloneBaz () ; } private function cloneBaz () { // __cloneから呼び出されている場合はreadonlyプロパティの変更がOK unset ( $ this -> baz ) ; } } $ foo = new Foo ( new DateTime () , new DateTime ()) ; $ foo2 = clone $ foo ; // エラーは発生しない。 // この場合、Foo2::$bar は2重にcloneされており、Foo2::$baz は初期化されない ※cloneメソッドでreadonlyを変更できるのは一回のみ 一回目は変更できるが、二回目はNGになります。 <?php class Test { public function __construct ( public readonly DateTime $ bar ){} public function __clone () { $ this -> bar = $ this -> bar; // OK $ this -> bar = clone $ this -> bar; // NG } } PDO driver specific sub-classes PDOのサブクラスを追加 各ドライバ固有のメソッドを持つPDO( PHP Data Objects)のサブクラスが追加されます。 <?php // MySQL $ pdoMySQL = new PdoMySql ( $ dsn ) ; $ pdoMySQL -> getWarningCount () ; // MySQL専用機能 // PostgreSQL $ pdoPgsql = new PdoPgsql ( $ dsn ) ; $ pdoMySQL -> getPid () ; // PostgreSQL専用機能 例として、 PostgreSQL にあるpidの取得が専用の関数により簡単になります。 専用の関数なので、これらの関数を使用した際はDB移行時に注意してください。 PDO::connect 特定のDBのサブクラスを取得する PDO::connect というファクトリメソッドが追加されます。 $dsn が PostgreSQL に接続したら、 PostgreSQL のPDO、 MySQL に接続したら MySQL のPDOが返却されます。 <?php class PDO { public static function connect ( string $ dsn [ , string $ username [ , string $ password [ , array $ options ]]]) { if ( connecting to SQLite DB ) { return new PdoSqlite ( ... ) ; } return new PDO ( ... ) ; } } サブクラスのコンスト ラク タを使って直接接続も可能。 $db = new PdoSqlite($dsn, $username, $password, $options); 議題として、何でもOKなファクトリメソッドを用意しているが、 専用のコンスト ラク タを用意されていると、そちらを使うのがメインになると思うのではとの意見がでました。 Randomizer Admditions Randomizerクラスに以下の関数が追加 getBytesFromString() 与えられた文字列、文字列長を参照してランダムに文字列を生成。 第一引数 $string :選択対象の文字列 第二引数 $length :返り値の文字列長 下記例では、半角小文字英数字の中から16桁のランダムな文字列を生成します。 <?php $ randomizer = new \Random\Randomizer () ; // ランダムなドメイン名 var_dump ( sprintf ( "%s.example.com" , $ randomizer -> getBytesFromString ( 'abcdefghijklmnopqrstuvwxyz0123456789' , 16 ) )) ; // string(28) "xfhnr0z6ok5fdlbz.example.com" こちらに対して、第一引数に 正規表現 は使用不可とのことで、惜しむ声が少しありました。 これからの改善に注目です。 getFloat() 引数$minと$maxの間の 浮動小数点数 を返す。 第一引数 $min :最小値 第二引数 $max :最大値 第三引数 $boundary : 区間 境界の指定 ※デフォルトは ClosedOpen \Random\IntervalBoundary::ClosedOpen : $min以上、 $maxより下 \Random\IntervalBoundary::ClosedClosed : $min以上、 $max以下 \Random\IntervalBoundary::OpenClosed : $minより上、 $max以下 \Random\IntervalBoundary::OpenOpen : $minより上、 $maxより下 <?php $ randomizer = new \Random\Randomizer () ; // 経緯度 var_dump ( sprintf ( "Lat: %+.6f Lng: %+.6f" , $ randomizer -> getFloat ( -90 , 90 , \Random\IntervalBoundary :: ClosedClosed ) , // 緯度は90/-90どちらも可 $ randomizer -> getFloat ( -180 , 180 , \Random\IntervalBoundary :: OpenClosed ) , // 経度は180はあるけど, -180はない )) ; // string(32) "Lat: -51.742529 Lng: +135.396328" こちらの用途については、次の引数の紹介も併せます。 nextFloat() 0~1の間でランダムな少数を出してくれます。 以下コードと同等の処理を実行。 getFloat(0, 1, \Random\IntervalBoundary::ClosedOpen) 内部実装がgetFloat()よりも整理されており、処理速度が速いとのこと。 0.0以上、 1.0より下 のランダムな少数を生成する場合はこっちを使うとよい。 この機能を作られた方はゲーム会社に勤めているとのことで納得の声があがりました。 業務アプリを作成する場合は乱数に頼る機会は少ないがゼロではない為、 こういった数値機能が豊富になると有り難いですね。 その他の関数追加修正 json_validate() 文字列が JSON の正しい形かどうかを判定します。 <?php json_validate ( '{ "test": { "foo": "bar" } }' ) ; // true json_validate ( '{ "": "": "" } }' ) ; // false 今まで、 JSON 形式のチェックは json_decode によるチェックを行っていたかと思いますが、 JSON の大きさによって大量のメモリを割り当てる必要がありました。 この関数を使用するとその心配がなくなります。 range() range関数に発生していた不自然な挙動が修正されます。 <?php var_dump ( range ( 0 , 3 , -1 )) ; // PHP8.2まで [0, 1, 2, 3] // PHP8.3以降 ValueError var_dump ( range ( '9' , 'A' )) ; // PHP8.2まで [9, 8, 7, 6, 5, 4, 3, 2, 1, 0] // PHP8.3以降 [9, :, ;, <, =, >, ?, @, A] var_dump ( range ( '' , 0 )) ; // PHP8.2まで [0] // PHP8.3以降 [0] Warning: range(): Argument #1 ($start) must not be empty, casted to 0 こちら、誤った指定でエラーになるようになります。 var_dump(range('9', 'A')); は、 変更後も挙動が分かり難いですが、ASCIIコードの順になります。 現在Range関数を使用している場合は、不自然な挙動を前提に動いている可能性がないか注意が必要です。 コメントでは、 コードゴルフ *1 の選択肢が減りますね!とのことで笑いが起きました。 mb_strimwidth() 指定した幅で文字列を丸める関数ですが、負の値を入れることが出来てしまった問題が修正されます。 使用されている場合は、負の値が今まで入っていたが動いていた場合があるので注意が必要です。 その他議題 定数NumberFormatter::TYPE_CURRENCYの削除 フォーマッタの形式を指定する定数です。 通貨の値をフォーマッタ化する定数がありましたが、実装されないままだったので消すことになりました。 定数MT_RAND_ PHP の削除 PHP7.1で修正された乱数発生機問題の「互換性維持」手段が、今回でなくなることになります。 最後に PHP TechCafeでは PHP の機能をなぞるだけではなく、 新機能の活用法について皆で考えたり、 有識者 に機能が追加された背景まで語りつくしていただけました! そのため、すべての変更点をなぞることができませんでしが、 ある意味 PHP TechCafeの気軽さならではかと思います笑 「 PHP TechCafe」では今後も PHP に関する様々なテーマのイベントを企画していきます。 皆さまのご参加をお待ちしております。 *1 : 可能な限りもっとも短い ソースコード で記述することを競う
はじめに 新卒1年目のTKDSです! 先日,Go言語で json で返すレスポンスを作る際,ゼロ値の場合の項目の出し分けを行いたい場面がありました. そこで,encoding/ json でゼロ値の場合の項目の出し分けを行う方法を調査しました. はじめに 行いたいこと 1. 改変したいフィールドの型をany(interface{})にして,タグにomitemptyを指定する 2. encoding/json/v2 のomitzeroを使う. 3. MarshalJSON()メソッドを実装する. まとめ 行いたいこと profileがゼロ値の場合,responseの一部を改変し,profileを含まず出力します. {"id":1,"created_at":"2009-11-10T23:00:00Z","updated_at":"2009-11-10T23:00:00Z","profile":{"name":"TKD","age":"1000","email":"hogege@example.com"}} profileがゼロ値の場合 {"id":1,"created_at":"2009-11-10T23:00:00Z","updated_at":"2009-11-10T23:00:00Z"} 改変前のサンプルコードは こちら です. goの構造体として次のような形を持っています. type user struct { ID int64 `json:"id"` CreatedAt time.Time `json:"created_at"` UpdatedAt time.Time `json:"updated_at"` Profile profile `json:"profile"` } type profile struct { Name string `json:"name"` Age string `json:"age"` Email string `json:"email"` } user型の変数を定義する際,以下のコードのようにProfileを指定せずに変数の初期化を行うと,Profileフィールドは変数の型のゼロ値で初期化されます.stringの場合は ”” です. user := user{ ID: 1 , CreatedAt: time.Now(), UpdatedAt: time.Now(), } サンプルコードを実行してみると, fmt.Println("Profile.Name is zero: ", user.Profile.Name == "") でtrueが出力されているのがわかります. では,このコードを目的に合うように変更していきます. ここで json を改変する方法は3つ考えられます. 1. 改変したいフィールドの型をany(interface{})にして,タグにomitemptyを指定する 通常,struct {}の型情報で宣言されているポインタ型でないフィールドには,何も代入しない場合ゼロ値がセットされます. 一方,タグのomitemptyは nil である場合にキーを無視して構造体を json に変換します. そのため,このサンプルコードのProfileフィールドは json への変換時,キーが無視されることなく,セットされたゼロ値を含む json レスポンスになってしまいます. omitemptyが機能しないサンプルコード: https://go.dev/play/p/xJG-nHmNLB6 この処理はProfileに nil を代入することで防げます. profileの値が nil になることで,omitemptyの条件に一致するようになり, json の項目にProfileが含まれなくなります. しかし,Profile型の変数宣言では nil を代入できません. エラーになるサンプルコード: https://go.dev/play/p/SRyjrSaOTmz そこで, nil を代入できるようにProfileの型をany(interface{})にします. 修正したサンプルコード: https://go.dev/play/p/m_b-fa3iyhj type user struct { ID int64 `json:"id"` CreatedAt time.Time `json:"created_at"` UpdatedAt time.Time `json:"updated_at"` Profile any `json:"profile_at,omitempty"` } {"id":1,"created_at":"2009-11-10T23:00:00Z","updated_at":"2009-11-10T23:00:00Z"} 出力結果からprofileの項目が消えていることが確認できます. しかし,この方法には欠点があります. any型にはなんでも代入できてしまうため,実装するときに変数の型について自分がなんの型を扱っているか気をつける必要があります. これでは静的型付き言語であるgoを使うメリットが薄れてしまいます. 2. encoding/ json /v2 のomitzeroを使う. Goの実験的な実装であるencoding/ json /v2を使う方法です. ドキュメント サンプルコード profileを無視する機能を実現するのは構造体部分のタグです. type user struct { ID int64 `json:"id"` CreatedAt time.Time `json:"created_at"` UpdatedAt time.Time `json:"updated_at"` Profile profile `json:"profile,omitzero"` } omitzeroをつけることによって,ゼロ値の場合 json に含まれなくなります. この実装が実験的でなくなったら使いたい方法ですね. 3. MarshalJSON()メソッドを実装する. json .Marshal()で json に変換する構造体に MarshalJSONメソッド を実装することで独自のタグに基づいて JSON を生成するロジックを記述できます. MarshalJSONはMarshaler interfaceに定義されているメソッドです. ついでに,なぜMarchalJSONを実装するのか encoding/jsonパッケージ を見ながら調査してみました. json .Marshalの記述は src/encoding/json/encode.go にあります. まずpackageのはじめの32行目あたりに, // If an encountered value implements [Marshaler] // and is not a nil pointer, Marshal calls [Marshaler.MarshalJSON] // to produce JSON . とあり, nil でなく,MarshalJSONを実装しているとMarshalJSONが呼び出されることが記述されています. func Marshal(v any) ([] byte , error ) { e := newEncodeState() defer encodeStatePool.Put(e) err := e.marshal(v, encOpts{escapeHTML: true }) if err != nil { return nil , err } buf := append ([] byte ( nil ), e.Bytes()...) return buf, nil } marshalを実行するメソッドを持つ構造体を返すのは,newEncodeStateです. func newEncodeState() *encodeState { if v := encodeStatePool.Get(); v != nil { e := v.(*encodeState) e.Reset() if len (e.ptrSeen) > 0 { panic ( "ptrEncoder.encode should have emptied ptrSeen via defers" ) } e.ptrLevel = 0 return e } return &encodeState{ptrSeen: make ( map [any] struct {})} } encodeStateのreflectValueを見てみましょう. func (e *encodeState) reflectValue(v reflect.Value , opts encOpts) { valueEncoder(v)(e, v, opts) } typeEncoderを呼び出した戻り値を返しています. func valueEncoder(v reflect.Value ) encoderFunc { if !v.IsValid() { return invalidValueEncoder } return typeEncoder(v.Type()) } typeEncoderについてみてみましょう. typeEncoderは長いので省略します. 省略 // Compute the real encoder and replace the indirect func with it. f = newTypeEncoder(t, true ) wg.Done() encoderCache.Store(t, f) return f } typeEncoderは最終的に newTypeEncoder の戻り値を返しています. 次はnewTypeEncoderについてみてみましょう.こちらも長いので省略します. 中身をみるとわかりますが,marshalerという単語が変数名やコメントに散見されます. 本丸に近づいていそうです. marshalerEncoderという名前が複数あります. matshalerEncoderを返すためのif文があります. これはポインタであるかどうか,marshalerTypeのinterfaceを実装しているかどうかなどをチェックしているようです. 前述したコード冒頭のMarshalJSONが機能する条件と合致しそうです. addr, textなどの接頭辞がついてるmarshalerEncoderもありますが,シンプルな marshalerEncoder を見てみましょう. func marshalerEncoder(e *encodeState, v reflect.Value , opts encOpts) { if v.Kind() == reflect.Pointer && v.IsNil() { e.WriteString( "null" ) return } m, ok := v.Interface().(Marshaler) if !ok { e.WriteString( "null" ) return } b, err := m.MarshalJSON() if err == nil { e.Grow( len (b)) out := e.AvailableBuffer() out, err = appendCompact(out, b, opts.escapeHTML) e.Buffer.Write(out) } if err != nil { e. error (&MarshalerError{v.Type(), err, "MarshalJSON" }) } } メソッドの途中で, b, err := m.MarshalJSON() が呼ばれていることが確認できました. ここで,構造体に実装されたメソッドが実行され,独自のMarshalJSONが実行されます. なぜ,MarshalJSONを実装すると JSON のGoの構造体の間の マッピング が実行できるのか理解できました! 本題に戻り,MarshalJSONを実装してゼロ値のprofileを無視してみましょう. サンプルコード: https://go.dev/play/p/UkVe0N0iU2G 実装したメソッドは次のようになっています. func (u user) MarshalJSON() ([] byte , error ) { fmt.Println( "marchal" ) if u.Profile.Name == "" && u.Profile.Age == "" && u.Profile.Email == "" { return json.Marshal(& struct { ID int64 `json:"id"` CreatedAt time.Time `json:"created_at"` UpdatedAt time.Time `json:"updated_at"` }{ ID: u.ID, CreatedAt: u.CreatedAt, UpdatedAt: u.UpdatedAt, }) } return json.Marshal(u) } 処理は単純で,ゼロ値だったらprofileを含まない構造体を返すだけです. 非常にシンプルにかけます. また,ゼロ値以外にも応用が効くので覚えておきたい方法です. まとめ 最後まで見ていただきありがとうございました! 今回は, goの json パッケージについて調べました. 本筋から逸れましたが,パッケージの中身まで調べてみるとなぜinterfaceを満たすだけで任意の処理ができるのか学ぶことができました. 今後も気になった処理やパッケージがあったら調べてみたいと思います.
はじめに こんにちは!新卒1年目のTKDSです! 今回はkindで任意のポートをローカルマシンのポートに マッピング する方法を紹介します. 実際にkindでclusterを作成して動作確認をしながら進めます. はじめに kindとは default 設定でのCluster構築 Cluster作成 deploymentとNodePortの作成 kindの設定ファイルの作成 設定したポートにアクセスする まとめ kindとは コンテナを使用して, kubernetes クラスタ ーを構築できるものです. githubのAbout には About Kubernetes IN Docker - local clusters for testing Kubernetes と書いてあるので,kindは Kubernetes IN Docker の略のようです. 先に結論から言うと,clusterの作成時に設定ファイルでポートを指定します. では,clusterの作成・ Kubernetes リソースの作成・動作確認・kindの設定し直しの順で行っていきます. default 設定でのCluster構築 まずはdefault設定でClusterを構築し, curl で通信してみます. Cluster作成 $ kind create cluster defaultの設定で,kindという名前のclusterが作成されます. 作成されたclusterを確認してみましょう. $ kind get clusters kind deploymentとNodePortの作成 このdeploymentの内容は kubernetesのドキュメント にあるものを使用しています. deploymentの作成 apiVersion: apps/v1 kind: Deployment metadata: name: nginx-deployment spec: selector: matchLabels: app: nginx replicas: 2 template: metadata: labels: app: nginx spec: containers: - name: nginx image: nginx:1.14.2 ports: - containerPort: 80 NodePortの作成 apiVersion: v1 kind: Service metadata: name: nginx-service spec: type: NodePort selector: app: nginx ports: - protocol: TCP port: 80 nodePort: 30007 リソースを作成します. deploymentとpodの状態を確認します. deploymentとdeploymentで指定していたpodがreplicasの数で起動しているのが確認できました. 次にNodePortの確認をします. NodePortが作成されていることが確認できます. マッピング されているポートの確認 NodePortでportを設定したので,アクセスしてみます. cluster-ipとそのポートを指定・ localhost とNodePortの指定,どちらを行ってもnginxにはアクセスできません. これは,nodePortで指定しているportがローカルマシンのportに マッピング されていないためです. 冒頭でも述べたようにkindで作るclusterはコンテナなので,コンテナのポートをローカルマシンに マッピング しなければなりません. まずは,稼働してるclusterについて見てみます. docker psでコンテナを確認することができます. PORTS の項で,ローカルのポートにコンテナのポートが マッピング されているのが確認できます. ここでは,NodePortで指定してる30007番のPortが マッピング されていないのがわかります. そのため,ローカルマシンからコンテナ内のnodePortにアクセスができなくなっています. では, yaml に書いたPortでアクセスできるようにしていきます. kindの設定ファイルの作成 kindはcluster作成時に設定を書いた yaml ファイルを指定することができます. まずは設定ファイルを作成しましょう. 設定ファイルからcluster作成 kindのフラグについて調べます $ kind create cluster --help 出力 Creates a local Kubernetes cluster using Docker container 'nodes' Usage: kind create cluster [flags] Flags: --config string path to a kind config file -h, --help help for cluster --image string node docker image to use for booting the cluster --kubeconfig string sets kubeconfig path instead of $KUBECONFIG or $HOME/.kube/config -n, --name string cluster name, overrides KIND_CLUSTER_NAME, config (default kind) --retain retain nodes for debugging when cluster creation fails --wait duration wait for control plane node to be ready (default 0s) Global Flags: --loglevel string DEPRECATED: see -v instead -q, --quiet silence all stderr output -v, --verbosity int32 info log verbosity, higher value produces more output --config string path to a kind config file と書いてあります. まず設定ファイルを作成します. kindの設定ファイルについては,ドキュメントの Configuration に記述があります. 設定ファイルでkind上のコンテナのポート番号を containerPort に書き,hostPortにローカルマシンのポートを指定します. 設定ファイルは下記の通りです. kind: Cluster apiVersion: kind.x-k8s.io/v1alpha4 nodes: - role: control-plane extraPortMappings: - containerPort: 30007 hostPort: 30007 listenAddress: 127.0.0.1 - role: worker では,設定ファイルを使って,clusterを作成しましょう. $ kind create cluster --config my-cluster.yaml docker psでマウントされているポートを見る $ docker ps ローカルマシンのポートにコンテナのポートが マッピング されているのが確認できました. 設定したポートにアクセスする もう一度,deploymentとserviceの作成をしておいてください. では,アクセスしてみましょう. 無事レスポンスを確認することができました. まとめ 今回は,kindでのport設定を紹介し,実際にレスポンスを確認するところまで行いました. ここまで見ていただきありがとうございました!
こんにちは、配配メール開発エンジニアのhiro_jiです。 突然ですが、負荷テストの進め方ってイメージできますか? ある程度経験があれば難なく進めることができると思いますが、そうでない場合はそもそも進め方のイメージが湧きづらいかと思います。 かくいう私も最初は何から手を付ければよいか分からなかった記憶があります。。。 そこで今回は負荷テスト初心者の方向けに、私の所属するチームで実施している手順を紹介します! 負荷テストとは? 負荷テストのフロー 全体像 方針検討 詳細計画 テスト準備 テスト実施 評価 分析・チューニング おわりに 負荷テストとは? 本題に入る前に、負荷テストとは何かについて軽く触れておきます。 負荷テストとは、特定の条件下でシステムやアプリが示す性能を評価、検証するものであり、運用中の障害を未然に防いだり、パフォーマンスの問題や ボトルネック を改善するために非常に重要な役割を持ちます。 負荷テストには、性能要件を満たしているか検証するための「ロードテスト」や、限界値を特定するための「ストレステスト」など、目的や観点に応じて様々な手法があり、計測方法や分析する指標がそれぞれが異なります。 (テスト手法の名称に関してはサービスや会社によってまちまちなようですが、本記事ではそれらの総称を「負荷テスト」として扱います) 本記事ではそれぞれの手法については触れませんが、「スムーズにテストを進める方法」という観点で参考になれば幸いです。 負荷テストのフロー 全体像 負荷テストフロー 私たちのチームではいくつかの工程に分けてテストを進めていて、 工程ごとにレビューを挟むことで余計な手戻り作業を削減しています。 方針検討 このフェーズでは以下のようなことを決めます。 テストを行う背景や目的 性能要件を満たしているかを確認したい?それともシステム限界値まで特定したい? どのような指標で評価するか 応答時間 エラー率 スループット サーバリソースの使用量 評価対象とする機能や処理の範囲 など ここの方針がずれていると、 無駄な作業や大幅なやり直し につながってしまいます。 例えば、限界値を特定したかったのに性能要件の範囲までの負荷しかかけれていなかったり、ある SQL の性能だけを計測したいのに機能全体も性能を計測したり... 効率的に進めるためにも、最低限上記のような内容は早い段階で明確にしておきましょう。 詳細計画 ここでは方針検討で決めた内容を元により詳細な内容を決めます。具体的には 、 使用する環境やサーバ構成 負荷の量 同時ユーザー数 リク エス ト数 レコード数やファイルサイズ エビデンス として残す情報 処理時間だけでよいのか?サーバリソースの状況も取得するのか? 操作手順(負荷をかけるシナリオ) 使用ツール 評価基準 などなど 決めることは多いですが、ここが曖昧だと実は想定する負荷をかけれていなかったなんてことになりかねないので、可能な限り詳細に記載することが大切です。 随分過去の話ですが、DBに用意するレコードに関してレコード数自体は想定通りだけど、その内訳に関して計画担当とデータ準備担当間で認識齟齬が生じていしまい、テストのやりなおしが発生したことがありました。 特にデータ量などを記載する際は、 数値だけでなくその数値とした根拠や内訳も明確に記載 し、チーム内の認識を合わせましょう。 テスト準備 詳細計画で決めた内容に沿って必要な環境、データや スクリプト などを準備します。 テスト用の環境 テストシナリオ DBに登録するレコードやリク エス トなどのデータ 負荷の計測用 スクリプト やツール 詳細計画に沿ってテスト準備をするだけといえばそれまでですが、個人的にはここが一番時間がかかるフェーズだと思います。 対象機能の理解や大量データの作成方法など、ある程度の前提知識やコツが求められることが多いです。詰まったら迷わずチーム内の 有識者 に聞いちゃいましょう。 また、次回以降の テストの効率と再現性向上のため に、データ作成や計測用に作成した スクリプト はどこかに残しておくことをおススメします。 テスト実施 準備ができたらいよいよテスト実施です。 テストの内容にもよりますが、大量データを扱う場合などは色々と注意が必要になります。 私たちのチームではトラブルや手戻りを未然に防ぐために、以下のような内容をチェックリスト化し、テスト実施前に毎回確認しています。 使用する環境が正しいか 共用の環境を利用する場合、事前に利用することを周知できているか リソース監視対象のサーバで、余計な処理が動いていないか 計測データにノイズが入らないか 外部サービスへ大量リク エス トを送るようなことはないか 送る必要がある場合は、許可を得ているか テスト手順が適切か 負荷テストはその性質上、他のテストに比べて様々なリスクがあります。 いきなり本番テストを行うのではなく、 まずはミニマムで実施する ことでテストの妥当性を確認しましょう。 評価 計測した結果が、詳細計画で決めた基準を満たしているかどうかを明確にします。 単純にOK、NGだけ記載するのではなく、その評価に至った根拠や補足情報を記載し、 結果の妥当性を示すこと が大切です。例えばサーバリソース(LAやメモリ)に関して、瞬間的な値のみで判断するのと、連続的な値も含めて判断するのとでは、大きく意味合いが異なると思います。 分析・チューニング 評価、分析の結果、基準を満たさない場合はアプリの改修もしくはインフラ側の拡張を検討する必要があります。 いきなりアプリ改修やインフラ側の拡張に走ってしまうと、全く改善効果が得られず無駄な対応に時間をかけてしまったなんてことになりかねません。 まずは ボトルネック の特定から進めることがチューニングの一番の近道です。 おわりに 本記事では私のチームで実践している負荷テスト手順についてご紹介させていただきまいた。 負荷テストと聞くと身構えてしまう方もいる多いかもしれませんが、 段階的にチーム内で認識を合わせて進める ことができていれば、なんてことないと思います。 今回は進めかたという点に絞ってご紹介しましたが、次回は具体的に使用している負荷計測ツールや分析方法についても紹介できればと思います!
概要 Prometheus未経験の非インフラエンジニアが、Grafanaでサー バモ ニタリングができるようになるまでの 軌跡を記録します。 とりあえず、モニタリングができることが目標なので運用面の考慮等はしていませんが、参考になれば幸 いです。 概要 きっかけ Prometheusとは Grafanaとは 今回構築する環境の構成 ①prometheus server ②exporter ③Grafana インストール 前提条件 ②exporterのインストール (1)ソースをダウンロード (2)ダウンロードしたソースを解凍する (3)node_exporterを起動する (4)node_exporterの起動確認 ①prometheus serverのインストール (1)ソースをダウンロード (2)ダウンロードしたソースを解凍する (3)Prometheusの設定ファイルを編集する (4)prometheus serverを起動する ③Grafanaのインストール (1)Grafanaのインストール (2)grafana-serverの起動と起動確認をする (3)Grafanaにブラウザでアクセスする (4)Data Sourceの設定 (5)dashboardの設定 やってよかったこと まとめ きっかけ 検証環境のとあるサーバが突然死しました。 なぜ死んだのかは分かりませんでした。 というのも、OSと必要最低限の ミドルウェア をインストールしただけのサーバだったのです。 これは良くないなと思い、サーバをモニタリングしたいなと思いました。 sysstatとか使えば良いのかもしれませんが、せっかくなのでPrometheusを使ってみることにしました。 Prometheusとは システムおよびサービスのモニタリングシステムです。 設定されたターゲットから定期的にデータを収集して 蓄積 可視化(Prometheusでの可視化は、今回は触れません) アラートの通知(今回は触れません) を行うことが可能です。 Grafanaとは Grafanaは、様々なデータソースから取得したデータを可視化するツールです。 Prometheus自体でも可視化は可能ですが、 アドホック な立ち位置で利用されるものだそうです。 可視化には、Grafanaを使うよう公式サイトに記載されています。 今回構築する環境の構成 ①prometheus server いわゆるPrometheusと呼ばれるものです(だと思っています)。 ②exporter 監視エージェントです(だと思っています)。 取得したい情報に応じて、exporterをインストールします。 主なexporterは、 Prometheusのマニュアル に記載されています。 ①prometheus server  は、  ②exporter  に対して定期的に情報を取得しに行き、データを蓄積します。 ③Grafana ③Grafana  は、  ①prometheus server  からデータを取得し、可視化を行います。 インストール 順番は前後しますが、 ②exporter ①prometheus server ③Grafana の順番でインストールします。 前提条件 OS: AlmaLinux 8.8 ②exporterのインストール 今回は、サーバの状況が知りたいので、 node_exporter をインストールします。 (1)ソースをダウンロード Prometheusのダウンロードページ のリンクから  node_exporter-1.7.0. linux - amd64 .tar.gz  をダウンロードしました。 wget https://github.com/prometheus/node_exporter/releases/download/v1.7.0/node_exporter-1.7.0.linux-amd64.tar.gz (2)ダウンロードしたソースを解凍する tar xzvf node_exporter-1.7.0.linux-amd64.tar.gz (3)node_exporterを起動する cd node_exporter-1.7.0.linux-amd64 ./node_exporter (4)node_exporterの起動確認 node_exporterが起動していることを確認します。 node_exporterのポート番号 9100 exporterのエンドポイント /metrics コマンド curl -s http://localhost:9100/metrics 実行結果 # HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles. # TYPE go_gc_duration_seconds summary go_gc_duration_seconds{quantile="0"} 3.0043e-05 go_gc_duration_seconds{quantile="0.25"} 4.12e-05 go_gc_duration_seconds{quantile="0.5"} 4.6299e-05 ・ ・ ・ ①prometheus serverのインストール (1)ソースをダウンロード Prometheusのダウンロードページ のリンクから  prometheus-2.45.2. linux - amd64 .tar.gz  をダウンロードしました。 # wget https://github.com/prometheus/prometheus/releases/download/v2.45.2/prometheus-2.45.2.linux-amd64.tar.gz (2)ダウンロードしたソースを解凍する tar xzvf prometheus-2.45.2.linux-amd64.tar.gz (3)Prometheusの設定ファイルを編集する cd prometheus-2.45.2.linux-amd64 vi prometheus.yml prometheus.yml  の末尾に  node_exporter  の情報を追記します。 - job_name : "node_exporter" static_configs : - targets : [ "localhost:9100" ] (4)prometheus serverを起動する ./prometheus --config.file=prometheus.yml ③Grafanaのインストール Grafanaは、 cloud on-premises Enterprise OSS エディションがありますが、今回はon-premisesの OSS をインストールします。 (1)Grafanaのインストール GrafanaのOSSダウンロードページ を開き Red Hat, CentOS, RHEL, and Fedora  のコマンドを実行します。 今回は以下のコマンドを実行しました。 sudo dnf install -y https://dl.grafana.com/oss/release/grafana-10.3.1-1.x86_64.rpm (2)grafana-serverの起動と起動確認をする sudo systemctl start grafana-server sudo systemctl status grafana-server (3)Grafanaにブラウザでアクセスする http://<IPアドレス>:3000  にアクセスします。 Email or username admin Password admin でログインできます。 ※初回ログイン時にパスワードの変更を求められます。  Skipも可能です。 (4)Data Sourceの設定 画面左上のトグルメニューから Home Connections Data sources を選択します。 +Add new data source  をクリックして  Prometheus  を選択します。 Name: 任意の名前 HTTP Prometheus server URL:  http://<IPアドレス>:9090 を入力し、  Save & Test  をクリックします。 (5) dashboard の設定 Grafanaの dashboard の設定ですが、 テンプレート が公開されています。 今回は、 Node Exporter Full を使わせていただきました。 画面右上の +  をクリックして  Import dashboard  を選択します。 先程エクスポートしたテンプレートをアップロードします。 Options Name: 任意の名前 Unique identifier(UID): 任意の値 Prometheus: 先程追加した  data source  を選択 を設定し、 Import  をクリックします。 表示される ダッシュ ボードの一部ですが、テンプレートを取り込むだけで簡単にモニタリングが出来ています。 キャプチャには入っていませんが、 ディスク使用量 ディスクIO ロードアベレージ 等もグラフ化されています。 やってよかったこと サーバのモニタリングができるようになった 結構簡単にできた インストールが簡単 ダッシュ ボードの設定もテンプレートを利用するだけ 拡張性が高いことがわかった exporterを追加することで、別のモニタリングも可能 対象サーバの追加も容易にできそう ディスク枯渇を事前に検知できた 日々ディスク使用量が増加していることが分かった 作業ファイルの削除漏れを見つけ、定期的に削除するようにした 実行するJobの数を調整した メモリ使用量を確認し適切な実行数となるよう調整した まとめ 環境構築からモニタリングを行えるところまでを紹介しました。 今回は、1サーバで1項目だけのモニタリングを紹介しましたが、対象サーバやモニタリング項目の追加も 容易に行えますので、気になる方はぜひ試して頂ければと思います。
はじめに こんにちは。フロントエンド開発課に所属している新卒1年目のm_you_sanと申します。 今回はissue formsを使って GitHub Issuesのテンプレートを作成する方法について、紹介したいと思います。 はじめに issue formsとは?導入するメリットは? 作り方 まとめ issue formsとは?導入するメリットは? issue formsは、 GitHub 上で提供される GitHub Issuesに入力フォームを追加する機能です。 GitHub Issuesでは、デフォルトで大きめのテキストエリアが1つ提供されていますが、そのまま運用すると以下のような問題が起こります。 具体的に何を書いて良いのかわからない 人によって記載粒度にばらつきがある 欲しい情報が記載されていない場合がある 上記の問題は MarkDown 形式のテンプレートでも、ある程度改善することはできますが、記入者がテンプレートを無視して自由に記載できてしまうなどの欠点があります。 一方でissue formsでテンプレートを作ることで、小項目に分けることができるので、記入者がどこに何を書けば良いのかが明確になります。 また、 MarkDown 形式のテンプレートと異なり、記入者がテンプレートを無視することができないため、記入者による書き方のばらつきが起こりにくくなります。 加えて、条件付きではありますが、issue formsでは必須項目の指定ができるので、欲しい情報を記入者に入力させることが可能です。 作り方 今回は例として、バグ報告用と改善・リファクタ用のテンプレートを作成します。 まずプロジェクト直下に .github/ISSUE_TEMPLATE/ を作成し、その下に yaml ファイルを置きます。 //ディレクトリ構成 . ├── .github │ └── ISSUE_TEMPLATE │ ├── bug_report.yml │ ├── enhancement_request.yml │ ├── config.yml : 次に bug_report.yml を編集します。 # bug_report.yml name : バグ報告 description : 不具合報告はこちら title : 'Bug: ' body : - type : textarea id : overview attributes : label : 概要 description : | 不具合の概要を記載してください。 見た目に関係する場合は、スクリーンショット等を貼り付けてください。 validations : required : true - type : input id : environment attributes : label : 再現環境 description : | 再現環境を記載してください。 例: Chrome + Windows Edge + Windows Chrome + macOS Safari + macOS validations : required : true - type : textarea id : process attributes : label : 再現手順 description : 不具合を再現させる手順を記載してください。 value : | 1. 2. 3. ... validations : required : true - type : textarea id : supplement attributes : label : 補足 キーの詳細は以下の通りです。 キー 説明 必須 name テンプレートの名前。一意である必要があります。 〇 description テンプレートの説明。名前の下に表示されます。 〇 title タイトルに事前に入力されているテキスト。 × body フォーム全体の内容。 〇 type フォームの要素。 checkboxes、dropdown、input、 markdown 、textareaの中から指定できます。 〇 id フォーム要素の識別子。フォーム定義内では一意である必要があります。 × attributes フォーム要素のプロパティを定義するキーと値のペア。 〇 label フォームのラベル。 〇 description フォームの説明。ラベルの下に表示されます。 × value 事前にフォームに入力されているテキスト。 × validations フォームのバリデーションを定義するキーと値のペア。 × required trueにすると入力必須になります。 public リポジトリ の場合のみ有効になります。 × 同じように enhancement_request.yml も編集します。 # enhancement_request.yml name : 改善・リファクタ description : 改善・リファクタはこちら body : - type : textarea id : background attributes : label : 背景 description : どのような課題を抱えてissueを立てたのか、経緯や前提を記載してください。 validations : required : true - type : textarea id : merit attributes : label : メリット description : 改善することでどのようなメリットがあるのかを記載してください。 validations : required : true - type : textarea id : do attributes : label : やること description : このissueで取り組むことを記載してください。 validations : required : true - type : textarea id : supplement attributes : label : 補足 最後に config.yml を編集します。 この config.yml は、新しくissueを作成する際に表示されるテンプレート選択画面をカスタマイズするためのファイルです。 今回は blank_issues_enabled をfalseにすることで、issue formsで作成したテンプレートのみを選択できるようにしています。 # config.yml blank_issues_enabled : false push後、画面を確認して以下のようになっていれば完成です。 テンプレート選択画面 バグ報告用テンプレート 改善・リファクタ用テンプレート まとめ 今回は、issue formsで GitHub issuesのテンプレートを作成する方法について紹介させていただきました。 私が所属しているチームでは、実際にissue formsを運用しているのですが、デフォルトのテンプレートを使っていたときに比べて、issueの管理がしやすくなったので、気になった方は是非試してみてください。 参考資料 docs.github.com docs.github.com
ラク スでは多くの SaaS プロダクトを開発・運用しており、オンプレミスまたは クラウド を適切に選択してインフラ基盤を構築しています。 そのインフラを担うのが、 ラク スのインフラ開発部です。 今回はインフラ開発部のマネージャーが厳選した、インフラエンジニアにおすすめの書籍10選をご紹介します。 それぞれの書籍に推薦コメントを記載していますので、是非ご参考になさってください。 選定基準は以下の通りで、今後インフラを深く理解し実力をつけていきたい方にも最適です。是非ご覧ください。 「すぐに役に立つがすぐに廃れる知識ではなく、10年以上使える書籍」 「分かりやすい本ではなく、難解ではあるがきちんと原理・原則を学べる書籍」 目次 目次 Operating Systemを理解しよう 詳解 Linuxカーネル 第3版 DNS & BIND 第5版 トラブルシューティングを理解しよう 詳解 システム・パフォーマンス 第2版 パケットキャプチャ入門 LANアナライザWireshark活用術 第4版 分散システムを理解しよう 分散システム 第二版 Google File System セキュリティを理解しよう AWSではじめるクラウドセキュリティ: クラウドで学ぶセキュリティ設計/実装 体系的に学ぶ 安全なWebアプリケーションの作り方 第2版 脆弱性が生まれる原理と対策の実践 思考力を高めよう 失敗の科学 失敗から学習する組織、学習できない組織 なぜあの人の解決策はいつもうまくいくのか? おわりに Operating Systemを理解しよう 詳解 Linux カーネル 第3版 Daniel P. Bovet (著), Marco Cesati (著), 高橋 浩和 (監修, 読み手), 杉田 由美子 (翻訳), 清水 正明 (翻訳), 高杉 昌督 (翻訳), 平松 雅巳 (翻訳), 安井 隆宏 (翻訳) インフラ技術の基本知識である Linux Kernelの本質を学び取れる一冊。Kernelはどんな機能を持ち、管理、処理しているのか。OSコア機能であるKernelを知ることはインフラエンジニアとしての基本的素養といえます。 DNS & BIND 第5版 Cricket Liu (著), Paul Albitz (著), 小柏 伸夫 (翻訳) DNS に関係する機能全般の詳細解説書です。OS内部でも外部でも名前解決技術は深く広く利用されている。名前解決技術を抑えることはOSのみならずシステム全般の理解を深めることとイコール。 トラブルシューティング を理解しよう 詳解 システム・パフォーマンス 第2版 Brendan Gregg (著), 西脇 靖紘 (監修), 長尾 高弘 (翻訳) インフラだけではなく、SREでも求められるシステムレスポンスについての知識、調査、分析方法を網羅的に記載している良書です。 システムがスローダウンし原因不明の際には必ず目を通したい一冊。 パケットキャプチャ入門 LANアナライザ Wireshark 活用術 第4版 ネットワークパケット解析ツール Wireshark の利用法が記載されています。ネットワークありきのシステム運用においてトラブル解決にパケット取得、分析スキルは必須です。 tcpdump だけではなく wireshark を用いることで迅速かつより明快に分析が可能になります。 分散システムを理解しよう 分散システム 第二版 アンドリュー・S・タネンバウム (著), マールティ ン・ファン・ス ティー ン (著), Andrew S. Tanenbaum (著), Maarten van Steen (著), 水野 忠則 (翻訳), 佐藤 文明 (翻訳), 鈴木 健二 (翻訳), 竹中 友哉 (翻訳), 西山 智 (翻訳), 峰野 博史 (翻訳), 宮西 洋太郎 (翻訳) PublicCloudでは分散システムの利用が容易に可能になっていますが、これをオンプレで実現するためには分散システムの全体像、構成する機能群を学びとる必要があります。 自前のPrivateCloud構築、運用に対応できる知識をこの書籍で身につけることができます。 Google File System Sanjay Ghemawat, Howard Gobioff, and Shun-Tak Leung(著) 分散システムを体現したシステムでもあり、分散システムのコアシステムである Google File Systemの理解を深めることで分散システムを実践的に学び取ることが出来ます。難解に見えますが、 アメリ カの大学にて分散システムを扱う際の教材にもなっています。 https://web.mit.edu/6.033/www/papers/gfs-sosp2003.pdf セキュリティを理解しよう AWS ではじめる クラウド セキュリティ: クラウド で学ぶセキュリティ設計/実装 松本 照吾 (著), 桐谷 彰一 (著), 畠中 亮 (著), 前田 駿介 (著) AWS を題材にセキュリティの基本を学べる書籍で、「 クラウド における特徴ポイント」を学び取ることができます。 AWS はrootアカウントの設定に不備があると、乗っ取りや不正利用の被害にあい、数百万の利用料金を請求されるケースも多発しています。基礎 からし っかり学んでおく必要があります。 体系的に学ぶ 安全なWebアプリケーションの作り方 第2版 脆弱性 が生まれる原理と対策の実践 徳丸 浩 (著) インフラ基盤だけではなく、アプリケーションの設計、実装不備によっても外部侵入は起こりえます。インフラエンジニアだからアプリ側の知識は不要というわけではなく、少なくとも設計時に指摘ができる程度の知識を身につけておくことは必要です。   思考力を高めよう 失敗の科学 失敗から学習する組織、学習できない組織 マシュー・サイド (著), 有枝 春 (翻訳) エンジニアリングにおいて設計、テスト、運用、あらゆる場面に失敗は紛れ込みます。その失敗にどう対処すべきか、他業種事例からも学び取れる一冊。 なぜ失敗するのか、なぜ失敗から学ぶ必要があるのかを具体例を挙げて記載している良書です。 なぜあの人の解決策はいつもうまくいくのか? 枝廣 淳子 (著), 小田 理一郎 (著) システム思考+問題解決を扱った書籍です。 ロジカルシンキング は一つの事象を一時点でスナップショットし、分析、比較します。しかし、実際のシステムはいくつもの事象の集合体であり、時間軸によっても変化していきます。システム思考を身につけることで一つの事象だけではなく、全体、フローの概念を加えてさらに高い次元で問題解決できる思考力を身につけることができます。 おわりに 今回は、原理原則をしっかり学ぶことができ、10年先にも活かせる知識が身につく書籍を中心に紹介しました。 ラク スでの実務体系や利用技術に沿って「Operating System」、「 トラブルシューティング 」、「分散システム」、「セキュリティ」の知識、そして「思考力」を高めるラインナップとなっていますので、通して読んでいただくことでインフラエンジニアとしての実力をバランスよく高められるのではないかと思います。 是非手にとっていただき、都度立ち返ってみていただければ幸いです。
はじめに こんにちは、Hiropyです。 今回は、 Java のComparatorについて簡単に解説できればと思います。 はじめに Comparatorとは? compareメソッドの使用方法 使用例 Comparableとの違い 主なメソッド comparing reversed naturalOrder・reverseOrder nullsFirst・nullsLast thenComparing まとめ Comparatorとは? Comparator は、「比較者」という和訳の通り オブジェクト同士の比較 を行うインタフェースで、主にList等の ソート (並べかえ)に使われます。 型パラメータTを持つ 関数型インタフェース で、抽象メソッドの compare (T o1, T o2)を実装することで大小比較ができるようになります。 後述する通り便利なメソッドが複数あり、毎回compareを実装する必要がないこともポイントです。 ※この記事には関数型インタフェースや ラムダ式 が特に説明なく登場します。よくわからない方はまずそちらから調べてみてください。 compareメソッドの使用方法 compare (T o1, T o2)は、 o1が小さい(ソートしたとき先に並ぶ)ときは返り値が負に、o1が大きい(後に並ぶ)ときは正に、等しいときは0 になるように実装します。 例えば、String型を文字数で比較(短いほうを「小さい」と判定)したい場合、実装は以下のようになります。 // s1のほうが短いときはs1.length() < s2.length()なので負の値を返す、s1のほうが長いときはその逆で正を返す Comparator<String> stringComparator = (String s1, String s2) -> s1.length() - s2.length(); より複雑な実装も可能です。 以下のComparator は、heightが小さいほうを「小さい」と判定し、heightが同じ場合は、weightが大きい方を「小さい」と判定する一風変わったものです。 class Person { public int height; public int weight; } Comparator<Person> personComparator = (p1, p2) -> { if (p1.height != p2.height) { return p1.height - p2.height; } return p2.weight - p1.weight; }; 使用例 配列やリストには、Comparatorを用いたソートを行うメソッドが用意されています。 以下に代表的なものを挙げますが、基本的にソート後の並びは 昇順 (小さい順)です。 (無論ソートメソッドの実装次第で並び順が降順やその他の順になっているものも存在し得ます) 以下の例では、先程のstringComparatorを用いてList を文字数の昇順で並べ替えています。 Comparator<String> stringComparator = (String s1, String s2) -> s1.length() - s2.length(); List<String> wordList = new ArrayList<>(Arrays.asList( "Today" , "is" , "a" , "good" , "day" )); System.out.println(wordList); // >[Today, is, a, good, day] // stream().sortedは元のリストを変更せずに新しいストリームを返す List<String> sortedList = wordList.stream().sorted(stringComparator).toList(); System.out.println(sortedList); // >[a, is, day, good, Today] // List.sortは元のリストを変更する wordList.sort(stringComparator); System.out.println(wordList); // >[a, is, day, good, Today] List<String> wordList2 = new ArrayList<>(Arrays.asList( "This" , "is" , "a" , "pen" )); // Collections.sortも元のリストを変更する Collections.sort(wordList2, stringComparator); System.out.println(wordList2); // >[a, is, pen, This] もちろん、1回しか使わないときはいちいちComparator変数を定義しなくてもソートする関数の引数内に記述すればOKです。 List<String> wordList = new ArrayList<>(Arrays.asList( "Today" , "is" , "a" , "good" , "day" )); List<String> sortedList = wordList.stream().sorted((String s1, String s2) -> s1.length() - s2.length()).toList(); // >[a, is, day, good, Today] Comparableとの違い Comparatorと似た名前の比較用インタフェースとして、 Comparable が存在します。 Comparableも型パラメータTを持つ関数型インタフェースで、実装時には compareTo (T o)を実装する必要があります。 このcompareToはクラス内蔵のComparatorのようなもので、 インスタンス の比較がしたいクラスであらかじめ比較方法を実装しておくものです。 Comparableを実装したオブジェクトをソートするときにメソッドを引数なしや引数nullで呼び出すと、メソッドにもよりますがcompareToを使用した昇順ソートがなされることが多いです。 なお、compareToの比較による順序付けのことを 自然順序付け といいます。 class Person implements Comparable<Person>{ public int age; public Person( int age) { this .age = age; } @Override // thisが小さいときは負の数を、thisが大きいときは正の数を、同じときは0を返すよう実装 public int compareTo(Person p) { return this .age - p.age; } } List<Person> people = new ArrayList<>(Arrays.asList( new Person( 10 ), new Person( 30 ), new Person( 20 ))); // stream.sortedでは引数なしで呼び出す List<Person> sortedPeople = people.stream().sorted().toList(); // List.sortでは引数nullで呼び出す people.sort( null ); // いずれも[10, 20, 30] Comparableは クラス内で一度実装すれば毎回ソートの際の比較方法を書かなくていい というメリットがあります。 一方でComparatorはソート時に毎回実装するので、 同じクラスでもその場に合わせた色々な基準でソートできる ソートする場所に比較方法を書くのでパッと見て何でソートするのかわかりやすい といった点がメリットです。 両方使用して、「Comparableを実装しておいて普段は自然順序付け、特別な並べかえ方法を使いたいときはComparator」といった運用方法も可能です。 ちなみに、 JDK に含まれているメジャーなクラスにも、Comparableを実装しているクラスは以下のように複数存在します。 IntegerやDouble, BigDecimal など数値系は、数値の昇順に並ぶ Stringは、辞書順の昇順に並ぶ LocalDateTimeなどの日付時刻系は、日付時刻の昇順に並ぶ 主なメソッド 前述の通りComparatorにはcompare以外にもstatic・defaultメソッドがいくつか用意されています。 これらを使用することで、より短く、見やすいコードで比較・ソートが行えます。 comparing Comparator. comparing (Function keyExtractor)では、引数に「Comparatorを実装したオブジェクトを返すメソッド」を実装したFunctionを入れることで、そのメソッドの返り値を自然順序付けで比較するComparatorが返されます。 オブジェクトの比較は、数値型(Integer, Doubleなど)の変数やlengthなど何らかの 数値 を使って行うことが多いかと思いますが、 この際compareを実装してComparatorを作る場合は同じメソッドの呼び出しを2回書くことになるほか、「どっちからどっちを引くと昇順だっけ?」と迷うことも少なくありません。 comparingを使用するとメソッドを1回書くだけで済むので、コーディングミスを減らすことが可能です。 Comparator<String> stringComparator = Comparator.comparing(s -> s.length()); // Comparator<String> stringComparator = (String s1, String s2) -> s1.length() - s2.length(); と同じ // メソッド参照を使用するとより簡潔に書ける Comparator<String> stringComparator2 =Comparator.comparing(String::length); 数値型に限らず、例えばStringを返すメソッドを入れた場合、辞書順で比較するComparatorになります。 class Person { public String name; public Person(String name) { this .name = name; } public String getName() { return name; } } List<Person> people = new ArrayList<>(Arrays.asList( new Person( "Hinata" ), new Person( "Emily" ), new Person( "Tsubasa" ))); List<Person> sortedList = people.stream().sorted(Comparator.comparing(Person::getName)).toList(); // > [Emily, Hinata, Tsubasa] また、引数を2つ取るcomparing(Function keyExtractor, Comparator keyComparator)もあり、この場合は自然順序付けではなく第2引数のComparatorで比較します。 reversed このメソッドを呼び出したComparatorの 逆順 で判定を行うComparatorを返します。 降順 でソートしたい場合や既存のComparatorの逆順でソートしたい場合、このメソッドを使うと便利です。 List<String> wordList = new ArrayList<>(Arrays.asList( "Today" , "is" , "a" , "good" , "day" )); List<String> sortedList = wordList.stream().sorted(Comparator.comparing(String::length).reversed()).toList(); // >[Today, good, day, is, a] naturalOrder・reverseOrder Comparator. naturalOrder ()は、Comparableを実装したオブジェクトについて、自然順序付けで比較をするComparatorを返します。 Comparator. reverseOrder ()は、Comparableを実装したオブジェクトについて、自然順序付けの 逆順 で比較をするComparatorを返します。 List<Integer> numberList = new ArrayList<>(Arrays.asList( 4 , 2 , 3 , 5 , 1 )); List<Integer> naturalSortedList = numberList.stream().sorted(Comparator.naturalOrder()).toList(); // > [1, 2, 3, 4, 5] // Comparableの項で書いた通り、以下のように書いても同じ結果になる // List<Integer> naturalSortedList = numberList.stream().sorted().toList(); List<Integer> reverseSortedList = numberList.stream().sorted(Comparator.reverseOrder()).toList(); // > [5, 4, 3, 2, 1] nullsFirst・nullsLast Comparator. nullsFirst (Comparator comparator)は、nullをnull以外より小さいとみなし、両方がnull以外なら引数のcomparatorによる比較を行うComparatorを返します。 つまり、ソート時にnullが先頭に来ることになるのです。 Comparatorを実装する際に比較対象にnullが入ってくると NullPointerException が発生する場合がありますが、 List<String> wordList = new ArrayList<>(Arrays.asList( "Today" , "is" , "a" , "good" , "day" , null )); List<String> sortedList = wordList.stream().sorted(Comparator.comparing(String::length)).toList(); // > NullPointerException nullsFirstを使用することで例外発生を防ぐことができます。 List<String> wordList = new ArrayList<>(Arrays.asList( "Today" , "is" , "a" , "good" , "day" , null )); List<String> sortedList = wordList.stream().sorted(Comparator.nullsFirst(Comparator.comparing(String::length))).toList(); // > [null, a, is, day, good, Today] nullsLastはその逆で、nullをnull以外より大きいとみなす、つまりソート時にnullが末尾に来るようなComparatorを返します。 thenComparing 複数条件でソート するときに使用するメソッドです。 Comparatorの後ろにつけて引数で比較条件を指定することで、そのComparatorが0を返したときに追加の条件で比較することができます。 引数にはComparatorの他、comparingと同様FunctionやFunction+Comparatorを入れることが可能です。 以下の例では、Stringのリストを文字数の昇順で、文字数が同じものについてはStringの自然順序付け(辞書順)で並べ替えています。 List<String> wordList = new ArrayList<>(Arrays.asList( "cat" , "dog" , "apple" , "banana" , "elephant" , "ant" , "zebra" )); List<String> sortedList = wordList.stream().sorted(Comparator.comparing(String::length).thenComparing(Comparator.naturalOrder())).toList(); // > [ant, cat, dog, apple, zebra, banana, elephant] まとめ Comparatorは Java でソートを行う際に非常に重要になるインターフェースです。 Webアプリなどではそもそも SQL のORDER BYでソートしているから Java でソートをする場面は必ずしも多くないかとは思います。 とはいえ Java 側での処理の途中でソートを行う処理もあったりするので、使いかたを覚えておいて損はないでしょう。 本記事がComparator、ひいてはソートの理解に少しでも役立てれば幸いです。
新卒1年目のTKDSです! 今回は、AIコーディング支援サービスである、 Amazon CodeWhispererの導入方法について記事を書きました。 個人での利用は無償ですので、自宅などでは費用をかけずにAIコーディング支援サービスを利用できて便利でした。 Amazon CodeWhispererの情報 導入の手順 1. 最新の AWS Toolkit プラグインをVS Codeにインストール 2. 認証 3. AWS Builder IDの作成 試す まとめ Amazon CodeWhispererの情報 公式サイト https://aws.amazon.com/jp/codewhisperer/ 公式サイトのインストール情報 https://aws.amazon.com/jp/codewhisperer/resources/#Getting_started 導入の手順 今回は VS Code にCodeWhispererを導入する手順をご紹介します。 1. 最新の AWS Toolkit プラグイン を VS Code にインストール VS Code 用の AWS Toolkitのサイト https://aws.amazon.com/jp/codewhisperer/resources/#Getting_started 拡張機能 のストアを開き、インストールを選択します。 2. 認証 インストール完了すると次の画面が表示されるので、CodeWhispererを選択します。 クリックすると以下の内容が展開されます。 「 Sign up or Sign in」を選択します。 ブラウザで認証と AWS Builder IDの作成に移ります。 3. AWS Builder IDの作成 Emailを使ってBuilder IDを作成します。 登録すると、メール認証が行われ、完了すると再度 VS Code の画面に遷移します。 試す 少しだけコード補完を試してみました。 コード補完が実際に働いていることが確認できました。 まとめ 今回はCodeWhispererを導入してみました。 GitHub Copilotと比べるとやや使いにくさを感じましたが、無償と考えると十分なのではないでしょうか。 ぜひ記事をご覧になった方はお試ししてみてください。
はじめに こんにちは。フロントエンド開発課に所属している新卒1年目のm_you_sanと申します。 今回はTypeScriptのinferについて紹介したいと思います。 はじめに inferとは? 具体的な使用例 関数の戻り値の型を推論する Promiseの内部の型を推論する 配列の中身を推論する 文字列リテラルと組み合わせる まとめ inferとは? inferは 型推論 する際に使われるキーワードで、 ジェネリクス 型と条件型(Conditional Types)と合わせて使われます。 inferを使うことで、関数の戻り値や配列の中身など、 ジェネリクス 型の内容によって変化する型情報をConditional Typesの条件分岐の中で推論することができます。 具体的な使用例 関数の戻り値の型を推論する inferは組み込み型のReturnTypeの内部で実は使われています。 型変数の R が、 型推論 が行われる部分です。 下記のコードでは、 ジェネリクス 型の T が関数である場合、その戻り値の型を R として推論し、その R がReturnTypeの結果として得られます。 関数が ジェネリクス 型である場合、戻り値は文字列や数値などの様々なパターンがありますが、inferを使うことで柔軟に型情報を取得することができます。 type ReturnType < T > = T extends ( ...args: any [] ) => infer R ? R : any ; const helloFn = () => "Hello World" ; const addtion = ( num1: number , num2: number ) => num1 + num2 ; const isEvenNumber = ( num: number ) => num % 2 === 0 ; //string型になる type HelloFnReturnType = ReturnType <typeof helloFn >; //number型になる type AddtionReturnType = ReturnType <typeof addtion >; //boolean型になる type IsEvenNumberReturnType = ReturnType <typeof isEvenNumber >; Promiseの内部の型を推論する inferを使うことで、Promise型が内包している型を推論することができます。 下記のコードでは、 ジェネリクス 型の T がPromise型であった場合、Promiseの型引数の部分を R として推論して、その R がExtractPromiseの結果として得られます。 type ExtractPromise < T > = T extends Promise < infer R > ? R : never ; //string型になる type SampleStringType = ExtractPromise < Promise < string >>; //number型になる type SampleNumberType = ExtractPromise < Promise < number >>; 配列の中身を推論する inferを使うことで、配列の中身を推論することもできます。 下記のコードのFisrtは、 ジェネリクス 型の T が配列の型だった場合、その配列の先頭の要素を R として推論します。 Array1の場合、先頭の要素以外(2と3)は ...any[] となって、1のみが R として推論されるため、結果としてArray1FirstTypeは1となります。 type Fisrt < T extends any [] > = T extends [ infer R , ... any []] ? R : never ; type Array1 = [ 1 , 2 , 3 ] ; type Array2 = [ "1" , 2 , 3 ] ; //1になる type Array1FirstType = Fisrt < Array1 >; //"1"になる type Array2FirstType = Fisrt < Array2 >; 文字列 リテラル と組み合わせる inferは文字列 リテラル と組み合わせることができます。 Replaceは文字列 S に含まれる文字列 T を U に置き換える型です。 具体的な処理の流れとしては、まず初めにstring型の S に T が含まれているかをConditional Typesを用いてチェックしています。 このとき、 T の前後の文字列をそれぞれ A 、 B として推論しています。 最後に T を U に置き換えて、推論された A と B を文字列 リテラル で結合させて、結果として返します。 下記の例では、 A は「NO」、 B は「NO LIFE」になり、 T の「MONEY」が U の「CAT」に置き換わるため、結果として「NO CAT NO LIFE」が得られます。 type Replace < S extends string , T extends string , U extends string > = S extends ` ${ infer A }${ T }${ infer B } ` ? ` ${ A }${ U }${ B } ` : never ; //NO CAT NO LIFEになる type replaced = Replace < " NO MONEY NO LIFE" , "MONEY" , "CAT" >; まとめ 今回はtypescriptのinferについて紹介させていただきました。 個人的には、関数の戻り値やPromiseの型引数など、型情報が不確定なものに対しても、inferを使うことで柔軟に型情報を取得できるところが魅力的に感じました。 inferの使い方について、更に深堀したい方は type-challenges に取り組んでみるのが良いかと思います。
こんにちは。フロントエンド開発課所属の koki _matsuraです。 今回はPlaywrightの コンポーネント テストについて個人的な意見を書いています。 目次は以下の通りになっています。 はじめに 導入方法 Playwright Component Test Runner のスゴい点 コンポーネントが実際にレンダリングされる 画面のサイズを指定できる タイムゾーンや言語を指定できる コンポーネントの振る舞いを見るテストに対応できる まとめ 参考 はじめに Playwrightは Microsoft が開発・メンテナンスしているCypress、Puppeteerなどと同じE2E自動テスト フレームワーク として有名です。 playwright.dev Chromium 、Edge、 Firefox などの複数のブラウザに対応しており、全てに単一の API で簡単にテストの実装が可能になっています。 目玉機能としては、コード生成が挙げられるのではないでしょうか。 コード生成とはユーザが画面を実際に触り、それがコードとして自動で反映されていく機能で手っ取り早くテストを開始するには最適な機能です。 他にも素晴らしい機能があるのですが、その中でも現在、実験的に試されているComponent Test Runnerがとても興味をそそられました。 そこで導入方法とPlaywright Component Test Runnerの個人的に凄いと思った点を紹介していきます。 導入方法 プロジェクトのトップで下記のコマンドを実行してください。通常のPlaywright導入コマンドにオプションでctをつけたような形になっています。 npm init playwright@latest -- --ct どの フレームワーク に向けて使うのかを聞かれるので、該当するものを選択してください。今回はReact18を選択します。 次はブラウザをインストールするかを聞かれますが、デフォルト(true)にします。 これで導入が完了しました。 プロジェクトの ディレクト リには3つのファイルが追加されていると思います。以下がそれぞれの簡単な役割となっています。 playwright / index.html テストの対象となる コンポーネント を レンダリング するためのhtmlファイル playwright / index. tsx index.htmlに対して、 スタイルシート の反映、テーマの適用などをするためのファイル playwright-ct.config.ts コンポーネント テストの設定を行うファイル テスト対象 ディレクト リを設定したり、 タイムアウト の設定、テストをするブラウザの設定が可能 テストファイルを作成すれば、 npm run test-ct でテストが実行できます。 Playwright Component Test Runner のスゴい点 コンポーネント が実際に レンダリング される 昨今の コンポーネント テストでよく使われているテストランナーはVitest・Jestではないでしょうか。そして、テストランナーとともに使われるJSDomなどはNode.js環境でDOMをエミュレートするためのライブラリであり実際のブラウザに レンダリング されているわけではありません。 ブラウザと完全に同じ レンダリング になるかわからないという問題があります。 しかし、Playwrightは index.html を通して、対象の コンポーネント が実際のブラウザに レンダリング されます。 つまり、ユーザの環境に限りなく近い状態でテストが可能となります。 また、副作用的なメリットとして今まではNode.js上でDOMをエミュレートしていたため、testing-libraryやuser-eventが必要になってましたが、それも要らなくなります。 Playwright Component Test Runnerのみで基本的なテストはできます。 以下は チェックボックス のテストを例に比較したものです。 内容自体は同じですが、簡潔に書けていることがわかります。 // @playwright/experimental-ct-reactを使わない例 import { AddressForm } from "../../Checkout/AddressForm" ; import { render } from "@testing-library/react" ; import { screen } from "@testing-library/dom" ; import { it , expect } from "vitest" ; import userEvent from "@testing-library/user-event" ; import "@testing-library/jest-dom/vitest" ; it ( "チェックボックスをクリックするとcheck状態が切り替わる" , async () => { render (< AddressForm / >); const user = userEvent.setup (); const checkbox = screen.getByRole ( "checkbox" ) as HTMLInputElement ; await user.click ( checkbox ); expect ( checkbox ) .toBeChecked (); } ); // @playwright/experimental-ct-reactを使う例 import { test , expect } from "@playwright/experimental-ct-react" ; import { AddressForm } from "../../Checkout/AddressForm" ; test ( "チェックボックスをクリックするとcheck状態が切り替わる" , async ( { mount , } ) => { const component = await mount (< AddressForm / >); const checkbox = component.getByRole ( "checkbox" ); await checkbox.click (); expect ( checkbox ) .toBeChecked (); } ); 画面のサイズを指定できる コンポーネント には画面のサイズによって見た目が変わるレスポンシブなものもよくあります。 このような コンポーネント をviewportを変えてテストするようなことはあまりないと思います。 そもそも、そのようなテストをVitest・Jestでするにはwindow.innerWidthやwindow.innerHeight、そしてresizeイベントなどで実装することになり非常に困難です。 だからと言って、E2Eテストで行うには適さないため、手動で確かめることが必要とされることが多いのでないでしょうか。 Playwright Component Testはそれを解決します。 方法は以下のようにviewportを設定するだけです。 テストファイルに書けば、個々に設定でき、 playwright-ct.config.ts に書けばテスト全体に設定可能です。 import { test } from '@playwright/experimental-ct-react' ; test.use ( { viewport: { width: 1280 , height: 720 } } ); 例えば、以下のような一定の幅になるとサイドバーが ハンバーガ ーメニューになる コンポーネント があります。 この コンポーネント に対し、次のようなテストで対応します。 test.use ( { viewport: { width: 599 , height: 720 } } ); test ( 'widthが599pxの時にハンバーガーメニューになっていること' , async ( { mount } ) => { const sideMenu = await mount (< SideMenu / >); const hamburgerButton = sideMenu.getByRole ( 'button' ); await expect ( hamburgerButton ) .toBeVisible (); } ) テストを実行するとwidth: 599px、height: 720pxで レンダリング されます。 サイドバーになることを確認する場合もviewportのサイズを変えてテストするだけ大丈夫です。 また、画面サイズではなく、 iOS などの様々なデ バイス を指定したい場合も playwright-ct.config.ts から変更できます。 タイムゾーン や言語を指定できる 時間によって見た目が変わったり、ブラウザの言語設定によってテキストが変わるような コンポーネント があると思います。 以下はブラウザの言語設定によってテキストが変わるサイドバーです。 これをVitest・Jestで見た目部分のテストをするとなると非常に困難で、手動で確認したり、VRT(Visual Regresion Test)で対応することになります。 Playwrightはこれにも対応しており、先ほど同様に タイムゾーン や言語を下記のようにテストファイルに書くことで設定できます。 test.use ( { locale: "en-GB" , timezoneId: "Europe/Paris" , } ); これでブラウザの読み込み時の言語や タイムゾーン が変わるのですが、例えば、多言語対応のためにi18nextなどのライブラリを使っている場合は上手くいきません。Providerがないため、Playwrightのブラウザでは以下のような レンダリング になります。 これへの対応方法は @playwright/experimental-ct-react をインストールした際に自動で作成される playwright/index.tsx にProviderを書きます。 import { beforeMount } from '@playwright/experimental-ct-react/hooks' ; import { I18nextProvider } from 'react-i18next' ; import i18n from '../src/i18n/configs' ; beforeMount (( { App } ) => { return ( < I18nextProvider i18n = { i18n } > < App / > < /I18nextProvider > ); } ); そして、 コンポーネント テストファイル側では特に気にせず、いつも通りのテストを書くだけです。 test.use ( { viewport: { width: 600 , height: 720 } , locale: 'ja' } ); test ( 'lang="ja"の時は日本語で表示されていること' , async ( { mount } ) => { const sideMenu = await mount (< SideMenu / >); const listRoot = sideMenu.locator ( '.MuiList-root' ); const inbox = await listRoot.locator ( 'li' ) .nth ( 0 ) .innerText (); const favorite = await listRoot.locator ( 'li' ) .nth ( 1 ) .innerText (); const trash = await listRoot.locator ( 'li' ) .nth ( 2 ) .innerText (); const sent = await listRoot.locator ( 'li' ) .nth ( 3 ) .innerText (); expect ( inbox ) .toBe ( '受信トレイ' ); expect ( favorite ) .toBe ( 'お気に入り' ); expect ( trash ) .toBe ( 'ゴミ箱' ); expect ( sent ) .toBe ( '送信済み' ); } ); Playwrightのブラウザでも問題なく日本語で レンダリング されていることが確認できます。 コンポーネント の振る舞いを見るテストに対応できる PlaywrightのようなE2Eテスト フレームワーク では当然なのですが、実際のブラウザに レンダリング するという特徴が非常に強力で、例で紹介したようなVitest・Jestでは対応が困難であった 画面サイズや タイムゾーン に依存する コンポーネント のテスト や今までは仕方なく 手動で確認していたテスト 、 E2Eのような 単体テスト コードの改善 などの コンポーネント の振る舞いを見るテストに最適です。 しかし、 コンポーネント 内部のロジック面のテストにおいては今までのようにVitest・Jestで対応するのが良いと思います。 まとめ 今回はPlaywright Component Test Runnerについて個人的に凄いと思った点について軽く紹介させていただきました。 既存のPlaywrightにmount関数を組み合わせたシンプルな形でありながら、今まではPage単位だったテストをComponent単位にすることを可能にしてくれました。 Vitest・Jestと少し比較するような書き方をしてしまいましたが、どちらかのみではなく両方 を上手く使い分けることでより コンポーネント の品質を高く保てるのではないかと考えています。 また、Playwright Component Test Runnerが登場したことにより、本来Vitest・Jestがどのようなテストに取り組むべきなのかがわかってきたような気もします。 まだ実験的機能ですが、正式に公開された際には コンポーネント テストに積極的に取り込んでいきます! 最後まで読んでいただきありがとうございます。 参考 playwright.dev
皆さん、こんにちは!もしくはこんばんは! 楽楽精算プロダクトマネージャーの @wekkyyyy です。 前回は、本件の 前編 を記載させていただきました。 tech-blog.rakus.co.jp 今回は後編を記載します。 目次は以下となります。 対象読者、筆者がどういう人物か、執筆背景については、前編をご参照くださいm( )m 資料を作るときに考えていること (復習)【いざ開始】1つのアウトプットを3ステップで分けて作業する 【60点版】今一度 本当にこれだけか? なぜそうなる? その次はどうなる?を考える 【90点版】メッセージを意識する 【90点版】届ける相手を自分に憑依させる 編集後記 資料を作るときに考えていること (復習)【いざ開始】1つのアウトプットを3ステップで分けて作業する 以下の4ステップに分けて考えています。 それぞれの段階でレビューにかけます。 ★注意点 レビュー相手としては、上長はもちろんですが「自分にない・足りない視座がある人」に頼むといいと考えています。 レビューの目的は、この内容で「目的とした達成状態にできる・近づくかどうか」を見るためだからです。 自分と同じ観点でレビューを受けてもそれはただの二重チェックであり、レビューの目的にはそぐわないと考えています。 前編 では、30点版までの部分を記載しました。 今回は60点版〜です。 1. 15点版(全体の流れこんな感じ状態) 2. 30点版(一旦作りました状態) 3. 60点版(見直して熟成します状態) 4. 90点版(これで提出します状態) ※100点は、最終合意状態を指すので割愛します。 【60点版】今一度 本当にこれだけか? なぜそうなる? その次はどうなる?を考える 30点版 にて 定性的なデータを可視化した上で、 定量 情報を付与する行為を30点版で一度実行している前提です。 ここを今一度!ロジックに抜け漏れがないか確認・修正・補足をします。 資料は、1日寝かしてもう一度見ると改善点が見つかること※が多いですが、 ここをやるやらないで合意・説明の場でのスムーズさが変わると考えています。  ※ 前田 鎌利さん著 社内プレゼンの資料作成術【完全版】 にも記載があります 可視化(カスタマージャーニー等)したものを見て、つながりに対して、 `本当にこれだけ?`、`なぜそうなのか`、`その次はどうなる?`を再度確認します。 ※すみません。以下は説明のためにシンプルさを求めて書いたので精度は低いです。 【90点版】メッセージを意識する ここは題名の通りシンプルです。 正直個人差はでます。正解はないです。 しかし意識すべき部分はあります。 1. 今一度、【15点版】1に達成状態・2に達成状態・3、4がなくて5に達成状態に立ち戻りましょう。         a. 誰が・どのような状態になっていれば、この仕事は完遂されるのか? 2. どこからどこまでの情報で、誰に何を言いたいのか? 3. 全てのメッセージを集めると、1. の達成状態を得れるのか? こちらを今一度考えることを意識しています。 【90点版】届ける相手を自分に憑依させる いよいよ最後の仕上げです。 ここを意識できてるできてないでは、読み手に与える印象が格段に変わるな。と 実体験から感じています。 偉そうに色々書いていますが、私もうまくできてない時はあります。 (特にはじめましてな人相手だと確率は高い) ですが、ここは諦めることはしないように心がけています。 書き出すと細かいことは、ものすごい量があるのですが、 サマると意識している事項は以下です。 1. 誰がこのOutputを見るのか? 2. その人に伝わる言葉になっているか? 3. その人にどう動いて欲しいのか? a. その人にどの流れで理解をしてほしいか? b. その人にどこに注力して見てほしいか? c. その人の利益になる情報を与えているか? d. その人に次にどういうアクションをしてほしいのか? 編集後記 楽楽精算PdMが資料を作るときに考えていること。 というテーマで書いて見ましたが、これは、、、書くのが難しいですねw Agendaのレベルで何回も書き直しました。 最初は細かすぎてブログとして読むのはしんどいな。。。というレベルから削って削って今の形にしました。 それによる弊害としても、そもそもの私の記載内容としても、 色々と足りない部分があると思います。 そこはすみませんが、 このブログをフックに様々な書籍を読んでみてください。 このブログ内容は、様々な書籍を自身で読んで・実践して・ミックスした上で、ある程度成功できる方程式を、私なりに組み上げた内容です。 ですが、 読者のみなさまを取り巻く状況によっては、過不足あるものだと思います。 ぜひ、学習してみなさんの中での方程式を組めるようにしてください。 ありがとうございました。
考えること1: JDKのEOL 考えること2: 使用しているMW(ミドルウェア)の対応バージョン 考えること3: JDK本体の更新内容 考えること4: 性能テスト まとめ 皆さんは JDK の更新をしたことがありますでしょうか。 私はこれまでやったことはありませんでした。。 理由は単純で基本的に JDK はLTS(長期サポート)を使用し更新する機会がなかったからです。 しかし今回偶然にも JDK の更新をする機会があったので更新する際にどのようなことを考えながら実施したかを 備忘録がてらご紹介したいと思います。 考えること1: JDK のEOL 現在、主に使用されている JDK は古い順から8, 11, 17, 21だと思われます。 これらはまだEOL(End of Life)を迎えておらずアップデートの対象です。 ここで Red Hat のOpenJDKのサポート期間を見てみましょう。 JDK8 JDK11 JDK17 JDK21 2026年11月 2024年10月 2027年10月 2029年12月 JDK8がそろそろEOLかと思いきやJDK11の方が早くEOLを迎えてしまいます。 これはJDK8を使用したアプリケーションが世の中に多く存在することや、 JDK8からJDK11への更新難易度が高いためと言われています。 では、最新のJDK21に更新すればOKというわけにも行きません。。これについては次で説明します。 考えること2: 使用しているMW( ミドルウェア )の対応バージョン Java は無数の フレームワーク やライブラリに支えられており開発の容易性や効率性に富んでいます。 しかし、その反面 現在はライブラリのメンテナンスが行われていないものも多く存在します。 これらが最新の JDK では動作しない可能性があります。 JDK の更新は行う際にはしっかりと各ライブラリが動作するかを確認する必要があります。 また、更新の際にはMWだけでなく静的解析ツールなども更新すべきです。 JDK の更新によって新しいコードの書き方ができるようになったりするためコード解析が正常に動作しない可能性があります。 考えること3: JDK 本体の更新内容 JDK の更新によって JDK 内部の動作に変更があり、本番コードまで影響がある場合があります。 例を上げるとすればJDK17の更新に含まれるJEP403の「 JDK 内部の強力な カプセル化 」などが挙げられます。 これによって JDK 内部の API へのアクセスが制限されるようになり一部 フレームワーク やライブラリはこの影響を受けると考えられます。 以上のような JDK の更新内容についても確認すべきです。 考えること4: 性能テスト JDK17からデフォルトの GC ( ガベージコレクション )がG1 GC に変更されました。 これを受けて主に GC の種類について検証しました。 JDK17の段階で使用できる GC は以下の通りです。 以下の GC をそれぞれ設定し性能テストを実施しチューニングを見直しました。 GC 一言説明 Serial GC シングルコア環境で主に使用する Parallel GC マルチコア環境ではJDK11までデフォルト G1 GC ヒープサイズの大きいアプリケーションに適している。JDK17からデフォルト Z GC 8MBから16TBまでのヒープサイズをサポートしている Shenandoah GC アプリケーションのスレッドと並列的に動作する GC まとめ 実際に更新に着手した際にはどこから手をつけるべきか悩むことが多いと思います。 アプリケーションの規模にもよりますが、膨大な作業を行う必要があったりもするかと思います。 今回ほぼ手探りで大規模なアプリケーションの JDK 更新を行ってみて以下のような学びがありました。 JDK のEOLを事前に確認する(JDK11のように短くなってしまう例もある) 更新を行った際のドキュメントは残しておく MWやビルドツール、静的解析ツールの更新を怠らない(EOLなMWがあると更新が難しいこともありそう) 性能テストを実行する環境があると便利(色々な種類の GC を試せた) さらっと書きましたが、実際はここに到達するまで1年以上かかってたりするので これから JDK 更新をする誰かの指針になったら幸いです。
弊社で毎月開催し、 PHP エンジニアの間で好評いただいている PHP TechCafe。 2023年4月のイベントでは「PhpStorm」について語り合いました。 弊社のメンバーが事前にまとめてきた情報にしたがって、他の参加者に意見を頂いて語り合いながら学びました。 今回はその内容についてレポートします。 「PhpStorm」を語る PhpStormとは JetBrains社とは 静的解析ツールとしての一面 最新機能 2022.3 非推奨の動的プロパティ 日時形式のプレビュー リストでの array shape の繰り返しをサポート 2023.1 3v4l.org での PHP スクラッチファイルの実行 インデックス作成中でも使用できるようになった Go to Class(クラスに移動)アクション データフロー解析に対応したデバッガー var_dump() / dd() のターミナル出力にクリック可能なパスとクラス参照を追加 新しいインスペクション ショートカット 主なコマンド 編集系 検索系 ナビゲーション 参考資料 プラグイン Marketplace Top PhpStorm Downloads Pickup 静的解析機能 他のエディタと比べて まとめ 「PhpStorm」を語る RAKUS Developers Blogには他にもPhpStormに関する記事がありますので、あわせてご覧ください。 【PhpStorm入門】基本的な使い方 PhpStormの個人的おすすめプラグイン3選 PhpStormで始めるGit生活 PhpStormとは PhpStorm はJetBrains社製の PHP 開発者に向けて設計された開発に便利な様々なツールが統合された環境、 IDE です。 公式HPにも以下のような記載があり、 PHP 開発者における大きな選択肢の一つとなっています。 PHP 開発者向けに設計された高速でスマートな IDE 以下に機能例を挙げます。 強力なコード補完/静的解析つきのエディタ 様々な リファクタリング 機能 DBクライアントサポート Gitクライアントサポート デバッガとの連携機能 JetBrains社とは JetBrains は プラハ に本社を置くソフトウェア開発企業です。 IntelliJ IDEA を筆頭に様々な言語の IDE ・ソフトウェア開発ツールの開発、販売を行っています。 PHP に注目して見ると IDE の開発だけでなく、 PHP 言語自体の開発にも貢献しており、 Nikita Popov 氏を数年雇用し PHP の開発を進めるなど PHP コミュニティへの貢献も大きいです。 PhpStormチーム 静的解析ツールとしての一面 PhpStormには強力な静的解析機能が存在します。 エディターで開かれたファイル内のコードを分析し、入力時に問題のあるコードをハイライト PHPDocを解析し引数や戻り値の型をチェック Gitコミット実行後にチェック(以前はコミット前) どの規約をチェックするのかなどを細かく設定可能 コミット時のチェックタイミングが前から後に変更されたことについては、 「コミット後だと実質プッシュ前チェック?」 「コミット前の方が個人的には良かったが、コミット内容によっては後チェックの方が良いもある」 「両タイミングでできればなお良かった」 などの意見がありました。 最新機能 ※ここで扱う最新機能は PHP TechCafe開催当時2023年4月のものとなりますのでご了承ください。 気になる最新機能をピックアップしていきます。 2022.3 https://www.jetbrains.com/ja-jp/phpstorm/whatsnew/2022-3/ 非推奨の動的プロパティ PHP8.2から非推奨警告が出るようになったことへの対応。 将来的には禁止される可能性が高いので対応していきたいです。 プロパティを追加するか #[AllowDynamicProperties] を追加するか選択できます。 <?php class EmptyClass {} $ class = new EmptyClass () ; $ class -> dynamicProperty = 'dynamicProperty' ; // ここで警告が出る 日時形式のプレビュー date()等で H``Y などの日時形式文字列を使用する時に自動補完してくれます。 言語や関数によっても形式が異なるのでマニュアルを確認しに行くことが多かったと思います。 リストでの array shape の繰り返しをサポート PHPDocの アノテーション でarray shapeを使用するとループ内で自動補完してくれます。 以前までは プラグイン を入れる必要がありました。 array shapeを書くことが明確なメリットになります。 <?php /** * @return array<string, array{post: Post}> */ function getData () : array { ... } foreach ( getData () as $ i -> $ data ) { $ data [ 'post' ] -> title ; // ここで$dataがpostというkeyがあると補完、そのvalueがPostクラスであると判断しメソッドやプロパティの補完をしてくれる } 2023.1 https://www.jetbrains.com/ja-jp/phpstorm/whatsnew/ 3v4l.org での PHP スクラッチファイルの実行 好きな PHP バージョンでス クラッチ ファイルの実行が可能になりました。 ここでは 3v4l.org について、 「完全に個人が運用しているサイトが連携されるのはすごい」 「アクセスが増えてインフラ費用がかさみそう」 「Jetbrainsはどのくらい資金提供しているのだろう」 などの話題が出ました。 インデックス作成中でも使用できるようになった Go to Class(クラスに移動)アクション ちょっとした待ち時間が減るので嬉しいです。 今後もインデックス作成中にできるアクションを増やしていく予定みたいです。 データフロー解析に対応したデバッガー xdebug ユーザは DFA デバッガ―を使用できるようになりました。 各分岐をステップ実行しなくても、実行されないコード分岐を事前に確認できます。 var_dump() / dd() のターミナル出力にクリック可能なパスとクラス参照を追加 var_dumpの出力結果から直接クラスやパス参照を出来るようになりました。 新しいインスペクション 互換性の無い戻り値の型変更 <?php class C { public function f () : int { return 1 ; } } class C0 { public function f () { // ここで警告が出て戻り値の型intを1クリックで追加出来る } } class C1 { public function f () : void { // ここで警告が出て戻り値の型を1クリックでintに変更出来る } } アサーション の置換 <?php $ this -> assertEquals ( true , $ test ) ; // 1クリックでassertTrueに変更出来る $ this -> assertEquals ( false , $ test ) ; // 1クリックでassertFalseに変更出来る ショートカット Windows / Linux : https://pleiades.io/sites/willbrains.jp/keymap/pdf/shortcut_phpstorm_windows.pdf Mac : https://pleiades.io/sites/willbrains.jp/keymap/pdf/shortcut_phpstorm_mac.pdf 「 Ctrl+E での最近使用したファイル表示をよく使う」 「 Shift+F6 でのプロパティリネームをよく使う」 など参加者の皆さんの良く使うショートカットの話題で盛り上がりました。 プロジェクトの規模や特性、はたまた個人の感性などで特別利用頻度の多いショートカットがあったりして面白いです。 個人的には汎用的なショートカットは全 IDE で統一してくれないかなと思ったりします。 主なコマンド 以下 Windows でのコマンドになっています。 編集系 説明 ショートカット コードの生成(Getter, Setter, コンストラクター など) Alt + Insert コメント化/コメント解除 Ctrl + / 自動インデント Ctrl + Alt + L 選択範囲のコードをフォーマット Ctrl + Alt + L ファイル全体をフォーマット Ctrl + Alt + Shift + L 検索系 説明 ショートカット どこでも検索 Shift2回 ファイル名で検索 Ctrl + Shift + N クラス名で検索 Ctrl + N ファイル内検索・置換 Ctrl + F / Ctrl + R プロジェクト内検索・置換 Ctrl + Shift + F / Ctrl + Shift + R 使用箇所を検索 Alt + F7 / Ctrl + F7 ナビゲーション 説明 ショートカット クラス、変数、メソッドの定義元にジャンプ Ctrl + B / Ctrl + Click 前のカーソル位置に移動 Ctrl + Alt + ⇐ 次のカーソル位置に移動 Ctrl + Alt + ⇒ 行番号を指定して移動 Ctrl + G コードブロックの最初・最後に移動 Ctrl + ] / Ctrl + [ 最近使用したファイルに切替 Ctrl + Tab 最近使用したファイルを表示 Ctrl + E 参考資料 あなたはPhpStormくんのショートカットキーを何個知っている? 【PhpStorm入門】基本的な使い方 プラグイン PhpStormには プラグイン が多くあり、公式や有志の作ったものをダウンロードすることでよりPhpStormを自分好みにより使いやすくカスタマイズできます。 Marketplace プラグイン を探してインストールすることができます。 JetBrainsスタッフのオススメPhpSrotm プラグイン やインストール数ランキングが表示されているので、人気の プラグイン が分かります。 まずWebの方でお目当ての機能を探してみてから、見つかった プラグイン をPhpStormでインストールするのがわかりやすいかもしれません。 https://plugins.jetbrains.com/phpstorm Top PhpStorm Downloads https://plugins.jetbrains.com/search?orderBy=downloads&products=phpstorm .ignore(様々な○○ignoreを管理する)やBashSupportが人気です。 他にもIdeaVimやemacsIdeasなど別エディタの操作感を再現するような プラグイン も存在します。 Markdown のように昔は プラグイン を入れて補完していたけれど現在はPhpStorm標準機能としてサポートしているというようなものも存在します。 Pickup Japanese Language Pack / 日本語言語パック PhpStormを日本語化してくれます。 Laravel Idea 有料の プラグイン です。以前は「Laravel」 プラグイン があったがメンテされておらず非推奨になりました。 Laravelを使っているとこれがないとしんどいという意見も。 有料ということもありcopilotが出てきた今は入れないという選択肢も出てくるかもしれません。 Symfony Support Symfony 用の プラグイン です。 Symfony 用の様々な追加サポートを受けられます。 PHP Annotations PHPDocの補完をサポートしてくれます。 静的解析機能 下記では一例を挙げます。 コードインスペクション コードの作成中に解析を行い、危険な箇所に対して下線で示すか、ハイライトしてくれます。解析方法は PHP ファイルをPhpStormで開くだけです。 文法の誤りをハイライトし、重要度によってハイライト部分の色が変更されるため見やすいです。重要度は個別に設定できます。 他の解析ツールを追加でインストールして使用することも可能です。 コールバックの参照 使用箇所の検索 名前変更リファクタリング 名前空間 Auto-Import(自動インポート) Optimize Imports(import文の最適化) folding for imports(import文の折りたたみ) など 静的解析ツールの導入が簡単 PHP_CodeSniffer PHPStan 他のエディタと比べて PHP の開発体験を高めるための機能が最初から備わっています コード補完 コード整形 コードインスペクション コードジャンプ 強力な検索機能 デバック Git操作 静的解析 テスト実行 DB操作 その他のエディタや IDE でも同等のことは可能ですが... 当然 PHP 専用のものではないため プラグイン を追加する必要があります 「この プラグイン おすすめだよ」であったり「これ入れるべきだよ」という意見を聞かないと勝手に気づくことができないような便利機能も数多くあります PhpStormは PHP の開発初心者でも開発体験を高めるための機能があらかじめ利用可能な状態になっています 開発しているうちに自然と便利な機能に触れることができます 初心者ほどPhpStormを使うことで開発スキルを高められる可能性があります 初心者ほど開発に必要な機能の切り分けができないのでおすすめ いきなり「有料ツールを使うのはちょっと...」と思っている方もフリートライアルがありますので是非試してみてください! 設定の共有 を行えます プロジェクトごとの設定共有 はGitを通じて可能 設定を共有することについては、 「設定ファイル(.idea)を整理して管理するのが厳しすぎる」 「共有したい設定と個人の設定が分離され切っていない」 「中にはDBの接続情報が入っていたりもする」 「検査例外・非検査例外の共有は便利」 など皆さん設定共有は試しているものの現状では中々やりきるのが厳しそうな印象でした。 まとめ PHPer御用達 IDE である PhpStorm について、イベント参加者の生の声を交えてまとめていきました。 毎日使うツールということもありたくさんの意見・コメントが出て盛り上がりました。 こんな設定があったのかこんな機能があったのかと知れるきっかけとなれば幸いです。 次はPhpStorm以外の IDE やエディタを使って PHP を開発している方の意見ももっと聞いてみたいですね。 PhpStorm使ったことない方は是非一度触ってみてください! 「 PHP TechCafe」では今後も PHP に関する様々なテーマのイベントを企画していきます。 皆さまのご参加をお待ちしております。
はじめに こんにちは、Hiropyです。 昨秋(2023年10月) IPA の データベーススペシャリスト 試験を受け、無事合格しました。 本記事では、私が行った対策法と軽い感想を紹介します。 はじめに データベーススペシャリスト試験とは 受験の動機 受験対策 午前対策 午後対策 問題選択について 結果 終わりに     データベーススペシャリスト 試験とは データベーススペシャリスト 試験は、 情報処理推進機構 (以下、 IPA )が行っている 情報処理技術者試験 の1つです。 名前の通りデータベースに関する専門性を問う試験で、 IPA の試験では 基本情報技術者試験 や 応用情報技術者試験 の上位に位置する、いわゆるレベル4の試験となります。 情報処理技術者試験 試験区分一覧より引用   ベンダー資格ではなく国家試験であることから、特定の製品に依存しない、設計・運用力を問う試験になっています。 問題は午前1,2(選択式)、午後1,2(記述式)の4段階で実施され、4つ全てで合格点を取ることで試験合格となります。午前1に関しては直近2年以内の 応用情報技術者試験 合格など一定の条件を満たすことによりスキップすることが可能です。 受験の動機 入社から3年余、業務でデータベースに接することが多かったのですが、設計や運用に関してはあまり触れてきませんでした。 とはいえ勉強するにも何からやれば…という状態で、国家試験の データベーススペシャリスト は一つのわかりやすい指標として興味を持っていました。 折しも私は2年前(2021年秋)に 応用情報技術者試験 に合格して以来 IPA 試験の合格から遠ざかっており、この秋を逃すと午前1の免除資格がなくなってしまう状態であったため、タイミング的にちょうどいいと思い受験を決めました。 受験対策 勉強期間: 3ヶ月・100時間程度 用いた教材(本のリンクに関しては同種の本の執筆時最新版を掲載しています) 情報処理教科書 https://www.amazon.co.jp/dp/4798179914/ 「専門知識+午後問題」の重点対策 https://www.amazon.co.jp/dp/4865752897/ 過去問道場 https://www.db-siken.com/dbkakomon.php なお、問題の傾向については私が受験した2023年秋時点のものであり、今後変更される場合があることをご了承ください。 午前対策 午前問題は選択式であることもあり、過去問から出る割合が高いです。 そのため、情報処理教科書をざっと読んだあとは「過去問道場をひたすらに解く⇔よくわからない箇所は教科書に立ち戻る」という方法で勉強していきました。 最初は分からなかった問題も繰り返し解くうちに覚えるようになっていき、最終的には正答率が8割を超える状態で試験に挑みました。 もちろん教科書の内容を理解し応用できるようになることも必要ですが、午前問題に関しては「過去問の問題と選択肢を覚えてしまう」という方法がかなり有効であると思います。これは他の IPA 試験でも通用する方法でしょう。 午後対策 午後問題は午後1,2とも長文を読みながら設計や運用に関する問題に記述式(一部選択式)で答えていく形式です。 午後1では数ページ、午後2に至っては10ページ程度にも及ぶ長文や複雑な図の中から答えを見つけていくことから、俗に「国語の試験」とも呼ばれています。 こちらは午前試験と違い過去問がそのまま出ることはありませんが、私は午後問題でも教科書を読むことより過去問を解いて解説を読むことをベースとした勉強方法を続けました。 午後はより深い知識が求められるはずだから教科書を熟読して知識をつけては?と思われるかもしれませんが、 データベーススペシャリスト 試験は求められる知識量はあまり多くなく、むしろ与えられた要件を正確に読み解いて回答を導く力が重要になってきます。 ですので、知識を増やすことよりも問題形式に慣れ、より速く正確に問題文を読み取れるようになることを優先して勉強を進めていきました。 問題選択について 午後問題は問題を選択する形式になっており、午後1は3問中2問、午後2は2問中1問を選択します。 出る分野としては、午後1は概念設計(ER図や関係 スキーマ など)と物理設計(パフォーマンスや同時制御など)、 SQL を主題とした問題が1問ずつ出題されることが多いです。 また午後2に関しては例年概念設計と物理設計が1問ずつ出るようでした。 私は過去問を見ながら「物理設計の分野は要求される知識に知らないものが多い」と感じたので、暗記することの少ない概念設計と既に業務である程度使っている SQL に的を絞って対策することにしました。 結果 合格点を大きく超える点数で無事合格することができました。 特に午後1はかなりの高得点が取れていますが、これは概念設計が2問出たことが大きかったです。 対策する分野を絞ることは問題形式に依存する諸刃の剣ではありますが、今回は吉と出ました。 終わりに 資格としてはデータベースの スペシャ リストとなったわけですが、「専門家になった」という気は全くしていません。 特に実務経験が増えたわけではないですし、知識を要求される分野を避けて対策を行いましたからね。 とはいえデータベースの設計をする際の頭の使い方は多少身についたかと思います。最近業務で設計をすることも徐々に出てきたので、できるだけ速く的確な設計ができるよう今回の受験体験を活かして頑張っていきたいです。 また、参考書は試験以外でも役立つと思うので、今回避けた物理分野の設計はまた見直しておこうと思います。   今回の合格で高度試験の午前1の免除資格が再度2年付与されたので、この期間内にまた何か合格できればいいなと考えています。情報処理安全確保支援士や システムアーキテクト 、2023年春に撃沈した ネットワークスペシャリスト あたりが候補です。今度は知識問題を避けることはできなさそうなので、じっくり取り組んでいこうと思います。
皆さんこんにちは!開発エンジニアをしているnkumaです! 最近ますます生成AI系の勢いが増しているのを感じる今日この頃です。 今回は、(1年くらい前の経験にはなりますが)ChatGPTを触り始めたくらいに躓いた経験から、 うまくいかないときに試していただきたい工夫をいくつかご紹介したいと思います。 本記事のターゲット お使いのChatGPTが素直じゃない方 なぜかChatGPTに作らせたいものが、どんどん逸れていってしまう方 など ※ChatGPTや シェルスクリプト といった言葉は知っている初心者を対象といたします。 そのため、そういった言葉の定義や解説は当記事では触れないのでご了承ください。 本記事のターゲット はじめに 知りたかったコツ4個 ⓵ 段階的に飲み込ませる ② パーツごとに作成してもらい、組み合わせるのは自分でやる ③ 入力データを用意して、読み込ませる ④ 都度、途中経過のファイルを出力する Before/After のスクリプト例 最後に はじめに 職場で、こんなお話を耳にしました。 昔は「パソコンが使えないおじさん」という揶揄がありましたが、 今は「AIがつかえないおじさん」でしょうね…。 胸に刺さりました。。確かにそうですよね。 ということで、「AIがつかえないおじさん」にならないようガンガン使っていこうと考えています。 ある時、丁度仕事で、とある大量の CSV データの重複を消しつつ、加工するということをする機会がありました。 早速ChatGPTにお願いして、 シェルスクリプト を書いてもらい楽をする、、予定だったのですが、 上手くいかないことこの上なし。 気づけばChatGPTの調教に時間をかけすぎていて、自分で書いた方が早かったじゃないかと感じました。 そういった経験を通して、自分が躓いたこと、気づいたことを、この記事で簡単にまとめようと思います。 技術的な内容は薄いので、どちらかといえば非技術者向けかもしれません。 とはいえ、改めて足元を確認する意義もあるかと思います。是非お気軽にお読みください。 知りたかったコツ4個 なぜか、うまくいかない悪い例: [1] CSV データの中から、列Aが"条件A"を満たす行を取り出して、列BをXXXに変更し、新しい CSV ファイルに保存するプログラムを書いてください。 ⓵ 段階的に飲み込ませる 悪い例:一気に複雑なタスクを要求している 良い例:段階的に飲み込ませている [1] 列Aが"条件A"を満たす行だけを取り出すようにしてください。 [2] 加えて、列BをXXXに変更してください。 [3] それを 新しい CSV ファイルに保存するようにしてください。 悪い例のように一気に複雑で具体的なタスクを指示すると、ChatGPTは思わぬものを出してくることが多いです。 また、なによりエラーが発生した際に原因の特定が難しくなります。 良い例のようにお願いしたいタスクを小さなステップに分け、段階的に依頼するようにしてください。 上記の例はまだシンプルなので悪い例でも意図したものが作成できるかもしれませんが、 実際に使いたいものは自分で考えるのが面倒になるくらいなので、もっと複雑かと思います。 そんな場合こそ、この工夫が役立ちます。 一気に依頼してするよりも、できる限り細かく分解して依頼していった方が、結果的に早く作成できることが多いです。 ② パーツごとに作成してもらい、組み合わせるのは自分でやる 悪い例:一気に全体の作業を依頼している 良い例:作りたいものをパーツごとに分けて作成してもらい、組み合わせるのは自分でやっている [1] CSV データの中から、列Aが"条件A"を満たす行だけ取り出す スクリプト を教えてください。 ---------------------------------------------------------------------------------- [1] CSV データの中から、列BをXXXに変更する スクリプト を教えてください。 ---------------------------------------------------------------------------------- [1] CSV データの中から、出力内容を新しい CSV ファイルに保存する スクリプト を教えてください。 ---------------------------------------------------------------------------------- ※最後に手元で、上記の スクリプト を組み合わせて利用する もっとよい方法は、組み合わせるのは自分でやることです。 1つ1つを頼むときは意図した動きができているのに、結合する際に意図しない スクリプト になってしまうのは 往々にしてあるかと思います。 であれば、パーツはお願いして、合わせるのは自分でやった方が早いというのが自分の結論です。 少し知識がないと難しいかもしれませんが、意図が分からないコードがあれば、「以下を解説して」 + 当該コードでChatGPTに頼むと詳細に解説してくれます。 それを駆使して、意図を理解しつつ、組み合わせてみましょう。 意図を理解すればまた他のものにも活かせますし!   ③ 入力データを用意して、読み込ませる 悪い例:入力データがない 良い例:入力データを用意して、読み込ませている [1] 以下のような CSV データから、国語の点数が"100"となる行を取り出して、名前列をXXXに変更し、新しい CSV ファイルに保存するプログラムを書いてください。 名前,クラス,国語の点数,数学の点数,英語の点数 太郎,A,85,90,78 花子,B,75,82,88 二郎,C,100,78,85 幸子,A,88,85,90 三郎,C,80,92,78 簡易的なもの、一部だけでもよいので、入力するデータを用意できると、ChatGPTが動作を理解しやすく、 より意図したものが作成できるかと思います。 入力データがない場合、思っていた挙動と微妙な部分で異なっていたり、実際に使ったときに、 思わぬバグを生んでしまいがちです。 調整が手間となってしまうので、多少時間がかかっても最初に具体的なデータを用意することをお勧めします。 実際のデータが使えないのであれば、ChatGPTに要件を言って作成を依頼するのが良いです! ④ 都度、途中経過のファイルを出力する 悪い例:完成版のファイルのみしか出力させない 良い例:都度、途中経過のファイルを出力する [1] CSV データの中から、列Aが"条件A"を満たす行だけを取り出したものを、step1. csv として保存してください。 [2] step1. csv から、列BをXXXに変更したものを、`step2_output. csv `として保存してください。 途中経過のファイルを出力することで、どこまで意図したものができているか、どこから狂いだしたのかを、 より具体的に把握することができます。 完成版のファイルのみでは、どこでうまくいかなくなったのか調査するのにとても手間がかかります。 途中経過を確認することで、どのステップで問題が発生しているかを特定しやすくなります。 また、途中経過のファイルは、部分的な修正の際の デバッグ や検証においても役立ちます。 例のようなそこまで複雑でない スクリプト や、細かいステップごとに出す必要はないと思いますが、 中間 セーブポイント を作る意識で出力するとよいかもしれません。 Before/After の スクリプト 例 Before: [1] CSV データの中から、列Aが"条件A"を満たす行を取り出して、列BをXXXに変更し、新しい CSV ファイルに保存するプログラムを書いてください。 After: [1] 以下のような CSV データから、列Aが"条件A"を満たす行だけ取り出したものを、step1. csv として保存してください。 名前,クラス,国語の点数,数学の点数,英語の点数 太郎,A,85,90,78 花子,B,75,82,88 二郎,C,100,78,85 幸子,A,88,85,90 三郎,C,80,92,78 ---------------------------------------------------------------------------------- [1] 以下のような CSV データから、列BをXXXに変更したものを、step2. csv として保存してください。。 ※step1. csv の中身 ---------------------------------------------------------------------------------- ※最後に手元で、上記の スクリプト を組み合わせて利用する 最後に 今回は私の経験上こうした方がうまくいっているといった工夫をお伝えしましたが、 これだけが正しいとは思いません。 日頃、皆さんがどのようなことを工夫・意識して、ChatGPTと絡んでいるのかが気になります。 そのため、方々で発信していただけるのを期待しております! また、書く上で色々検証してて思いましたが、もうエンジニアじゃなくても簡単なプログラムなら組める時代ですね。。 どう書くかはAIにお任せして、何を書くかの方を磨いていく必要があるのかなあとしみじみ。。 どちらにせよAIを活用していきたいので、作らせる技術は磨いていきたいです。 皆さんもどんどん活用していきましょう!この記事が、その一助になれれば幸いです!
はじめに こんにちは、新卒1年目のTKDSです。 今回はgitについて調べました! gitはよく使われている バージョン管理システム で、記事をご覧の皆さんも使ったことがあるのではないでしょうか? この記事では、diffコマンドのケース別の使い方について実際に試しながらご紹介します。 はじめに git diffとは? 準備 add前の変更の差分 特定のコミットとadd前の変更との変更 特定のブランチと現在のブランチの状態の比較 コミット間の変更 ブランチ間の変更 まとめ git diffとは? gitにおいて、管理しているファイルの変更の差分が見れるのがdiffコマンドです。 gitの日本語リファレンスによると、 ワークツリーとインデックスまたはツリー間の変更、インデックスとツリー間の変更、2つのツリー間の変更、マージによる変更、2つの ブロブ オブジェクト間の変更、またはディスク上の2つのファイル間の変更を表示します。 と記述されています。 今回は一部のケースを紹介します。 準備 では、実際に ディレクト リとファイルを作ってコマンドを試していきましょう。 まず、コマンドを試すための準備をします。 $ mkdir git-diff $ cd git-diff $ git init $ touch a.txt $ git add a.txt $ git commit -m " add a.txt " $ git switch -c diff-1 $ echo " change file. " > a.txt これで準備は完了しました。 次項から、ケースごとにコマンドを紹介します。 add前の変更の差分 図のように単純にファイルを変更した場合は、オプションなしのdiffコマンドで差分が確認できます。 $ git diff 次項のために、変更を反映しておきましょう。 $ git add -A $ git commit -m " 2. change file. " 特定のコミットとadd前の変更との変更 次はコミットとdiffの差分を出します。 まず変更を加えます。 $ echo " 変更と特定のコミットを比較する " >> a.txt 次にコミットのIDを調べます。 $ git log commit 94d83c65c55c14008ec9af90abbf827ab572cf46 ( HEAD - > diff-1 ) Author: shun.takeda < shun.takeda@rakus.co.jp > Date: Thu Aug 24 23:12:39 2023 + 0900 2 . change file. commit c963cd1fa1f8748eff9ce4a78684fb2d6a0b12ed ( main ) Author: shun.takeda < shun.takeda@rakus.co.jp > Date: Thu Aug 24 22:31:48 2023 + 0900 add a.txt それぞれのコミットと差分を比べてみますしょう。 $ git diff 94d83c65c55c14008ec9af90abbf827ab572cf46 diff --git a/a.txt b/a.txt index 9720d84..1e0a356 100644 --- a/a.txt +++ b/a.txt @@ -1 + 1 , 2 @@ change file. +変更と特定のコミットを比較する $ git diff c963cd1fa1f8748eff9ce4a78684fb2d6a0b12ed diff --git a/a.txt b/a.txt index e69de29..1e0a356 100644 --- a/a.txt +++ b/a.txt @@ -0 , 0 + 1 , 2 @@ +change file. +変更と特定のコミットを比較する このように、git diffにコミットIDを追記することで、特定のコミットとの差分を取ることができます。 今回した変更を追加しておきましょう。 $ git add -A $ git commit -m " diff-1: change file. " [ diff -1 17b9f12 ] diff-1: change file. 1 file changed, 1 insertion ( + ) 特定のブランチと現在のブランチの状態の比較 ファイルに変更を加えます。 echo " ファイルに変更を加えます。 " >> a.txt ではmainブランチとの差分をとってみましょう。 mainブランチでのファイルの中身は空です。 git diff の引数にmainブランチを指定します。 $ git diff main diff --git a/a.txt b/a.txt index e69de29..65005f7 100644 --- a/a.txt +++ b/a.txt @@ -0 , 0 + 1 , 3 @@ +change file. +変更と特定のコミットを比較する +ファイルに変更を加えます。 これで、mainブランチとの差分を見ることができました。 また、addした内容を除いて、今いるブランチとの差分がみたい場合は --staged をつけることで、差分が確認できます。 git diff --staged main diff --git a/a.txt b/a.txt index e69de29..1e0a356 100644 --- a/a.txt +++ b/a.txt @@ -0 , 0 + 1 , 2 @@ +change file. +変更と特定のコミットを比較する 今回した変更を追加しておきましょう。 $ git add -A $ git commit -m " diff-1: change file. " コミット間の変更 次はcommitとcommitの差分を比較します。 diff-1ブランチに戻ります。 $ git switch diff-1 ログを見て今までのコミット履歴を確認します。 $ git log commit 03bbf93929733a4c59aba01f019f3518dad5757d ( HEAD - > diff-1 ) Author: shun.takeda < shun.takeda@rakus.co.jp > Date: Fri Aug 25 09:35:23 2023 + 0900 diff-1: change file. commit 17b9f127dad5fd9a69d5a0e33deb30cb0e1da8ba Author: shun.takeda < shun.takeda@rakus.co.jp > Date: Fri Aug 25 09:18:38 2023 + 0900 diff-1: change file. commit 94d83c65c55c14008ec9af90abbf827ab572cf46 Author: shun.takeda < shun.takeda@rakus.co.jp > Date: Thu Aug 24 23:12:39 2023 + 0900 2 . change file. commit c963cd1fa1f8748eff9ce4a78684fb2d6a0b12ed ( main ) Author: shun.takeda < shun.takeda@rakus.co.jp > Date: Thu Aug 24 22:31:48 2023 + 0900 add a.txt 引数にコミットIDを指定して差分を比較してみましょう。 $ git diff 03bbf93929733a4c59aba01f019f3518dad5757d 94d83c65c55c14008ec9af90abbf827ab572cf46 diff --git a/a.txt b/a.txt index 65005f7..9720d84 100644 --- a/a.txt +++ b/a.txt @@ -1 , 3 + 1 @@ change file. -変更と特定のコミットを比較する -ファイルに変更を加えます。 これで、コミット間の差分を確認できました。 ブランチ間の変更 次はブランチ間の差分を比較します。 mainブランチに一度戻り、新たなブランチを作成します。 $ git switch -c diff-2 次に新たなブランチで、変更をadd・commitします。 $ echo " 1. 別のブランチで変更を記述 " >> b.txt $ echo " 2. 別のブランチで変更を記述 " >> b.txt $ git add -A $ git commit -m " diff-2 ファイルを追加 " [ diff -2 3c7bdda ] diff-2 ファイルを追加 1 file changed, 2 insertions ( + ) create mode 100644 b.txt 元のブランチに戻ります。 $ git switch diff-1 引数にブランチ名を指定することで、ブランチ間の差分を確認できます。 今回は、diff-1とdiff-2の差分を確認してみましょう。 git diff diff-1 diff-2 diff --git a/a.txt b/a.txt index 65005f7..e69de29 100644 --- a/a.txt +++ b/a.txt @@ -1 , 3 + 0 , 0 @@ -change file. -変更と特定のコミットを比較する -ファイルに変更を加えます。 diff --git a/b.txt b/b.txt new file mode 100644 index 0000000 ..320e7b2 --- /dev/null +++ b/b.txt @@ -0 , 0 + 1 , 2 @@ + 1 . 別のブランチで変更を記述 + 2 . 別のブランチで変更を記述 これでブランチ間の差分が確認できました。 まとめ 今回の記事では、git diffで色々な差分を確認してみました。普段よく使っているコマンドをよく知る機会になりました。他にもコマンドについても機会があれば調べてみたいと思います。 最後まで読んでいただきありがとうございました。