SpringMVC（1）环境搭建&&@RequestMapping注解&&springmvc获取请求参数

• 环境配置
• @RequestMapping注解
• 获取请求参数的方法

1、SpringMVC简介

1.1、什么是MVC

MVC是一种软件架构的思想，将软件按照模型、视图、控制器来划分

M：Model，模型层，指工程中的JavaBean，作用是处理数据

JavaBean分为两类：

• 一类称为实体类Bean：专门存储业务数据的，如 Student、User 等
• 一类称为业务处理 Bean：指 Service 或 Dao 对象，专门用于处理业务逻辑和数据访问。

V：View，视图层，指工程中的html或jsp等页面，作用是与用户进行交互，展示数据
C：Controller，控制层，指工程中的servlet，作用是接收请求和响应浏览器

MVC的工作流程：用户通过视图层发送请求到服务器，在服务器中请求被Controller接收，Controller调用相应的Model层处理请求，处理完毕将结果返回到Controller，Controller再根据请求处理的结果找到相应的View视图，渲染数据后最终响应给浏览器

1.2、什么是SpringMVC

SpringMVC是Spring的一个后续产品，是Spring的一个子项目

SpringMVC 是 Spring 为表述层开发提供的一整套完备的解决方案。在表述层框架历经 Strust、WebWork、Strust2 等诸多产品的历代更迭之后，目前业界普遍选择了 SpringMVC 作为 Java EE 项目表述层开发的首选方案。

注：三层架构分为表述层（或表示层）、业务逻辑层、数据访问层，表述层表示前台页面和后台
servlet

1.3、SpringMVC的特点

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

2、入门案例

2.1、开发环境

• IDE：idea 2021.3
• 构建工具：maven3.8.4
• 服务器：tomcat 9.0
• Spring版本：5.3.1

2.2、创建maven工程

1>添加web模块

• 注意需要将web模块 放在 ，src/main 下

2>打包方式：war

3>引入依赖

pom.xml

<dependencies>
    <!-- SpringMVC -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.3.1</version>
    </dependency>
    <!-- 日志 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>
    <!-- ServletAPI -->
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>
    <!-- Spring5和Thymeleaf整合包 -->
    <dependency>
        <groupId>org.thymeleaf</groupId>
        <artifactId>thymeleaf-spring5</artifactId>
        <version>3.0.12.RELEASE</version>
    </dependency>
</dependencies>

注：由于 Maven 的传递性，我们不必将所有需要的包全部配置依赖，而是配置最顶端的依赖，其他靠传递性导入。

2.3、配置web.xml

• 注册SpringMVC的前端控制器DispatcherServlet

2>默认配置方式

web.xml

<dependencies>
    <!-- SpringMVC -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.3.1</version>
    </dependency>
    <!-- 日志 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>
    <!-- ServletAPI -->
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>
    <!-- Spring5和Thymeleaf整合包 -->
    <dependency>
        <groupId>org.thymeleaf</groupId>
        <artifactId>thymeleaf-spring5</artifactId>
        <version>3.0.12.RELEASE</version>
    </dependency>
</dependencies>

此配置作用下，SpringMVC的配置文件默认位于WEB-INF下，默认名称为<servlet-name>-servlet.xml，

例如 以下配置所对应SpringMVC的配置文件位于WEB-INF下，文件名为springMVCservlet.xml

2>扩展配置方式

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

<!-- 配置SpringMVC的前端控制器，对浏览器发送的请求统一进行处理 -->
<servlet>
    <servlet-name>springMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servletclass>
    <!-- 通过初始化参数指定SpringMVC配置文件的位置和名称 -->
    <init-param>
        <!-- contextConfigLocation为固定值 -->
        <param-name>contextConfigLocation</param-name>
        <!-- 使用classpath:表示从类路径查找配置文件，例如maven工程中的src/main/resources -->
        <param-value>classpath:springMVC.xml</param-value>
    </init-param>
    <!--
作为框架的核心组件，在启动过程中有大量的初始化操作要做而这些操作放在第一次请求时才执行会严重影响访问速度因此需要通过此标签将启动控制DispatcherServlet的初始化时间提前到服务器启动时
-->
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <!--
设置springMVC的核心控制器所能处理的请求的请求路径
/所匹配的请求可以是/login或.html或.js或.css方式的请求路径
但是/不能匹配.jsp请求路径的请求
-->
    <url-pattern>/</url-pattern>
</servlet-mapping>

注：<url-pattern>标签中使用/和/*的区别：
/ 所匹配的请求可以是/login或.html或.js或.css方式的请求路径，但是/不能匹配.jsp请求路径的请求

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

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

2.4、创建请求控制器

由于前端控制器对浏览器发送的请求进行了统一的处理，但是具体的请求有不同的处理过程，因此需要创建处理具体请求的类，

即请求控制器 ,请求控制器中每一个处理请求的方法成为控制器方法

因为SpringMVC的控制器由一个POJO（普通的Java类）担任，因此需要通过@Controller注解将其标识
为一个控制层组件，交给Spring的IOC容器管理，此时SpringMVC才能够识别控制器的存在

@Controller
public class HelloController {
    
}

2.5、创建SpringMVC的配置文件

springMVC-servlet.xml

<!-- 自动扫描包 -->
<context:component-scan base-package="com.atguigu.mvc.controller"/>
<!-- 配置Thymeleaf视图解析器 -->
<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>
<!--
处理静态资源，例如html、js、css、jpg
若只设置该标签，则只能访问静态资源，其他请求则无法访问
此时必须设置<mvc:annotation-driven/>解决问题
-->
<mvc:default-servlet-handler/>
<!-- 开启mvc注解驱动 -->
<mvc:annotation-driven>
    <mvc:message-converters>
        <!-- 处理响应中文内容乱码 -->
        <bean
              class="org.springframework.http.converter.StringHttpMessageConverter">
            <property name="defaultCharset" value="UTF-8" />
            <property name="supportedMediaTypes">
                <list>
                    <value>text/html</value>
                    <value>application/json</value>
                </list>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

2.6、测试HelloWorld

1>实现对首页的访问

在请求控制器中创建处理请求的方法

// @RequestMapping注解：处理请求和控制器方法之间的映射关系
// @RequestMapping注解的value属性可以通过请求地址匹配请求，/表示的当前工程的上下文路径
// localhost:8080/springMVC/
@RequestMapping("/")
public String index() {
    //设置视图名称
    return "index";
}

2>通过超链接跳转到指定页面

在主页index.html中设置超链接

index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>首页</title>
    </head>
    <body>
        <h1>首页</h1>
        <a th:href="@{/hello}">HelloWorld</a><br/>
    </body>
</html>

在请求控制器中创建处理请求的方法

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

2.7、总结

①浏览器发送请求，若请求地址符合前端控制器的url-pattern，

②该请求就会被前端控制器DispatcherServlet处理。

③前端控制器会读取SpringMVC的核心配置文件，通过扫描组件找到控制器，

④将请求地址和控制器中@RequestMapping注解的value属性值进行匹配，

⑤若匹配成功，该注解所标识的控制器方法就是处理请求的方法。处理请求的方法需要返回一个字符串类型的视图名称，该视图名称会被视图解析器解析，加上前缀和后缀组成视图的路径，通过Thymeleaf对视图进行渲染，最终转发到视图所对应页面

前缀和后缀 在 springMVC-servlet.xml 中设置

​

3、@RequestMapping注解

3.1、@RequestMapping注解的功能

从注解名称上我们可以看到，@RequestMapping注解的作用就是将请求和处理请求的控制器方法关联起来，建立映射关系。

SpringMVC 接收到指定的请求，就会来找到在映射关系中对应的控制器方法来处理这个请求。

RequestMapping.java

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    String name() default "";

    @AliasFor("path")
    String[] value() default {};

    @AliasFor("value")
    String[] path() default {};

    RequestMethod[] method() default {};

    String[] params() default {};

    String[] headers() default {};

    String[] consumes() default {};

    String[] produces() default {};
}

3.2、@RequestMapping注解的位置

@RequestMapping标识一个类：设置映射请求的请求路径的初始信息

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

例如

@Controller
@RequestMapping("class")   // 请求映射的基本信息，方法上面试具体信息 
public class TestRequestMappingController {
//    此时控制器方法所匹配的请求的路径/controller/index
    @RequestMapping("/")
    public String protal(){
        return "index";
    }
    @RequestMapping(value={"/hello","hello1"},)   
    public String test(){
        return "success";
    }
}

/controller/index , 类似于父目录与子目录

3.3、@RequestMapping注解的value属性

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

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

• 源码如下

@AliasFor("path")
String[] value() default {};

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

@RequestMapping(value = {"/testRequestMapping", "/test"})
public String testRequestMapping(){
    return "success";
}

3.4、@RequestMapping注解的method属性

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

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

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

测试代码如下：

<a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a><br>
<form th:action="@{/test}" method="post">
    <input type="submit" value="@RequestMapping 注解method 测试">
</form>

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

RequestMethod.java 源码

public enum RequestMethod {
    GET,
    HEAD,
    POST,
    PUT,
    PATCH,
    DELETE,
    OPTIONS,
    TRACE;

    private RequestMethod() {
    }
}

注：
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

<a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a><br>
<form th:action="@{/test}" method="post">
<input type="submit">
</form>

@RequestMapping(
    value = {"/testRequestMapping", "/test"},
    method = {RequestMethod.GET, RequestMethod.POST}
)
public String testRequestMapping(){
    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和method属性，但是不满足headers属性，此时页面
显示404错误，即资源未找到

3.7、SpringMVC支持ant风格的路径

• ？：表示任意的单个字符
• *：表示任意的0个或多个字符
• **：表示任意层数的任意目录
• 注意：在使用**时，只能使用/**/xxx的方式

3.8、SpringMVC支持路径中的占位符

• 原始方式：/deleteUser?id=1
• rest方式：/user/delete/1

需要在@RequestMapping 注解的value属性中所设置的路径中， 使用{xx}占位符的方式表示路径中的数据

再通过@PathVariable("xx") 注解，将占位符所标志 的值和控制器方法的形参进行绑定

测试代码

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

@Controller
@RequestMapping("class")   // 请求映射的基本信息，方法上面试具体信息  /class/index , 类似于父目录与子目录
public class TestRequestMappingController {
    @RequestMapping("/testRest/{id}/{username}")
    public String test(@PathVariable("id") String id, @PathVariable("username")String username){
        String userId =id;
        String userName=username;
        System.out.println("id:"+id+",username:"+username);   //id:1,username:admin
        return "success";
    }
}

/testRest/1/admin — > 1: {id} admin: {username}

4、SpringMVC获取请求参数

4.1、通过ServletAPI获取

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

<form th:href="@{/Param/servletAPI}"  method=post>
    用户名<input type="text" name="username"></intput><br/>
    密码<input type="text" name="passward"></intput><br/>
    提交<input type="submit" value="提交" /><br/>
</form>

@Controller
public class TestParamController{
    @RequestMapping("/Param/servletAPI")
    public String getParmByServletAPI(HttpServletRequest request){
        String username = request.getParameter("username");
        String password = request.getParameter("password");
        System.out.println("username:"+username+",password:"+password);
        return "success";
    }  
}

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

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

• 只需要在控制器（Controller）方法（testParam）的形参位置，设置一个形参，形参的名字和请求参数的名字一致即可

注：
若请求所传输的请求参数中有多个同名的请求参数，此时可以在控制器方法的形参中设置字符串
数组或者字符串类型的形参接收此请求参数
若使用字符串数组类型的形参，此参数的数组中包含了每一个数据
若使用字符串类型的形参，此参数的值为每个数据中间使用逗号拼接的结果

<form th:href="@{/param}"  method=post>
    用户名<input type="text" name="username"></intput><br/>
    密码<input type="text" name="passward"></intput><br/>
    提交<input type="submit" value="提交" /><br/>
</form>

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

4.3、@RequestParam

• @RequestParam是将请求参数和控制器方法的形参创建映射关系

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

• value：指定为形参赋值的请求参数的参数名
• required：设置是否必须传输此请求参数，默认值为true

required的值 ： true or fasle

设置为true时，则当前请求必须传输value所指定的请求参数，

​ 若没有传输该请求参数，且没有设置defaultValue属性，则页面报错400：Required String parameter ‘xxx’ is not present；

​ 若设置了defaultValue属性的值，那么就会为形参赋值为defaultValue的值，不会报错

若设置为false，则当前请求不是必须传输value所指定的请求参数，若没有传输，则注解所标识的形参的值为null

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

@RequestMapping("/param")
public String getParam(@RequestParam(value="username",required=true,defaultValue="hello")
                       String username, String password){
    System.out.println("username:"+username+",password:"+password);
    return "success";
}  

• required 默认是true ，表示必须传 value里面的参数，如果没有就会报错(400 )
• defaultValue="hello" 如果没有传入数据，就会吧这个默认值赋值给形参

4.4、@RequestHeader

• @RequestHeader是将请求头信息和控制器方法的形参创建映射关系，说白了就是获取请求头信息

@RequestHeader注解一共有三个属性：value、required、defaultValue，用法同@RequestParam

@RequestMapping("/param")
public String getParam(@RequestHeader(value="referer",required=false,defaultValue="......")
                       String referer, ){
    System.out.println("referer:"+referer);
    return "success";
    //  http://localhost:8080/SpringMVC/demo02
}  

4.5、@CookieValue

• @CookieValue是将cookie数据和控制器方法的形参创建映射关系

@CookieValue注解一共有三个属性：value、required、defaultValue，用法同@RequestParam

源码如下

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CookieValue {
    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";

    boolean required() default true;

    String defaultValue() default "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n";
}

@RequestMapping("/param/servletAPI")
public String getParmByServletAPI(HttpServletRequest request){
    HttpSession session= request.getSession(); // 需要先设置session
    return "success";
}

@RequestMapping("/param")
public String getParam(@CookieValue(value="JSESSIONID",required=false,defaultValue="......")
                       String jsessionId, ){
    System.out.println("cookie:"+cookie);
    return "success";
}  

4.6、通过POJO获取请求参数

可以在控制器方法的形参位置设置一个实体类类型的形参，此时若浏览器传输的请求参数的参数名和实体类中的属性名一致，

那么请求参数就会为此属性赋值

务必保证 实体类型的属性名和请求参数的形参名一致

创建实体类 User.java

package pers.dhx_.pojo;

/**
 * @author Dhx_
 * @className User
 * @description TODO
 * @date 2022/7/26 8:04
 */
public class User {
    private Integer id;
    private String username;

    User(){}
    public User(Integer id, String username, String password) {
        this.id = id;
        this.username = username;
        this.password = password;
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    private String password;
}

前端表单：

<form th:href="@{/param/servletAPI}"  method=post>
    用户名<input type="text" name="username"></intput><br/>
    密码<input type="text" name="passward"></intput><br/>
    提交<input type="submit" value="提交" /><br/>
</form>

Controller:

@RequestMapping
public String getParamByPojo(User user){
    System.out.println(user);
    return "success";
}

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

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

Spring中没有Request对象，无法直接设置编码方式

在request设置编码前不能获取任何请求参数，否则设置无效

<!--配置springMVC的编码过滤器-->
<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filterclass>
        org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name> <!--request编码-->
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name><!--response编码-->
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

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

• tomcat7有乱码问题， 在8中解决了