냉장고 가계부 프로젝트 33

Spring security 의 권한 구분과 계정잠금/만료 정책관련 필드 정보를 제공하기 위해 Member 서버를 수정한다.

CREATE TABLE member (
    id BIGINT GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1) PRIMARY KEY,
    username VARCHAR(256) NOT NULL,
    password VARCHAR(128) NOT NULL,
    account_non_expired BOOLEAN NOT NULL DEFAULT TRUE,
    account_non_locked BOOLEAN NOT NULL DEFAULT TRUE,
    credentials_non_expired BOOLEAN NOT NULL DEFAULT TRUE,
    enabled BOOLEAN NOT NULL DEFAULT TRUE
);

ALTER TABLE member ADD CONSTRAINT UK_member_username UNIQUE (username);

CREATE TABLE member_authorities (
    member_id BIGINT NOT NULL,
    authority VARCHAR(32) NOT NULL
);

member 테이블에는 account_non_expired, account_non_locked, credentials_non_expired, enabled 네 개의 Boolean 컬럼이 추가되고 Default 값은 true로 지정한다.

그리고 권한구분값을 저장할 member_authorities 테이블을 생성한다. member_authorities 테이블에는 member 테이블의 식별키 id값을 참조하는 member_id 컬럼과 문자열로 저장되는 권한구분 authority 컬럼으로 구성된다.

@Data
@NoArgsConstructor
@Entity
public class Member {
    @Id
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    private Long id;
    
    @NaturalId
    @Column(unique=true)
    private String username;
    private String password;
    private boolean accountNonExpired = true;
    private boolean accountNonLocked = true;
    private boolean credentialsNonExpired = true;
    private boolean enabled = true;
    
    @ElementCollection
    @Column(name="authority")
    private Set<String> authorities = new HashSet<>();

    public Member(String username, String password) {
        this(username, password, null);
    }
    
    public Member(String username, String password, Set<String> authorities) {
        this.username = username;
        this.password = password;
        if(authorities != null) {
            this.authorities.addAll(authorities);
        }
    }
    
}

Member 클래스에서는 accountNonExpired, accountNonLocked, credentialsNonExpired, enabled 네개의 boolean 멤버변수가 추가되고 변수 선언과 동시에 true를 할당한다.

권한구분값을 컬렉션형태로 관리하는 하이버네이트의 @ElementCollection을 선언한 authorities 멤버변수도 추가한다. authorities는 String 제네릭타입을 가지는 Set타입이며 선언과 동시에 java.util.HashSet 클래스 빈 생성자를 할당한다.

하이버네이트의 네이밍전략에 따라 authorities 멤버변수는 Collection으로 동작하며 테이블은 member_authorities 와 매핑된다. 저장은 Member 의 식별자(ID)의 member_id 컬럼에 member 식별자를 집어넣고, authorites 컬럼에 문자열 권한값을 넣게 된다. 하지만, 테이블을 생성할때 authority 컬럼으로 컬럼명을 정했으므로, @Column 애너테이션을 사용해서 authorities 컬럼명이 아니라 authority 컬럼이라고 지정한다.

이제 web 프로젝트에서 회원가입, 로그인 등을 할때 권한값과 계정상태를 가져올 수 있도록 수정한다.

public class Member implements UserDetails {
    private static final long serialVersionUID = 1L;
    private Long id;
    private String username;
    private String password;
    private boolean accountNonExpired;
    private boolean accountNonLocked;
    private boolean credentialsNonExpired;
    private boolean enabled;
    private Set<GrantedAuthority> authorities;
    
    @Builder
    public Member(Long id, String username, String password, boolean accountNonExpired, boolean accountNonLocked,
            boolean credentialsNonExpired, boolean enabled, Set<GrantedAuthority> authorities) {
        super();
        this.id = id;
        this.username = username;
        this.password = password;
        this.accountNonExpired = accountNonExpired;
        this.accountNonLocked = accountNonLocked;
        this.credentialsNonExpired = credentialsNonExpired;
        this.enabled = enabled;
        this.authorities = authorities;
    }

    public Long getId() {
        return id;
    }
    
    @Override
    public Collection<? extends GrantedAuthority> getAuthorities() {
        return authorities;
    }
    @Override
    public String getPassword() {
        return password;
    }
    @Override
    public String getUsername() {
        return username;
    }
    @Override
    public boolean isAccountNonExpired() {
        return accountNonExpired;
    }
    @Override
    public boolean isAccountNonLocked() {
        return accountNonLocked;
    }
    @Override
    public boolean isCredentialsNonExpired() {
        return credentialsNonExpired;
    }
    @Override
    public boolean isEnabled() {
        return enabled;
    }

}

Member 클래스를 API통신, Model 객체등 모든 구간에서 다 사용하는 것은 적절하지 못하므로 Member 클래스는 인증관련 부분에서만 사용하도록 수정한다.
lombok 라이브러리의 @Data 애너테이션은 더이상 불필요하므로 삭제한다.
추가되는 멤버변수는 Member 서버에서와 동일하게 계정잠금,만료 여부등을 나타내는 boolean 필드 4개와 권한구분을 위한 authorities 필드이다.
여기서 authorities 멤버변수의 타입이 GrantedAuthority 인터페이스를 제네릭 타입으로 하는 Set타입이다. Spring security 의 Authentication 객체에서 권한을 나타내는 타입으로 GrantedAuthority를 사용하기 때문이다.

기존의 isAccountNonExpired, isAccountNonLocked, isCredentialsNonExpired, isEnabled 게터 메서드들의 하드코딩 true값을 각각 멤버변수들을 지정한다.
getAuthorities 메서드 또한 authorities 멤버변수를 반환하도록 한다.

Member 서버의 API 통신 응답결과로 마샬링되는 Member 클래스 타입을 DTO 클래스를 생성해서 대신할 수 있도록 한다. 다음은 Member 클래스의 DTO 클래스이다.

@Data
public class MemberRequest {
    private Long id;
    @NotNull
    @Size(min=6, max=128)
    private String username;
    @NotNull
    @Size(max=72)
    private String password;
    private Set<String> authorities;
    private boolean accountNonExpired;
    private boolean accountNonLocked;
    private boolean credentialsNonExpired;
    private boolean enabled;

    public Member toMember() {
        return Member.builder()
                .id(id)
                .username(username)
                .password(password)
                .authorities(authorities.stream()
                        .map(role -> {
                            return new SimpleGrantedAuthority(role);
                        })
                        .collect(Collectors.toSet()))
                .accountNonExpired(accountNonExpired)
                .accountNonLocked(accountNonLocked)
                .credentialsNonExpired(credentialsNonExpired)
                .enabled(enabled)
                .build();
    }
    
    public void generateNewUser(PasswordEncoder passwordEncoder) {
        setAuthorities(AuthorityUtils.authorityListToSet(AuthorityUtils.createAuthorityList("ROLE_USER")));
        setPassword(passwordEncoder.encode(getPassword()));
        setAccountNonExpired(true);
        setAccountNonLocked(true);
        setCredentialsNonExpired(true);
        setEnabled(true);
    }
    
}

MemberRequest클래스는 Member 클래스의 DTO이므로 멤버변수들이 동일하고 컨트롤러와 뷰 사이의 폼데이터를 전달하는 역할을 수행하므로 JSR Bean Validation 애너테이션을 선언하고있다. toMember 메서드는 MemberRequest 클래스를 Member 클래스로 변환하는 기능을 한다.
generateNewUser 메서드는 회원가입 프로세스에서 전달받은 폼데이터를 기반으로 새로운 회원가입을 위한 디폴트 데이터를 작성해준다. 신규회원은 ROLE_USER 권한을 부여하고, 비밀번호는 BCrypr로 암호화한다. 4개의 계정상태값은 모두 true로 설정한다.

Member 서버의 API통신을 하는 MemberRestService 클래스를 수정한다.

@Service
@RequiredArgsConstructor
@Slf4j
public class MemberRestService {
    private final RestTemplate memberRestTemplate;
    
    public Member loadByUsername(String username) {
        try {
            ResponseEntity<MemberRequest> response = memberRestTemplate.getForEntity("/members/{username}", MemberRequest.class, username);
            if(response.getStatusCode() == HttpStatus.OK) {
                return response.getBody().toMember();
            }
        } catch(HttpClientErrorException ex) {
            log.error("Response error: {} {}", ex.getStatusCode(), ex.getStatusText());
        }
        return null;
    }
    
    public Member register(MemberRequest memberRequest) {
        ResponseEntity<MemberRequest> response = memberRestTemplate.postForEntity("/members", memberRequest, MemberRequest.class);
        if(response.getStatusCode() == HttpStatus.CREATED) {
            return response.getBody().toMember();
        }
        return null;
    }

}

loadByUsername 메서드는 원래 응답본문에 Member클래스로 파싱되었는데, 응답본문의 타입을 MemberRequest 클래스 타입으로 수정한다. JSON을 MemberRequest 객체로 파싱한 후 toMember 메서드를 이용해서 리턴한다.

register 메서드는 메서드 파라미터로 Member 타입을 MemberRequest 타입으로 변경하고 request Body에 MemberRequest 클래스를 전달하고, 응답본문으로 MemberRequest 타입으로 파싱한다.

MemberRestService 클래스를 사용하는 MemberController 클래스도 수정한다.

@Controller
@RequiredArgsConstructor
public class MemberController {
    private final MemberRestService service;
    private final PasswordEncoder passwordEncoder;
    
    @GetMapping("/signup")
    public String signupForm(MemberRequest memberRequest, Model model) {
        model.addAttribute("memberRequest", memberRequest);
        return "members/signup";
    }
    
    @PostMapping("/signup")
    public String signupProcessing(@ModelAttribute @Valid MemberRequest memberRequest, Errors errors) {
        if(errors.hasErrors()) {
            return "members/signup";
        }
        Member existsMember = service.loadByUsername(memberRequest.getUsername());
        if(existsMember != null) {
            errors.rejectValue("username", "field.exists.member.username");
            return "members/signup";
        }
        
        memberRequest.generateNewUser(passwordEncoder);
        service.register(memberRequest);
        return "redirect:/signin";
    }
    
    @GetMapping("/signin")
    public String signinForm() {
        return "members/signin";
    }
    
}

MemberController 클래스의 signupForm, signupProcessing 메서드가 Member 클래스를 바인딩했지만, MemberRequest 클래스로 변경해서 Controller 와 View 사이의 폼데이터 바인딩역할을 수행한다. 특별히 확인할 부분은 memberRestService 클래스의 register 메서드를 수행하기 전에 memberRequest의 generateNewUser 메서드를 호출해서 폼데이터로 전달받은 객체의 데이터에 신규회원가입을 위한 데이터를 준비한다는 부분이다.

이제 테스트를 수행해서 문제가 없는지 확인한다.

이전글: 냉장고 가계부 프로젝트 32
다음글: 냉장고 가계부 프로젝트 34