[Spring] - @ModelAttribute, @RequestParam

• 안녕하세요~ 이전에 운영하던 블로그와 소스코드를 관리하는 GitHub가 따로 있습니다.

• 네이버 블로그

• GitHub

---

✔ @ModelAttribute, @RequestParam

 

안녕하세요~ 이번에 정리할 내용은 스프링의

@ModelAttribute, @RequestParam 어노테이션 입니다.

 

최근 @ModelAttribute 어노테이션을 사용하는데, 바인딩이 되지 않아 문제가 있었고 ...

검색해보니 @ModelAttribute 어노테이션을 객체에 바인딩 하기 위해선 Setter 메소드 혹은 생성자 가 필수적으로 필요하기에 바인딩이 되지 않는 문제가 발생했었습니다.

 

따라서 @ModelAttribute 와 비슷한 어노테이션인 @RequestParam 어노테이션을 간단히 정리해보도록 하겠습니다.

 

 

 

 

 

✔ @ModelAttribute

@ModelAttribute는 클라이언트가 전송하는 여러 파라미터를 1:1로 객체에 바인딩 한 후 다시 View로 데이터를 넘겨서 출력하기 위해 사용되는 어노테이션 입니다.

 

@ModelAttribute는 넘어온 파라미터의 타입이 객체의 타입과 일치하는지를 포함해서 다양한 유효성(Validation) 검사를 추가적으로 진행합니다.

예를 들어, int 형의 id 값에 "1" 이라는 String의 문자열을 넣으려고 한다면 BindException 에러가 발생합니다.

 

  @PostMapping(path = "user/join", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
  @ApiOperation(value = "회원가입")
  public ApiResult<JoinResult> join(
          @ModelAttribute JoinRequest joinRequest,
          @RequestPart(required = false) MultipartFile file) {
      // ... 
      
      
      

import io.swagger.annotations.ApiModelProperty;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;

public class JoinRequest {

  @ApiModelProperty(value = "이름", required = true)
  private String name;

  @ApiModelProperty(value = "로그인 이메일", required = true)
  private String principal;

  @ApiModelProperty(value = "로그인 비밀번호", required = true)
  private String credentials;

  protected JoinRequest() {}

  // Getter, Setter 생략
  // Setter 메소드 혹은 모든 필드를 받는 생성자는 반드시 존재해야 @ModelAttribute 바인딩 가능

  @Override
  public String toString() {
    return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
      .append("name", name)
      .append("principal", principal)
      .append("credentials", credentials)
      .toString();
  }

}      

위 코드에서 클라이언트가 다음과 같은 파라미터를 전송하면, JoinRequest 객체에 바인딩이 됩니다.

 

  • https://localhost~?name=test&principal=id&credentials=password

 

 

※ @ModelAttribute 는 Setter 메소드 혹은 모든 필드를 인자로 받는 생성자가 있어야 바인딩이 됩니다.

 

 

 

 

 

 

✔ @RequestParam

@RequestParam 어노테이션은 클라이언트가 전송하는 파라미터를 1:1로 받기 위해 사용합니다.

---

@RequestParam 어노테이션은 생략

※ 사실 @RequestParam 어노테이션은 생략이 가능합니다. 생략을 하더라도 컨트롤러의 매개변수 이름과 Form에서의 네이밍이 동일하다면 클라이언트가 요청한 파라미터의 key 값과 매개변수의 이름을 비교하여 적절히 바인딩을 해주지만 사용자가 원하는 매개변수에 직접 매핑을 할 수 있으므로 사용합니다.

---

 

 

@ModelAttribute 어노테이션은 객체에 바인딩한다는 점에서 다릅니다.

 

 

@RequestParam 어노테이션을 사용하면 반드시 해당 파라미터가 전송이 되어야 하는데요, 만약 해당 파라미터가 필요하지 않는다면 required 속성을 false로 설정 할 수 있습니다. (default는 true 입니다.)

 

 

또한 아래와 같이 속성으로 name을 설정할 수 있는데요, 설정하면 해당 설정 값과 파라미터의 key가 동일해야 합니다.

 

@Requestparam("test") String test ==> localhost:8080/hello/dto?test=1234

 

 

아래 속성에서 value = "test" 와 value = "testAmount" 를 참고해주세요.

 

 

• @Request("test"), @Request("testAmount") 테스트

@RestController
public class HelloController {

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

    @GetMapping("/hello/dto")
    public HelloResponseDto helloDto(@RequestParam(value = "test") String name,
                                     @RequestParam(value = "testAmount") int amount) {
        return new HelloResponseDto(name, amount);
    }
}

 

 

 

 

 

• @Request("name"), @Request("amount") 테스트

RestController
public class HelloController {

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

    @GetMapping("/hello/dto")
    public HelloResponseDto helloDto(@RequestParam("name") String name,
                                     @RequestParam("amount") int amount) {
        return new HelloResponseDto(name, amount);
    }
}

 

 

• 요청 파라미터가 부족할 때

 

 

 

 

 

• required = false 속성 테스트

@RestController
public class HelloController {

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

    @GetMapping("/hello/dto")
    public HelloResponseDto helloDto(@RequestParam(value = "name", required = false) String name,
                                     @RequestParam(value = "amount") int amount) {
        return new HelloResponseDto(name, amount);
    }
}

 

 

 

 

 

• primitive 타입은 require = false 속성 불가능!

@RestController
public class HelloController {

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

    @GetMapping("/hello/dto")
    public HelloResponseDto helloDto(@RequestParam("name") String name,
                                     @RequestParam(value = "amount", required = false) int amount) {
        return new HelloResponseDto(name, amount);
    }
}

 

Reference Type이 아닌 primitive type은 위와 같이 required = false 속성이 불가능합니다!!

  • Reference Type

      • ex) String

  • primitive type

      • ex) int