냉장고 가계부 프로젝트 22

fridge 프로젝트의 FoodService 인터페이스의 구현클래스 JpaFoodService 의 클래스명을 일관된 네이밍을 위해서 FoodServiceImpl 클래스로 변경한다.

Fridge는 냉장고를 의미하는데 아직 개인화(Personalization) 서비스는 지원하지 않고있다. 아직은 개발단계이므로 Security를 적용하면 개발 편의성이 떨어지므로 우선은 개인화 관련 컬럼을 추가해서 작업을 진행하고 추후에 security 모듈을 적용하도록 한다.

개인화 서비스는 Fridge 단계에서 식별가능한 참조컬럼만 있으면 된다. Food는 Fridge의 자식 관계를 가지므로 Fridge 모델이 개인화되면 자연스럽게 Food도 개인화영역에 들어온다.
Fridge 의 개인화는 1:1 관계를 맺는다. 즉, User 한명당 하나의 Fridge 만을 가지도록 제약한다.

(이제부터는 설계된 코드만 기록한다.)
Fridge 클래스에 long userId 필드와 접근자/수정자를 추가한다. userId 필드는 사용자 개인을 식별할 수 있는 회원번호와 동일한 개념의 데이터를 표현한다.

@Entity(name="fridge")
public class Fridge {
    ... 
    private Long userId;
    
    // Get/Set/Constructor
    
    public Long getUserId() {
        return userId;
    }
    
    public void setUserId(Long userId) {
        this.userId = userId;
    }

    @Override
    public String toString() {
        return "Fridge [id=" + id + ", nickname=" + nickname + ", userId=" + userId + "]";
    }

}

Fridge 테이블 생성 쿼리도 변경한다. schema.sql 파일을 열어서 Fridge 테이블에 user_id 컬럼을 추가한다.

CREATE TABLE fridge (
    id INTEGER GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1) PRIMARY KEY,
    nickname VARCHAR(45) NOT NULL,
    user_id BIGINT
);

Fridge 데이터를 데이터베이스에서 불러올 때, 개인 식별키를 이용할 수 있도록 JpaFridgeRepository 인터페이스에 다음 메서드를 추가한다.

@Repository
public interface JpaFridgeRepository extends JpaRepository<Fridge, Integer> {
    Fridge findByUserId(Long userId);

}

스프링DATA JPA 에서 Query Creation 기능을 이용해서 일정한 패턴의 메서드명으로 표현하면 쿼리가 완성된다. 위의 메서드는 user_id 컬럼이 쿼리 조건절에 추가된다.

FridgeService 인터페이스에서 create 메서드는 새로운 Fridge를 생성하는 로직이 담겨있다. 해당 메서드에 userId 파라미터를 추가하고, 구현 클래스(FridgeServiceImpl) 도 수정한다.

@Transactional
public interface FridgeService {
    Fridge create(String nickname, long userId);

    Fridge save(Fridge fridge);

    void remove(int id);

    void removeAll();
}

@Service
public class FridgeServiceImpl implements FridgeService {
    
    @Autowired
    JpaFridgeRepository jpaFridgeRepository;
    
    @Override
    public Fridge create(String nickname, long userId) {
        Fridge fridge = new Fridge(nickname);
        fridge.setUserId(userId);
        return jpaFridgeRepository.save(fridge);
    }

    ...

}

FridgeService를 이용해서 Fridge 객체를 생성하는 부분은 FridgeController에 있다. 해당 코드도 수정한다.

@RestController
@RequestMapping("/fridges")
public class FridgeController {
    ...

    @PostMapping
    public ResponseEntity<FridgeResource> create(@RequestBody final FridgeRequest fridgeRequest) {
        Fridge fridge = fridgeService.create(fridgeRequest.getNickname(), fridgeRequest.getUserId());
        URI location = MvcUriComponentsBuilder.fromController(getClass())
                .path("/{id}")    
                .buildAndExpand(fridge.getId())
                .toUri();
        return ResponseEntity.created(location).body(assembler.toResource(fridge));
    }
    
    ...
    
    @PutMapping("/{id}")
    public ResponseEntity<?> updateFridge(@PathVariable final int id, @RequestBody final FridgeRequest fridgeRequest) {
        if(jpaFridgeRepository.findOne(id) != null) {
            fridgeService.save(fridgeRequest.toFridge());
        }
        return ResponseEntity.noContent().build();
    }
    
    ...

}

create 메서드는 요청바디에 Fridge 객체를 받는데, 이 부분은 Food와 마찬가지로 JsonIgnore 애너테이션으로 인한 foods 컬렉션을 파싱하지 못하는 문제가 있기때문에 요청 파라미터를 전담할 DTO객체 FridgeRequest 를 만들어서 사용한다.
변경된 fridgeService의 create 메서드에 nickname, userId 파라미터를 전달한다.
updateFridge 메서드도 요청파라미터에 Fridge 객체를 FridgeRequest 객체로 변경하고 toFridge 메서드를 이용해서 저장한다.
다음은 FridgeRequest 클래스이다.

public class FridgeRequest {
    private Integer id;
    private String nickname;
    private List<Food> foods;
    private Long userId;
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getNickname() {
        return nickname;
    }
    public void setNickname(String nickname) {
        this.nickname = nickname;
    }
    public List<Food> getFoods() {
        return foods;
    }
    public void setFoods(List<Food> foods) {
        this.foods = foods;
    }
    public Long getUserId() {
        return userId;
    }
    public void setUserId(Long userId) {
        this.userId = userId;
    }
    public Fridge toFridge() {
        Fridge fridge = new Fridge(getNickname(), getFoods());
        fridge.setId(getId());
        fridge.setUserId(getUserId());
        return fridge;
    }
    @Override
    public String toString() {
        return "FridgeRequest [id=" + id + ", nickname=" + nickname + ", foods=" + foods + ", userId=" + userId + "]";
    }
}

Fridge 클래스와 동일한 필드에 접근자/수정자가 달려있고 toFridge 유틸리티 메서드와 toString 메서드를 오버라이드했다.

FridgeResource 클래스와 FridgeResourceAssembler 클래스에도 userId 필드를 추가한다.

public class FridgeResource extends ResourceSupport {
    @JsonProperty
    Integer id;
    @JsonProperty
    String nickname;
    @JsonProperty
    List foods;
    @JsonProperty
    Long userId;
}

public class FridgeResourceAssembler extends ResourceAssemblerSupport<Fridge, FridgeResource> {

    public FridgeResourceAssembler() {
        super(FridgeController.class, FridgeResource.class);
    }

    @Override
    public FridgeResource toResource(Fridge fridge) {
        FridgeResource resource = new FridgeResource();
        resource.id = fridge.getId();
        resource.nickname = fridge.getNickname();
        resource.foods = fridge.getFoods();
        resource.userId = fridge.getUserId();
        resource.add(linkTo(FridgeController.class).slash(resource.id).withSelfRel());
        return resource;
    }

}

FridgeController 에서 userId를 요청 파라미터로 전달해서 나의 냉장고 데이터를 응답하는 컨트롤러 메서드를 작성한다.

    @GetMapping("/me/{userId}")
    public ResponseEntity<FridgeResource> loadMyFridge(@PathVariable final long userId) {
        Fridge fridge = jpaFridgeRepository.findByUserId(userId);
        if(fridge == null) {
            return ResponseEntity.noContent().build();
        }
        return ResponseEntity.ok(assembler.toResource(fridge));
    }

URL /fridges/me/{userId} 를 Get방식으로 호출하면 loadMyFridge 메서드가 매핑되며, URI 변수로 전달된 userId 값을 repository의 findByUserId 메서드에 파라미터로 전달한다. 리턴값이 null이면 noContent 상태값을 응답으로 리턴하고, 아니라면 OK 상태코드와 함께 fridge 객체를 리턴한다.

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