【SpringMVC】SpringMVC基础篇

SpringMVC基础篇

---

---

前言

需要前置知识:Spring Maven Tomca MVC模式

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、SpringMVC的特点

• Spring 家族原生产品，与 IOC 容器等基础设施无缝对接
• 基于原生的Servlet，通过了功能强大的前端控制器DispatcherServlet，对请求和响应进行统一处理
• 表述层各细分领域需要解决的问题全方位覆盖，提供全面解决方案
• 代码清新简洁，大幅度提升开发效率
• 内部组件化程度高，可插拔式组件即插即用，想要什么功能配置相应组件即可
• 性能卓著，尤其适合现代大型、超大型互联网项目要求

二、初始配置

2.1 pom.xml

<packaging>warpackaging>

    
    <properties>
        <maven.compiler.source>8maven.compiler.source>
        <maven.compiler.target>8maven.compiler.target>
    properties>
    
    <dependencies>
        
        <dependency>
            <groupId>org.springframeworkgroupId>
            <artifactId>spring-webmvcartifactId>
            <version>5.3.1version>
        dependency>

        
        <dependency>
            <groupId>ch.qos.logbackgroupId>
            <artifactId>logback-classicartifactId>
            <version>1.2.3version>
        dependency>

        
        
        <dependency>
            <groupId>javax.servletgroupId>
            <artifactId>javax.servlet-apiartifactId>
            <version>3.1.0version>
            
            <scope>providedscope>
        dependency>

        
        <dependency>
            <groupId>org.thymeleafgroupId>
            <artifactId>thymeleaf-spring5artifactId>
            <version>3.0.11.RELEASEversion>
        dependency>
    dependencies>

2.2 配置web.xml

注册SpringMVC的前端控制器DispatcherServlet

2.2.1 默认配置

<servlet>
    <servlet-name>springMVCservlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
servlet>
<servlet-mapping>
    <servlet-name>springMVCservlet-name>
    
    <url-pattern>/url-pattern>
servlet-mapping>

2.2.2 扩展配置方式

可通过init-param标签设置SpringMVC配置文件的位置和名称，通过load-on-startup标签设置SpringMVC前端控制器DispatcherServlet的初始化时间

 
    
    <servlet>
        <servlet-name>SpringMVCservlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
        
        <init-param>
            
            <param-name>contextConfigLocationparam-name>
            
            <param-value>classpath:springMVC.xmlparam-value>
        init-param>
        
        
        <load-on-startup>1load-on-startup>
    servlet>
    <servlet-mapping>
        <servlet-name>SpringMVCservlet-name>
        
        <url-pattern>/url-pattern>
    servlet-mapping>

注:标签中使用/和/*的区别：

• /所匹配的请求可以是/login或.html或.js或.css方式的请求路径，但是/不能匹配.jsp请求路径的请求

• 因此就可以避免在访问jsp页面时，该请求被DispatcherServlet处理，从而找不到相应的页面

• /*则能够匹配所有请求，例如在使用过滤器时，若需要对所有请求进行过滤，就需要使用/*的写法

2.3 创建请求控制器

这里不过多讲解 @Controller注解 将当前类注册为控制层

@Controller
public Class HelloController {
}

2.4 创建springMVC的配置文件

    <context:component-scan base-package="com.worker.mvc">context:component-scan>


    
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/> 
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8" />
                    bean>
                property>
            bean>
        property>
    bean>

2.5 请求执行流程

1. 浏览器发送请求，若请求地址符合前端控制器的url-pattern，该请求就会被前端控制器DispatcherServlet处理。
2. 前端控制器会读取SpringMVC的核心配置文件，通过扫描组件找到控制器，将请求地址和控制器中@RequestMapping注解的value属性值进行匹配，
3. 若匹配成功，该注解所标识的控制器方法就是处理请求的方法。处理请求的方法需要返回一个字符串类型的视图名称，
4. 该视图名称会被视图解析器解析，加上前缀和后缀组成视图的路径，通过Thymeleaf对视图进行渲染，最终转发到视图所对应页面

流程图后续补上

三、@RequestMapping注解

3.1 @RequestMapping注解的功能

作用就是将请求和处理请求的控制器方法关联起来，建立映射关系。
SpringMVC 接收到指定的请求，就会来找到在映射关系中对应的控制器方法来处理这个请求。

3.2 @RequestMapping注解的位置

• @RequestMapping标识一个类：设置映射请求的请求路径的初始信息 : 该初始信息为请求前缀

@Controller
@RequestMapping("/test")
public class RequestController {

    @RequestMapping("/test1")
    public String test1(){
    
    }
}

此时的请求路径应该为/test/test1

• @RequestMapping标识一个方法：设置映射请求请求路径的具体信息

用来修饰方法,则为具体请求路径 /test1

3.3 @RequestMapping注解的value属性

• @RequestMapping注解的value属性通过请求的请求地址匹配请求映射

• @RequestMapping注解的value属性是一个字符串类型的数组，表示该请求映射能够匹配多个请求地址所对应的请求

• @RequestMapping注解的value属性必须设置，至少通过请求地址匹配请求映射

1. 多个Controller层中的RequestMapping注解如果value属性一样,则需要指定method属性不一致
2. value属性作为字符串数组,指定多个也可以解决value重复的异常问题

3.4 @RequestMapping注解的method属性

• @RequestMapping注解的method属性通过请求的请求方式（get或post）匹配请求映射

• @RequestMapping注解的method属性是一个RequestMethod类型的数组，表示该请求映射能够匹配多种请求方式的请求

• 若当前请求的请求地址满足请求映射的value属性，但是请求方式不满足method属性，则浏览器报错405：Request method ‘POST’ not supported

@RequestMapping(
        value = {"/test1", "/test2"},
        method = {RequestMethod.GET, RequestMethod.POST}
)
public String testRequestMapping(){
    return "success";
}

注：

1、对于处理指定请求方式的控制器方法，SpringMVC中提供了@RequestMapping的派生注解

处理get请求的映射-->@GetMapping

处理post请求的映射-->@PostMapping

处理put请求的映射-->@PutMapping

处理delete请求的映射-->@DeleteMapping

2、常用的请求方式有get，post，put，delete

但是目前浏览器只支持get和post，若在form表单提交时，为method设置了其他请求方式的字符串（put或delete），则按照默认的请求方式get处理

若要发送put和delete请求，则需要通过spring提供的过滤器HiddenHttpMethodFilter，在RESTful部分会讲到

3.5 @RequestMapping注解的params属性（了解)

• @RequestMapping注解的params属性通过请求的请求参数匹配请求映射

• @RequestMapping注解的params属性是一个字符串类型的数组，可以通过四种表达式设置请求参数和请求映射的匹配关系

• “param”：要求请求映射所匹配的请求必须携带param请求参数

• “!param”：要求请求映射所匹配的请求必须不能携带param请求参数

• “param=value”：要求请求映射所匹配的请求必须携带param请求参数且param=value

• “param!=value”：要求请求映射所匹配的请求必须携带param请求参数但是param!=value

@RequestMapping(
        value = {"/test1", "/test2"}
        ,method = {RequestMethod.GET, RequestMethod.POST}
        ,params = {"username","password!=123456"}
)
public String testRequest(){
    return "success";
}

注意
若当前请求满足@RequestMapping注解的value和method属性，但是不满足params属性，此时页面回报错400：
Parameter conditions “username, password!=123456” not met for actual request parameters: username={admin}, password={123456}

3.6 @RequestMapping注解的headers属性（了解）

• @RequestMapping注解的headers属性通过请求的请求头信息匹配请求映射

• @RequestMapping注解的headers属性是一个字符串类型的数组，可以通过四种表达式设置请求头信息和请求映射的匹配关系

• “header”：要求请求映射所匹配的请求必须携带header请求头信息

• “!header”：要求请求映射所匹配的请求必须不能携带header请求头信息

• “header=value”：要求请求映射所匹配的请求必须携带header请求头信息且header=value

• “header!=value”：要求请求映射所匹配的请求必须携带header请求头信息且header!=value

@RequestMapping(value = "testParam",
            params = {"username=admin"},
            headers = {"Host=localhost:8080"}
    )
    public String testParam(@RequestParam("username") String username){
        System.out.println("username = " + username);
        return "target";
    }

注:

1. headers里的属性和值必须存在于请求头
2. 若当前请求满足@RequestMapping注解的value和method属性，但是不满足headers属性，此时页面显示404错误，即资源未找到

3.7 SpringMVC支持ant风格的路径

？：表示任意的单个字符

*：表示任意的0个或多个字符

**：表示任意的一层或多层目录

注：
在使用*时，只能使用//xxx的方式,
如果是/aa/xxx,则表示的作用,而不是**

3.8 SpringMVC支持路径中的占位符（重点）

原始方式：/deleteUser?id=1

rest方式：/deleteUser/1

• SpringMVC路径中的占位符常用于RESTful风格中，当请求路径中将某些数据通过路径的方式传输到服务器中，就可以在相应的@RequestMapping注解的value属性中通过占位符{xxx}表示传输的数据，
• 书写格式 /path1/{value1}/{value2}
• 在通过@PathVariable注解，将占位符所表示的数据赋值给控制器方法的形参

<a th:href="@{/testRest/1/admin}">测试路径中的占位符-->/testResta><br>

@RequestMapping("/testRest/{id}/{username}")
public String testRest(@PathVariable("id") String id, @PathVariable("username") String username){
    System.out.println("id:"+id+",username:"+username);
    return "success";
}
//最终输出的内容为-->id:1,username:admin

四、SpringMVC获取请求参数

4.1 通过ServletAPI获取

将HttpServletRequest作为控制器方法的形参，此时HttpServletRequest类型的参数表示封装了当前请求的请求报文的对象

@RequestMapping("/testParam")
public String testParam(HttpServletRequest request){
    String username = request.getParameter("username");
    String password = request.getParameter("password");
    System.out.println("username:"+username+",password:"+password);
    return "success";
}

注：

1. 若请求所传输的请求参数中有多个同名的请求参数，此时可以在控制器方法的形参中设置字符串数组或者字符串类型的形参接收此请求参数

2. 若使用字符串数组类型的形参，此参数的数组中包含了每一个数据

3. 若使用字符串类型的形参，此参数的值为每个数据中间使用逗号拼接的结果

4.2 通过控制器方法的形参获取请求参数

在控制器方法的形参位置，设置和请求参数同名的形参，当浏览器发送请求，匹配到请求映射时，在DispatcherServlet中就会将请求参数赋值给相应的形参

<a th:href="@{/testParam(username='admin',password=123456)}">测试获取请求参数-->/testParama><br>

@RequestMapping("/testParam")
public String testParam(String username, String password){
    System.out.println("username:"+username+",password:"+password);
    return "success";
}

4.3 @RequestParam

@RequestParam注解一共有三个属性：

1. value：指定为形参赋值的请求参数的参数名

2. required：设置是否必须传输此请求参数，默认值为true

若设置为true时，则当前请求必须传输value所指定的请求参数，若没有传输该请求参数，且没有设置defaultValue属性，则页面报错400：Required String parameter ‘xxx’ is not present；若设置为false，则当前请求不是必须传输value所指定的请求参数，若没有传输，则注解所标识的形参的值为null

3. defaultValue：不管required属性值为true或false，当value所指定的请求参数没有传输或传输的值为""时，则使用默认值为形参赋值

@RequestMapping("/testParam2")
    /*@RequestParam("请求参数名") 请求参数与形参映射
    * defaultValue 解决请求没有传值 但是必须传值的情况 */
    public String testParam2(@RequestParam(value = "username",required = false)String username){
        System.out.println( "username = " + username);
        return "success";
    }

4.4 @RequestHeader

@RequestHeader是将请求头信息和控制器方法的形参创建映射关系
@RequestHeader注解一共有三个属性：value、required、defaultValue，用法同@RequestParam

@RequestMapping("/testHeader")
    public String testHeader(@RequestHeader("Connection") String conn){
        System.out.println("conn = " + conn);
        return "success";
    }

注:
这里的请求头参数必须请求头拥有,否则报错

4.5 @CookieValue

@CookieValue是将cookie数据和控制器方法的形参创建映射关系
@CookieValue注解一共有三个属性：value、required、defaultValue，用法同@RequestParam

@RequestMapping("/testCookie")
    public String testHeader(@CookieValue( value = "JSESSIONID",required = true,defaultValue = "哈哈") String cookie){
        System.out.println(" cookie +=" + cookie);
        return "success";
    }

注:
这里的value值是固定的name,客户端第一次请求,服务器会将session随着请求传递过来,客户端则会使用set-Cookie 将session的id存储到JSESSIONID这个键中

4.6 通过POJO获取请求参数

当实体类的属性名与请求参数名一致,请求参数则会自动给此属性进行赋值

<form th:action="@{/testpojo}" method="post">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    性别：<input type="radio" name="sex" value="男">男<input type="radio" name="sex" value="女">女<br>
    年龄：<input type="text" name="age"><br>
    邮箱：<input type="text" name="email"><br>
    <input type="submit">
form>

/* POJO */
    @RequestMapping("/testpojo")
    public String testPojo(User user){
        System.out.println("User = " + user);
        return "success";
    }

最终结果-->User{id=null, username='张三', password='123', age=23, sex='男', email='[email protected]'}

4.7 解决获取请求参数的乱码问题

解决获取请求参数的乱码问题，可以使用SpringMVC提供的编码过滤器CharacterEncodingFilter，但是必须在web.xml中进行注册

<filter>    
  <filter-name>CharacterEncodingFilterfilter-name>   
  <filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class>
  <init-param>        
    <param-name>encodingparam-name>       
    <param-value>UTF-8param-value>    
  init-param>    
  <init-param>        
    <param-name>forceResponseEncodingparam-name>      
    <param-value>trueparam-value>    
  init-param>
filter>
<filter-mapping>   
   <filter-name>CharacterEncodingFilterfilter-name>    
   <url-pattern>/*url-pattern>
filter-mapping>

注:
SpringMVC中处理编码的过滤器一定要配置到其他过滤器之前，否则无效

五、域对象共享数据

5.1 使用ServletAPI向request域对象共享数据

@RequestMapping("/testServletAPI")
public String testServletAPI(HttpServletRequest request){
    request.setAttribute("testScope", "hello,servletAPI");
    return "success";
}

5.2 使用ModelAndView向request域对象共享数据

ModelAndView 将视图和模型进行组合返回,由视图解析器通过视图名称进行处理 返回html页面
所以返回值必须是ModelAndView的实例

/* 接口的实现类是同一个*/
    @RequestMapping("/testModelAndView")
    public ModelAndView testModelAndView(){
        /**
         * 最后都会封装到Model和View的ModelAndView中
         * 需要将模型数据和视图名称返回给前端控制器
         * view 视图名称经过视图解析 跳转到指定也页面
         * ModelAndView有Model和View的功能
         * Model主要用于向请求域共享数据
         * View主要用于设置视图，实现页面跳转
         */
        ModelAndView mav = new ModelAndView();
        mav.addObject("mav","hello mav");
        mav.setViewName("success");
        return mav;
    }

5.3 使用Model向request域对象共享数据

@RequestMapping("/testModel")
    public String testModel(Model model){
        model.addAttribute("request","hello model");
        System.out.println(model.getClass().getName());
        return "success";
    }

5.4 使用map向request域对象共享数据

@RequestMapping("/testMap")
    public String testMap(Map<String,Object> model){
        model.put("request","hello map");
        System.out.println(model.getClass().getName());
        return "success";
    }

5.5 使用ModelMap向request域对象共享数据

@RequestMapping("/testModelMap")
    public String testModelMap(ModelMap model){
        model.addAttribute("request","hello modelmap");
        System.out.println(model.getClass().getName());
        return "success";
    }

5.6 Model、ModelMap、Map的关系

1. Model、ModelMap、Map类型的参数其实本质上都是 BindingAwareModelMap 类型的

2. BindingAwareModelMap继承于ExtendedModelMap
   ExtendedModelMap继承于ModelMap 实现了Model
   ModelMap继承了LinkedHashMap
   LinkedHashMap又实现了Map接口
   所以这三个都可以用来共享请求域的数据

public interface Model{}
public class ModelMap extends LinkedHashMap<String, Object> {}
public class ExtendedModelMap extends ModelMap implements Model {}
public class BindingAwareModelMap extends ExtendedModelMap {}

5.7 向session域共享数据

这里直接使用的servletApi

@RequestMapping("/testSession")
public String testSession(HttpSession session){
    session.setAttribute("testSessionScope", "hello,session");
    return "success";
}

5.8 向application域共享数据

这里直接使用的servletApi

@RequestMapping("/testApplication")
public String testApplication(HttpSession session){
	ServletContext application = session.getServletContext();
    application.setAttribute("testApplicationScope", "hello,application");
    return "success";
}

六、SpringMVC的视图

• SpringMVC中的视图是View接口，视图的作用渲染数据，将模型Model中的数据展示给用户

• SpringMVC视图的种类很多，默认有转发视图和重定向视图

• 当工程引入jstl的依赖，转发视图会自动转换为JstlView

• 若使用的视图技术为Thymeleaf，在SpringMVC的配置文件中配置了Thymeleaf的视图解析器，由此视图解析器解析之后所得到的是ThymeleafView

6.1 ThymeleafView

当此时的视图名称没有任何前缀则有SpringMVC.xml配置的ThyemeafView解析器进行解析
默认就是转发视图

@RequestMapping("/testHello")
public String testHello(){
    return "hello";
}

6.2 转发视图

• SpringMVC中默认的转发视图是InternalResourceView

• SpringMVC中创建转发视图的情况：

• 当控制器方法中所设置的视图名称以"forward:"为前缀时，创建InternalResourceView视图，此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析，而是会将前缀"forward:"去掉，剩余部分作为最终路径通过转发的方式实现跳转

例如"forward:/"，“forward:/employee”

@RequestMapping("/testForward")
public String testForward(){
   return "forward:/testHello";
}

6.3 重定向视图

• SpringMVC中默认的重定向视图是RedirectView

1. 当控制器方法中所设置的视图名称以"redirect:"为前缀时，创建RedirectView视图
2. 此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析
3. 而是会将前缀"redirect:"去掉，剩余部分作为最终路径通过重定向的方式实现跳转

例如"redirect:/"，“redirect:/employee”

@RequestMapping("/testRedirect")
public String testRedirect(){
    return "redirect:/testHello";
}

6.4 视图控制器view-controller

当控制器方法中，仅仅用来实现页面跳转，即只需要设置视图名称时，可以将处理器方法使用view-controller标签进行表示

    <mvc:view-controller path="/" view-name="index">mvc:view-controller>

    
    <mvc:annotation-driven/>

---

总结

以上就是今天要讲的内容，本文仅仅简单介绍了