不使用NativeQuery时，JPA查询无法获取JSONB属性'gender'

问题分析 #

你遇到的错误是因为JPQL不支持PostgreSQL特有的->>操作符，这是数据库原生语法，直接写在JPQL查询中会被解析器判定为非法语法。下面提供几种无需使用NativeQuery的解决方案：

方案1：使用JPQL的FUNCTION调用PostgreSQL内置函数 #

PostgreSQL的->>操作等价于jsonb_extract_path_text(jsonb_column, 'key')，可以通过JPQL的FUNCTION语法调用这个数据库函数，实现跨兼容的查询。

修改仓库接口 #

public interface CustomerDataRepository extends JpaRepository<CustomerData, Long> {
    @Query("SELECT COUNT(c.id), FUNCTION('jsonb_extract_path_text', c.customerData, 'gender') " +
           "FROM CustomerData c " +
           "GROUP BY FUNCTION('jsonb_extract_path_text', c.customerData, 'gender')")
    List<Object[]> getGenderStats();
}

使用说明 #

查询返回的List<Object[]>中，每个数组的第一个元素是Long类型的统计数量，第二个元素是String类型的gender值。你可以遍历列表获取数据：

List<Object[]> stats = customerDataRepository.getGenderStats();
for (Object[] stat : stats) {
    Long count = (Long) stat[0];
    String gender = (String) stat[1];
    // 业务处理逻辑
}

方案2：通过@Formula在实体类中映射gender属性 #

在实体类中添加@Formula字段，直接将JSONB中的gender属性映射为实体类的只读属性，这样就可以在JPQL中直接使用该属性进行查询。

修改实体类 #

@Entity
public class CustomerData {
    
    @Id
    private Long id;
    
    @Type(type = "jsonb")
    @Column(columnDefinition = "jsonb")
    private Map<String, Object> customerData = new HashMap<>();
    
    // 注意：这里使用数据库实际列名（驼峰转下划线后的customer_data）
    @Formula("customer_data->>'gender'")
    private String gender;

    // gender为只读属性，仅需提供getter
    public String getGender() {
        return gender;
    }
}

修改仓库接口 #

public interface CustomerDataRepository extends JpaRepository<CustomerData, Long> {
    @Query("SELECT COUNT(c.id), c.gender FROM CustomerData c GROUP BY c.gender")
    List<Object[]> getGenderStats();
}

方案3：自定义Hibernate方言，注册JSONB操作函数 #

如果需要频繁使用JSONB的属性查询，可以自定义Hibernate方言，将->>操作注册为JPQL可用的函数，简化查询语句。

自定义方言类 #

public class CustomPostgreSQLDialect extends PostgreSQLDialect {
    public CustomPostgreSQLDialect() {
        super();
        // 注册自定义函数jsonb_get_text，对应?1->>?2语法
        registerFunction("jsonb_get_text", 
            new SQLFunctionTemplate(StandardBasicTypes.STRING, "?1->>?2"));
    }
}

配置方言 #

在application.properties（或application.yml）中指定自定义方言：

spring.jpa.properties.hibernate.dialect=com.yourpackage.CustomPostgreSQLDialect

使用自定义函数查询 #

public interface CustomerDataRepository extends JpaRepository<CustomerData, Long> {
    @Query("SELECT COUNT(c.id), jsonb_get_text(c.customerData, 'gender') " +
           "FROM CustomerData c " +
           "GROUP BY jsonb_get_text(c.customerData, 'gender')")
    List<Object[]> getGenderStats();
}

优化：使用DTO接收查询结果 #

如果觉得Object[]不够直观，可以创建DTO类，通过构造函数投影直接返回结构化数据：

创建DTO类 #

public class GenderStatsDTO {
    private Long count;
    private String gender;

    // 必须提供对应参数顺序的构造函数
    public GenderStatsDTO(Long count, String gender) {
        this.count = count;
        this.gender = gender;
    }

    // getter方法
    public Long getCount() {
        return count;
    }

    public String getGender() {
        return gender;
    }
}

修改仓库接口查询 #

以方案1为例，修改后的查询：

@Query("SELECT new com.yourpackage.GenderStatsDTO(COUNT(c.id), FUNCTION('jsonb_extract_path_text', c.customerData, 'gender')) " +
       "FROM CustomerData c " +
       "GROUP BY FUNCTION('jsonb_extract_path_text', c.customerData, 'gender')")
List<GenderStatsDTO> getGenderStats();

这样查询返回的就是List<GenderStatsDTO>，直接调用getter即可获取数据，代码可读性更高。

内容的提问来源于stack exchange，提问作者ÄLi D Yëss