Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    View page history    Add new chapter    Reorder page    Raw


PlantUML テキスト エンコード

PlantUML Text Encoding

はじめに

Introduction

PlantUMLでは、図のソースコードを英数字、アンダースコア、ハイフンだけのシンプルな文字列にエンコードする標準の方法を定めています。 これは、URLによって図を使ったコミュニケーションを円滑に行えるようにすることを目的としています(サーバーを参照)。 エンコード後の文字列をできるだけ短くするために圧縮が行われます。

エンコードされた文字列は、生成されたPNGファイルにもメタデータとして保存されます。つまり、画像ファイルから、その図のソースを取り出すことができます(サーバーを参照)。

PlantUML defines a standardized way to encode diagram text description to a simple string of characters that contains only digits, letters, underscore and minus character. The goal of such an encoding is to facilitate communication of diagrams through URL (see server). This encoding includes compression to keep encoded strings as short as possible.

The encoded metadata is stored in the generated PNG, so the diagram source can be extracted from the diagram itself! (see server#metadata).

圧縮

Compression

以下の圧縮アルゴリズムが利用可能です:

  1. Deflateアルゴリズムは小さい図の場合に有効です。
  2. バージョン1.2017.20以降のPlantUMLでは、Brotliアルゴリズムを利用することもできます。(issue #117)こちらは大きい図の場合に有効です。Brotliアルゴリズムであることを表すために、エンコード後の文字列の最初に0が追加されます(Deflateで0で始まるデータが生成されることはありません)。
  3. 単純な16進数(HEX)エンコーディングを使用することもできます。この場合、先頭に~hが追加されます。

原理

例えば、次のようなUMLのテキスト記述があった場合:

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
@enduml

このようにエンコードされます:

Syp9J4vLqBLJSCfFib9mB2t9ICqhoKnEBCdCprC8IYqiJIqkuGBAAUW2rO0LOr5LN92VLvpA1G00

この結果を得るには次の処理を行います:

  1. テキストをUTF-8でエンコードします。
  2. DeflateまたはBrotliアルゴリズムで圧縮します。
  3. Base64に類似したアルゴリズムを使って、ASCIIに再エンコーディングします。

Base64ではない理由

大きな理由は歴史的なものです。このフォーマットは最初、公開を目的としていませんでした。これを変更するのは今となっては遅すぎます。しかし、その差異は、使用する文字の順番のみです。

Base64は0~63の値を、次の配列に対応させます:

ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/

PlantUMLでは、0~63の値を、次の配列に対応させます:

0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_

圧縮の比較

次の図をエンコードすると、

@startuml
skinparam backgroundColor #EEEBDC
skinparam handwritten true

skinparam sequenceArrowColor DeepSkyBlue
skinparam sequenceActorBorderColor DeepSkyBlue
skinparam sequenceLifeLineBorderColor blue
skinparam sequenceLifeLineBackgroundColor #A9DCDF
skinparam sequenceParticipantBorderColor DeepSkyBlue
skinparam sequenceParticipantBackgroundColor DodgerBlue
skinparam sequenceParticipantFontName Impact
skinparam sequenceParticipantFontSize 17
skinparam sequenceParticipantFontColor #A9DCDF
skinparam sequenceActorBackgroundColor aqua
skinparam sequenceActorFontColor DeepSkyBlue
skinparam sequenceActorFontSize 17
skinparam sequenceActorFontName Aapex

actor User
participant "First Class" as ParticipantA
participant "Second Class" as ParticipantB
participant "Last Class" as ParticipantC

User -> ParticipantA: DoWork
activate ParticipantA

ParticipantA -> ParticipantB: Create Request
activate ParticipantB

ParticipantB -> ParticipantC: DoWork
activate ParticipantC
ParticipantC --> ParticipantB: WorkDone
destroy ParticipantC

ParticipantB --> ParticipantA: Request Created
deactivate ParticipantB

ParticipantA --> User: Done
deactivate ParticipantA
@enduml

となります。

The following compression algorithms are available:

  1. First was is the Deflate algorithm that gives good results for short diagrams.
  2. Starting in version 1.2017.20, PlantUML also supports the Brotli algorithm (issue #117) that gives better results for larger diagrams. An initial 0 character is added to the encoded string to indicate Brotli (Deflated data never starts with 0).
  3. You can also use simple HEX encoding, see below. An initial ~h is added to indicate this encoding.

Principle

For example, the following uml text description:

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
@enduml

is encoded as:

Syp9J4vLqBLJSCfFib9mB2t9ICqhoKnEBCdCprC8IYqiJIqkuGBAAUW2rO0LOr5LN92VLvpA1G00

To achieve such encoding, the text diagram is:

  1. Encoded in UTF-8
  2. Compressed using Deflate or Brotli algorithm
  3. Reencoded in ASCII using a transformation close to base64

Why not use Base64?

The main reason is historic: this format was not created to be public at first. Now, it's too late to change it. However, the only difference is in character order.

Where in base64 the mapping array for values 0-63 is:

ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/

For PlantUML, the mapping array for values 0-63 is:

0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_

Compression comparison

The following diagram:

@startuml
skinparam backgroundColor #EEEBDC
skinparam handwritten true

skinparam sequenceArrowColor DeepSkyBlue
skinparam sequenceActorBorderColor DeepSkyBlue
skinparam sequenceLifeLineBorderColor blue
skinparam sequenceLifeLineBackgroundColor #A9DCDF
skinparam sequenceParticipantBorderColor DeepSkyBlue
skinparam sequenceParticipantBackgroundColor DodgerBlue
skinparam sequenceParticipantFontName Impact
skinparam sequenceParticipantFontSize 17
skinparam sequenceParticipantFontColor #A9DCDF
skinparam sequenceActorBackgroundColor aqua
skinparam sequenceActorFontColor DeepSkyBlue
skinparam sequenceActorFontSize 17
skinparam sequenceActorFontName Aapex

actor User
participant "First Class" as ParticipantA
participant "Second Class" as ParticipantB
participant "Last Class" as ParticipantC

User -> ParticipantA: DoWork
activate ParticipantA

ParticipantA -> ParticipantB: Create Request
activate ParticipantB

ParticipantB -> ParticipantC: DoWork
activate ParticipantC
ParticipantC --> ParticipantB: WorkDone
destroy ParticipantC

ParticipantB --> ParticipantA: Request Created
deactivate ParticipantB

ParticipantA --> User: Done
deactivate ParticipantA
@enduml

is compressed to a

Running

Running

PTE 表現は、 -encodeurl-decodeurlコマンドライン フラグをつけることで、使用できます。

以下のコードでは、このエンコードを実際に使っています。

You can use -encodeurl or -decodeurl in the command line flags to encode or decode the text.

You will find here some implementation of this encoder:

シンプルな16進数(HEX)形式

Simple HEX format

DeflateやBrotliは複雑すぎると思う場合は、16進数(HEX)形式を使用することもできます。 この場合は、すべての文字を16進数形式でフォーマットするだけです。

例:

@startuml
Alice->Bob : I am using hex
@enduml

次のようになります:

407374617274756d6c0a416c6963652d3e426f62203a204920616d207573696e67206865780a40656e64756d6c

16進数(HEX)形式であることを示すために、PlantUMLサーバに送信するデータの先頭には~hを付ける必要があります。

http://www.plantuml.com/plantuml/uml/~h4073...

圧縮されていないので、図のサイズが大きくなるとURLが非常に長くなります。

If you find Deflate and Brotli too complex, you can try the HEX format. In that case, you just have to encode each character in hexadecimal format.

For example :

@startuml
Alice->Bob : I am using hex
@enduml

will be turned into:

407374617274756d6c0a416c6963652d3e426f62203a204920616d207573696e67206865780a40656e64756d6c

To indicate the use of HEX format, you must add ~h at the start of the data sent to PlantUML server.

http://www.plantuml.com/plantuml/uml/~h4073...

Since there is no compression here, the URL will become very long as the diagram grows.


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.