用註解開發SpringMVC

• 2021 年 2 月 23 日
• 筆記
• spring, SpringMVC, Web MVC

Spring2.5以後，用註解開發SpringMVC的功能十分強大，註解也是SpringMVC的精髓。在實際開發中，都會使用註解來實現。
這讓SpringMVC開發工作量最小化，開發者只要專註於業務邏輯及頁面的編寫實現。

1、web.xml文件

配置DispatcherServlet，及相應的servlet-mapping。
這個文件除了servlet-name，和springmvc的配置文件名，其餘都是固定不變，可以復用的。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="//xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="//www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="//xmlns.jcp.org/xml/ns/javaee //xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <!--註冊DispatcherServlet-->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--關聯一個springmvc的配置文件，命名規則為：【servlet-name】-servlet.xml-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!--/ 匹配所有的請求：不包括.jsp-->
    <!--/* 匹配所有的請求：包括.jsp-->
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

2、Spring bean配置文件

沿用官方命名規則，此處用springmvc-servlet.xml。這個文件除了要掃描的包路徑，其餘都是固定不變，可以直接復用的。

• 開啟註解

  • 新增context約束
  • 開啟自動掃描包

• 靜態資源過濾

  • 使用默認的default-servlet-handler
  • 讓Spring MVC不處理靜態資源 .css .js .html .mp3 .mp4

• 支持mvc註解驅動

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

• 視圖解析器

  • 默認使用InternalResourceViewResolver
  • 配置.jsp文件全路徑文件名的前綴、後綴。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="//www.springframework.org/schema/beans"
       xmlns:xsi="//www.w3.org/2001/XMLSchema-instance"
       xmlns:context="//www.springframework.org/schema/context"
       xmlns:mvc="//www.springframework.org/schema/mvc"
       xsi:schemaLocation="//www.springframework.org/schema/beans
       //www.springframework.org/schema/beans/spring-beans.xsd
       //www.springframework.org/schema/context
       //www.springframework.org/schema/context/spring-context.xsd //www.springframework.org/schema/mvc //www.springframework.org/schema/mvc/spring-mvc.xsd">

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

    <!--讓Spring MVC不處理靜態資源 .css .js .html .mp3 .mp4-->
    <mvc:default-servlet-handler/>

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

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

</beans>

3、Controller類編寫

使用註解開發SpringMVC，99%的工作量都在controller類編寫。SpringMVC Annotation 使開發量最小化。

Controller負責解析用戶請求，進行業務處理，並返回一個模型。

Controller通過實現接口和註解定義兩種方法實現。

實現了Controller接口的類就是控制器，這是較老的方法。

一個控制器類只能有一個方法。多個方法要寫多個controller。

推薦用註解定義實現。

• @Controller

  • 修飾類，保證該類能被Spring自動掃描到，自動裝配為Spring bean

• @RequestMapping

  請求地址，將controller類或其特定方法映射到指定前端視圖

  • 修飾類，表示該類所有方法的響應路徑以該地址作為父路徑。
  • 修飾方法：表示該方法響應路徑，方法響應到指定前端視圖。

• return

  • 返回值：視圖jsp文件名

  • @Controller註解的類中，若方法返回值對應的jsp文件名存在，則會被視圖解析器解析

@Controller //修飾類，保證該類能被Spring自動掃描到，自動裝配為Spring bean
@RequestMapping("controller") //修飾類，表示該類所有方法的響應路徑以該地址作為父路徑
public class MyController {

    //完整url：//localhost:8080/(工程名)/controller/hello
    @RequestMapping("/hello") //修飾方法：表示該方法響應路徑，方法響應到指定前端視圖。
    public String sayHello(Model model){
        model.addAttribute("msg", "Hello!SpringMVC Annotation!");
        //返回值：視圖jsp文件名
        //@Controller註解的類中，若方法返回值對應的jsp文件名存在，則會被視圖解析器解析
        return "hello";
    }
}

4、編寫hello.jsp頁面

放在/WEB-INF/jsp/路徑下

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

</body>
</html>

5、測試

url：//localhost:8080/springmvc_annotation_war_exploded/controller/hello