推荐学java——SpringMVC第一课 - 《推荐学 Java 系列》

SpringMVC 概述
第一个 SpringMVC 例子
总结

推荐学java——SpringMVC第一课 - 图1

SpringMVC 概述

Spring MVC 是 Spring 框架中的一个模块，也是 Spring 的核心之一，常用作 web 开发，其底层是 Servlet，故也叫 Spring web mvc。因为内内部架构模式是 mvc 架构，故此称为 Spring MVC .

SpringMVC 是一个容器，管理界面层中的控制器对象，使用 ioC 技术。

SpringMVC 的核心 Servlet ——DispatcherServlet，负责处理请求以及响应处理结果，这是我们学习的核心内容。

第一个 SpringMVC 例子

实现的功能（即需求）

用户发起请求，处理请求，给出响应结果。

实现步骤分析

创建web项目
添加依赖（spring-webmvc、servlet）
声明 SpringMVC 核心对象 DispatcherServlet
创建jsp，发起请求
创建一个普通类，作为控制器使用（代替之前的 servlet），这里要使用注解 @Controller 和 @RequestMapping
创建展示结果的 jsp 页面
创建 SpringMVC 的配置文件（和 Spring 配置文件类似）

以上步骤中，第一步不需要多说；第二步中用到的依赖项如下：

<!--    springMVC 依赖    -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.15</version>
</dependency>
<!--    servlet依赖    -->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
</dependency>

声明 SpringMVC 核心对象 DispatcherServlet

首先在 resources 文件夹下创建 springmvc-servlet.xml，这是 springMVC 的配置文件，但现在我们只是创建文件，里面的配置后面会添加；然后在 web.xml 文件中添加如下代码：

<!DOCTYPE web-app PUBLIC
        "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
        "http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--    自定义SpringMVC的配置文件位置    -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc-servlet.xml</param-value>
        </init-param>
        <!--    表示服务器 tomcat 创建对象的顺序，数值越小，创建对象的时机越早，大于等于0的整数    -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <!--
            <url-pattern> 把一些请求交给指定的 Servlet 处理。
            那么就可以使用通配符来指定，常见的扩展名形式如：.do、.action、.mvc等
        -->
        <url-pattern>*.do</url-pattern>
    </servlet-mapping>
</web-app>

这里的配置在上一节《Spring与web》中我们写过，这里略作调整，因为这次使用的是 DispatcherServlet ，同样，以上代码基本是固定的，记下来后面直接用即可。

创建发起请求的 jsp

页面很简单，做一个超链接，点击即可发起请求，具体代码如下：

<%--
  Created by studyingJava
  Date: 2022/2/9
  Time: 11:57
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>springmvc-first</title>
</head>
<body>
    <a href="hello.do">发起 hello.do 请求</a>
</body>
</html>

创建控制器类

新建一个名为 controller 的包，当然名字可以随你定义，完整代码如下：

/**
 * desc: 自定义后端控制器，添加注解 @Controller，表示创建该java对象
 * author: 推荐学java
 * <p>
 * weChat: studyingJava
 */
@Controller
public class MyController {
    /**
     * @return ModelAndView：表示请求结果的封装（数据和视图）
     * @RequestMapping：请求映射，其参数value是一个字符串类型的数组，uri地址以 "/" 开头,method参数是指定请求方式的
     * 可用在方法上面和类上面。前者表示完整的地址，后者表示公共前缀，此时对应的方法上面只需要写前缀后面的部分即可
     */
    @RequestMapping(value = "/doHello")
    public ModelAndView doHello() {
        // 这里模拟结果 实际业务应该是调用service层
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("msg", "处理 doHello 请求");
        modelAndView.addObject("code", 200);
        // 将请求结果给要展示的 jsp 页面
        modelAndView.setViewName("/result.jsp");
        return modelAndView;
    }
}

创建展示结果的 jsp 页面

我们把控制器类中封装好的值取出来，显示在该页面上即可，代码如下：

<%--
  Created by studyingJava
  Date: 2022/2/9
  Time: 16:43
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>响应请求结果</title>
</head>
<body>
    /result.jsp 展示用户请求的处理结果<br>
    <h3>msg数据：${msg}</h3>
    <h3>code数据：${code}</h3>
</body>
</html>

在配置文件中添加注解扫描器

因为我们是通过注解来生成Java对象的，以及对应的请求响应方法也是通过注解指定的，所以程序要通过配置文件扫描我们给定的业务逻辑，代码如下：

<?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.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
    <context:component-scan base-package="com.javafirst.controller"/>
</beans>

测试结果

这里就需要用到我们上节的知识了，将我们的项目发布部署到本地 tomcat 服务器中，然后通过浏览器访问，看结果，具体操作这里不再重复，没有掌握的朋友可以看上一篇博客哈。

如果遇到 result.jsp 页面中的取值不显示，解决办法：修改 web.xml 中的 web-app 的开始标签为以下内容即可：

<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
            http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

最终效果如下，即为正确：

推荐学java——SpringMVC第一课 - 图2

扩展知识

以上内容中我们展示结果的页面写的是全路径，比较麻烦，那么系统给我们提供了一个叫视图解析器的配置，添加之后，我们只需要给页面名称即可，下面看具体配置。

在配置文件中添加如下代码：

<!--  视图解析器
            只需要配置前缀和后缀即可，使用的时候只需要文件名
-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix" value="/WEB-INF/view/"/>
    <property name="suffix" value=".jsp"/>
</bean>

MyController中的使用代码如下：

// 将请求结果给要展示的 jsp 页面
//modelAndView.setViewName("/WEB-INF/view/result.jsp");
// 配置视图解析器后使用方式
modelAndView.setViewName("result");

这样就ok了！

携带参数

上面我们的请求没有携带任何参数，但实际开发中很多情况需要携带参数，下面分情况演示。

携带多个参数

下面举个例子，在请求页面增加一个表单，用户输入两个数据，通过 Controller 接收后，显示到 result.jsp 页面上。

index.jsp增加如下代码：

<body>
    <a href="hello.do">发起 hello.do 请求</a><br>
    <%--演示带参数请求--%>
    <form action="test/param.do" method="post">
        语言：<input type="text" name="language"><br>
        经验：<input type="text" name="work_time"><br>
        <input type="submit" value="提交">
    </form>
</body>

MyController中我们新增一个方法来专门处理这个提交请求：

/**
 * 传参-接收参数-显示参数
 * <p>
 * 形参类型建议使用基本数据类型的包装类,可以避免不填写造成的400异常
 *
 * @return
 */
@RequestMapping(value = "/test/param.do")
public ModelAndView doParam(String language, Integer work_time) {
    ModelAndView mv = new ModelAndView();
    mv.addObject("language", language);
    mv.addObject("work_time", work_time);
    mv.setViewName("result");
    return mv;
}

结果各位自行验证，前面的跑通了，这个应该没啥问题，不懂的欢迎留言哈~

解决携带中文参数乱码问题

tips：如果我们传参使用中文，那么会发现显示的时候是乱码，那么我们需要通过过滤器来解决这个问题，代码如下：

在web.xml中添加如下代码：

<!--  使用过滤器 解决乱码（请求过程、设置过程、显示过程）问题  -->
<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>
    <init-param>
        <!--     强制请求使用encoding编码方式       -->
        <param-name>forceRequestEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
    <init-param>
        <!--     强制响应使用encoding编码方式       -->
        <param-name>forceResponseEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <!--     强制请求都走过滤器       -->
    <filter-name>characterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

增加过滤器就可以保证我们所有请求（请求和响应）都经过我们定义的过滤器，编码都是统一的，这段代码也是固定的，后续可直接使用。

请求中参数名和方法形参名不一致

tips：上面传参我们请求中的参数名和 Controller 中方法的形参名是一致的，那如果不一致，如何保证能收到请求中的参数值呢？

解决方案是通过注解 @RequestParam 注解，用法也很简单：

@RequestMapping(value = "/test/param.do")
public ModelAndView doParam1(@RequestParam(value = "language") String lan,
                             @RequestParam(value = "work_time") Integer workTime) {
    ModelAndView mv = new ModelAndView();
    mv.addObject("language", lan);
    mv.addObject("work_time", workTime);
    mv.setViewName("result");
    return mv;
}

该注解的 value 值是请求中的参数名，方法的形参就可以自定义了，该注解就会自动将请求中的参数值赋值给方法的形参。

控制器方法形参是 java 对象

这种接收参数方式有前提条件：

请求中的参数名必须和 java 对象中的属性名保持一致
java对象需要提供无参构造方法

我们新建java对象 Programmer.java

/**
 * desc:
 * author: 推荐学java
 * <p>
 * weChat: studyingJava
 */
public class Programmer {
    private String languageType;
    private Integer workTime;
    public Programmer() {
    }
    public String getLanguageType() {
        return languageType;
    }
    public void setLanguageType(String languageType) {
        this.languageType = languageType;
    }
    public Integer getWorkTime() {
        return workTime;
    }
    public void setWorkTime(Integer workTime) {
        this.workTime = workTime;
    }
}

index.jsp中新增一个表单：

<%--演示 用java对象接收 带参数的请求
       要求：请求中的参数名和java对象中的属性名一致
       --%>
<form action="test/param_object.do" method="post">
    语言分类：<input type="text" name="languageType"><br>
    工作经验：<input type="text" name="workTime"><br>
    <input type="submit" value="java对象接收请求参数">
</form>

MyController.java中增加如下方法：

/**
 * 演示 用java对象接收 带参数的请求
 * 要求：请求中的参数名和java对象中的属性名一致、java对象中提供无参构造方法
 *
 * @return
 */
@RequestMapping(value = "/test/param_object.do")
public ModelAndView doParamObject(Programmer programmer) {
    ModelAndView mv = new ModelAndView();
    mv.addObject("language", programmer.getLanguageType());
    mv.addObject("work_time", programmer.getWorkTime());
    mv.setViewName("result");
    return mv;
}

结果各位读者朋友自行验证，这种接收参数的方式不支持请求中参数名和java对象中属性名不一致的情况。

控制器方法的返回值

包括这几种：

ModelAndView：数据和视图。这个我们已经学习过了。
String：只有视图，视图路径可以是完整路径，也可以是视图的逻辑名称。
void：
Object：

视图解析器返回 String 类型：

/**
 * 视图控制器返回类型是String
 *
 * @return
 */
@RequestMapping(value = "/test/controller_return_string.do")
public String doReturnString(String languageType, Integer workTime) {
    // 使用视图解析器的逻辑名方式
    return "result";
    // 要使用全路径的话，那么不能使用视图解析器
    //return "/WEB-INF/view/result.jsp";
}

如果只返回视图，还想附带数据，那么可以给该方法增加形参，如下方式：

@RequestMapping(value = "/test/controller_return_string.do")
public String doReturnString(HttpServletRequest request, String languageType, Integer workTime) {
    // 只返回视图 附带数据方式
    request.setAttribute("language", languageType);
    request.setAttribute("work_time", workTime);
    // 使用视图解析器的逻辑名方式
    return "result";
}

视图解析器返回 void 类型：

完成AJAX请求。

第一步，在webapp下创建文件夹js

并将文件jquery-3.4.1.js放在该文件夹下。

第二步，添加依赖

既然是请求，那么对请求结果的数据做格式处理，通常是json格式，我们添加的就是json依赖：

<!--    jackson依赖    -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.9.10</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.10</version>
</dependency>

依赖都是在pom.xml文件添加的。

第三步，在index.jsp页面中发起请求

首先在head标签下，引入我们添加的jquery-js库，代码如下：

<script charset="UTF-8" type="text/javascript" src="<%=request.getContextPath()%>/js/jquery-3.4.1.js"></script>

这需要注意一点，可能会遇到这样的错误：

Failed to load resource: the server responded with a status of 404

浏览器按F12就可以看到，是本地的 js文件没有加载成功，那么大多数问题是以为路径的问题，所以这里的路径需要加上<%=request.getContextPath()%>，如果你一开始是这么写的 js/jquery-3.4.1.js，那么并不会出现语法报错，但会出现我写的这个错误，就是这样的原因，需要添加请求上下文路径。

然后在 body 中添加一个button，用于点击的时候发起ajax请求：

<%--演示 视图控制器返回类型是void--%>
<button id="btnAjax" type="button">发起Ajax请求</button>

然后在head标签里面，在我们刚刚写过的引入js代码下面写javaScript 脚本：

<%--  发起ajax请求  --%>
<script type="text/javascript">
    $(function () {
        $("#btnAjax").on("click",function () {
            alert("click success")
        })
    })
</script>

我们先测试一下点击后是否会生效，结果各位自己验证，是没有任何问题的，接下来我们就写具体的响应数据，也就是要包装json格式。

以上没有问题后，我们要演示Ajax真正的请求响应结果了，我们修改脚本如下：

<%--  发起ajax请求  --%>
<script type="text/javascript">
    $(function () {
        $("#btnAjax").on("click",function () {
            $.ajax({
                dataType: 'json',
                url: 'return-void-ajax.do',
                data:{
                    languageType:"ajax请求",
                    workTime:20220303
                },
                // response 是形参 自定义的
                success: function (response) {
                    alert("ajax请求响应结果："+response.languageType+response.workTime);
                }
            });
        })
    })
</script>

我们这里指定的响应数据格式是json ，这就是为什么一开始我们要添加相应依赖的原因了。这一步搞定，我们的控制器，就是服务端还没写呢，和之前一样，在MyController 中新增一个方法如下：

/**
 * 控制器返回类型是 void 使用ajax请求演示结果
 *
 * @param response
 * @param languageType
 * @param workTime
 * @throws Exception
 */
@RequestMapping(value = "/return-void-ajax.do")
public void doAjax(HttpServletResponse response, String languageType, Integer workTime) throws Exception {
    Programmer programmer = new Programmer();
    programmer.setLanguageType(languageType);
    programmer.setWorkTime(workTime);
    ObjectMapper mapper = new ObjectMapper();
    String json = mapper.writeValueAsString(programmer);
    response.setContentType("application/json;charset=utf-8");
    PrintWriter pw = response.getWriter();
    pw.print(json);
    pw.flush();
    pw.close();
}

在浏览器测试结果即可，能显示我们在ajax中指定的数据即是正确的。这块主要是熟悉流程，掌握程序执行顺序和逻辑。

执行流程分析

用户发起请求，首先到服务器（Tomcat），然后有中央调度器（DispatcherServlet）进行分发到不同的控制器（Controller），然后控制器执行对应的业务逻辑后返回数据视图给结果页。

控制器可以有多个，我们上面的例子只写了一个，且一个控制器中可以有多个方法处理不同的请求，同一个方法也可以处理多个请求。

总结

SpringMVC 其实可以理解为封装好的框架，简化我们的工作流程，提高开发效率
Spring体系很庞大，我们学习了前面的Spring Framework，现在学 SpringMVC 就感觉很轻松了，而且会感觉到后续的压力没那么重了

学编程，推荐首选 Java 语言，小编创建了一个专注Java的原创公众号推荐学java，大家可在微信搜索javaFirst 关注，一起开启 Java 旅途！