如何使用spring data jpa查询jsonb列？

Question

我在获取这个针对 postgres 9.4 实例的本机查询时遇到问题。

我的仓库有一个方法：

 @Query(value = "SELECT t.* " +
            "FROM my_table t " +
            "WHERE t.field_1 = ?1 " +
            "AND t.field_2 = 1 " +
            "AND t.field_3 IN ?2 " +
            "AND t.jsonb_field #>> '{key,subkey}' = ?3",
            nativeQuery = true)
    List<Entity> getEntities(String field1Value,
                                   Collection<Integer> field3Values,
                                   String jsonbFieldValue);

但日志显示：

SELECT t.* FROM my_table t 
WHERE t.field_1 = ?1 
  AND t.field_2 = 1 
  AND t.field_3 IN ?2 
  AND t.jsonb_field ? '{key,subkey}' = ?3

我得到了这个例外：

内部异常：org.postgresql.util.PSQLException：无值 为参数 2 指定。

我在方法调用之前直接记录了参数，它们都是提供的。

我不确定为什么#>> 在日志中显示?。我需要逃避#>>吗？我需要为IN 格式化集合吗？我需要转义 json 路径吗？

当我直接对数据库执行查询时，它可以工作。示例：

SELECT *
FROM my_table t
WHERE t.field_1 = 'xxxx'
  AND t.field_2 = 1
  AND t.field_3 IN (13)
  AND t.jsonb_field #>> '{key,subkey}' = 'value'

Answer 1

我发现 spring data 中的 Specification api 非常有用。
假设我们有一个名称为 Product 的实体和一个名称为 title 的 JSON(B) 类型的属性。
我假设此属性包含不同语言的产品标题。例如：{"EN":"Multicolor LED light", "EL":"Πολύχρωμο LED φώς"}.
下面的源代码通过作为参数传递的标题和语言环境找到一个（或更多，如果它不是唯一字段）产品。

@Repository
public interface ProductRepository extends JpaRepository<Product, Integer>, JpaSpecificationExecutor<Product> {
}


public class ProductSpecification implements Specification<Product> {

    private String locale;
    private String titleToSearch;

    public ProductSpecification(String locale, String titleToSearch) {
        this.locale = locale;
        this.titleToSearch = titleToSearch;
    }

    @Override
    public Predicate toPredicate(Root<Product> root, CriteriaQuery<?> query, CriteriaBuilder builder) {
        return builder.equal(builder.function("jsonb_extract_path_text", String.class, root.<String>get("title"), builder.literal(this.locale)), this.titleToSearch);
    }
}


@Service
public class ProductService {

    @Autowired
    private ProductRepository productRepository;

    public List<Product> findByTitle(String locale, String titleToSearch) {
        ProductSpecification cs = new ProductSpecification(locale, titleToSearch);
        return productRepository.find(cs);
        // Or using lambda expression - without the need of ProductSpecification class.
//      return productRepository.find((Root<ProductCategory> root, CriteriaQuery<?> query, CriteriaBuilder builder) -> {
//          return builder.equal(builder.function("jsonb_extract_path_text", String.class, root.<String>get("title"), builder.literal(locale)), titleToSearch);
//      });
    }
}

您可以找到另一个关于如何使用 Spring Data here 的答案。
希望对您有所帮助。

Answer 2

如果由于某种原因将运算符转换为问号，那么您应该尝试使用该函数。您可以在 psql 控制台中使用\doS+ #>> 找到相应的函数。它告诉我们调用的函数是jsonb_extract_path_text。这将使您的查询：

@Query(value = "SELECT t.* " +
        "FROM my_table t " +
        "WHERE t.field_1 = ?1 " +
        "AND t.field_2 = 1 " +
        "AND t.field_3 IN ?2 " +
        "AND jsonb_extract_path_text(t.jsonb_field, '{key,subkey}') = ?3",
        nativeQuery = true)

Answer 3

也许这是一个老话题，但我在这里使用spring规范按字段搜索jsonb。

如果您想使用“LIKE”进行搜索，您需要使用以下代码创建 like 析取：

final Predicate likeSearch = cb.disjunction();

之后，假设您的对象中有 jsonb 字段，即地址，地址有 5 个字段。要在所有这些字段中搜索，您需要为所有字段添加“LIKE”表达式：

for (String field : ADDRESS_SEARCH_FIELDS) {
                likeSearch.getExpressions().add(cb.like(cb.lower(cb.function("json_extract_path_text", String.class,
                        root.get("address"), cb.literal(field))), %searchKey%));
            }

其中cb 是相同的criteriaBuilder。 %searchKey% 是您要在地址字段中搜索的内容。

希望这会有所帮助。

Answer 4

您还可以使用FUNC JPQL 键来调用自定义函数，而不是使用本机查询。
像这样的，

@Query(value = "SELECT t FROM my_table t "
        + "WHERE t.field_1=:field_1 AND t.field_2=1 AND t.field_3 IN :field_3 "
        + "AND FUNC('jsonb_extract_path_text', 'key', 'subkey')=:value")
List<Entity> getEntities(@Param("field_1") String field_1, @Param("field_3") Collection<Integer> field_3, @Param("value") String value);

Answer 5

我建议不要遵循这种方式，我更喜欢遵循通用的 CRUD 方式（对于 Spring Data Rest maven 插件，也可以使用 StrongLoop Loopback 的高级自动生成的 DAO 方法，但它目前只是实验性的）。 但是有了这个 JSON，现在该怎么办......我正在通过 @Document 注释在 Spring Data 中寻找类似于 MongoDB JSON 处理的东西，但是这还不可用。但是还有其他方法:-)

一般来说，它是关于实现你的 JSON 用户类型（UserType 接口）：

public class YourJSONBType implements UserType {

最后，您需要使用您实现的用户类型的规范来增强您的 JPA 类：

@Entity
@Data
@AllArgsConstructor
@NoArgsConstructor
@TypeDef(name = "JsonbType", typeClass = YourJSONBType.class)
public class Person {
    @Id
    @GeneratedValue
    private Long id;

    @Column(columnDefinition = "jsonb")
    @Type(type = "JsonbType")
    private Map<String,Object> info;
}

在此处查看另一篇相关文章： Mapping PostgreSQL JSON column to Hibernate value type

完整的实现示例可在此处获得：

• https://github.com/nzhong/spring-data-jpa-postgresql-json
• https://github.com/mariusneo/postgres-json-jpa

此处提供了类似但略有不同的示例： http://www.wisely.top/2017/06/27/spring-data-jpa-postgresql-jsonb/?d=1

Answer 6

分享我自己的例子，因为我努力分解提供的答案以满足我的特定需求。希望这对其他人有帮助。我的示例在 groovy 中，并且正在与 postgres SQL 数据库集成。这是一个简单示例，说明如何在名为“name”的字段上搜索 JSON 列并使用分页。

JSON 支持类

@TypeDefs([@TypeDef(name = "jsonb", typeClass = JsonBinaryType.class)])
@MappedSuperclass
class JSONSupport {}

实体类：

@Entity
@Table(name = "my_table")
class MyEntity extends JSONSupport {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    Long pk

    @Type(type = "jsonb")
    @Column(columnDefinition = "jsonb")
    String jsonData
}

规范类

class NameSpecification implements Specification<MyEntity> {

    private final String name

    PhoneNumberSpecification(String name) {
        this.name = name
    }

    @Override
    Predicate toPredicate(Root<ContactEntity> root, CriteriaQuery<?> query, CriteriaBuilder builder) {
        return builder.equals(
                   builder.function(
                       "jsonb_extract_path_text",
                       String.class,
                       root.<String>get("jsonData"),
                       builder.literal("name")
                   ),
                   this.name
              )
    }
}

存储库

interface MyEntityRepository extends PagingAndSortingRepository<MyEntity, Long>, JpaSpecificationExecutor<MyEntity> {}

用法

@Service
class MyEntityService {
    
    private final MyEntityRepository repo
    
    MyEntityService(MyEntityRepository repo) {
         this.repo = repo
    }    

    Page<MyEntity> getEntitiesByNameAndPage(String name, Integer page, Integer pageSize) {
        PageRequest pageRequest = PageRequest.of(page, pageSize, Sort.by("pk"))

        NameSpecification spec = new NameSpecification(name)
        return repo.findAll(spec, pageRequest)
    }
}