[Spring][혼공] 4. 스프링 웹 개발 기초 - API (3)

스프링 웹 개발 기초

3. API

MVC는 변환된 html을 웹 브라우저에게 반환하는 방식이고 (xml)

API는 데이터를 바로 그대로 내려주는 방식이다. (json)

 

1) 문자 반환

Controller

• 기존에 구현한 HelloController 안에 새로운 메서드를 추가할 것이다.
• viewResolver를 사용하지 않고 HTTP의 응답 body에 데이터를 직접 반환할 것이다. (@ResponseBody)

@GetMapping("hello-string")
@ResponseBody
public String helloString(@RequestParam("name") String name) {
    return "hello " + name;
}

 

실행 화면

이전에 작업했던 MVC 방식과 별 차이가 없어 보인다.

http://localhost:8080/hello-string?name=spring?!

 

하지만, 페이지 소스 보기를 하면 차이점이 나타난다.

html Tag가 보이지 않고 오직 입력한 문자만 보인다.

view-source:http://localhost:8080/hello-string?name=spring?!

 

2) 객체 반환

Controller

• 기존에 구현한 HelloController 안에 새로운 메서드 및 클래스를 추가할 것이다.

@GetMapping("hello-api")
@ResponseBody
public Hello helloApi(@RequestParam("name") String name)
    Hello hello = new Hello();
    hello.setName(name);
    return hello;
}

// static으로 만들면 클래스 안에서 클래스를 사용할 수 있다.
static class Hello { // 반환할 객체
    private String name;
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
}

 

실행 화면

문자를 반환한 것과 다른 결과 화면이 나타났다.

객체를 반환하면 객체가 Json으로 변환되어 반환된다.

http://localhost:8080/hello-api?name=spring?!??

 

3) 동작 방식

웹 브라우저에서 어떤 페이지를 던지면 내장 톰캣 서버가 받아서 스프링한테 전달한다.
전달받은 스프링은 매칭 가능한 컨트롤러를 찾아 해당 메서드를 실행시킨다. (@GetMapping)

 

@ResponseBody는 HTTP의 응답 body에 그대로 데이터를 넘기도록 동작한다.

이때, 넘겨야 하는 데이터가 문자라면 바로 반환하고

객체라면 json 방식으로 데이터를 만들어 반환하도록 default가 설정되어 있다.

 

변환을 하기 위해 HttpMessageConverter가 동작하는데,

기본 문자 처리는 StringHttpMessageConverter에서 하고

기본 객체 처리는 MappingJackson2HttpMessageConverter에서 한다.

 

추가로 byte 처리 등 여러 HttpMessageConverter가 기본으로 등록되어 있다.

클라이언트의 HTTP Accept 헤더와 서버의 컨트롤러 반환 타입 정보를 조합해서 선택한다.

 

그 후 변환된 데이터를 요청한 서버나 웹 브라우저로 반환한다.

동작 환경