(A Better) Avro Schema Generator

The Avro Schema Generator produces Java classes from Avro schemas using your chosen Avro Compiler version.
It supports Avro versions from 1.8.0 up to 1.12.0.

Why use this Avro Generator Plugin?

• Sources Avro schemas from local files, classpath resources, or authenticated remote HTTP URLs.
• Automatically sorts schemas to resolve dependencies for Avro versions prior to 1.12.0.
• Ensures generated code is consistent and ready for integration in Java projects.

• (A Better) Avro Schema Generator
  • Why use this Avro Generator Plugin?
  • Usage
    • Using the ZenWave CLI
    • Using the ZenWave Maven Plugin
    • Gradle Usage
  • Options
  • Getting Help

Usage

Using the ZenWave CLI

Generating from remote HTTP resources:

jbang zw -p io.zenwave360.sdk.plugins.AvroSchemaGeneratorPlugin \
    avroFiles="https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/Address.avsc, \
              https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/PaymentMethod.avsc, \
              https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/PaymentMethodType.avsc, \
              https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/CustomerEvent.avsc" \
    sourceFolder=src/main/java \
    targetFolder=target/generated-sources/avro

This will generate the following Java classes:

$ find target/ -type f
target/generated-sources/avro/src/main/java/io/zenwave360/example/core/outbound/events/dtos/Address.java
target/generated-sources/avro/src/main/java/io/zenwave360/example/core/outbound/events/dtos/CustomerEvent.java
target/generated-sources/avro/src/main/java/io/zenwave360/example/core/outbound/events/dtos/PaymentMethod.java
target/generated-sources/avro/src/main/java/io/zenwave360/example/core/outbound/events/dtos/PaymentMethodType.java

Generating from local folders and imports:

jbang zw -p io.zenwave360.sdk.plugins.AvroSchemaGeneratorPlugin \
    avroCompilerProperties.sourceDirectory=some/avro/folder \
    avroCompilerProperties.imports="common.avsc,another.avsc" \
    sourceFolder=src/main/java \
    targetFolder=target/generated-sources/avro

Using the ZenWave Maven Plugin

<plugin>
    <groupId>io.zenwave360.sdk</groupId>
    <artifactId>zenwave-sdk-maven-plugin</artifactId>
    <version>${zenwave.version}</version>

    <configuration>
        <!-- <authentication> -->
        <!--     <authentication><key>API_KEY</key><value>XXX</value></authentication> -->
        <!-- </authentication> -->
        <addCompileSourceRoot>true</addCompileSourceRoot><!-- default is true -->
        <addTestCompileSourceRoot>true</addTestCompileSourceRoot><!-- default is false -->
    </configuration>

    <executions>
        <execution>
            <id>generate-avros</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <generatorName>AvroSchemaGeneratorPlugin</generatorName>
                <configOptions>
                    <avroFiles>
                        https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/Address.avsc,
                        https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/PaymentMethod.avsc,
                        https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/PaymentMethodType.avsc,
                        https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/CustomerEvent.avsc
                    </avroFiles>
                </configOptions>
            </configuration>
        </execution>
    </executions>

    <dependencies>
        <dependency>
            <groupId>io.zenwave360.sdk.plugins</groupId>
            <artifactId>avro-schema-compiler</artifactId>
            <version>${zenwave.version}</version> <!-- Requires 2.2.0 or newer -->
        </dependency>
        <dependency>
            <groupId>org.apache.avro</groupId>
            <artifactId>avro-compiler</artifactId>
            <version>${avro-compiler.version}</version> <!-- Supports 1.8.0 to 1.12.0+ -->
            <exclusions>
                <exclusion>
                    <groupId>com.fasterxml.jackson.core</groupId>
                    <artifactId>jackson-core</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>com.fasterxml.jackson.core</groupId>
                    <artifactId>jackson-databind</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>
</plugin>

NOTE: you need to exclude jackson-core and jackson-databind from avro-compiler dependency to avoid conflicts with ZenWaveSDK requirements which expect newer versions.

Gradle Usage

plugins {
    java
    id("dev.jbang") version "0.3.0"
}

tasks.register<dev.jbang.gradle.tasks.JBangTask>("generateAvroClasses") {
    group = "avro"
    description = "Generates Avro classes from Avro schemas"
    script.set("io.zenwave360.sdk:zenwave-sdk-cli:RELEASE")
    jbangArgs.set(listOf(
        "--deps=" +
            "org.slf4j:slf4j-simple:1.7.36," +
            "io.zenwave360.sdk.plugins:avro-schema-compiler:RELEASE," +
            "org.apache.avro:avro-compiler:1.11.1"
    ))
    args.set(listOf(
        "-p", "AvroSchemaGeneratorPlugin",
        "avroFiles=" +
            "https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/Address.avsc," +
            "https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/PaymentMethod.avsc," +
            "https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/PaymentMethodType.avsc," +
            "https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/main/plugins/avro-schema-compiler/src/test/resources/avros/customer-event/CustomerEvent.avsc"
    ))
}

sourceSets {
    main {
        java {
            srcDir(layout.buildDirectory.dir("generated-sources/zenwave/src/main/java").get().asFile)
        }
    }
}

Options

Getting Help

jbang zw -p io.zenwave360.sdk.plugins.AvroSchemaGeneratorPlugin --help