colfer
Version 1.8.1
Colfer est un format de sérialisation binaire optimisé pour la vitesse et la taille.
Le compilateur du projet colf(1) génère du code source à partir des définitions de schéma pour marshaler et démarshall les structures de données.
Il s'agit d'un logiciel gratuit et sans contrainte publié dans le domaine public. Le format est inspiré des Proto col Buffer s.
Téléchargez un compilateur prédéfini ou exécutez go get -u github.com/pascaldekloe/colfer/cmd/colf pour en créer un vous-même. Les utilisateurs de Homebrew peuvent également brew install colfer .
La commande imprime son propre manuel lorsqu'elle est invoquée sans arguments.
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)
Il est recommandé de valider le code source généré dans le contrôle de version respectif pour préserver la cohérence de la construction et minimiser le besoin d'installations du compilateur. Alternativement, vous pouvez utiliser le plugin Maven.
< plugin >
< groupId >net.quies.colfer</ groupId >
< artifactId >colfer-maven-plugin</ artifactId >
< version >1.11.2</ version >
< configuration >
< packagePrefix >com/example</ packagePrefix >
</ configuration >
</ plugin > Les structures de données sont définies dans des fichiers .colf . Le format est assez explicite.
// 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
}
Découvrez à quoi ressemble le code généré en C, Go, Java ou JavaScript.
Le tableau suivant montre comment les types de données Colfer sont appliqués par langue.
| Colfer | C | Aller | Java | Javascript |
|---|---|---|---|---|
| bouffon | carboniser | bouffon | booléen | Booléen |
| uint8 | uint8_t | uint8 | octet † | Nombre |
| uint16 | uint16_t | uint16 | court † | Nombre |
| uint32 | uint32_t | uint32 | entier † | Nombre |
| uint64 | uint64_t | uint64 | long † | Nombre ‡ |
| int32 | int32_t | int32 | int | Nombre |
| int64 | int64_t | int64 | long | Nombre ‡ |
| flotteur32 | flotter | flotteur32 | flotter | Nombre |
| flotteur64 | double | flotteur64 | double | Nombre |
| horodatage | spécification de temps | temps.Temps †† | time.Instantané | Date + Numéro |
| texte | const char* + taille_t | chaîne | Chaîne | Chaîne |
| binaire | uint8_t* + taille_t | []octet | octet[] | Uint8Array |
| liste | * + taille_t | tranche | tableau | Tableau |
Les listes peuvent contenir des virgules flottantes, du texte, des binaires ou des structures de données.
Colfer convient aux sources de données non fiables telles que les E/S réseau ou les flux massifs. Le marshalling et le unmarshalling sont dotés d'une protection de taille intégrée pour garantir une consommation de mémoire prévisible. Le format empêche les bombes mémoire de par sa conception.
Le marshaller ne peut pas produire de sortie mal formée, quelle que soit l'entrée de données. En aucun cas, le démarshaller ne peut lire en dehors des limites d'une série. Les tests Fuzz n'ont pas encore révélé de vulnérabilités. La puissance de calcul est la bienvenue.
Les changements de nom n'affectent pas le format de sérialisation. Les champs obsolètes doivent être renommés pour décourager clairement leur utilisation. Pour des raisons de compatibilité ascendante, de nouveaux champs doivent être ajoutés à la fin des structures colfer. Ainsi, le nombre de champs peut être considéré comme la version du schéma.
Colfer vise à être le format le plus rapide et le plus petit sans compromettre la fiabilité. Voir le wiki de référence pour une comparaison. Les performances sous-optimales sont traitées comme un bug.
