colfer
Version 1.8.1
Colfer ist ein binäres Serialisierungsformat, das auf Geschwindigkeit und Größe optimiert ist.
Der Compiler colf(1) des Projekts generiert Quellcode aus Schemadefinitionen zum Marshallen und Unmarshallen von Datenstrukturen.
Hierbei handelt es sich um kostenlose und unbelastete Software, die der Öffentlichkeit zugänglich gemacht wird. Das Format ist von Protokollpuffern inspiriert .
Laden Sie einen vorgefertigten Compiler herunter oder führen Sie go get -u github.com/pascaldekloe/colfer/cmd/colf aus, um selbst einen zu erstellen. Homebrew-Benutzer können auch brew install colfer verwenden.
Der Befehl gibt sein eigenes Handbuch aus, wenn er ohne Argumente aufgerufen wird.
NAME
colf — compile Colfer schemas
SYNOPSIS
colf [-h]
colf [-vf] [-b directory] [-p package]
[-s expression] [-l expression] C [file ...]
colf [-vf] [-b directory] [-p package] [-t files]
[-s expression] [-l expression] Go [file ...]
colf [-vf] [-b directory] [-p package] [-t files]
[-x class] [-i interfaces] [-c file]
[-s expression] [-l expression] Java [file ...]
colf [-vf] [-b directory] [-p package]
[-s expression] [-l expression] JavaScript [file ...]
DESCRIPTION
The output is source code for either C, Go, Java or JavaScript.
For each operand that names a file of a type other than
directory, colf reads the content as schema input. For each
named directory, colf reads all files with a .colf extension
within that directory. If no operands are given, the contents of
the current directory are used.
A package definition may be spread over several schema files.
The directory hierarchy of the input is not relevant to the
generated code.
OPTIONS
-b directory
Use a base directory for the generated code. (default ".")
-c file
Insert a code snippet from a file.
-f Normalize the format of all schema input on the fly.
-h Prints the manual to standard error.
-i interfaces
Make all generated classes implement one or more interfaces.
Use commas as a list separator.
-l expression
Set the default upper limit for the number of elements in a
list. The expression is applied to the target language under
the name ColferListMax. (default "64 * 1024")
-p package
Compile to a package prefix.
-s expression
Set the default upper limit for serial byte sizes. The
expression is applied to the target language under the name
ColferSizeMax. (default "16 * 1024 * 1024")
-t files
Supply custom tags with one or more files. Use commas as a list
separator. See the TAGS section for details.
-v Enable verbose reporting to standard error.
-x class
Make all generated classes extend a super class.
TAGS
Tags, a.k.a. annotations, are source code additions for structs
and/or fields. Input for the compiler can be specified with the
-t option. The data format is line-oriented.
<line> :≡ <qual> <space> <code> ;
<qual> :≡ <package> '.' <dest> ;
<dest> :≡ <struct> | <struct> '.' <field> ;
Lines starting with a '#' are ignored (as comments). Java output
can take multiple tag lines for the same struct or field. Each
code line is applied in order of appearance.
EXIT STATUS
The command exits 0 on success, 1 on error and 2 when invoked
without arguments.
EXAMPLES
Compile ./io.colf with compact limits as C:
colf -b src -s 2048 -l 96 C io.colf
Compile ./*.colf with a common parent as Java:
colf -p com.example.model -x com.example.io.IOBean Java
BUGS
Report bugs at <https://github.com/pascaldekloe/colfer/issues>.
Text validation is not part of the marshalling and unmarshalling
process. C and Go just pass any malformed UTF-8 characters. Java
and JavaScript replace unmappable content with the '?' character
(ASCII 63).
SEE ALSO
protoc(1), flatc(1)
Es wird empfohlen, den generierten Quellcode in die jeweilige Versionskontrolle einzubinden, um die Build-Konsistenz zu wahren und die Notwendigkeit von Compiler-Installationen zu minimieren. Alternativ können Sie das Maven-Plugin verwenden.
< plugin >
< groupId >net.quies.colfer</ groupId >
< artifactId >colfer-maven-plugin</ artifactId >
< version >1.11.2</ version >
< configuration >
< packagePrefix >com/example</ packagePrefix >
</ configuration >
</ plugin > Datenstrukturen werden in .colf Dateien definiert. Das Format ist ziemlich selbsterklärend.
// Package demo offers a demonstration.
// These comment lines will end up in the generated code.
package demo
// Course is the grounds where the game of golf is played.
type course struct {
ID uint64
name text
holes []hole
image binary
tags []text
}
type hole struct {
// Lat is the latitude of the cup.
lat float64
// Lon is the longitude of the cup.
lon float64
// Par is the difficulty index.
par uint8
// Water marks the presence of water.
water bool
// Sand marks the presence of sand.
sand bool
}
Sehen Sie, wie der generierte Code in C, Go, Java oder JavaScript aussieht.
Die folgende Tabelle zeigt, wie Colfer-Datentypen pro Sprache angewendet werden.
| Colfer | C | Gehen | Java | JavaScript |
|---|---|---|---|---|
| bool | verkohlen | bool | Boolescher Wert | Boolescher Wert |
| uint8 | uint8_t | uint8 | Byte † | Nummer |
| uint16 | uint16_t | uint16 | kurz † | Nummer |
| uint32 | uint32_t | uint32 | int † | Nummer |
| uint64 | uint64_t | uint64 | lang † | Nummer ‡ |
| int32 | int32_t | int32 | int | Nummer |
| int64 | int64_t | int64 | lang | Nummer ‡ |
| float32 | schweben | float32 | schweben | Nummer |
| float64 | doppelt | float64 | doppelt | Nummer |
| Zeitstempel | Zeitangabe | Zeit.Zeit †† | Zeit.Instant | Datum + Nummer |
| Text | const char* + size_t | Zeichenfolge | Zeichenfolge | Zeichenfolge |
| binär | uint8_t* + size_t | []Byte | Byte[] | Uint8Array |
| Liste | * + size_t | Scheibe | Array | Array |
Listen können Gleitkommazahlen, Text, Binärdateien oder Datenstrukturen enthalten.
Colfer eignet sich für nicht vertrauenswürdige Datenquellen wie Netzwerk-E/A oder Massenströme. Marshalling und Unmarshalling verfügen über einen integrierten Größenschutz, um einen vorhersehbaren Speicherverbrauch sicherzustellen. Das Format verhindert konstruktionsbedingt Speicherbomben.
Unabhängig von der Dateneingabe darf der Marshaller keine fehlerhafte Ausgabe erzeugen. In keinem Fall darf der Unmarshaller außerhalb der Grenzen einer Zeitschrift lesen. Fuzz-Tests ergaben bisher keine Schwachstellen. Rechenleistung ist willkommen.
Namensänderungen haben keinen Einfluss auf das Serialisierungsformat. Veraltete Felder sollten umbenannt werden, um deutlich von ihrer Verwendung abzuraten. Aus Gründen der Abwärtskompatibilität müssen am Ende von Colfer-Strukturen neue Felder hinzugefügt werden. Somit kann die Anzahl der Felder als Schemaversion angesehen werden.
Ziel von Colfer ist es, das schnellste und kleinste Format zu bieten, ohne Kompromisse bei der Zuverlässigkeit einzugehen. Einen Vergleich finden Sie im Benchmark-Wiki. Eine suboptimale Leistung wird wie ein Fehler behandelt.
