Spring JPA Query returns Null instead of List

Question

I have an @Entity Video having a one-to-many relation with a List<Tag> tags as one of its fields. I use the following @Repository using Spring Data to get the most popular tags:

@Repository
public interface TagRepository extends CrudRepository<Tag, Integer>{
    @Query("SELECT t FROM Tag t WHERE (SELECT SUM(v.views) FROM Video v WHERE t MEMBER OF v.tags) > 0")
    public List<Tag> findMostViewedTags(int maxTags);
}

The Query is processed and considered valid by Spring, I tested the generated SQL vs my database locally and it returned 2 Tags. In my Code however, I receive the value Null when I call the method findMostViewedTags(100).

The Query lookup strategy is the default "CREATE_IF_NOT_FOUND".

If there are no results found, should the method return an empty list or Null? My desired behavior is to receive an empty list.
Why does the method call return Null instead of a List<Tag> with size() 2?

maxTags isn't used or that isn't the query you are actually executing. — M. Deinum
– M. Deinum, Commented Jun 9, 2016 at 14:18

Vjeetje · Accepted Answer · 2016-01-27 19:14:30Z

48

The normal behavior is indeed returning an empty list if no results are found. If a List<Object> is the return value of the method in the defined interface, the method should never return Null.
The problem is that a parameter is given to the method and is not used anywhere in the Query. For some reason Spring decides to return a Null in that case. Solution: remove the unused parameter or use the parameter in the Query.

answered Jan 27, 2016 at 19:14

Vjeetje

5,4046 gold badges37 silver badges57 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Neil Stockton Over a year ago

The "Solution" should include raise a bug on Spring to better cater for that situation

osmingo Over a year ago

@Vjeetje is it specified anywhere in the docs that it returns an empty list if no results are found? I cant find it

Raja Anbazhagan Over a year ago

@osmingo Here you go.. docs.spring.io/spring-data/jpa/docs/current/reference/html/…

Repository methods returning collections, collection alternatives, wrappers, and streams are guaranteed never to return null but rather the corresponding empty representation

Manuel Over a year ago

The new, and updated link, whether null can be returned: docs.spring.io/spring-data/jpa/reference/repositories/…

user1747134 · Accepted Answer · 2016-06-09 14:15:36Z

7

I have experienced similar problem. The cause was that I was using Mockito and have not correctly mocked the data with when().

answered Jun 9, 2016 at 14:15

user1747134

2,5021 gold badge21 silver badges31 bronze badges

Collectives™ on Stack Overflow

Spring JPA Query returns Null instead of List

2 Answers 2

4 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related