Donate245Patreon129


標準ライブラリ

このページでは、PlantUMLの標準ライブラリについて説明します。 標準ライブラリはPlantUMLの公式リリースに含まれています。 含まれるファイルは、"標準Cライブラリ"の規約に従っています。( https://en.wikipedia.org/wiki/C_standard_library を参照)

ライブラリの内容は、サードパーティのコントリビュータによるものです。貢献して下さった方々に感謝します。

Amazon Labsライブラリ

https://github.com/awslabs/aws-icons-for-plantuml

Amazon Labs AWSライブラリは、PlantUMLのスプライト、マクロ、その他のAmazon Web Services(AWS)向けサービスとリソースを提供します。

AWSコンポーネントを含むPlantUMLダイアグラムを作成するために使用します。すべての要素は公式のAWS Architecture Iconsから生成されていて、PlantUMLやC4 modelと組み合わせることで、設計、デプロイ、トポロジーをコードとして伝えるための素晴らしい手段となります。

@startuml
'Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
'SPDX-License-Identifier: MIT (For details, see https://github.com/awslabs/aws-icons-for-plantuml/blob/master/LICENSE)

!include <awslib/AWSCommon>

' Uncomment the following line to create simplified view
' !include <awslib/AWSSimplified>

!include <awslib/General/Users>
!include <awslib/Mobile/APIGateway>
!include <awslib/SecurityIdentityAndCompliance/Cognito>
!include <awslib/Compute/Lambda>
!include <awslib/Database/DynamoDB>

left to right direction

Users(sources, "Events", "millions of users")
APIGateway(votingAPI, "Voting API", "user votes")
Cognito(userAuth, "User Authentication", "jwt to submit votes")
Lambda(generateToken, "User Credentials", "return jwt")
Lambda(recordVote, "Record Vote", "enter or update vote per user")
DynamoDB(voteDb, "Vote Database", "one entry per user")

sources --> userAuth
sources --> votingAPI
userAuth <--> generateToken
votingAPI --> recordVote
recordVote --> voteDb
@enduml

AWSライブラリ

https://github.com/milo-minderbinder/AWS-PlantUML

AWSライブラリにはAmazon AWSのアイコンが含まれています。それぞれ2つの異なるサイズのアイコンがあります。

スプライトの含まれるファイルをインポートして使います。例: !include <aws/Storage/AmazonS3/AmazonS3>. インポートされると、通常のスプライトと同様、<$sprite_name>のように使用することができます。

!include <aws/common>のようにしてcommon.pumlをインクルードすると、そこに定義されたヘルパーマクロを使用することができます。common.pumlをインポートすると、NAME_OF_SPRITE(parameters...)マクロを使用することができます。

使用例:

@startuml
!include <aws/common>
!include <aws/Storage/AmazonS3/AmazonS3>
!include <aws/Storage/AmazonS3/bucket/bucket>

AMAZONS3(s3_internal)
AMAZONS3(s3_partner,"Vendor's S3")
s3_internal <- s3_partner
@enduml

Azureライブラリ

https://github.com/RicardoNiepel/Azure-PlantUML/

AzureライブラリにはMicrosoft Azureのアイコンが含まれます。

スプライトの含まれるファイルをインポートして使います。例: !include <azure/Analytics/AzureEventHub.puml> インポートされると、通常のスプライトと同様、<$sprite_name>のように使用することができます。

!include <aws/common>のようにしてAzureCommon.pumlをインクルードすると、そこに定義されたヘルパーマクロを使用することができます。AzureCommon.pumlをインポートすると、NAME_OF_SPRITE(parameters...)マクロを使用することができます。

使用例:

@startuml
!include <azure/AzureCommon.puml>
!include <azure/Analytics/AzureEventHub.puml>
!include <azure/Analytics/AzureStreamAnalytics.puml>
!include <azure/Databases/AzureCosmosDb.puml>

left to right direction

agent "Device Simulator" as devices #fff

AzureEventHub(fareDataEventHub, "Fare Data", "PK: Medallion HackLicense VendorId; 3 TUs")
AzureEventHub(tripDataEventHub, "Trip Data", "PK: Medallion HackLicense VendorId; 3 TUs")
AzureStreamAnalytics(streamAnalytics, "Stream Processing", "6 SUs")
AzureCosmosDb(outputCosmosDb, "Output Database", "1,000 RUs")

devices --> fareDataEventHub
devices --> tripDataEventHub
fareDataEventHub --> streamAnalytics
tripDataEventHub --> streamAnalytics
streamAnalytics --> outputCosmosDb
@enduml

Cloud Insight

https://github.com/rabelenda/cicon-plantuml-sprites

このリポジトリには、Cloudinsightのアイコンから生成したPlantUMLスプライトがあります。PlantUMLの図の中で簡単に使用することができ、一般的なテクノロジーの美しいビジュアル表現を行うことができます。

@startuml
!include <cloudinsight/tomcat>
!include <cloudinsight/kafka>
!include <cloudinsight/java>
!include <cloudinsight/cassandra>

title Cloudinsight sprites example

skinparam monochrome true

rectangle "<$tomcat>\nwebapp" as webapp
queue "<$kafka>" as kafka
rectangle "<$java>\ndaemon" as daemon
database "<$cassandra>" as cassandra

webapp -> kafka
kafka -> daemon
daemon --> cassandra
@enduml

Elasticライブラリ

Elasticライブラリには、Elasticのアイコンが含まれています。 これは、AWSおよびAzureライブラリと類似のものです(同じツールを使用して作られました)。

スプライトの含まれるファイルをインポートして使います。例: !include elastic/elastic_search/elastic_search.puml> インポートされると、通常のスプライトと同様、<$sprite_name>のように使用することができます。

!include <elastic/common>のようにしてcommon.pumlをインクルードすると、そこに定義されたヘルパーマクロを使用することができます。common.pumlをインポートすると、NAME_OF_SPRITE(parameters...)マクロを使用することができます。

使用例:

@startuml
!include <elastic/common>
!include <elastic/elasticsearch/elasticsearch>
!include <elastic/logstash/logstash>
!include <elastic/kibana/kibana>

ELASTICSEARCH(ElasticSearch, "Search and Analyze",database)
LOGSTASH(Logstash, "Parse and Transform",node)
KIBANA(Kibana, "Visualize",agent) 

Logstash -right-> ElasticSearch: Transformed Data
ElasticSearch -right-> Kibana: Data to View
@enduml

Tupadr3ライブラリ

https://github.com/tupadr3/plantuml-icon-font-sprites

このライブラリにはDeviconsやFont Awesomeを含む、いくつかのアイコンライブラリが含まれています。

スプライトの含まれるファイルをインポートして使います。例: !include <font-awesome/align_center> インポートされると、通常のスプライトと同様、<$sprite_name>のように使用することができます。

!include <font-awesome/common>のようにしてcommon.pumlをインクルードすると、そこに定義されたヘルパーマクロを使用することができます。common.pumlをインポートすると、NAME_OF_SPRITE(parameters...)マクロを使用することができます。

使用例:

@startuml
!include <tupadr3/common>
!include <tupadr3/font-awesome/server>
!include <tupadr3/font-awesome/database>

title Styling example

FA_SERVER(web1,web1) #Green
FA_SERVER(web2,web2) #Yellow
FA_SERVER(web3,web3) #Blue
FA_SERVER(web4,web4) #YellowGreen

FA_DATABASE(db1,LIVE,database,white) #RoyalBlue
FA_DATABASE(db2,SPARE,database) #Red

db1 <--> db2

web1 <--> db1
web2 <--> db1
web3 <--> db1
web4 <--> db1
@enduml

@startuml
!include <tupadr3/common>
!include <tupadr3/devicons/mysql>

DEV_MYSQL(db1)
DEV_MYSQL(db2,label of db2)
DEV_MYSQL(db3,label of db3,database)
DEV_MYSQL(db4,label of db4,database,red) #DeepSkyBlue
@enduml

Google Material Icons

https://github.com/Templarian/MaterialDesign

このライブラリには、Googleやその他の作成者によって作られた、フリーのマテリアルスタイルのアイコンが含まれています。

スプライトの含まれるファイルをインポートして使います。例: !include <material/ma_folder_move> インポートされると、通常のスプライトと同様、<$ma_sprite_name>のように使用することができます。このライブラリでは、他のライブラリの同じ名前のスプライトとの衝突を避けるために、スプライト名にプレフィックスma_を付ける必要があることに注意してください。

!include <material/common>のようにしてcommon.pumlをインクルードすると、そこに定義されたヘルパーマクロを使用することができます。common.pumlをインポートすると、MA_NAME_OF_SPRITE(parameters...)マクロを使用することができます。 こちらもプレフィックスMA_を付ける必要があることに注意してください。

使用例:

@startuml
!include <material/common>
' To import the sprite file you DON'T need to place a prefix!
!include <material/folder_move>

MA_FOLDER_MOVE(Red, 1, dir, rectangle, "A label")
@enduml

注意

例えば次のように、クラスとともにrectangleを加えようとした場合のように、スプライトマクロをほかの要素と一緒に使う場合にシンタックスエラーが発生することがあります。 そのような場合には、マクロの後ろに{}を加えて空のrectangleを作るようにしてください。

使用例:

@startuml
!include <material/common>
' To import the sprite file you DON'T need to place a prefix!
!include <material/folder_move>

MA_FOLDER_MOVE(Red, 1, dir, rectangle, "A label") {
}

class foo {
    bar
}
@enduml

Office

https://github.com/Roemer/plantuml-office

スプライト(*.puml)と色付きのPNGアイコンが利用可能です。名前に色名が含まれていたとしてもスプライトはすべてモノクロです(ファイルが自動生成されているためです)。マクロ(以下の例を参照)を使ってスプライトに色を付けるか、フルカラーのPNGを使用することができます。スプライト、PNG、マクロの使い方は以下の例を参照してください。

使用例:

@startuml
!include <tupadr3/common>

!include <office/Servers/database_server>
!include <office/Servers/application_server>
!include <office/Concepts/firewall_orange>
!include <office/Clouds/cloud_disaster_red>

title Office Icons Example

package "Sprites" {
    OFF_DATABASE_SERVER(db,DB)
    OFF_APPLICATION_SERVER(app,App-Server)
    OFF_FIREWALL_ORANGE(fw,Firewall)
    OFF_CLOUD_DISASTER_RED(cloud,Cloud)
    db <-> app
    app <--> fw
    fw <.left.> cloud
}
@enduml

@startuml
!include <tupadr3/common>

!include <office/servers/database_server>
!include <office/servers/application_server>
!include <office/Concepts/firewall_orange>
!include <office/Clouds/cloud_disaster_red>

' Used to center the label under the images
skinparam defaultTextAlignment center

title Extended Office Icons Example

package "Use sprite directly" {
    [Some <$cloud_disaster_red> object]
}

package "Different macro usages" {
    OFF_CLOUD_DISASTER_RED(cloud1)
    OFF_CLOUD_DISASTER_RED(cloud2,Default with text)
    OFF_CLOUD_DISASTER_RED(cloud3,Other shape,Folder)
    OFF_CLOUD_DISASTER_RED(cloud4,Even another shape,Database)
    OFF_CLOUD_DISASTER_RED(cloud5,Colored,Rectangle, red)
    OFF_CLOUD_DISASTER_RED(cloud6,Colored background) #red
}
@enduml

ArchiMate

https://github.com/ebbypeter/Archimate-PlantUML

このリポジトリにはArchiMateのPlantUMLマクロ、および、ArchiMateの図を簡単に一貫性をもって作成するためのその他のインクルードが含まれています。

@startuml
!include <archimate/Archimate>

title Archimate Sample - Internet Browser

' Elements
Business_Object(businessObject, "A Business Object")
Business_Process(someBusinessProcess,"Some Business Process")
Business_Service(itSupportService, "IT Support for Business (Application Service)")

Application_DataObject(dataObject, "Web Page Data \n 'on the fly'")
Application_Function(webpageBehaviour, "Web page behaviour")
Application_Component(ActivePartWebPage, "Active Part of the web page \n 'on the fly'")

Technology_Artifact(inMemoryItem,"in memory / 'on the fly' html/javascript")
Technology_Service(internetBrowser, "Internet Browser Generic & Plugin")
Technology_Service(internetBrowserPlugin, "Some Internet Browser Plugin")
Technology_Service(webServer, "Some web server")

'Relationships
Rel_Flow_Left(someBusinessProcess, businessObject, "")
Rel_Serving_Up(itSupportService, someBusinessProcess, "")
Rel_Specialization_Up(webpageBehaviour, itSupportService, "")
Rel_Flow_Right(dataObject, webpageBehaviour, "")
Rel_Specialization_Up(dataObject, businessObject, "")
Rel_Assignment_Left(ActivePartWebPage, webpageBehaviour, "")
Rel_Specialization_Up(inMemoryItem, dataObject, "")
Rel_Realization_Up(inMemoryItem, ActivePartWebPage, "")
Rel_Specialization_Right(inMemoryItem,internetBrowser, "")
Rel_Serving_Up(internetBrowser, webpageBehaviour, "")
Rel_Serving_Up(internetBrowserPlugin, webpageBehaviour, "")
Rel_Aggregation_Right(internetBrowser, internetBrowserPlugin, "")
Rel_Access_Up(webServer, inMemoryItem, "")
Rel_Serving_Up(webServer, internetBrowser, "")
@enduml

Kubernetes

https://github.com/michiel/plantuml-kubernetes-sprites

@startuml
!include <kubernetes/k8s-sprites-unlabeled-25pct>
package "Infrastructure" {
  component "<$master>\nmaster" as master
  component "<$etcd>\netcd" as etcd
  component "<$node>\nnode" as node
}
@enduml

その他

特別なダイアグラムを使用して、標準ライブラリのフォルダ一覧を得ることができます:

@startuml
stdlib
@enduml

コマンドラインからjava -jar plantuml.jar -stdlibを実行することでも同じ一覧を得ることができます。

java -jar plantuml.jar -extractstdlibを実行すると、標準ライブラリのすべてのソースを取り出すことができます。すべてのファイルはstdlibフォルダに出力されます。

公式のPlantUMLリリースのビルドに使用されるソースは、https://github.com/plantuml/plantuml-stdlibにホストされています。ライブラリのアップデートや関連するライブラリを追加したい場合は、プルリクエストを作成することができます。