[TIL] #5. 스프링 MVC - 구조 이해

스프링 MVC 전체 구조

지난 시간까지 직접 만들었던 MVC 프레임워크와 스프링 MVC를 비교해보자!

✔ 직접 만든 MVC 프레임워크

✔ SpringMVC 구조

놀랍게도 구조가 똑같다..!

사실 강사님이 지금까지 스프링 MVC를 단계적으로 알려주셨던 것이었다..!
(이름은 살짝 다르다.)

---

DispatcherServlet 구조 살펴보기

⭐ 스프링 MVC의 핵심, 디스패처 서블릿

스프링 MVC의 프론트 컨트롤러는 바로 디스패처 서블릿(DispatcherServlet)이다.

✔ DispatcherServlet 서블릿 등록

• DispacherServlet도 부모 클래스에서 HttpServlet을 상속 받아서 사용하고, 서블릿으로 동작한다.
  • DispatcherServlet → FrameworkServlet → HttpServletBean → HttpServlet
• 스프링 부트는 DispacherServlet을 서블릿으로 자동으로 등록하면서 모든 경로(urlPatterns="/")에 대해서 매핑한다.

✔ 요청 흐름

1. 서블릿 호출 → HttpServlet이 제공하는 serivce()가 호출됨.
2. 스프링 MVC는 DispatcherServlet의 부모인 FrameworkServlet에서 service()를 오버라이드 해두었다.
3. FrameworkServlet.service()를 시작으로 여러 메서드가 호출되면서 DispatcherServlet.doDispatch()가 호출된다.

---

SpringMVC 구조

✔ 동작 순서

1. 핸들러 조회: 핸들러 매핑을 통해 요청 URL에 매핑된 핸들러(컨트롤러) 조회
2. 핸들러 어댑터 조회: 핸들러를 실행할 수 있는 핸들러 어댑터 조회
3. 핸들러 어댑터 실행: 핸들러 어댑터 실행
4. 핸들러 실행: 핸들러 어댑터가 실제 핸들러 실행
5. ModelAndView 반환: 핸들러가 반환하는 정보를 핸들러 어댑터가 ModelAndView로 변환해서 반환
6. viewResolver 호출: 뷰 리졸버를 찾아 실행
   • JSP의 경우: InternalResourceViewResolver가 자동 등록되고 사용됨
7. View 반환: 뷰 리졸버는 뷰의 논리 이름을 물리 이름으로 바꾸고, 렌더링 역할을 담당하는 뷰 객체 반환
   • JSP의 경우: InternalResourceView(JstlView)를 반환하는데, 내부에 forward() 로직이 있음
8. 뷰 렌더링: 뷰 통해서 뷰 렌더링

💡 스프링 MVC의 큰 강점

DispatcherServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다!

---

핸들러 매핑과 핸들러 어댑터

이전에는 핸들러 매핑과 핸들러 어댑터를 단순하게 Map, List를 이용해서 사용했다.

(지금은 전혀 사용하지 않지만) SpringMVC에서는 어떻게 핸들러 매핑과 핸들러 어댑터를 사용하는지 알아보자!

---

Controller 인터페이스

✔ 과거 버전 스프링 컨트롤러

과거 버전의 스프링 컨트롤러 인터페이스인 Controller를 구현하는 OldController를 만들어보자.

🔗 전체 코드 확인하기

• @Component: 이 컨트롤러는 /springmvc/old-controller라는 이름의 스프링 빈으로 등록되었다.
• 빈의 이름으로 URL을 매핑할 것이다.

실행 결과

http://localhost:8080/springmvc/old-controller로 접속하면 다음과 같이 OldController가 잘 호출되었다는 것을 확인할 수 있다!

✔ 컨트롤러 호출하기 위해 필요한 두 가지

1. HandlerMapping (핸들러 매핑)

• 핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다.
• Ex) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요하다.

2. HandlerAdapter (핸들러 어댑터)

• 핸들러 매핑을 통해 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
• Ex) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾아야 한다.

---

HttpRequestHandler

HttpRequestHandler 핸들러(컨트롤러)는 서블릿과 가장 유사한 형태의 핸들러이다.

핸들러 매핑과, 어댑터를 더 잘 이해하기 위해 Controller 인터페이스가 아닌 다른 핸들러를 알아보자.

(코드는 위의 링크 참고)

✔ 실행 결과

---

뷰 리졸버

이번에는 뷰 리졸버에 대해 알아보자!

OldController - View 조회할 수 있도록 변경

package hello.servlet.web.springmvc.old;

import org.springframework.stereotype.Component;
import org.springframework.ui.Model;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component("/springmvc/old-controller")
public class OldController implements Controller {

    @Override
    public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        System.out.println("OldController.handleRequest");
        return new ModelAndView("new-form");
    }
}

• View를 사용할 수 있도록 return new ModelAndView("new-form"); 코드를 추가했다!

✔ 실행 결과

http://localhost:8080/springmvc/old-controller를 실행하면 Whitelabel Error Page 오류가 발생하지만 컨트롤러는 제대로 호출된다!

new-form이라는 viewPath를 물리 이름으로 바꾸기 위해서는 상위 경로(prefix)와 확장자 정보가 필요하기 때문이다!

지금은 이와 관련된 동작이 따로 없어서 속성 파일에 코드를 추가해주어야 한다.

✔ 오류 해결

이를 해결하기 위해서 application.properties에 다음과 같은 코드를 추가해주자.

spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp

이제 페이지도 제대로 나온다!

---

뷰 리졸버 동작 방식

✔ 스프링 부트 구동 시 자동 등록하는 뷰 리졸버

실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략!

1 = BeanNameViewResolver : 빈 이름으로 뷰를 찾아서 반환한다. (예: 엑셀 파일 생성 기능에 사용)
2 = InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다.

현재 new-form으로 등록된 빈이 없어서,
그 다음 우선순위인 InternalResourceViewResolver가 호출된다!

✔ 흐름

1. 핸들러 어댑터 호출

• 핸들러 어댑터를 통해 논리 뷰 이름(new-form)을 획득한다.

2. ViewResolver 호출

• 뷰 이름(new-form )으로 viewResolver를 순서대로 호출한다.
• BeanNameViewResolver는 new-form 이라는 이름의 스프링 빈으로 등록된 뷰를 찾아야 하는데 없다!
  → InternalResourceViewResolver가 호출된다.

3. InternalResourceViewResolver

• 이 뷰 리졸버는 InternalResourceView를 반환한다.

4. 뷰 - InternalResourceView

• InternalResourceView는 JSP처럼 포워드(forward())를 호출해서 처리할 수 있는 경우에 사용한다.

5. view.render()

• view.render()가 호출되고 InternalResourceView는 forward() 를 사용해서 JSP를 실행한다.

---

스프링 MVC - 시작하기

이제 스프링에서 제공하는 애노테이션을 기반으로 컨트롤러를 구현해 동작을 확인해보자!

@RequestMapping

가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping, RequestMappingHandlerAdapter이다.

@RequestMapping의 앞글자를 따서 만든 이름인데, 이것이 바로 지금 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 핸들러 매핑과 어댑터이다.

---

회원 등록/저장/조회 컨트롤러

🔗 전체 코드 확인하기

✔ SpringMemberFormControllerV1 - 회원 등록 컨트롤러

• @Controller
  • 스프링이 자동으로 스프링 빈으로 등록한다.
  • 스프링 MVC에서 애노테이션 기반 컨트롤러로 인식한다.
• @RequestMapping: 요청 정보를 매핑한다. 해당 URL이 호출되면 이 메서드가 호출된다.
• ModelAndView: 모델과 뷰 정보를 담아서 반환하면 된다.

✔ SpringMemberSaveControllerV1 - 회원 저장

• mv.addObject("member", member): 스프링이 제공하는 ModelAndView를 통해 Model 데이터를 추가할 때는 addObject()를 사용하면 된다.

실행 결과

모두 다 잘 나온다!

---

스프링 MVC - 컨트롤러 통합

이전까지는 기능별로 파일을 분리했는데, 사실 동일한 데이터에 접근하는 간단한 기능이므로 한 파일로 통합할 수도 있다!

SpringMemberControllerV2

package hello.servlet.web.springmvc.v2;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

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

@Controller
@RequestMapping("/springmvc/v2/members")
public class SpringMemberControllerV2 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @RequestMapping("/new-form")
    public ModelAndView newForm() {
        return new ModelAndView("new-form");
    }

    @RequestMapping("/save")
    public ModelAndView save(HttpServletRequest request, HttpServletResponse response) {

        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));

        Member member = new Member(username, age);
        memberRepository.save(member);

        ModelAndView mav = new ModelAndView("save-result");
        mav.addObject("member", member);
        return mav;
    }

    @RequestMapping
    public ModelAndView members() {

        List<Member> members = memberRepository.findAll();

        ModelAndView mav = new ModelAndView("members");
        mav.addObject("members", members);
        return mav;
    }
}

모든 메서드마다 /springmvc/v2/members 부분이 중복되었는데 클래스 레벨에 @RequestMapping을 두어서 중복을 제거할 수 있었다!

실행 결과

---

스프링 MVC - 실용적인 방식

SpringMemberControllerV3

package hello.servlet.web.springmvc.v3;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

@Controller
@RequestMapping("/springmvc/v3/members")
public class SpringMemberControllerV3 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @GetMapping("/new-form")
    public String newForm() {
        return "new-form";
    }

    @PostMapping("/save")
    public String save(
            @RequestParam("username") String username,
            @RequestParam("age") int age,
            Model model) {

        Member member = new Member(username, age);
        memberRepository.save(member);

        model.addAttribute("member", member);
        return "save-result";
    }

    @GetMapping
    public String members(Model model) {
        List<Member> members = memberRepository.findAll();
        model.addAttribute("members", members);
        return "members";
    }
}

✔ Model 파라미터

save(), members()에서 Model을 파라미터로 받는다.

✔ ViewName 직접 반환

애노테이션 기반의 컨트롤러는 ModelAndView 뿐만 아니라 viewName을 직접 반환 받아도 동작한다.

✔ @RequestParam 사용

• 스프링은 HTTP 요청 파라미터를 @RequestParam으로 받을 수 있다.
• @RequestParam("username")은 request.getParameter("username")와 거의 같은 코드!

✔ @RequestMapping → @GetMapping, @PostMapping

• @RequestMapping은 URL만 매칭하는 것이 아니라, HTTP Method도 함께 구분할 수 있다.
• @GetMapping, @PostMapping을 이용하여 GET, POST를 구분하여 요청받을 수 있다.

GetMapping("/new-form")일 때,

GET요청은 잘 실행되고. (200 OK)

POST 요청을 하면 이렇게 에러가 나는 것을 확인할 수 있다!