Tech Log 🛠️

@RequestParam 에서 @ModelAttribute를 사용하기 까지의 변화를 알아보자

1.@RequestParam 을 통해 파라미터 직접 받기

@PostMapping("/add")
public String addItemV1(@RequestParam String itemName,
                        @RequestParam int price,
                        @RequestParam Integer quantity,
                        Model model) {
    Item item = new Item();
    item.setItemName(itemName);
    item.setPrice(price);
    item.setQuantity(quantity);
    itemRepository.save(item);
    model.addAttribute("item", item);
    return "basic/item";
}

해당 변수 이름에 맞는 파라미터를 직접 받고 itemRepository에 저장한다.

해당 item 객체를 모델에 전달한다.

2.@ModelAttribute를 통한 주입

@PostMapping("/add")
public String addItemV2(@ModelAttribute("item") Item item, Model model) {
    itemRepository.save(item);
    //model.addAttribute("item", item); //자동 추가, 생략 가능
    return "basic/item";
}

@RequestParam 을 생략해도 @ModelAttribute가 알아서 생성자를 입력해준다.

게다가 이렇게 넘어온 item 값을 자동으로 모델에 넘겨주기 때문에 

model.addAttribute 코드를 생략해도 된다.

따라서 코드를 더 간결하게 짤 수 있다.

만약 @ModelAttribute("item2")라고 입력해준다면, 모델에 "item2"라는 이름으로 넘겨준다.

3.@ModelAttribute의 이름 생략

@PostMapping("/add")
public String addItemV3(@ModelAttribute Item item) {
    itemRepository.save(item);
    return "basic/item";
}

@ModelAttribute의 이름을 생략해도 상관없다.

이 경우 item 클래스의 Item을 앞 글자만 소문자로 변경 후 모델 이름으로 넘겨준다.

model.addAttribute("item",item);

4. @ModelAttribute까지 생략

@PostMapping("/add")
public String addItemV4(Item item) {
    itemRepository.save(item);
    return "basic/item";
}

@ModelAttribute 까지 생략할 수 있다. 

이 경우에도 위와 똑같이 동작한다.

하지만 직관성이 너무 떨어지기 때문에 사용을 권하지 않는다.

"Redirect를 왜 필요할까?"

PRG를 알아보기 전에 먼저 Rediect의 필요성을 알 필요가 있다.

만약 상품을 수정, 개발하는 메서드를 개발한다고 생각해보자 

@PostMapping("/addForm")
public String addCafe(@ModelAttribute Cafe cafe){
    cafeRepository.save(cafe);
    return "basicCafe/cafe";
}

카페 정보를 추가하는 메서드를 만들었다.

하지만 추가를 완료한 뒤 새로 고침을 누르게 된다면 어떻게 될까?

똑같은 정보들이 계속해서 입력될 것이다.

이는 Redirect를 설정하지 않았기 때문인데, 이렇게되면 마지막으로 서버에 전송한 데이터가 추가 메서드를 계속 실행시킨다.

POST, Redirect Get

PRG는 새로고침 시 똑같은 메서드가 계속해서 실행되는 것을 막아준다.

말 그대로 경로를 우회해주는 것이다. 

메서드 실행 완료 후 다른 경로로 호출해줌으로써 서버는 더 이상 똑같은 메서드를 반복하지 않게 된다!

그럼 이제 위에서 문제를 일으켰던 추가 메서드를 수정해보자

@PostMapping("/addForm")
public String addCafe(@ModelAttribute Cafe cafe){
    cafeRepository.save(cafe);
    return "redirect:/basicCafe/cafes"+ cafe.getId();
}

 이렇게 메서드를 수정해주면 리다이렉트를 적용시킴으로써 문제를 해결할 수 있다.

하지만

"cafe.getId() 처럼 URL에 변수를 더해서 사용하는 것은 URL 인코딩이 안되기 때문에 위험하다."

쉽게 설명하자면 변수에 띄워쓰기나 한글이 포함될 경우 서버가 인식할 수 있게 url인코딩을 해주어야하는데 

이것이 안된다는 것이다.

결국 또 다른 문제가 생겼다.

그리고 이를 해결할 수 있는 두가지 해결책이 제시되었다.

첫번째, @PathVariable 사용

@PostMapping("/edit/{cafeId}")
public String edit(@PathVariable Long cafeId,@ModelAttribute Cafe cafe){
    cafeRepository.update(cafeId,cafe);
    return "redirect:/basic/items/{cafeId}";
}

@PathVariable 을 사용하게 된다면 컨트롤러에 매핑된 값도 Redirect 값에 사용할 수 있다. 

두번째, RedirectAttributes 사용

@PostMapping("/addForm")
public String addCafe(@ModelAttribute Cafe cafe, RedirectAttributes redirectAttributes){
    Cafe savedCafe = cafeRepository.save(cafe);
    redirectAttributes.addAttribute("cafeId",savedCafe.getId());
    redirectAttributes.addAttribute("status",true);
    return "redirect:/basicCafe/items/{cafeId}";
}

RedirectAttributes 를 사용하게 되면, URL 인코딩도 해주고, pathVarible , 쿼리 파라미터까지 처리해준다.

이 메서드는 

localhost:8080/basic/cafes/3?status=true

를 반환해준다.

굳이 PathVariable을 쓸 필요도 없고 url 인코딩 걱정도 할 필요가 없다. 

게다가 status 파라미터까지 추가해준다 !! (바인딩 되지 않았을 경우)

파라미터는 타임리프 문법에서 ${param.status}로 조회가 가능하다

실무에서는 printLn 이 아닌 로깅을 통하여 정보를 출력해야한다.

@RestController
public class LogTestController {
    private final Logger log = LoggerFactory.getLogger(getClass());

    @RequestMapping("/log-test")
    public String logTest(){
        String name = "spring";

        log.trace("trace log = {}", name);
        log.debug("debug log = {}", name);
        log.info("info log = {}", name);
        log.warn("warn log = {}", name);
        log.error("error log = {}", name);

        log.debug("debug log={}",name);

        return "ok";
        
    }

먼저 클래스 레벨에 붙은 @RestController 에노테이션은 리턴 값을 Http 바디에 바로 입력해준다.

(@Controller 는 반환값을 뷰 이름으로 인식한다.)

@Slf4j
@RestController
public class LogTestController {
    //private final Logger log = LoggerFactory.getLogger(getClass());

또한 @sLf4j 어노테이션을 사용하면 로그 선언을 해줄 필요가 없다.

로그를 보면 trace와 debug 로그가 찍히지 않은 것을 볼 수 있는 데, 이는 application.properties 의 기본 설정과 관련이 있다.

# 기본 설정
logging.level.root=info
#debug 이하의 값을 출력해준다.
logging.level.hello.springmvc=debug

이렇게 설정을 하고 다시 로그를 찍어보자

이런식으로 로그 출력 단계를 조절할 수 있다.

(TRACE > DEBUG > INFO > WARN > ERROR)

log.debug("debug log={}"+name);

참고로 이와 같은 출력 형식은 사용하지 않는 것이 좋다.

출력 여부와 관계없이 문자열 + 연산을 수행하기 때문에 메모리 낭비가 되기 때문이다.

더 많은 기능은?

SLF4J

Logback Home (qos.ch)

Core Features (spring.io)

application.properties 에 위와 같은 코드를 입력해준다.

logging.level.org.apache.coyote.http11=debug

운영 서버에서 모든 요청 정보를 남기면 성능 저하가 될 수 있으므로 개발 단계에서만 활용하도록 하자!