[코드로 배우는 스프링 부트 웹 프로젝트] 10. Spring Boot와 Spring Security 연동 (2)

3. 프로젝트를 위한 JPA 처리
4. 시큐리티를 위한 UserDetailsService
5. Controller에서 사용자 정보 출력하기

3. 프로젝트를 위한 JPA 처리

ClubMember: 엔티티 클래스

ClubMemberRole: 엔티티 enum 클래스

ClubMemberRepository: repository 인터페이스

ClubAuthMemberDTO: DTO 클래스(스프링 시큐리티의 User 클래스를 상속함)

ClubUserDetailsService: service 클래스, AuthenticationManager가 내부적으로 호출하여 사용자 정보 가져오는 클래스 (UserDetailsService 인터페이스 상속함)

 

User: 스프링 시큐리티에서 사용하는 회원, 계정에 대한 용어
username: 회원을 구별할 수 있는 식별 데이터 (일반적인 id와 유사한 기능)

 

ClubMember

entity 패키지 내의 클래스

addMemberRole 메소드로 사용자의 역할 추가 가능

package org.zerock.club.entity;


import lombok.*;

import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.Id;
import java.util.Set;

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

    @Id
    private String email;

    private String password;

    private String name;

    private boolean fromSocial;

    @ElementCollection(fetch = FetchType.LAZY)
    private Set<ClubMemberRole> roleSet;

    public void addMemberRole(ClubMemberRole clubMemberRole){
        roleSet.add(clubMemberRole);
    }

}

ClubMemberRole

entity 패키지 내의 enum 클래스

사용자의 Role을 정의해둠

package org.zerock.club.entity;

public enum ClubMemberRole {

    USER,MANAGER,ADMIN

}

ClubMemberRepository

package org.zerock.club.repository;


import org.springframework.data.jpa.repository.EntityGraph;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.zerock.club.entity.ClubMember;

import java.util.Optional;

public interface ClubMemberRepository extends JpaRepository<ClubMember, String> {

    @EntityGraph(attributePaths = {"roleSet"}, type = EntityGraph.EntityGraphType.LOAD)
    @Query("select m from ClubMember m where m.fromSocial = :social and m.email =:email")
    Optional<ClubMember> findByEmail(String email, boolean social);
}

이메일, 소셜로 추가된 회원 여부 입력받아 사용자 검색

@EntityGraph: left outer join으로 ClubMemberRole도 로딩될 수 있도록 함

4. 시큐리티를 위한 UserDetailsService

ClubAuthMemberDTO

UserDetails 인터페이스를 구현한 User 클래스를 상속

-> DTO와 같은 개념으로 별도 클래스(User)를 구성하고 활용하는 방식

UserDetails 타입
- getAuthorities() : 사용자가 가지는 권한 정보 획득
- getPassword(): 인증을 마무리하기 위한 패스워드 정보 획득
- getUsername(): 인증에 필요한 아이디 같은 정보 획득
- 계정 만료/잠김 여부 확인

package org.zerock.club.security.dto;

import lombok.Data;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import lombok.extern.log4j.Log4j2;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.userdetails.User;

import java.util.Collection;

@Log4j2
@Getter
@Setter
@ToString
public class ClubAuthMemberDTO extends User {


    private String email;

    private String name;

    private boolean fromSocial;

    public ClubAuthMemberDTO(String username, String password, boolean fromSocial,
                             Collection<? extends GrantedAuthority> authorities) {
        super(username, password, authorities);
        this.email = username;
        this.fromSocial = fromSocial;
    }

}

 

super(...): 부모 클래스인 User 클래스의 사용자 정의 생성자를 호출

password는 부모 클래스를 사용하므로 멤버 변수로 선언하지 않음

ClubUserDetailsService

UserDetailsService 인터페이스를 구현하는 클래스

 

package org.zerock.club.security.service;

import lombok.RequiredArgsConstructor;
import lombok.extern.log4j.Log4j2;
import org.springframework.security.core.authority.SimpleGrantedAuthority;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.stereotype.Service;
import org.zerock.club.entity.ClubMember;
import org.zerock.club.repository.ClubMemberRepository;
import org.zerock.club.security.dto.ClubAuthMemberDTO;

import java.util.Optional;
import java.util.stream.Collectors;

@Log4j2
@Service
@RequiredArgsConstructor
public class ClubUserDetailsService  implements UserDetailsService {

    private final ClubMemberRepository clubMemberRepository;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {

        log.info("ClubUserDetailsService loadUserByUsername " + username);


        Optional<ClubMember> result = clubMemberRepository.findByEmail(username, false);

        if(result.isEmpty()){
            throw new UsernameNotFoundException("Check User Email or from Social ");
        }

        ClubMember clubMember = result.get();

        log.info("-----------------------------");
        log.info(clubMember);

        ClubAuthMemberDTO clubAuthMember = new ClubAuthMemberDTO(
                clubMember.getEmail(),
                clubMember.getPassword(),
                clubMember.isFromSocial(),
                clubMember.getRoleSet().stream()
                        .map(role -> new SimpleGrantedAuthority("ROLE_"+role.name()))
                        .collect(Collectors.toSet())
        );

        clubAuthMember.setName(clubMember.getName());
        clubAuthMember.setFromSocial(clubMember.isFromSocial());

        return clubAuthMember;
    }
}

- ClubMemberRepository를 주입받을 수 있는 구조로 변경 + @RequiredArgsConstructor 처리

- ClubMemberRepository의 findByEmail 메소드 호출

- ClubMember를 UserDetails타입으로 처리하기 위해 ClubAuthMemberDTO타입으로 변환

- ClubMemberRole을 SimpleGrantedAuthority로 변환 처리

 

5. Controller에서 사용자 정보 출력하기

SampleController

로그인된 사용자 정보 확인하는 방법

1) SecurityContextHolder 객체 사용

2) 직접 파라미터와 어노테이션 사용

SampleController 내의 exMember 메소드

AuthenticationPrincipal 어노테이션을 사용

@GetMapping("/member")
    public void exMember(@AuthenticationPrincipal ClubAuthMemberDTO clubAuthMember){

        log.info("exMember..........");

        log.info("-------------------------------");
        log.info(clubAuthMember);

    }