SpringMVC --- RESTful

一、RESTful

1.1、RESTful简介

REST：Representational State Transfer，表现层资源状态转移。

① 资源

资源是一种看待服务器的方式，即，将服务器看作是由很多离散的资源组成。每个资源是服务器上一个 可命名的抽象概念。因为资源是一个抽象的概念，所以它不仅仅能代表服务器文件系统中的一个文件、 数据库中的一张表等等具体的东西，可以将资源设计的要多抽象有多抽象，只要想象力允许而且客户端 应用开发者能够理解。与面向对象设计类似，资源是以名词为核心来组织的，首先关注的是名词。一个 资源可以由一个或多个URI来标识。URI既是资源的名称，也是资源在Web上的地址。对某个资源感兴 趣的客户端应用，可以通过资源的URI与其进行交互。

② 资源的表述

资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移（交 换）。资源的表述可以有多种格式，例如HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格 式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。

③ 状态转移

状态转移说的是：在客户端和服务器端之间转移（transfer）代表资源状态的表述。通过转移和操作资 源的表述，来间接实现操作资源的目的。

1.2、RESTful的实现

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

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

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

1.3、HiddenHttpMethodFilter

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

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

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

1、当前请求的请求方式必须为 post

2、当前请求必须传输请求参数 _method

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

在web.xml中注册HiddenHttpMethodFilter

1.  
   <filter>
2.  
   <filter-name>HiddenHttpMethodFilter</filter-name>
3.  
   <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
4.  
   </filter>
5.  
   <filter-mapping>
6.  
   <filter-name>HiddenHttpMethodFilter</filter-name>
7.  
   <url-pattern>/*</url-pattern>
8.  
   </filter-mapping>

注：

目前为止，SpringMVC中提供了两个过滤器：CharacterEncodingFilter 和 HiddenHttpMethodFilter

在web.xml中注册时，必须先注册CharacterEncodingFilter，再注册HiddenHttpMethodFilter

原因： 

• 在 CharacterEncodingFilter 中通过 request.setCharacterEncoding(encoding) 方法设置字符集的
• request.setCharacterEncoding(encoding) 方法要求前面不能有任何获取请求参数的操作
• 而 HiddenHttpMethodFilter 恰恰有一个获取请求方式的操作：String paramValue = request.getParameter(this.methodParam);

二、RESTful案例

2.1、准备工作

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

• 搭建环境
• 准备实体类

1.  
   public class Employee {
2.  
   private Integer id;
3.  
   private String lastName;
4.  
   private String email;
5.  
   private String gender;
6.  
    
7.  
   public Employee() {
8.  
   }
9.  
    
10.  
    public Employee(Integer id, String lastName, String email, String gender) {
11.  
    this.id = id;
12.  
    this.lastName = lastName;
13.  
    this.email = email;
14.  
    this.gender = gender;
15.  
    }
16.  
     
17.  
    public Integer getId() {
18.  
    return id;
19.  
    }
20.  
     
21.  
    public void setId(Integer id) {
22.  
    this.id = id;
23.  
    }
24.  
     
25.  
    public String getLastName() {
26.  
    return lastName;
27.  
    }
28.  
     
29.  
    public void setLastName(String lastName) {
30.  
    this.lastName = lastName;
31.  
    }
32.  
     
33.  
    public String getEmail() {
34.  
    return email;
35.  
    }
36.  
     
37.  
    public void setEmail(String email) {
38.  
    this.email = email;
39.  
    }
40.  
     
41.  
    public String getGender() {
42.  
    return gender;
43.  
    }
44.  
     
45.  
    public void setGender(String gender) {
46.  
    this.gender = gender;
47.  
    }
48.  
     
49.  
    @Override
50.  
    public String toString() {
51.  
    return "Employee{"
52.  
    "id=" id
53.  
    ", lastName='" lastName '\''
54.  
    ", email='" email '\''
55.  
    ", gender='" gender '\''
56.  
    '}';
57.  
    }
58.  
    }

• 准备dao模拟数据

1.  
   @Repository
2.  
   public class EmployeeDao {
3.  
   private static Map<Integer, Employee> employees = null;
4.  
    
5.  
   static{
6.  
   employees = new HashMap<Integer, Employee>();
7.  
   employees.put(1001, new Employee(1001, "E-AA", "aa@163.com", "男"));
8.  
   employees.put(1002, new Employee(1002, "E-BB", "bb@163.com", "男"));
9.  
   employees.put(1003, new Employee(1003, "E-CC", "cc@163.com", "女"));
10.  
    employees.put(1004, new Employee(1004, "E-DD", "dd@163.com", "女"));
11.  
    employees.put(1005, new Employee(1005, "E-EE", "ee@163.com", "男"));
12.  
    }
13.  
     
14.  
    private static Integer initId = 1006;
15.  
     
16.  
    public void save(Employee employee){
17.  
    if(employee.getId() == null){
18.  
    employee.setId(initId );
19.  
    }
20.  
    employees.put(employee.getId(), employee);
21.  
    }
22.  
     
23.  
    public Collection<Employee> getAll(){
24.  
    return employees.values();
25.  
    }
26.  
     
27.  
    public Employee get(Integer id){
28.  
    return employees.get(id);
29.  
    }
30.  
     
31.  
    public void delete(Integer id){
32.  
    employees.remove(id);
33.  
    }
34.  
    }

2.2、功能清单

2.3、具体功能：访问首页 

① 配置view-controller

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

② 创建页面

1.  
   <!DOCTYPE html>
2.  
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
3.  
   <head>
4.  
   <meta charset="UTF-8">
5.  
   <title>首页</title>
6.  
   </head>
7.  
   <body>
8.  
   <h1>index.html</h1><br>
9.  
   <a th:href="@{/employee}">查询所有的员工信息</a><br>
10.  
    </body>
11.  
    </html>

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

① 控制器方法

1.  
   @Controller
2.  
   public class EmployeeController {
3.  
    
4.  
   @Autowired
5.  
   private EmployeeDao employeeDao;
6.  
    
7.  
   @GetMapping("/employee")
8.  
   public String getAllEmployee(Model model) {
9.  
   //获取所有员工信息
10.  
    Collection<Employee> employeeList = employeeDao.getAll();
11.  
    //将员工信息在请求域中共享
12.  
    model.addAttribute("employeeList", employeeList);
13.  
    //跳转到列表页面
14.  
    return "employee_list";
15.  
    }
16.  
    }

②创建employee_list.html

1.  
   <!DOCTYPE html>
2.  
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
3.  
   <head>
4.  
   <meta charset="UTF-8">
5.  
   <title>Employee List</title>
6.  
   <link rel="stylesheet" th:href="@{/static/css/index_work.css}">
7.  
   </head>
8.  
   <body>
9.  
   <table border="1" cellpadding="0" cellspacing="0" style="text-align:center;" id="dataTable">
10.  
    <tr>
11.  
    <th colspan="5">Employee List</th>
12.  
    </tr>
13.  
    <tr>
14.  
    <th>id</th>
15.  
    <th>lastName</th>
16.  
    <th>email</th>
17.  
    <th>gender</th>
18.  
    <th>options(<a th:href="@{/to/add}">add</a>)</th>
19.  
    </tr>
20.  
    <tr th:each="employee : ${employeeList}">
21.  
    <td th:text="${employee.id}"></td>
22.  
    <td th:text="${employee.lastName}"></td>
23.  
    <td th:text="${employee.email}"></td>
24.  
    <td th:text="${employee.gender}"></td>
25.  
    <td>
26.  
    <a class="deleteA" @click="deleteEmployee"
27.  
    th:href="@{'/employee/' ${employee.id}}">delete</a>
28.  
    <a th:href="@{'/employee/' ${employee.id}}">update</a>
29.  
    </td>
30.  
    </tr>
31.  
    </table>
32.  
     
33.  
    </body>
34.  
    </html>

2.5、具体功能：删除

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

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

② 删除超链接绑定点击事件

引入vue.js

<script type="text/javascript" th:src="/static/js/vue.js"></script>

删除超链接

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

通过vue处理点击事件

1.  
   <!DOCTYPE html>
2.  
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
3.  
   <head>
4.  
   <meta charset="UTF-8">
5.  
   <title>Employee List</title>
6.  
   <link rel="stylesheet" th:href="@{/static/css/index_work.css}">
7.  
   </head>
8.  
   <body>
9.  
   <div id="app">
10.  
    <table >
11.  
    <tr>
12.  
    <th colspan="5">Employee List</th>
13.  
    </tr>
14.  
    <tr>
15.  
    <th>id</th>
16.  
    <th>lastName</th>
17.  
    <th>email</th>
18.  
    <th>gender</th>
19.  
    <th>options(<a th:href="@{/to/add}">add</a>)</th>
20.  
    </tr>
21.  
    <tr th:each="employee : ${employeeList}">
22.  
    <td th:text="${employee.id}"></td>
23.  
    <td th:text="${employee.lastName}"></td>
24.  
    <td th:text="${employee.email}"></td>
25.  
    <td th:text="${employee.gender}"></td>
26.  
    <td>
27.  
    <a @click="deleteEmployee"
28.  
    th:href="@{'/employee/' ${employee.id}}">delete</a>
29.  
    <a th:href="@{'/employee/' ${employee.id}}">update</a>
30.  
    </td>
31.  
    </tr>
32.  
    </table>
33.  
    <form id="delete_form" method="post">
34.  
    <input type="hidden" name="_method" value="delete">
35.  
    </form>
36.  
    </div>
37.  
     
38.  
    <script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
39.  
    <script type="text/javascript" >
40.  
    var vue = new Vue({
41.  
    el:"#app",
42.  
    methods:{
43.  
    //event表示当前事件
44.  
    deleteEmployee:function (event) {
45.  
    //通过id获取表单标签
46.  
    var delete_form = document.getElementById("delete_form");
47.  
    //将触发事件的超链接的href属性为表单的action属性赋值
48.  
    delete_form.action = event.target.href;
49.  
    //提交表单
50.  
    delete_form.submit();
51.  
    //阻止超链接的默认跳转行为
52.  
    event.preventDefault();
53.  
    }
54.  
    }
55.  
    });
56.  
    </script>
57.  
    </body>
58.  
    </html>

③ 控制器方法

1.  
   @DeleteMapping("/employee/{id}")
2.  
   public String deleteEmployee(@PathVariable("id") Integer id){
3.  
   employeeDao.delete(id);
4.  
   return "redirect:/employee";
5.  
   }

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

① 配置view-controller

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

② 创建employee_add.html

1.  
   <!DOCTYPE html>
2.  
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
3.  
   <head>
4.  
   <meta charset="UTF-8">
5.  
   <title>Add Employee</title>
6.  
   <link rel="stylesheet" th:href="@{/static/css/index_work.css}">
7.  
   </head>
8.  
   <body>
9.  
   <form th:action="@{/employee}" method="post">
10.  
    <table>
11.  
    <tr>
12.  
    <th colspan="2">add employee</th>
13.  
    </tr>
14.  
    <tr>
15.  
    <td>lastName</td>
16.  
    <td><input type="text" name="lastName"></td>
17.  
    </tr>
18.  
    <tr>
19.  
    <td>email</td>
20.  
    <td><input type="text" name="email"></td>
21.  
    </tr>
22.  
    <tr>
23.  
    <td>gender</td>
24.  
    <td>
25.  
    <input type="radio" name="gender" value="男">男
26.  
    <input type="radio" name="gender" value="女">女
27.  
    </td>
28.  
    </tr>
29.  
    <tr>
30.  
    <td colspan="2">
31.  
    <input type="submit" value="add">
32.  
    </td>
33.  
    </tr>
34.  
    </table>
35.  
    </form>
36.  
    </body>
37.  
    </html>

2.7、具体功能：执行保存

① 控制器方法

1.  
   @PostMapping("/employee")
2.  
   public String addEmployee(Employee employee) {
3.  
   //添加员工信息
4.  
   employeeDao.save(employee);
5.  
   //使用重定向跳转到列表页面
6.  
   return "redirect:/employee";
7.  
   }

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

① 修改超链接

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

② 控制器方法

1.  
   @GetMapping("/employee/{id}")
2.  
   public String toUpdate(@PathVariable("id") Integer id, Model model) {
3.  
   //根据id获取员工信息
4.  
   Employee employee = employeeDao.get(id);
5.  
   //将员工信息在请求域中共享
6.  
   model.addAttribute("employee", employee);
7.  
   //跳转到更新页面
8.  
   return "employee_update";
9.  
   }

 ③ 创建employee_update.html

1.  
   <!DOCTYPE html>
2.  
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
3.  
   <head>
4.  
   <meta charset="UTF-8">
5.  
   <title>Update Employee</title>
6.  
   <link rel="stylesheet" th:href="@{/static/css/index_work.css}">
7.  
   </head>
8.  
   <body>
9.  
   <form th:action="@{/employee}" method="post">
10.  
    <input type="hidden" name="_method" value="put">
11.  
    <input type="hidden" name="id" th:value="${employee.id}">
12.  
    <table>
13.  
    <tr>
14.  
    <th colspan="2">update employee</th>
15.  
    </tr>
16.  
    <tr>
17.  
    <td>lastName</td>
18.  
    <td><input type="text" name="lastName" th:value="${employee.lastName}"></td>
19.  
    </tr>
20.  
    <tr>
21.  
    <td>email</td>
22.  
    <td><input type="text" name="email" th:value="${employee.email}"></td>
23.  
    </tr>
24.  
    <tr>
25.  
    <td>gender</td>
26.  
    <td>
27.  
    <input type="radio" name="gender" value="男" th:field="#{employee.gender}" >男
28.  
    <input type="radio" name="gender" value="女" th:field="#{employee.gender}">女
29.  
    </td>
30.  
    </tr>
31.  
    <tr>
32.  
    <td colspan="2">
33.  
    <input type="submit" value="update">
34.  
    </td>
35.  
    </tr>
36.  
    </table>
37.  
    </form>
38.  
    </body>
39.  
    </html>

2.9、具体功能：执行更新

① 控制器方法

1.  
   @PutMapping("/employee")
2.  
   public String updateEmployee (Employee employee) {
3.  
   employeeDao.save(employee);
4.  
    
5.  
   return "redirect:/employee";
6.  
   }

这篇好文章是转载于：学新通技术网