Аннотация Spring Controller – это специализация аннотации @Component. Аннотация Spring Controller обычно используется в сочетании с аннотированными методами обработчика на основе аннотации RequestMapping.
Spring Controller
Аннотация Spring Controller может быть применена только к классам. Она используется для обозначения класса как обработчика веб-запросов. Она чаще всего используется с приложением Spring MVC.
Spring RestController
Spring @RestController – это удобная аннотация, которая сама аннотирована как @Controller и @ResponseBody. Эта аннотация используется для обозначения класса как обработчика запросов для веб-сервисов RESTful.
Пример контроллера Spring
Давайте создадим простое веб-приложение Spring, в котором мы реализуем стандартный контроллер MVC, а также REST-контроллер. Создайте “Динамический веб-проект” в Eclipse, а затем преобразуйте его в проект 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>
Давайте рассмотрим файл развертывания (web.xml), где мы настроим сервлет DispatcherServlet
как фронт-контроллер.
<?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-запросы с URI “/hello” и возвращает страницу “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 является основой приложений Spring MVC. Именно здесь начинается наша бизнес-логика. Кроме того, RestController помогает нам легко создавать веб-сервисы на основе REST.
Вы можете загрузить пример кода проекта из нашего репозитория на GitHub.
Source:
https://www.digitalocean.com/community/tutorials/spring-controller-spring-mvc-controller