Spring MVC 入門例子
Spring Web MVC 是一個建立在 Servlet API 的 Web 框架,它屬於 Spring Framework 的產品。Spring Web MVC 名稱來源於模組 spring-webmvc ,但它更常用的叫法是 Spring MVC。
本文講述如何使用 IntelliJ IDEA 來編寫一個 Spring MVC Demo。
使用 IntelliJ IDEA 建立一個 Maven 專案,選擇 webapp 型別。
建立好 Maven 專案後,我們在 pom.xml 檔案中新增依賴。
<dependencies>
<dependency >
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.0.7.RELEASE</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId >
<version>3.0.1</version>
<scope>provided</scope>
</dependency>
</dependencies>
為編寫程式碼,我們在 main 目錄下建立 java 目錄,並標記為 Source 目錄。接下來在 main 目錄下新增 resources 目錄,並標記為 Resource 目錄。如下圖所示:
為執行 Spring MVC 專案,我們還需要配置 tomcat 伺服器。 先在官網下載 tomcat,然後在 IntelliJ IDEA 新增 tomcat ,如下圖所示:
配置完 tomcat 伺服器後,還需要將專案部署到 tomcat 中執行。在 Deployment 選項視窗中將本專案配置進去。
Tomcat 伺服器配置完畢,可以點選執行按鈕進行測試。如果可以正常開啟瀏覽器,並顯示 Hello World 的字樣,說明配置成功。
經過以上的配置,Spring MVC 專案的框架就搭建完畢了,接下來就可以編寫程式碼了。
配置 web.xml
我們將 web.xml 配置修改為:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
version="2.5">
<display-name>spring-web</display-name>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
</welcome-file-list>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
classpath:application-context.xml </param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<servlet>
<servlet-name>example</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>example</servlet-name>
<url-pattern>/api/*</url-pattern>
</servlet-mapping>
</web-app>
在 web.xml 檔案,我們添加了一個名為example
的 servlet,用於處理 /api/ 的請求;並指定application-context.xml
作為 spring 的上下文配置檔案。
建立application-context.xml
檔案,內容為:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xmlns:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
</beans>
配置 xxx-servlet.xml
配置完 web.xml 後,我們新增 servlet 的 xml 配置。上面我們配置了名為example
的 servlet,故我們建立一個example-servlet.xml
的檔案,其內容如下:
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<context:component-scan base-package="com.test.controller" />
</beans>
example-servlet.xml
檔案裡面指定了 controller 的包為com.test.controller
。
新增 controller
上述 servlet 配置檔案中指定了 servlet 的包為com.test.controller
,因此,我們在 java 目錄下建立com.test.controller
包,並新增類HelloController
。
package com.test.controller;
import java.io.IOException;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping(value = "/hello")
public class HelloController {
@RequestMapping(value = "/spring")
public void spring(HttpServletResponse response) throws IOException {
response.getWriter().write("Hello, Spring Web!!");
}
}
註解 @Controller
的含義是指類HelloController
為一個處理請求的 Controller。
註解@RequestMapping
用於定義請求 url 的對映,上述程式碼表明我們將 /hello/spring 的請求對映到方法spring()
中處理。
完成以上步驟後,我們就完成了一個完整 spring mvc 的示例。專案原始碼和配置如下圖所示:
執行
執行專案,在瀏覽器中輸入http://localhost:8081/
,顯示結果如下:
在瀏覽器中輸入http://localhost:8081/api/hello/spring
,顯示結果如下:
這表明 Spring MVC 框架將 /api/hello/spring 的請求由類HelloController
中的spring()
方法進行了處理。