如何在Olingo OData4 Java Spring Boot响应中排除属性

在基于Java Spring Boot的Olingo OData4服务中，若需将Employee实体的details属性从响应中排除，可参考以下方案：

场景代码示例 #

实体类（Employee.java） #

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.Id;
import jakarta.persistence.Table;

@Entity
@Table(schema="EMPLOWNER", name="EMPLOYEE")
public class Employee{
    private String empId;
    private String empName;
    // 需要从响应中排除的属性
    private String details;
    
    // 此处省略getter/setter方法
}

当前EDM配置类（EmployeeCsdlEntityType.java） #

import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeKind;
import org.apache.olingo.commons.api.edm.provider.CsdlEntityType;
import org.apache.olingo.commons.api.edm.provider.CsdlProperty;
import org.apache.olingo.commons.api.edm.provider.CsdlPropertyRef;

import java.util.Arrays;
import java.util.Collections;

public class EmplCsdlEntityType implements ICsdlEntityType{

    @Override
    public CsdlEntityType getCsdlEntityType(EntityDetailEnum entityDetailEnum){
        CsdlProperty empId = new CsdlProperty()
                .setName("empId")
                .setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
        CsdlProperty empName = new CsdlProperty()
                .setName("empName")
                .setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
        CsdlProperty details = new CsdlProperty()
                .setName("details")
                .setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());

        CsdlPropertyRef propRef = new CsdlPropertyRef();
        propRef.setName("empId"); // 修正原代码错误：主键应指向实体存在的empId字段

        CsdlEntityType entityType = new CsdlEntityType();
        entityType.setName(entityDetailEnum.getEntityType());
        entityType.setProperties(Arrays.asList(empId, empName, details));
        entityType.setKey(Collections.singletonList(propRef));
        return entityType;
    }
}

解决方案 #

方法1：直接从EDM模型中移除属性 #

这是最直接的方式，在构建EDM元数据时，不将需要排除的属性加入实体的属性列表：

修改EmployeeCsdlEntityType.java代码：

@Override
public CsdlEntityType getCsdlEntityType(EntityDetailEnum entityDetailEnum){
    CsdlProperty empId = new CsdlProperty()
            .setName("empId")
            .setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
    CsdlProperty empName = new CsdlProperty()
            .setName("empName")
            .setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
    // 不再创建details属性对象

    CsdlPropertyRef propRef = new CsdlPropertyRef();
    propRef.setName("empId");

    CsdlEntityType entityType = new CsdlEntityType();
    entityType.setName(entityDetailEnum.getEntityType());
    // 仅添加需要对外暴露的属性
    entityType.setProperties(Arrays.asList(empId, empName));
    entityType.setKey(Collections.singletonList(propRef));
    return entityType;
}

此方式下，OData元数据中不会包含details属性，响应自然也不会返回该字段。

方法2：自定义注解+序列化过滤 #

若需保留实体类中的属性，但在响应中隐藏，可通过自定义注解结合序列化逻辑实现：

1. 定义排除属性的注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

2. 在Employee实体的details字段上添加注解：

@ODataExclude
private String details;

3. 在数据转换阶段过滤属性：
   在将实体转换为OData响应数据的环节，通过反射检查字段注解，排除标记了@ODataExclude的属性：

// 示例：在数据提供类中处理属性过滤
public Map<String, Object> getEmployeeData(Employee employee) {
    Map<String, Object> data = new HashMap<>();
    Field[] fields = Employee.class.getDeclaredFields();
    for (Field field : fields) {
        if (!field.isAnnotationPresent(ODataExclude.class)) {
            field.setAccessible(true);
            try {
                data.put(field.getName(), field.get(employee));
            } catch (IllegalAccessException e) {
                // 按需处理异常
            }
        }
    }
    return data;
}

方法3：利用OData原生$select参数动态控制 #

Olingo默认支持OData的$select查询选项，客户端可通过请求参数指定需要返回的属性，例如：

GET /Employees?$select=empId,empName

此请求会自动排除details属性，适合需要灵活控制返回字段的场景。

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