Spring MVC 5 - Hello World Example
- src
- main
- java
- com
- example
- springmvc_practice
- config
- AppConfig.java
- SpringMvcDispatcherServletInitializer.java
- controller
- HelloWorldController.java
- model
- HelloWorld.java
- resources
- application.properties
- webapp
- WEB-INF
- views
- helloworld.jsp
- test
- .gitignore
- build.gradle
- gradlew
- gradlew.bat
/WEB-INF/views/
안에 있는 JSP 파일들을 찾기를 기본으로 기대하기 때문에 gradle로 프로젝트를 생성했다면 **src/main/webapp/WEB-INF/views/
경로 만들어줘야함**plugins {
id 'java'
id 'war'
}
group = 'net.javaguides.springmvc'
version = '0.0.1-SNAPSHOT'
java {
sourceCompatibility = JavaVersion.VERSION_1_8
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework:spring-webmvc:5.1.0.RELEASE'
implementation 'javax.servlet.jsp.jstl:javax.servlet.jsp.jstl-api:1.2.1'
implementation 'taglibs:standard:1.1.2'
compileOnly 'javax.servlet:javax.servlet-api:3.1.0' // provided 스코프 대응
compileOnly 'javax.servlet.jsp:javax.servlet.jsp-api:2.3.1' // provided 스코프 대응
// 테스트 의존성은 그대로 유지
testImplementation 'org.springframework:spring-test:5.3.18'
testImplementation 'junit:junit:4.13.2'
}
test {
useJUnitPlatform()
}
package com.example.springmvc_practice.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
import org.springframework.web.servlet.view.JstlView;
/**
* @author Ramesh Fadatare
*/
// @Configuration 어노테이션은 이 클래스가 스프링 설정 클래스임을 나타낸다.
// 이 클래스 내의 메소드들은 스프링 컨테이너가 관리하는 빈(Bean) 객체를 정의하거나
// 설정 정보를 반환한다.
@Configuration
// @EnableWebMvc 어노테이션은 Spring MVC를 활성화한다.
// 이것은 <mvc:annotation-driven />과 동일한 기능을 수행하여
// DispatcherServlet과 같은 Spring MVC의 핵심 부분들을 활성화한다.
@EnableWebMvc
// @ComponentScan 어노테이션은 스프링이 컴포넌트 스캔을 수행할 기본 패키지를 지정한다.
// 컴포넌트 스캔은 지정된 패키지와 그 하위 패키지에서 @Component, @Controller,
// @Service, @Repository 등이 붙은 클래스를 찾아 스프링 빈으로 등록한다.
@ComponentScan(basePackages = { "com.example.springmvc_practice" })
public class AppConfig {
// @Bean 어노테이션은 메소드가 스프링 컨테이너에 의해 관리되는 빈 객체를 생성한다는 것을 나타낸다.
// 이 메소드가 반환하는 객체는 스프링의 빈으로 등록되며, 이후 이 빈을 필요로 하는 다른 컴포넌트에 주입될 수 있다.
@Bean
public InternalResourceViewResolver resolver() {
// InternalResourceViewResolver 인스턴스를 생성한다.
// 이 객체는 컨트롤러가 반환하는 뷰 이름(논리적이름)을 기반으로 실제 JSP 파일의 경로를 해석하는 역할을 한다.
InternalResourceViewResolver resolver = new InternalResourceViewResolver();
// resolver.setViewClass(JstlView.class); 라인은 JSP 파일에서 JSTL 태그를 사용할 수 있도록 설정한다.
// JSTL 태그는 JSP 파일에서 자바 코드를 사용하지 않고도 반복문, 조건문 등을 사용할 수 있게 해준다.
resolver.setViewClass(JstlView.class);
// resolver.setPrefix("/WEB-INF/views/"); 라인은 모든 뷰 이름 앞에 자동으로 붙을 경로를 설정한다.
// 예를 들어 컨트롤러가 "helloworld"라는 뷰 이름을 반환하면, "/WEB-INF/views/helloworld.jsp" 파일을 사용하게 된다.
resolver.setPrefix("/WEB-INF/views/");
// resolver.setSuffix(".jsp"); 라인은 모든 뷰 이름 뒤에 자동으로 붙을 확장자를 설정한다.
// 이 설정에 의해 "hello" 라는 뷰 이름은 "hello.jsp"로 해석된다.
resolver.setSuffix(".jsp");
// 설정된 InternalResourceViewResolver 객체를 반환한다.
// 이 객체는 이후 뷰를 해석할 때 사용된다.
return resolver;
}
}
package com.example.springmvc_practice.config;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
/**
* 이 클래스는 web.xml의 Java 기반 대안으로 사용되며,
* Spring MVC 애플리케이션의 DispatcherServlet을 초기화하기 위한 설정을 제공한다.
* AbstractAnnotationConfigDispatcherServletInitializer를 상속받아 사용한다.
*/
public class SpringMvcDispatcherServletInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getRootConfigClasses() {
// getRootConfigClasses() 메서드는 애플리케이션의 root-level(전역) 설정 클래스를 반환한다.
// "root" 애플리케이션 컨텍스트는 애플리케이션의 모든 서블릿에 공유되는 빈을 포함한다.
// 여기서는 특별한 root 설정이 없으므로 null을 반환한다.
return null;
}
/*
쇼핑몰을 운영하는 데 필요한 특정 부서의 관리자를 선정하는 것에 비유
쇼핑몰에는 다양한 부서가 있다: 의류, 식료품, 가전제품 등등. 이 모든 부서들이 효율적으로 운영되기 위해서는 각각의 섹션을 관리하는 전문 관리자가 필요하다.
getServletConfigClasses() 메서드는 쇼핑몰의 '웹 컴포넌트' 부서를 위한 관리자를 선정하는 것과 같다.
여기서 '웹 컴포넌트' 부서라는 것은, 웹 애플리케이션에서 사용자의 요청을 처리하는 부분, 즉 이전에 DispatcherServlet에서 공부했던 컨트롤러, 뷰 리졸버, 핸들러 매핑 등을 의미한다.
AppConfig.class는 이 '웹 컴포넌트' 부서의 관리자라고 할 수 있다.
즉, 이 클래스에는 웹 애플리케이션을 운영하는 데 필요한 모든 설정과 규칙이 정의되어 있다.
getServletConfigClasses()는 시스템에게 "이것이 우리 웹 애플리케이션의 관리자이다.
이 관리자가 웹 애플리케이션을 어떻게 설정하고 운영할지를 알고 있으니, 사용자의 요청을 처리할 때는 이 관리자의 지시에 따라주세요."라고 말해주는 것과 같다.
이 메서드가 반환하는 AppConfig.class는 웹 애플리케이션의 설정을 담당하는 클래스로,
사용자의 요청을 어떻게 처리할지, 어떤 컨트롤러를 사용할지, 뷰는 어디에 있는지 등의 정보를 스프링 프레임워크에 제공한다.
*/
@Override
protected Class<?>[] getServletConfigClasses() {
// getServletConfigClasses() 메서드는 DispatcherServlet 애플리케이션 컨텍스트에 대한 설정 클래스를 반환한다.
// 이 컨텍스트는 애플리케이션의 웹 컴포넌트에만 관련된 빈을 포함한다.
// AppConfig.class는 웹 컨텍스트의 설정 정보를 포함하고 있다.
return new Class[]{
AppConfig.class
};
}
/*
DispatcherServlet은 스프링 MVC에서의 프론트 컨트롤러 패턴을 구현하며, 모든 웹 요청을 받아 적절한 처리를 위해 다른 컴포넌트로 전달하는 역할을 한다.
이 메서드에서 "/"를 반환함으로써, 웹 애플리케이션의 모든 요청(예: 홈페이지, 사용자 프로필 페이지, 검색 결과 페이지 등)이
DispatcherServlet을 통과하여 적절한 핸들러로 라우팅되도록 설정한다.
* */
@Override
protected String[] getServletMappings() {
// getServletMappings() 메서드는 DispatcherServlet이 매핑될 경로를 정의한다.
// 여기서 "/"는 애플리케이션의 기본 경로로 설정되며,
// 이는 모든 요청이 DispatcherServlet으로 라우팅되도록 한다.
return new String[]{
"/"
};
}
}
package com.example.springmvc_practice.controller;
import java.time.LocalDateTime;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import com.example.springmvc_practice.model.HelloWorld;
/**
* @author Ramesh Fadatare
*/
@Controller
public class HelloWorldController {
@RequestMapping("/helloworld")
public String handler(Model model) {
HelloWorld helloWorld = new HelloWorld();
helloWorld.setMessage("Hello World Example Using Spring MVC 5!!!");
helloWorld.setDateTime(LocalDateTime.now().toString());
model.addAttribute("helloWorld", helloWorld);
return "helloworld";
}
}
package com.example.springmvc_practice.model;
public class HelloWorld {
private String message;
private String dateTime;
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public String getDateTime() {
return dateTime;
}
public void setDateTime(String dateTime) {
this.dateTime = dateTime;
}
}
<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
pageEncoding="ISO-8859-1"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<!DOCTYPE html>
<html>
<head><%@ page isELIgnored="false" %>
<meta charset="ISO-8859-1">
<title>Spring 5 MVC - Hello World Example | javaguides.net</title>
</head>
<body>
<h2>${helloWorld.message}</h2>
<h4>Server date time is : ${helloWorld.dateTime}</h4>
</body>
</html>