냉장고 가계부 프로젝트 31

fridge-web에서 fridge 개인화 영역을 아직 구현하지 못했다. 개인화 데이터의 관리는 별도의 도메인으로 관리하기 위해서 fridge-member 프로젝트를 생성한다.

fridge-member 의존성 라이브러리는 다음과 같다.

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-hateoas</artifactId>
  </dependency>
  <dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-java8</artifactId>
  </dependency>
  <dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jsr310</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
  </dependency>
  
  <!-- Spring Cloud -->
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
  </dependency>

  <dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
  </dependency>
  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
  </dependency>
</dependencies>

Eureka Client로 선언하기 위해 Application.class 파일에 @EnableDiscoveryClient 애너테이션을 선언한다.

@SpringBootApplication
@EnableDiscoveryClient
public class FridgeMemberApplication {

 public static void main(String[] args) {
  SpringApplication.run(FridgeMemberApplication.class, args);
 }
 
}

회원 도메인 엔티티를 작성한다.

@Data
@NoArgsConstructor
@Entity
public class Member {
    @Id
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    private Long id;
    
    @NaturalId
    @Column(unique=true)
    private String username;
    private String password;

    public Member(String username, String password) {
        this.username = username;
        this.password = password;
    }
    
}

대부분은 비슷한 엔티티 설정이지만, 새롭게 @NaturalId 애너테이션이 존재한다. Natural Id 란 도메인 모델의 유니크한 식별자로 현실에서 사용하는 식별자를 표현한다.
도메인 모델에서 식별키로써 사용하기에는 적합하지 않지만, 해당 유니크키는 충분히 유효한 의미를 지니고 있는 컬럼을 유니크 키로써 사용할 수 있도록 @NaturalId 애너테이션을 선언하면 하이버네이트에서
별도의 NaturalId API를 활용할 수 있다. username은 회원아이디를 표현하고, 중복되는 아이디가 존재할 수 없으므로 유니크하다. 따라서 NaturalId를 선언한다.

회원 데이터를 저장할 데이터베이스 생성 스키마 파일을 resources 폴더에 작성한다.

CREATE TABLE member (
    id BIGINT GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1) PRIMARY KEY,
    username VARCHAR(128) NOT NULL,
    password VARCHAR(512) NOT NULL
);

ALTER TABLE member ADD CONSTRAINT UK_member_username UNIQUE (username);

member 테이블은 BIGINT id 컬럼이 Primary key이고, username은 아이디, password는 비밀번호를 표현한다.
member 테이블의 username 컬럼은 Unique 인덱스를 추가해서 중복되는 아이디가 저장되지 않도록 한다.
application.yml 파일을 작성한다.

spring:
  application:
    name: fridge-member
  jpa:
    hibernate:
      ddl-auto: validate
    show-sql: true
    properties:
      hibernate.format_sql: true
  jackson:
    serialization:
      WRITE_DATES_AS_TIMESTAMPS: false
  h2:
    console:
      enabled: true
server:
  port: 8082
logging:
  level:
    org:
      hibernate:
        type: trace

애플리케이션의 이름은 fridge-member 로 정하고, port 는 8082로 한다. h2-console 을 사용가능하도록 하는 설정이 새롭게 추가되었다.
나머지 설정은 fridge, fridge-web 프로젝트에서 사용하던 그대로이므로 별도의 설명은 생략한다.
회원 데이터 영속성 관리를 위한 JPA Repository 인터페이스를 작성한다.

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

Optional 타입을 반환하는 findByUsername메서드는 username 문자열을 파라미터로 전달받아서 member 테이블에서 일치하는 username 로우를 반환한다.
Restful API를 작성하기 위해 Hateoas의 Resource API를 작성한다. ResourceAssembler 인터페이스를 구현하는 MemberResourceAssembler 클래스를 작성한다.

@Component
public class MemberResourceAssembler implements ResourceAssembler<Member, Resource<Member>> {

    @Override
    public Resource<Member> toResource(Member member) {
        return new Resource<>(member, 
                linkTo(methodOn(MemberController.class).findByUsername(member.getUsername())).withSelfRel());
    }

}

다음은 MemberController 클래스를 작성한다.

@RestController
@RequestMapping("/members")
@RequiredArgsConstructor
public class MemberController {
    private final MemberRepository repository;
    private final MemberResourceAssembler assembler;
    
    @GetMapping("/{username}")
    Resource<Member> findByUsername(@PathVariable String username) {
        Member member = repository.findByUsername(username)
                .orElseThrow(() -> new UsernameNotFoundException(username));
        return assembler.toResource(member);
    }
    
    @ExceptionHandler(UsernameNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    String usernameNotFoundHandler(UsernameNotFoundException ex) {
        return ex.getMessage();
    }
    
}

findByUsername 메서드가 호출될 경우 repository 에서 findByUsername 메서드를 호출하고 Optional에서 null이 반환될 경우 예외를 던진다.
예외는 UsernameNotFoundException 클래스로 생성자에 username 문자열을 전달한다.
UsernameNotFoundException 클래스는 RuntimeException 을 상속해서 unchecked exception으로 구현한다.

public class UsernameNotFoundException extends RuntimeException {
    private static final long serialVersionUID = 1L;

    public UsernameNotFoundException(String username) {
        super("could not found username by " + username);
    }

}

문자열 username을 파라미터로 전달받는 생성자는 부모생성자로 예외 메시지를 전달한다.

테스트를 실행해서 지금까지 작성한 코드가 문제없는지 확인한다.

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