Laravelの構成って意外と忘れがちです。
最初にルーターがあって、ミドルウェアが呼ばれて、その後コントーローラー…etc。
Laravelに慣れてる人からすれば簡単に理解できますが、初心者に説明する際は図が分かりやすいです。
ということで今回は、Laravelの構成をPlantUMLで図にして書いてみた件について解説します。
Laravelの構成
僕がLaravelで開発をした際の構成は以下の通りです。これを図にします。
Router⇒Middleware⇒Controller⇒Service⇒Query
Laravel×PlantUML
先ほどの構成を図にして伝えるためのPlantUMLコードです。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
@startuml title Laravel構成 hide footbox ' オブジェクト宣言 participant "Router" as Router participant "Middleware" as Middleware participant "Controller" as Controller participant "Service" as Service participant "Query" as Query ' ルーターからミドルウェア activate Router Router -> Middleware ' ミドルウェアからコントローラ activate Middleware Middleware -> Controller ' コントローラからサービス activate Controller Controller -> Service ' サービスからクエリ activate Service Service -> Query ' クエリからサービス activate Query Service <- Query deactivate Query ' サービスからコントローラ Controller <- Service deactivate Service ' コントローラからミドルウェア Middleware <- Controller deactivate Controller ' ミドルウェアからルーター Router <- Middleware deactivate Middleware deactivate Router @enduml |
VSCodeで上記のファイルを開き、「Altキー」+「D」を同時押しすると、図が表示されます。
※VSCodeでPlantUMLを使えることが前提です。ここでは割愛します。
Laravel×PlantUML構成図
こんな感じ。どうよ!!
おすすめ書籍
僕はLaravelの勉強をするのに以下の書籍を購入しました。おすすめですよ!
まとめ
PlantUMLっていいですね。
図をコードで描くっていうのがいいですね。Excelとかではできない差分管理ができるので。
ではまた!