【Spring】— Spring MVC的注解

- Spring MVC的注解
- - 1.DispatcherServlet
  - 2.Controller注解类型
  - 3.RequestMapping注解类型
  - - （1）@RequestMapping注解的使用
    - （2）@RequestMapping注解的属性
    - （3）组合注解
    - （4）请求处理方法的参数类型和返回类型
  - 4.ViewResolver（视图解析器）

Spring MVC的注解

1.DispatcherServlet

DispatcherServlet的全名:

org.Springframework.web.servlet.DispatcherServlet

它在程序中充当着前端控制器的角色。

【示例】在使用DispatcherServlet时，只需将其配置在项目的web.xml文件中，其配置代码如下。

	<servlet>
        <!--配置前端过滤器-->
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--初始化时加载配置文件-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc-config.xml</param-value>
        </init-param>
        <!--表示容器在启动时立即加载Servlet -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

在上述代码中，<load-on-startup>元素和<init-param>元素都是可选的。如果<load-on-startup>元素的值为1，在应用程序启动时就会立即加载该Servlet；如果<load-on-startup>元素不存在，应用程序会就在第一个Servlet请求时加载该Servlet。如果<init-param>元素存在并且通过其子元素配置了Spring MVC配置文件的路径，应用程序在启动时就会加载配置路径下的配置文件；如果没有通过<init-param>元素配置，应用程序就会默认到WEB-INF目录下寻找如下方式命名的配置文件。

servletName-servlet.xml

servletName指的是部署在web.xml中的DispatcherServlet的名称，在上面web.xml中的配置代码中即为springmvc，而-servlet.xml是配置文件名的固定写法，所以应用程序会在WEB-INF下寻找springmvc-servlet.xml。

2.Controller注解类型

org.springframework.stereotype.Controller注解类型用于指示Spring类的实例是一个控制器，其注解形式为@Controller。该注解在使用时不需要再实现Controller接口，只需要将@Controller注解加入控制器类上，然后通过Spring的扫描机制找到标注了该注解的控制器即可。

【示例】@Controller注解在控制器类中的使用示例如下。

package com.ssm.controller;
import org.springframework.stereotype.Controller;
......
//Controller注解
@Controller
public class ControllerTest{
......
}

为了保证Spring能够找到控制器类，还需要在Spring MVC的配置文件中添加相应的扫描配置信息，具体如下。

（1）在配置文件的声明中引入spring-context。

（2）使用<context: component-scan>元素指定需要扫描的类包。

完整的配置文件如下。

<?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"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-4.3.xsd">
    <!--  指定需要扫描的包  -->
    <context:component-scan base-package="com.ssm.controller"/>
</beans>

<context: component-scan>元素的属性base-package指定了需要扫描的类包为com.ssm.controller。在运行时，该类包及其子包下所有标注了注解的类都会被Spring所处理。与实现了Controller接口的方式相比，使用注解的方式显然更加简单。同时，Controller接口的实现类只能处理一个单一的请求动作，而基于注解的控制器可以同时处理多个请求动作，在使用上更加灵活。因此，在实际开发中通常都会使用基于注解的形式。

注意

使用注解方式时，程序的运行需要依赖Spring的AOP包，因此需要向lib目录中添加spring.aop-4.3.6 RELEASE.jar，否则程序运行时会报错。

3.RequestMapping注解类型

（1）@RequestMapping注解的使用

Spring通过@Controller注解找到相应的控制器类后，还需要知道控制器内部对每一个请求是如何处理的，这就需要使用org.springframework.web.bind.annotation.RequestMapping注解类型。RequestMapping用于映射一个请求或一个方法，其注解形式为@RequestMapping，可以使用该注解标注在一个方法或一个类上。

（1）标注在方法上

当标注在一个方法上时，该方法将成为一个请求处理方法，它会在程序接收到对应的URL请求时被调用。

【示例】使用@RequestMapping注解标注在方法上的示例如下。

package com.ssm.controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

......
//Controller注解
@org.springframework.stereotype.Controller
public class AnnotationControllerTest {
    //@RequestMapping注解标注再方法上
    @RequestMapping(value="/annotationController")
    public ModelAndView handleRequest(HttpServletRequest arg0, HttpServletResponse arg1)throws Exception{
        ......
        return m;
    }

}

使用@RequestMapping注解后，上述代码中的handleRequest()方法就可以通过地址http://localhost:8080/chapter11/annotationController进行访问。

（2）标注在类上

当标注在一个类上时，该类中的所有方法都将映射为相对于类级别的请求，表示该控制器所处理的所有请求都被映射到value属性值所指定的路径下。

//Controller注解
@Controller

//@RequestMapping注解标注再方法上
@RequestMapping(value = "/controll")
public class AnnotationControllerTest {
    @RequestMapping(value="/annotationController")
    public ModelAndView handleRequest(HttpServletRequest arg0, HttpServletResponse arg1)throws Exception{
        ......
        return m;
    }

}

由于在类上添加了@RequestMapping注解，并且其value属性值为“/controll”，因此上述代码方法的请求路径将变为http://localhost:8080/chapter11/controll/annotationController。如果该类中还包含其他方法，那么在其他方法的请求路径中也需要加入“/ control”。

（2）@RequestMapping注解的属性

@RequestMapping注解除了可以指定value属性外，还可以指定一些其他属性，如表所示。

在这里插入图片描述
所有属性都是可选的，但其默认属性是value。当value是其唯一属性时，可以省略属性名，例如下面两种标注的含义相同。

@RequestMapping(value="/annotationController")
@RequestMapping("/annotationController")

（3）组合注解

前面已经对@RequestMapping注解及其属性进行了详细讲解，而在Spring 4.3版本中引入了组合注解来帮助简化常用的HTTP方法的映射，并更好地表达被注解方法的语义。其组合注解如下所示。

@GetMapping：匹配GET方式的请求。
@PostMapping：匹配POST方式的请求。
@PutMapping：匹配PUT方式的请求。
@DeleteMapping：匹配DELETE方式的请求。
@PatchMapping：匹配PATCH方式的请求。

以@GetMapping为例，该组合注解是@RequestMapping(method=RequestMethod.GET)的缩写，它会将Http Get映射到特定的处理方法上。在实际开发中，传统的@RequestMapping注解使用方式如下。

@RequestMapping(value="/user/{id}",method = RequestMethod.GET)
    public String selectUserById(string id){
        ......
    }

而使用新注解@GetMapping后，可以省略method属性，从而简化代码，使用方式如下。

  @GetMapping(value="/user/{fid}")
    public String selectUserById(string id){
        ......
    }

（4）请求处理方法的参数类型和返回类型

在控制器类中，每一个请求处理方法都可以有多个不同类型的参数，以及一个多种类型的返回结果。之前handleRequest()方法的参数就是对应请求的HttpServletRequest和HttpServletResponse两种参数类型。除此之外，还可以使用其他的参数类型，例如在请求处理方法中需要访问HttpSession对象，就可以添加HttpSession作为参数，Spring会将对象正确地传递给方法，其使用示例如下。

 @RequestMapping(value="/annotationController")
    public ModelAndView (httpSession session)
    {
        ......
        return m;
    }

在请求处理方法中，可以出现的参数类型如下。

javax.servlet.ServletRequest/javax.servlet.http.HttpServletRequest
javax.servlet.ServletResponse/javax.servlet.http.HttpServletResponse　
javax.servlet.http.HttpSession　
org.springframework.web.context.request.WebRequest或　
org.springframework.web.context.request.NativeWebRequest　
java.util.Locale
java.util.TimeZone (Java 6+)/java.time.Zoneld(on Java 8)　
java.io.InputStream/java.io.Reader　
Java.io.OutputStream/java.io.Writer　
org.springframework.http.HttpMethod　
java.security.Principal
@PathVariable、@MatrixVariable、@RequestParam、@RequestHeader、@RequestBody、　
@RequestPart、@SessionAttribute、@RequestAttribute注解　
HttpEntity<?>　
java.util.Map/org.springframework.ui.Model/lorg.springframework.ui.ModelMap　
org.springframework.web.servlet.mvc.support.RedirectAttributes　
org.springframework.validation.Errors/org.springframework.validation.BindingResult　
org.springframework.web.bind.support.SessionStatus　
org.springframework.web.util.UriComponentsBuilder

注意

org.springframework.ui.Model类型不是一个Servlet API类型，而是一个包含Map对象的Spring MVC类型。如果方法中添加了Model参数，那么每次调用该请求处理方法时，Spring MVC都会创建Model对象，并将其作为参数传递给方法。

入门案例中，请求处理方法返回的是一个ModelAndView类型的数据。除了这种类型外，请求处理方法还可以返回其他类型的数据。Spring MVC所支持的常见方法返回类型如下。

　ModelAndView　
　Model　
　Map　
　View　
　String　
　void　
　HttpEntity<?>或ResponseEntity<?>　
　Callable<?>　
  DeferredResult<?>

在上述列举的返回类型中，常见的返回类型有ModelAndView、String和void。其中，ModelAndView类型中可以添加Model数据，并指定视图；String类型的返回值可以跳转视图，但不能携带数据；而void类型主要在异步请求时使用，它只返回数据，而不会跳转视图。

由于ModelAndView类型未能实现数据与视图之间的解耦，因此在开发时，方法的返回类型通常都会使用String。既然String类型的返回值不能携带数据，那么在方法中是如何将数据带入视图页面呢？这就用到了上面所讲解的Model参数类型，通过该参数类型即可添加需要在视图中显示的属性。

返回String类型方法的示例代码如下。

 @RequestMapping(value="/annotationController")
    public String handleRequest(HttpServletRequest arg0, HttpServletResponse arg1,
                                Model model)throws Exception{
        model.addAttribute("msg","第一个Spring MVC程序");
        return "/WEB-INF/jsp/welcome.jsp";
   }

在上述方法代码中增加了一个Model类型的参数，通过该参数实例的addAttribute()方法即可添加所需数据。String类型除了可以返回上述代码中的视图页面外，还可以进行复位向与请求转发，具体方式如下。

（1）redirect复位向

例如，在修改用户信息操作后，将请求复位向到用户查询方法的实现代码如下。

@RequestMapping(value="/update")
    public String update(HttpServletRequest request, HttpServletResponse response,
                                Model model){
        //复位向请求路径
        return "redirect: queryUser";
   }

（2）forward请求转发

例如，用户执行修改操作时，转发到用户修改页面的实现代码如下。

    @RequestMapping(value="/toEdit")
    public String toEdit(HttpServletRequest request, HttpServletResponse response,
                         Model model){
        //复位向请求路径
        return "forward: editUser";
    }

4.ViewResolver（视图解析器）

Spring MVC中的视图解析器负责解析视图，可以在配置文件中定义一个ViewResolver来配置视图解析器，其配置示例如下。

    <!--定义视图解析器-->
    <bean id="viewResolver"
          class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!--设置前缀-->
        <property name="prefix" value="/WEB-INF/jsp/" />
        <!--设置后缀-->
        <property name="suffix" value=".isp" />
    
    </bean>

在上述代码中定义了一个id为viewResolver的视图解析器，并设置了视图的前缀和后缀属性。这样设置后，方法中所定义的view路径将可以简化。例如，入门案例中的逻辑视图名只需设置为“welcome”，而不再需要设置为“/WEB-INF/jsp/welcome.jsp”，在访问时视图解析器会自动地增加前缀和后缀。