SpringMVC使用RESTful接口案例詳解

更新時間：2022年11月08日 08:45:37 作者：學(xué)習(xí)使我快樂T

RESTful是一種web軟件風(fēng)格，它不是標(biāo)準(zhǔn)也不是協(xié)議，它不一定要采用,只是一種風(fēng)格，它倡導(dǎo)的是一個資源定位(url)及資源操作的風(fēng)格，這篇文章主要介紹了SpringBoot使用RESTful接口

一、準(zhǔn)備工作

和傳統(tǒng) CRUD 一樣，實(shí)現(xiàn)對員工信息的增刪改查。

①搭建環(huán)境

添加相關(guān)依賴

web.xml

springmvc.xml

②準(zhǔn)備實(shí)體類

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

③準(zhǔn)備dao模擬數(shù)據(jù)

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

二、功能清單

功能 URL地址請求方式

訪問首頁√ / GET

查詢?nèi)繑?shù)據(jù)√ / employee GET

刪除√ / employee/2 DELETE

跳轉(zhuǎn)到添加數(shù)據(jù)頁面√ / toAdd GET

執(zhí)行保存√ / employee POST

跳轉(zhuǎn)到更新數(shù)據(jù)頁面√ / employee/2 GET

執(zhí)行更新√ / employee PUT

三、具體功能-訪問首頁

查詢所有員工信息-->/employee-->get

跳轉(zhuǎn)到添加頁面-->/to/add-->get

新增員工信息-->/employee-->post

跳轉(zhuǎn)到修改頁面-->/employee/1-->get

修改員工信息-->/employee-->put

刪除員工信息-->/employee--delete

配置默認(rèn)的servlet處理靜態(tài)資源

當(dāng)前工程的web.xml配置的前端控制器DispatcherServlet的url-pattern是/

tomcat的web.xml配置的DefaultServlet的url-pattern也是/

此時，瀏覽器發(fā)送的請求會優(yōu)先被DispatcherServlet進(jìn)行處理，但是DispatcherServlet無法處理靜態(tài)資源

若配置了<mvc:default-servlet-handler/>，此時瀏覽器發(fā)送的所有請求都會被DefaultServlet處理

若配置了<mvc:default-servlet-handler/>和<mvc:annotation-driven />

瀏覽器發(fā)送的請求會先被DispatcherServlet處理，無法處理再交給DefaultServlet處理

web.xml

    <!--配置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>
    <!-- 配置SpringMVC的前端控制器，對瀏覽器發(fā)送的請求統(tǒng)一進(jìn)行處理 -->
    <servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 通過初始化參數(shù)指定SpringMVC配置文件的位置和名稱 -->
        <init-param>
            <!-- contextConfigLocation為固定值 -->
            <param-name>contextConfigLocation</param-name>
            <!-- 使用classpath:表示從類路徑查找配置文件，例如maven工程中的
            src/main/resources -->
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <!--
        作為框架的核心組件，在啟動過程中有大量的初始化操作要做
        而這些操作放在第一次請求時才執(zhí)行會嚴(yán)重影響訪問速度
        因此需要通過此標(biāo)簽將啟動控制DispatcherServlet的初始化時間提前到服務(wù)器啟動時
        -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <!--
        設(shè)置springMVC的核心控制器所能處理的請求的請求路徑
        /所匹配的請求可以是/login或.html或.js或.css方式的請求路徑
        但是/不能匹配.jsp請求路徑的請求
        -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    <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.xml

<!-- 自動掃描包 -->
    <context:component-scan base-package="com.atguigu"/>
    <!-- 配置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>
    <!--
        配置默認(rèn)的servlet處理靜態(tài)資源
        當(dāng)前工程的web.xml配置的前端控DispatcherServlet的url - pattern是/
        tomcat的web.xml配置的DefaultServlet的url-pattern也是/
        此時，瀏時器發(fā)送的請求會優(yōu)先DispatcherServlet進(jìn)行處理，但是DispatcherServlet無法處理靜態(tài)資源
        若配置了<mvc:default-servlet-handler />,此時瀏覽器發(fā)送的所有請求都會越DispatcherServlet處理
        若配置了<mvc:default-servlet-handler />和<mvc:annotation-driven />
        瀏覽器發(fā)送的請求會先被DispatcherServlet.處理，無法處理在交給DefaultServlet處理
    -->
<!--    <mvc:default-servlet-handler></mvc:default-servlet-handler>-->
    <mvc:default-servlet-handler />
    <mvc:annotation-driven />
    <!--
        path：設(shè)置處理的請求地址
        view-name：設(shè)置請求地址所對應(yīng)的視圖名稱
    -->
    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <mvc:view-controller path="/to/add" view-name="employee_add"></mvc:view-controller>

employee_add.html

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

employee_list.html

<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="@{/to/add}" rel="external nofollow" >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}}" rel="external nofollow"  rel="external nofollow" >delete</a>
            <a th:href="@{'/employee/'+${employee.id}}" rel="external nofollow"  rel="external nofollow" >update</a>
        </td>
    </tr>
</table>
<!-- 作用：通過超鏈接控制表單的提交，將post請求轉(zhuǎn)換為delete請求 -->
<form id="delete_form" method="post">
    <!-- HiddenHttpMethodFilter要求：必須傳輸_method請求參數(shù)，并且值為最終的請求方式 -->
    <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: {
            //event表示當(dāng)前事件
            deleteEmployee: function (event) {
                //通過id獲取表單標(biāo)簽
                var delete_form = document.getElementById("delete_form");
                //將觸發(fā)事件的超鏈接的href屬性為表單的action屬性賦值
                delete_form.action = event.target.href;
                //提交表單
                delete_form.submit();
                //阻止超鏈接的默認(rèn)跳轉(zhuǎn)行為
                event.preventDefault();
            }
        }
    });
</script>

employee_update.html

<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}"可用于單選框或復(fù)選框的回顯
        </body>
        </html>
        若單選框的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>

index.html

<h1>index.html</h1>
<a th:href="@{/user}" rel="external nofollow" >查詢所有的用戶信息</a><br>
<a th:href="@{/user/1}" rel="external nofollow" >查詢用戶id為1的信息</a><br>
<form th:action="@{/user}" method="post">
    <input type="submit" value="添加用戶信息">
</form>
<form th:action="@{/user}" method="post">
    <input type="hidden" name="_method" value="put">
    <input type="submit" value="修改用戶信息">
</form>
<form th:action="@{/user/5}" method="post">
    <input type="hidden" name="_method" value="delete">
    <input type="submit" value="刪除用戶信息">
</form>
<hr>
<a th:href="@{/employee}" rel="external nofollow" >查詢所有的員工信息</a><br>

控制器方法

@Controller
public class EmployeeController {
    @Autowired
    private EmployeeDao employeeDao;
    @RequestMapping(value = "/employee", method = RequestMethod.GET)
    public String getAllEmployee(Model model) {
        Collection<Employee> employeeList = employeeDao.getAll();
        model.addAttribute("employeeList", employeeList);
        return "employee_list";
    }
    @RequestMapping(value = "/employee", method = RequestMethod.POST)
    public String addEmployee(Employee employee) {
        employeeDao.save(employee);
        return "redirect:/employee";
    }
    @RequestMapping(value = "/employee/{id}", method = RequestMethod.GET)
    public String toUpdate(@PathVariable("id") Integer id, Model model) {
        Employee employee = employeeDao.get(id);
        model.addAttribute("employee", employee);
        return "employee_update";
    }
    @RequestMapping(value = "/employee", method = RequestMethod.PUT)
    public String updateEmployee(Employee employee) {
        employeeDao.save(employee);
        return "redirect:/employee";
    }
    @RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
    public String deleteEmployee(@PathVariable("id") Integer id) {
        employeeDao.delete(id);
        return "redirect:/employee";
    }
}

到此這篇關(guān)于SpringMVC使用RESTful接口案例詳解的文章就介紹到這了,更多相關(guān)SpringMVC RESTful內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: