[🦁] Spring MVC 미션

4주차 Spring MVC 미션

초록스터디를 진행하면서 Spring MVC에 대해서 학습해보았다.
Spring을 처음 사용하다보니 여러 문제를 겪었다.
학습 테스트를 보고 왜 그런지 이해못하고 넘어간 부분이 더 많은 것 같다. (지금도...)
미션을 진행하면서 의문을 가졌던 부분과 배운 부분위주로 정리 했다.

https://github.com/day024/spring-roomescape-playground/tree/day024

🚀 Gradle을 이용하여 프로젝트를 빌드하고 실행하기

미션에 들어가기 앞서 스프링을 처음 써보기 때문에 기본 세팅부터 진행 해보았다.
어떤 문제인지 스프링이 인식이 안되는 오류가 계속 발생하였다.

https://velog.io/@coastby/Spring 이글을 통해서 겨우 해결하였다.
처음에는 Gradle버전이 안맞는다는 오류가 계속발생해서 Build,Execution,Deployment>gradle JVM 설정을 계속 변경하면서 버전을 바꿔보았다.

그런데 이젠 Cannot resolve symbol 'springframework 라는 문구가 계속 떴고 블로그를 통해서 해결했다.
어째서인지 다른 방법으로는 여전히 똑같은 오류를 반복했다. 동일하게 Gradle을 refresh 해주는 방법이 성공했다.

🚀 1단계 - 홈 화면

요구사항:
홈 화면조회 / 의존성 추가

웹관련 의존성을 추가했다.

    implementation 'org.springframework.boot:spring-boot-starter-web'

• Spring Boot 애플리케이션에 웹 기능을 추가하기 위한 의존성
• Spring MVC를 사용할 수 있도록 한다.

    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'

• Spring Boot 애플리케이션에 Thymeleaf 템플릿 엔진을 추가하기 위한 의존성
• Thymeleaf는 HTML 기반의 템플릿 엔진으로, 서버 사이드에서 HTML을 생성하고 렌더링하는 데 사용한다.

@Controller와 @GetMapping을 통해서 진행했다.

package roomescape.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HomeController {

    @GetMapping("/")
    public String home() {
        return "home";
    }
}

Annotation

어노테이션을 통해서 스프링에서 다양한 기능을 수행한다.

1. @Controller

• 해당 클레스가 "Controller"임을 나타낸다.
• @Controller 어노테이션이 지정된 클래스를 bean으로 등록된다. 해당 클래스가 Controller로 사용됨을 Spring Framework에 알린다.

2. @RequestMapping

• 특정 url부터 들어온 요청을 컨트롤러 메서드에 매핑 한다.
• @GetMapping, @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping

3. @GetMapping

• HTTP Request 메소드 값을 매핑하기 위한 Annotation
• @PathVariable 어노테이션을 통해서 경로를 지정하기도 한다. , @PathVariable 를 다중사용도 가능하다.

---

🚀 2단계 - 예약 조회

요구사항:
예약 조회 API구현
예약 페이지 요청과 예약 목록 조회 요청을 처리하는 메서드를 구현하세요.

• reservation를 조회하는 것은 1단계 homeController와 같게 진행하였다.
• 데이터 베이스가 없어 리스트로 진행하였다. 또한 아직 입력이 구현되지 않아 테스트 통과를 위한 임의 예시 데이터를 추가했다.

ResponseEntity.status(HttpStatus.OK).body(reservationList);

• ResponseEntity를 생성 하고 응답의 상태를 HttpStatus.OK, 상태코드 200으로 설정한다. 요청이 성공적으로 실행 되었다는 의미.
• body(reservationList) 예약 내용이 담긴 리스트를 응답 본문으로 전달

@Controller
public class ReservationController {
    private List<Reservation> reservations = new ArrayList<>();
	//예약 뷰 렌더링 
    @GetMapping("/reservation")
    public String reservation() {
        return "reservation";
    }
	//예약 정보를 조회
    @GetMapping("/reservations")
    public ResponseEntity<List<Reservation>> getReservations() {

        List<Reservation> reservationList = new ArrayList<>();
        reservationList.add(new Reservation(1, "브라운", "2023-01-01", "10:00"));
        reservationList.add(new Reservation(2, "브라운", "2023-01-02", "11:00"));

        return ResponseEntity.status(HttpStatus.OK).body(reservationList);
    }

Reservation class를 생성했다. 예약 정보를 저장하기 위한 id, name, date, time을 가지고 있는 class이다.

package roomescape.domain;

import java.time.LocalDateTime;

public class Reservation {
    private int id;
    private String name;
    private String date;
    private String time;

    public Reservation(int id, String name, String date, String time) {
        this.id = id;
        this.name = name;
        this.date = date;
        this.time = time;
    }

    public int getId() {
        return id;
    }

    public String getDate() {
        return date;
    }

    public String getName() {
        return name;
    }

    public String getTime() {
        return time;
    }
}

---

🚀 3단계 - 예약 추가 / 취소

요구사항 :
API 명세를 따라 예약 추가 API 와 삭제 API를 구현

예약 추가 API

id를 만들고, 새 예약 객체를 생성한다.
예약을 저장하고 ResponseEntity를 반환한다.

private final AtomicLong index = new AtomicLong(0); //예약을 위한 ID

@PostMapping("/reservations")
    public ResponseEntity<Reservation> addReservation(@RequestBody Reservation request) {
        long id = index.incrementAndGet();
        Reservation reservation = new Reservation(id, request.getName(), request.getDate(), request.getTime());
        reservations.add(reservation);

        URI location = URI.create("/reservations/" + id);

        return ResponseEntity.created(location).body(reservation);
    }

힌트

...
public class ReservationController {

    private AtomicLong index = new AtomicLong(1);
    ...
    
    // AtomicLong 활용 예시
    reservations.add(new Reservation(index.incrementAndGet(), "브라운", "2023-01-01", "10:00"));
    
   ...

예약 정보의 식별자를 생성할 때 AtomicLong를 활용할 수 있다는 힌트를 받았다.

AtomicLong

• 멀티스레드 환경에서 안전하게 long 변수를 증가, 감소 시킴
• 동시성을 보장해준다.
• 주요 메서드 : incrementAndGet(), decrementAndGet(), getAndIncrement(), getAndDecrement()

long id = index.incrementAndGet();

id 증감을 위해서 incrementAndGet를 사용했다. 메서드는 AtomicLong의 값을 1 증가시키고, 증가된 값을 반환합니다. 따라서 index 변수의 값을 1씩 증가시키면서 그 값을 id 변수에 할당한다.

처음엔 id를 그냥 int로 선언하였는데 AtomicLong에 대해서 학습을 하니 long으로 선언해야한다는 것을 깨달아 후에 수정했다.

reservations.add(reservation);

jvaa Collection에서 리스트에 정보추가가 가능하다.
ArrayList의 add()를 사용하면 된다. 삭제도 마찬가지이다.

예약 삭제 API

@DeleteMapping("/reservations/{id}")
    public ResponseEntity<Void> cancelReservation(@PathVariable long id) {
        Reservation reservation = reservations.stream()
                .filter(it -> Objects.equals(it.getId(), id))
                .findFirst()
                .orElseThrow(IllegalArgumentException::new);

        reservations.remove(reservation);

        return ResponseEntity.noContent().build(); // 성공(204) 상태 코드 반환
    }

 reservations.remove(reservation);

ArrayList의 remove()를 통해서 바로 삭제가 가능하다.

ResponseEntity.noContent().build(); 

성공적으로 예약이 삭제 되면 204 코드를 반환한다. 삭제 처리가 정상적으로 되었으니 응답하는 본문은 없다.

---

🚀 4단계 - 예외 처리

요구 사항

• 예약 관련 API 호출 시 에러가 발생하는 경우 중 요청의 문제인 경우 Status Code를 400으로 응답
  • 예약 추가 시 필요한 인자값이 비어있는 경우InvalidRequest
  • 삭제 할 예약의 식별자로 저장된 예약을 찾을 수 없는 경우notfound

힌트

@ExceptionHandler(NotFoundReservationException.class)
public ResponseEntity handleException(NotFoundReservationException e) {
    return ResponseEntity.badRequest().build();
}

힌트로 주어진 @ExceptionHandler를 사용해서 예외처리를 진행하였다.

package roomescape;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import roomescape.exception.InvalidRequestException;

@ControllerAdvice
public class ReservationExceptionHandler {
    @ExceptionHandler(InvalidRequestException.class)
    public ResponseEntity handleInvalidRequestException(InvalidRequestException e) {
        return ResponseEntity.badRequest().build();
    }

}

package roomescape.exception;

public class InvalidRequestException extends RuntimeException {
    public InvalidRequestException(String message) {
        super(message);
    }
}

package roomescape.exception;

public class NotFoundReservationException extends ReservationException {
    public NotFoundReservationException(String message) {
        super(message);
    }
}

@ExceptionHandler , @ControllerAdvice

1. @ExceptionHandler

• @ExceptionHandler는 예외처리를 위한 어노테이션이다.
• @ControllerAdvice와 함께 사용하여 애플리케이션의 모든 컨트롤러에서 발생하는 예외를 전역적으로 처리한다.

2. @ControllerAdvice
   -각 컨트롤러에 개별적으로 예외 처리를 추가할 필요 없이 중앙에서 예외를 처리할 수 있다.

    private final String INVALID_NAME_REQUEST_MESSAGE = "이름 정보가 공백입니다.";
    private final String INVALID_DATE_REQUEST_MESSAGE = "날짜 정보가 공백입니다.";
    private final String INVALID_TIME_REQUEST_MESSAGE = "시간 정보가 공백입니다.";

리뷰를 받은 이후 각 예외 문구들은 상수처리를 진행해주었다.
별도로 class를 생성한 후 사용해도 좋을 것 같다.
문구들을 상수처리를 하면 코드 중복이 줄어들고, 일관성을 가질 수 있다는 장점이 있다.

---

roomescape
ㄴcontroller
  ㄴ homeController
  ㄴ reservationController
ㄴdomain 
  ㄴ Reservation
ㄴexception
  ㄴInvalidRequestException
  ㄴNotFoundReservationException
  ㄴReservationException
  ㄴReservationExceptionHandler

우선 기능만으로도 낯설어 구조에 대한 큰 고민없이 위와 같이 진행하였다. DTO 구조를 다들 활용하길래 찾아보게 되었다.
Repository, Controller, Service, DTO에 대해서 생각해보고는 있지만 아직 이해 하지 못했다...
그래서 Spring 구조에 대해서 좀 더 고민해보고 service와 Repository를 활용해서 다음 미션에 적용해보고싶다.

+) 미션을 진행하면서 pr을 보냈더니 x표시가 떠서 우선은 놔두었었다.
알고보니 아주 기본적인 걸 잊고있었다.

pr보내는 branch를 base:main으로 설정해두었기 때문에 merge할 수 없는 문제였다. base:day024로 변경했다.

이제 충돌이 없는 상태로 바뀌었다!

---

미션에 참고한 자료들

[Spring] Cannot resolve symbol'springframework'

Long 과 AtomicLong은 어떤 차이가 있을까?
[JAVA] Atomic 변수와 동시성 제어 (AtomicInteger, AtomicLong, AtomicBoolean, AtomicReference)
[Spring] 요청 방식(@RequestMapping, @GetMapping, @PostMapping)
Spring Controller 어노테이션과 파라미터 타입
[스프링부트] @ExceptionHandler를 통한 예외처리

[Spring] DTO를 사용하는이유
[Spring] 스프링 패키지 구조, DAO, DTO, Entity, Repository 에 대하여, DTO를 사용하는 이유
[SpringMVC] SpringMVC 구조