SpringMVC之RESTful具体操作

126 阅读5分钟

本文已参与【新人创作礼】活动,一起开启掘金创作之路。

目录

一、RESTful简介

二、HiddenHttpMethodFilter

在web.xml中注册HiddenHttpMethodFilter

三、RESTful案例 

1、准备工作

准备实体类

准备dao模拟数据

2、功能清单

3、具体功能:访问首页

1)配置view-controller

2)创建页面 

4、具体功能:查询所有员工数据

1)控制器方法

 5、具体功能:删除

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

 2)创建employee_list.html,删除超链接绑定点击事件

6、具体功能:跳转到添加数据页面

1)配置view-controller

2)创建employee_add.html

7、具体功能:执行保存

1)控制器方法

8、具体功能:跳转到更新数据页面

1)控制器方法

2)创建employee_update.html 

9、具体功能:执行更新

1)控制器方法


一、RESTful简介

REST:Representational State Transfer,表现层资源状态转移。

具体说,就是 HTTP 协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET 用来获取资源,POST 用来新建资源,PUT 用来更新资源,DELETE用来删除资源。

REST 风格提倡 URL 地址使用统一的风格设计,从前到后各个单词使用斜杠分开,不使用问号键值对方式携带请求参数,而是将要发送给服务器的数据作为 URL 地址的一部分,以保证整体风格的一致性。

操作传统方式REST风格
查询操作getUserById?id=1user/1  -->get请求方式
保存操作saveUseruser  -->post请求方式
删除操作deleteUser?id=1user/1  -->delete请求方式
更新操作updateUseruser  -->put请求方式

二、HiddenHttpMethodFilter

由于浏览器只支持发送get和post方式的请求,那么该如何发送put和delete请求呢?

SpringMVC 提供了 HiddenHttpMethodFilter 帮助我们将 POST 请求转换为 DELETE 或 PUT 请求
HiddenHttpMethodFilter 处理put和delete请求的条件:
1)当前请求的请求方式必须为post
2)当前请求必须传输请求参数_method

满足以上条件,HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数
_method的值,因此请求参数 _method的值才是最终的请求方式。

在web.xml中注册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中提供了两个过滤器:CharacterEncodingFilter和HiddenHttpMethodFilter
在web.xml中注册时,必须先注册CharacterEncodingFilter,再注册HiddenHttpMethodFilter
原因:

1)在 CharacterEncodingFilter 中通过 request.setCharacterEncoding(encoding) 方法设置字符集的,request.setCharacterEncoding(encoding) 方法要求前面不能有任何获取请求参数的操作
2)而 HiddenHttpMethodFilter 恰恰有一个获取请求方式的操作:

String paramValue = request.getParameter(this.methodParam);

三、RESTful案例 

1、准备工作

准备实体类

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() {
        }

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

}

准备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
查询全部数据/employeeGET
删除/employee/2DELETE
跳转到添加数据页面/toAddGET
执行保存/employeePOST
跳转到更新数据页面/employee/2GET
执行更新/employeePUT

3、具体功能:访问首页

1)配置view-controller

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

2)创建页面 

<!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>

4、具体功能:查询所有员工数据

1)控制器方法

@RequestMapping(value = "/employee", method = RequestMethod.GET)
public String getEmployeeList(Model model){
  Collection<Employee> employeeList = employeeDao.getAll();
  model.addAttribute("employeeList", employeeList);
  return "employee_list";
}

 5、具体功能:删除

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

@RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
public String deleteEmployee(@PathVariable("id") Integer id){
  employeeDao.delete(id);
//使用重定向,因为当前任务已完成,且与后面的没有关系
  return "redirect:/employee";
}

 2)创建employee_list.html,删除超链接绑定点击事件

删除使用vue的原因:删除不像添加,会转发到另一个页面,在form里提供隐藏域,从而在控制器找到相应的方法 ,删除只在一个页面跳转,所以需要在本页面使用隐藏域。

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Employee Info</title>
</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>Name</th>
        <th>email</th>
        <th>Gender</th>
        <th>Option(<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 @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">delete</a>
            <a th:href="@{'/employee/'+${employee.id}}">update</a>
        </td>
    </tr>
</table>

<form id="deleteForm" method="post">
    <input type="hidden" name="_method" value="delete">
</form>

<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
<script type="text/javascript">
    var vue=new Vue({
        el:"#dataTable",
        methods:{
            deleteEmployee:function (event) {
             var deleteForm = document.getElementById("deleteForm");
             deleteForm.action=event.target.href;
             deleteForm.submit();
             event.preventDefault();
            }
        }
    });
</script>

</body>
</html>

6、具体功能:跳转到添加数据页面

1)配置view-controller

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

2)创建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、具体功能:执行保存

1)控制器方法

@RequestMapping(value = "/employee", method = RequestMethod.POST)
public String addEmployee(Employee employee){
  employeeDao.save(employee);
//使用重定向,因为当前任务已完成,且与后面的没有关系
  return "redirect:/employee";
}

8、具体功能:跳转到更新数据页面

1)控制器方法

@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";
}

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

9、具体功能:执行更新

1)控制器方法

@RequestMapping(value = "/employee", method = RequestMethod.PUT)
public String updateEmployee(Employee employee){
  employeeDao.save(employee);
  return "redirect:/employee";
}

\