Spring MVC 기본기능- HTTP 요청 [ 요청파라미터, 요청메시지]

Spring

Spring MVC 기본기능- HTTP 요청 [ 요청파라미터, 요청메시지]

DAHLIA CHOI 2021. 8. 18. 17:15

💬 클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 3가지 방법을 이용한다.

◾ GET - 쿼리 파라미터

/?username=hello&age=20 이런 식으로 사용한다.
메시지 바디 없이, url의 쿼리 파라미터에 데이터를 포함해서 전달한다.
검색, 필터, 페이징에서 많이 사용

◾ POST - HTML Form

content-type : application/x-www-form-urlencoded 형식
메시지 바디에 쿼리 파라미터 형식으로 전달 (username=hello&age=20)
회원가입, 상품주문에서 많이 사용

◾ HTTP message body에 데이터를 직접 담아서 요청

HTTP API에서 주로 사용 (JSON, XML, TEXT)
데이터 형식은 주로 JSON사용
POST, PUT, PATCH

👉 GET방식과 HTML Form방식은 HttpServletRequest의 request.getParameter()사용하면 요청 파라미터 조회 가능

[ 요청 파라미터 ]

◼ 가장 기본적인 코드

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

@RequestMapping은 안에 있는 url과 맞는다면 밑에 있는 코드가 실행된다.
GET방식과 HTML Form 방식은 getParameter()로 조회가 가능하다.
response.getWriter().writer()는 페이지에 출력할 문자를 쓸 수 있다.

➕ POST방식으로 하려면 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>

이곳에 정보를 작성하면 /request-param-v1으로 이동해서 정보를 처리한다.

◼ getParameter() 대신 애노테이션으로 대체하기

@ResponseBody
@RequestMapping("/request-param-v2")
public String RequestParamV2(
	@RequestParam("username") String memberName,
	@RequestParam("age") int memberAge) {

	log.info("username={}, age={}", memberName, memberAge);
	return "ok";
}

➕ 매핑 정보와 변수 이름이 동일하다면 ""이름도 생략 가능

@ResponseBody
@RequestMapping("/request-param-v3")
public String RequestParamV3(
	@RequestParam String username,
	@RequestParam int age) {
            
	log.info("username={}, age={}", username, age);
	return "ok";
}

원래 string을 페이지에 출력되게 하려면 response.getWriter().write()를 사용했었는데,
@ResponseBody 애노테이션을 사용하면 그냥 문자열만 반환해도 문자열이 출력된다.

➕ 애노테이션도 생략 가능 ( 단, 요청 파라미터 형식이랑 맞아야 된다. )

@ResponseBody
@RequestMapping("/request-param-v4")
public String RequestParamV4(String username, int age) { 
	log.info("username={}, age={}", username, age);
	return "ok";
}

◼ required 추가

매핑 정보가 여러 개여도 꼭 필요한 정보와 꼭 필요하지 않은 정보가 존재한다.

그럴 때는 required를 추가해서 필요한 것인지 꼭 필요하지 않은 것인지 구별할 수 있다.

true는 꼭 필요한 요소, false는 없어도 되는 요소이다.

@ResponseBody
@RequestMapping("/request-param-required")
public String RequestParamRequired(
	@RequestParam(required = true) String username,
	@RequestParam(required = false) Integer age) {

	log.info("username={}, age={}", username, age);
	return "ok";
}

이 코드를 살펴보자면 username은 꼭 있어야 하는 파라미터이고, age는 입력하지 않아도 되는 파라미터이다.
* int는 디폴트 값이 null이 아니기 때문에 Integer로 형 변환해준다.

✍ 애노테이션을 생략해도 되는데 애노테이션을 생략하면 디폴트 값은 required=false를 적용한다.

localhost:8080/request-param-required?username=hello로 검색하면.

콘솔에 이렇게 출력된다.

➕ null같은 변수 디폴트 값이 아니라 내가 디폴트 값을 설정하고 싶다면 dafaultValue값을 지정하면 된다.

@RequestParam(required = true, defaultValue = "guest") String username;
@RequestParam(required = false, defaultValue = "-1") int age;

이렇게 바꾸면 된다.

◼ Map 사용하는 방법

@ResponseBody
@RequestMapping("/request-param-map")
public String RequestParamMap(@RequestParam Map<String, Object> paramMap) {

	log.info("username={}, age={}", paramMap.get("username"), paramMap.get("age"));
	return "ok";
}

Map으로 간단하게 묶을 수도 있다.
이렇게 되면 Map에 있는 username이랑 age를 가져와서 출력한다.
required도 이미 설정이 되어있어서 값을 적지 않을 경우에는 null로 입력된다.

✍ 파라미터 값이 1개가 확실하다면 Map을 사용해도 되는데 그렇지 않다면 MultiValueMap을 사용하는 편이 좋다.

하지만 파라미터 값이 여러 개일 경우는 별로 없다 ( 같은 key값에 value가 여러 개인 경우)

◼ ModelAttribute사용

실제 개발에서는 파라미터를 받아서 객체에 값을 넣어주는데, 이 과정을 ModelAttribute가 대신해준다.

먼저 클래스를 하나 만들어보자.

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

여기에서 @Data는 lombok 애노테이션인데, @Getter, @Setter, @EqualsAndHashCode, @RequiredArgsConstructor를 자동으로 적용해준다.

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

이렇게 @ModelAttribute를 사용하면 자동으로 객체에 파라미터 정보를 주입시켜주기 때문에 편하다.

⭐ @ModelAttribute는 생략 가능하다.

[ 요청 메시지 - TEXT ]

요청 파라미터와는 다르게 HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우는 @RequestParam, @ModelAttribute를 사용할 수 없다.

대신 InputStream을 사용해서 읽을 수 있다.

InputStream은 HTTP 요청 메시지 바디의 내용을 직접 조회한다.

◼ 기본적인 방법

    @PostMapping ("/request-body-string-v1")
    public void requestBodyString(HttpServletRequest request, HttpServletResponse response) throws IOException {
        ServletInputStream inputStream = request.getInputStream();
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
        log.info("messageBody={}", messageBody);
        response.getWriter().write("ok");
    }

⭐ steam은 바이트 코드여서 항상 어떤 인코딩으로 해서 바꿀 건지 지정해줘야 된다.

포스트맨을 사용해서 메시지 바디에 정보를 담아보자!

위 코드를 출력해보면 콘솔에 이렇게 나온다.

◼ InputStream 미리 선언하기

    @PostMapping("/request-body-string-v2")
    public void requestBodyStringV2(InputStream inputStream, Writer responseWriter) throws IOException {
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

        log.info("messageBody={}", messageBody);
        responseWriter.write("ok");
    }

◼ HttpEntity 사용

HttpEntity를 사용하면 HTTP header, body 정보를 편리하게 조회할 수 있다.

    @PostMapping("/request-body-string-v3")
    public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) throws IOException {
        String messageBody = httpEntity.getBody();
        log.info("messageBody={}", messageBody);
        return new HttpEntity<>("ok");
    }

HttpEntity<String>으로 하면 문자인 것을 확인하고, http body에 있는 걸 문자로 넘겨준다는 뜻이다.
http 메시지 컨버터가 동작한다.

◼ RequestBody 사용

@RequestBody를 사용하면 HTTP 메시지 바디의 정보를 편리하게 조회할 수 있다.

만약 헤더 내용이 필요하다면 위에서 사용한 HttpEntity( or @RequestHeader)를 사용하면 된다.

@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) throws IOException {
	log.info("messageBody={}", messageBody);
	return "ok";
}

[ 요청 메시지 - JSON ]

{"username":"hello", "age":20} 이 방법이 JSON 형식으로 데이터를 보내는 것이다.

private ObjectMapper objectMapper = new ObjectMapper();

objectMapper()를 사용하기 위에서 private를 먼저 선언해준다.

◼ 기본적인 방법

    @PostMapping("/request-body-json-v1")
    public void requestBodyJsonV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
        ServletInputStream inputStream = request.getInputStream();
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

        log.info("messageBody={}", messageBody);
        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
        log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());

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

👉 POSTMAN으로 실행한 결과

콘솔 창에는 이렇게 출력된다.

◼ RequestBody 사용

    @ResponseBody
    @PostMapping("/request-body-json-v2")
    public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {

        log.info("messageBody={}", messageBody);
        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
        log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
        return "ok";
    }

text에 사용했던 @RequestBody를 사용할 수도 있다.

➕ @RequestBody에 직접 만든 객체를 지정할 수도 있다. 그럼 객체를 안에서 따로 선언하지 않아도 됨

    @ResponseBody
    @PostMapping("/request-body-json-v3")
    public String requestBodyJsonV3(@RequestBody HelloData data){

        log.info("username={}, age={}", data.getUsername(), data.getAge());
        return "ok";
    }

⭐ @RequestBody는 생략하면 절대 안 된다!!!

➕ 객체를 반환해도 된다.

    @ResponseBody
    @PostMapping("/request-body-json-v5")
    public HelloData requestBodyJsonV5(@RequestBody HelloData data){

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

이렇게 반환된 객체의 정보가 페이지에 출력된다.

◼ HttpEntity 사용

앞에서 사용했던 HttpEntity를 사용해도 된다.

    @ResponseBody
    @PostMapping("/request-body-json-v4")
    public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity){
        HelloData data = httpEntity.getBody();
        log.info("username={}, age={}", data.getUsername(), data.getAge());

        return "ok";
    }

스프링 mvc를 사용하면서 스프링이 제공해주는 기능들을 사용하면서 코드의 길이를 줄여나가니까 왜 스프링을 사용하는지 또 한 번 느꼈다... 오히려 너무 많은 방법이 있어서 헷갈릴 지경이다ㅋㅋㅋㅋㅋ 난 짧은 게 좋아!

이 포스팅은 인프런 김영한님의 [스프링MVC 1편 - 백엔드 웹개발 핵심 기술]을 듣고 작성된 복습 겸 정리 포스팅입니다.

저작자표시