Olingo (OData 4) + JPA：如何重新定义元数据（SAP实现）

针对你需要修改部分类或属性外部名称、尤其是不同实体同名属性选择性重命名的需求，以下是几种可行的实现方案：

1. 扩展JPAEdmNameBuilder，基于实体上下文选择性重命名 #

默认的JPAEdmNameBuilder提供了带完整JPA属性/实体对象的重载方法，通过重写这些方法可以获取属性所属的实体信息，实现针对性重命名。

示例代码 #

public class CustomJPAEdmNameBuilder extends JPAEdmNameBuilder {
    @Override
    public String buildAttributeName(Attribute<?, ?> jpaAttribute) {
        // 获取属性所属的实体类
        Class<?> entityClass = jpaAttribute.getDeclaringType().getJavaType();
        String originalAttrName = jpaAttribute.getName();
        
        // 按实体+属性名组合规则重命名
        if (entityClass.equals(Order.class) && originalAttrName.equals("code")) {
            return "OrderCode";
        } else if (entityClass.equals(Customer.class) && originalAttrName.equals("code")) {
            return "CustomerCode";
        }
        // 未匹配规则时沿用父类逻辑
        return super.buildAttributeName(jpaAttribute);
    }

    @Override
    public String buildEntityTypeName(EntityType<?> jpaEntityType) {
        // 同理可重定义实体的外部名称
        Class<?> entityClass = jpaEntityType.getJavaType();
        if (entityClass.equals(Order.class)) {
            return "SalesOrder";
        }
        return super.buildEntityTypeName(jpaEntityType);
    }
}

注册自定义构建器 #

在OData服务初始化时注册该构建器：

JPAODataSessionContextAccess sessionContext = ...; // 获取会话上下文实例
sessionContext.setJPAEdmNameBuilder(new CustomJPAEdmNameBuilder());

2. 使用JPAEntityTypePostProcessor做元模型后处理 #

如果需要更灵活的元模型调整（比如修改属性的其他EDM元数据），可以实现JPAEntityTypePostProcessor接口，在EDM模型构建完成后做二次修改。

示例代码 #

public class CustomEntityPostProcessor implements JPAEntityTypePostProcessor {
    @Override
    public void process(JPAEdmEntityTypeAccess entityTypeAccess, JPASessionContext sessionContext) {
        EntityType<?> jpaEntityType = entityTypeAccess.getJPAEntityType();
        Class<?> entityClass = jpaEntityType.getJavaType();
        
        // 针对Order实体做元模型调整
        if (entityClass.equals(Order.class)) {
            EdmEntityType edmEntity = entityTypeAccess.getEdmEntityType();
            // 可在此处调整属性的可访问性、注释等其他元数据
        }
    }
}

注册后处理器 #

JPAODataFactory oDataFactory = JPAODataFactory.getInstance();
oDataFactory.registerJPAEntityTypePostProcessor(new CustomEntityPostProcessor());

3. 自定义注解+名称构建器，实现声明式重命名 #

通过自定义注解标注实体/属性的期望外部名称，在名称构建器中读取注解值完成重命名，更符合代码可读性要求。

自定义注解 #

@Target({ElementType.TYPE, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ODataExternalName {
    String value();
}

实体类中使用注解 #

@Entity
@ODataExternalName("SalesOrder")
public class Order {
    @Id
    @ODataExternalName("OrderCode")
    private String code;
    // ...其他属性
}

名称构建器读取注解 #

@Override
public String buildAttributeName(Attribute<?, ?> jpaAttribute) {
    ODataExternalName nameAnnotation = jpaAttribute.getAnnotation(ODataExternalName.class);
    if (nameAnnotation != null) {
        return nameAnnotation.value();
    }
    return super.buildAttributeName(jpaAttribute);
}

@Override
public String buildEntityTypeName(EntityType<?> jpaEntityType) {
    ODataExternalName nameAnnotation = jpaEntityType.getJavaType().getAnnotation(ODataExternalName.class);
    if (nameAnnotation != null) {
        return nameAnnotation.value();
    }
    return super.buildEntityTypeName(jpaEntityType);
}

以上方案中，扩展JPAEdmNameBuilder是最直接适配你需求的方式，能精准处理不同实体中同名属性的选择性重命名，效果类似OData2的元模型重定义功能。

内容的提问来源于stack exchange，提问作者Agustín Santos Méndez