目录
1、准备工作
① 创建一个新模块,这里名为 SpringMVC-rest,在 pom.xml 中设置打包方式为 war,引入依赖,如下:
<dependencies>
<!-- SpringMVC -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.1</version>
</dependency>
<!-- 日志 -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
<!-- ServletAPI -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
<!-- Spring5和Thymeleaf整合包 -->
<dependency>
<groupId>org.thymeleaf</groupId>
<artifactId>thymeleaf-spring5</artifactId>
<version>3.0.12.RELEASE</version>
</dependency>
</dependencies>
② 配置 web 模块,在项目结构中配置 web.xml,路径为 src/main/webapp/WEB-INF/web.xml,在 web.xml 中配置 编码过滤器CharacterEncodingFilter 、 处理请求方式为PUT和DELETE的过滤器HiddenHttpMethodFilter 、SpringMVC的前端控制器DispatcherServlet
<!-- 配置编码过滤器CharacterEncodingFilter -->
<filter>
<filter-name>CharacterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceRequestEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CharacterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!-- 配置处理请求方式为PUT和DELETE的过滤器HiddenHttpMethodFilter -->
<filter>
<filter-name>HiddenHttpMethodFilter</filter-name>
<filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>HiddenHttpMethodFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!-- 配置SpringMVC的前端控制器DispatcherServlet -->
<servlet>
<servlet-name>DispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springMVC.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>DispatcherServlet</servlet-name>
<!--
设置springMVC的核心控制器所能处理的请求的请求路径
/ 所匹配的请求可以是/login或.html或.js或.css方式的请求路径
但是 / 不能匹配.jsp请求路径的请求
-->
<url-pattern>/</url-pattern>
</servlet-mapping>
③ 在 src/main/resources 下创建 springMVC.xml,配置 扫描组件、Thymeleaf视图解析器
<!-- 配置扫描组件 -->
<context:component-scan base-package="com.zyj.mvc"></context:component-scan>
<!-- 配置Thymeleaf视图解析器 -->
<bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
<property name="order" value="1"/>
<property name="characterEncoding" value="UTF-8"/>
<property name="templateEngine">
<bean class="org.thymeleaf.spring5.SpringTemplateEngine">
<property name="templateResolver">
<bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
<!-- 视图前缀 -->
<property name="prefix" value="/WEB-INF/templates/"/>
<!-- 视图后缀 -->
<property name="suffix" value=".html"/>
<property name="templateMode" value="HTML5"/>
<property name="characterEncoding" value="UTF-8" />
</bean>
</property>
</bean>
</property>
</bean>
④ 创建实体类
public class Employee {
private Integer id;
private String lastName;
private String email;
//1 male, 0 female
private Integer gender;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Integer getGender() {
return gender;
}
public void setGender(Integer gender) {
this.gender = gender;
}
public Employee(Integer id, String lastName, String email, Integer gender) {
super();
this.id = id;
this.lastName = lastName;
this.email = email;
this.gender = gender;
}
public Employee() {
}
}
⑤ 创建dao类
@Repository
public class EmployeeDao {
private static Map<Integer, Employee> employees = null;
static{
employees = new HashMap<Integer, Employee>();
employees.put(1001, new Employee(1001, "E-AA", "aa@163.com", 1));
employees.put(1002, new Employee(1002, "E-BB", "bb@163.com", 1));
employees.put(1003, new Employee(1003, "E-CC", "cc@163.com", 0));
employees.put(1004, new Employee(1004, "E-DD", "dd@163.com", 0));
employees.put(1005, new Employee(1005, "E-EE", "ee@163.com", 1));
}
private static Integer initId = 1006;
public void save(Employee employee){
if(employee.getId() == null){
employee.setId(initId++);
}
employees.put(employee.getId(), employee);
}
public Collection<Employee> getAll(){
return employees.values();
}
public Employee get(Integer id){
return employees.get(id);
}
public void delete(Integer id){
employees.remove(id);
}
}
2、功能清单
功能 | URL地址 | 请求方式 |
访问首页 | / | GET |
查询全部数据 | /employee | GET |
删除 | /employee/2 | DELETE |
跳转到添加数据页面 | /toAdd | GET |
执行保存 | /employee | POST |
跳转到更新数据页面 | /employee/2 | GET |
执行更新 | /employee | PUT |
3、功能实现:访问首页
① 在 springMVC.xml 配置访问首页的view-controller
<!-- 配置访问首页的view-controller视图控制器 -->
<mvc:view-controller path="/" view-name="index"></mvc:view-controller>
② 由于配置 view-controller 会导致其他控制器中的请求映射将全部失效,所以需要在 SpringMVC 的核心配置文件 springMVC.xml 中设置开启mvc注解驱动的标签
<!-- 开启MVC注解驱动 -->
<mvc:annotation-driven></mvc:annotation-driven>
③ 根据在 springMVC.xml 中配置的 Thymeleaf 视图解析器的 视图前缀
<!-- 视图前缀 -->
<property name="prefix" value="/WEB-INF/templates/"/>
在对应位置 src/main/webapp/WEB-INF/templates 下创建首页 index.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>首页</title>
</head>
<body>
<h1>首页</h1>
</body>
</html>
④ 编辑运行/调试配置,运行测试
4、功能实现:查询所有员工数据
① 在 EmployeeController 控制器中添加方法,用来查询所有员工信息
//查询所有员工信息
@RequestMapping(value = "/employee", method = RequestMethod.GET)
public String getAllEmployee(Model model){
// 获取所有员工信息
Collection<Employee> employeeList = employeeDao.getAll();
// 由于每次查询都要重新查询,所以将结果保存到request域(一次请求有效)中即可
model.addAttribute("employeeList", employeeList);
return "employee_list";
}
② 在 src/main/webapp/WEB-INF/templates 下创建页面 employee_list.html,用来显示所有员工信息。
注:Thymeleaf在IDEA中变量名报错是正常现象,只要不影响使用效果即可
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Employee Info</title>
</head>
<body>
<!--
border 设置表格边框
width 设置表格宽度
height 设置表格宽度
align 设置表格相对于页面的对齐方式
cellspacing 设置单元格之间的间距
cellpadding 设置单元边沿与其内容之间的间距
text-align 设置单元格文本水平对齐方式
-->
<table border="1" cellspacing="0" cellpadding="10" style="text-align: center;" align="center">
<tr>
<!-- colspan属性设置跨列 rowspan属性设置跨行 -->
<th colspan="5">Employee Info</th>
</tr>
<tr>
<th>id</th>
<th>lastName</th>
<th>email</th>
<th>gender</th>
<th>options</th>
</tr>
<tr th:each="employee : ${employeeList}">
<td th:text="${employee.id}"></td>
<td th:text="${employee.lastName}"></td>
<td th:text="${employee.email}"></td>
<td th:text="${employee.gender}"></td>
<td>
<a href="">delete</a>
<a href="">update</a>
</td>
</tr>
</table>
</body>
</html>
③ 运行测试,在首页点击对应的链接,结果如下
5、功能实现:删除
首先要考虑的是如何在请求上以 /id 的方式发送 DELETE 请求,
① 首先引入 vue.js,在 src/main/webapp/static/js 目录下引入 vue.js
② 在 employee_list.html 页面给 delete超链接 绑定单击事件
<!--
border 设置表格边框
width 设置表格宽度
height 设置表格宽度
align 设置表格相对于页面的对齐方式
cellspacing 设置单元格之间的间距
cellpadding 设置单元边沿与其内容之间的间距
text-align 设置单元格文本水平对齐方式
-->
<table id="dataTable" border="1" cellspacing="0" cellpadding="10" style="text-align: center;" align="center">
<tr>
<!-- colspan属性设置跨列 rowspan属性设置跨行 -->
<th colspan="5">Employee Info</th>
</tr>
<tr>
<th>id</th>
<th>lastName</th>
<th>email</th>
<th>gender</th>
<th>options</th>
</tr>
<tr th:each="employee : ${employeeList}">
<td th:text="${employee.id}"></td>
<td th:text="${employee.lastName}"></td>
<td th:text="${employee.email}"></td>
<td th:text="${employee.gender}"></td>
<td>
<!--<a th:href="@{/employee/}+${employee.id}">delete</a>-->
<a @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">delete</a>
<a href="">update</a>
</td>
</tr>
</table>
<!-- 删除操作要提交的表单 -->
<form id="deleteForm" method="post">
<input type="hidden" name="_method" value="delete">
</form>
<!-- 给delete超链接绑定单击事件 -->
<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
<script type="text/javascript">
var vue = new Vue({
el:"#dataTable",
methods:{
// event 表示当前触发的事件
deleteEmployee:function (event){
// 根据id获取delete表单
var deleteForm = document.getElementById("deleteForm");
// event.target是当前触发这个事件的元素(标签)
// 将触发点击事件的超链接的href属性赋值给表单的action
deleteForm.action = event.target.href;
// 提交表单
deleteForm.submit();
// 由于html页面有默认行为,在点击a标签超链接后,会先执行事件(跳转到指定链接),再提交表单,所以要取消默认行为
event.preventDefault();
}
}
})
</script>
③ 在 EmployeeController 控制器中添加方法
//删除指定id的员工信息
@RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
public String deleteEmployee(@PathVariable("id")Integer id){
employeeDao.delete(id);
// 删除完后跳转到表单页面
// 使用重定向,若使用转发,浏览器地址不变,但地址有id参数,且重定向可以避免表单重复提交
return "redirect:/employee";
}
④ 运行测试,发现页面报错405,delete超链接的请求方式还是 GET。回到显示员工列表的页面,按F12查看控制台,发现报错:找不到 vue.js
查看 target 目录,发现没有 static 目录,也就没有 vue.js,这时只需要在 Maven 重新打包,执行 package 命令即可。
重新部署,回到显示员工列表的页面,再次查看控制台,发现虽然有了 vue.js,但是访问不了
原因:由于配置了SpringMVC的前端控制器,所以访问 vue.js 的路径是由这个控制器来处理的,但是这个路径无法被 SpringMVC的前端控制器 所解析。
解决办法:在 springMVC.xml 中添加
<!--
开放对静态资源的访问
静态资源首先会被前端控制器处理,若找不到对应的请求映射,就会交给默认的servlet处理
-->
<mvc:default-servlet-handler/>
⑤ 运行测试,发现删除成功
6、功能实现:跳转到添加数据页面
① 在 employee_list.html 页面的表格第一行的 option 添加 跳转到添加数据页面 的超链接,添加完后表格如下:
<table id="dataTable" border="1" cellspacing="0" cellpadding="10" style="text-align: center;" align="center">
<tr>
<!-- colspan属性设置跨列 rowspan属性设置跨行 -->
<th colspan="5">Employee Info</th>
</tr>
<tr>
<th>id</th>
<th>lastName</th>
<th>email</th>
<th>gender</th>
<th>options(<a th:href="@{/toAdd}"></a>) </th>
</tr>
<tr th:each="employee : ${employeeList}">
<td th:text="${employee.id}"></td>
<td th:text="${employee.lastName}"></td>
<td th:text="${employee.email}"></td>
<td th:text="${employee.gender}"></td>
<td>
<!--<a th:href="@{/employee/}+${employee.id}">delete</a>-->
<a @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">delete</a>
<a href="">update</a>
</td>
</tr>
</table>
② 由于跳转到添加数据的页面不需要其他参数,所以使用视图控制器来跳转即可。在 springMVC.xml 添加 跳转到添加数据页面 的视图控制器
<!-- 配置view-controller视图控制器 -->
<mvc:view-controller path="/" view-name="index"></mvc:view-controller>
<mvc:view-controller path="/toAdd" view-name="employee_add"></mvc:view-controller>
③ 在 EmployeeController 类添加方法
//添加员工信息
@RequestMapping(value = "/employee", method = RequestMethod.POST)
public String addEmployee(Employee employee){
employeeDao.save(employee);
return "redirect:/employee";
}
④ 创建用于添加员工的页面 employee_add.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>add employee</title>
</head>
<body>
<form th:action="@{/employee}" method="post">
lastName:<input type="text" name="lastName"><br>
email:<input type="text" name="email"><br>
gender:<input type="radio" name="gender" value="1">male
<input type="radio" name="gender" value="0">female<br>
<input type="submit" value="add"><br>
</form>
</body>
</html>
7、功能实现:修改员工信息(跳转到更新数据页面并执行更新)
想要修改员工信息,需要提供一个用来修改的页面,且初始会回显要修改的员工的初始信息
① 首先在显示员工列表页面的 update 超链接设置打开修改员工页面的路径,并传递所要修改的员工的 id,修改后表格代码如下
<table id="dataTable" border="1" cellspacing="0" cellpadding="10" style="text-align: center;" align="center"> <tr> <!-- colspan属性设置跨列 rowspan属性设置跨行 --> <th colspan="5">Employee Info</th> </tr> <tr> <th>id</th> <th>lastName</th> <th>email</th> <th>gender</th> <th>options(<a th:href="@{/toAdd}">add</a>)</th> </tr> <tr th:each="employee : ${employeeList}"> <td th:text="${employee.id}"></td> <td th:text="${employee.lastName}"></td> <td th:text="${employee.email}"></td> <td th:text="${employee.gender}"></td> <td> <!--<a th:href="@{/employee/}+${employee.id}">delete</a>--> <a @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">delete</a> <a th:href="@{'/employee/'+${employee.id}}">update</a> </td> </tr> </table>
② 在 EmployeeController 类添加根据传递的 id 查询该员工的信息,在修改页面回显其信息
//根据id查询员工信息,用来在修改页面回显信息
@RequestMapping(value = "/employee/{id}", method = RequestMethod.GET)
public String getEmployeeById(@PathVariable("id") Integer id, Model model){
Employee employee = employeeDao.get(id);
model.addAttribute("employee", employee);
return "employee_update";
}
③ 创建 employee_update.html 页面,用来回显及修改员工信息
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>update employee</title>
</head>
<body>
<form th:action="@{/employee}" method="post">
<input type="hidden" name="_method" value="put">
<input type="hidden" name="id" th:value="${employee.id}">
lastName:<input type="text" name="lastName" th:value="${employee.lastName}"><br>
email:<input type="text" name="email" th:value="${employee.lastName}"><br>
<!-- th:field会将单选框的name和它的值相同的选项选中 -->
gender:<input type="radio" name="gender" value="1" th:field="${employee.gender}">male
<input type="radio" name="gender" value="0" th:field="${employee.gender}">female<br>
<input type="submit" value="update"><br>
</form>
</body>
</html>
④ 运行测试是否能够正确回显,能够回显后,接下来要将修改页面的信息保存到服务器中
⑤ 在 EmployeeController 类创建方法将修改页面的信息保存
//根据修改页面的信息修改对应员工的信息
@RequestMapping(value = "/employee", method = RequestMethod.PUT)
public String updateEmployee(Employee employee){
employeeDao.save(employee);
return "redirect:/employee";
}
⑥ 运行测试,查看是否能够将修改的信息保存
补充:SpringMVC处理静态资源的过程
在 web 阶段,静态资源是交给 tomcat 中的默认servlet,其定义在 apache-tomcat-8.5.73\conf 目录下的 web.xml
其映射信息如下
而在 web.xml 中我们配置的 DispatcherServlet 的路径也是 /
如果 url 路径一样,使用的是当前工程配置的 DispatcherServlet,但 DispatcherServlet 会找不到静态资源路径的请求映射,所以会 404。而在 springMVC.xml 中配置以下代码后,当 DispatcherServlet 处理不了,就会交给 DefaultServlet 来处理
<!--
开放对静态资源的访问
静态资源首先会被前端控制器处理,若找不到对应的请求映射,就会交给默认的servlet处理
-->
<mvc:default-servlet-handler/>
当然,如果没有配置下面的代码,也就是没有开启MVC注解驱动,这样SpringMVC相关的注解就不会起作用,所有请求都会交给 DefaultServlet 来处理
<!-- 开启MVC注解驱动 -->
<mvc:annotation-driven></mvc:annotation-driven>