SpringMVC - 详解RESTful - java开发笔记

1. 简介

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。它首次出现在2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。他在论文中提到：“我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。REST指的是一组架构约束条件和原则。” 如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。

2. RESTful的实现

具体说，就是 HTTP 协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。

它们分别对应四种基本操作：GET 用来获取资源，POST 用来新建资源，PUT 用来更新资源，DELETE 用来删除资源。

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

操作传统方式 REST风格

查询操作 getUserById?id=1 user/1–>get请求方式

保存操作 saveUser user–>post请求方式

删除操作 deleteUser?id=1 user/1–>delete请求方式

更新操作 updateUser user–>put请求方式

3.HiddenHttpMethodFilter

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

SpringMVC 提供了 HiddenHttpMethodFilter 帮助我们将 POST 请求转换为 DELETE 或 PUT 请求

HiddenHttpMethodFilter 处理put和delete请求的条件：

a>当前请求的请求方式必须为post

b>当前请求必须传输请求参数_method

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

在web.xml中注册HiddenHttpMethodFilter

<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

原因：

在 CharacterEncodingFilter 中通过 request.setCharacterEncoding(encoding) 方法设置字符集的

request.setCharacterEncoding(encoding) 方法要求前面不能有任何获取请求参数的操作

而 HiddenHttpMethodFilter 恰恰有一个获取请求方式的操作：

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

4. RESTful案例

1、准备工作

和传统 CRUD 一样，实现对员工信息的增删改查。

搭建环境

准备实体类

public class Employee {

private Integer id;

private String lastName;

private String email;

//1 male, 0 female

private Integer gender;

}

准备dao模拟数据

import java.util.Collection;

import java.util.HashMap;

import java.util.Map;

import com.atguigu.mvc.bean.Employee;

import org.springframework.stereotype.Repository;

@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、具体功能：访问首页

a>配置view-controller

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

b>创建页面

<!DOCTYPE html>

<head>

<title>Title</title>

</head>

<body>

<a th:href="@{/employee}">访问员工信息</a>

</body>

</html>

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

a>控制器方法

@RequestMapping(value = "/employee", method = RequestMethod.GET)

public String getEmployeeList(Model model){

Collection<Employee> employeeList = employeeDao.getAll();

model.addAttribute("employeeList", employeeList);

return "employee_list";

}

b>创建employee_list.html

<!DOCTYPE html>

<head>

<title>Employee Info</title>

</head>

<body>

<tr>

<th colspan="5">Employee Info</th>

</tr>

<tr>

<th>lastName</th>

<th>email</th>

<th>gender</th>

<th>options(<a th:href="@{/toAdd}">add</a>)</th>

</tr>

<td>

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

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

</td>

</tr>

</table>

</body>

</html>

5、具体功能：删除

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

<!– 作用：通过超链接控制表单的提交，将post请求转换为delete请求 –>

<!– HiddenHttpMethodFilter要求：必须传输_method请求参数，并且值为最终的请求方式 –>

</form>

b>删除超链接绑定点击事件

引入vue.js

删除超链接

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

通过vue处理点击事件

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>

c>控制器方法

@RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)

public String deleteEmployee(@PathVariable("id") Integer id){

employeeDao.delete(id);

return "redirect:/employee";

}

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

a>配置view-controller

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

b>创建employee_add.html

<!DOCTYPE html>

<head>

<title>Add Employee</title>

</head>

<body>

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>

</form>

</body>

</html>

7、具体功能：执行保存

a>控制器方法

@RequestMapping(value = "/employee", method = RequestMethod.POST)

public String addEmployee(Employee employee){

employeeDao.save(employee);

return "redirect:/employee";

}

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

a>修改超链接

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

b>控制器方法

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

}

c>创建employee_update.html

<!DOCTYPE html>

<head>

<title>Update Employee</title>

</head>

<body>

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>

</form>

</body>

</html>

9、具体功能：执行更新

a>控制器方法

@RequestMapping(value = "/employee", method = RequestMethod.PUT)

public String updateEmployee(Employee employee){

employeeDao.save(employee);

return "redirect:/employee";

}

————————————————

原文链接：https://blog.csdn.net/m0_60915009/article/details/133912094

SpringMVC - 详解RESTful

相关文章

归档