[Spring] Spring Security 인증 절차 Interface | UserDetails와 UserDetailsService

 

🚀 UserDetails & UserDetailsService란?

    🔽  개요

UserDetailsService Interface는 Data Base에서 User 정보를 가져오는 역할을 하는 것이에요.

해당 Interface의 Method에서 Data Base User 정보를 가져와서 AuthenticationProvider Interface로 User 정보를 반환하면 그 곳에서 이용자가 입력한 정보와 DB에 있는 회원 정보를 비교하게 되는 것이에요. DB에서 회원 정보를 가져오는 작업에 필요한 Interface는 UserDetails와 UserDetilasService Interface인 것이에요.

 

 

 

    🔽  UserDetails

Spring Security에서 이용자의 정보를 담는 Interface는 UserDetails Interface인 것이에요. 이 Interface를 구현하게 되면 Spring Security에서 구현한 Class를 통해 이용자 정보를 인식하고, 인증 작업을 할 수 있는 것이에요.

UserDetails Interface는 VO(Value Object)의 역할을 한다고 보면 되고, 이를 통해 이용자 정보를 모두 담아두는 객체로 구현할 수 있는 것이에요.

UserDetails Interface를 구현하게 되면 Override 되는 Method들이 있는 것이에요. 이 Method들을 먼저 파악하는 게 아무래도 좋을 거 같아요.

또한, 회원 정보에 관한 다른 정보(이름, 나이, 생년월일 등등..)도 추가할 수 있는 것이에요.

Override된 Method들만 Spring Security에서 알아서 이용하기 때문에 따로 Class를 만들지 않고, Member 변수를 추가해서 같이 사용해도 좋은 것이에요.

그리고, MyBatis를 이용하게 된다면 여기에 Member 변수들에 맞는 getter, setter를 만들어 주면 되는 것이에요.

 

Method	Return Type	Detail
getAuthorities()	Collections<? extends GrantedAuthority>	이용자 계정이 갖고 있는 권한 목록 반환
getPassword()	String	이용자 계정의 비밀번호 반환
getUsername()	String	이용자 계정의 이름(ID)를 반환
isAccountNonExpired()	boolean	이용자 계정 만료 여부 반환 true : 만료 되지 않음 false : 만료
isAccountNonLocked()	boolean	이용자 계정 잠금 여부 반환 true : 잠기지 않음 false : 잠김
isCredentialNonExpired()	boolean	비밀번호 만료 여부 반환 true : 만료 되지 않음 false : 만료
isEnable()	boolean	계정 활성화(사용 가능) 여부 반환 true : 활성화 (이용 가능) false : 비 활성화  (이용 불가)

`getUsername()`은 계정의 이름(ID)를 반환하는데, 그 말인 즉, 우리가 Login 할 때 이용하는 ID 혹은 E-mail을 반환하는 것이에요. 그리고, 계정이 만료 되었는지 혹은 계정이 잠겨 있는지 등에 대해 확인할 필요가 없다면 무조건 true를 반환하게 해 주면 되는 것이에요. 만약 확인할 Member 변수가 있다면 그 Member 변수를 반환해 주면 되는 것이에요.

아래 예시는 계정의 활성 / 비활성화를 확인하는 Member 변수가 존재하고, 이 때문에 `isEnable()`은 해당 Member 변수를 반환 해 주게 한 것이에요.

 

예시 코드

@SuppressWarnings("serial")
public class CustomUserDetails implements UserDetails {
    
    private String id;
    private String password;
    private String authority;
    private boolean enabled;
    private String name;
    
    @Override
    public Collection<? extends GrantedAuthority> getAuthorities() {
        ArrayList<GrantedAuthority> auth = new ArrayList<GrantedAuthority>();
        auth.add(new SimpleGrantedAuthority(AUTHORITY));
        return auth;
    } // getAuthorities() 끝
 
    @Override
    public String getPassword() {
        return password;
    }
 
    @Override
    public String getUsername() {
        return id;
    }
 
    @Override
    public boolean isAccountNonExpired() {
        return true;
    }
 
    @Override
    public boolean isAccountNonLocked() {
        return true;
    }
 
    @Override
    public boolean isCredentialsNonExpired() {
        return true;
    }
 
    @Override
    public boolean isEnabled() {
        return enabled;
    }
    
    public String getNAME() {
        return NAME;
    }
 
    public void setNAME(String name) {
        this.name = name;
    }
 
} // class 끝

 

CustomUserDetails - Member 변수

 

위의 그림과 같이 이용자 정보들의 Member 변수를 선언해 줄 수 있는 것이에요. 더 많은 정보가 필요하다면 추가를 해도 됩니다.

 

CustomUserDetails - getAuthorities()

반응형

 

위 그림의 Method는 계정이 갖고 있는 권한 목록을 반환하는 친구인 것이에요.

위의 `SimpleGrantedAutority()`는 `GrantedAuthority`를 Implement한 Class인데, `basic concrete implementations of a GrantedAuthority stores a String representation of an authority granted to the authentication object` 권한을 `String`으로 반환해 주는 친구인 것이에요.

결국 권한 목록을 문자열로 얻기 위해 위의 Method를 이용하는 것이에요.

 

 

CustomUserDetails - isEnabled()

이용자 계정에 활성 / 비활성화 여부를 관리하기 위해 Member 변수로 선언한 `enabled`를 반환하는 것이에요.

 

 

 

 

 

 

    🔽  UserDetailsService

        📦 DevInquryReplyVO.java

이용자 정보를 담은 객체를 `UserDetails`를 구현해서 만들었다면 Data Base에서 이용자 정보를 직접 가져오는 Interface 또한 구현 해 주어야 하는 것이에요.

`UserDetailsService` Interface는 JPA나, MyBatis를 구현한 Class 등을 통해 Data Base에서 이용자 정보를 불러오는 아주 중요한 역할을 하는 친구가 존재하는데, 그 친구가 바로 `loadUserByUsername()`인 것이에요. 이 친구는 이용자 정보를 불러오는 작업을 하면 되는 것이에요.

`UserDetailsService` Interface를 구현하면 `loadUserByUsername()`를 Override해서 이용해야 하는 것이에요. 여기에서 CustomUserDetails 형으로 이용자의 정보를 가져오면 되는 것이에요. 가져온 이용자 정보가 있다? 없다?에 따라 예외와 이용자 정보를 반환해주면 되는 것이에요.

 

예시 코드

public class CustomUserDetailsService implements UserDetailsService {
    
    @Autowired
    private UserAuthDAO userAuthDAO;
 
    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        CustomUserDetails user = userAuthDAO.getUserById(username);
        if(user==null) {
            throw new UsernameNotFoundException(username);
        }
        return user;
    } // loadUserByUsername(String username) 끝
} // class 끝

 

위의 Code에서 `loadUserByUsername()` Body를 보면 DAO의 `getUserById()`를 호출하는데, 매개변수로 들어온 username(이용자 ID)를 넣어주어 DB에서 검색을 한 뒤 그 결과를 위에서 `UserDatils`를 구현한 구현체 `CustomUserDetails` 객체 자료형 user 변수로 받아 주는 것이에요.

만약 user 정보를 못 찾았다면 Login을 할 수 없는 것이고, 그렇다면 `UsernameNotFoundException()`이 터지도록 되어있고, 존재한다면 회원 정보를 반환 해 주면 되는 것이에요.

 

 

 

참고 Site : https://writerroom.tistory.com/211