Spring JPA REST按嵌套属性

时间:2017-01-23 13:33:12

标签: java spring rest spring-data-jpa spring-data-rest

我有实体MarketEventMarket实体有一列:

@ManyToOne(fetch = FetchType.EAGER)
private Event event;

接下来我有一个存储库:

public interface MarketRepository extends PagingAndSortingRepository<Market, Long> {
}

和投影:

@Projection(name="expanded", types={Market.class})
public interface ExpandedMarket {
    public String getName();
    public Event getEvent();
}

使用REST查询/api/markets?projection=expanded&sort=name,asc我成功获得了按市场名称排序的嵌套事件属性的市场列表:

{
    "_embedded" : {
        "markets" : [ {
            "name" : "Match Odds",
            "event" : {
                "id" : 1,
                "name" : "Watford vs Crystal Palace"
            },
            ...
        }, {
            "name" : "Match Odds",
            "event" : {
                "id" : 2,
                "name" : "Arsenal vs West Brom",
            },
            ...
        },
        ...
    }
}

但我需要的是获取按活动名称排序的市场列表,我尝试了查询/api/markets?projection=expanded&sort=event.name,asc,但它没有成功。我该怎么做才能让它发挥作用?

7 个答案:

答案 0 :(得分:1)

降级 spring.data.‌​rest.webmvcHopper发布

<spring.data.jpa.version>1.10.10.RELEASE</spring.data.jpa.ve‌​rsion> 
<spring.data.‌​rest.webmvc.version>‌​2.5.10.RELEASE</spri‌​ng.data.rest.webmvc.‌​version>

projection=expanded&sort=event.name,asc // works
projection=expanded&sort=event_name,asc // this works too

感谢@Alan Haythis question

的评论
  

在Hopper版本中,嵌套属性的排序对我来说很好,但我确实在Ingalls版本的RC版本的RC版本的Ingalls release.bug中遇到了以下错误。据报道这是固定的,

顺便说一句,我试过v3.0.0.M3报告已修复但未与我合作。

答案 1 :(得分:1)

关于此问题有任何消息吗? 同样在Spring Boot 2.1和Spring Data Lovelace版本中,无法按嵌套属性进行排序。

答案 2 :(得分:0)

尝试使用_代替.

/api/markets?projection=expanded&sort=event_name,asc

答案 3 :(得分:0)

您的MarketRepository可能有named query之类的内容:

public interface MarketRepository exten PagingAndSortingRepository<Market, Long> {
    Page<Market> findAllByEventByName(String name, Page pageable);
}

您可以使用name

从网址获取@RequestParam参数

答案 4 :(得分:0)

page的想法可行。想法是在存储库顶部使用控制器,并分别应用投影。

这是一段有效的代码(SpringBoot 2.2.4)

import ro.vdinulescu.AssignmentsOverviewProjection;
import ro.vdinulescu.repository.AssignmentRepository;
import org.apache.commons.lang3.StringUtils;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.projection.ProjectionFactory;
import org.springframework.data.web.PagedResourcesAssembler;
import org.springframework.hateoas.EntityModel;
import org.springframework.hateoas.PagedModel;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RepositoryRestController
public class AssignmentController {
    @Autowired
    private AssignmentRepository assignmentRepository;

    @Autowired
    private ProjectionFactory projectionFactory;

    @Autowired
    private PagedResourcesAssembler<AssignmentsOverviewProjection> resourceAssembler;

    @GetMapping("/assignments")   
    public PagedModel<EntityModel<AssignmentsOverviewProjection>> listAssignments(@RequestParam(required = false) String search,
                                                                                  @RequestParam(required = false) String sort,
                                                                                  Pageable pageable) {
        // Spring creates the Pageable object correctly for simple properties,
        // but for nested properties we need to fix it manually   
        pageable = fixPageableSort(pageable, sort, Set.of("client.firstName", "client.age"));

        Page<Assignment> assignments = assignmentRepository.filter(search, pageable);
        Page<AssignmentsOverviewProjection> projectedAssignments = assignments.map(assignment -> projectionFactory.createProjection(
                AssignmentsOverviewProjection.class,
                assignment));

        return resourceAssembler.toModel(projectedAssignments);
    }

    private Pageable fixPageableSort(Pageable pageable, String sortStr, Set<String> allowedProperties) {
        if (!pageable.getSort().equals(Sort.unsorted())) {
            return pageable;
        }

        Sort sort = parseSortString(sortStr, allowedProperties);
        if (sort == null) {
            return pageable;
        }

        return PageRequest.of(pageable.getPageNumber(), pageable.getPageSize(), sort);
    }

    private Sort parseSortString(String sortStr, Set<String> allowedProperties) {
        if (StringUtils.isBlank(sortStr)) {
            return null;
        }

        String[] split = sortStr.split(",");
        if (split.length == 1) {
            if (!allowedProperties.contains(split[0])) {
                return null;
            }
            return Sort.by(split[0]);
        } else if (split.length == 2) {
            if (!allowedProperties.contains(split[0])) {
                return null;
            }
            return Sort.by(Sort.Direction.fromString(split[1]), split[0]);
        } else {
            return null;
        }
    }

}

答案 5 :(得分:0)

从Spring Data REST文档中:

不支持通过可链接的关联进行排序(即,链接到顶级资源)。

https://docs.spring.io/spring-data/rest/docs/current/reference/html/#paging-and-sorting.sorting

我发现的一种替代方法是使用@ResResource(exported=false)。 这是无效的(尤其是对于旧版Spring Data REST项目而言),因为避免资源/实体将被加载HTTP链接:

JacksonBinder
BeanDeserializerBuilder updateBuilder throws
 com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot construct instance of ' com...' no String-argument constructor/factory method to deserialize from String value

我尝试在注释的帮助下通过可链接的关联激活排序,但是没有成功,因为我们始终需要覆盖mappPropertyPath的{​​{1}}方法来检测注释:

JacksonMappingAwareSortTranslator.SortTranslator

注释

            if (associations.isLinkableAssociation(persistentProperty)) {
                if(!persistentProperty.isAnnotationPresent(SortByLinkableAssociation.class)) {
                    return Collections.emptyList();
                }
            }

在您的项目中,将 @SortByLinkableAssociation 包含在可排序的可链接关联中。

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

真的,我没有找到一个明确且成功的解决方案,但决定公开进行讨论,甚至春季团队考虑将其包含在下一个版本中。

答案 6 :(得分:0)

我们有一个案例,我们想按链接实体中的字段排序(这是一对一的关系)。最初,我们使用基于 https://stackoverflow.com/a/54517551 的示例按链接字段进行搜索。

因此,在我们的案例中,解决方法/hack 是提供自定义排序和可分页参数。 示例如下:

@org.springframework.data.rest.webmvc.RepositoryRestController
public class FilteringController {

private final EntityRepository repository;

@RequestMapping(value = "/entities",
        method = RequestMethod.GET)

public ResponseEntity<?> filter(
        Entity entity,
        org.springframework.data.domain.Pageable page,
        org.springframework.data.web.PagedResourcesAssembler assembler,
        org.springframework.data.rest.webmvc.PersistentEntityResourceAssembler entityAssembler,
        org.springframework.web.context.request.ServletWebRequest webRequest
) {

    Method enclosingMethod = new Object() {}.getClass().getEnclosingMethod();
    Sort sort = new org.springframework.data.web.SortHandlerMethodArgumentResolver().resolveArgument(
            new org.springframework.core.MethodParameter(enclosingMethod, 0), null, webRequest, null
    );

    ExampleMatcher matcher = ExampleMatcher.matching()
            .withIgnoreCase()
            .withStringMatcher(ExampleMatcher.StringMatcher.CONTAINING);
    Example example = Example.of(entity, matcher);

    Page<?> result = this.repository.findAll(example, PageRequest.of(
            page.getPageNumber(),
            page.getPageSize(),
            sort
    ));
    PagedModel search = assembler.toModel(result, entityAssembler);
    search.add(linkTo(FilteringController.class)
            .slash("entities/search")
            .withRel("search"));
    return ResponseEntity.ok(search);
}
}

使用的Spring boot版本:2.3.8.RELEASE

我们还有实体的存储库并使用了投影:

@RepositoryRestResource
public interface JpaEntityRepository extends JpaRepository<Entity, Long> {
}