jOOQ生成枚举如何添加自定义属性：三种实用策略-java教程-PHP中文网

jOOQ生成枚举如何添加自定义属性：三种实用策略

本文探讨了在jooq自动生成的枚举中添加自定义属性的几种实用策略。针对jooq从数据库枚举类型生成简单枚举的限制，我们介绍了通过自定义代码生成器、将业务逻辑外部化为静态工具类，以及使用独立的自定义枚举配合jooq类型转换器这三种方法，帮助开发者灵活地为jooq枚举扩展功能，以满足复杂业务需求。

在数据持久化层开发中，枚举（Enum）类型常常用于表示固定集合的数据，例如订单状态、容量类型等。在许多ORM框架（如Hibernate）中，开发者可以方便地创建带有自定义属性和行为的Java枚举，并将其直接映射到数据库列。这些自定义属性（如描述、是否可覆盖等）可以直接通过枚举实例访问，极大地简化了业务逻辑的实现和UI层的展示。

然而，当迁移到jOOQ并利用其代码生成器从数据库（特别是PostgreSQL的ENUM类型）生成Java枚举时，会发现jOOQ生成的枚举通常只包含一个literal字段，用于存储数据库中的字面值，而缺乏自定义的业务属性和方法。这给那些习惯于在枚举中封装业务逻辑的开发者带来了挑战。

例如，一个自定义的Hibernate枚举可能如下所示：

public enum HBMCapacityType {

    Accepting("Accepting until end of day", true),
    Limited("Limited until end of day", true),
    AtCapacity("At Capacity until further notice",false);

    private final String description;
    private final boolean userOverridable;

    HBMCapacityType(String description, boolean userOverridable) {
        this.description = description;
        this.userOverridable = userOverridable;
    }

    public String getDescription() {
        return this.description;
    }

    public boolean isUserOverridable() {
        return this.userOverridable;
    }
}

登录后复制

但在jOOQ中，如果数据库中定义了capacity_type枚举，jOOQ会自动生成一个类似以下的Java枚举：

/**
 * This class is generated by jOOQ.
 */
@SuppressWarnings({ "all", "unchecked", "rawtypes" })
public enum CapacityType implements EnumType {

    Accepting("Accepting"),
    Limited("Limited"),
    AtCapacity("AtCapacity");

    private final String literal;

    private CapacityType(String literal) {
        this.literal = literal;
    }

    // ... 其他jOOQ自动生成的方法，如getCatalog(), getSchema(), getName(), getLiteral()
}

登录后复制

显然，这个自动生成的CapacityType枚举不包含description或userOverridable这样的自定义属性。本文将介绍三种在jOOQ环境中为枚举添加自定义属性的实用策略。

策略一：利用自定义代码生成器扩展

jOOQ的代码生成器是高度可配置和可扩展的。通过继承DefaultJavaGenerator并重写其方法，我们可以在jOOQ生成的枚举类中注入自定义代码，例如添加新的方法。由于无法直接修改枚举值的构造函数来添加属性，这种方法通常通过在枚举类中添加基于switch (this)逻辑的getter方法来实现。

绘蛙-多图成片

绘蛙新推出的AI图生视频工具

133

查看详情

实现步骤：

创建自定义的JavaGenerator子类： 继承org.jooq.codegen.DefaultJavaGenerator，并重写generateEnumClassFooter()方法。这个方法允许你在生成的枚举类的末尾添加自定义代码。

// 文件名: MyJavaGenerator.java
package com.example.codegen;

import org.jooq.codegen.DefaultJavaGenerator;
import org.jooq.codegen.JavaWriter;
import org.jooq.meta.EnumDefinition;

public class MyJavaGenerator extends DefaultJavaGenerator {

    @Override
    protected void generateEnumClassFooter(EnumDefinition definition, JavaWriter out) {
        // 确保只为特定的枚举类型添加自定义属性，例如 "capacity_type"
        if ("capacity_type".equalsIgnoreCase(definition.getName())) {
            out.println();
            out.println("    public String getDescription() {");
            out.println("        return switch (this) {");
            out.println("            case Accepting -> \"Accepting until end of day\";");
            out.println("            case Limited -> \"Limited until end of day\";");
            out.println("            case AtCapacity -> \"At Capacity until further notice\";");
            out.println("            default -> this.getLiteral(); // 默认返回字面量
            out.println("        };");
            out.println("    }");

            out.println();
            out.println("    public boolean isUserOverridable() {");
            out.println("        return switch (this) {");
            out.println("            case Accepting, Limited -> true;");
            out.println("            case AtCapacity -> false;");
            out.println("            default -> false; // 默认值
            out.println("        };");
            out.println("    }");
        }
    }
}

登录后复制

配置jOOQ代码生成器使用自定义类： 在jooq-codegen.xml配置文件中，将generator.name指向你的自定义JavaGenerator类。

<configuration>
    <generator>
        <name>com.example.codegen.MyJavaGenerator</name> <!-- 使用你的自定义生成器 -->
        <database>
            <!-- 数据库连接和schema配置 -->
            <inputSchema>wastecoordinator</inputSchema>
            <includes>capacity_type</includes>
        </database>
        <target>
            <!-- 生成代码的目标路径和包名 -->
            <packageName>com.example.generated</packageName>
            <directory>src/main/java</directory>
        </target>
    </generator>
</configuration>

登录后复制

优缺点：

优点： 自定义方法直接集成到jOOQ生成的枚举类中，使用起来非常直观，例如record.getCapacityType().getDescription()。
缺点： 逻辑是硬编码在代码生成器中的，每次业务逻辑变更都需要重新生成代码。对于复杂的属性或频繁变动的逻辑，维护成本较高。此外，这种方式无法像自定义枚举那样在构造函数中直接初始化属性，所有属性值都必须通过switch语句在getter方法中动态判断。

策略二：将业务逻辑外部化为静态工具类

如果不想修改jOOQ生成的代码，或者希望将枚举的业务逻辑与枚举定义解耦，可以将自定义属性的获取逻辑封装在一个独立的静态工具类中。

实现步骤：

创建静态工具类： 这个工具类将包含一系列静态方法，每个方法接收jOOQ生成的枚举实例作为参数，并返回对应的自定义属性值。

// 文件名: CapacityTypeUtils.java
package com.example.utils;

import com.example.generated.enums.CapacityType; // 假设这是jOOQ生成的枚举

public class CapacityTypeUtils {

    public static String getDescription(CapacityType type) {
        if (type == null) {
            return null;
        }
        return switch (type) {
            case Accepting -> "Accepting until end of day";
            case Limited -> "Limited until end of day";
            case AtCapacity -> "At Capacity until further notice";
            default -> type.getLiteral();
        };
    }

    public static boolean isUserOverridable(CapacityType type) {
        if (type == null) {
            return false;
        }
        return switch (type) {
            case Accepting, Limited -> true;
            case AtCapacity -> false;
            default -> false;
        };
    }
}

登录后复制

使用方式： 在代码中需要访问自定义属性时，调用工具类的方法。

// 假设 record 是一个jOOQ生成的记录对象
CapacityType capacityType = record.getCapacityType();
String description = CapacityTypeUtils.getDescription(capacityType);
boolean overridable = CapacityTypeUtils.isUserOverridable(capacityType);

登录后复制

优缺点：

优点： 简单、快速，不需要修改代码生成配置或生成代码。业务逻辑与jOOQ生成的枚举完全解耦，易于维护。
缺点： 不够面向对象。每次访问属性都需要显式调用工具类方法，而不是直接通过枚举实例访问，可能导致代码可读性稍差。

策略三：使用独立的枚举和类型转换器

这是最灵活且推荐的策略，尤其适用于业务逻辑复杂、需要完全控制枚举行为的场景。它允许你定义一个功能完备的自定义Java枚举，并通过jOOQ的Converter机制将其与jOOQ生成的简单枚举进行双向映射。

实现步骤：

定义自定义的Java枚举： 创建一个包含所有自定义属性和方法的枚举类，与Hibernate示例中的枚举类似。

// 文件名: CustomCapacityType.java
package com.example.model;

public enum CustomCapacityType {
    Accepting("Accepting until end of day", true),
    Limited("Limited until end of day", true),
    AtCapacity("At Capacity until further notice", false);

    private final String description;
    private final boolean userOverridable;

    CustomCapacityType(String description, boolean userOverridable) {
        this.description = description;
        this.userOverridable = userOverridable;
    }

    public String getDescription() {
        return this.description;
    }

    public boolean isUserOverridable() {
        return this.userOverridable;
    }

    // 辅助方法：根据字面量查找枚举实例
    public static CustomCapacityType fromLiteral(String literal) {
        for (CustomCapacityType type : values()) {
            if (type.name().equalsIgnoreCase(literal)) { // jOOQ的literal通常与枚举名一致
                return type;
            }
        }
        throw new IllegalArgumentException("Unknown CustomCapacityType literal: " + literal);
    }
}

登录后复制

创建jOOQ Converter 实现： 实现org.jooq.Converter<T, U>接口，其中T是jOOQ生成的枚举类型（数据库类型），U是你自定义的枚举类型（用户类型）。

// 文件名: CustomCapacityTypeConverter.java
package com.example.converter;

import org.jooq.Converter;
import com.example.generated.enums.CapacityType; // jOOQ生成的枚举
import com.example.model.CustomCapacityType; // 你自定义的枚举

public class CustomCapacityTypeConverter implements Converter<CapacityType, CustomCapacityType> {

    @Override
    public CustomCapacityType from(CapacityType databaseObject) {
        if (databaseObject == null) {
            return null;
        }
        // 将jOOQ生成的枚举转换为自定义枚举
        return CustomCapacityType.fromLiteral(databaseObject.getLiteral());
    }

    @Override
    public CapacityType to(CustomCapacityType userObject) {
        if (userObject == null) {
            return null;
        }
        // 将自定义枚举转换为jOOQ生成的枚举（用于数据库存储）
        // 注意：CapacityType.lookupLiteral() 是jOOQ生成的辅助方法
        return CapacityType.lookupLiteral(userObject.name());
    }

    @Override
    public Class<CapacityType> fromType() {
        return CapacityType.class;
    }

    @Override
    public Class<CustomCapacityType> toType() {
        return CustomCapacityType.class;
    }
}

登录后复制

配置jOOQ代码生成器使用 ForcedType： 在jooq-codegen.xml中，使用<forcedType>元素将数据库中的枚举类型映射到你的自定义枚举和转换器。

<configuration>
    <generator>
        <database>
            <!-- 数据库连接和schema配置 -->
            <inputSchema>wastecoordinator</inputSchema>
            <forcedTypes>
                <forcedType>
                    <userType>com.example.model.CustomCapacityType</userType>        <!-- 你的自定义枚举类型 -->
                    <converter>com.example.converter.CustomCapacityTypeConverter</converter> <!-- 你的转换器 -->
                    <!-- 匹配数据库中的枚举类型名称。这里使用正则表达式匹配 schema.enum_name -->
                    <expression>.*\.capacity_type</expression>
                    <!-- 或者，如果只想匹配特定的列名，可以使用 <column> 标签 -->
                    <!-- <column>my_table\.capacity_column</column> -->
                </forcedType>
            </forcedTypes>
        </database>
        <target>
            <!-- 生成代码的目标路径和包名 -->
            <packageName>com.example.generated</packageName>
            <directory>src/main/java</directory>
        </target>
    </generator>
</configuration>

登录后复制

重新运行jOOQ代码生成器后，jOOQ生成的记录（Record）和表（Table）将直接使用CustomCapacityType作为capacity_type列的Java类型。

优缺点：

优点： 提供了对枚举行为的完全控制，保持了面向对象的设计原则。业务逻辑封装在自定义枚举中，清晰且易于测试和维护。jOOQ生成的代码会直接使用自定义枚举类型，无需额外转换。
缺点： 增加了代码量（需要定义自定义枚举和转换器）。需要配置jOOQ代码生成器，并在每次枚举定义或转换逻辑变更时重新生成代码。