Spring & Springboot/올인원 스프링 프레임워크

STS를 이용한 웹 프로젝트

YJ_ma 2023. 9. 21. 23:36

STS를 이용한 웹 프로젝트 생성

스프링 MVC 프레임워크를 이용한 웹 프로젝트를 생성하고 실행해본다.

MVC 프레임워크를 이용한 웹 프로젝트 생성하기

STS 상단 메뉴의 [File]-[New]-[Other..]를 선택한다.(ctrl+n)

Spring > Spring Legacy Project를 선택하고 'ch07_pjt_01' 프로젝트 이름을 지정해준다.

Spring MVC Project를 선택하고 최초 1회 Spring MVC 사용을 위해 데이터를 다운로드하는 창이 나타나면 YES을 클릭해준다.

패키지 이름은 com.company.hello로 지정해준다.

 

Spring MVC 프로젝트 설정하기

1. [Window] - [Show View] - [Project Explorer]를 클릭하여 프로젝트를 관리하는 Project Explorer를 열어준다.

2. ch07_pjt_01 프로젝트의 JRE 버전은 1.6으로 우리가 사용하는 11로 변경해줘야한다.

pom.xml 파일에서 11행에 자바 버전 설정을 1.6 → 11 로 변경해준다.

3. 141, 142 행의 빌드에 사용되는 자바 버전도 11로 변경해준다.

4. 이제 스프링 버전을 변경해준다.

pom.xml 파일의 12행에 3.1.1.RELEASE → 5.2.9.RELEASE 로 변경해준다.

5. 변경된 내용에 대해 저장하고 변경된 내용을 적용하기 위해 메이븐 프로젝트를 업데이트해준다.

프로젝트 우클릭 > [Maven] > [Update Maven Project] 클릭 > ch07_pjt_01 선택 > OK버튼 클릭

 

변경 전 변경 후

 

톰캣 실행하기

프로젝트를 실행하려면 프로젝트 우클릭 > [Run As] - [Run on Server] 클릭(Alt+Shift+x)

[Run on Server] 창이 뜨면 'Tomcat v9.0 Server at localhost'를 선택하고 <Finish> 버튼 클릭한다.

다음과 같이 프로젝트가 실행되면 STS 브라우저에 Hello World!가 출력되는 것을 확인할 수 있다.

 

크롬 브라우저에서 실행하기 위해 기본 브라우저를 크롬으로 변경해준다.

[Window] - [Web Browser] - [Chrome]을 선택한다.

톰캣을 종료 후 다시 프로젝트를 실행하면 크롬에서 프로젝트가 실행되는 것을 확인할 수 있다.

실행 결과

한글 인코딩

실행 결과를 보면 브라우저에 서버의 시간이 깨져있는 것을 확인할 수 있다. 

한글 인코딩은 web.xml에 <filter>를 이용해서 UTF-8로 인코딩한다.

src/main/webapp/WEB-IFN/web.xml을 열고 </web-app> 전에 <filter>를 추가한다.

 

· 한글 인코딩을 위해 추가한 코드

<filter>
    <filter-name>encodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter
    </filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>encodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
web.xml 위치 실행 결과

 

스프링 MVC를 이용한 웹 프로젝트 구조 분석

프로젝트의 전체 구조

1. java : java파일들이 위치한다. 
주로 패키지로 묶어서 관리한다.
웹 애플리케이션에서 사용되는 Controller, Service, DAO객체들이 있다.

2. webapp : 웹과 관련된 파일들(스프링 설정 파일, JSP 파일, HTML 파일 등)이 있다.

3. resources : CSS, 자바스크립트 파일 등이 위치한다.

4. spring : 스프링 컨테이너를 생성하기 위한 스프링 설정 파일이 위치한다.

5. views : View로 설정될 JSP 파일이 위치한다.

6. web.xml : 웹 서비스의 전반적인 설정을 하는 파일

7. pom.xml : 메인 리포지토리에서 프로젝트에 필요한 라이브러리를 내려받기 위한 메이븐 설정 파일

 

pom.xml

프로젝트에 필요한 라이브러리를 메인 리포지토리에서 다운받기 위한 메이블 설정 파일이다.

· 7행 : 프로젝트 이름

<name>ch07_pjt_01</name>

· 11행 : 프로젝트에 사용되는 자바 버전 명시

<java-version>11</java-version>

· 12행 : 스프링 버전 명시, 자동으로 메인 리포지터리에서 해당 버전(5.2.9) 라이브러리를 다운로드

<org.springframework-version>5.2.9.RELEASE</org.springframework-version>

· 30~34행 : 스프링 MVC 프레임워크와 관련된 라이브러리를 메인 리포지토리에서 다운로드

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>${org.springframework-version}</version>
</dependency>

· 94~110행 : 웹 프로젝트에 필요한 서블릿 관련 라이브러리를 메인 리포지터리에서 다운로드

<!-- Servlet -->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>servlet-api</artifactId>
    <version>2.5</version>
    <scope>provided</scope>
</dependency>
<dependency>
    <groupId>javax.servlet.jsp</groupId>
    <artifactId>jsp-api</artifactId>
    <version>2.1</version>
    <scope>provided</scope>
</dependency>
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>jstl</artifactId>
    <version>1.2</version>
</dependency>

· 120~157행 : 프로젝트를 빌드하기 위한 설정한다.

<build>
    <plugins>
        <plugin>
            <artifactId>maven-eclipse-plugin</artifactId>
            <version>2.9</version>
            <configuration>
                <additionalProjectnatures>
                    <projectnature>org.springframework.ide.eclipse.core.springnature</projectnature>
                </additionalProjectnatures>
                <additionalBuildcommands>
                    <buildcommand>org.springframework.ide.eclipse.core.springbuilder</buildcommand>
                </additionalBuildcommands>
                <downloadSources>true</downloadSources>
                <downloadJavadocs>true</downloadJavadocs>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>2.5.1</version>
            <configuration>
                <source>11</source>
                <target>11</target>
                <compilerArgument>-Xlint:all</compilerArgument>
                <showWarnings>true</showWarnings>
                <showDeprecation>true</showDeprecation>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>exec-maven-plugin</artifactId>
            <version>1.2.1</version>
            <configuration>
                <mainClass>org.test.int1.Main</mainClass>
            </configuration>
        </plugin>
    </plugins>
</build>

 

web.xml

DispatcherServlet 객체가 웹 애플리케이션의 모든 객체를 관리한다고 했었다.

이때 DispatcherServlet 객체를 서블릿으로 등록해주는 코드는 web.xml에 있다.

 

· 18~26행 : appServlet 별칭을 사용해서 DispatcherServlet 클래스를 서블릿으로 등록한다.

· 21~24행 : contextConfigLocation 이름으로 스프링 설정 파일(servlet-context.xml)을 설정한다.

<!-- Processes application requests -->
<servlet>
    <servlet-name>appServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/spring/appServlet/servlet-context.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

· 28~31행 : 18~26행에서 서블릿으로 등록한 DispatcherServlet을 매핑(/)한다.

웹 애플리케이션에서 최초 사용자의 요청이 발생하면 가장 먼저 DispatcherServlet이 사용자의 요청을 받는다.

따라서 개발자는 DispatcherServlet을 서블릿으로 등록해주는 과정을 설정해야한다. 그리고 사용자의 모든 요청을 받기 위해 서블릿 매핑 경로는 '/'로 설정한다.

<servlet-mapping>
    <servlet-name>appServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

 

web.xml에서 DispatcherServlet 클래스를 서블릿으로 등록하고, 서블릿 매핑을 통해서 (<url-pattern>/</url-pattern>) 사용자의 모든 요청을 DispatcherServlet에 전달한다.

서블릿 매핑 설정에서 <url-pattern> 태그 값이 '/'를 설정했기 때문에 사용자의 모든 요청을 DispatcherServlet 객체에 전달할 수 있다.

 

① DispatcherServlet ↔ HandlerMapping

DispatcherServlet HandlerMapping
웹 서비스 사용자의 모든 요청을 받으면
HandlerMapping 객체에 컨트롤러 객체 검색 요청
객체 검색 후 DispatcherServlet에게 객체 알려줌

② DispatcherServlet ↔ HandlerAdapter

DispatcherServlet HandlerAdapter
HandlerAdapter 객체에게 사용자의 요청에 부합하는 메서드 검색을 요청 사용자에 부합하는 메서드 찾아서 해당 컨틀롤러 객체의 메서드 실행
실행 후 컨트롤러 객체는HandlerAdapter에게 ModelAndView 객체 반환
HandlerAdapter 객체는 ModelAndView 객체를 다시 DispatcherServlet 객체에 반환

ModalAndView 객체 : 사용자 응답에 필요한 데이터 정보와 뷰 정보(JSP 파일)가 담겨있음

 

실제로 개발자가 작업하는 클래스는 컨트롤러와 객체 뿐이다.

 

servlet-context.xml

servlet-context.xml 파일은 스프링 설정의 역할을 한다.

· 13행 : 컨트롤러의 역할을 하는 @Controller 애너테이션이 명시되어 있는 클래스를 Controller 객체로 생성

<annotation-driven />

· 16행 : JSP 파일을 제외한 HTML, CSS, JS 파일과 이미지 파일 등을 사용하기 위한 [resources] 폴더를 지정

<resources mapping="/resources/**" location="/resources/" />

· 19~22행 : 컨트롤러 객체에서 반환된 ModelAndView 객체에서 뷰에 해당하는 JSP 파일을 검색하기 위해 InternalResourceViewResolver 객체를 생성

<beans:bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <beans:property name="prefix" value="/WEB-INF/views/" />
    <beans:property name="suffix" value=".jsp" />
</beans:bean>

· 24행 : com.company.hello 패키지 하위에 있는 모든 컴포넌트를 사용할 수 있도록 스캔

<context:component-scan base-package="com.company.hello" />

 

스프링 설정 파일(servlet-context.xml)은 클래스로부터 프로젝트에 필요한 빈 객체를 생성하고 조립한다.

13행의 <annotation-driven>은 @Controller 애너테이션이 명시된 클래스를 컨트롤러 객체로 이용할 수 있다.

⚠️ 만약 <annotation-driven>을 사용하지 않으면?

→ 컨트롤러로 사용되는 모든 클래스를 <bean> 태그를 이요해서 생성해야한다.

 

16행의 <resources> 태그는 속성으로 mapping과 location을 갖는다. JSP파일을 제외한 파일들의 경로를 매핑하는 것으로 여기에서는 /resources/** 속성 값을 갖는다.

ex, /resources/특정 폴더명(파일명) 으로 접근함

location 속성 값으로 지정한 물리적 경로에 특정 폴더 또는 파일을 개발자가 만들어주면 된다.

ex, resources/index.html 파일을 생성한 경우

→ 웹 브라우저에 접근할 때는 http://localhost:8090/context명/resources/index.html로 접근

 

19~22행은 컨트롤러에서 반환된 뷰 객체의 JSP 파일을 찾기 위한 빈 객체를 생성하기 위한 설정이다.

뷰를 찾기 위해 InternalResourceViewResolver 객체가 스프링 컨테이너에 생성하고 prefix와 suffix 속성에 /WEB-INF/views/와 .jsp를 설정한다.

· prefix : JSP 파일의 위치

· suffix : 컨트롤러에서 반환된 뷰 이름에 .jsp을 붙여서 정확한 JSP파일을 찾을 수 있게 한다.

/WEB-INF/views/ + Controller에서 받은 view 정보 + .jsp

ex, /WEB-INF/views/home.jsp

 

컨트롤러

· 클라이언트 요청을 받아서 사용자의 요청에 부합하는 메서드를 실행

· 해당 메서드는 Service와 DAO 등을 이용해서 사용자의 요청에 대한 작업을 진행

· 메서드 작업이 완료되면 뷰 정보를 반환하고, 반환된 정보를 이용해서 JSP 파일이 실행

 

■ Controller와 Service 그리고 DAO 객체 관계

DispatcherServlet → HandlerAdapter → Controller → Service → DAO → DB

 

기본 HomeController.java 코드

@Controller 애너테이션 : 해당 클래스는 웹 애플리케이션에서 Controller로 사용

@RequestMapping 애너테이션 : 메서드가 사용자의 요청(URL)을 받도록 작업

- value 속성 : URL 매핑 정보 속성 값으로 지정

- 형태 :  @RequestMapping(value="URL 요청 값") / @RequestMapping("URL 요청 값")

해당 @RequestMapping은 home() 메서드를 사용자의 요청에 부합하는 메서드로 선언하며 value 속성에 대한 값으로 /를 설정하고 있다. /를 설정하면 루트 경로를 이용한 사용자의 요청에 대해 home() 메서드가 실행된다.

package com.company.hello;

import java.text.DateFormat;
import java.util.Date;
import java.util.Locale;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * Handles requests for the application home page.
 */
@Controller
public class HomeController {
	
	private static final Logger logger = LoggerFactory.getLogger(HomeController.class);
	
	/**
	 * Simply selects the home view to render by returning its name.
	 */
	@RequestMapping(value = "/", method = RequestMethod.GET)
	public String home(Locale locale, Model model) {
		logger.info("Welcome home! The client locale is {}.", locale);
		
		Date date = new Date();
		DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG, locale);
		
		String formattedDate = dateFormat.format(date);
		
		model.addAttribute("serverTime", formattedDate );
		
		return "home";
	}
	
}

 

· 앞서 HomeController에서 home() 메서드가 반환 값으로 String 데이터를 이용하고 있다.

· 반환되는 String 값 == 사용자한테 응답하는 JSP 파일 이름

home.jsp 경로
실행 결과