[스프링 MVC 1편] - 스프링 MVC - 기본 기능(1)

Chooooo·2023년 1월 5일

MVC spring mvc 기본 기능

스프링 MVC 1편

목록 보기

6/11

이 글은 강의 : 김영한님의 - "[스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술]"을 듣고 정리한 내용입니다. 😁😁

이제 스프링 MVC를 바탕으로 프로젝트를 만들어 나가보자.

프로젝트 생성

사전 준비물

JDK 11 + (File>settings에서 Gradle 검색 후 Gradle JVM에서 java 버전 11을 사용하자.)
IDE : IntelliJ

프로젝트 생성

스프링 공식 홈페이지에서 프로젝트 구성 https://start.spring.io
IntelliJ Ultimate 이상이면 자체적으로 생성 가능

프로젝트 구성

Project : Gradle Project
Language : JAVA
Spring Boot : 최신 버전
Project metadata
- Group : hello
- Artifact : springmvc
- Name : springmvc
- Package name : hello.springmvc
- Packaging : Jar(이번에는 스프링으로 할꺼잖아)
- Java : 11

Dependencies

Spring Web
Lombok
Thymeleaf

참고

Packaging을 War가 아닌 Jar를 선택해야 한다! JSP를 사용하지 않기에 Jar를 사용하는 것이 좋고, 스프링 부트에서는 주로 Jar을 사용하게 된다.

Jar를 선택하면 항상 내장 서버(톰캣)을 사용하고 webapp 경로도 사용하지 않는다. 내장 서버 사용에 최적화된 기능이다. War는 내장 서버도 사용가능 하지만, 주로 외부 서버에 배포하는 목적으로 사용한다.

build.gradle

plugins {
id 'org.springframework.boot' version '2.4.3'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
}
group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
implementation 'org.springframework.boot:spring-boot-starter-web'
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
test {
useJUnitPlatform()
}

Welcome 페이지

이번에 학습할 내용을 편리하게 관리하기 위해 Welcome 페이지를 만들어놓자.

스프링 부트에 Jar를 사용하면 /resource/static/ 위치에 index.html 파일을 두면 Welcome 페이지 처리해준다. (스프링 부트가 지원하는 정적 컨텐츠 위치에 /index.html이 있으면 된다.)

로깅 간단히 알아보기

지금까지는 콘솔창에 실행 결과나 기대값을 System.out.println()을 통해 출력을 했다.
🎈 하지만 실제 운영을 할 때는 시스템 콘솔이 아닌 별도의 로깅 라이브러리를 사용해 출력을 해야 한다.
여기서는 많은 로깅 라이브러리 중 SLF4J, Logback 정도만 알아보도록 한다.

로깅 라이브러리

스프링 부트 라이브러리를 사용할 경우 스프링 부트 로깅 라이브러리(spring-boot-starter-loggin)이 포함되는데 이 라이브러리는 내부에 다음 로깅 라이브러리가 사용된다.

SJF4J = http://www.slf4j.org
Logback = http://logback.qos.ch

로그 라이브러리는 Logback, Log4J, Log4J2 등 정말 많은 라이브러리가 있는데 이를 통합해서 제공하는게 SLF4J 이고 이 인터페이스의 구현체로 Logback과 같은 로그 라이브를 선택해서 사용한다.

사용법 - 선언

🎈 로깅을 사용하려면 우선 로깅 객체를 생성해야 하는데, 다음과 같이 선언해서 사용한다.

클래스 참조 변수 선언

/* getClass()메서드를 통해 사용되는 클래스 타입 반환하여 삽입 */
private Logger log = LoggerFactory.getLogger(getClass());

/* 직접적으로 해당 클래스타입을 입력해줘도 된다. */
private static final Logger log = LoggerFactory.getLogger(Xxx.class);

롬복(Lombok) 사용

@Slf4j
public class TestController {
	...
}

🎈 롬복 라이브러리를 사용한다면 @Slf4j 애너테이션으로도 사용 가능하다!

LogTestController

package hello.springmvc.basic;


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@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);
        return "ok";
    }
}

🎃 @RestController

@Controller는 반환값이 String이면 뷰 이름으로 인식하기에 뷰를 찾고 뷰가 렌더링된다.
@RestController는 반환 값으로 뷰를 찾는게 아니라 HTTP 메세지 바디에 바로 입력한다.
⇒클래스레벨이아닌 메서드레벨에서 @ResponseBody를 사용하면 @Controller를 사용하더라도 바로 HTTP 메세지 바디에 입력해서 반환을 해준다.
(따라서 실행 결과(return "ok";)로 ok 메세지를 받을 수 있다. @ResponseBody 와 관련이 있는데, 뒤에서 더 자세히 설명한다)

로그 테스트

해당 로깅 컨트롤러를 구현해서 테스트를 해본 뒤 실행결과를 보면 로그 출력 코드를 5개 작성했으니 5개가 나와야 하지만 3개밖에 나오지 않는다. 왜 그런 것인가?

로그에는 레벨이 있다. 그래서 로그레벨을 설정하면 그 로그보다 우선순위가 높은 것만 출력이 되는데, 스프링 부트에서는 기본으로 설정 되어 있는 로그 레벨은 info이다. 그렇기에 info보다 우선순위가 낮은 debug, trace는 출력되지 않는다.
(LEVEL: TRACE → DEBUG → INFO → WARN → ERROR)

개발 서버는 debug 출력
운영 서버는 info 출력

만약, 이런 로그를 임의로 내가 원하는 대로 변경하고자 한다면 설정 파일(applicaion.properties)에서 레벨을 변경해주면 된다.

#전체 로그 레벨 설정(기본 info)
lolgging.level.root=info

#hello.springmvc 패캐지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=[변경을 원하는 로그 레벨]

올바른 로그 사용법

시스템 콘솔 출력을 작성할 때 우리는 지금까지 주로 다음과 같이 작성을 했다.

🎃 기존의 문자열 결합을 이용한 출력문 사용

System.out.println(name + "님 안녕하세요.");

/*로그도 위와같이 사용한다면?*/
log.debug(name + "님 안녕하세요.");

로그 레벨을 info로 설정해도 해당 코드에 있는 name + "님 안녕하세요."는 평가되며 연산이 되버린다. 즉, 더하기 연산이 발생! 자바 컴파일 시점에서 사용하지도 않는 debug 레벨에 있는 연산을 평가해버리니 리소스 낭비다.

🎃 새로운 방식의 로그 출력 방식
log.debug("{} 님 안녕하세요.", name);

로그 출력 레벨이 debug 이상이면 debug 내의 연산은 수행되지 않는다.

로그 사용 시 장점

🎈 쓰레드 정보, 클래스 이름같은 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.

🎈 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고 운영서버에선느 출력하지 않게끔 로그를 조절할 수 있다. (상황에 맞게 조정할 수 있다)

🎈 콘솔에만 출력하는게 아니라 파일이나 네트워크 등 로그를 별도의 위치에 남길 수 있다.
특히 파일로 남길 때 일별, 특정 용량에 따라 로그를 분할하는것도 가능하다.

🎈 성능도 System.out보다 좋다.(내부 버퍼링, 멀티 쓰레드 등)

이제 진짜 스프링 기본 기능에 대해서 알아가 보자.

요청 매핑

요청이 왔을 때 어떤 컨트롤러에서 매핑을 할 지 조사해서 매핑을 진행하는 것.

MappingController

/**
 * 기본 요청
 * 둘 다 허용한다 /hello-basic, /hello-basic/
 * HTTP 메서드 모두 허용 GET, POST, HEAD, PUT, PATCH, DELETE
 */
@RequestMapping("/hello-basic")
public String helloBasic() {
    log.info("helloBasic");
    return "ok";
}

🎃 @RequestMapping("/hello-basic")
⇒ /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.
⇒ 대부분의 속성을 배열[]로 제공하기에 다중 설정도 가능하다.
ex : @RequestMapping({"/hello-baisc", "/hello-go"})

method 속성으로 HTTP 메서드를 지정하지 않으면 모든 메서드에 무관하게 호출된다.
(GET, HEAD, POST, PATCH, DELETE)

매핑 정보 (한번 더)

@RestController

@Controller 는 반환 값이 String 이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 랜더링 된다.
@RestController 는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.
따라서 실행 결과로 ok 메세지를 받을 수 있다. @ResponseBody 와 관련이 있는데, 뒤에서 더 자세히 설명한다.

method 특정 HTTP 혀용 매핑

/**
 * method 특정 HTTP 메서드 요청만 허용한다.
 * GET, HEAD, POST, PUT, PATCH, DELETE
 */
@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
public String mappingGetV1() {
    log.info("mappingGetV1");
    return "ok";
}

method가 GET일 경우에만 매핑이 되며 다른 방식으로 요청하면 HTTP 405(Method Not Allowed)가 반환된다.

HTTP 메서드 매핑 축약

/**
 * 편리한 축약 애노테이션
 *
 * @GetMapping
 * @PostMapping
 * @PutMapping
 * @DeleteMapping
 * @PatchMapping
 */
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
    log.info("mapping-get-v2");
    return "ok";
}

🎈 매번 method 속성을 설정해서 HTTP 메서드를 지정해주는게 번거롭고 가독성도 떨어지기에 전용 애너테이션을 만들어서 해결한다.

🎈 GetMapping, PostMapping, PatchMapping, DeleteMapping 등 이름에 의미를 부여해 더 직관적이다.

애너테이션 내부에는 @RequestMapping과 method를 미리 지정해놨다.

PathVariable(경로 변수)를 사용한 매핑

요즘 진짜 많이 사용해!!! 경로 변수 기억하기.

/**
 * PathVariable 사용
 * 변수명이 같으면 생략 가능
 *
 * @PathVariable("userId") String userid -> @PathVariable userId
 */
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable String userId) {
    log.info("mappingPath userId={}", userId);
    return "ok";
}

🎃 최근 HTTP API는 위와 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다고 한다.

/mapping/userA
/users/1

🎃 @RequestMapping은 URL 경로를 템플릿화 할 수 있는데 @PathVariable애너테이션을 사용하면 매칭 되는 부분을 편리하게 조회할 수 있다.

템플릿화 한다는 것이 @GetMapping("/mapping/{userId}") 여기서 userId처럼 뭔가 들어오는 것을 의미해!

🎃 @PathVariable의 이름과 파라미터 이름이 같으면 생략 가능!
⇒ @PathVariable("username") String username → PathVariable String username
(username이 같잖아!) → 그러면 생략가능. @PathVariable 자체를 생략하면 안돼 !

PathVariable 다중 사용

/**
 * PathVariable 다중 사용
 */
@GetMapping("/mapping/users/{userId}/orders/{orderId}")
public String mappingPath(@PathVariable String userId, @PathVariable String orderId) {
    log.info("mappingPath userId={}, orderId={}", userId, orderId);
    return "ok";
}

하나 이상의 PathVariable도 사용이 가능하다.

특정 파라미터 조건 매핑

/**
 * 파라미터로 추가 매핑
 * params="mode",
 * params="!mode",
 * params="mode=debug",
 * params="mode!=debug"(!=)
 * params={"mode=debug", "data=good"}
 */
@GetMapping(value = "/mapping-param", params = "mode=debug")
public String mappingParam() {
    log.info("mappingParam");
    return "ok";
}

특정 파라미터를 조건식으로 매핑해서 매핑 여부를 결정할 수 있다. (URL 경로 뿐만 아니라 파라미터 정보까지 AND 조건으로 추가로 매핑해서 해당하면 맵핑을 해준다!)
⇒ http://localhost:8080/mapping-param?mode=debug
요즘은 경로변수 방식을 많이 사용해서 이 방법은.. 잘 사용하지 않는다.

특정 헤더 조건 매핑

/**
 * 특정 헤더로 추가 매핑
 * headers="mode",
 * headers="!mode",
 * headers="mode=debug",
 * headers="mode!=debug"
 */
@GetMapping(value = "/mapping-header", headers = "mode-debug")
public String mappingHeader() {
    log.info("mappingHeader");
    return "ok";
}

특정 파라미터 매핑과 동일하게 헤더 역시 (URL에 더해서)조건 매핑이 가능하다.

미디어 타입 조건 매핑 - HTTP 요청 Content-Type, consume

/**
 * Content-Type 헤더 기반 추가 매핑 Media Type
 * consumes="application/json",
 * consumes="!application/json",
 * consumes="application/*",
 * consumes="*\/*"
 * MediaType.APPLICATION_JSON_VALUE
 */
@PostMapping(value = "/mapping-consume", consumes = "application/json")
public String mappingConsumes() {
    log.info("mappingConsumes");
    return "ok";
}

HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.
일치하지 않을 경우 HTTP 415(Unsupported Media Type)을 반환한다.
조건을 배열로 설정할 수 있고 상수로 제공하는 매직넘버를 사용해도 된다.

🎈 사용예시

consumes = "application/json"
consumes = {"text/plain", "application/*"}
consumes = MediaType.TEXT_PLAIN_VALUE

미디어 타입 조건 매핑 - HTTP 요청 Accept, produce

/**
 * Accept 헤더 기반 Media Type
 * produces="text/html",
 * produces="!text/html",
 * produces="text/*",
 * produces="*\/*"
 */
@PostMapping(value = "/mapping-produces", produces = "text/html")
public String mappingProduces() {
    log.info("mappingProduces");
    return "ok";
}

HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑한다.
만약 맞지 않으면 HTTP 406(Not Acceptable)을 반환한다.

요청 매핑 - API 예시

이제 회원 관리 웹 애플리케이션에 필요한 HTTP API를 구조만 만들어보자
회원관리를 HTTP API로 만든다고 생각하고 매핑을 어떻게 하는지 알아보자.
(실제 데이터가 넘어가는 부분은 생략하고 URL 매핑만)

회원 관리 API

회원 목록 조회 : GET /users
회원 등록 : POST /users
회원 조회 : GET /users/{userId}
회원 수정 : PATCH /users/{userId}
회원 삭제 : Delete /users/{userId}

여기서 보면 URL은 똑같이 제공이 되는데, HTTP 메서드로 어떤 기능이 동작하는지 행위를 구분할 수 있다!!!

MappingClassController

package hello.springmvc.basic.requestmapping;

import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {

    @GetMapping
    public String user() {
        return "get users";
    }

    @PostMapping
    public String addUser() {
        return "add user";
    }

    @GetMapping("/{userId}")
    public String findUser(@PathVariable String userId) {
        return "get userId= " + userId;
    }

    @PatchMapping("/{userId}")
    public String updateUser(@PathVariable String userId) {
        return "update userId= " + userId;
    }

    @DeleteMapping("/{userId}")
    public String deleteUser(@PathVariable String userId) {
        return "delete userId= " + userId;
    }
}

🎃 @RequestMapping("/mapping/users")
- 클래스 레벨에 매핑 정보를 두면 메서드 레벨에서 해당 정보를 조합해서 사용한다. (한 눈에 알아보기 직관적)

🎃 (클라이언트로부터 요청이 오면) 매핑 방법을 이해했으니, 이제부터 HTTP 요청이 보내는 데이터들을 스프링 MVC로 어떻게 조회하는지 알아보자.

HTTP 요청 - 기본, 헤더 조회

(HTTP 요청이 보내는 데이터들을 조회하는 방법)

애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.
스프링에서는 아주 유연하게 컨트롤러의 메서드가 요구하는 파라미터를 정말 대부분 지원을 해주는데, 코드를 통해 알아보자.

RequestHeaderController

package hello.springmvc.basic.request;

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpMethod;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Locale;

@Slf4j
@RestController
public class RequestHeaderController {

    @RequestMapping("/headers")
    public String headers(HttpServletRequest request,
                          HttpServletResponse response,
                          HttpMethod httpMethod,
                          Locale locale,
                          @RequestHeader MultiValueMap<String, String> headerMap,
                          @RequestHeader("host")String host,
                          @CookieValue(value = "myCookie", required = false)String cookie) {

        log.info("request = {}", request);
        log.info("response = {}", response);
        log.info("httpMethod = {}", httpMethod);
        log.info("locale = {}", locale);
        log.info("headerMap = {}", headerMap);
        log.info("host = {}", host);
        log.info("cookie = {}", cookie);

        return "ok";

    }
}

🎃 HttpMethod

HTTP 메서드를 조회한다.
(org.springframework.http.HttpMethod)

🎃 Locale

Locale 정보를 조회한다. (ko-kr, euc-kr, ...)

🎃 @RequestHeader MultiValueMap<String, String> headerMap

모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.

🎃 @RequestHeader("host") String host

특정 HTTP 헤더를 조회한다.
속성
- 필수 값 여부(required)
- 기본 값 속성(defaultValue)

🎃 @CookieValue(value = "myCookie", required = false) String cookie

특정 쿠키를 조회한다.
속성
- 필수 값 여부(required)
- 기본 값 속성(defaultValue)

참고 : MultiValueMap

Map과 유사하지만 하나의 키에 여러 값을 받을 수 있다.
HTTP header, HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용한다.
- keyA=value1&keyA=value2

MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
map.add("keyA", "value1");
map.add("keyA", "value2");

//[value1, value2]
List<String> values = map.get("keyA");

🎃 @Slf4j

다음 코드를 자동으로 생성해서 로그를 선언해준다. 개발자는 편리하게 log 라고 사용하면 된다

private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class);

HTTP 요청 파라미터 - 쿼리 파라미터, HTML Form

HTTP 요청 메세지를 개발자가 사용하기 편하게 변환해 제공하는 것이 HttpServletRequest 객체다.

이 객체 내의 getParameter()를 이용하면 요청 파라미터를 조회할 수 있는데,(HTTP 요청 메세지에서 요청 파라미터 조회) queryString으로 요청 메세지를 전달하는 것은 GET, 쿼리 파라미터 전송과 POST HTML Form 전송 방식이다.

🎃 GET 쿼리 파라미터 전송

http://localhost:8080/request-param?username=hello&age=20

🎃 POST, HTML Form 전송

POST /request-param ...
content-type: application/x-www-form-urlencoded

username=hello&age=20

위 두 방식은 모두 형식이 동일하기에 구분없이 getParameter()메서드를 이용해 조회할 수 있는데 이를 요청 파라미터(request parameter) 조회라 한다.

지금부터 스프링으로 요청 파라미터 조회하는 방법을 단계적으로 알아보자.

그 전에 먼저 테스트용 HTML Form을 만들어야 한다.
리소스는 /resources/static 아래에 두면 스프링 부트가 자동으로 인식한다.

main/resources/static/basic/hello-form.html

<!DOCTYPE html>
<html>
<head>
 <meta charset="UTF-8">
 <title>Title</title>
</head>
<body>
 <form action="/request-param-v1" method="post">
 username: <input type="text" name="username" />
 age: <input type="text" name="age" />
 <button type="submit">전송</button>
 </form>
</body>
</html>

이렇게 resources/static아래에 두면 경로를 호출할 때 localhost:8080/basic/hello-form.html 이런 식으로 호출해주면 된다! (스프링 부트가 알아서 인식)

이렇게 직접 한번 해본 이유는 jar로 내장 톰캣만 쓰겠다고 하면 webapp 경로를 쓸 수 없기 때문에 지금부터는 resources/static에 정적 리소스를 담아두면 된다는걸 보여주기 위해서 해본 것.

RequestParamController

package hello.springmvc.basic.request;

import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Map;

@Slf4j
@Controller
public class RequestParamController {

    /**
     * 서블릿 시절 사용하던 쿼리 스트링 추출 방식
     */
    @RequestMapping("/request-param-v1")
    public void requestParamV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));
        log.info("username={}, age={}", username, age);

        response.getWriter().write("ok");
    }
}

🎃 반환 타입이 없으면서 응답에 값을 직접 입력("OK")하면 View 조회를 할 수 없다.

🎃 이전 서블릿 코드를 구현하던 시절과 같이 HttpServletRequest에서 getParameter()로 요청 파라미터를 조회했다.

🎈 참고
Jar를 사용하면 webapp 경로 사용을 못하기에 정적 리소스도 클래스 경로에 함께 포함해야 한다.

HTTP 요청 파라미터 - @RequestParam

스프링이 제공하는 애노테이션인 @RequestParam을 사용하면 위에서 사용한 getParameter() 메서드를 통해 꺼내는 대신 매개변수 레벨에서 더 빠르게 바로 꺼내 사용할 수 있다.

RequestParamController.requestParamV2

/**
 * RequestParam 애노테이션을 활용해 내부 속성으로 쿼리 스트링의 Key를 작성해서 해당 key 의 value 추출
 */
@RequestMapping("/request-param-v2")
@ResponseBody
public String requestParamV2(@RequestParam("username") String memberName, @RequestParam("age") int memberAge) {
    log.info("username={}, age={}", memberName, memberAge);
    return "ok";
}

🎃 @RequestParam("uesrname")

파라미터 이름으로 바인딩

🎃 @ResponseBody (중요!!!)

View 조회를 무시하고, HTTP 메세지 바디에 직접 해당 내용을 입력
클래스 레벨에서 @Controller 사용하는 경우 메서드 레벨에서 해당 애노테이션을 사용해서 메세지 바디에 직접 내용 입력하는게 가능하다.

RequestParamController.requestParamV3

/**
 * 매개변수의 이름이 쿼리파라미터의 key와 이름이 동일하면 속성을 빼도 동작한다.
 */
@RequestMapping("/request-param-v3")
@ResponseBody
public String requestParamV3(@RequestParam String username, @RequestParam int age) {
    log.info("username={}, age={}", username, age);
    return "ok";
}

HTTP 파라미터 이름이 변수 이름과 같을 경우 파라미터 속성 생략이 가능하다.
⇒ @RequestParam("username") String username → @RequestParam String username

RequestParamController.requestParamV4

/**
 * 쿼리 파라미터의 Key가 일치하면 애노테이션을 제거해도 동작한다.
 */
@RequestMapping("/request-param-v4")
@ResponseBody
public String requestParamV4(String username, int age) {
    log.info("username={}, age={}", username, age);
    return "ok";
}

🎃 String, int, Integer 등의 단순 타입이면 @RequestParam도 생략이 가능하다.

참고

이렇게 애노테이션을 완전히 생략해도 되는데, 너무 없는 것도 과할 수가 있다.
@RequestParam이 있으면 명확하게 요청 파라미터에서 데이터를 읽는다는 것을 앍 수 있다. 그렇기에 일단은 넣어쓰면서 해당 코드가 요청 파라미터에서 데이터를 가져 오는구나.. 이런걸 알아간다 생각하고 애노테이션을 쓰자.

지금까지는 @RequestParam의 속성 중 바인딩을 위한 요청 파라미터 이름만 사용했는데, 그 외에도 여러 속성이 있다. 다음 소개할 속성은 required라는 속석으로 해당 파라미터의 필수 여부를 설정할 수 있다.

RequestParamController.requestParamRequired

@RequestMapping("/request-param-required")
@ResponseBody
public String requestParamRequired(@RequestParam(required = true) String username,
                                   @RequestParam(required = false) Integer age) {
    log.info("username={}, age={}", username, age);
    return "ok";
}

🎃 @RequestParam(required = ?)

파라미터 필수 여부
기본값은 파라미터 필수(true)이다.

🎃 해당 파라미터를 공백(ex: username=)으로 전송하면 빈 문자가 통과된다.

🎃 required가 true인 파라미터를 보내주지 않으면 400예외(BAD_REQUEST)가 발생한다.

🎃 원시 타입은 null이 들어갈 수 없어서 required가 false여도 500에러가 발생한다.
⇒ int형으로 에러가 발생하면 Integer같은 wrapper 타입을 사용해야 한다.
⇒ 혹은 기본값을 설정해주는 defaultValue를 사용하면 된다.

속성 중 필수 여부 속성(requierd)를 설정할 수 있다. 그럼 필수인데 값을 매번 공통 초기값을 넣거나 기본값이 필요한 경우에는 어떻게 해야할까? 속성 중에는 defaultValue라는 기본값 속성이 있다.

RequestParamController.requestParamDefault

@RequestMapping("/request-param-default")
@ResponseBody
public String requestParamDefault(@RequestParam(defaultValue = "hello") String username,
                                   @RequestParam(defaultValue = "20") int age) {
    log.info("username={}, age={}", username, age);
    return "ok";
}

파라미터가 없는 경우 기본값으로 설정한 값이 적용된다.
이미 기본값이 있기에 required는 의미가 없어 빼도 된다.
빈 문자("")의 경우에도 설정한 기본 값이 적용된다.
⇒ 요청(?age=) 을 공백으로 하면 int 기본형이라 null을 받아들일 수 없어 에러가 나야하지만 defaultValue로 설정한 값이 적용되어 age에 20이 주입된다.

RequestParamController.requestParamMap

🎈 지금까지 요청 파라미터를 하나하나씩 받고 있는데 Map을 이용해 한 번에 받을 수도 있다.

@RequestMapping("/request-param-map")
@ResponseBody
public String requestParamMap(@RequestParam Map<String, Object> paramMap) {
    log.info("username={}, age={}", paramMap.get("username"), paramMap.get("age"));
    return "ok";
}

🎃 파라미터를 Map, MultiValueMap으로 조회할 수 있다.

@RequestParam Map
- Map(key=value)
@RequestParam MultiValueMap
- MultiValueMap(key=[value1,value2,...]) (ex: (key=userIds, value=[id1, id2])

🎃 파라미터의 값이 1개가 확실하면 Map을 써도 되지만 그렇지 않다면 MultiValueMap을 사용하자

그런데 보통 파라미터의 값(key에 해당하는 value)은 하나를 쓴다. 애매하게 두개를 쓰는 경우는 거의 없다.

HTTP 요청 파라미터 - @ModelAttribute

위에서 @RequestParam을 이용해 요청 파라미터를 하나하나 받아줬다. 애노테이션을 이용해 최대한 편하게 받아줬지만, 요청 파라미터가 하나의 객체가 되야 하는 경우 각각 파라미터 요청을 조회해서 객체에 값을 넣어서 생성해주는 작업을 해야하기 때문에 번거롭다. 예를 들어, username과 age필드가 있는 HelloData라는 객체가 있다면 지금까지 배운 지식만 가지고 코드를 구현하면 다음과 같다.

@RequestParam을 이용한 객체 HelloData 객체 생성

@RequestMapping("/model-attribute-v1")
@ResponseBody
public String modelAttributeV1(@RequestParam(defaultValue = "hello") String username,
                               @RequestParam(defaultValue = "20") int age) {
    HelloData helloData = new HelloData();
    helloData.setUsername(username);
    helloData.setAge(age);

    log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());

    return helloData.toString();
}

🎃 위 예제에서는 username과 age밖에 없지만 이 요청 파라미터가 많아질수록 코드는 길어지고 오류의 확률은 올라간다.

😆 참고로 프로퍼티 객체에 getUsername() , setUsername() 메서드가 있으면, 이 객체는 username 이라는 프로퍼티를 가지고 있다.
username 프로퍼티의 값을 변경하면 setUsername() 이 호출되고, 조회하면 getUsername() 이
호출된다.

이런 번거로운 부분을 자동화해주는 애노테이션도 스프링에서 제공해주는데 그게 @ModelAttribute이다.
(객체를 만들어서 그 안에 파라미터를 넣어줘서 쓰도록..)

HelloData

요청 파라미터를 바인딩할 객체 HelloData

package hello.springmvc.basic;

import lombok.Data;

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

롬복을 통해 Getter, Setter 뿐만 아니라 toString, EqualsAndHashCode와 생성자까지 자동생성 되는데 @Data 애노테이션은 이 모든 애노테이션을 한 번에 모아서 제공한다.

RequestParamController.modelAttributeV1

@ModelAttribute 애노테이션을 이용한 요청 파라미터 객체 바인딩

@RequestMapping("/model-attribute-v1")
@ResponseBody
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
    log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());

    return helloData.toString();
}

🎃 ?username=hello&age=20 이라는 쿼리스트링을 담아서 요청을 하면 바로 HelloData 객체에 담겨서 사용할 수 있는걸 확인할 수 있다.

🎃 스프링MVC는 @ModelAttribute가 있으면 다음을 수행한다.

ⅰ. HelloData 객체를 생성한다.

ⅱ. 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩)한다.

파라미터 이름이 username이면 setUsername()메서드를 찾아 호출한다.

🎃 만약 나이(age)필드에 숫자가 아닌 문자(age=qwe)를 넣으려 하면 BindException이 발생하는데 이런 바인딩 오류를 처리하는 부분은 검증 부분에서 다룬다.

RequestParamController.modelAttributeV2

생략 가능한 @ModelAttribute 애노테이션

@RequestMapping("/model-attribute-v2")
@ResponseBody
public String modelAttributeV2(HelloData helloData) {
    log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());

    return helloData.toString();
}

🎃 @ModelAttribute는 생략할 수 있는데 @RequestParam도 생략이 가능하다. 그럼 이 HelloData는 어느 애노테이션이 생략되었는지 어떻게 판단해야 할까? 스프링은 해당 생략시 다음과 같은 규칙을 적용한다.
⇒ String, int, Integer 같은 단순 타입 = @RequestParam
⇒ 나머지 = @ModelAttribute (argument resolver로 지정해둔 타입은 제외)
⇒ argument resolver는 뒤에서 학습한다.

@ModelAttribute역시 처음부터 생략하지 말고, 일단은 쓰면서 아 지금 요청 파라미터를 가져와서 객체로 만들어준 것이구나(HelloData) 이해하면서 쓰자.

Chooooo

back-end, 지속 성장 가능한 개발자를 향하여

이전 포스트

[스프링 MVC 1편] - 스프링 MVC - 구조이해

다음 포스트

[스프링 MVC 1편] - 스프링 MVC - 기본 기능(1)