avatar

目录
SpringMVC详解

1、回顾MVC

1.1、什么是MVC

参见《MVC三层架构

  • MVC是模型(Model)、视图(View)、控制器(Controller)的简写,是一种软件设计规范。
  • MVC是将业务逻辑、数据、显示分离来组织代码的。
  • MVC主要作用是降低了视图与业务逻辑间的双向偶合
  • MVC不是一种设计模式,MVC是一种架构模式。当然不同的MVC架构之间也存在一些差异。

(1)Model(模型):数据模型,提供要展示的数据,包含数据和行为。我们一般将Service(业务)层、DAO(持久)层和JavaBean统称为Model。也就是模型提供了模型数据查询和模型数据的状态更新等功能,包括数据和业务。

(2)View(视图):负责进行模型的展示,一般就是我们见到的用户界面,客户想看到的东西。

(3)Controller(控制器):接收用户请求,委托给模型进行处理(状态改变),处理完毕后把返回的模型数据返回给视图,由视图负责展示。Controller的底层都是通过Servlet来实现的。

最典型的MVC就是JSP + servlet +javabean的模式。

MVC架构示意图

1.2、Web开发的两个时代

1.2.1、Model 1 时代

  • web早期的开发中,通常采用的都是Model1
  • Model1中,主要分为两层,视图层和模型层。
Model1时代

Model1的优点:架构简单,比较适合小型项目开发;

Model1的缺点:JSP职责不单一,职责过重,不便于维护。

1.2.1、Model 2 时代

Model2把一个项目分成三部分,包括模型(Model)、视图(View)、控制(Controller)。

Model2时代

数据处理过程:

  1. 用户发请求;
  2. Servlet接收请求数据,并调用对应的业务逻辑方法;
  3. 业务处理完毕,返回更新后的数据给servlet
  4. servlet转向到JSP,由JSP来渲染页面;
  5. 响应给前端更新后的页面。

Model2不仅提高的代码的复用率与项目的扩展性,且大大降低了项目的维护成本。Model1模式的实现比较简单,适用于快速开发小规模项目,Model1JSP页面身兼ViewController两种角色,将控制逻辑和表现逻辑混杂在一起,从而导致代码的重用性非常低,增加了应用的扩展性和维护的难度。Model2消除了Model1的缺点。

1.3、回顾Servlet

(1)新建一个普通的Maven项目,(具体步骤参考《Maven详解》),项目名称为SpringMVC-Study

(2)删除系统自动生成的src目录,所得到的空项目就是我们的Maven父项目,我们可以在其中创建多个子项目(即:Module)。

(3)在父项目的pom.xml文件中导入父/子工程需要的Maven依赖。

pom.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<!-- 导入Maven依赖 -->
<dependencies>
<!-- junit依赖 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<!-- SpringMVC依赖 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.1.9.RELEASE</version>
</dependency>
<!-- servlet依赖 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
</dependency>
<!-- jsp依赖 -->
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.2</version>
</dependency>
<!-- jstl依赖 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
</dependencies>

(4)在父项目中新建一个模块(Module),并在其中创建一个普通的Maven子项目,项目名称为springMVC-01-servlet

(5)右键选择”Add FrameworkSupport“菜单项,为该子项目添加Web Application的支持!

添加Webapp的支持

(6)在子项目的java目录下新建一个com.atangbiji.servlet包,并在该包下新建一个HelloServlet类,用于实现Servlet接口,并处理用户的请求。

HelloServlet.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
package com.atangbiji.servlet;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class HelloServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//1、获取前端的参数
String method = req.getParameter("method");
if (method.equals("add")){
req.getSession().setAttribute("msg","执行了add方法");
}
if (method.equals("delete")){
req.getSession().setAttribute("msg","执行了delete方法");
}
//2、调用业务层代码处理业务(本项目暂时没有)
//3、试图转发或重定向
req.getRequestDispatcher("/WEB-INF/jsp/hello.jsp").forward(req,resp);
}

@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//因为get和post只是不同的Http请求方式,所以它们之间可以相互调用。
doGet(req, resp);
}
}

(7)在子项目的web/WEB-INF目录下新建一个jsp包,并在该包下新建一个hello.jsp文件。

hello.jsp文件:

1
2
3
4
5
6
7
8
9
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>阿汤笔迹</title>
</head>
<body>
${msg}
</body>
</html>

注:

  • web页面写在web目录下时,项目发布后,页面文件用户可见,数据不安全。
  • web页面写在web/WEB-INF目录下时,项目发布后,页面文件用户不可见,数据安全。

(8)在web.xml中注册Servlet,并为其提供一个浏览器可以访问的路径。

web.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<!--注册Servlet-->
<servlet>
<servlet-name>helloServlet</servlet-name>
<servlet-class>com.atangbiji.servlet.HelloServlet</servlet-class>
</servlet>
<!--Servlet的访问路径-->
<servlet-mapping>
<servlet-name>helloServlet</servlet-name>
<url-pattern>/hello</url-pattern>
</servlet-mapping>
</web-app>

(9)配置Tomcat服务器;deploy(发布)springMVC-01-servlet:war包,并为该子项目添加虚拟路径映射:/s1。(参见《Servlet详解》)

(10)启动测试。在IDEA中启动Tomcat。

  • 在浏览器中输入http://localhost:8080/s1/hello?method=add,访问结果如下:
add
  • 在浏览器中输入http://localhost:8080/s1/hello?method=delete,访问结果如下:
delete

1.4、MVC框架主要做了哪些事?

(1)将url映射到java类或java类的方法。

(2)封装用户提交的数据。

(3)处理请求、调用相关的业务处理、封装响应数据。

(4)将响应的数据进行渲染。jsp/html等表示层数据。

注:

  • 常见的服务器端MVC框架有:StrutsSpring MVCASP.NET MVCZend FrameworkJSF
  • 常见前端MVC框架:vueangularjsreactbackbone
  • MVC可以演化出另外一些模式如:MVPMVVM等。

2、SpringMVC概述

2.1、什么是SpringMVC

SpringMVC

Spring MVCSpring Framework的一部分,是基于Java实现MVC的轻量级Web框架。

注:SpringMVC的底层还是Servlet

2.2、Spring MVC的特点

  • 轻量级,简单易学。
  • 高效 , 基于请求响应的MVC框架。
  • Spring兼容性好,无缝结合。(我们只需将SpringMVC中所有要用到的Bean,注册到SpringIOC容器中去即可使用!)
  • 约定优于配置。
  • 功能强大:RestFul、数据验证、格式化、本地化、主题等。
  • 简洁灵活。(从Spring 2.5开始,使用Java 5或者以上版本的用户可以采用基于注解形式进行开发,十分简洁。)

2.3、为什么要学习SpringMVC

正因为SpringMVC好用、简单、便捷、易学;天生和Spring无缝集成(使用SpringIoCAop);使用约定优于配置;能够进行简单的junit测试;支持RestFul风格、异常处理、本地化、国际化、数据验证、类型转换、拦截器 等功能,所以我们要学习。

最重要的一点还是用的人多 , 使用的公司多!

3、中心控制器

Spring MVC框架像许多其他MVC框架一样, 以请求为驱动,围绕一个中心Servlet(控制器)分派请求及提供其他功能

Springweb框架围绕DispatcherServlet【调度Servlet】设计。DispatcherServlet的作用是将请求分发到不同的处理器(即:不同的类和方法)。

注:DispatcherServlet是一个实际的Servlet(它也是继承自HttpServlet基类),其继承关系如下图所示。

中心控制器

4、SpringMVC运行原理

SpringMVC的运行原理如下图所示:

SpringMVC原理图

当用户发送请求时:

  • 前端控制器(Front Controller)【即:DispatcherServlet中心控制器)】首先拦截浏览器的所有请求;
  • 然后,处理映射器(如:BeanNameUrlHandlerMapping等)和处理器适配器(如:SimpleControllerHandlerAdapter等)再根据请求的参数(URL)将该请求委托给对应的实际控制器Controller)。
  • 然后,控制器Controller)调用(Service层)业务对象对请求进行处理;(Dao层)创建数据模型、访问数据库,并将处理后的模型数据存放在模型和视图ModelAndView对象)中返回给前端控制器。
  • 然后,通过视图解析器(如:InternalResourceViewResolver等)找到要跳转到的页面,并使用模型和视图(ModelAndView对象)中的数据渲染视图。
  • 最后,再通过中心控制器,将结果返回给用户。

5、第一个SpringMVC程序

5.1、搭建MavenWeb项目环境

(1)在父项目中新建一个模块(Module),并在其中创建一个普通的Maven子项目,项目名称为springMVC-02-helloSpringMVC

(2)右键选择”Add FrameworkSupport“菜单项,为该子项目添加Web Application的支持!

注:如果我们的Java Web应用是通过普通Maven项目添加Web Application支持的方式创建,那么当我们deploy(发布)项目时,可能会出现输出目录无法生成lib目录,进而无法导出依赖包的问题,此时页面显示404错误。

  • 出现该问题的原因在于:使用Maven模板创建MavenWeb项目默认生成的Web资源目录,与通过普通Maven项目添加Web Application支持的方式创建的Web项目的Web资源目录不相同。
  • 解决方法:点击File->Project Structure菜单,打开项目结构目录,我们只需在其中将该项目的Web资源目录修改正确,并手动将Maven依赖包添加到输出跟目录下即可。
web资源目录出错 web资源目录修改 手动添加Maven依赖包 手动添加Maven依赖包成功

(3)确定pom.xml文件中导入了SpringMVC相关的依赖!

5.2、注册中心控制器

(4)在web.xml文件中注册DispatcherServlet(中心控制器),并通过DispatcherServlet(中心控制器)拦截浏览器的所有请求。

web.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">

<!--1.注册DispatcherServlet-->
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--关联一个springMVC的配置文件:【servlet-name】-servlet.xml-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-servlet.xml</param-value>
</init-param>
<!--启动级别:1(即:服务器启动时就启动)-->
<load-on-startup>1</load-on-startup>
</servlet>

<!--2、通过DispatcherServlet(中心控制器)拦截浏览器的所有请求-->
<!--/ :只匹配所有的请求;不会去匹配.jsp页面-->
<!--/* :匹配所有的请求,包括.jsp页面-->
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>

注:DispatcherServlet(请求分发器,又称“前置控制器”、“中心控制器”),它是整个SpringMVC的控制中心(核心),它也是一个实际的Servlet

5.3、配置处理映射器、处理器适配器和视图解析器

(5)在该子项目的resources目录下新建一个SpringMVC的配置文件,配置文件的名称为:springmvc-servlet.xml(即:[servletname]-servlet.xml),并在其中添加SpringMVC的核心三要素:处理映射器、处理器适配器和视图解析器。

springmvc-servlet.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
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">
<!--处理器映射器-->
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>
<!--处理器适配器-->
<bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>
<!--视图解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
<!--前缀-->
<property name="prefix" value="/WEB-INF/jsp/"/>
<!--后缀-->
<property name="suffix" value=".jsp"/>
</bean>
</beans>

注:

  • SpringMVC的配置文件本质上就是Spring的配置文件。
  • 在实际项目中,我们可以将视图解析器换成ThymeleafFreemarker等模板引擎。
  • 若视图层为html页面,则只需对视图解析器的前缀和后缀做相应的修改即可。

5.4、通过接口创建Controller

(6)在该子项目的java目录下新建一个com.atangbiji.controller包(用于存放我们自己编写的控制器),并在该包下新建一个HelloController类。

HelloController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.atangbiji.controller;

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
//自定义控制器
public class HelloController implements Controller {
//处理请求,并响应
public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
//新建ModelAndView(模型和视图)
ModelAndView mv = new ModelAndView();
//封装对象Model,并放在ModelAndView中
mv.addObject("msg","HelloSpringMVC!");
//封装要跳转的视图,并放在ModelAndView中
mv.setViewName("hello");
//返回视图位置:WEB-INF/jsp/hello.jsp
return mv;
}
}

注:只要实现(implements)了Controller接口的类就是一个控制器,即:获得了控制器功能。

5.5、注册自己编写的处理器

(7)将自己编写的处理器(bean)在SpringIOC容器(Spring的配置文件)中注册。

springmvc-servlet.xml文件:

xml
1
2
<!--注册自己编写的处理器-->
<bean id="/hello" class="com.atangbiji.controller.HelloController"/>

注:id对应请求路径,class对应处理请求的类。

5.6、编写前端页面

(8)在子项目的web/WEB-INF目录下新建一个jsp包,并在该包下新建一个hello.jsp文件,用于显示ModelandView中存放的数据,以及我们的正常页面。

hello.jsp文件:

1
2
3
4
5
6
7
8
9
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>阿汤笔迹</title>
</head>
<body>
${msg}
</body>
</html>

注:我们把所有的视图都存放在/WEB-INF/目录下,这样可以保证视图安全,因为这个目录下的文件,客户端不能直接访问。

5.7、发布与测试

(9)配置Tomcat服务器;deploy(发布)springMVC-02-helloSpringMVC:war包,并为该子项目添加虚拟路径映射:/mvc。(参见《Servlet详解》)

(10)启动测试。在IDEA中启动Tomcat,在浏览器中输入http://localhost:8080/mvc/hello,页面访问成功。访问结果如下:

第一个SpringMVC程序测试结果

注:通过这个示例程序,估计大部分同学都能理解SpringMVC运行的原理了。但是我们实际开发才不会这么写,这样写是为了让大家更好地理解SpringMVC的运行原理!实现项目中,我们会使用注解版进行开发,这才是SpringMVC的精髓!

6、SpringMVC执行流程

SpringMVC的一个较完整的执行流程如下图所示,其中:实线表示SpringMVC框架提供的技术,不需要开发者实现;虚线表示需要开发者实现。

SpringMVC执行流程

接下来,结合第一个SpringMVC示例程序,分析SpringMVC的执行流程:

(1)用户发出请求,DispatcherServlet接收请求并拦截浏览器的所有请求。

注:DispatcherServlet表示前置控制器,它是整个SpringMVC的控制中心。

如:第一个SpringMVC示例程序中请求的url为:http://localhost:8080/mvc/hello

注:url可拆分成如下三部分:

  • 服务器域名(如:http://localhost:8080
  • 部署在服务器上的web站点(如:/mvc
  • 控制器(如:/hello

通过分析,上述url表示为:请求位于服务器localhost:8080上的mvc站点的hello控制器。

(2)DispatcherServlet调用HandlerMapping处理器映射),HandlerMapping根据请求的url查找(映射)相应的Handler处理器)。

(3)HandlerExecution根据url查找控制器Controller)。如上述url被查找的控制器为:hello

注:HandlerExecution表示具体执行的处理器。

(4)HandlerExecution将解析后的信息传递给DispatcherServlet。如:解析控制器映射等。

(5)HandlerAdapter处理器适配器)按照特定的规则去执行Handler

(6)Handler让具体的Controller执行。

(7)Controller将具体的执行信息返回给HandlerAdapter,即:ModelAndView

注:控制器(Controller)主要调用(Service层)业务对象对请求进行处理;并通过Dao层创建数据模型、访问数据库,然后将处理后的模型数据存放在模型和视图ModelAndView对象)中返回给前端控制器。

(8)HandlerAdapter将视图逻辑名或模型数据传递给DispatcherServlet

(9)DispatcherServlet调用视图解析器ViewResolver)来解析HandlerAdapter传递的视图逻辑名。

注:视图解析器的主要完成以下功能:

  • 获取ModelAndView中的数据;
  • 解析ModelAndView中的视图名称;
  • 通过字符串拼(前缀、后缀)接找到对应的视图;
  • 将数据渲染到该视图上。

(10)视图解析器将解析的视图逻辑名传给DispatcherServlet

(11)DispatcherServlet根据视图解析器解析的视图结果,调用具体的视图View)。

(12)View把最终视图呈现给用户。

7、使用注解开发SpringMVC(重点)

7.1、搭建MavenWeb项目环境

(1)在父项目中新建一个模块(Module),并在其中创建一个普通的Maven子项目,项目名称为springMVC-03-annotationSpringMVC

(2)右键选择”Add FrameworkSupport“菜单项,为该子项目添加Web Application的支持!

注:如果我们的Java Web应用是通过普通Maven项目添加Web Application支持的方式创建,那么当我们deploy(发布)项目时,可能会出现输出目录无法生成lib目录,进而无法导出依赖包的问题,此时页面显示404错误。

  • 出现该问题的原因在于:使用Maven模板创建MavenWeb项目默认生成的Web资源目录,与通过普通Maven项目添加Web Application支持的方式创建的Web项目的Web资源目录不相同。
  • 解决方法:点击File->Project Structure菜单,打开项目结构目录,我们只需在其中将该项目的Web资源目录修改正确,并手动将Maven依赖包添加到输出跟目录下即可。(详见5.1节)

(3)在父项目的pom.xml文件中导入父/子工程所需要的SpringMVC相关的依赖。

pom.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<!-- 导入Maven依赖 -->
<dependencies>
<!-- junit依赖 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<!-- SpringMVC依赖 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.1.9.RELEASE</version>
</dependency>
<!-- servlet依赖 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
</dependency>
<!-- jsp依赖 -->
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.2</version>
</dependency>
<!-- jstl依赖 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
</dependencies>

注:由于Maven的“约定大于配置”思想,我们以后可能会遇到我们自己写的配置文件(如:我们配置文件*.xml写在了项目中的Java目录下)无法被导出或者无法生效的问题。该问题的解决方法是:在pom.xml<build>……</build>中配置resources,修改Maven约定的过滤条件,来防止我们的资源导出失败。

pom.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<!--在build中配置resources,来防止我们资源导出失败的问题-->
<build>
<resources>
<!--选择需要导出资源的路径,可以选择多个-->
<resource>
<directory>src/main/resources</directory>
<!--写入需要导出的什么类型的文件-->
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<!--不去过滤这些文件-->
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<!--不去过滤这些文件-->
<filtering>false</filtering>
</resource>
</resources>
</build>

7.2、注册中心控制器

(4)在web.xml文件中注册DispatcherServlet(中心控制器),并通过DispatcherServlet(中心控制器)拦截浏览器的所有请求。

web.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">

<!--1.注册DispatcherServlet-->
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--关联一个springMVC的配置文件:【servlet-name】-servlet.xml-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-servlet.xml</param-value>
</init-param>
<!--启动级别:1(即:服务器启动时就启动)-->
<load-on-startup>1</load-on-startup>
</servlet>

<!--2、通过DispatcherServlet(中心控制器)拦截浏览器的所有请求-->
<!--/ :只匹配所有的请求;不会去匹配.jsp页面-->
<!--/*:匹配所有的请求,包括.jsp页面-->
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>

注:

  • 注意web.xml版本问题,要最新版(4.0)!

  • //* 的区别:

    • / :只匹配所有的请求;不会去匹配.jsp页面。
    • /*:匹配所有的请求,包括.jsp页面。

    若此处使用/*,则会出现返回jsp视图时再次进入springDispatcherServlet类,导致找不到对应的controller问题,此时页面显示404错误。

7.3、添加SpringMVC配置文件(固定写法)

(5)在该子项目的resources目录下新建一个SpringMVC的配置文件,配置文件的名称为:springmvc-servlet.xml(即:[servletname]-servlet.xml)。并在其中完成以下工作:

①在xml配置文件的头部引入contextMVC约束。

②开启自动扫描包,让指定包下的注解生效,由IOC容器统一管理。

③过滤静态资源,让Spring MVC不处理静态资源(如:htmlcssjsmp3mp4文件等)。

④开启SpringMVC注解驱动,自动完成DefaultAnnotationHandlerMappingAnnotationMethodHandlerAdapter实例的注入。

注:spring中一般采用@RequestMapping注解来完成映射关系。要想使@RequestMapping注解生效,必须向上下文中注册一个DefaultAnnotationHandlerMapping和一个AnnotationMethodHandlerAdapter实例。这两个实例分别在类级别和方法级别处理注解。而annotation-driven配置帮助我们自动完成上述两个实例的注入。

⑤配置视图解析器(前缀、后缀)。

springmvc-servlet.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?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.xsd
http://www.springframework.org/schema/context
https://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
https://www.springframework.org/schema/mvc/spring-mvc.xsd">

<!--自动扫描包,让指定包下的注解生效,由IOC容器统一管理-->
<context:component-scan base-package="com.atangbiji.controller"/>
<!--过滤静态资源,让Spring MVC不处理静态资源(如:html、css、js、mp3、mp4文件等)-->
<mvc:default-servlet-handler />
<!--开启mvc注解驱动,自动完成DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter实例的注入-->
<mvc:annotation-driven />
<!--视图解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
id="internalResourceViewResolver">
<!-- 前缀 -->
<property name="prefix" value="/WEB-INF/jsp/" />
<!-- 后缀 -->
<property name="suffix" value=".jsp" />
</bean>
</beans>

注:

  • SpringMVC的配置文件本质上就是Spring的配置文件。
  • 处理器映射器、处理器适配器、视图解析器是使用springMVC开发必须配置的三大件。当使用注解开发SpringMVC时,我们只需要手动配置视图解析器,而处理器映射器处理器适配器只需要开启注解驱动即可!
  • 在实际项目中,我们可以将视图解析器换成ThymeleafFreemarker等模板引擎。

7.4、通过注解创建Controller

(6)在该子项目的java目录下新建一个com.atangbiji.controller包(用于存放我们自己编写的控制器),并在该包下新建一个HelloController类。

HelloController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

//自定义控制器,被@Controller注解的类会被自动扫描并添加到Spring上下文(IOC容器)中
@Controller
//映射访问路径
@RequestMapping("/HelloController")
public class HelloController {
//真实访问地址: http://localhost:8080/项目虚拟路径映射/HelloController/hello
@RequestMapping("/hello")
public String sayHello(Model model){
//Spring MVC会自动实例化一个Model对象用于向视图中传值
//向模型中添加属性msg与值,在JSP页面中可以取出并渲染
model.addAttribute("msg","Hello,SpringMVC注解开发");
//返回视图位置:web-inf/jsp/hello.jsp
return "hello";
}
}

注:

  • @Controller之所以能够在Spring IOC容器初始化时被自动扫描到,只因为我们在SpringMVC配置文件中配置了要自动扫描的包。注解完成自动扫描,就相当于我们已经将自己编写的处理器(bean)在SpringIOC容器(Spring的配置文件)中完成注册了,实现了bean的自动装配。
  • @Controller注解的控制器会被视图解析器解析;被@RestController注解的控制器不会被图解析器解析,可以直接返回字符串或json格式的数据。
  • @RequestMapping的作用是为了映射请求路径,这里因为类与方法上都映射了请求路径,所以访问时应该访问:/HelloController/hello
  • 方法中声明Model类型的参数是为了把Action中的数据带到视图中。
  • 方法返回的结果是视图的名称hello,加上配置文件中的前缀和后缀后,变成WEB-INF/jsp/hello.jsp

7.5、创建视图层

(7)在子项目的web/WEB-INF目录下新建一个jsp包,并在该包下新建一个hello.jsp文件,用于显示ModelandView中存放的数据,以及我们的正常页面。

hello.jsp文件:

1
2
3
4
5
6
7
8
9
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>阿汤笔迹</title>
</head>
<body>
${msg}
</body>
</html>

注:我们把所有的视图都存放在/WEB-INF/目录下,这样可以保证视图安全,因为这个目录下的文件,客户端不能直接访问。

7.6、发布与测试

(8)配置Tomcat服务器;deploy(发布)springMVC-03-annotationSpringMVC:war包,并为该子项目添加虚拟路径映射:/mvc。(参见《Servlet详解》)

(9)启动测试。在IDEA中启动Tomcat,在浏览器中输入http://localhost:8080/mvc/HelloController/hello,页面访问成功。访问结果如下:

注解开发测试结果

8、Controller的两种实现方式

8.1、控制器概述

Controller,即:控制器。

  • Controller(控制器)负责提供访问应用程序的行为,即:程序接受用户请求后要处理的一些行为,也就是以前的Servlet
  • Controller(控制器)可以通过实现(implementsController接口或注解两种方式实现。
  • Controller(控制器)负责解析用户的请求,并将其转换为一个模型,返回给视图解析器。
  • Spring MVC中,一个控制器(Controller)类中可以包含多个方法。
  • Spring MVC中,Controller的配置方式有很多种。

8.2、方式一:通过接口实现Controller

8.2.1、控制器接口

Controller是一个控制器接口,在org.springframework.web.servlet.mvc包下,该接口中只有一个方法;

java
1
2
3
4
5
//实现Controller接口的类就是一个控制器,即:获得控制器功能
public interface Controller {
//处理用户请求并返回一个模型与视图(ModelAndView)对象
ModelAndView handleRequest(HttpServletRequest var1, HttpServletResponse var2) throws Exception;
}
  • 只要实现(implements)了Controller接口的类就是一个控制器,即:获得控制器功能。
  • 控制器主要处理用户请求,并返回一个模型与视图(ModelAndView)对象。

8.2.2、实现步骤

具体实现步骤参见第5节:《第一个SpringMVC程序》。

8.2.3、优缺点分析

  • 优点:该方式是较老的实现控制器的方法,但使用它更容易理解SpringMVC的运行原理。
  • 缺点:一个控制器中只有一个方法,如果要多个方法则需要定义多个Controller,定义的方式比较麻烦。

8.3、方式二:通过注解实现Controller(推荐)

8.3.1、使用@Controller注解声明控制器

  • @Controller注解用于声明Spring类的实例是一个控制器

注:在讲Spring时还提到了另外3个与@Controller注解功能一样的注解,即:@Component@Service@Repository。(参见《Spring详见》9.4节)

8.3.2、使用@RequestMapping注解映射访问路径

  • @RequestMapping注解用于映射url到控制器类或一个特定的处理程序方法。
  • 它可用于类或方法上。若用于类上,则表示类中所有响应请求的方法都是以该路径作为父路径。

8.3.3、实现步骤

具体实现步骤参见第7节:《使用注解开发SpringMVC》。

8.3.4、优缺点分析

  • 优点:一个控制器中可以有多个方法,使用简单方便。
  • 缺点:底层都被封装了,使用它可能不太好理解SpringMVC的运行原理。

注:无论方式一还是方式二,它们都实现了视图的复用(即:不同的请求可以指向同一个视图,但是页面显示的结果可以不同)。因此,控制器与视图之间是弱偶合关系。

9、RestFul风格

9.1、什么是RestFul风格

RestFulRepresentational State Transfer)就是一种资源定位及资源操作的风格。它不是标准也不是协议,只是一种风格。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。

互联网上所有的事物都可以被抽象为资源,并且每个资源我们都只能通过唯一的访问路径(URL)去访问它。

  • 传统的资源操作方式:通过?传参,通过不同的参数来实现不同的效果。

    • 比如:http://ip:port/项目虚拟映射路径/资源名?请求参数

    • 举例:http://127.0.0.1:8080/springmvc/book?action=delete&id=1

  • RestFul风格的资源操作方式:通过/传参,可以通过不同的请求方式来实现不同的效果。

    • 比如:http://ip:port/项目虚拟映射路径/资源名/请求参数/请求参数
    • 举例:http://127.0.0.1:8080/springmvc/book/1
    • 请求的动作(如:删除)由请求方式delete决定。

RestFul风格中的POSTDELETEPUTGET请求方式与对资源的增、删、改、查操作一一对应。如:

URL 请求方式 功能
http://ip:port/项目虚拟映射路径/book/1 GET(查询) 查询id为1的图书
http://ip:port/项目虚拟映射路径/book GET(查询) 查询全部的图书
http://ip:port/项目虚拟映射路径/book POST(增加) 增加一个图书
http://ip:port/项目虚拟映射路径/book/1 PUT(修改) 修改id为1的图书信息
http://ip:port/项目虚拟映射路径/book/1 DELETE(删除) 删除id为1的图书信息

注:当通过RestFul风格操作资源时,即使请求地址(URL)一样,也可以实现不同的功能!请求的动作(增、删、改、查)由请求方式(POSTDELETEPUTGET)决定。

9.2、对比测试

9.2.1、传统的资源操作方式

(1)在上述子项目的基础上,在com.atangbiji.controller包下新建一个TraditionalController类,并使用传统的资源操作方式映射访问路径(URL)。

TraditionalController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

//自定义控制器,被@Controller注解的类会被自动扫描并添加到Spring上下文(IOC容器)中
@Controller
//映射访问路径
@RequestMapping("/Traditional")
public class TraditionalController {
//映射访问路径(真实访问地址: http://localhost:8080/项目虚拟路径映射/Traditional/add)
@RequestMapping("/add")
public String add(int p1, int p2, Model model){
int result = p1 + p2;
//向模型中添加属性msg与值,在JSP页面中可以取出并渲染
model.addAttribute("msg","计算结果为:" + result);
//返回视图位置:web-inf/jsp/hello.jsp
return "hello";
}
}

(2)此时,我们需要使用?传参。重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/Traditional/add?p1=1&p2=2,页面访问成功。访问结果如下:

传统的资源操作方式

9.2.2、RestFul风格的资源操作方式

(1)在上述子项目的基础上,再在com.atangbiji.controller包下新建一个RestFulController类,并使用RestFul风格的资源操作方式映射访问路径(URL)。

RestFulController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

//自定义控制器,被@Controller注解的类会被自动扫描并添加到Spring上下文(IOC容器)中
@Controller
//映射访问路径
@RequestMapping("/RestFul")
public class RestFulController {
//映射访问路径(真实访问地址: http://localhost:8080/项目虚拟路径映射/RestFul/add/{p1}/{p2})
@RequestMapping("/add/{p1}/{p2}")
public String add(@PathVariable int p1,@PathVariable int p2, Model model){
int result = p1 + p2;
//向模型中添加属性msg与值,在JSP页面中可以取出并渲染
model.addAttribute("msg","计算结果为:" + result);
//返回视图位置:web-inf/jsp/hello.jsp
return "hello";
}
}

注:Spring MVC中,我们可以使用@PathVariable(路径变量)注解,将方法参数的值对应绑定到一个URL模板变量上。这样,我们就可以在URL中给参数传参了。

(2)此时,我们需要使用/传参。重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/RestFul/add/1/2,页面访问成功。访问结果如下:

RestFul风格的资源操作方式

9.3、使用RestFul风格的优点

使用RestFul风格(路径变量)的URL主要有以下好处:

  • 使路径变得更加简洁;
  • URL中不会暴露访问的参数(名称),访问更加安全;
  • 易于实现缓存,访问更高效;
  • 获得参数更加方便,框架会自动进行类型转换;
  • 通过路径变量的类型可以约束访问参数。若参数类型不一样,则访问不到对应的请求方法。如:若上述访问路径是http://localhost:8080/mvc/RestFul/add/1/a,则路径与方法不匹配(a不是int类型),而不会是参数转换失败。

9.4、使用method属性指定请求类型

我们可以在@RequestMapping注解中使用method属性来约束请求的类型,以收窄请求范围。

注:@RequestMapping注解中定义了RequestMethod(请求方式)的值可以是:GETHEADPOSTPUTPATCHDELETEOPTIONSTRACE

9.4.1、测试步骤

(1)修改上述add方法的@RequestMapping注解,通过method属性限定映射的访问路径必须是POST请求。

RestFulController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

//自定义控制器,被@Controller注解的类会被自动扫描并添加到Spring上下文(IOC容器)中
@Controller
//映射访问路径
@RequestMapping("/RestFul")
public class RestFulController {
//映射访问路径(真实访问地址: http://localhost:8080/项目虚拟路径映射/RestFul/add/{p1}/{p2})
@RequestMapping(value = "/add/{p1}/{p2}",method = RequestMethod.POST)
public String add(@PathVariable int p1,@PathVariable int p2, Model model){
int result = p1 + p2;
//向模型中添加属性msg与值,在JSP页面中可以取出并渲染
model.addAttribute("msg","计算结果为:" + result);
//返回视图位置:web-inf/jsp/hello.jsp
return "hello";
}
}

(2)重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/RestFul/add/1/2。因为我们使用浏览器地址栏进行访问默认使用是Get请求,因此会报405错误。访问结果如下:

请求方式出错

(3)如果将上述请求方式由POST修改为GET

RestFulController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

//自定义控制器,被@Controller注解的类会被自动扫描并添加到Spring上下文(IOC容器)中
@Controller
//映射访问路径
@RequestMapping("/RestFul")
public class RestFulController {
//映射访问路径(真实访问地址: http://localhost:8080/项目虚拟路径映射/RestFul/add/{p1}/{p2})
@RequestMapping(value = "/add/{p1}/{p2}",method = RequestMethod.GET)
public String add(@PathVariable int p1,@PathVariable int p2, Model model){
int result = p1 + p2;
//向模型中添加属性msg与值,在JSP页面中可以取出并渲染
model.addAttribute("msg","计算结果为:" + result);
//返回视图位置:web-inf/jsp/hello.jsp
return "hello";
}
}

(4)重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/RestFul/add/1/2,页面访问成功。访问结果如下:

GET方式请求成功

注:我们可以使用@GetMapping注解,将@RequestMapping(value = "/add/{p1}/{p2}",method = RequestMethod.GET)注解简化为@GetMapping("/add/{p1}/{p2}"),两者是等价的。

9.4.2、小结

  • 我们可以在@RequestMapping注解中使用method属性来约束请求的类型,以收窄请求范围。

  • @RequestMapping注解中定义了RequestMethod(请求方式)的值可以是:GETHEADPOSTPUTPATCHDELETEOPTIONSTRACE

  • 所有的地址栏请求默认都是 HTTP GET 类型的。

  • 方法级别的注解变体有:(平时使用的会比较多)

    • @GetMapping:等价于@RequestMapping(method = RequestMethod.GET)
    • @PostMapping:等价于@RequestMapping(method = RequestMethod.POST)
    • @PutMapping:等价于@RequestMapping(method = RequestMethod.PUT)
    • @DeleteMapping:等价于@RequestMapping(method = RequestMethod.DELETE)
    • @PatchMapping:等价于@RequestMapping(method = RequestMethod.PATCH)
  • 当通过RestFul风格操作资源时,即使请求地址(URL)一样,也可以实现不同的功能!请求的动作(增、删、改、查)由请求方式(POSTDELETEPUTGET)决定。

10、结果跳转方式

10.1、通过ModelAndView设置跳转页面

我们可以使用ModelAndView对象设置视图(view)名称,然后通过视图解析器跳转到指定的页面。

跳转页面的位置为:{视图解析器前缀} + viewName(视图名称) + {视图解析器后缀}。

如:第一个SpringMVC程序中

  • SpringMVC配置文件中配置的视图解析器

springmvc-servlet.xml文件:

xml
1
2
3
4
5
6
7
8
<!--视图解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
id="internalResourceViewResolver">
<!-- 前缀 -->
<property name="prefix" value="/WEB-INF/jsp/" />
<!-- 后缀 -->
<property name="suffix" value=".jsp" />
</bean>
  • 对应的controller

HelloController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.atangbiji.controller;

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
//自定义控制器
public class HelloController implements Controller {
//处理请求,并响应
public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
//新建ModelAndView(模型和视图)
ModelAndView mv = new ModelAndView();
//封装对象Model,并放在ModelAndView中
mv.addObject("msg","HelloSpringMVC!");
//封装要跳转的视图,并放在ModelAndView中
mv.setViewName("hello");
//返回视图位置:WEB-INF/jsp/hello.jsp
return mv;
}
}

10.2、通过Servlet API实现结果跳转(了解)

10.2.1、实现功能

因为Controller的底层(本质)仍然是Servlet,所以我们也可以通过Servlet API实现结果跳转。我们可以:

(1)通过HttpServletResponse输出结果。

(2)通过HttpServletResponse实现重定向

(3)通过HttpServletRequest实现请求转发。

注:通过Servlet API实现结果跳转,不需要视图解析器。

10.2.2、测试

(1)在上述子项目的基础上,在com.atangbiji.controller包下新建一个ResultByServletAPI类。

ResultByServletAPI.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Controller
public class ResultByServletAPI {
@RequestMapping("ServletAPI/test1")
//通过HttpServletResponse输出结果
public void test1(HttpServletRequest request, HttpServletResponse response) throws IOException {
response.getWriter().println("Hello,SpringMVC BY servlet API");
}
//通过HttpServletResponse实现重定向
@RequestMapping("/ServletAPI/test2")
public void test2(HttpServletRequest request, HttpServletResponse response) throws IOException {
response.sendRedirect("/mvc/index.jsp");
}
//通过HttpServletRequest实现请求转发
@RequestMapping("/ServletAPI/test3")
public void test3(HttpServletRequest request, HttpServletResponse response) throws Exception {
request.getRequestDispatcher("/index.jsp").forward(request,response);
}
}

(2)修改默认生成的index页面。

index.jsp文件:

1
2
3
4
5
6
7
8
9
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>阿汤笔迹</title>
</head>
<body>
欢迎访问index页面!
</body>
</html>

(3)重新启动Tomcat

  • 在浏览器中输入http://localhost:8080/mvc/ServletAPI/test1,页面访问成功。访问结果如下:
ServletAPI输出结果
  • 在浏览器中输入http://localhost:8080/mvc/ServletAPI/test2,页面访问成功。访问结果如下:
ServletAPI输出结果重定向
  • 在浏览器中输入http://localhost:8080/mvc/ServletAPI/test3,页面访问成功。访问结果如下:
ServletAPI输出结果请求转发

10.3、通过SpringMVC实现结果跳转

10.3.1、通过SpringMVC实现转发和重定向(无需视图解析器)【了解】

(1)在上述子项目的基础上,先将SpringMVC配置文件(springmvc-servlet.xml)中的视图解析器注释掉。

(2)然后,在com.atangbiji.controller包下新建一个ResultBySpringMVC1类。

ResultBySpringMVC1.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class ResultBySpringMVC1 {
@RequestMapping("SpringMVC1/test1")
public String test1(){
//(默认)请求转发
return "/index.jsp";
}

@RequestMapping("SpringMVC1/test2")
public String test2(){
//使用forward:(显示)请求转发
return "forward:/index.jsp";
}

@RequestMapping("SpringMVC1/test3")
public String test3(){
//使用redirect:(显示)重定向
return "redirect:/index.jsp";
}
}

(3)重新启动Tomcat

  • 在浏览器中输入http://localhost:8080/mvc/SpringMVC1/test1,页面访问成功。访问结果如下:
SpringMVC请求转发方式一
  • 在浏览器中输入http://localhost:8080/mvc/SpringMVC1/test2,页面访问成功。访问结果如下:
SpringMVC请求转发方式二
  • 在浏览器中输入http://localhost:8080/mvc/SpringMVC1/test3,页面访问成功。访问结果如下:
SpringMVC重定向

10.3.2、通过SpringMVC实现转发和重定向(需要视图解析器)【推荐】

(1)在上述子项目的基础上,先将SpringMVC配置文件(springmvc-servlet.xml)中视图解析器的注释去除。

(2)然后,在com.atangbiji.controller包下新建一个ResultBySpringMVC2类。

ResultBySpringMVC2.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class ResultBySpringMVC2 {
@RequestMapping("SpringMVC2/test1")
public String test1(Model model){
//Spring MVC会自动实例化一个Model对象用于向视图中传值
//向模型中添加属性msg与值,在JSP页面中可以取出并渲染
model.addAttribute("msg","Hello,通过SpringMVC和视图解析器实现请求转发。");
//返回视图位置:web-inf/jsp/hello.jsp(请求转发)
return "hello";
}

@RequestMapping("SpringMVC2/test2")
public String test2(){
//使用redirect:(显示)重定向
return "redirect:/index.jsp";
}
}

(3)重新启动Tomcat

  • 在浏览器中输入http://localhost:8080/mvc/SpringMVC2/test1,页面访问成功。访问结果如下:
通过SpringMVC和视图解析器实现请求转发
  • 在浏览器中输入http://localhost:8080/mvc/SpringMVC2/test2,页面访问成功。访问结果如下:
通过SpringMVC和视图解析器实现重定向

注:重定向本质就是重新请求一个新的URl , 所以它根本不需要视图解析器。(注意路径问题)

11、数据处理

11.1、接受前端提交的数据

11.1.1、提交域名中参数的名称和处理方法中参数的名称一致

若提交域名中参数的名称处理方法中参数的名称一致,则可直接进行数据传递。

测试:

(1)在上述子项目的基础上,在com.atangbiji.controller包下新建一个UserController类。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class UserController {
//映射访问路径
@RequestMapping("/user/test1")
public String test1(String name, Model model){
//接受前端参数,将数据处理返回给前端
model.addAttribute("msg","提交域名中参数的名称是:name,值为:" + name + "; 处理方法中参数的名称也是:name!");
//视图跳转
return "hello";
}
}

(2)重新启动Tomcat。在浏览器中输入http://localhost:8080/mvc/user/test1?name=atang,页面访问成功。访问结果如下:

提交域名中参数的名称和处理方法中参数的名称一致

11.1.2、提交域名中参数的名称和处理方法中参数的名称不一致(推荐)

若提交域名中参数的名称处理方法中参数的名称不一致,则需要在处理方法中使用@RequestParam注解声明域名中该参数对应的名称后,才能进行数据传递。

测试:

(1)在UserController类中下新建一个test2方法。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class UserController {
//映射访问路径
@RequestMapping("/user/test2")
public String test2(@RequestParam("userName") String name, Model model){
//接受前端参数,将数据处理返回给前端
model.addAttribute("msg","提交域名中参数的名称是:userName,值为:" + name + "; 处理方法中参数的名称是:name!");
//视图跳转
return "hello";
}
}

(2)重新启动Tomcat。在浏览器中输入http://localhost:8080/mvc/user/test2?userName=atang,页面访问成功。访问结果如下:

提交域名中参数的名称和处理方法中参数的名称不一致

注:无论提交域名中参数的名称和处理方法中参数的名称是否一致,我们建议把所有需要从前端接受数据的形参都使用@RequestParam注解进行声明,这样哪些参数需要从前端传值就会一目了然。

11.1.3、提交一个对象

若提交数据是一个对象,则需要域名中提交的参数名称和实体类(pojo)中该对象的属性名保持一致,且处理方法中使用该对象作为形参,才能进行数据传递。

测试:

(1)在上述子项目的基础上,在父项目的pom.xml文件中导入lombok依赖。

pom.xml文件:

xml
1
2
3
4
5
6
<!-- lombok依赖 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
</dependency>

(2)在java目录下新建一个com.atangbiji.pojo包,并在该包下新建一个User实体类。

User.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.atangbiji.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
//实体类
public class User {
private int id;
private String name;
private int age;
private String sex;
}

(3)在UserController类中下新建一个test3方法。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.atangbiji.controller;

import com.atangbiji.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class UserController {
//映射访问路径
@RequestMapping("/user/test3")
public String test3(User user, Model model){
//接受前端参数,将数据处理返回给前端
model.addAttribute("msg","URL传入的User对象为:" + user.toString());
//视图跳转
return "hello";
}
}

(4)重新启动Tomcat。在浏览器中输入http://localhost:8080/mvc/user/test3?id=1&name=atang&age=18,页面访问成功。访问结果如下:

提交一个对象

注:

  • 若前端输入的参数名和对象属性名不一致,则该属性传入的就是null
  • 若前端没有输入该对象某一属性对应的参数,则该属性传入的也是null

11.2、将数据显示到前端

11.2.1、方式一:通过ModelAndView

如:第一个SpringMVC程序中

HelloController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.atangbiji.controller;

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
//自定义控制器
public class HelloController implements Controller {
//处理请求,并响应
public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
//新建ModelAndView(模型和视图)
ModelAndView mv = new ModelAndView();
//封装对象Model,并放在ModelAndView中
mv.addObject("msg","HelloSpringMVC!");
//封装要跳转的视图,并放在ModelAndView中
mv.setViewName("hello");
//返回视图位置:WEB-INF/jsp/hello.jsp
return mv;
}
}

11.2.2、方式二:通过ModelMap

HelloController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;

//自定义控制器,被@Controller注解的类会被自动扫描并添加到Spring上下文(IOC容器)中
@Controller
public class HelloController {
//映射访问路径
@RequestMapping("/HelloController/test")
public String test(ModelMap modelMap){
//向modelMap中添加属性msg与值,在JSP页面中可以取出并渲染
modelMap.addAttribute("msg","通过ModelMap将数据显示到前端!");
//返回视图位置:web-inf/jsp/hello.jsp
return "hello";
}
}

11.2.3、方式三:通过Model

HelloController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

//自定义控制器,被@Controller注解的类会被自动扫描并添加到Spring上下文(IOC容器)中
@Controller
public class HelloController {
//映射访问路径
@RequestMapping("/HelloController/hello")
public String hello(Model model){
//Spring MVC会自动实例化一个Model对象用于向视图中传值
//向模型中添加属性msg与值,在JSP页面中可以取出并渲染
model.addAttribute("msg","通过Model将数据显示到前端!");
//返回视图位置:web-inf/jsp/hello.jsp
return "hello";
}
}

11.2.4、对比

就对于新手而言,上述三种方式的使用区别简单来说就是:

  • Model只有寥寥几个方法只适合用于储存数据,简化了新手对于Model对象的操作和理解(使用最多);

  • ModelMap继承了LinkedMap,除了实现了自身的一些方法外,同样继承了LinkedMap的方法和特性;

  • ModelAndView可以在储存数据的同时,进行设置返回的逻辑视图,进行视图跳转。

12、解决乱码问题

乱码问题是在我们开发中十分常见的问题,也是让我们程序猿比较头大的问题!

以前乱码问题可以通过过滤器解决 , SpringMVC也给我们提供了一个解决乱码问题的过滤器 , 我们只需在web.xml中配置即可。

web.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
<!--配置SpringMVC的乱码过滤器-->
<filter>
<filter-name>encoding</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>encoding</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>

注:一般情况下,SpringMVC默认的编码过滤器就已经能够解决绝大多数的乱码问题了!如果乱码问题仍得不到解决,建议:

(1)检查tomcat的配置文件是否设置utf-8编码!

xml
1
2
3
<Connector URIEncoding="utf-8" port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />

(2)自定义编码过滤器,然后在web.xml中配置自定义的编码过滤器。

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
package com.atangbiji.filter;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.Map;

/**
* 解决get和post请求 全部乱码的过滤器
*/
public class GenericEncodingFilter implements Filter {

@Override
public void destroy() {
}

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
//处理response的字符编码
HttpServletResponse myResponse=(HttpServletResponse) response;
myResponse.setContentType("text/html;charset=UTF-8");

// 转型为与协议相关对象
HttpServletRequest httpServletRequest = (HttpServletRequest) request;
// 对request包装增强
HttpServletRequest myrequest = new MyRequest(httpServletRequest);
chain.doFilter(myrequest, response);
}

@Override
public void init(FilterConfig filterConfig) throws ServletException {
}

}

//自定义request对象,HttpServletRequest的包装类
class MyRequest extends HttpServletRequestWrapper {

private HttpServletRequest request;
//是否编码的标记
private boolean hasEncode;
//定义一个可以传入HttpServletRequest对象的构造函数,以便对其进行装饰
public MyRequest(HttpServletRequest request) {
super(request);// super必须写
this.request = request;
}

// 对需要增强方法 进行覆盖
@Override
public Map getParameterMap() {
// 先获得请求方式
String method = request.getMethod();
if (method.equalsIgnoreCase("post")) {
// post请求
try {
// 处理post乱码
request.setCharacterEncoding("utf-8");
return request.getParameterMap();
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
} else if (method.equalsIgnoreCase("get")) {
// get请求
Map<String, String[]> parameterMap = request.getParameterMap();
if (!hasEncode) { // 确保get手动编码逻辑只运行一次
for (String parameterName : parameterMap.keySet()) {
String[] values = parameterMap.get(parameterName);
if (values != null) {
for (int i = 0; i < values.length; i++) {
try {
// 处理get乱码
values[i] = new String(values[i]
.getBytes("ISO-8859-1"), "utf-8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
}
}
}
hasEncode = true;
}
return parameterMap;
}
return super.getParameterMap();
}

//取一个值
@Override
public String getParameter(String name) {
Map<String, String[]> parameterMap = getParameterMap();
String[] values = parameterMap.get(name);
if (values == null) {
return null;
}
return values[0]; // 取回参数的第一个值
}

//取所有值
@Override
public String[] getParameterValues(String name) {
Map<String, String[]> parameterMap = getParameterMap();
String[] values = parameterMap.get(name);
return values;
}
}

13、JSON

13.1、JSON概述

13.1.1、什么是JSON

JSONJavaScript Object NotationJS对象标记)是一种轻量级的数据交换格式,目前使用特别广泛。其主要特点:

  • 采用完全独立于编程语言的文本格式来存储和表示数据。
  • 层次结构简洁、清晰。
  • 易于人阅读和编写,同时也易于机器解析和生成,并能够有效地提升网络传输效率。

JavaScript语言中,一切都是对象。因此,任何JavaScript支持的类型都可以通过JSON来表示,例如字符串、数字、对象、数组等。

13.1.2、JSON的语法格式

  • 对象表示为键值对,数据由逗号(,)分隔。
  • 大括号({})保存对象。
  • 中括号([])保存数组。

JSON 键值对是用来保存JavaScript对象的一种方式,和JavaScript对象的写法也大同小异,键/值对组合中的键名写在前面并用双引号 ("")包裹,使用冒号(:)分隔,然后紧接着值。如:

json
1
2
3
{"name": "Atang"}
{"age": "3"}
{"sex": "男"}

13.1.3、JSONJavaScript对象的关系

JSONJavaScript对象的字符串表示法,它使用文本表示一个JS对象的信息,本质上是一个字符串。如:

1
2
var obj = {a: 'Hello', b: 'World'}; //这是一个JS对象,注意键名也是可以使用引号包裹的
var json = '{"a": "Hello", "b": "World"}'; //这是一个 JSON 字符串,本质是一个字符串

13.1.4、JSON字符串和JavaScript对象的相互转换

(1)JSON字符串转JavaScript对象

要将JSON字符串转换为JavaScript对象,需使用JSON.parse()方法。如:

Javascript
1
2
var obj = JSON.parse('{"a": "Hello", "b": "World"}');
//结果是 {a: 'Hello', b: 'World'}

(2)JavaScript对象转JSON字符串

要将JavaScript对象转换为JSON字符串,需使用JSON.stringify()方法。如:

Javascript
1
2
var json = JSON.stringify({a: 'Hello', b: 'World'});
//结果是 '{"a": "Hello", "b": "World"}'

13.1.5、测试

(1)在父项目中新建一个模块(Module),并在其中创建一个普通的Maven子项目,项目名称为springMVC-04-json

(2)右键选择”Add FrameworkSupport“菜单项,为该子项目添加Web Application的支持!

注:如果我们的Java Web应用是通过普通Maven项目添加Web Application支持的方式创建,那么当我们deploy(发布)项目时,可能会出现输出目录无法生成lib目录,进而无法导出依赖包的问题,此时页面显示404错误。

  • 出现该问题的原因在于:使用Maven模板创建MavenWeb项目默认生成的Web资源目录,与通过普通Maven项目添加Web Application支持的方式创建的Web项目的Web资源目录不相同。
  • 解决方法:点击File->Project Structure菜单,打开项目结构目录,我们只需在其中将该项目的Web资源目录修改正确,并手动将Maven依赖包添加到输出跟目录下即可。(详见5.1节)

(3)在子项目的web/WEB-INF目录下新建一个html包,并在该包下新建一个jsonTest.html文件,用于显示ModelandView中存放的数据,以及我们的正常页面。

jsonTest.html文件:

html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>阿汤笔迹</title>
</head>
<body>
<script type="text/javascript">
<!--编写一个JavaScript的对象-->
var user = {
name:"阿汤",
age:18,
sex:"男"
};

<!--将JavaScript对象转换成JSON字符串-->
var json = JSON.stringify(user);
console.log(json);
<!--将JSON字符串转换成JavaScript对象-->
var obj = JSON.parse(json);
console.log(obj);
</script>
</body>
</html>

(4)在IDEA中使用浏览器打开html页面,F12查看控制台输出!输出结果如下图所示:

JSON字符串与变量

13.2、通过Jackson返回JSON数据

13.2.1、常用的json分析处理工具

  • Jackson是目前比较好用的json分析处理工具。
  • 当然还有其它的分析处理工具,如:阿里巴巴的fastjson等。

13.2.2、通过Jackson输出JSON对象

在上述springMVC-04-json子项目的基础上:

(1)先确认在父项目的pom.xml文件中导入父/子工程所需要的SpringMVC相关的依赖。此外,我们需要导入Jackson所依赖的jar包。

pom.xml文件:

xml
1
2
3
4
5
6
<!-- jackson依赖 -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.10.0</version>
</dependency>

注:为了确保项目发布时,jackson的依赖包发布成功,我们需要再次手动将Maven依赖包添加到输出跟目录下。(详见5.1节)

(2)同样地,在web.xml文件中注册DispatcherServlet(中心控制器),并通过DispatcherServlet(中心控制器)拦截浏览器的所有请求。

(3)同样地,在该子项目的resources目录下新建一个SpringMVC的配置文件,配置文件的名称为:springmvc-servlet.xml(即:[servletname]-servlet.xml)。

(4)在java目录下新建一个com.atangbiji.pojo包,并在该包下新建一个User实体类。

User.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.atangbiji.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
//需要导入lombok
@Data
@NoArgsConstructor
@AllArgsConstructor
//实体类
public class User {
private int id;
private String name;
private int age;
private String sex;
}

(5)同样地,在该子项目的java目录下新建一个com.atangbiji.controller包(用于存放我们自己编写的控制器),并在该包下新建一个UserController类。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package com.atangbiji.controller;

import com.atangbiji.pojo.User;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class UserController {

@RequestMapping("/json/test1")
//被@ResponseBody注解的方法不会被视图解析器解析,会直接返回一个字符串。
@ResponseBody
public String json1() throws JsonProcessingException {
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个User对象
User user = new User(1,"阿汤", 18, "男");
//将我们的对象解析成为json格式
String str = mapper.writeValueAsString(user);
//Controller返回JSON数据
return str;
}
}

注:

  • @ResponseBody注解是配合@Controller注解使用的。
  • @ResponseBody注解的方法不会被视图解析器解析,会直接返回一个字符串。
  • ObjectMapperJackson包中的对象映射器。

当然,我们也可以在输出字符串的控制器上直接使用@RestController注解。如:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//被@RestController注解的控制器类,其中所有的方法都将只返回字符串
@RestController
public class UserController {

@RequestMapping(value = "/json/test1")
public String json1() throws JsonProcessingException {
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个User对象
User user = new User(1,"阿汤", 18, "男");
//将我们的对象解析成为json格式
String str = mapper.writeValueAsString(user);
//Controller返回JSON数据
return str;
}
}

注:@RestController注解Controller类,其中所有的方法都将只返回字符串。我们不用再给其中的每一个方法都添加@ResponseBody注解了!在前后端分离开发中,一般都使用@RestController注解,十分便捷!

(6)配置Tomcat服务器;deploy(发布)springMVC-04-json:war包,并为该子项目添加虚拟路径映射:/mvc。(参见《Servlet详解》)

(7)启动测试。在IDEA中启动Tomcat,在浏览器中输入http://localhost:8080/mvc/json/test1,页面访问成功,但出现json字符串中文乱码问题。访问结果如下:

jackson使用测试乱码

13.2.3、解决中文乱码问题

(1)方法一:通过@RequestMaping注解的produces属性解决json字符串乱码问题。

UserController.java文件:

java
1
2
//通过@RequestMaping注解的produces属性解决json字符串乱码问题
@RequestMapping(value = "/json/test1",produces = "application/json;charset=utf-8")

重启Tomcat,在浏览器中输入http://localhost:8080/mvc/json/test1,页面访问成功,json字符串中文乱码问题得到解决。访问结果如下:

jackson使用测试未乱码

注:如果项目中有许多请求,那么使用方法一解决乱码问题就比较麻烦,因为每一个请求都要需要我们手动添加一个produces属性。

(2)方法二:通过SpringMVC配置统一解决乱码问题。(推荐)

我们可以在SpringMVC的配置文件上添加一段StringHttpMessageConverter消息转换配置!这样就不用每次都去处理json字符串乱码问题了!

springmvc-servlet.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!--统一解决json字符串乱码问题-->
<mvc:annotation-driven>
<mvc:message-converters register-defaults="true">
<bean class="org.springframework.http.converter.StringHttpMessageConverter">
<constructor-arg value="UTF-8"/>
</bean>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper">
<bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
<property name="failOnEmptyBeans" value="false"/>
</bean>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>

13.2.4、通过Jackson输出JSON数组

UserController类中新增一个json2方法。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
package com.atangbiji.controller;

import com.atangbiji.pojo.User;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.ArrayList;

@Controller
public class UserController {
@RequestMapping(value = "/json/test2")
//被@ResponseBody注解的方法不会被视图解析器解析,会直接返回一个字符串。
@ResponseBody
public String json2() throws JsonProcessingException {
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个数组集合
ArrayList<User> userList = new ArrayList<User>();
//创建多个User对象
User user1 = new User(1,"阿汤", 18, "男");
User user2 = new User(2,"张三", 3, "男");
User user3 = new User(3,"李四", 18, "男");
//把多个User对象添加到数组集合
userList.add(user1);
userList.add(user2);
userList.add(user3);
//将我们的数组集合解析成为json格式
String str = mapper.writeValueAsString(userList);
//Controller返回JSON数据
return str;
}
}

重启Tomcat,在浏览器中输入http://localhost:8080/mvc/json/test2,页面访问成功。访问结果如下:

jackson输出JSON数组

13.2.5、通过Jackson输出时间对象

UserController类中新增一个json3方法。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package com.atangbiji.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Date;

@Controller
public class UserController {
@RequestMapping(value = "/json/test3")
//被@ResponseBody注解的方法不会被视图解析器解析,会直接返回一个字符串。
@ResponseBody
public String json3() throws JsonProcessingException {
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个Date对象(java.util.Date)
Date date = new Date();
//将我们的对象解析成为json格式
String str = mapper.writeValueAsString(date);
//Controller返回JSON数据
return str;
}
}

重启Tomcat,在浏览器中输入http://localhost:8080/mvc/json/test3,页面访问成功。访问结果如下:

jackson输出时间对象

注:Jackson默认会把时间转换成Timestamp(时间戳)形式。(即:1970年1月1日到当前时间的毫秒数!)

若要正常输出时间,则需要取消Timestamp形式 , 自定义时间格式。在UserController类中新增一个json4方法。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
package com.atangbiji.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.text.SimpleDateFormat;
import java.util.Date;

@Controller
public class UserController {
@RequestMapping(value = "/json/test4")
//被@ResponseBody注解的方法不会被视图解析器解析,会直接返回一个字符串。
@ResponseBody
public String json4() throws JsonProcessingException {
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//设置为不使用时间戳的方式
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//自定义日期格式
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//指定日期格式
mapper.setDateFormat(sdf);

//创建一个Date对象(java.util.Date)
Date date = new Date();
//将我们的对象解析成为json格式
String str = mapper.writeValueAsString(date);
//Controller返回JSON数据
return str;
}
}

重启Tomcat,在浏览器中输入http://localhost:8080/mvc/json/test4,页面访问成功。访问结果如下:

jackson输出时间对象正确

13.2.6、封装成工具类(重点)

java目录下新建一个com.atangbiji.utils包,并在该包下新建一个JsonUtils,用于封装Jackson

JsonUtils.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
package com.atangbiji.utils;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

import java.text.SimpleDateFormat;

public class JsonUtils {

public static String getJson(Object object) {
return getJson(object,"yyyy-MM-dd HH:mm:ss");
}

public static String getJson(Object object,String dateFormat){
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//设置为不使用时间戳的方式
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//自定义日期格式
SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
//指定日期格式
mapper.setDateFormat(sdf);
try {
//将我们的对象解析成为json格式,并返回JSON数据
return mapper.writeValueAsString(object);
} catch (JsonProcessingException e) {
e.printStackTrace();
}
return null;
}
}

UserController类中新增一个json5方法,并在其中使用我们封装的工具类。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.atangbiji.controller;

import com.atangbiji.utils.JsonUtils;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Date;

@Controller
public class UserController {
@RequestMapping("/json/test5")
//被@ResponseBody注解的方法不会被视图解析器解析,会直接返回一个字符串。
@ResponseBody
public String json5() {
Date date = new Date();
String json = JsonUtils.getJson(date);
return json;
}
}

重启Tomcat,在浏览器中输入http://localhost:8080/mvc/json/test5,页面访问成功。访问结果如下:

jackson封装测试

13.3、通过FastJson返回JSON数据

fastjson.jar是阿里巴巴开发的一款专门用于Java开发的包,使用它同样可以方便地实现json对象与JavaBean对象的转换。

13.3.1、fastjson三个主要的类及常用方法

  • JSONObject(json对象)

  • JSONArray(json数组)

  • JSON(JSONObjectJSONArray间的转化)

    • toJSONStringJava对象转JSON字符串。
    • toJSONJava对象转JSON对象。
    • toJavaObjectJSON对象转Java对象。
    • parseObjectJSON字符串转Java对象。

13.3.2、fastjson的使用步骤

在上述springMVC-04-json子项目的基础上:

(1)先确认在父项目的pom.xml文件中导入父/子工程所需要的SpringMVC相关的依赖。此外,我们需要导入fastjson所依赖的jar包。

pom.xml文件:

xml
1
2
3
4
5
6
<!-- fastjson依赖 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.60</version>
</dependency>

注:为了确保项目发布时,fastjson的依赖包发布成功,我们需要再次手动将Maven依赖包添加到输出跟目录下。(详见5.1节)

(2)在UserController类中新增一个fastjsonTest方法。

UserController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
package com.atangbiji.controller;

import com.alibaba.fastjson.JSON;
import com.atangbiji.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.ArrayList;

@Controller
public class UserController {
@RequestMapping("/fastjson/test")
//被@ResponseBody注解的方法不会被视图解析器解析,会直接返回一个字符串。
@ResponseBody
public String fastjsonTest() {
//创建一个数组集合
ArrayList<User> userList = new ArrayList<User>();
//创建多个User对象
User user1 = new User(1,"阿汤", 18, "男");
User user2 = new User(2,"张三", 3, "男");
User user3 = new User(3,"李四", 18, "男");
//把多个User对象添加到数组集合
userList.add(user1);
userList.add(user2);
userList.add(user3);
//通过fastjson将我们的数组集合解析成为json格式
String str = JSON.toJSONString(userList);
return str;
}
}

重启Tomcat,在浏览器中输入http://localhost:8080/mvc/fastjson/test,页面访问成功。访问结果如下:

fastjson使用测试

14、SSM框架整合

14.1、环境要求

  • IDEA 2020.2
  • MySQL 5.7.19
  • Tomcat 9.0.65
  • Maven 3.6.1

注:整合SSM框架,需要熟练掌握MySQL数据库、JavaWebSpringSpringMVCMyBatis及简单的前端知识。

14.2、配置MyBatis(DAO层)

14.2.1、搭建数据库环境

使用SQL创建一个名称为ssmbuild的数据库,在其中创建一个用于存放书籍数据的books表,并向其中插入测试数据。

sql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
CREATE DATABASE `ssmbuild`;

USE `ssmbuild`;

DROP TABLE IF EXISTS `books`;

CREATE TABLE `books` (
`bookID` INT(10) NOT NULL AUTO_INCREMENT COMMENT '书id',
`bookName` VARCHAR(100) NOT NULL COMMENT '书名',
`bookCounts` INT(11) NOT NULL COMMENT '数量',
`detail` VARCHAR(200) NOT NULL COMMENT '描述',
KEY `bookID` (`bookID`)
) ENGINE=INNODB DEFAULT CHARSET=utf8

INSERT INTO `books`(`bookID`,`bookName`,`bookCounts`,`detail`)VALUES
(1,'Java',1,'从入门到放弃'),
(2,'MySQL',10,'从删库到跑路'),
(3,'Linux',5,'从进门到进牢');

创建的数据库如下图所示:

books数据库表

14.2.2、创建普通的Maven项目

(1)在IDEA中创建一个普通的Maven项目。(具体步骤参考《Maven详解》),项目名称为ssmbuild

(2)删除系统自动生成的src目录,所得到的空项目就是我们的Maven父项目,我们可以在其中创建多个子项目(即:Module)。

(3)在父项目的pom.xml文件中导入父/子工程需要的Maven依赖。

pom.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<!-- 导入Maven依赖 -->
<dependencies>
<!-- junit依赖 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!-- 数据库连接池 -->
<dependency>
<groupId>com.mchange</groupId>
<artifactId>c3p0</artifactId>
<version>0.9.5.5</version>
</dependency>
<!--Servlet-JSP -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.2</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<!--Mybatis依赖-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<!-- Spring整合MyBatis依赖 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>2.0.2</version>
</dependency>
<!--Spring依赖-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.1.9.RELEASE</version>
</dependency>
<!-- Spring-JDBC依赖 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.1.10.RELEASE</version>
</dependency>
<!--lombok依赖-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
</dependency>
</dependencies>

注:由于Maven的“约定大于配置”思想,我们的映射器配置文件*.xml写在了项目中的Java目录下,因此出现无法被导出或者无法生效的问题。该问题的解决方法是:在父项目(或子项目)的pom.xml<build>……</build>中配置resources,修改Maven约定的过滤条件,来防止我们的资源导出失败。

pom.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<!--在build中配置resources,来防止我们资源导出失败的问题-->
<build>
<resources>
<!--选择需要导出资源的路径,可以选择多个-->
<resource>
<directory>src/main/resources</directory>
<!--写入需要导出的什么类型的文件-->
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<!--不去过滤这些文件-->
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<!--不去过滤这些文件-->
<filtering>false</filtering>
</resource>
</resources>
</build>

(4)在父项目中新建一个模块(Module),并在其中创建一个普通的Maven子项目,项目名称为ssm-Demo01

(5)填写子项目名称和Maven项目GAV,点击Finish按钮完成子项目创建,等待Maven依赖包导入完毕。

14.2.3、建立项目的基本结构和配置框架

(6)在上述子项目的src/main/java目录下:

  • 新建com.atangbiji.pojo包,用于存放实体类;
  • 新建com.atangbiji.dao包,用于存放持久层代码(映射器接口及其对应的映射器配置文件);
  • 新建com.atangbiji.service包,用于存放业务层代码;
  • 新建com.atangbiji.controller包,用于存放控制器代码;
  • 新建com.atangbiji.utils包,用于存放我们封装的各种工具。

(7)在上述子项目的src/main/resources目录下:

  • 新建MyBatis的核心配置文件:mybatis-config.xml

    mybatis-config.xml文件:

    xml
    1
    2
    3
    4
    5
    6
    7
    <?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>

    </configuration>
  • 新建Spring的核心配置文件:applicationContext.xml

    applicationContext.xml文件:

    xml
    1
    2
    3
    4
    5
    6
    7
    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
    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">

    </beans>

14.2.4、配置Mybatis核心配置文件

(8)在该子项目的src/main/resources目录下,新建一个db.properties配置文件,用于配置数据库。

db.properties文件:

properties
1
2
3
4
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssmbuild?useSSL=true&useUnicode=true&characterEncoding=utf8
jdbc.username=root
jdbc.password=123456

注:

  • 数据源连接信息与使用IDEA连接数据库相同(参见《使用IDEA连接数据库》)。
  • 如果我们使用的MySQL为8.0及以上版本,那么需要在jdbc.url中增加时区的配置。
  • 整合后,数据库配置文件不再在MyBatis核心配置文件中引入,而是变成在Spring的核心配置文件中引入。

(9)在MyBatis的核心配置文件中配置类型别名(typeAliases)和映射器(mappers)。

mybatis-config.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!--将包内的实体类全部设置别名-->
<typeAliases>
<package name="com.atangbiji.pojo"/>
</typeAliases>
<!--将包内的映射器接口全部注册为映射器-->
<mappers>
<package name="com.atangbiji.dao"/>
</mappers>
</configuration>

14.2.5、创建实体类

(10)在子项目java目录的com.atangbiji.pojo包下新建一个Books类,用于实现关系型数据库和业务实体间的映射。

Books.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.atangbiji.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

//实体类(使用lombok)
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Books {
private int bookID;
private String bookName;
private int bookCounts;
private String detail;
}

注:实体类中的属性要与数据库表中的字段一一对应。

14.2.6、创建映射器接口

(11)在子项目java目录的com.atangbiji.dao包下新建一个BookMapper映射器接口,然后再向其中添加映射器接口函数。

BookMapper.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.atangbiji.dao;

import com.atangbiji.pojo.Books;
import java.util.List;

//映射器接口
public interface BookMapper {
//增加一本书
int addBook(Books book);
//根据id删除一本书
int deleteBookById(int id);
//更新一本书
int updateBook(Books books);
//根据id查询,返回一本书
Books queryBookById(int id);
//查询全部书,返回list集合
List<Books> queryAllBook();
}

注:映射器接口中的接口函数用于映射XML映射器配置文件中对应标签中的SQL语句

14.2.7、创建XML映射器配置文件

(12)在子项目java目录的com.atangbiji.dao包下新建一个映射器配置文件BookMapper.xml,并在其中使用标签实现SQL语句与映射器接口函数的映射

BookMapper.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--命名空间(绑定对应的映射器接口)-->
<mapper namespace="com.atangbiji.dao.BookMapper">
<!--增加一本书-->
<insert id="addBook" parameterType="Books">
insert into ssmbuild.books(bookName,bookCounts,detail)
values (#{bookName}, #{bookCounts}, #{detail})
</insert>

<!--根据id删除一本书-->
<delete id="deleteBookById" parameterType="int">
delete from ssmbuild.books where bookID=#{bookID}
</delete>

<!--更新一本书-->
<update id="updateBook" parameterType="Books">
update ssmbuild.books
set bookName = #{bookName},bookCounts = #{bookCounts},detail = #{detail}
where bookID = #{bookID}
</update>

<!--根据id查询,返回一本书-->
<select id="queryBookById" resultType="Books">
select * from ssmbuild.books
where bookID = #{bookID}
</select>

<!--查询全部书-->
<select id="queryAllBook" resultType="Books">
SELECT * from ssmbuild.books
</select>
</mapper>

14.3、编写Service层的接口和实现类

(13)在子项目java目录的com.atangbiji.service包下新建一个BookService业务层接口,然后再向其中添加相应的接口函数。

BookService.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.atangbiji.service;

import com.atangbiji.pojo.Books;
import java.util.List;

//业务层接口
public interface BookService {
//增加一本书
int addBook(Books book);
//根据id删除一本书
int deleteBookById(int id);
//更新一本书
int updateBook(Books books);
//根据id查询,返回一本书
Books queryBookById(int id);
//查询全部书,返回list集合
List<Books> queryAllBook();
}

(14)在子项目java目录的com.atangbiji.service包下新建一个BookServiceImpl接口实现类,用于实现业务层接口。并在其中调用DAO层的映射器接口。

BookServiceImpl.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package com.atangbiji.service;

import com.atangbiji.dao.BookMapper;
import com.atangbiji.pojo.Books;
import java.util.List;

//业务层接口实现类(调用DAO层的映射器接口)
public class BookServiceImpl implements BookService {

//组合DAO层的映射器接口
private BookMapper bookMapper;

//添加一个set接口,方便Spring管理
public void setBookMapper(BookMapper bookMapper) {
this.bookMapper = bookMapper;
}

public int addBook(Books book) {
return bookMapper.addBook(book);
}

public int deleteBookById(int id) {
return bookMapper.deleteBookById(id);
}

public int updateBook(Books books) {
return bookMapper.updateBook(books);
}

public Books queryBookById(int id) {
return bookMapper.queryBookById(id);
}

public List<Books> queryAllBook() {
return bookMapper.queryAllBook();
}
}

14.4、Spring整合MyBatis

(15)在子项目的resources目录下新建一个spring包,并在该包下新建一个spring-dao.xml配置文件,用于Spring整合Mybatis的相关的配置【参见《Spring整合MyBatis》】。

spring-dao.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<?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">

<!-- Spring整合mybatis -->
<!-- 1、关联数据库配置文件 -->
<context:property-placeholder location="classpath:db.properties"/>
<!-- 2、配置数据源【数据库连接池】(这里使用的是c3p0) -->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<!-- 配置连接池(数据源)属性 -->
<property name="driverClass" value="${jdbc.driver}"/>
<property name="jdbcUrl" value="${jdbc.url}"/>
<property name="user" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>

<!-- c3p0连接池的私有属性(部分) -->
<property name="maxPoolSize" value="30"/>
<property name="minPoolSize" value="10"/>
<!-- 关闭连接后不自动commit -->
<property name="autoCommitOnClose" value="false"/>
<!-- 获取连接超时时间 -->
<property name="checkoutTimeout" value="10000"/>
<!-- 当获取连接失败重试次数 -->
<property name="acquireRetryAttempts" value="2"/>
</bean>
<!-- 3、配置SqlSessionFactory对象 -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 注入数据库连接池(数据源) -->
<property name="dataSource" ref="dataSource"/>
<!-- 绑定MyBatis配置文件:mybatis-config.xml,关联Mybatis -->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
</bean>
<!-- 4、配置自动扫描Dao接口包,动态实现Dao接口注入到spring容器中 -->
<!--解释 :https://www.cnblogs.com/jpfss/p/7799806.html-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<!-- 注入sqlSessionFactory -->
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
<!-- 配置需要扫描的Dao接口包 -->
<property name="basePackage" value="com.atangbiji.dao"/>
</bean>
</beans>

注:

  • 这里使用的数据源(数据库连接池)是c3p0,实际项目中我们可以根据需要,选择配置DBCPDruid等其它数据源。
  • 为了能够在Spring中使用Dao接口,这里我们通过自动扫描Dao接口包的方式,动态实现Dao接口注入到spring容器中。不再通过《Spring整合MyBatis》方式1和方式2中“先手动实现Dao接口,然后再手动将Dao接口的实现类注入到IOC容器中”的方式实现Dao接口注入。

14.5、Spring整合Service层

(16)在子项目resources目录下的spring包下新建一个spring-service.xml配置文件,用于Spring整合Service层的相关的配置。

spring-service.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?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">
<!--1、扫描service相关的bean -->
<context:component-scan base-package="com.atangbiji.service"/>
<!--2、将所有的业务层的接口实现类注入到Spring容器中-->
<bean id="BookServiceImpl" class="com.atangbiji.service.BookServiceImpl">
<property name="bookMapper" ref="bookMapper"/>
</bean>
<!--3、配置事务管理器 -->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<!-- 注入数据库连接池 -->
<property name="dataSource" ref="dataSource" />
</bean>
</beans>

14.6、Spring整合SpringMVC

(17)右键选择”Add FrameworkSupport“菜单项,为该子项目添加Web Application的支持!

注:如果我们的Java Web应用是通过普通Maven项目添加Web Application支持的方式创建,那么当我们deploy(发布)项目时,可能会出现输出目录无法生成lib目录,进而无法导出依赖包的问题,此时页面显示404错误。

  • 出现该问题的原因在于:使用Maven模板创建MavenWeb项目默认生成的Web资源目录,与通过普通Maven项目添加Web Application支持的方式创建的Web项目的Web资源目录不相同。
  • 解决方法:点击File->Project Structure菜单,打开项目结构目录,我们只需在其中将该项目的Web资源目录修改正确,并手动将Maven依赖包添加到输出跟目录下即可。(详见5.1节)

(18)在web.xml文件中:①注册DispatcherServlet(中心控制器),并通过DispatcherServlet(中心控制器)拦截浏览器的所有请求;②配置SpringMVC的乱码过滤器;③配置Session过期时间。

web.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<!--1.注册DispatcherServlet-->
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--关联springMVC的总配置文件:applicationContext.xml-->
<init-param>
<param-name>contextConfigLocation</param-name>
<!--一定要注意:我们这里加载的是Spring总的配置文件!-->
<param-value>classpath:applicationContext.xml</param-value>
</init-param>
<!--启动级别:1(即:服务器启动时就启动)-->
<load-on-startup>1</load-on-startup>
</servlet>

<!--2、通过DispatcherServlet(中心控制器)拦截浏览器的所有请求-->
<!--/ :只匹配所有的请求;不会去匹配.jsp页面-->
<!--/* :匹配所有的请求,包括.jsp页面-->
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>

<!--3、配置SpringMVC的乱码过滤器-->
<filter>
<filter-name>encoding</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>encoding</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>

<!--4、配置Session过期时间(分钟)-->
<session-config>
<session-timeout>15</session-timeout>
</session-config>
</web-app>

(19)在子项目resources目录下的spring包下新建一个spring-mvc.xml配置文件,用于Spring整合Spring MVC的相关的配置。并在其中完成以下工作:

①在xml配置文件的头部引入contextMVC约束。

②开启自动扫描包,让指定包下的注解生效,由IOC容器统一管理。

③过滤静态资源,让Spring MVC不处理静态资源(如:htmlcssjsmp3mp4文件等)。

④开启SpringMVC注解驱动,自动完成DefaultAnnotationHandlerMappingAnnotationMethodHandlerAdapter实例的注入。

注:spring中一般采用@RequestMapping注解来完成映射关系。要想使@RequestMapping注解生效,必须向上下文中注册一个DefaultAnnotationHandlerMapping和一个AnnotationMethodHandlerAdapter实例。这两个实例分别在类级别和方法级别处理注解。而annotation-driven配置帮助我们自动完成上述两个实例的注入。

⑤配置视图解析器(前缀、后缀)。

spring-mvc.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<?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.xsd
http://www.springframework.org/schema/context
https://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
https://www.springframework.org/schema/mvc/spring-mvc.xsd">

<!-- 配置SpringMVC -->
<!--1、自动扫描包,让指定包下的注解生效,由IOC容器统一管理-->
<context:component-scan base-package="com.atangbiji.controller"/>
<!--2、过滤静态资源,让Spring MVC不处理静态资源(如:html、css、js、mp3、mp4文件等)-->
<mvc:default-servlet-handler />
<!--3、开启mvc注解驱动,自动完成DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter实例的注入-->
<mvc:annotation-driven />
<!--4、配置视图解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
id="internalResourceViewResolver">
<property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
<!-- 前缀 -->
<property name="prefix" value="/WEB-INF/jsp/" />
<!-- 后缀 -->
<property name="suffix" value=".jsp" />
</bean>
</beans>

14.7、整合Spring配置文件

(20)我们可以通过以下两种方式来将Spring整合的各个配置文件添加到同一个ApplicationContext下(建议两种方式同时配置)。

方式一:通过import标签将多个xml配置文件中的配置,合并为一个配置文件【参见《import(导入)》】。

applicationContext.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
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">

<import resource="classpath:/spring/spring-dao.xml"/>
<import resource="classpath:/spring/spring-service.xml"/>
<import resource="classpath:/spring/spring-mvc.xml"/>
</beans>

方式二:通过IDEA自动将多个Spring配置文件添加到同一个ApplicationContext下。具体操作步骤如下图所示:

ApplicationContext添加

此时,我们可以在Project Structure中查看ApplicationContext下的配置文件,如下图所示:

ApplicationContext关系

至此,SSM框架整合完毕!

15、第一次使用SSM框架

接下来,我们在上述整合后的SSM框架上实现具体的增删改查功能。

15.1、查询全部书籍

(1)在上述子项目的com.atangbiji.controller包下,新建一个BookController控制器类。

BookController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package com.atangbiji.controller;

import com.atangbiji.pojo.Books;
import com.atangbiji.service.BookService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import java.util.List;

//控制器(调用Service层)
@Controller
@RequestMapping("/book")
public class BookController {
//使用@Autowired和@Qualifier注解实现按名称自动装配
@Autowired
@Qualifier("BookServiceImpl")
private BookService bookService;

//查询全部的书籍,并返回到书籍展示页面
@RequestMapping("/allBook")
public String queryAllBooks(Model model){
//调用业务层接口
List<Books> books = bookService.queryAllBook();
//向模型中添加属性与值
model.addAttribute("list",books);
//返回视图位置:web-inf/jsp/allBook.jsp
return "allBook";
}
}

(2)在子项目的web/WEB-INF目录下新建一个jsp包,并在该包下新建一个allBook.jsp文件,用于显示Model中存放的数据,以及我们的正常页面。

allBook.jsp文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>书籍列表</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- 引入Bootstrap美化界面 -->
<link href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
<!--容器-->
<div class="container">
<!--标题(清除浮动)-->
<div class="row clearfix">
<!--屏幕栅格化(列12等份)-->
<div class="col-md-12 column">
<div class="page-header">
<h1>
<small>书籍列表 —— 显示所有书籍</small>
</h1>
</div>
</div>
</div>
<!--新增按钮-->
<div class="row">
<div class="col-md-4 column">
<a class="btn btn-primary" href="${pageContext.request.contextPath}/book/toAddBook">新增</a>
</div>
</div>
<!--书籍展示列表-->
<div class="row clearfix">
<div class="col-md-12 column">
<table class="table table-hover table-striped">
<!--表头-->
<thead>
<tr>
<th>书籍编号</th>
<th>书籍名字</th>
<th>书籍数量</th>
<th>书籍详情</th>
<th>操作</th>
</tr>
</thead>
<!--表格主体(从Model的list属性中获取数据并显示)-->
<tbody>
<c:forEach var="book" items="${requestScope.get('list')}">
<tr>
<td>${book.getBookID()}</td>
<td>${book.getBookName()}</td>
<td>${book.getBookCounts()}</td>
<td>${book.getDetail()}</td>
<td>
<!--修改按钮(并将修改书籍的id传给后端的Controller)-->
<a href="${pageContext.request.contextPath}/book/toUpdateBook?id=${book.getBookID()}">更改</a> |
<!--删除按钮(并将删除书籍的id传给后端的Controller)【RestFul风格】-->
<a href="${pageContext.request.contextPath}/book/deleteBook/${book.getBookID()}">删除</a>
</td>
</tr>
</c:forEach>
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>

(3)配置Tomcat服务器;deploy(发布)ssm-Demo01:war包,并为该子项目添加虚拟路径映射:/ssm。(参见《Servlet详解》)

(4)启动测试。在IDEA中启动Tomcat,在浏览器中输入http://localhost:8080/ssm/book/allBook,页面访问成功。访问结果如下:

使用SSM框架查询结果

15.2、新增书籍

(1)在上述BookController控制器中添加”跳转到新增书籍页面”和“新增书籍”功能。

BookController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
//跳转到新增书籍页面
@RequestMapping("/toAddBook")
public String toAddPage(){
return "addBook";
}
//新增书籍
@RequestMapping("/addBook")
public String addBook(Books book){
//前端传入Books数据后,再调用业务层接口
bookService.addBook(book);
//重定向到查询全部书籍的页面
return "redirect:/book/allBook";
}

(2)在子项目的jsp包下新建一个addBook.jsp文件,用于显示新增书籍页面。

addBook.jsp文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>新增书籍</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- 引入Bootstrap美化界面 -->
<link href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
<!--容器-->
<div class="container">
<!--标题-->
<div class="row clearfix">
<div class="col-md-12 column">
<div class="page-header">
<h1>
<small>新增书籍</small>
</h1>
</div>
</div>
</div>
<!--新增书籍信息表单-->
<form action="${pageContext.request.contextPath}/book/addBook" method="post">
<div class="form-group">
<label>书籍名称</label>
<input type="text" class="form-control" name="bookName" required>
</div>
<div class="form-group">
<label>书籍数量</label>
<input type="text" class="form-control" name="bookCounts" required>
</div>
<div class="form-group">
<label>书籍详情</label>
<input type="text" class="form-control" name="detail" required>
</div>
<!--添加按钮-->
<button type="submit" class="btn btn-default">添加</button>
</form>
</div>
</body>
</html>

注:前端input标签的name属性的值必须与实体类的属性保存完全一致!

(3)启动测试。

  • 在IDEA中重新启动Tomcat,在浏览器中输入http://localhost:8080/ssm/book/allBook,进入查询全部书籍的页面;

    使用SSM框架点击添加按钮
  • 点击“新增”按钮,浏览器跳转至“新增书籍页面”。填写新增书籍的信息:

    使用SSM框架添加书籍
  • 点击”添加”按钮,页面重定向到“查询全部书籍”的页面。如下图所示:

    使用SSM框架添加书籍成功

此时,数据库中也新增了一条记录。如下图所示:

使用SSM框架添加书籍数据库变化

15.3、修改书籍

(1)在上述BookController控制器中添加”跳转到修改书籍页面”和“修改书籍信息”功能。

BookController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//跳转到修改书籍页面
@RequestMapping("/toUpdateBook")
public String toUpdatePage(int id,Model model){
//接受前端传入的待修改书籍的id后,再调用业务层接口
Books books = bookService.queryBookById(id);
//向模型中添加属性与值(待修改书籍的信息)
model.addAttribute("bookInfo",books);
//返回视图位置:web-inf/jsp/updateBook.jsp
return "updateBook";
}
//修改书籍信息
@RequestMapping("/updateBook")
public String updateBook(Books book){
//前端传入Books数据后,再调用业务层接口
bookService.updateBook(book);
//重定向到查询全部书籍的页面
return "redirect:/book/allBook";
}

(2)在子项目的jsp包下新建一个updateBook.jsp文件,用于显示修改书籍页面。

updateBook.jsp文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>修改书籍</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- 引入Bootstrap美化界面 -->
<link href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
<!--容器-->
<div class="container">
<!--标题-->
<div class="row clearfix">
<div class="col-md-12 column">
<div class="page-header">
<h1>
<small>修改书籍</small>
</h1>
</div>
</div>
</div>
<!--修改书籍信息表单-->
<form action="${pageContext.request.contextPath}/book/updateBook" method="post">
<!--注:修改书籍信息需要传入bookID,否则数据库修改会失败-->
<input type="hidden" name="bookID" value="${bookInfo.bookID}">
<div class="form-group">
<label>书籍名称</label>
<input type="text" class="form-control" name="bookName" value="${bookInfo.bookName}" required>
</div>
<div class="form-group">
<label>书籍数量</label>
<input type="text" class="form-control" name="bookCounts" value="${bookInfo.bookCounts}" required>
</div>
<div class="form-group">
<label>书籍详情</label>
<input type="text" class="form-control" name="detail" value="${bookInfo.detail}" required>
</div>
<!--修改按钮-->
<button type="submit" class="btn btn-default">修改</button>
</form>
</div>
</body>
</html>

注:修改书籍信息需要传入bookID,否则数据库修改会失败。

(3)启动测试。

  • 在IDEA中重新启动Tomcat,在浏览器中输入http://localhost:8080/ssm/book/allBook,进入查询全部书籍的页面;

  • 选中C++书籍,点击“更改”按钮,浏览器跳转至“修改书籍页面”。将C++修改为:C语言,书籍数量修改为:20。

    使用SSM框架修改书籍信息
  • 点击”修改”按钮,页面重定向到“查询全部书籍”的页面。数据修改成功!如下图所示:

    使用SSM框架修改书籍信息成功
  • 此时,数据库中的数据也修改成功。如下图所示:

    使用SSM框架修改书籍信息成功数据库

15.4、删除书籍

(1)在上述BookController控制器中添加“删除书籍”功能。

BookController.java文件:

java
1
2
3
4
5
6
7
8
//删除书籍【RestFul风格】
@RequestMapping("/deleteBook/{bookId}")
public String deleteBook(@PathVariable("bookId") int id){
//接受前端传入的待删除书籍的id后,再调用业务层接口
bookService.deleteBookById(id);
//重定向到查询全部书籍的页面
return "redirect:/book/allBook";
}

(2)启动测试。

  • 在IDEA中重新启动Tomcat,在浏览器中输入http://localhost:8080/ssm/book/allBook,进入查询全部书籍的页面;

    使用SSM框架删除书籍前
  • 选中Linux书籍,点击“删除”按钮。数据删除成功!如下图所示:

    使用SSM框架删除书籍后
  • 此时,数据库中的数据也删除成功。如下图所示:

    使用SSM框架删除数据库数据成功

15.5、小结及展望

到目前为止,这个SSM项目整合已经完全的OK了,可以直接运行进行测试!这个示例十分的重要,大家需要保证,不看任何东西,自己也可以完整的实现出来!

此时项目结构如下图所示:

项目结构1

项目结构2

这个是我们的第一个SSM整合案例,一定要烂熟于心!

SSM框架的重要程度是不言而喻的,学到这里,大家已经可以进行基本网站的单独开发。但是这只是增删改查的基本操作。可以说学到这里,大家才算是真正的步入了后台开发的门。也就是能找一个后台相关工作的底线。

或许很多人,工作就做这些事情,但是对于个人的提高来说,还远远不够!

16、Ajax

16.1、简介

  • AJAX = Asynchronous JavaScript and XML(异步的 JavaScript 和 XML)。

  • AJAX 是一种在无需重新加载整个网页的情况下,能够更新部分网页的技术。

  • Ajax 不是一种新的编程语言,而是一种用于创建更好更快以及交互性更强的Web应用程序的技术。

  • 在2005 年,Google通过其Google Suggest使AJAX变得流行起来。Google Suggest能够自动帮你完成搜索单词。

  • Google Suggest使用AJAX创造出动态性极强的web界面:当您在谷歌的搜索框输入关键字时,JavaScript会把这些字符发送到服务器,然后服务器会返回一个搜索建议的列表。

  • 就像在百度的搜索框中输入关键词的过程中,页面在不刷新的情况下也能返回搜索建议列表一样!

    百度ajax
  • 传统的网页(即不用ajax技术的网页),想要更新内容或者提交一个表单,都需要重新加载整个网页(请求转发或重定向)。

  • 使用ajax技术的网页,通过在后台服务器进行少量的数据交换,就可以实现异步局部更新。

  • 使用Ajax,用户可以创建接近本地桌面应用的直接、高可用、更丰富、更动态的Web用户界面。

16.2、jQuery.ajax

我们这里不去讲解纯JS原生实现Ajax,而是直接使用jquery提供的Ajax。这样方便学习和使用,避免重复造轮子,有兴趣的同学可以去了解下JS原生XMLHttpRequest

Ajax的核心是XMLHttpRequest对象(XHR)。XHR为向服务器发送请求和解析服务器响应提供了接口,能够以异步方式从服务器获取新数据。

16.2.1、jQuery.ajax用法(重点)

  • 通过jQuery Ajax方法,我们能够使用HTTP GetHTTP Post从远程服务器上请求文本、HTMLXMLJSON, 我们同时能够把这些外部数据直接载入网页的被选元素中。

  • jQuery不是生产者,而是大自然搬运工。

  • jQuery Ajax的本质就是XMLHttpRequest,只是jQuery对其进行了封装,方便调用!

  • jQuery提供多个与Ajax有关的方法。最常用的就是$.ajax()方法,其语法格式为:

    Javascript
    1
    2
    3
    $.ajax({
    参数列表//各参数之间用逗号【,】分隔
    })

    主要参数:

    • url:请求地址。

    • type:请求方式。GETPOST(1.9.0之后用method

    • headers:请求头。

    • data:要发送的数据(键值对)。

      注:前后端以“键值对”的形式进行数据传递,其中:键的名称需要与Controller中传入的形参保持一致。

    • contentType:即将发送信息至服务器的内容编码类型(默认: application/x-www-form-urlencoded; charset=UTF-8)。

    • async:是否异步。

    • timeout:设置请求超时时间(毫秒)。

    • beforeSend:发送请求前执行的函数(全局)。

    • complete:请求完成之后执行的回调函数(全局)。

    • success:请求成功之后执行的回调函数(全局)。

    • error:请求失败之后执行的回调函数(全局)。

    • accepts:通过请求头发送给服务器,告诉服务器当前客户端可接受的数据类型。

    • dataType:将服务器端返回的数据转换成指定类型。

      • "xml":将服务器端返回的内容转换成xml格式;
      • "text":将服务器端返回的内容转换成普通文本格式;
      • "html":将服务器端返回的内容转换成普通文本格式,在插入DOM中时,如果包含JavaScript标签,则会尝试去执行;
      • "script":尝试将返回值当作JavaScript去执行,然后再将服务器端返回的内容转换成普通文本格式;
      • "json"将服务器端返回的内容转换成相应的json对象;
      • "jsonp"JSONP格式使用JSONP形式调用函数时,如"myurl?callback=?"jQuery将自动替换?为正确的函数名,以执行回调函数。

16.2.2、搭建测试环境

具体实现步骤如下:

(1)在父项目中新建一个模块(Module),并在其中创建一个普通的Maven子项目,项目名称为springMVC-05-ajax

(2)右键选择”Add FrameworkSupport“菜单项,为该子项目添加Web Application的支持!

注:如果我们的Java Web应用是通过普通Maven项目添加Web Application支持的方式创建,那么当我们deploy(发布)项目时,可能会出现输出目录无法生成lib目录,进而无法导出依赖包的问题,此时页面显示404错误。

  • 出现该问题的原因在于:使用Maven模板创建MavenWeb项目默认生成的Web资源目录,与通过普通Maven项目添加Web Application支持的方式创建的Web项目的Web资源目录不相同。
  • 解决方法:点击File->Project Structure菜单,打开项目结构目录,我们只需在其中将该项目的Web资源目录修改正确,并手动将Maven依赖包添加到输出跟目录下即可。(详见5.1节)

(3)先确认在父项目的pom.xml文件中导入父/子工程所需要的SpringMVC相关的依赖。

(4)同样地,在web.xml文件中:

  • 注册DispatcherServlet(中心控制器),并通过DispatcherServlet(中心控制器)拦截浏览器的所有请求。
  • 配置SpringMVC的乱码过滤器。

(5)同样地,在该子项目的resources目录下新建一个SpringMVC的配置文件,配置文件的名称为:applicationContext.xml

并在其中完成以下工作:

①在xml配置文件的头部引入contextMVC约束。

②开启自动扫描包,让指定包下的注解生效,由IOC容器统一管理。

③过滤静态资源,让Spring MVC不处理静态资源(如:htmlcssjsmp3mp4文件等)。

④开启SpringMVC注解驱动,自动完成DefaultAnnotationHandlerMappingAnnotationMethodHandlerAdapter实例的注入。

注:spring中一般采用@RequestMapping注解来完成映射关系。要想使@RequestMapping注解生效,必须向上下文中注册一个DefaultAnnotationHandlerMapping和一个AnnotationMethodHandlerAdapter实例。这两个实例分别在类级别和方法级别处理注解。而annotation-driven配置帮助我们自动完成上述两个实例的注入。

⑤配置视图解析器(前缀、后缀)。

(6)在java目录下新建com.atangbiji.controller包,用于存放控制器代码。并在该包下新建一个AjaxController控制器类。

AjaxController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

//控制器
@Controller
@RequestMapping("/ajax")
public class AjaxController {

@RequestMapping("/test")
public String test(){
//返回视图位置:web-inf/jsp/ajaxTest.jsp
return "ajaxTest";
}

@RequestMapping("/a1")
@ResponseBody
public void a1(String name, HttpServletResponse response) throws IOException {
//设置响应的编码集
response.setCharacterEncoding("utf-8");

if (name.equals("")){
response.getWriter().print("前端通过Ajax传入的名字为空!");
}else {
response.getWriter().print("前端通过Ajax传入的名字为:"+ name + "(非空)");
}
}
}

(7)导入jQuery

方式一:使用在线的CDN

Javascript
1
<script src="https://code.jquery.com/jquery-3.6.3.min.js"></script>

方式二:下载后导入使用。

  • jQuery官网下载jquery-3.6.3.js库。
  • 在子项目的web目录下新建一个static/js目录,并通过右键菜单将static标记为,然后将下载好的jquery-3.6.3.js文件复制到该目录下。
  • ajaxTest.jsp文件的head标签中引入本地的jQuery库。
Javascript
1
<script src="${pageContext.request.contextPath}/static/js/jquery-3.6.3.js"></script>

注:我们这里使用方式二导入jquery

(8)在子项目的web/WEB-INF目录下新建一个jsp包,并在该包下新建一个ajaxTest.jsp文件,用于显示Model中存放的数据,以及我们的正常页面。

ajaxTest.jsp文件:

html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Ajax测试</title>
<%--导入jQuery--%>
<%--<script src="https://code.jquery.com/jquery-3.6.3.min.js"></script>--%>
<script src="${pageContext.request.contextPath}/static/js/jquery-3.6.3.js"></script>
<script>
function test1(){
$.post({
url:"${pageContext.request.contextPath}/ajax/a1",
data:{'name':$("#txtName").val()},
success:function (data,status) {
alert("后台响应的数据为:" + data + ";状态为:" + status);
}
});
}
</script>
</head>
<body>
<%--onblur:当失去焦点时,触发事件(向服务器发送一个请求)--%>
用户名:<input type="text" id="txtName" onblur="test1()"/>
</body>
</html>

(9)配置Tomcat服务器;deploy(发布)springMVC-05-ajax:war包,并为该子项目添加虚拟路径映射:/mvc。(参见《Servlet详解》)

(10)启动测试。在IDEA中启动Tomcat,在浏览器中输入http://localhost:8080/mvc/ajax/test,页面访问成功。

  • 先点击输入框,再点击其它区域。访问结果如下:

    ajax不输入
  • 先点击输入框,输入admin,再点击其它区域。访问结果如下:

    ajax有输入

注:类似于百度的搜索框,当我们在输入框中输入用户名的过程中,页面在不刷新的情况下也能异步向后台发送请求,并获取后台的响应!

16.2.3、Ajax异步加载json数据

在上述子项目的基础上:

(1)在java目录下新建一个com.atangbiji.pojo包,并在该包下新建一个User实体类。

User.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.atangbiji.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

//实体类(需要导入lombok依赖)
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String name;
private int age;
private String sex;
}

(2)在该子项目的AjaxController控制器中添加“返回json数据”的功能。

AjaxController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package com.atangbiji.controller;

import com.atangbiji.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.ArrayList;
import java.util.List;

//控制器
@Controller
@RequestMapping("/ajax")
public class AjaxController {
@RequestMapping("/test2")
public String test2(){
//返回视图位置:web-inf/jsp/ajaxTestJSON.jsp
return "ajaxTestJSON";
}
@RequestMapping("/getUsers")
@ResponseBody
public List<User> getUsers(){
//创建一个数组集合
ArrayList<User> userList = new ArrayList<User>();
//创建多个User对象
User user1 = new User("阿汤", 18, "男");
User user2 = new User("张三", 3, "男");
User user3 = new User("李四", 18, "男");
//把多个User对象添加到数组集合
userList.add(user1);
userList.add(user2);
userList.add(user3);
//@ResponseBody注解会自动将userList转成json格式返回
return userList;
}
}

注:

  • @ResponseBody注解会自动将userList转成json格式返回。
  • 我们也可以使用JacksonFastJson返回json数据。

(3)在子项目的jsp包下新建一个ajaxTestJSON.jsp文件,并在其中使用Ajax异步获取后端的json数据。

ajaxTestJSON.jsp文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Ajax异步加载json数据</title>
<%--导入jQuery--%>
<%--<script src="https://code.jquery.com/jquery-3.6.3.min.js"></script>--%>
<script src="${pageContext.request.contextPath}/static/js/jquery-3.6.3.js"></script>
<script>
$(function () {
$("#btn").click(function () {
<%--使用Ajax异步获取后端的json数据--%>
$.post("${pageContext.request.contextPath}/ajax/getUsers",function (data) {
console.log(data);
var html="";
for (var i = 0; i < data.length ; i++) {
html+= "<tr>" +
"<td>" + data[i].name + "</td>" +
"<td>" + data[i].age + "</td>" +
"<td>" + data[i].sex + "</td>" +
"</tr>"
};
$("#content").html(html);
});
})
})
</script>
</head>
<body>
<input type="button" id="btn" value="获取数据"/>
<%--在表格中显示后端返回的json数据--%>
<table width="80%" align="center">
<tr>
<td>姓名</td>
<td>年龄</td>
<td>性别</td>
</tr>
<tbody id="content">
</tbody>
</table>
</body>
</html>

(4)启动测试。在IDEA中重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/ajax/test2,页面访问成功。访问结果如下:

Ajax异步加载json数据

16.2.4、Ajax实现输入提示效果

在上述子项目的基础上:

(1)在该子项目的AjaxController控制器中添加“用户名和密码校验”的功能。

AjaxController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

//控制器
@Controller
@RequestMapping("/ajax")
public class AjaxController {
@RequestMapping("/test3")
public String test3(){
//返回视图位置:web-inf/jsp/login.jsp
return "login";
}

@RequestMapping("/checkNameAndPwd")
@ResponseBody
public String checkNameAndPwd(String name,String pwd){
String msg = "";
//模拟数据库中存在数据
if (name!=null){
if ("admin".equals(name)){
msg = "OK";
}else {
msg = "用户名输入错误";
}
}
if (pwd!=null){
if ("123456".equals(pwd)){
msg = "OK";
}else {
msg = "密码输入有误";
}
}
//@ResponseBody注解会自动将msg转成json格式返回
return msg;
}
}

注:记得在SpringMVC配置文件中统一处理字符串乱码问题。

applicationContext.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!--统一解决字符串乱码问题-->
<mvc:annotation-driven>
<mvc:message-converters register-defaults="true">
<bean class="org.springframework.http.converter.StringHttpMessageConverter">
<constructor-arg value="UTF-8"/>
</bean>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper">
<bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
<property name="failOnEmptyBeans" value="false"/>
</bean>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>

(2)在子项目的jsp包下新建一个login.jsp文件,并在其中实现登录页面。

login.jsp文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Ajax实现输入提示效果</title>
<%--导入jQuery--%>
<%--<script src="https://code.jquery.com/jquery-3.6.3.min.js"></script>--%>
<script src="${pageContext.request.contextPath}/static/js/jquery-3.6.3.js"></script>
<script>
function a1(){
$.post({
url:"${pageContext.request.contextPath}/ajax/checkNameAndPwd",
data:{'name':$("#name").val()},
success:function (data) {
if (data.toString()=='OK'){
$("#userInfo").css("color","green");
}else {
$("#userInfo").css("color","red");
}
$("#userInfo").html(data);
}
});
}
function a2(){
$.post({
url:"${pageContext.request.contextPath}/ajax/checkNameAndPwd",
data:{'pwd':$("#pwd").val()},
success:function (data) {
if (data.toString()=='OK'){
$("#pwdInfo").css("color","green");
}else {
$("#pwdInfo").css("color","red");
}
$("#pwdInfo").html(data);
}
});
}
</script>
</head>
<body>
<p>
<%--onblur:当失去焦点时,触发事件(向服务器发送一个请求)--%>
用户名:<input type="text" id="name" onblur="a1()"/>
<%--提示信息--%>
<span id="userInfo"></span>
</p>
<p>
<%--onblur:当失去焦点时,触发事件(向服务器发送一个请求)--%>
密码:<input type="text" id="pwd" onblur="a2()"/>
<%--提示信息--%>
<span id="pwdInfo"></span>
</p>
</body>
</html>

(3)启动测试。在IDEA中重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/ajax/test3,页面访问成功。测试输入框的提示效果,访问结果如下:

Ajax实现输入提示效果

17、拦截器

17.1、概述

SpringMVC的处理器、拦截器的工作原理类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现特定的功能。

过滤器与拦截器的区别:拦截器是AOP思想的具体应用。

过滤器(Filter):

  • servlet规范中的一部分,在web.xml文件中配置,任何java web工程都可以使用。
  • url-pattern标签中配置了/*之后,可以对所有要访问的资源进行拦截。

拦截器(Interceptor):

  • 拦截器是SpringMVC框架自己的,在SpringMVC的配置文件中配置,只有使用了SpringMVC框架的工程才能使用。
  • 拦截器只会拦截访问控制器的方法, 如果访问的是jsp/html/css/image/js是不会进行拦截的。

17.2、自定义拦截器

若想要自定义拦截器,则必须实现HandlerInterceptor接口

具体实现步骤如下:

(1)在父项目中新建一个模块(Module),并在其中创建一个普通的Maven子项目,项目名称为springMVC-06-interceptor

(2)右键选择”Add FrameworkSupport“菜单项,为该子项目添加Web Application的支持!

注:如果我们的Java Web应用是通过普通Maven项目添加Web Application支持的方式创建,那么当我们deploy(发布)项目时,可能会出现输出目录无法生成lib目录,进而无法导出依赖包的问题,此时页面显示404错误。

  • 出现该问题的原因在于:使用Maven模板创建MavenWeb项目默认生成的Web资源目录,与通过普通Maven项目添加Web Application支持的方式创建的Web项目的Web资源目录不相同。
  • 解决方法:点击File->Project Structure菜单,打开项目结构目录,我们只需在其中将该项目的Web资源目录修改正确,并手动将Maven依赖包添加到输出跟目录下即可。(详见5.1节)

(3)先确认在父项目的pom.xml文件中导入父/子工程所需要的SpringMVC相关的依赖。

(4)同样地,在web.xml文件中:

  • 注册DispatcherServlet(中心控制器),并通过DispatcherServlet(中心控制器)拦截浏览器的所有请求。
  • 配置SpringMVC的乱码过滤器。

(5)同样地,在该子项目的resources目录下新建一个SpringMVC的配置文件,配置文件的名称为:applicationContext.xml

并在其中完成以下工作:

①在xml配置文件的头部引入contextMVC约束。

②开启自动扫描包,让指定包下的注解生效,由IOC容器统一管理。

③过滤静态资源,让Spring MVC不处理静态资源(如:htmlcssjsmp3mp4文件等)。

④开启SpringMVC注解驱动,自动完成DefaultAnnotationHandlerMappingAnnotationMethodHandlerAdapter实例的注入。

注:spring中一般采用@RequestMapping注解来完成映射关系。要想使@RequestMapping注解生效,必须向上下文中注册一个DefaultAnnotationHandlerMapping和一个AnnotationMethodHandlerAdapter实例。这两个实例分别在类级别和方法级别处理注解。而annotation-driven配置帮助我们自动完成上述两个实例的注入。

⑤配置视图解析器(前缀、后缀)。

(6)在java目录下新建com.atangbiji.interceptor包,用于存放拦截器代码。在该包下新建一个MyInterceptor拦截器类,并在其中重写HandlerInterceptor接口的方法。

MyInterceptor.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package com.atangbiji.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

//拦截器
public class MyInterceptor implements HandlerInterceptor {

//在请求处理的方法之前执行(若返回true,则继续执行下一个拦截器;若返回false,则不再执行下一个拦截器。)
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("------------处理前------------");
return true;//若返回true,则继续执行下一个拦截器
}

//在请求处理方法执行之后执行
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("------------处理后------------");
}

//在dispatcherServlet处理后执行(做清理工作)
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("------------清理------------");
}
}

注:

  • preHandle在请求处理的方法之前执行。若该方法返回true,则执行下一个拦截器;若返回false,则不再执行下一个拦截器。
  • 我们一般在重写的preHandle方法中实现拦截功能,在postHandle方法中实现拦截日志的功能。

(7)在springMVC的配置文件中配置拦截器。

applicationContext.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
<!--配置拦截器-->
<mvc:interceptors>
<mvc:interceptor>
<!--/** :包括路径及其子路径-->
<!--/admin/* :拦截的是/admin/add等等这种, /admin/add/user不会被拦截-->
<!--/admin/** :拦截的是/admin/下的所有-->
<mvc:mapping path="/**"/>
<!--bean配置的就是拦截器-->
<bean class="com.atangbiji.interceptor.MyInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>

(8)在java目录下新建com.atangbiji.controller包,用于存放控制器代码。并在该包下新建一个InterceptorController控制器类。

InterceptorController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

//控制器
@Controller
@RequestMapping("/interceptor")
public class InterceptorController {

@RequestMapping("/test")
@ResponseBody
public String testFunction() {
System.out.println("执行控制器(Controller)中的方法!");
return "控制器中的方法执行成功!";
}
}

(9)配置Tomcat服务器;deploy(发布)springMVC-06-interceptor:war包,并为该子项目添加虚拟路径映射:/mvc。(参见《Servlet详解》)

(10)启动测试。在IDEA中启动Tomcat,在浏览器中输入http://localhost:8080/mvc/interceptor/test,页面访问成功。

  • 浏览器前端输出结果如下:
拦截器返回true前端
  • 此时,服务器后台输出结果如下:
拦截器返回true后端

(11)若将拦截器preHandle方法的返回值改为false。即:

MyInterceptor.java文件:

java
1
2
3
4
5
//在请求处理的方法之前执行(若返回true,则继续执行下一个拦截器;若返回false,则不再执行下一个拦截器。)
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("------------处理前------------");
return false;//若返回false,则不再执行下一个拦截器
}

启动测试。在IDEA中重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/interceptor/test,页面访问成功。

  • 浏览器前端输出结果如下:

    拦截器返回false前端
  • 此时,服务器后台输出结果如下:

    拦截器返回false后端

17.3、验证用户是否已经登录

在上述子项目的基础上:

(1)在子项目的web/WEB-INF目录下新建一个jsp包,并在该包下新建一个login.jsp文件,用于用户登录页面。

login.jsp文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>登录页面</title>
</head>
<body>
<form action="${pageContext.request.contextPath}/login/goLogin" method="post">
用户名:<input type="text" name="username"> <br>
密码:<input type="password" name="pwd"> <br>
<input type="submit" value="提交">
</form>
</body>
</html>

注:WEB-INF目录下的页面或资源,无法直接访问,只能通过ControllerServlet进行访问。

(2)在jsp包下新建一个success.jsp文件,作为登录成功页面。

success.jsp文件:

1
2
3
4
5
6
7
8
9
10
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>welcome</title>
</head>
<body>
<h1>欢迎进入首页</h1>
<a href="${pageContext.request.contextPath}/login/logout">注销</a>
</body>
</html>

(3)在com.atangbiji.controller包下新建一个LoginController控制器类,用于处理用户的登录请求。

LoginController文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpSession;

//控制器
@Controller
@RequestMapping("/login")
public class LoginController {

@RequestMapping("/test")
public String test(){
//返回视图位置:web-inf/jsp/success.jsp
return "success";
}

//提交登录按钮
@RequestMapping("/goLogin")
public String login(HttpSession session, String username, String pwd) {
//通过Session存储用户的身份信息
session.setAttribute("username", username);
session.setAttribute("password", pwd);
//重定向到:/login/test
return "redirect:/login/test";
}

//退出登陆
@RequestMapping("/logout")
public String logout(HttpSession session) {
//让session过期
session.invalidate();
//返回视图位置:web-inf/jsp/login.jsp
return "login";
}
}

(4)在com.atangbiji.interceptor包下新建一个LoginInterceptor拦截器类,用于拦截所有的请求,判断用户是否登录。若session中登录信息正确,则放行;否则,则跳转到登录页面。

LoginInterceptor.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
package com.atangbiji.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;

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

//登录拦截器
public class LoginInterceptor implements HandlerInterceptor {
//在请求处理的方法之前执行(若返回true,则继续执行下一个拦截器;若返回false,则不再执行下一个拦截器。)
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

//如果是登陆页面,那么就放行
if (request.getRequestURI().contains("goLogin")){
return true;
}

//如果不是登陆页面,那么判断用户是否登录
HttpSession session = request.getSession();
String username = (String) session.getAttribute("username");
String password = (String) session.getAttribute("password");

if ("atang".equals(username) && "123456".equals(password)){
//若session中登录信息正确,则放行。
return true;
}else {
//否则,则跳转到登录页面。
request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);
return false;
}
}
}

(5)在Springmvc的配置文件中注册拦截器。

applicationContext.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
<!--配置拦截器-->
<mvc:interceptors>
<mvc:interceptor>
<!--/** :包括路径及其子路径-->
<!--/admin/* :拦截的是/admin/add等等这种, /admin/add/user不会被拦截-->
<!--/admin/** :拦截的是/admin/下的所有-->
<mvc:mapping path="/**"/>
<!--bean配置的就是拦截器-->
<bean class="com.atangbiji.interceptor.LoginInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>

(6)启动测试。

  • 在IDEA中重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/login/test,请求被拦截,由于用户未登录,页面跳转到登录页面。如下图所示:
拦截器拦截请求
  • 只有当输入正确的用户名(atang)和密码(123456)后,才能登录,并成功进入首页。如下图所示:
拦截器放行

注:若点击“注销”按钮或关闭浏览器,则又需要重新登录才能成功进入首页。

18、文件上传和下载

18.1、文件上传

18.1.1、准备工作

文件上传是项目开发中最常见的功能之一,springMVC可以很好的支持文件上传,但是SpringMVC上下文中默认没有装配MultipartResolver,因此默认情况下其不能处理文件上传工作。如果想使用Spring的文件上传功能,则需要在上下文中配置MultipartResolver

前端表单要求:为了能上传文件,必须将表单的method设置为POST,并将enctype设置为multipart/form-data。只有在这样的情况下,浏览器才会把用户选择的文件以二进制数据发送给服务器。

附:对表单中的enctype属性的详细说明

  • application/x-www=form-urlencoded:默认方式,只处理表单域中的value属性值,采用这种编码方式的表单会将表单域中的值处理成URL编码方式。
  • multipart/form-data:这种编码方式会以二进制流的方式来处理表单数据,这种编码方式会把文件域指定文件的内容也封装到请求参数中,不会对字符编码。
  • text/plain:除了把空格转换为 “+” 号外,其他字符都不做编码处理,这种方式适用直接通过表单发送邮件。
html
1
2
3
4
<form action="" enctype="multipart/form-data" method="post">
<input type="file" name="file"/>
<input type="submit">
</form>

一旦设置了enctypemultipart/form-data,浏览器即会采用二进制流的方式来处理表单数据,而对于文件上传的处理则涉及在服务器端解析原始的HTTP响应。在2003年,Apache Software Foundation发布了开源的Commons FileUpload组件,其很快成为Servlet/JSP程序员上传文件的最佳选择。

  • Servlet3.0规范已经提供方法来处理文件上传,但这种上传需要在Servlet中完成。
  • Spring MVC则提供了更简单的封装。
  • Spring MVC为文件上传提供了直接的支持,这种支持是用即插即用的MultipartResolver实现的。
  • Spring MVC使用Apache Commons FileUpload技术实现了一个MultipartResolver实现类:CommonsMultipartResolver

因此,SpringMVC的文件上传还需要依赖Apache Commons FileUpload的组件。

18.1.2、具体实现

具体实现步骤如下:

(1)在父项目中新建一个模块(Module),并在其中创建一个普通的Maven子项目,项目名称为springMVC-07-file

(2)右键选择”Add FrameworkSupport“菜单项,为该子项目添加Web Application的支持!

注:如果我们的Java Web应用是通过普通Maven项目添加Web Application支持的方式创建,那么当我们deploy(发布)项目时,可能会出现输出目录无法生成lib目录,进而无法导出依赖包的问题,此时页面显示404错误。

  • 出现该问题的原因在于:使用Maven模板创建MavenWeb项目默认生成的Web资源目录,与通过普通Maven项目添加Web Application支持的方式创建的Web项目的Web资源目录不相同。
  • 解决方法:点击File->Project Structure菜单,打开项目结构目录,我们只需在其中将该项目的Web资源目录修改正确,并手动将Maven依赖包添加到输出跟目录下即可。(详见5.1节)

(3)先确认在父项目的pom.xml文件中导入父/子工程所需要的SpringMVC相关的依赖。此外,我们需要导入commons-fileupload所依赖的jar包。

pom.xml文件:

xml
1
2
3
4
5
6
7
8
9
10
11
12
<!--文件上传-->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.3</version>
</dependency>
<!--导入高版本的servlet-api-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
</dependency>

注:

  • 为了确保项目发布时,jackson的依赖包发布成功,我们需要再次手动将Maven依赖包添加到输出跟目录下。(详见5.1节)
  • 记得注掉低版本的servlet-api依赖。

(4)同样地,在web.xml文件中:

  • 注册DispatcherServlet(中心控制器),并通过DispatcherServlet(中心控制器)拦截浏览器的所有请求。
  • 配置SpringMVC的乱码过滤器。

(5)同样地,在该子项目的resources目录下新建一个SpringMVC的配置文件,配置文件的名称为:applicationContext.xml

并在其中完成以下工作:

①在xml配置文件的头部引入contextMVC约束。

②开启自动扫描包,让指定包下的注解生效,由IOC容器统一管理。

③过滤静态资源,让Spring MVC不处理静态资源(如:htmlcssjsmp3mp4文件等)。

④开启SpringMVC注解驱动,自动完成DefaultAnnotationHandlerMappingAnnotationMethodHandlerAdapter实例的注入。

注:spring中一般采用@RequestMapping注解来完成映射关系。要想使@RequestMapping注解生效,必须向上下文中注册一个DefaultAnnotationHandlerMapping和一个AnnotationMethodHandlerAdapter实例。这两个实例分别在类级别和方法级别处理注解。而annotation-driven配置帮助我们自动完成上述两个实例的注入。

⑤配置视图解析器(前缀、后缀)。

(6)在SpringMVC的配置文件中配置beanmultipartResolver

applicationContext.xml文件:

xml
1
2
3
4
5
6
7
8
<!--文件上传配置-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- 请求的编码格式,必须和jSP的pageEncoding属性一致,以便正确读取表单的内容,默认为ISO-8859-1 -->
<property name="defaultEncoding" value="utf-8"/>
<!-- 上传文件大小上限,单位为字节(10485760=10M) -->
<property name="maxUploadSize" value="10485760"/>
<property name="maxInMemorySize" value="40960"/>
</bean>

注意:这个bena的id必须为:multipartResolver ,否则上传文件会报400的错误!在这里栽过坑,教训!

(7)在java目录下新建com.atangbiji.controller包,用于存放控制器代码。并在该包下新建一个FileController控制器类。

FileController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.multipart.commons.CommonsMultipartFile;
import javax.servlet.http.HttpServletRequest;
import java.io.*;

@Controller
@RequestMapping("/file")
public class FileController {

@RequestMapping("/test")
public String test(){
//返回视图位置:web-inf/jsp/upload.jsp
return "upload";
}

//@RequestParam("file") 将name=file控件得到的文件封装成CommonsMultipartFile 对象
//批量上传CommonsMultipartFile则为数组即可
//通过@RequestMaping注解的produces属性解决json字符串乱码问题
@RequestMapping(value = "/upload",produces = "application/json;charset=utf-8")
@ResponseBody
public String fileUpload(@RequestParam("file") CommonsMultipartFile file , HttpServletRequest request) throws IOException {

//获取文件名 : file.getOriginalFilename();
String uploadFileName = file.getOriginalFilename();

//如果文件名为空,直接回到上传页面!
if ("".equals(uploadFileName)){
return "文件名为空,请返回上传页面重新选择上传文件!";
}
System.out.println("上传文件名 : "+uploadFileName);

//上传路径保存设置
String path = request.getServletContext().getRealPath("/upload");
//如果路径不存在,创建一个
File realPath = new File(path);
if (!realPath.exists()){
realPath.mkdir();
}
System.out.println("上传文件保存地址:"+realPath);

InputStream is = file.getInputStream(); //文件输入流
OutputStream os = new FileOutputStream(new File(realPath,uploadFileName)); //文件输出流

//读取写出
int len=0;
byte[] buffer = new byte[1024];
while ((len=is.read(buffer))!=-1){
os.write(buffer,0,len);
os.flush();
}
os.close();
is.close();
return "文件上传成功!";
}
}

附:CommonsMultipartFile 的常用方法

  • String getOriginalFilename():获取上传文件的原名。
  • InputStream getInputStream():获取文件流。
  • void transferTo(File dest):将上传文件保存到一个目录文件中。

(8)在子项目的web/WEB-INF目录下新建一个jsp包,并在该包下新建一个upload.jsp文件,用于文件上传页面。

upload.jsp文件:

1
2
3
4
5
6
7
8
9
10
11
12
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>文件上传</title>
</head>
<body>
<form action="${pageContext.request.contextPath}/file/upload" enctype="multipart/form-data" method="post">
<input type="file" name="file"/>
<input type="submit" value="upload">
</form>
</body>
</html>

(9)配置Tomcat服务器;deploy(发布)springMVC-07-file:war包,并为该子项目添加虚拟路径映射:/mvc。(参见《Servlet详解》)

(10)启动测试。在IDEA中启动Tomcat,在浏览器中输入http://localhost:8080/mvc/file/test,文件上传页面访问成功。选择要上传的文件后,点击“upload”按钮。如下图所示:

文件上传页面

浏览器页面返回“文件上传成功!”,如下图所示:

文件上传成功

与此同时,文件上传目录中出现已上传的文件,如下图所示:

文件上传目录

注:我们也可以采用file.Transto来保存上传的文件。

FileController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*
* 采用file.Transto来保存上传的文件
*/
//通过@RequestMaping注解的produces属性解决json字符串乱码问题
@RequestMapping(value = "/upload2",produces = "application/json;charset=utf-8")
@ResponseBody
public String fileUpload2(@RequestParam("file") CommonsMultipartFile file, HttpServletRequest request) throws IOException {

//上传路径保存设置
String path = request.getServletContext().getRealPath("/upload");
File realPath = new File(path);
if (!realPath.exists()){
realPath.mkdir();
}
//上传文件地址
System.out.println("上传文件保存地址:"+realPath);

//通过CommonsMultipartFile的方法直接写文件(注意这个时候)
file.transferTo(new File(realPath +"/"+ file.getOriginalFilename()));

return "文件上传成功!";
}

18.2、文件下载

18.2.1、文件下载步骤

(1)设置response响应头

(2)读取文件 – InputStream

(3)写出文件 – OutputStream

(4)执行操作

(5)关闭流 (先开后关)

18.2.2、具体实现

具体实现步骤如下:

(1)在FileController控制器中,添加文件下载的功能。

FileController.java文件:

java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.net.URLEncoder;

@Controller
@RequestMapping("/file")
public class FileController {

@RequestMapping("/downloadTest")
public String downloadTest(){
//返回视图位置:web-inf/jsp/download.jsp
return "download";
}

/*
* 下载文件链接响应
*/
@RequestMapping(value="/download")
public String downloads(HttpServletResponse response , HttpServletRequest request) throws Exception{
//要下载的图片地址
String path = request.getServletContext().getRealPath("/upload");
String fileName = "下载测试.png";

//1、设置response 响应头
response.reset(); //设置页面不缓存,清空buffer
response.setCharacterEncoding("UTF-8"); //字符编码
response.setContentType("multipart/form-data"); //二进制传输数据
//设置响应头
response.setHeader("Content-Disposition","attachment;fileName="+ URLEncoder.encode(fileName, "UTF-8"));

File file = new File(path,fileName);
//2、读取文件--输入流
InputStream input=new FileInputStream(file);
//3、写出文件--输出流
OutputStream out = response.getOutputStream();

byte[] buff =new byte[1024];
int index=0;
//4、执行写出操作
while((index= input.read(buff))!= -1){
out.write(buff, 0, index);
out.flush();
}
out.close();
input.close();
return null;
}
}

(2)上传一个”下载测试.png”的图片到文件上传目录。

(3)在jsp包下新建一个download.jsp文件,用于文件下载页面。

download.jsp文件:

1
2
3
4
5
6
7
8
9
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>文件下载</title>
</head>
<body>
<a href="${pageContext.request.contextPath}/file/download">点击下载</a>
</body>
</html>

(4)在IDEA中重新启动Tomcat,在浏览器中输入http://localhost:8080/mvc/file/downloadTest,文件下载页面访问成功。点击“点击下载”按钮,文件下载成功。如下图所示:

文件下载成功

(本讲完,系列博文持续更新中…… )

阿汤笔迹微信公众平台

关注“阿汤笔迹” 微信公众号,获取更多学习笔记。
原文地址:http://www.atangbiji.com/2023/01/05/SpringMVCInDetail
博主最新文章在个人博客 http://www.atangbiji.com/ 发布。

文章作者: ATang
文章链接: http://www.atangbiji.com/2023/01/05/SpringMVCInDetail/
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 阿汤笔迹
打赏
  • 微信
    微信
  • 支付宝
    支付宝

评论