JPQL @Query 에러: For queries with named parameters you need to use provide names for method parameters

📎 For queries with named parameters you need to use provide names for method parameters

 

 

 

Spring Data JPA에서 아래 Entity를 통해 조회를 하려는데 오류가 발생했습니다.

(email에 대한 데이터는 DB에 존재합니다.)

import ...

@Entity
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Getter
@ToString
public class ClubMember extends BaseEntity {

    @Id
    private String email;

    @Column
    private String password;

    @Column
    private String name;

    @Column
    private boolean fromSocial;

}


import ...

public interface ClubMemberRepository extends JpaRepository<ClubMember, String> {

    @Query("select m from ClubMember m where m.email = :email and m.fromSocial = :social")
    Optional<ClubMember> findByEmail(String email, boolean social);

}


    // 테스트 코드
    @Test
    void read_ClubMember() {
        /* given */
        String email = "user95@zerock.org";

        /* when */
        ClubMember clubMember = clubMemberRepository.findByEmail(email, false)
                .orElseThrow(NullPointerException::new);

        /* then */
        System.out.println(clubMember);
    }

Caused by: java.lang.IllegalStateException: For queries with named parameters you need to use provide names for method parameters. Use @Param for query method parameters, or when on Java 8+ use the javac flag -parameters.

 

 

 

친절하게도 로그에 해결 방법을 알려주고 있습니다.

 

Use @Param for query method parameters, or when on Java 8+ use the javac flag -parameters.

• @Param 어노테이션을 사용하거나 (Java 8+에서) -parameters 을 사용하라는 것입니다.

@Param: 매개변수의 네임을 통해 메서드의 매개 변수를 쿼리에 바인드 시키는 어노테이션

 

따라서 다음과 같이 @Param 어노테이션을 매개변수에 추가해서 해결을 할 수 있습니다. 

...

public interface ClubMemberRepository extends JpaRepository<ClubMember, String> {

    @Query("select m from ClubMember m where m.email = :email and m.fromSocial = :social")
    Optional<ClubMember> findByEmail(@Param("email") String email, @Param("social") boolean social);

}

 

 

 

🤔 그럼 두 번째 해결 방법인 javac flag -parameters 는 무엇을 나타내는 걸까요?

 

먼저 해결 방법부터 나타내면 아래와 같습니다.

Preferences(Command + ,) > Build, Execution, Deployment > Compiler > Java Compiler

Additional command line parameters 부분에 -parameters 를 추가해주면 됩니다.

 

 

 

 

 

🧐 이제 -parameters 라는게 무슨 역할을 하는지 살펴보겠습니다.

 

먼저 Spring Data JPA 공식문서 에서는 다음과 같이 나와있습니다.

 

As of version 4, Spring fully supports Java 8’s parameter name discovery based on the -parameters compiler flag. By using this flag in your build as an alternative to debug information, you can omit the @Param annotation for named parameters.

 

(영어를 잘 못하기에😭) 대략 -parameters compiler flag 를 통해 @Param 어노테이션을 생략할 수 있다고 합니다.

 

 

 

열심히 구글링을 해본 결과 .... stackoverflow 에는 다음과 같은 글들이 존재합니다.

 

Q)

대략적으로 해석해보면 ...

Custom JPQL @Query 메소드를 만들고, @Param 어노테이션을 명시하지 않았는데 오류가 발생한다. 

내용에는 Java 버전이 8보다 작을 경우, @Param 어노테이션을 사용하라고 나와있는데 나는 Java 8을 사용하고 있다.

문제가 무엇이냐? 라고 질문을 남기셨고,

 

A)

Java 8에서 리플렉션을 통해 메소드의 매개변수 이름에 접근할 수 있다.

이러한 방식으로 인해 @Param 어노테이션이 필요하지 않는데, 스프링이 메서드 파라미터의 이름에서

JPQL 파라미터의 이름을 추론할 수 있기 때문이다.

하지만 이를 위해서는 -parameters flag 를 컴파일과 함께 사용해야 한다.

라고 합니다.

 

 

https://stackoverflow.com/questions/48515309/naming-query-parameters-in-spring-repository/48515494

 

 

🧐 따라서 위 내용들을 요약해보면 ...

 

Java 8부터 -parameter flag 설정으로 메소드 매개변수의 이름에 접근할 수 있습니다.

    @Query("select m from ClubMember m where m.email = :email and m.fromSocial = :social")
    Optional<ClubMember> findByEmail(@Param("email") String email, @Param("social") boolean social);

즉, 위 코드에서 메소드의 매개변수를 쿼리에 바인딩 할 때, @Param 어노테이션을 생략할 수 있습니다.

 

기본적으로 Java의 .class 파일은 파라미터의 이름을 저장하지 않습니다. (위 코드에서 email, social)

특정 .class 파일에 매개변수의 이름을 저장하여 Reflection API가 매개변수 이름을 검색하도록 하기 위해

javac compiler의 -parameters 옵션을 사용하여 컴파일을 해야 Runtime시점에 매개변수의 이름을 파악할 수 있습니다.

 

 

 

 

📝 추가 자료

-parameters, 리플렉션 등에 대해 추가적인 자료가 원하시면 아래 사이트들을 더 읽어보시면 좋을 것 같습니다 :)

 

Named Parameters in Java 8

How to compile Java class to include method parameter names?

JEP 118: Access to Parameter Names at Runtime

Obtaining Names of Method Parameters

 

 

 

References

• https://stackoverflow.com/questions/27733892/java-8-spring-data-jpa-parameter-binding
• https://stackoverflow.com/questions/48515309/naming-query-parameters-in-spring-repository/48515494
• https://docs.oracle.com/javase/tutorial/reflect/member/methodparameterreflection.html
• https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.named-parameters