SpringMVC框架个人笔记之入门、请求参数绑定、注解

最新推荐文章于 2023-12-13 09:53:19 发布

EdmundDshi

最新推荐文章于 2023-12-13 09:53:19 发布

阅读量317

点赞数 1

分类专栏： SpringMVC框架文章标签： mvc

本文链接：https://blog.csdn.net/weixin_42707971/article/details/106106129

版权

SpringMVC框架专栏收录该内容

4 篇文章 0 订阅

订阅专栏

对应工程为springMVC-strat

1.概念知识

服务器端的三层架构和对应的框架如下：

表现层：SpringMVC
业务层：Spring
持久层：Mybatis

MVC 全名是 Model View Controller。是模型(model)－视图(view)－控制器(controller)的缩写，是一种用于设计创建 Web 应用程序表现层的模式。

Model （模型）：举例为javaBean。通常指的就是我们的数据模型。作用一般情况下用于封装数据。
View （视图）：通常指的就是我们的 jsp 或者 html。作用一般就是展示数据的。
Controller （控制器）：举例为servlet。是应用程序中处理用户交互的部分。作用一般就是处理程序逻辑的。举个详细的例子说明：我们要保存一个用户的信息，该用户信息中包含了姓名，性别，年龄等等。这时候表单输入要求年龄必须是 1~100 之间的整数。姓名和性别不能为空。并且把数据填充到模型之中。此时除了 js 的校验之外，服务器端也应该有数据准确性的校验，那么校验就是控制器的该做的。当校验失败后，由控制器负责把错误页面展示给使用者。如果校验成功，也是控制器负责把数据填充到模型，并且调用业务层实现完整的业务需求。

2.搭建环境

pom.xml:

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <spring.version>5.0.2.RELEASE</spring.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>servlet-api</artifactId>
      <version>2.5</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>javax.servlet.jsp</groupId>
      <artifactId>jsp-api</artifactId>
      <version>2.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

springMVC配置文件：

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

    <!-- 配置spring创建容器时要扫描的包 -->
    <context:component-scan base-package="cn.smm"></context:component-scan>
    <!-- 配置spring开启注解mvc的支持-->
    <mvc:annotation-driven></mvc:annotation-driven>
    
    <!-- 配置视图解析器 -->
    <bean id="viewResolver"
          class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"></property>
        <property name="suffix" value=".jsp"></property>
    </bean>

在web.xml进行配置。web.xml文件是用来初始化工程配置信息的。

  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

    <!-- 配置Servlet的初始化参数，读取springmvc的配置文件，创建spring容器 -->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <!-- 配置servlet启动时加载对象 -->
    <load-on-startup>1</load-on-startup>

  </servlet>
  <servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

index.jsp：

<body>
<h3>入门案例</h3>
<a href="hello">入门案例</a>
</body>

新建一个控制类：

//控制类
@Controller
public class HelloController {

    @RequestMapping(path = "/hello")
    public String sayHello(){
        System.out.println("你好，世界");
        return "success";
    }

success.jsp:

<body>
        <h3>恭喜你入门成功</h3>
</body>

3.配置Tomcat

1.点击编辑配置
在这里插入图片描述
2.左上角选择本地Tomcat，然后在右侧选中电脑上下载好的Tomcat，如果用maven配置的就忽略此过程。

其中上面的URL是的启动浏览器时访问的网址，下面的application-context是web项目的默认访问路径，两者是不一样的，application-context是你项目工程的名字，相当于访问入口，默认是访问index.jsp文件的，而URL是你设置启动浏览器就访问哪个链接，你可以设置不访问index.jsp。
在这里插入图片描述

4.项目流程分析

在这里插入图片描述
在 SpringMVC 的各个组件中，处理器映射器、处理器适配器、视图解析器称为 SpringMVC 的三大组件。

当启动Tomcat服务器的时候，因为web.xml中配置了load-on-startup标签，所以会创建DispatcherServlet对象，就会加载springmvc.xml配置文件
开启了注解扫描，那么HelloController对象就会被创建
从index.jsp中的链接“hello”发送请求，请求会先到达DispatcherServlet前端控制器，根据配置@RequestMapping注解找到执行的sayHello（）方法
根据执行方法的返回值"success"，再根据springmvc.xml文件配置的视图解析器，去指定的目录下查找success.jsp文件
Tomcat服务器渲染页面，做出响应

5.文件详细分析

5.1 web.xml：

命名与定制URL：

我们可以为Servlet和JSP文件命名并定制URL,其中定制URL是依赖命名的，命名必须在定制URL前。<servlet>标签表示定义了一个servlet，<servlet-name>是这个servlet的名字，<servlet-class>就是说明这个servlet的路径，也可以导入别人写好的jar包。<servlet-mapping>就是映射servlet和虚拟路径，其中<url-pattern>就是配置虚拟路径的。下面举例：

(1)、为Servlet命名： 
<servlet> 
	<!-- servlet的内部名称，自定义。尽量有意义 -->
    <servlet-name>servletTest</servlet-name> 
    <!-- servlet的类全名： 包名+简单类名 -->
    <servlet-class>cn.smm.ServletDemo</servlet-class> 
</servlet> 

(2)、为Servlet定制URL、 
<servlet-mapping> 
	<!-- servlet的内部名称，一定要和上面的内部名称保持一致！！ -->
    <servlet-name>servletTest</servlet-name> 
    <!-- servlet的映射路径（访问servlet的名称） -->
    <url-pattern>/test</url-pattern> 
</servlet-mapping>

定制初始化参数：
在spring中配置参数名为contextConfigLocation，其参数的<param-value>定义了要装入的配置文件，此处为springmvc.xml。<load-on-startup> 元素标记容器是否应该在web应用程序启动的时候就加载这个servlet，它的值必须是一个整数，表示servlet被加载的先后顺序。如果值为正整数或者0时，表示容器在应用启动时就加载并初始化这个servlet，值越小，servlet的优先级越高，就越先被加载。值相同时，容器就会自己选择顺序来加载。值为负数或者没有设置，则容器会当Servlet被请求时再加载。

  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

    <!-- 配置Servlet的初始化参数，读取springmvc的配置文件，创建spring容器 -->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <!-- 配置servlet启动时加载对象 -->
    <load-on-startup>1</load-on-startup>
  </servlet>

5.2 springmvc.xml：

首先导入springmvc、注解的约束文件，此处不导入，参照上面。然后开启要扫描注解的位置和开启支持注解。

    <!-- 配置spring创建容器时要扫描的包 -->
    <context:component-scan base-package="cn.smm"></context:component-scan>
    <!-- 配置spring开启注解mvc的支持-->
    <mvc:annotation-driven></mvc:annotation-driven>

定义一个bean标签，使用类InternalResourceViewResolver，它的作用是在Controller返回的时候进行解析视图。采用property标签的set方法注入数据，prefix是设置路径，suffix是设置后缀。

    <bean id="viewResolver"
          class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"></property>
        <property name="suffix" value=".jsp"></property>
    </bean>

5.3用到的注解

@Controller在博客中提到过，作用是用于把当前类对象存入spring容器中。
@RequestMapping(path = "/hello")。RequestMapping注解的作用是建立请求URL和处理方法之间的对应关系。
可以作用在方法和类上。

@Controller
@RequestMapping(path = "/hehe")
public class HelloController {

    @RequestMapping(path = "/hello")
    public String sayHello(){
    }
}
//此时的index的超链接为
<a href="hehe/hello">入门案例</a>

RequestMapping的属性：
3. path 指定请求路径的url
4. value value属性和path属性是一样的
5. mthod 指定该方法的请求方式（get/post等）
6. params 指定限制请求参数的条件
7. headers 发送的请求中必须包含的请求头

6.请求参数绑定

表单中请求参数都是基于 key=value 的，SpringMVC 绑定请求参数的过程是通过把表单提交请求参数，作为控制器中方法参数进行绑定的。
例如：

//index中
<a href="para?username=root&password=root">请求参数绑定</a>

    @RequestMapping(path = "/para")
    public String parameter(String username,String password){
        System.out.println("执行了账户查询：");
        System.out.println("username:" + username);
        System.out.println("password:" + password);
        return "success";
    }

下面采用把表单数据封装到JavaBean中的方式
新建一个实体类Account：注：要实现Serializable 接口

public class Account implements Serializable {
    private String username;
    private String password;
    private double money;

Controller中新建一个方法：

    @RequestMapping(path = "/account")
    public String account(Account account){
        System.out.println(account);
        return "success";
    }

index中添加一个表单：
如果Account类有引用类型的User类的user属性，参数的引用如下

<form action="account" method="get">
    姓名：<input type="text" name="username">
    密码：<input type="text" name="password">
    金额：<input type="text" name="money">
    <input type="submit" value="提交">
</form>

年龄：<input type="text" name="user.age">

6.1请求参数中文乱码的解决

在web.xml中配置

<web-app>
  <!-- 配置 springMVC 编码过滤器 -->
  <filter>
  <filter-name>CharacterEncodingFilter</filter-name>
  <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <!-- 设置过滤器中的属性值 -->
    <init-param>
      <param-name>encoding</param-name>
      <param-value>UTF-8</param-value>
    </init-param>
  </filter>
  
  <filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-app>

7.自定义类型转换器

在Account实体类中增加一个private Date date;属性。
第一步，新建一个utils包，包下新建一个StringToDateConverter类，并实现Converter<String, Date>接口和其方法convert。

public class StringToDateConverter implements Converter<String, Date> {
    @Override
    public Date convert(String source) {
        DateFormat format = null;
        try {
            if(StringUtils.isEmpty(source)) {
                throw new NullPointerException("请输入要转换的日期");
            }
            format = new SimpleDateFormat("yyyy-MM-dd");
            Date date = format.parse(source);
            return date;
        } catch (Exception e) {
            throw new RuntimeException("输入日期有误");
        }
    }
}

第二步，修改主配置文件springmvc.xml：
第三步：在 annotation-driven 标签中引用配置的类型转换服务

    <!-- 配置类型转换器工厂 -->
    <bean id="converterService"
          class="org.springframework.context.support.ConversionServiceFactoryBean">
        <!-- 给工厂注入一个新的类型转换器 -->
        <property name="converters">
            <array>
                <!-- 配置自定义类型转换器 -->
                <bean class="cn.smm.utils.StringToDateConverter"></bean>
            </array>
        </property>
    </bean>

<!-- 引用自定义类型转换器 -->
<mvc:annotation-driven
conversion-service="converterService"></mvc:annotation-driven>

8.常用注解

8.1RequestParam

作用：把请求中指定名称的参数给控制器中的形参赋值。
属性：value：请求参数中的名称。required：请求参数中是否必须提供此参数。默认值：true。表示必须提供，如果不提供将报错。

举个例子：请求参数绑定那个例子。
在这里插入图片描述

把链接里面的参数改了，就会和处理器里面参数不一致，这时只要在方法参数里面加个@RequestParam注解，就可以对应上了。如下：

    @RequestMapping(path = "/para")
    public String parameter(@RequestParam("name")String username, String password){
    }

8.2RequestBody

作用：用于获取请求体内容。直接使用得到是key=value&key=value…结构的数据。get 请求方式不适用。
属性：required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false，get 请求得到是 null。

意思就是请求的链接必须有请求体，响应路劲里面的方法不再是单独获取请求体里面的单个属性，而是整个请求体的内容，拿表单举例子如下：

<form action="testRequestBody" method="post">
    姓名：<input type="text" name="username">
    密码：<input type="text" name="password">
    <input type="submit" value="提交">
</form><br>

    @RequestMapping(path = "/testRequestBody")
    public String testRequestBody(@RequestBody String body){
        System.out.println(body);
        return "success";
    }

输出：
在这里插入图片描述

8.3PathVaribale

作用：用于绑定 url 中的占位符。例如：请求 url 中 /delete/{id}，这个{id}就是 url 占位符。url 支持占位符是 spring3.0 之后加入的。是springmvc 支持 rest 风格 URL 的一个重要标志。具体去查 rest 风格，懒得弄例子
属性：value：用于指定 url 中占位符名称。required：是否必须提供占位符。

<a href="testPathVaribale/10">testPathVaribale</a><br>

    @RequestMapping(path = "/testPathVaribale/{id}")
    public String testPathVaribale(@PathVariable(name ="id") String id){
        System.out.println(id);
        return "success";
    }

8.4 RequestHeader

作用：用于获取请求消息头。
属性：value：提供消息头名称required：是否必须有此消息头
注：在实际开发中一般不怎么用。所以不贴例子

8.5CookieValue

作用：用于把指定 cookie 名称的值传入控制器方法参数。
属性：value：指定 cookie 的名称。required：是否必须有此 cookie。

<a href="testCookieValue">绑定 cookie 的值</a>

@RequestMapping("/testCookieValue")
public String  testCookieValue(@CookieValue(value="JSESSIONID",required=false)
String cookieValue){
System.out.println(cookieValue);
return "success";
}

8.6ModelAttribute

作用：该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。

出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。
出现在参数上，获取指定的数据给参数赋值。

属性：value：用于获取数据的 key。key 可以是 POJO 的属性名称，也可以是 map 结构的 key。

应用场景：当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。
例如：我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。在提交表单数据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。

<form action="testModelAttribute" method="post">
    姓名：<input type="text" name="username">
    密码：<input type="text" name="password">
    <input type="submit" value="提交">
</form><br>

@RequestMapping("/testModelAttribute")
public String  testModelAttribute(){
System.out.println("testModelAttribute执行了...");
return "success";

@ModelAttribute
public void showUser(){
System.out.println("showUser执行了...");
}

输出：
在这里插入图片描述

8.7SessionAttribute

作用：用于多次执行控制器方法间的参数共享。
属性：
value：用于指定存入的属性名称
type：用于指定存入的数据类型。

<a href="testSessionAttribute">SessionAttribute</a>

    @RequestMapping("/testSessionAttribute")
    public String  testSessionAttribute(Model model){
        System.out.println("testSessionAttribute执行了...");
        //底层会存储到request域对象中
        model.addAttribute("msg","佳琪" );
        return "success";
    }