Spring MVC 개발환경 세팅 / Dispatcher Servlet / View Resolver

tomcat 9.0.3, sts 4.9.0 다운로드

sts 실행 후 perspective Java EE로 설정

Java EE가 없을 때는 Help > Install New Software > work with에 http://download.eclipse.org/releases/2020-12

> web,xml,java ee and OSGi Enterprise Develoment 설치

Create a Maven project - Create a simple project 선택

프로젝트가 열리면 pom.xml에 빨간줄이 뜨는데, web.xml이 없기 때문이다.

src - main - webapp 안에 톰캣 디렉토리 안 ROOT - WEB-INF(안에 web.xml 파일 있음)를 복사해 와서 붙인다.

pom.xml의 Overview에서 Packaging을 war으로 바꾸고 Properties를 설정한다.

저장하고 메이븐 업데이트를 하면 소스의 properties 태그가 추가되어 있음을 확인할 수 있다.

pom.xml

<properties>
  	<maven.compiler.source>1.8</maven.compiler.source>
  	<maven.compiler.target>1.8</maven.compiler.target>
  </properties>

관련 라이브러리를 추가하기 위해 Maven Repository 접속, tomcat-api 9.0.30과 spring-webmvc 5.2.9를 pom.xml에 추가한다.

Maven Repository에 접속하지 않고도 라이브러리를 가져오는 방법도 있다.

Show View에서 Maven - Maven Repositories 선택, Global Repositories - central 우클릭 - Rebuild Index하면 원격에 있는 Repository들을 인덱싱해서 sts 안에서 검색해서 쓸 수 있다. 원격에 있는 라이브러리의 목록을 가져오는 과정이며, 인덱싱을 한 후에는 pom.xml의 Dependencies 탭에서 Add를 눌러 검색해서 추가하면 된다. (시간이 너무 오래 걸리므로 이 과정은 스킵했다. 최소 한 시간 이상 소요)

Java Resources 안의 메이븐 디펜던시를 펼쳐보면 직접 추가한 tomcat-api, spring-webmvc 외에도 다른 라이브러리들이 추가되었음을 확인할 수 있다. 메이븐이 라이브러리를 추가하면서 필요하다고 판단한 서브 라이브러리를 자동으로 추가하는 것이다. (=>메이븐의 장점)

Dependency Hierarchy 탭에서 서브 라이브러리를 확인할 수 있다.

프론트 컨트롤러의 역할을 할 서블릿 클래스인 DispatcherServlet을 사용하기 위해 DispatcherServlet.class 우클릭 - Copy Qualified Name 누르면 패키지명과 클래스의 이름이 복사된다.

web.xml

  <servlet>
  	<servlet-name>dispatcher</servlet-name>
  	<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  </servlet>
  
  <servlet-mapping>
  	<servlet-name>dispatcher</servlet-name>
  	<url-pattern>/</url-pattern>
  </servlet-mapping>

web.xml에 다음과 같은 코드를 추가한다. servlet-class에는 복사한 디스패처 서블릿의 패키지와 클래스 이름을 써주고, 모든 요청을 다 받기 위해 url-pattern은 "/"으로 설정한다.

index.jsp(webapp 폴더 안)

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
	<h1>hi ${data }</h1>
</body>
</html>

${data} 값은 없기 때문에 창에는 hi만 나타난다.

web.xml의 <url-pattern>을 "/*"으로 수정하고 실행하면 500 에러가 발생한다. WEB-INF 안에 dispatcher-servlet.xml 파일이 없기 때문이다.

(여기서 dispatcher란 web.xml에서 설정한 서블릿 네임을 의미하며, -servlet은 예약어이다.)

디스패처 서블릿이 모든 요청을 받은 후 WEB-INF 안의 *-servlet.xml에서 매핑된 정보에 따라 배분하는데, 이 설정이 없기 때문에 에러가 나는 것이다.

url-pattern을 "/"으로 정의하는 것은 디폴트 서블릿을 의미한다. 디폴트 서블릿은 서블릿 매핑 url에 걸리지 않은 모든 요청들을 처리한다. 즉, 매핑 정보가 있는 것은 그에 따라 배분한 후 매핑이 되지 않아 남은 것들을 모두 처리한다는 뜻이다. 그래서 "/"으로 정의했을 때는 매핑 정보가 없어도 에러가 나지 않고 정상적으로 실행된 것이다.

(참고. multifrontgarden.tistory.com/145)

(itmore.tistory.com/entry/%EC%8A%A4%ED%94%84%EB%A7%81-urlpattern-%EC%84%A4%EC%A0%95-%EC%99%80-%EC%B0%A8%EC%9D%B4%EC%97%90-%EB%8C%80%ED%95%9C-%EA%B0%9C%EB%85%90)

매핑 설정을 하기 위해 WEB-INF 안에 dispatcher-servlet.xml 파일을 생성한다. xml 파일의 내용을 작성하기 위해 https://docs.spring.io/spring-framework/docs/ 에 접속 -> 5.2.x -> spring-framework-reference -> Core 클릭 -> beans 태그 복사해서 붙인다.

dispatcher-servlet.xml

	<!-- spring mvc에서는 id에 url을 적는다. -->
	<!-- index라는 요청이 왔을 때 컨테이너에서 class를 꺼낸다. -->
    <bean id="/index" class="com.newlecture.web.controller.IndexController">  
    </bean>

컨트롤러 인터페이스를 상속해서 사용할 때 반드시 구현해야 하는 handelRequest 메소드가 있다. IndexController에서 추가해준다.

IndexController.java

public class IndexController implements Controller{

	//Controller를 상속할 때 반드시 있어야 하는 handleRequest
	@Override
	public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
		System.out.println("index controller");
        
		ModelAndView mv = new ModelAndView();
		mv.addObject("data", "Hello Spring MVC"); //view(index.jsp)에서 출력할 data를 담는다
		mv.setViewName("index.jsp");
		
		return mv;
	}
}

ModelAndView를 사용하여 data 객체를 addObject하고, 실행할 jsp를 setViewName을 통해 담는다. IndexController에서 실행한다.

페이지를 찾을 수 없는 404 에러가 발생한다. 주소창을 보면 매핑된 url 정보가 아닌 다른 경로로 요청되고 있다. http://localhost:8787/webprj/index 으로 요청되어야 한다.

주소창의 경로를 http://localhost:8787/webprj/index으로 바꿔도 같은 에러가 난다. 하지만 System.out.println();으로 출력한 "index controller"는 콘솔창에 잘 출력되는 것을 확인할 수 있다.

다시 말해, /index라는 요청이 들어왔을 때 IndexController까지 정상적으로 매핑이 되었고, handleRequest 메소드가 실행되었지만 ModelAndView으로 세팅한 index.jsp를 찾아가는 것에서 문제가 생겼다는 뜻이다. (=>포워드로 요청한 mv.setViewName("index.jsp");에서 문제가 생겼다.)

에러가 나는 이유는, web.xml에서 url-pattern이 "/*"으로 설정되어 있기 때문이다. 실행했을 때 index라는 요청을 받아 그 요청을 프론트 컨트롤러가 받아 dispatcher-servlet.xml에 명시된 bean의 매핑으로 IndexController에 전달하여 실행되기 때문에 문제가 없다. 하지만 mv.setViewName에서 index.jsp라는 경로를 요청하였고, 그 때 다시 프론트 컨트롤러로 가게 되는데 index.jsp라는 요청은 매핑되지 않았기 때문에 에러가 나는 것이다. 에러가 나지 않게 하려면 dispatcher-servlet.xml에 <bean id="/index.jsp" .... > 설정을 해야한다는 건데, 그것보다는 web.xml의 url-pattern을 "/"으로 바꿔주는 편이 좋다.

"/"으로 설정하더라도 프론트 컨트롤러를 거쳐서 요청에 맞는 컨트롤러를 찾아보지만, 매핑된 컨트롤러가 없을 경우에는 직접 리소스를 요청하게 하기 때문에 mv.setViewName("index.jsp");에 요청된 대로 찾아갈 수 있게 된다.

* View 페이지를 위한 위치

MVC 2 디자인 패턴을 사용하면서 코드 작성, 수정의 용이함을 위해서 컨트롤러(IndexController)와 뷰(index.jsp)를 물리적으로 떼어놓았지만 실행 절차를 생각해 보면 둘은 이어져있는 관계이다. 컨트롤러가 먼저 실행된 후에 뷰를 요청하게 된다. 사용자가 뷰만 단독으로 호출하는 상황이 생기면 안 된다는 뜻이다.

현재 상태에서는 localhost:8080/webprj/index.jsp 요청을 했을 때 index.jsp 페이지가 보이게 된다. 이런 현상을 해결하기 위해서 뷰 페이지를 숨겨놓는 방식을 생각하게 된 것이다. 사용자가 뷰 페이지만 호출할 수는 없게 숨겨두는 공간이 바로 WEB-INF이다. WEB-INF는 사용자가 직접 접근할 수 없는 공간이다.

WEB-INF 안에 뷰 페이지들을 모아놓을 view 폴더를 생성하고 그 안에 index.jsp를 옮겨놓는다.

url로 직접 요청했을 때 404 에러가 뜬다면 맞게 설정된 것이다.

IndexController.java

public class IndexController implements Controller{

	@Override
	public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
		System.out.println("index controller");
		ModelAndView mv = new ModelAndView();
		mv.addObject("data", "Hello Spring MVC"); //view에서 출력할 data를 담는다.
		mv.setViewName("/WEB-INF/view/index.jsp"); //수정한 뷰 페이지의 경로
		
		return mv;
	}
}

mv.setViewName을 수정하고 컨트롤러를 실행하면 정상적으로 index.jsp 페이지가 뜬다.

(/ : 루트로부터 찾는 절대경로, /가 없으면 상대경로. 절대경로를 사용하는 게 더 편하다. 여기서 루트(웹 루트)는 webapp이다.)

http://localhost:8080/webprj/index과 같은 url에서 webprj이 의미하는 것은 프로젝트 명인데 url에 굳이 들어갈 필요가 없다. 프로젝트 우클릭 > Web Project Settings > Context root를 "/"으로 지정한다. 그리고 Servers 탭에서 톰캣 밑에 있는 웹 모듈을 지운다.

실행할 때마다 매번 주소를 입력하기 귀찮으니 WEB-INF 안에 index라는 파일을 만든다. WEB-INF 바로 아래에 있으므로 이 파일도 /index라는 경로를 가지지만, 컨트롤러가 실행 우선순위가 더 높으므로 /index 요청하면 IndexController로 간다. 이클립스 상에서 실행을 편하게 하기 위해 간이로 만든 것이다.

* ViewResolver

앞서 뷰를 요청할 때는

ModelAndView mv = new ModelAndView();
mv.setViewName("/WEB-INF/view/index.jsp");

이런 식으로 ModelAndView 객체를 만든 후 뷰 네임을 set 해주었지만 매개변수 생성자를 이용할 수도 있다.

ModelAndView mv = new ModelAndView("/WEB-INF/view/index.jsp");

여기서 반복되는 '/WEB-INF/view'와 '.jsp'는 뷰 리졸버를 통해 처리해 주면 보다 간편하게 쓸 수 있다.

dispatcher-servlet.xml

    <!-- View Resolver -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    	<property name="prefix" value="/WEB-INF/view/"></property>
    	<property name="suffix" value=".jsp"></property>
    </bean>

사용법은 간단하다. dispatcher-servlet.xml에 해당 코드만 추가하면 된다.

뉴렉처 스프링 프레임워크 강의를 듣고 정리한 게시글입니다.

www.youtube.com/user/newlec1

저작자표시 비영리 변경금지

'💻Study > Spring' 카테고리의 다른 글

데이터 서비스 클래스 추가 / 서비스 결합력 낮추기 / DB 연결정보 분리 / Spring 설정 분리 (0)	2021.02.26
정적 파일 매핑 / Tiles와 TilesResolver (0)	2021.02.26
Spring MVC (0)	2021.02.14
Spring으로 AOP 구현 (Around Advice) (0)	2021.02.13
순수 자바로 AOP 구현해보기 (0)	2021.02.13

자기개발 🚀 I develop me

Spring MVC 개발환경 세팅 / Dispatcher Servlet / View Resolver

'💻Study > Spring' 카테고리의 다른 글

티스토리툴바

Spring MVC 개발환경 세팅 / Dispatcher Servlet / View Resolver

'💻Study > Spring' 카테고리의 다른 글

'💻Study/Spring' Related Articles

티스토리툴바