냉장고 가계부 프로젝트 36

member 프로젝트에서는 간단한 CRUD 기능만을 가지므로 Spring Data Rest를 사용해서 코드의 양을 줄일 수 있다. Spring Data Rest와 Spring HATEOAS, Spring Data JPA 를 사용한다.
pom.xml 에 Spring Data Rest 의존성을 추가한다.

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>

Spring Data Rest는 Repository인터페이스에 @RepositoryRestResource애너테이션을 추가하기만 하면 CRUD 관련 endpoint를 작성해준다. MemberRepository 인터페이스에 다음과 같이 애너테이션을 추가한다.

@RepositoryRestResource
public interface MemberRepository extends JpaRepository<Member, Long> {
    Optional<Member> findByUsername(String username);
}

Spring Data Rest는 {repository} GET,POST {repository}/{id} GET,PUT,PATCH,DELETE, {repository}/search GET 과 같은 CRUD endpoint를 작성해준다.
MemberRepository는 members, members/{id}, members/search 와 같다.
(더 상세한 내용은 Spring Data Rest Reference 를 참고.)

Spring Data Rest 관련 설정은 yaml 을 통해서도 가능하고, 별도의 Configuration 클래스를 작성할 수도 있다. Member 프로젝트같은 경우 회원의 식별키를 username으로 구분한다.
findByUsername 메서드를 추가한 이유도 id를 primary key로 가져가지만, username 필드가 NaturalId 역할을 하기 때문이다. 따라서, /members/{username} 과 같은 역할을 위해서 MemberRepositoryRestConfig 클래스를 작성한다.

@Configuration
public class MemberRepositoryRestConfig extends RepositoryRestConfigurerAdapter {

    @Override
    public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
        config
            .exposeIdsFor(Member.class)
            .withEntityLookup()
            .forRepository(MemberRepository.class, Member::getUsername, MemberRepository::findByUsername);
    }

}

config.exposeIdsFor(Member.class)는 응답본문에 id 필드가 노출되도록 설정한다. 기본값은 노출하지 않기 때문에 설정한다.
withEntityLookup().forRepository 메서드를 이용하면 @Id 애너테이션으로 선언한 식별키 대신 식별할 대상을 별도로 지정할 수 있다.
MemberRepository 클래스는 Member 클래스의 ID(long id) 필드가 식별키인데, 위의 코드에서처럼 Member::getUsername 을 식별 매핑으로 하고, 리퍼지토리에서는 findByUsername 메서드를 이용해서 식별하도록 설정한다.

Spring Data Rest 를 활용하면 기존의 MemberController 클래스와 기능이 겹치게 되므로 필요없다. MemberService, UsernameNotFoundException 클래스도 마찬가지로 사용할 곳이 없어진다.
파일을 정리하고 테스트클래스도 정리하고 테스트를 수행해서 문제가 없는지 확인한다.

member 프로젝트를 소비하는 web프로젝트에서는 코드를 몇군데만 수정하면 기능은 그대로 동작한다.
member 프로젝트와 통신하는 Feign클라이언트인 MemberClient 클래스에서 회원탈퇴 endpoint인 withdraw 메서드가 기존의 members/{id} 인것이 members/{username} 으로 변경된다.

@FeignClient(name="fridge-member")
@RequestMapping("/members")
public interface MemberClient {
    ...
    
    @DeleteMapping("/{username}")
    void withdraw(@PathVariable("username") String username);
    
}

MemberClient 를 사용하는 MemberController 클래스의 withdraw 메서드도 수정한다.

@Controller
@RequiredArgsConstructor
@Slf4j
public class MemberController {
    ...
    
    @PostMapping("/withdraw")
    public String withdrawProcessing(@AuthenticationPrincipal Member member, 
            @ModelAttribute @Valid MemberRequest memberRequest, Errors errors) {
        if(errors.hasErrors()) {
            return "members/withdraw";
        }
        if(!passwordEncoder.matches(memberRequest.getPassword(), member.getPassword())) {
            errors.rejectValue("password", "field.not_same.member.password");
            return "members/withdraw";
        }
        
        client.withdraw(member.getUsername());
        SecurityContextHolder.clearContext();
        return "members/withdrawDone";
    }
    
}

수정이 다 끝났으면 테스트를 실행해서 문제가 있는지 확인한다.

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