@AuthenticationPrincipal 어노테이션은 스프링 시큐리티(Spring Security)에서 현재 인증된 사용자(로그인한 사용자)의 정보를 컨트롤러(Controller)에서 쉽게 가져올 수 있도록 해주는 마법 같은 도구입니다.

• "지금 로그인한 사람이 누구야?" 라고 물어보는 것과 같습니다.
• 스프링 시큐리티는 로그인한 사용자의 정보를 UserDetails라는 특별한 상자에 담아 관리합니다.
• @AuthenticationPrincipal 어노테이션은 이 UserDetails 상자를 컨트롤러의 메서드에 직접 전달해줍니다.
• 개발자는 복잡한 코드를 직접 작성할 필요 없이, 어노테이션 하나로 로그인한 사용자의 정보를 바로 사용할 수 있습니다.

예시:

import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @GetMapping("/my-profile")
    public String getMyProfile(@AuthenticationPrincipal UserDetails userDetails) {
        String username = userDetails.getUsername(); // 로그인한 사용자의 아이디
        // ... 다른 사용자 정보 사용 ...
        return "내 아이디는 " + username + " 입니다.";
    }
}

위 코드에서 @AuthenticationPrincipal UserDetails userDetails 부분은:

1. 스프링 시큐리티가 로그인한 사용자의 UserDetails 상자를 가져옵니다.
2. UserDetails 상자를 getMyProfile 메서드의 userDetails 파라미터로 전달합니다.
3. getMyProfile 메서드에서는 userDetails.getUsername()과 같이 UserDetails 상자 안의 정보를 꺼내 사용할 수 있습니다.

장점:

• 코드 간결성: 복잡한 로그인 관련 코드를 줄여줍니다.
• 가독성 향상: 코드만 봐도 어떤 정보를 사용하는지 쉽게 알 수 있습니다.
• 유지보수성 향상: 로그인 관련 코드를 한 곳에서 관리할 수 있습니다.