SpringMvc-使用註解開發

註解開發

在使用SpringMvc時，使用註解開發可以讓我們開發的速度大大提升，就無需每寫一個組件就在配置文件中手動添加一個Bean了。

先介紹一些常用的註解：

• @Controller

  • 該註解用於標註一個類，表示該類是一個SpringMvc的Controller對象，如果被Spring掃描到，會自動添加到Bean。
  • 被該註解的類，其中的所有方法，如果返回值時String，就會被視圖解析器解析。

• @RestController

  • 該註解與@Controller功能一致，但是被該註解標識的類，其中處理請求的方法，返回時不會被視圖解析器解析。

• @RequestMapping

  • 該註解用於標識類或者方法，標識類時，表示類中所有請求的方法都是以該地址作爲父路徑。用於方法上時，表示該路徑的請求由該方法完成。
  • value：指定請求的實際地址。
  • method：指定請求的方法類型。
  • consumes：指定處理請求的提交內容類型。
  • produces：指定返回的內容類型。
  • params：指定該請求中必須包含某些參數值。
  • header：指定請求中必須包含某些指定的頭信息。
  • 存在@GetMapping、@PostMapping…等註解用於標識指定method請求的方法，這些註解只能存在於方法上。

• @PathVariable

  • 該註解用於功能處理方法的參數上，用於指定請求路徑中攜帶的參數。

• @ResponseBody

  • 該註解用於標識類或者方法，將Controller的方法返回的對象通過指定的格式轉換後直接寫入Response的Body數據區中，不會用視圖解析器解析。

代碼演示

1. 新建Maven項目，導入依賴：

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

2. 編寫SpringMvc的配置文件（spring-mvc.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:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!--自動掃描包，讓指定包下的註解生效，由Spring容器統一管理-->
    <context:component-scan base-package="com.ara.controller"/>

    <!--讓Spring不處理靜態資源-->
    <mvc:default-servlet-handler />

    <!--
    支持mvc註解驅動
        在Spring中一般採用@RequestMapping註解來完成映射關係
        要使@RequestMapping註解生效
        必須向上下文中註冊DefaultAnnotationHandlerMapping
        和一個AnnotationMethodHandlerAdapter實例
        這兩個實例分別在類級別和方法級別中處理
        而annotation-driven配置幫助我們自動完成上述兩個實例的注入
    -->
    <mvc:annotation-driven />

    <!--視圖解析器-->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver" >
        <!--視圖前綴-->
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <!--視圖後綴-->
        <property name="suffix" value=".jsp"/>
    </bean>

</beans>

3. 配置web.xml，在其中添加如下：

<servlet>
    <servlet-name>springMvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

    <!--配置DispatcherServlet要綁定Spring的配置文件-->
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring-mvc.xml</param-value>
    </init-param>

    <!--配置DispatcherServlet的啓動級別爲1，與服務器同時啓動加載-->
    <load-on-startup>1</load-on-startup>

</servlet>

<!--
    /和/*的區別：這裏需要的是/
        /:只匹配所有的請求，不會去匹配jsp頁面
        /*:匹配所有的請求，包括jsp頁面
-->
<servlet-mapping>
    <servlet-name>springMvc</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

<!--  Spring中自帶的編碼過濾器，處理中文亂碼問題  -->
<filter>
    <filter-name>characterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>characterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

4. 編寫測試Controller類（ControllerTest）這裏需要注意Controller的所在包路徑，要和Springmvc配置文件中配置的掃描包路徑一致，否則會掃描不上：

package com.ara.controller;

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

//標註該類是Spring的Controller類
@Controller
public class ControllerTest {
    
    //標註該方法的訪問路徑
    @RequestMapping("/test")
    //該方法返回的String會被視圖解析器解析成對應的頁面 "/WEB-INF/jsp/"+"test"+".jsp"
    //該方法的參數還可以自己寫，比如HttpServletRequest、HttpServletResponse...
    public String test(Model model){
        
        model.addAttribute("msg","SpringMvc 測試！");
        
        return "test";
    }
    
}

5. 編寫測試頁面（在WEB-INF下的jsp文件中創建test.jsp）需要和SpringMvc配置文件中的視圖解析器對應：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
${msg}
</body>
</html>

6. 將該項目運行到Tomcat，訪問test結果如下：
   
   註解環境沒問題，實驗成功。