[Spring] HTTP 요청에서 값 받아오기 - @ModelAttribute

이 글은 공부를 하면서 알게 된 내용들을 기록하는 글 입니다. 오류나 고쳐야 할 사항들이 있다면 지적 부탁드립니다!

 

⛅️ @ModelAttribute를 사용하는 때

✅ request parameter(요청 파라미터) 조회

• @RequestParam은 GET 요청 파라미터 전송 방식, HTML Form 전송 방식을 사용할 때에 조회할 수 있는 방법 중 하나이다.
• 이를 request parameter 조회라고 한다.

 

✅ 객체에 요청 파라미터의 값을 넣어야 할 때

• 요청 파라미터의 값을 받아서 객체에 넣고 싶을 때, @ModelAttribute를 사용하지 않으면
  @RequestParam을 통해 변수에 값을 저장하고, 객체를 생성한 후, setter를 통해 값을 설정해주어야 한다.

@ResponseBody
@RequestMapping("/request-param-object")
public String requestParamObject(@RequestParam String username, @RequestParam int age){
	HelloData data = new HelloData();
	data.setUsername(username);
	data.setAge(age);
    
	return "ok";
}

• 위 코드에서의 과정을 스프링에서 자동화해준 것이 바로 @ModelAttribute이다.

 

---

⛅️ @ModelAttribute 사용법

✅ 요청 파라미터를 바인딩할 객체 만들기

• GET 요청 파라미터 방식 혹은 HTML Form 전송 방식으로 받은 요청 파라미터를 저장할 객체가 필요하다.
• 요청 파라미터의 형식에 맞게 객체의 변수들을 private로 선언한다.
• Getter와 Setter를 설정하여 요청 파라미터를 받을 수 있게 한다.
  Tip! Lombok 라이브러리를 사용하면 어노테이션을 통해 코드를 간결화할 수 있다!

 

요청 파라미터로 회원의 정보(회원 이름, 나이)를 전달받아서 객체에 저장하려고하는 상황이라고 가정하자.

요청 파라미터를 저장할 객체를 만든다. 

Lombok의 @Data 어노테이션을 적용하면

@Getter, @Setter, @ToString, @EqualAndHashCode, @RequiredArgsConstructor가 모두 적용된다.

import lombok.Data;

@Data
public class MemberData {
	private String username;
	private int age;
}

이렇게하면 요청 파라미터를 저장할 객체가 준비된 것 이다.

 

 

✅ @ModelAttribute를 통해 객체에 요청 파라미터 바인딩하기

@ModelAttribute 클래스명 객체명

• 스프링 MVC의 동작 방식
  • @ModelAttribute가 있는 경우, 스프링 MVC가 MemberData 객체를 생성한다.
  • 요청 파라미터의 이름(username, age)으로 MemberData 객체의 프로퍼티를 찾고, setter를 통해 값을 바인딩한다.

@ResponseBody
@RequestMapping("/model-attribute")
public String modelAttribute(@ModelAttribute MemberData memberData) {
	log.info("username={}, age={}", memberData.getUsername(), memberData.getAge());
	return "ok";
}

 

이처럼 @ModelAttribute 어노테이션을 사용하면 편하게 요청 파라미터의 값을 객체에 바인딩할 수 있다.