spring MVC 常用注解 Day6 2018-11-24

作者: Ernest_Chou | 来源:发表于2018-11-24 20:33 被阅读0次

SSM框架搭建

Spring+SpringMVC+MyBatis
spring-5.1.2.RELEASE
mybatis-3.4.6
jdk1.8+

一、springMVC应用

1. 基础springMVC应用

1.1 web.xml配置拦截器

 <!-- springMVC配置 前端控制器 -->
  <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>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <!-- 配置springMVC 前端拦截器 拦截所有请求 -->
  <servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

1.2 springMVC配置映射

springmvc-config.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-4.3.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context-4.3.xsd
    http://www.springframework.org/schema/mvc
    http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd">
    <!-- 配置Handle,映射"/hello"请求 -->
    <bean name="/hello" class="com.zhougl.web.controller.HelloController"/>
    <!-- 处理映射器将bean的name作为url进行查找，需要在配置handle时指定name（既url） -->
    <bean class="org.springframework.aop.framework.autoproxy.BeanNameAutoProxyCreator"/>
    <!-- SimpleControllerHandlerAdapter 处理器适配器，所有处理适配器都要实现HandlerAdapter接口-->
    <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>
    <!-- 视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
 
</beans>

1.3 controller类实现

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

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;
/**
 * 实现Controller接口的处理器，可以处理单一请求动作
 * @author zgldo
 *
 */
public class HelloController implements Controller {
    
    private static final Log logger = LogFactory.getLog(HelloController.class);
    /**
     * handleRequest是Controller接口必须实现的方法
     * 该方法必须返回一个包含视图名或视图名和模型的ModelAndView对象
     */
    @Override
    public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        logger.info("handleRequest 被调用...");
        // 创建准备返回的ModelAndView对象，该对象通常包含了返回视图名、模型的名称以及模型对象
        ModelAndView modelAndView = new ModelAndView();
        //添加模型数据，可以是任意的pojo对象
        modelAndView.addObject("message", "Hello World!");
        //设置逻辑视图名，视图解析器会根据该名字解析到具体的视图页面
        modelAndView.setViewName("/hello.jsp");
        return modelAndView;
    }

}

1.4 View页面

jsp用EL表达式获取视图值

<body>
${requestScope.message}
</body>

1.5 访问

http://localhost:8080/maven-springMVC/hello

2. @Controller、@RequestMapping注解应用

@Controller用来标记一个spring MVC Controller对象，既一个控制器类。
@RequestMapping注解的方法才是真正处理请求的处理器。
Spring使用扫描机制查找所有基于注解的控制器类，分发处理器会扫描该类，检测是否使用了@RequestMapping注解，处理请求。

2.1 @Controller基础注解配置

web.xml配置不变

2.1.1 springMVC配置扫描

配置springmvc-config.xml

<!-- 开启spring扫描 -->
    <!-- spring可以自动扫描back-package 下面的包或者子包下面的java文件，
        如果扫描到有spring相关注解类，则把这些类注册为spring的bean -->
    <context:component-scan base-package="com.zhougl.web" />
    
    <!-- 配置annotation类型的处理映射器 -->
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"/>
    <!-- 配置annotation类型的处理器适配器 -->
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"/>
    <!-- 视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>

2.1.2 用注解实现controller类

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

/**
 * 基于注解的控制器
 * 可以同时处理多个请求动作，并且无须实现任何接口
 *  Controller 注解用于指示该类是一个控制器
 * @author zgldo
 *
 */
@Controller
public class AnnotationController {
    private static final Log logger = LogFactory.getLog(AnnotationController.class);
    
    /**
     *  RequestMapping 用了映射请求的URL和请求的方法。本例用了映射"/helloAnnotation"
     * @return
     */
    @RequestMapping(value="/helloAnnotation")
    public ModelAndView helloAnnotation() {
        logger.info("helloAnnotation 方法  被调用...");
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("message", "Hello Annotation!");
        modelAndView.setViewName("/hello.jsp");
        return modelAndView;
    }
}

2.1.3 访问

http://localhost:8080/maven-springMVC/helloAnnotation

2.2 @Controller不同配置写法

web.xml写法不变

2.2.1 springMVC配置

配置springmvc-config.xml

<!-- 开启spring扫描 -->
    <!-- spring可以自动扫描back-package 下面的包或者子包下面的java文件，
        如果扫描到有spring相关注解类，则把这些类注册为spring的bean -->
    <context:component-scan base-package="com.zhougl.web.controller" />
    <!-- 处理器映射器、处理器适配器不配置时，spring会使用默认配置处理请求 -->
    <!-- 视图解析器 -->
    <bean id="viewResolver"  class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix">
            <value>/</value>
        </property>
        <!-- 后缀 -->
        <property name="suffix">
            <value>.jsp</value>
        </property>
    </bean>

2.2.2 controller类的写法

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * 基于注解的控制器
 * 可以同时处理多个请求动作，并且无须实现任何接口
 *  Controller 注解用于指示该类是一个控制器
 * @author zgldo
 *
 */
@Controller
public class AnnotationController {
    private static final Log logger = LogFactory.getLog(AnnotationController.class);
    
    /**
     * 不同配置的视图解析器下、带model参数的映射   
     * @param model
     * @return
     */
    @RequestMapping("/helloModel")
    public String helloModelAnnotation(Model model) {
        model.addAttribute("message", "Hello Model");
        return "hello";
    }
}

2.2.3 访问

http://localhost:8080/maven-springMVC/helloModel

2.3 @RequestMapping注解

@RequestMapping，表示该控制器所有请求都被映射到value属性所指示的路径下。
@RequestMapping注解支持属性

属性	类型	说明
value	String[]	用于指定请求的实际地址映射到方法
name	String	给映射地址指定一个别名
method	RequestMethod[]	映射指定请求的方法类型，包括GET、POST、HEAD、OPTIONS、PUT、PATCH、DELETE、TRACE
consumes	String[]	指定处理请求的提交内容类型（Content-Type）,例如：application/json、text/html等
produces	String[]	指定返回的内容类型，返回的内容必须是request请求头（Accept）中所包含的类型
params	String[]	指定request中必须包含某些参数值时，才让该方法处理
header	String[]	指定request中必须包含某些指定的header值，才能让该方法处理请求
Path	String[]	在Servlet环境中只有：uri路径映射（例如“/mypath.do”）.也支持如ant的基于路径模式（例如“/mypath/*,”）。在方法层面上，支持相对路径（例如“edit.do”）

2.3.1 value属性

//访问url http://localhost:8080/maven-springMVC/hello   
//注释类时需要在/hello前面加上类注释的属性值
//注释一个方法
@RequestMapping(value="/hello")
public ModelAndView hello(){
    return ...;
}

//如果@RequestMapping属性唯一时，可以省略属性名;如果有超过一个属性，则必须写上value属性名称
@RequestMapping(value="/hello")
@RequestMapping("/hello")

value属性的值为空字符串时，url：http://localhost:8080/maven-springMVC

2.3.2 method属性

该属性用来指示该方法处理哪些HTTP请求。

只支持POST请求：@RequestMapping(value="/hello",method=RequestMethod.POST)

如果没有指定method属性值，则请求处理方法可以处理任意的HTTP请求。

2.3.3 consumes属性

该方法指定处理请求的提交内容类型（Content-Type）。

@RequestMapping(value="/hello",method=RequestMethod.POST，consumes="application/json")表示方法仅处理request Conten-Type为"application/json"类型的请求。

2.3.4 produces属性

@RequestMapping(value="/hello",method=RequestMethod.POST，produces="application/json")表示方法仅处理request请求中Accept头中包含了"application/json"类型的请求，并且指明了返回的内容类型为"application/json"。

2.3.5 params属性

该属性指定request中必须包含某些参数值，才让该方法处理。

@RequestMapping(value="/hello",method=RequestMethod.POST，params="myParam=myValue")表示方法仅处理其中myParam值为myValue的请求。

2.3.6 header属性

该属性指定request中必须包含某些指定的header值，才能让该方法处理请求。

@RequestMapping(value="/hello",method=RequestMethod.POST，header="Referer=http://www.zhougl.com/")表示方法仅处理request的header中包含了指定“Referer”请求头且对应值为“http://www.zhougl.com/”的请求。

2.4 请求处理方法可出现的参数类型

javax.servlet.ServletRequest 或 javax.servlet.http.HttpServletRequest
javax.servlet.ServletResponse 或 javax.servlet.http.HttpServletResponse
javax.servlet.http.HttpSession
org.springframework.web.context.request.NativeWebRequest或org.springframework.web.context.request.WebRequest
java.util.Locale
java.io.InputStream或java.io.Reader
java.io.OutputStream或java.io.Writer
java.security.Principal
HttpEntity<?>
java.util.Map
org.springframework.ui.Model
org.springframework.ui.ModelMap
org.springframework.validation.BindingResult
``org.springframework.validation.Errors`
org.springframework.web.servlet.mvc.support.RedirectAttributes
org.springframework.web.bind.support.SessionStatus
org.springframework.web.util.UriComponents
@PathVariable、@MatrixVariable注解
@RequestParam、@RequestHeader、@RequestBody、@RequestPart注解

2.5 请求方法可返还的类型结果

org.springframework.web.servlet.ModelAndView
org.springframework.ui.Model
java.util.Map<k,v>
org.springframework.web.servlet.View
java.lang.String
HttpEntity或ResponseEntity
java.util.concurrent.Callable
org.springframework.web.context.request.async.DeferredResult
void

2.5 Model 和ModelAndView

Spring MVC框架将模型数据传递给视图提供了多种输出模型：

Model 和ModelMap 实现了java.util.Map接口
ModelAndView
@ModelAttribute
@SessionAttributes

2.5.1 Model和ModelMap

Spring MVC在调用处理方法之前，会创建一个隐含的模型对象，存储模型数据。如果方法参数为Model或ModelMap类型，则会将隐含模型的引用传递给这些参数。

//将User对象添加到Model或ModelMap中
addAttribute(String attributeName, Object attributeValues);

model

  @Controller
  public class UserModelTestController {
  
  
  //@ModelAttribute修饰的方法会优先login调用
  @ModelAttribute
  public void userModel(String loginName,String password,Model model) {
    //创建User对象存储jsp页面传入的参数
    User user = new User();
    user.setLoginName(loginName);
    user.setPassword(password);
      
    //将User对象添加到Model中
    model.addAttribute("user",user);
  }
  @RequestMapping(value="/login_model")
  public String login(Model model) {
    
    //从model中取出之前存入的名为user的对象
    User user = (User) model.asMap().get("user");
    
    //设置user对象的userName属性
    user.setUserName("测试输出模型Model");
    return "requestMappingTest/loginResult";
  }
  }

modelMap

@Controller
public class UserModelMapTestController {

    //@ModelAttribute修饰的方法会优先login调用
    @ModelAttribute
    public void userModel(String loginName,String password,ModelMap modelMap) { 
        //创建User对象存储jsp页面传入的参数
        User user = new User();
        user.setLoginName(loginName);
        user.setPassword(password);
        
        //将User对象添加到ModelMap中
        modelMap.addAttribute("user",user);
    }
    @RequestMapping(value="/login_modelMap")
    public String login(ModelMap modelMap) {
        //从modelMap中取出之前存入的名为user的对象
        User user = (User) modelMap.get("user");
        
        //设置user对象的userName属性
        user.setUserName("测试输出模型ModelMap");
        return "requestMappingTest/loginResult";
    }
}

2.5.3 ModelAndView

既包含模型数据信息又包含视图信息

//将User对象添加到ModelAndView中
modelAndView.addObject(String attributeName, Object attributeValues);

//设置返回视图名称
modelAndView.setViewName(String viewName);

@Controller
public class UserModelAndViewTestController {
        //@ModelAttribute修饰的方法会优先login调用
        @ModelAttribute
        public void userModel(String loginName,String password
                              ,ModelAndView modelAndView) {
            //创建User对象存储jsp页面传入的参数
            User user = new User();
            user.setLoginName(loginName);
            user.setPassword(password);
            
            //将User对象添加到ModelAndView中
            modelAndView.addObject("user", user);
        }
        @RequestMapping(value="/login_modelAndView")
        public ModelAndView login(ModelAndView modelAndView) {
            //从ModelAndView的Model中取出之前存入的名为user的对象
            User user = (User) modelAndView.getModel().get("user");
            
            //设置user对象的userName属性
            user.setUserName("测试输出模型ModelAndView");
            //设置返回视图名称
            modelAndView.setViewName("requestMappingTest/loginResult");
            return modelAndView;
        }
}

3. 参数绑定注解

常用类型根据处理的request的不同内容部分可以分为四类：

处理request body部分的注解：@RequestParam、@RequestBody。
处理request uri部分的注解：@pathVariable。
处理request header部分的注解:@RequestHeader、@CookieValue。
处理attribute类型的注解：@SessionAttributes、@ModelAttribute。