在自定义注释中使用 HashMap

引言

在之前的文章“创建自定义 Jackson JsonSerializer 和 JsonDeserializer 用于映射值”中，我创建了自定义注解 @mappingtable 用于键值对映射。键值对在 JSON 中定义，并在 @mappingtable 注解中以字符串形式指定。MappingTableMapReader 类将 JSON 转换为 HashMap，并在 JsonSerializer 和 JsonDeserializer 中使用。

@mappingtable(map = "{"1": "male", "2": "female", "6": "pers"}")
private MappingValue<String> salutation;

@mappingtable(map = "{"1": true, "2": false}")
private MappingValue<Boolean> marketingInformation;

登录后复制

直接使用 JSON 的缺点是键值对无法复用。例如，如果需要在应用中复用这些键值对进行验证，则必须再次定义为 HashMap，导致代码冗余。因此，更理想的方式是直接使用 HashMap。

不支持直接使用 HashMap

注解不支持直接使用 HashMap 类型。以下示例会导致编译错误：

public static Map<String, String> salutationMap = new HashMap<>() {{
    put("1", "male");
    put("2", "female");
    put("6", "pers");
}};

@mappingtable(map = salutationMap)
private MappingValue<String> salutation;

登录后复制

支持的类型

注解仅支持以下类型：

• 原生类型 (int, boolean, float 等)
• 字符串
• 枚举
• 类 (Class>, Class extends/super T?>)
• 类型中的数组 (int[], String[], Enum[] 等)
• 其他注解

解决方案

在注解中使用 HashMap 有三种可行方案：

• 枚举示例
• 类示例
• 使用嵌套注解的示例

枚举示例

枚举定义

Maps 枚举包含常量 salutation 和 marketing_information。HashMap 使用 Map.of() 在这些常量中定义。也可以使用 new HashMap()。

public enum Maps {

    salutation(Map.of("1", "male", "2", "female", "6", "pers")),

    marketing_information(Map.of("1", true, "2", false));

    private final Map<String, Object> map;

    Maps(Map<String, Object> map) {
        this.map = map;
    }

    public Map<String, Object> getMap() {
        return this.map;
    }
}

登录后复制

@mappingtable 注解

注解使用 Maps 枚举类型：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface mappingtable {

    Maps map();
}

登录后复制

ContactDTO

@mappingtable 注解引用枚举常量：

public class ContactDTO {

    // ...    

    @mappingtable(map = Maps.salutation)
    private MappingValue<String> salutation;

    @mappingtable(map = Maps.marketing_information)
    private MappingValue<Boolean> marketingInformation;

    // ...
}

登录后复制

MappingTableMapReader

在 MappingTableMapReader 类中，HashMap 从枚举常量中检索，并在 JsonSerializer 和 JsonDeserializer 中使用：

public class MappingTableMapReader {

    private final BeanProperty property;

    public MappingTableMapReader(BeanProperty property) {
        this.property = property;
    }

    public Map<String, Object> getMap() {

        mappingtable annotation = property.getAnnotation(mappingtable.class);

        if (annotation == null) {
            throw new MappingTableRuntimeException("annotation @mappingtable not set at property");
        }

        return annotation.map().getMap();
    }
}

登录后复制

使用枚举的完整示例: https://www.php.cn/link/45961dd50e46379442318098474e0ced

类示例，嵌套注解示例以及结论部分与原文一致，此处省略。

以上就是在自定义注释中使用 HashMap的详细内容，更多请关注其它相关文章！

Tags： 注解示例