Java – SpringMVC – RESTful案例

简介

利用RESTful的风格，配合SpringMVC来搭建一个简单的具有增删改查功能的案例。

环境搭建

添加依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.unsoft</groupId>
    <artifactId>SpringMVC</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!-- SpringMVC -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.24</version>
        </dependency>

        <!-- 日志 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.4.5</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.15.RELEASE</version>
        </dependency>
    </dependencies>
</project>

web.xml文件

<?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">

    <!--配置springMVC的编码过滤器-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceEncoding</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提交-->
    <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>

<!--    定义浏览器接收到请求后要处理的类，这里使用Spring的DispatcherServlet-->
<!--    该请求处理名为SpringMVC-->
    <servlet>
        <servlet-name>SpringMVC</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请求映射，即当什么类型的url会被传到servlet-name为SpringMVC的地方处理-->
<!--    url-pattern 为 / 则表示所有请求都会被转到 servlet-name 中处理-->
    <!--
        设置springMVC的核心控制器所能处理的请求的请求路径
        /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
        但是/不能匹配.jsp请求路径的请求
    -->
    <servlet-mapping>
        <servlet-name>SpringMVC</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>


</web-app>

 web.xml文件解析

1.对于SpringMVC来说，我们使用了IoC控制反转机制，也就是说，所有的对象创建，都由Spring来进行控制和管理。那么对于HTTPServletRequest和HTTPServletResponse 这类的请求和响应，会对中文产生乱码，所以我们要在处理请求和响应参数前，都应该进行编码处理，SpringMVC提供了一个编码类CharacterEncodingFilter，我们使用它对所有的请求和响应都进行UTF-8编码。

2.RESTful除了会使用GET和POST请求外，还会使用PUT和DELETE请求，在HTML中，实际支持只有GET和POST请求，要实现PUT和DELETE请求，需要使用一种过滤器制定自定义提交，SpringMVC提供了一种自定义请求方法的类【hiddenHttpMethodFilter】，我们可以使用它，对所有请求进行过滤，并识别PUT和DELETE方法。

3.我们要对所有的请求，交给SpringMVC提供的【DispatcherServlet】进行处理，因此我们要在这里配置Servlet处理，并把所有的Servlet处理提交给【DispatcherServlet】。在以往的Servlet开发中，我们会对不同的请求路径，设置不同的Servlet处理，但在SpringMVC中，可以把统一的请求都交给【DispatcherServlet】。

SpringMVC.xml Bean类配置文件

<?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/cache http://www.springframework.org/schema/cache/spring-cache.xsd">

    <!--    扫描ioc Bean类-->
    <context:component-scan base-package="cn.unsoft"></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>

<!--    把静态资源交给Tomcat处理，否则所有的请求都会被DispatcherServlet处理，而DispatcherServlet不能处理静态资源-->
<!--    配置默认的servlet处理静态资源-->
<!--    当前工程的web.xml配置的前端控制器DispatcherServlet的url-pattern是/-->
<!--    tomcat的web.xml配置的DefaultServlet的url-pattern也是-->
<!--    此时，浏览器发送的请求会优先被DispatcherServlet进行处理，但是DispatcherServlet无法处理静态资源-->
<!--    若配置了<mvc:default-servlet-handler />，此时浏览器发送的所有请求都会被DefaultServlet处理-->
<!--    若配置了<mvc:default-servlet-handler />和<mvc:annotation-driven />-->
<!--    浏览器发送的请求会先被DispatcherServlet处理，无法处理在交给DefaultServlet处理-->
    <mvc:default-servlet-handler />

<!--    开启注解驱动-->
    <mvc:annotation-driven />

    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <mvc:view-controller path="/add" view-name="employee_add"></mvc:view-controller>

</beans>

SpringMVC.xml文件解析

1.我们使用了【DispatcherServlet】，那么就需要提供一个IoC控制反转的Bean配置，SpringMVC.xml 就是一个IoC的Bean配置文件，在里面配置对象

2.对于一些Model-View-Controller层的类，我们使用【@Controller】、【@Service】、【@Repository】、【@Component】注解进行识别，但是需要让Ioc知道我们那些类需要让Bean管理，所以在SpringMVC.xml中，需要配置一个扫描。（当然也可以真接使用【bean】标签进行配置）

3.配置Thymeleaf视图解析器，页面是需要一个模板引擎进行渲染的，我们目前使用的是Thymeleaf模板渲染器。

4.对于【DispatcherServlet】而言，它只能处理注解了【@RequestMapping】类的方法并进行解析，但是对于一些静态资源文件，是无法处理的，但是在配置Servlet中，我们默认设置了所有请求都经过【DispatcherServlet】进行处理，使得一些静态资源在请求时会产生 HTTP404 错误。

而对于Tomcat而言，它有一个默认的web.xml配置文件,它的主要负责是把所有请求都转发，默认的web.xml配置文件中也是同样配置了接收所有请求，这样和项目web.xml中的【DispatcherServlet】配置产生了冲突，所以我们需要同时开启两个驱动：

【<mvc:default-servlet-handler />】表示，当【DispatcherServlet】不能配置的时候，就交给Tomcat去处理

【<mvc:annotation-driven />】表示，当【DispatcherServlet】能处理的时候，就使用注解处理（因为我们的MVC都使用了注解Bean）

5.对于一些不需要计算的页面，我们可以不需要写在Controller层中，可以直接进行配置

【mvc:view-controller】表示，对一些只需要直接打开的页面，进行配置。

准备实体类

package cn.unsoft.pojo;

/**
 * ClassName : Employee
 * Package : cn.unsoft.pojo
 * @Author : TZMing
 * @Create : 2023-01-09
 * @Version : 1.0
 */
public class Employee {

    private Integer uid;
    private String lastName;

    /**
     * 1 -> 男
     * 0 -> 女
     */
    private Integer gender;

    public Employee() {
    }

    public Employee(Integer uid, String lastName, Integer gender) {
        this.uid = uid;
        this.lastName = lastName;
        this.gender = gender;
    }

    public Integer getUid() {
        return uid;
    }

    public void setUid(Integer uid) {
        this.uid = uid;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getGender() {
        return gender;
    }

    public void setGender(Integer gender) {
        this.gender = gender;
    }

    @Override
    public String toString() {
        return "Employee{" +
                "uid=" + uid +
                ", lastName='" + lastName + '\'' +
                ", gender=" + gender +
                '}';
    }
}

Dao模拟数据

package cn.unsoft.dao;

import cn.unsoft.pojo.Employee;
import org.springframework.stereotype.Repository;

import java.util.*;

/**
 * ClassName : EmployeeDao
 * Package : cn.unsoft.dao
 * Description : SpringMVC 项目描述
 *
 * @Author : TZMing
 * @Create : 2023-01-09
 * @Version : 1.0
 */
@Repository()
public class EmployeeDao {

    private static Map<String, Employee> employees;
    private static Integer initId = 1006;

    static {
        employees = new HashMap<>();

        employees.put("1001", new Employee(1001, "AAA", 1));
        employees.put("1002", new Employee(1002, "BBB", 0));
        employees.put("1003", new Employee(1003, "CCC", 1));
        employees.put("1004", new Employee(1004, "DDD", 0));
        employees.put("1005", new Employee(1005, "EEE", 1));
    }

    public EmployeeDao() {
    }


    public void save(Employee employee) {

        if (employee.getUid() == null) {
            employee.setUid(initId++);
        }
        employees.put(employee.getUid().toString(), employee);
    }

    public Collection<Employee> getEmployees() {
        return employees.values();
    }

    public Employee getEmployeeById(Integer uid) {
        return employees.get(uid.toString());
    }

    public void deleteEmployeeById(Integer uid) {
        employees.remove(uid.toString());
    }
}

实现功能

访问首页

首页设置

<mvc:view-controller path="/" view-name="index"/>

创建页面

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" >
    <title>Title</title>
</head>
<body>
<h1>首页</h1>
<a th:href="@{/employee}">访问员工信息</a>
</body>
</html>

查询所有员工数据

Controller控制层

    /**
     * 查询所有用户信息
     *
     * @param model
     * @return
     */
    @RequestMapping(value = "/employee", method = RequestMethod.GET)
    public String getAllEmployee(Model model) {

        Collection<Employee> employees = employeeDao.getEmployees();
        model.addAttribute("allEmployees", employees);
        return "employee_list";
    }

创建employee_list.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Employee Info</title>
    <script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
</head>
<body>
<table border="1" cellpadding="0" cellspacing="0" style="text-align:
center;" id="dataTable">
    <tr>
        <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 class="deleteA" @click="deleteEmployee"
               th:href="@{'/employee/'+${employee.id}}">delete</a>
            <a th:href="@{'/employee/'+${employee.id}}">update</a>
        </td>
    </tr>
</table>
</body>
</html>

执行保存、新增

Dao层

    public void save(Employee employee) {

        if (employee.getUid() == null) {
            employee.setUid(initId++);
        }
        employees.put(employee.getUid().toString(), employee);
    }

跳转到添加数据页面

<mvc:view-controller path="/toAdd" view-name="employee_add"></mvc:viewcontroller>

创建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>

跳转到更新数据页面

<a th:href="@{'/employee/'+${employee.id}}">update</a>

控制器层

    /**
     * 点击 update 按钮跳转到 update 页面
     *
     * @param uid
     * @return
     */
    @RequestMapping("/update/{uid}")
    public String ToUpdatePageById(@PathVariable("uid") Integer uid, Model model) {
        Employee employee = employeeDao.getEmployeeById(uid);
        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.email}"><br>
    <!--
    th:field="${employee.gender}"可用于单选框或复选框的回显
    若单选框的value和employee.gender的值一致，则添加checked="checked"属性
-->
    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>

执行更新

控制器层

    /**
     * 修改用户信息
     * @param employee
     * @return
     */
    @RequestMapping(value = "/employee",method = RequestMethod.PUT)
    public String UpdateEmployee(Employee employee){
        employeeDao.save(employee);
        return "redirect:/employee";
    }

删除

创建处理delete请求方式的表单

<!-- 作用：通过超链接控制表单的提交，将post请求转换为delete请求 -->
<form id="delete_form" method="post">
    <!-- HiddenHttpMethodFilter要求：必须传输_method请求参数，并且值为最终的请求方式 -->
    <input type="hidden" name="_method" value="delete"/>
</form>

设置超链接

<a class="deleteA" @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">delete</a>

使用Vue控制点击事件

<script type="text/javascript">
    var vue = new Vue({
        el:"#dataTable",
        methods:{
//event表示当前事件
            deleteEmployee:function (event) {
//通过id获取表单标签
                var delete_form = document.getElementById("delete_form");
//将触发事件的超链接的href属性为表单的action属性赋值
                delete_form.action = event.target.href;
//提交表单
                delete_form.submit();
//阻止超链接的默认跳转行为
                event.preventDefault();
            }
        }
    });
</script>

控制器方法

    /**
     * 删除用户信息
     * @param uid
     * @return
     */
    @RequestMapping("/employee/{uid}")
    public String deleyeEmployee(@PathVariable("uid") Integer uid){
        employeeDao.deleteEmployeeById(uid);
        return "redirect:/employee";
    }