如何创建Avro Schema以生成名称相似的Java Avro Maven类？解决字段名冲突导致的Setter方法重复定义问题

这个问题确实挺棘手的——默认的Avro命名策略会把下划线分隔的字段转成驼峰格式，导致first_name和firstName生成完全相同的setFirstName()方法，而Avro内置的冲突处理只针对除首字符外完全一致的字段（比如firstName和firstname），对你的场景确实没用。不过好在我们可以通过自定义命名策略来解决这个问题，具体步骤如下：

1. 自定义命名策略类 #

创建一个继承自Avro默认JavaBeanNamingStrategy的类，重写字段转属性名的逻辑，让带下划线的字段保留原格式，避免和驼峰字段生成同名方法：

import org.apache.avro.specific.JavaBeanNamingStrategy;

public class UnderscorePreservingNamingStrategy extends JavaBeanNamingStrategy {
    @Override
    protected String getPropertyName(String fieldName) {
        // 对包含下划线的字段，直接返回原字段名，不做驼峰转换
        if (fieldName.contains("_")) {
            return fieldName;
        }
        // 其他字段沿用默认的驼峰转换逻辑
        return super.getPropertyName(fieldName);
    }
}

这个类的作用很明确：

• 对于firstName这类无下划线的字段，依然生成setFirstName()方法
• 对于first_name这类带下划线的字段，生成setFirst_name()方法，彻底避免方法名冲突

2. 配置Avro Maven插件使用自定义策略 #

在你的pom.xml中，给Avro插件添加<namingStrategy>配置，指定自定义类的全限定名：

<plugin>
    <groupId>org.apache.avro</groupId>
    <artifactId>avro-maven-plugin</artifactId>
    <version>${avro.version}</version>
    <executions>
        <execution>
            <phase>generate-sources</phase>
            <goals>
                <goal>schema</goal>
            </goals>
            <configuration>
                <schemaDirectory>src/main/resources/avro</schemaDirectory>
                <outputDirectory>target/generated-sources/avro</outputDirectory>
                <!-- 替换成你自己的自定义类全限定名 -->
                <namingStrategy>com.yourcompany.utils.UnderscorePreservingNamingStrategy</namingStrategy>
            </configuration>
        </execution>
    </executions>
</plugin>

3. 确保自定义类在Avro代码生成前编译 #

因为Avro插件在生成代码时需要加载这个自定义类，所以必须保证它先被编译。如果这个类和你的Avro Schema在同一个模块，可以通过调整Maven编译顺序来实现：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>${maven-compiler.version}</version>
    <executions>
        <execution>
            <id>pre-compile-naming-strategy</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>compile</goal>
            </goals>
            <!-- 只编译我们的自定义命名策略类 -->
            <includes>
                <include>com/yourcompany/utils/UnderscorePreservingNamingStrategy.java</include>
            </includes>
        </execution>
    </executions>
</plugin>

这段配置会在Avro插件生成代码前，先编译你的自定义命名策略类，确保插件能找到并使用它。

这样处理后，生成的Java类就会有两个不同的Setter方法：setFirstName(String)和setFirst_name(String)，完美解决了方法名冲突的问题，同时也不用修改遗留系统的字段名。

内容的提问来源于stack exchange，提问作者Invisible