Blog-Shine

BackEnd/Spring MVC

[Spring] 스프링 MVC - 구조 이해

샤아이인 2022. 2. 25.

내가 공부한것을 올리며, 중요한 단원은 저 자신도 곱씹어 볼겸 상세히 기록하고 얕은부분들은 가겹게 포스팅 하겠습니다.

 

 

1. 스프링 MVC 전체 구조

스프링 MVC도 프론트 컨트로러 패턴으로 구현되어있다. MVC의 프론트 컨트롤러가 바로 DisaptcherServlet 이다.

 

● DispacherServlet 서블릿 등록

DispacherServlet 도 부모 클래스에서 HttpServlet 을 상속 받아서 사용하고, 서블릿으로 동작한다.

DispatcherServlet => FrameworkServlet => HttpServletBean => HttpServlet

 

스프링 부트는 DispacherServlet 을 서블릿으로 자동으로 등록하면서 모든 경로( urlPatterns="/" )에 대해서 매핑한다.

참고: 더 자세한 경로가 우선순위가 높다. 그래서 기존에 등록한 서블릿도 함께 동작한다.

 

● DispatcherServlet의 요청 흐름을 알아보자. (개인적으로 관련 서적 공부후 추가 요약한 부분입니다)

위의 사진을 보면 <스프링 빈으로 등록> 이라 되어있는 부분은 스프링 빈으로 등록되어야 하는 것을 의미합니다.

또한 초록색 박스의 JSP, 컨트롤러는 개발자가 직접 구현해고 스프링 빈으로 등록해야 하는 요소 입니다.

 

중앙에 위치한 DispatcherServlet은 모든 연결을 담당합니다. 가장 핵심이 되는 부분입니다.

 

Client로부터 요청이 들어오면 DispatcherServlet은 그 요청을 처리하기 위해서 HandlerMapping 이라는 빈 객체를 통하여 컨트롤러를 검색하게 됩니다. (그림에서 2번 과정)

HandlerMapping은 Clinet의 요청에 따라서 이를 처리할 컨트롤러 빈 객체를 DispatcherServlet에 전달하게 됩니다.

컨트롤러 빈 객체를 DispatcherServlet가 전달받았다고 해서 바로 컨트롤러 객체의 메서드를 실행하는 것 이 아닙니다!

 

DispatcherServlet은 @Controller 애노테이션을 이용해서 구현한 컨트롤러 뿐만 아니라,

스프링 2.5까지 주로 사용했었던 Controller 인터페이스를 구현한 컨트롤러,

특수목적으로 사용되는 HttpRequestHandler 인터페이스를 구현한 클래스를

모두 동일한 방식으로 실행할 수 있도록 만들어 집니다.

위의 3가지 동일한 방식으로 처리하기 위해 중간에 사용되는 것 이 바로! HandlerAdapter 빈 입니다!

따라서 DispatcherServlet는 전달받은 컨트롤러 객체를 처리할 수 있는 HandlerAdapter를 찾아 요청을 위임하게 됩니다. (그림의 3번과정)

 

HandlerAdapter는 컨트롤러의 알맞은 메서드를 호출하여 요청을 처리하고(4, 5번 과정) 처리결과를 다시 ModelAndView 라는 객체로 변환하여 DispatcherServlet에 반환하게 됩니다.(6번 과정)

 

이후 DispatcherServlet는 결과를 보여줄 뷰를 찾기위해 ViewResolver 빈 객체를 사용하게 됩니다. (7번 과정)

ModelAndView는 컨트롤러가 반환한 뷰 이름을 담고 있는데, ViewResolver는 이 뷰 이름에 해당하는 view객체를 찾거나 생성해서 리턴하 됩니다.

 

응답을 생성하기 위해 JSP를 사용하는 ViewResolver는 매번 새로운 View 객체를 생성해서 DispathcerServlet에 리턴합니다.

DispathcerServlet은 ViewResolver 가 리턴한 View 객체에 응답 결과 생성을 요청하게 됩니다. (8번 과정)

JSP를 사용한다면 View 객체는 JSP를 실행할 때 웹 브라우저에 전송할 응답 결과를 생성하고 끝나게 됩니다.

 

위의 과정을 코드로 좀더 확인해 봅시다.

 

서블릿이 호출되면 HttpServlet의 service()메서드가 호출됩니다.

스프링 MVC는 DispatcherServlet 의 부모인 FrameworkServlet 에서 service() 를 오버라이드 하고있죠!

FrameworkServlet.service() 를 시작으로 여러 메서드가 호출되면서 DispacherServlet.doDispatch() 가 호출됩니다.

 

● DispacherServlet 의 핵심인 doDispatch() 코드를 분석해보자.

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {

    HttpServletRequest processedRequest = request;
    HandlerExecutionChain mappedHandler = null;
    ModelAndView mv = null;

    // 1. 핸들러 조회
    mappedHandler = getHandler(processedRequest); 
    if (mappedHandler == null) {
         noHandlerFound(processedRequest, response);
         return; 
    }

    //2.핸들러 어댑터 조회-핸들러를 처리할 수 있는 어댑터
    HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

    // 3. 핸들러 어댑터 실행 -> 4. 핸들러 어댑터를 통해 핸들러 실행 -> 5. ModelAndView 반환 
    mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

    processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
}

private void processDispatchResult(HttpServletRequest request,
HttpServletResponse response, HandlerExecutionChain mappedHandler, ModelAndView
mv, Exception exception) throws Exception {

    // 뷰 렌더링 호출
    render(mv, request, response); 렌더링 한다는 사실이 중요!!!
}

protected void render(ModelAndView mv, HttpServletRequest request, HttpServletResponse response) 
throws Exception {
    View view;
    String viewName = mv.getViewName(); 

    //6. 뷰 리졸버를 통해서 뷰 찾기, 7.View 반환
    view = resolveViewName(viewName, mv.getModelInternal(), locale, request);

    // 8. 뷰 렌더링
    view.render(mv.getModelInternal(), request, response);
}
 

추가로 viewResolver를 호출할때 JSP의 경우 InternalResourceViewResolver 가 자동 등록되고, 사용된다.

또한 viewResolver가 View를 반환할때 JSP의 경우 InternalResourceView(JstlView) 를 반환하는데, 내부에 forward() 로직이 있다.

 

● 인터페이스 살펴보기

스프링 MVC의 큰 강점은 DispatcherServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다는 점이다.

지금까지 설명한 대부분을 확장 가능할 수 있게 인터페이스로 제공한다.

이 인터페이스들만 구현해서 DispatcherServlet 에 등록하면 여러분만의 컨트롤러를 만들 수도 있다.

 

● 주요 인터페이스 목록

- 핸들러 매핑: org.springframework.web.servlet.HandlerMapping

- 핸들러 어댑터: org.springframework.web.servlet.HandlerAdapter

- 뷰 리졸버: org.springframework.web.servlet.ViewResolver

- 뷰: org.springframework.web.servlet.View

 

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

지금은 거의 사용하지 않지만, 과거에 주로 사용했던 스프링이 제공하는 간단한 컨트롤러로 핸들러 매핑과 어댑터를 이해해보자.

 

● Controller 인터페이스

public interface Controller {
    ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
}
 

이를 활용한 간단한 컨트롤러를 작성해 봅시다.

@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 null;
    }
}
 

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

 

http://localhost:8080/springmvc/old-controller 로 접속하면 정상적으로 컨트롤러가 호출되는것을 알 수 있다.

 

컨트롤러가 정상적으로 호출되려면 2가지가 필요하다.

● HandlerMapping(핸들러 매핑)

- 핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다.

- 예) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요하다.

 

● HandlerAdapter(핸들러 어댑터)

- 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.

- 예) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다.

 

스프링 부트가 자동 등록하는 핸들러 매핑과 핸들러 어댑터 는 다음과 같다.

 

HandlerMapping (숫자는 우선순위)

0 = RequestMappingHandlerMapping : 애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1 = BeanNameUrlHandlerMapping : 스프링 빈의 이름으로 핸들러를 찾는다.
 

위에서 우리는 Controller인터페이스를 구현한 컨트롤러를 만들때 Component로 이름을 지정하였다.

따라서 1번 방식을 사용하게 된다.

 

HandlerAdapter

0 = RequestMappingHandlerAdapter : 애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1 = HttpRequestHandlerAdapter : HttpRequestHandler 처리
2 = SimpleControllerHandlerAdapter : Controller 인터페이스(애노테이션X, 과거에 사용) 처리
 

우리의 컨트롤러는 애노테이션 기반이 아니라 0번은 아니다.

그다음으로 HttpRequestHandler 또한 아니기에 1번도 아니다.

최종적으로 Controller 인터페이스를 구현하였기 때문에 2번의 handlerAdapter를 사용하게 된다.

 

1. 핸들러 매핑으로 핸들러 조회

HandlerMapping 을 순서대로 실행해서, 핸들러를 찾는다.

이 경우 빈이름으로 핸들러를 찾아야 하기 때문에 이름그대로 빈이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping 가 실행에 성공하고 핸들러인 OldController 를 반환한다.

 

2. 핸들러 어댑터 조회

HandlerAdapter 의 supports() 를 순서대로 호출한다. SimpleControllerHandlerAdapter 가 Controller 인터페이스를 지원하므로 대상이 된다.

 

3. 핸들러 어댑터 실행

디스패처 서블릿이 조회한 SimpleControllerHandlerAdapter 를 실행하면서 핸들러 정보도 함께 넘겨준다.

SimpleControllerHandlerAdapter 는 핸들러인 OldController 를 내부에서 실행하고, 그 결과를 반환한다.

 

3. 뷰 리졸버

기존의 코드에서 ModelAndView("new-form")을 반환하도록 수정하였다.

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

http://localhost:8080/springmvc/old-controller 로 접속해보자.

브라우저 상에서는 Error page가 나오지만, 콘솔에서는 "OldController.handleRequest"이 정상출력되고 있다.

이는 컨트롤러를 찾은후, 어댑터를 통하여 실행까지는 잘 됬다는 의미이다.

 

하지만 뷰 리졸버가 정상작동하지 못하여 랜더링을 하지 못하는 상황이다.

application.properties에 다음 코드를 추가해보자.

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

● 뷰 리졸버 - InternalResourceViewResolver

스프링 부트는 InternalResourceViewResolver 라는 뷰 리졸버를 자동으로 등록하는데, 이때 application.properties 에 등록한 spring.mvc.view.prefix , spring.mvc.view.suffix 설정 정보를 사용해서 등록한다.

 

뷰 리졸버를 위한 prefix, suffix를 추가하니 정상적으로 작동함을 알 수 있다.

 

스프링 부트가 자동적으로 등록하는 뷰 리졸버(여러개중 2개만 적은것)

1 = BeanNameViewResolver : 빈 이름으로 뷰를 찾아서 반환한다.
2 = InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다.
 

1. 핸들러 어댑터 호출

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

 

2. ViewResolver 호출

new-form 이라는 뷰 이름으로 viewResolver를 순서대로 호출한다.

BeanNameViewResolver 는 new-form 이라는 이름의 스프링 빈으로 등록된 뷰를 찾아야 하는데 없다.

따라서 2번째인 InternalResourceViewResolver 가 호출된다.

 

3. InternalResourceViewResolver

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

 

4. 뷰 - InternalResourceView

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

 

5. view.render()

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

 

4. 스프링 MVC - 시작하기

@RequestMapping

스프링은 애노테이션을 활용한 매우 유연하고, 실용적인 컨트롤러를 만들었는데 이것이 바로 @RequestMapping 애노테이션을 사용하는 컨트롤러이다.

 

@RequestMapping 을 사용한 컨트롤러를 누가 찾아주고?, 그 찾은 컨트롤러를 어떤 어댑터가 실행해 줄까?

-> RequestMappingHandlerMapping (컨트롤러를 찾아줌)

-> RequestMappingHandlerAdapter (찾은 컨트롤러를 실행할 어댑터)

위 2가지가 그 역할을 한다.

 

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

실무에서는 99% 이방식의 컨트롤러를 사용한다.

 

그럼 본격적으로 @RequestMapping기반의 스프링 MVC 컨트롤러를 만들어보자.

 

● SpringMemberFormControllerV1 - 회원 등록 폼

@Controller
public class SpringMemberFormControllerV1 {

    @RequestMapping("/springmvc/v1/members/new-form")
    public ModelAndView process() {
        return new ModelAndView("new-form");
    }
}
 

- @Controller

스프링이 자동으로 스프링 빈으로 등록한다. 내부에 @Component 애노테이션이 있어서 가능하다.

스프링 MVC에서 애노테이션 기반 컨트롤러로 인식한다.

 

- @RequestMapping

요청 정보를 매핑한다. 해당 URL이 호출되면 이 메서드가 호출된다. 애노테이션을 기반으로 동작하기 때문에, 메서드의 이름은 임의로 지으면 된다.

 

- ModelAndView

모델과 뷰 정보를 담아서 반환하면 된다.

 

중요!!

 

RequestMappingHandlerMapping 은 스프링 빈 중에서 @RequestMapping 또는 @Controller 가 클래스 레벨에 붙어 있는 경우에 매핑 정보로 인식한다.(사용 가능한 컨트롤러로 인식한다) 다음 코드를 살펴보자.

public class RequestMappingHandlerMapping extends RequestMappingInfoHandlerMapping
		implements MatchableHandlerMapping, EmbeddedValueResolverAware {

    // 생략...
	@Override
	protected boolean isHandler(Class<?> beanType) {
		return (AnnotatedElementUtils.hasAnnotation(beanType, Controller.class) ||
				AnnotatedElementUtils.hasAnnotation(beanType, RequestMapping.class));
	}
    // 생략...
}
 

RequestMappingHandlerMapping 클래스 안에 isHandler()라는 메서드를 사용하여 @RequestMapping 또는 @Controller 인지를 확인한다. boolean값으로 true를 받게되면 해당 컨트롤러를 필요할때 반환할 수 있다.

 

또한 위의 코드에서 @Controller 대신 @Compnent를 사용하여 컴포넌트 스캔의 대상으로 만든 후, @RequestMapping을 추가해주면 HandlerMapping이 해당 클래스를 컨트롤러로 인식할수 있다. 따라서 필요할때 컨트롤러를 찾을 수 있다.

@Component //컴포넌트 스캔을 통해 스프링 빈으로 등록 
@RequestMapping
public class SpringMemberFormControllerV1 {

      @RequestMapping("/springmvc/v1/members/new-form")
      public ModelAndView process() {
          return new ModelAndView("new-form");
      }

}
 

 

● SpringMemberSaveControllerV1 - 회원 저장

@Controller
public class SpringMemberSaveControllerV1 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @RequestMapping("/springmvc/v1/members/save")
    public ModelAndView process(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 mv = new ModelAndView("save-result");
        mv.addObject("member", member);
        return mv;
    }
}
 

- mv.addObject("member", member)

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

이 데이터는 이후 뷰를 렌더링 할 때 사용된다.

 

● SpringMemberListControllerV1 - 회원 목록

@Controller
public class SpringMemberListControllerV1 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @RequestMapping("/springmvc/v1/members")
    public ModelAndView process() {
        List<Member> members = memberRepository.findAll();
        ModelAndView mv = new ModelAndView("members");
        mv.addObject("members", members);

        return mv;
    }
}
 
 

5. 스프링 MVC - 컨트롤러 통합

@RequestMapping 을 잘 보면 클래스 단위가 아니라 메서드 단위에 적용된 것을 확인할 수 있다.

따라서 컨트롤러 클래스를 유연하게 하나로 통합할 수 있다.

@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 mv = new ModelAndView("save-result");
        mv.addObject("member", member);
        return mv;
    }

    @RequestMapping
    public ModelAndView members() {
        List<Member> members = memberRepository.findAll();
        ModelAndView mv = new ModelAndView("members");
        mv.addObject("members", members);

        return mv;
    }
}
 

조합 결과

클래스 레벨 @RequestMapping("/springmvc/v2/members")

- 메서드 레벨 @RequestMapping("/new-form") => /springmvc/v2/members/new-form

- 메서드 레벨 @RequestMapping("/save") => /springmvc/v2/members/save

- 메서드 레벨 @RequestMapping => /springmvc/v2/members

 

6. 스프링 MVC - 실용적인 방식

MVC 프레임워크 만들기에서 v3은 ModelView를 개발자가 직접 생성해서 반환했기 때문에, 불편했던 난다.

물론 v4를 만들면서 String을 반환하게 함으로써 실용적으로 개선한 기억도 날 것이다.

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

    private MemberRepository memberRepository = MemberRepository.getInstance();

    //@RequestMapping(value = "/new-form", method = RequestMethod.GET)
    @GetMapping("/new-form")
    public String newForm() {
        return "new-form";
    }

    //@RequestMapping("/save", method = RequestMethod.POST)
    @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";
    }

    //@RequestMapping(method = RequestMethod.GET)
    @GetMapping
    public String members(Model model) {
        List<Member> members = memberRepository.findAll();
        model.addAttribute("members", members);

        return "members";
    }
}
 

1) FrontController 로부터 넘어온 Model 파라미터 사용

 

2) ViewName을 직접 반환, 즉 논리적 이름을 반환한다.

 

3) @RequestParam을 통한 파라미터 인자 추출

 

4) @RequestMapping, @GetMapping, @PostMapping

@RequestMapping 은 URL만 매칭하는 것이 아니라, HTTP Method도 함께 구분할 수 있다.

예를 들어서 URL이 /new-form 이고, HTTP Method가 GET인 경우를 모두 만족하는 매핑을 하려면 다음과 같이 처리하면 된다.

@RequestMapping(value = "/new-form", method = RequestMethod.GET)
 

이를 @GetMapping("/new-form")으로 더 편리하게 사용할 수 있다.

 

저작자표시

'BackEnd > Spring MVC' 카테고리의 다른 글

[Spring] 스프링 MVC - 기본 기능 - 2  (0) 2022.02.27
[Spring] 스프링 MVC - 기본 기능 - 1  (0) 2022.02.26
[Spring] MVC 프레임워크 만들기 - 2  (0) 2022.02.23
[Spring] MVC 프레임워크 만들기 - 1  (0) 2022.02.19
[Spring] 서블릿, JSP, MVC 패턴  (0) 2022.02.17

댓글

티스토리툴바