@AuthenticationPrincipal

@AuthenticationPrincipal null값

😰오늘 개인 프로젝트로 시큐리티를 연습하던중 nullpointexception이 발생하였다. 아래는 그 코드이다.

 @GetMapping("/modify/{id}")
 public String questionModify(QuestionForm questionForm,
@PathVariable Long id,
@AuthenticationPrincipal PrincipalUser auth) {
        log.info("authentication ={}", auth); <--EXCEPTION
        
        ...생략
}

---

🤔처음에는 이해가 가지 않았다. 분명 authentication객체를 제대로 반환하도록 만들었기 때문이다. 아래는 그 반환 코드들이다

 @Override
    public Authentication authenticate(Authentication authentication) throws AuthenticationException {

        String username = authentication.getName();
        String password = (String) authentication.getCredentials();

        PrincipalUser userDetails = (PrincipalUser) userSecurityService.loadUserByUsername(username);

        if (!passwordEncoder.matches(password, userDetails.getPassword())) {
            throw new BadCredentialsException("비밀번호가 일치 하지 않습니다.");
        }

        return new UsernamePasswordAuthenticationToken(userDetails.getUsername() , userDetails.getPassword(), userDetails.getAuthorities());
    }

---

🤨위 코드에서 PincipalUser는 OAuth2User와 UserDetails를 구현하고 있는 코드이다. 그래서 provider에서 반환시 UsernamePasswordAuthenticationToken에 담아 반환하도록 하였는데 계속 null값이 들어오는 것이다.

그래서 처음에는 UsernamePasswordAuthenticationToken이 제대로 들어가지 않은 것 같아 디버그로 돌려 보았다.

만약 들어가지 않았다면 SecurityContext에는 위 토큰값이 들어가지 않을 것이기 때문이다.

🫥그러나 수차례 확인해 보아도 인증 객체는 제대로 들어갔다.

원인 파악 및 해결

😊그래서 수많은 구글링을 통해 한 블로거 님의 글을 통해 원인을 알 수 있게 되었다.
이유는 바로 UsernamePasswordAuthenticationToken의 첫번째 생성자에 String인 getUsername값을 넣었기 때문이다.
이론인해 @AuthenticationPrincipal에는 String 값이 들어오게 되고 PrincipalUser와는 타입이 맞지 않아 갑이 null이 들어가게 된 것이었다.

그래서 아래의 코드로 고친 결과 제대로 된 principal값이 들어갔다.

@Override
    public Authentication authenticate(Authentication authentication) throws AuthenticationException {

        String username = authentication.getName();
        String password = (String) authentication.getCredentials();

        PrincipalUser userDetails = (PrincipalUser) userSecurityService.loadUserByUsername(username);

        if (!passwordEncoder.matches(password, userDetails.getPassword())) {
            throw new BadCredentialsException("비밀번호가 일치 하지 않습니다.");
        }

//첫 번째 값에 내가 만든 Principal값 넣기
        return new UsernamePasswordAuthenticationToken(userDetails , userDetails.getPassword(), userDetails.getAuthorities());
    }

아래 블로거님 아니였으면 많은 시간을 해맸을 것 같다.

참고 블로그: Jemni