Spring Controller – Spring MVC Controller

教學
Spring

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

Spring Controller

Spring Controller注解只能应用于类。它用于将类标记为Web请求处理程序，主要与Spring MVC应用程序一起使用。

Spring RestController

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

Spring 控制器示例

让我们创建一个简单的Spring应用程序，在其中实现标准的MVC控制器以及REST控制器。在Eclipse中创建一个“Dynamic Web Project”，然后将其转换为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），在那里我们将配置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 bean，并提供了视图页面的详细信息。

<?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 存儲庫 下載範例專案代碼。

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