Spring 控制器 - Spring MVC 控制器

Spring Controller 注释是@Component注释的一种特殊形式。Spring Controller 注释通常与基于 RequestMapping 注释的注释处理程序方法结合使用。

Spring 控制器

Spring Controller 注释只能应用于类。它用于将类标记为 Web 请求处理程序。它主要用于Spring MVC应用程序。

春季 RestController

Spring @RestController是一个便利注释，它本身用@Controller和@ResponseBody注释。此注释用于将类标记为RESTful Web 服务的请求处理程序。

Spring 控制器示例

让我们创建一个简单的 Spring 应用程序，我们将在其中实现标准 MVC 控制器以及 REST 控制器。在 Eclipse 中创建一个“动态 Web 项目”，然后将其转换为 Maven 项目。这将为我们提供基于 Maven 的 Web 应用程序结构，我们可以在此基础上构建我们的应用程序。下图显示了我们的 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），其中我们将DispatcherServletservlet 配置为前端控制器。

<?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 组件的根包。我们还配置InternalResourceViewResolverbean 并提供视图页面的详细信息。

<?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 文件已经准备好了，现在让我们转到 Controller 类。

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";
	}

}

我们定义了一个请求处理程序方法，它接受 URI 为“/hello”的 GET 请求并返回“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 控制器测试

我们的基于 servlet 的传统 Spring MVC 应用程序带有一个简单的控制器，已经准备就绪，只需将其导出为 WAR 文件并部署到 Tomcat 或任何其他 servlet 容器上即可。然后转到 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 的 Web 服务。

您可以从我们的GitHub 存储库下载示例项目代码。