Spring Controller – Spring MVC Controller

Spring Controller 어노테이션은 @Component 어노테이션의 특화된 형태입니다. Spring Controller 어노테이션은 일반적으로 RequestMapping 어노테이션을 기반으로 한 어노테이션 처리기 메서드와 함께 사용됩니다.

Spring Controller

Spring Controller 어노테이션은 클래스에만 적용할 수 있습니다. 이는 클래스를 웹 요청 처리기로 표시하는 데 사용됩니다. 이는 주로 Spring MVC 애플리케이션과 함께 사용됩니다.

Spring RestController

Spring @RestController는 자체적으로 @Controller@ResponseBody로 어노테이션이 지정된 편의 어노테이션입니다. 이 어노테이션은 RESTful 웹 서비스의 요청 처리기로 클래스를 표시하는 데 사용됩니다.

Spring Controller 예제

간단한 Spring 애플리케이션을 만들어 보겠습니다. 표준 MVC 컨트롤러와 REST 컨트롤러를 구현할 것입니다. Eclipse에서 “Dynamic Web Project”를 생성한 다음 Maven 프로젝트로 변환하세요. 이렇게 하면 Maven 기반의 웹 애플리케이션 구조를 제공받을 수 있으며, 이를 기반으로 애플리케이션을 개발할 수 있습니다. 아래 이미지는 Spring MVC 컨트롤러 애플리케이션의 최종 프로젝트 구조를 보여줍니다. 애플리케이션에는 다음과 같은 종속성이 필요합니다.

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-webmvc</artifactId>
	<version>5.0.7.RELEASE</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-web</artifactId>
	<version>5.0.7.RELEASE</version>
</dependency>

<!-- Jackson for REST -->
<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-databind</artifactId>
	<version>2.9.6</version>
</dependency>

프론트 컨트롤러로서 DispatcherServlet 서블릿을 구성하는 배포 서술자(web.xml)를 살펴보겠습니다.

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://xmlns.jcp.org/xml/ns/javaee" 
 xsi:schemaLocation="https://xmlns.jcp.org/xml/ns/javaee https://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" id="WebApp_ID" version="3.1">
  <display-name>Spring-Controller</display-name>
  <!-- Add Spring MVC DispatcherServlet as front controller -->
	<servlet>
        <servlet-name>spring</servlet-name>
        <servlet-class>
                org.springframework.web.servlet.DispatcherServlet
        </servlet-class>
        <init-param>
       		<param-name>contextConfigLocation</param-name>
       		<param-value>/WEB-INF/spring-servlet.xml</param-value>
    		</init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
 
    <servlet-mapping>
        <servlet-name>spring</servlet-name>
        <url-pattern>/</url-pattern> 
    </servlet-mapping>
</web-app>

마지막으로, 다음과 같은 Spring 컨텍스트 파일이 있습니다. 여기에서는 애플리케이션을 어노테이션 기반으로 구성하고 Spring 컴포넌트를 스캔할 루트 패키지를 제공합니다. 또한, InternalResourceViewResolver 빈을 구성하고 뷰 페이지의 세부 정보를 제공합니다.

<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="https://www.springframework.org/schema/mvc"
	xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:beans="https://www.springframework.org/schema/beans"
	xmlns:context="https://www.springframework.org/schema/context"
	xsi:schemaLocation="https://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd
		https://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
		https://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

	<!-- Enables the Spring MVC @Controller programming model -->
	<annotation-driven />

	<context:component-scan base-package="com.journaldev.spring" />

	<!-- Resolves views selected for rendering by @Controllers to JSP resources 
		in the /WEB-INF/views directory -->
	<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>

</beans:beans>

구성 XML 파일이 준비되었으므로, 이제 컨트롤러 클래스로 넘어갑니다.

package com.journaldev.spring.controller;

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

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HomeController {

	@GetMapping("/hello")
	public String home(Locale locale, Model model) {
		Date date = new Date();
		DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG, locale);
		String formattedDate = dateFormat.format(date);
		model.addAttribute("serverTime", formattedDate);
		return "home";
	}

}

하나의 요청 핸들러 메서드를 정의했으며, “GET /hello” URI에 대한 요청을 수락하고 “home.jsp” 페이지를 응답으로 반환합니다. home.jsp 페이지에서 사용될 모델에 속성을 설정하는 것에 주목하세요. 아래는 간단한 home.jsp 페이지 코드입니다.

<%@ page language="java" contentType="text/html; charset=UTF-8"
	pageEncoding="UTF-8"%>
<html>
<head>
<title>Home</title>
</head>
<body>
	<h1>Hello world!</h1>

	<p>The time on the server is ${serverTime}.</p>

</body>
</html>

Spring MVC 컨트롤러 테스트

간단한 컨트롤러를 가진 전통적인 서블릿 기반 Spring MVC 애플리케이션이 준비되었습니다. WAR 파일로 내보내고 Tomcat이나 다른 서블릿 컨테이너에 배포하세요. 그런 다음 URL https://localhost:8080/Spring-Controller/hello로 이동하면 다음과 같은 화면이 출력됩니다.

Spring RestController 예제

이제 애플리케이션을 확장하여 REST API를 노출시킵니다. JSON 응답으로 전송될 모델 클래스를 생성하세요.

package com.journaldev.spring.model;

public class Person {

	private String name;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}
	
}

다음은 간단한 REST 컨트롤러 클래스입니다.

package com.journaldev.spring.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.journaldev.spring.model.Person;

@RestController
public class PersonRESTController {

	@RequestMapping("/rest")
	public String healthCheck() {
		return "OK";
	}

	@RequestMapping("/rest/person/get")
	public Person getPerson(@RequestParam(name = "name", required = false, defaultValue = "Unknown") String name) {
		Person person = new Person();
		person.setName(name);
		return person;
	}

}

REST API를 테스트하기 위해 애플리케이션을 다시 배포하세요.

Spring REST 컨트롤러 테스트

URL https://localhost:8080/Spring-Controller/rest로 이동하면 다음과 같은 출력을 얻을 수 있습니다. URL https://localhost:8080/Spring-Controller/rest/person/get로 이동하면 다음과 같은 JSON 응답을 받게 됩니다. 이제 URL에 이름 매개변수 값을 제공해 보세요. https://localhost:8080/Spring-Controller/rest/person/get?name=Pankaj로 이동하면 다음과 같은 JSON 응답을 받게 됩니다.

요약

Spring Controller는 Spring MVC 애플리케이션의 핵심입니다. 여기서 비즈니스 로직이 시작됩니다. 또한 RestController를 사용하면 쉽게 REST 기반 웹 서비스를 생성할 수 있습니다.

예제 프로젝트 코드는 GitHub 저장소에서 다운로드할 수 있습니다.

Source:
https://www.digitalocean.com/community/tutorials/spring-controller-spring-mvc-controller