Restful风格-Toy模板网

这篇具有很好参考价值的文章主要介绍了Restful风格。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

实现对员工信息增删改查

准备工作

第一步: 创建Maven工程然后手动添加web模块

第二步: 在pom.xml文件中指定Maven工程的打包方式war

第三步: 引入依赖,由于Maven的传递性,我们不必将所有需要的包全部配置依赖,只需要配置最顶端的依赖,其他依赖靠传递性导入

<?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>com.atguigu</groupId>
    <artifactId>spring_mvc_rest</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
    <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>
</project>

第四步: 在web.xml文件中配置SpringMVC的前端控制器DispatcherServlet,配置编码过滤器,配置HiddenHttpMethodFilter

<?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">
    <!--配置编码过滤器-->
    <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>forceResponseEncoding</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>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

第五步: 创建springMVC的配置文件,扫描所有组件,配置Thymeleaf视图解析器,配置视图控制器(开启MVC注解驱动),配置静态资源映射

<?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/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--扫描组件,这里需要包括Controller层和Dao层的组件-->
    <context:component-scan base-package="com.atguigu.rest"></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>
    <!--配置视图控制器-->
    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <mvc:view-controller path="/toAdd" view-name="employee_add"></mvc:view-controller>
    <!--设置所有的请求由默认的DefaultServlet处理,此时前端控制器就不能处理请求了-->
    <mvc:default-servlet-handler />
    <!--开启mvc注解驱动,当处理访问静态资源的请求时先由前端控制器处理,如果找不到请求映射的控制器方法就交由默认的DefaultServlet处理-->
    <mvc:annotation-driven />
</beans>

数据准备

第一步: 准备实体类封装查询到的数据

public class Employee {
   private Integer id;
   private String lastName;
   private String email;
   //1 male, 0 female
   private Integer gender;
   //getter和setter方法
   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));
   }
   // 设置添加员工时Id的初始化值 
   private static Integer initId = 1006;
   // 添加和修改员工信息
   public void save(Employee employee){
      // 判断员工信息中是否包含Id,如果有表示需要修改员工信息,没有表示需要添加员工
      if(employee.getId() == null){
         employee.setId(initId++);
      }
      // 对于修改员工信息,如果Map集合中的key重复时value会覆盖 
      employees.put(employee.getId(), employee);
   }
   // 查询所有员工信息
   public Collection<Employee> getAll(){
      return employees.values();
   }
   // 根据id查询某个员工信息
   public Employee get(Integer id){
      return employees.get(id);
   }
   // 根据id删除某个员工信息
   public void delete(Integer id){
      employees.remove(id);
   }
}

编写控制器方法

创建处理员工业务相关的请求控制器类EmployeeController

@Controller
public class EmployeeController {
    // 自动注入Dao层组件
    @Autowired
    private EmployeeDao employeeDao;
    //编写控制器方法
}

功能	URL 地址	请求方式
访问首页	/	GET
查询所有员工信息	/employee	GET
根据Id删除员工	/employee/2	DELETE
跳转到添加员工信息的页面	/toAdd	GET
新增员工	/employee	POST
跳转到修改员工信息的页面,修改前需要先把员工原本的信息查询出来	/employee/2	GET
修改员工信息	/employee	PUT

访问首页功能

第一步: 创建首页面index.html

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

第二步: 在SpringMVC配置文件中使用view-controller标签配置视图控制器跳转到首页

<mvc:view-controller path="/" view-name="index"/>
<!--开启mvc注解驱动-->
<mvc:annotation-driven />

查询所有员工并展示

第一步: 在首页点击查询查询员工所有信息的链接

<a th:href="@{/employee}">查询所有员工的信息</a>

第二步: 编写控制器方法负责查询所有的员工信息并跳转到员工列表页面展示查询到的数据

//@RequestMapping(value = "/employee", method = RequestMethod.GET)
@GetMapping("/employee")
public String getEmployeeList(Model model){
    // 获取所有的员工信息
    Collection<Employee> employeeList = employeeDao.getAll();
    // 使用model的方式将获取的员工信息添加到请求域共享
    model.addAttribute("employeeList", employeeList);
    // 返回视图名称,跳转到员工列表页面
    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>
    <link rel="stylesheet" th:href="@{/static/css/index_work.css}">
    <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>
        <!--th:each属性用于循环生成tr,先取出请求域中包含员工信息的集合,然后依次遍历集合中的每一个元素-->
        <!--th:text指定标签的文本内容-->
        <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>
                "@{'/employee/'+${employee.id}}"或"@{/employee/}+${employee.id}}"
                <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>

添加员工

第一步: 用户点击employee_list.html页面中的add超链接会发起GET请求,然后跳转到添加员工信息的页面employee_add.html

<tr>
    <th>id</th>
    <th>lastName</th>
    <th>email</th>
    <th>gender</th>
    <!--添加员工-->
    <th>options(<a th:href="@{/toAdd}">add</a>)</th>
</tr>

第二步: 在SpringMVC配置文件中使用view-controller标签配置视图控制器跳转到employee_add.html页面

<!--跳转到employee_add.html页面-->
<mvc:view-controller path="/toAdd" view-name="employee_add"></mvc:view-controller>
<!--开启mvc注解驱动-->
<mvc:annotation-driven />

第三步: 创建employee_add.html页面保存要添加员工的信息且不含有员工Id,最后发起POST请求提交员工信息

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Add Employee</title>
        <link rel="stylesheet" th:href="@{/static/css/index_work.css}">
    </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>

第四步: 用户点击employee_add.html页面上的add表单提交按钮,执行添加员工的控制器方法

//@RequestMapping(value = "/employee", method = RequestMethod.POST)
@PostMapping("/employee")
public String addEmployee(Employee employee){
    employeeDao.save(employee);
    // 添加完员工后需要重定向到查询所有员工功能的请求,因为员工数据有变化需要重新查询并渲染
    // 重定向的目的就是为了刷新地址栏,防止用户一直刷新添加员工的请求
    return "redirect:/employee";
}

修改员工信息

第一步: 用户点击employee_list.html页面中的update超链接会发起GET请求

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

第二步: 编写控制器方法负责根据员工Id查询员工信息并跳转到修改员工信息的页面展示查询到的数据

//@RequestMapping(value = "/employee/{id}", method = RequestMethod.GET)
@GetMapping("/employee/{id}")
public String getEmployeeById(@PathVariable("id") Integer id, Model model){
    // 查询要修改的员工信息并存放到请求域中
    Employee employee = employeeDao.get(id);
    model.addAttribute("employee", employee);
    // 跳转到修改员工信息的页面employee_update.html
    return "employee_update";
}

第三步: 创建employee_update.html页面,将请求域中查询到的要修改的员工信息展示出来并且员工Id会隐藏起来不显示

在HTML中只要使用了Thymeleaf语法,如@{}和${},那么对应的属性就需要使用th命名空间修饰,这样Thymeleaf视图解析器才会知道对哪个标签解析

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Update Employee</title>
         <link rel="stylesheet" th:href="@{/static/css/index_work.css}">
    </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>
            <!--如果${}中的值等于单选框或复选框的value值,此时就会被选中即添加添加`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>

第三步: 用户点击employee_update.html页面中update表单的提交按钮后,执行修改员工信息的控制器方法

//@RequestMapping(value = "/employee", method = RequestMethod.PUT)
@PutMapping("/employee")
public String updateEmployee(Employee employee){
    // 保存修改后的员工信息(包含员工Id)
    employeeDao.save(employee);
    // 修改完员工信息后需要重定向到查询所有员工功能的请求,因为员工数据有变化需要重新查询并渲染
    // 重定向的目的就是为了刷新地址栏,防止用户一直刷新添加员工的请求
    return "redirect:/employee";
}

根据Id删除员工

第一步: 因为用户点击delete按钮是个超链接只能发起GET请求,所以我们需要通过点击超链接执行点击事件deleteEmployee控制表单的提交

因为删除是个危险的操作,我们还可以在控制表单提交前提示用户是否确定删除

<div id="app">
    <!-- 通过点击超链接控制表单的提交,然后将POST请求转换为DELETE请求-->
    <a @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">delete</a>
    <form id="deleteForm" method="post">
        <input type="hidden" name="_method" value="delete">
    </form>
</div>
<!--引入vue.js本质就是发起请求访问一个静态资源-->
<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
<!--使用vue处理点击事件-->
<script type="text/javascript">
    var vue = new Vue({
        el:"#app",
        methods:{
            deleteEmployee:function (event) {// event表示当前事件
                // 通过标签的id获取表单标签
                var delete_form = document.getElementById("deleteForm");
                // 将触发点击事件元素即超链接的href属性赋值给form表单的action属性
                delete_form.action = event.target.href;
                // 提交表单
                delete_form.submit();
                // 阻止超链接默认的跳转行为
                event.preventDefault();
            }
        }
    });
</script>

第二步: 编写控制器方法根据Id删除对应的员工文章来源地址https://www.toymoban.com/news/detail-469115.html

//@RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
@DeleteMapping("/employee/{id}")
public String deleteEmployee(@PathVariable("id") Integer id){
    // 根据Id删除对于的员工
    employeeDao.delete(id);
    // 删除完员工后需要重定向到查询所有员工功能的请求,因为员工数据有变化需要重新查询并渲染
    // 重定向的目的就是为了刷新地址栏,防止用户一直刷新添加员工的请求
    return "redirect:/employee";
}