SpringBoot RESTful風格入門講解

Posted on by

1、Restful簡介

Restful比較熱門，，Spring的微服務是基於Restful風格搭建的框架。

Restful有一下幾個特點：

  • 使用URL描述資源。
  • 使用HTTP方法描述行為，使用HTTP狀態碼來表示不同的結果。
  • 使用JSON交互數據。
  • Restful隻是一種風格，不是強制標準。

2、查詢用戶以及用戶詳情

最簡單的，最常用的GET請求，用於查詢全部數據或者其中一條數據的詳情。

2.1常用註解

常用註解 作用
@RestController 表明此tController 提供的是Restful服務
@RequestMapping 將URL映射到Java
@RequestParam 映射請求參數到Java上的參數
@PageableDefault 指定分頁參數的默認值

2.2查詢用戶詳情

@RequestMapping(value="/manage", method= {RequestMethod.GET})
	public String list(String userId,Map<String,Object> map) {
		if(userId==""||userId==null) {
			map.put("userList", userService.getUserList());
		}else {
			map.put("userList",userService.getUserById(Integer.parseInt(userId)));
		}
		return "user/list";
	}

3、處理創建請求

3.1@RequestBody註解

3.1.1用途

用於接收前端傳遞給後端的json字符串中的數據。（處理json格式的數據）

@RequestBody用來接收前端傳遞給後端的json字符串中的數據，GET方式的請求一般通過URL中攜帶key-value參數，而@RequestBody接收的是請求體中的數據（json格式的數據，隻有請求體中能保存json），所以使用@RequestBody接收數據的時候必須是POST方式等方式。

@RequestBody與@RequestParam()可以同時使用，但@RequestBody最多隻能有一個，而@RequestParam()可以多個。

3.1.2語法規范

(@RequestBody Map map)
(@RequestBody Object object)

(@RequestBody Map map)先對簡單，將json解析成Map形式的key-value對，直接通過map.get(“KeyName”)就能拿到值瞭

(@RequestBody Object object) 通過json字符串中的key來匹配對應實體類的屬性如果匹配一致且json中的該key對應的值符合實體類的對應屬性的類型要求時,會調用實體類的setter方法將值註入到該屬性。

例如

public Result deleteBookById(@RequestBody HashMap<String, String> map) {
        this.bookService.deleteBookById(Long.parseLong(map.get("id")));
        return Result.createWithSuccessMessage();
    }
public Result updateBookById(@RequestBody Book book){
        Book record = this.bookService.updateBookById(book);
        return Result.createWithModel(record);
    }

註意：

在(@RequestBody Object object)中，前端POST過來的數據會通過反序列數據到實體類中，並且在反序列的過程中會進行類型的轉換。

在json中應該用null來代表空值，如果是"“(空字符串)會判斷為空串，如果實體類屬性是String類型的，那麼接受到的就是”"，如果實現類屬性類型是Integer、Double等類型，那麼接收到的就是null。

{
	name:"",
	age:null
}

(@RequestBody Object object)內部是通過傳遞過來的數據中的Key尋找setter方法，有則調用，無則不作任何操作（其實可以設計）。

如果通過Key匹配到setter方法，但是Value無法轉換為對應的實例類屬性的類型時，拋出異常。

3.2日期類型的處理

前端傳入日期格式： yyyy-MM-dd HH:mm:ss，例如：2018-07-09 12:55:12（不使用時間戳，前後雙方聯調時查看起來更加友好）

後端返回日期格式： yyyy-MM-dd HH:mm:ss，例如：2018-07-09 12:55:12（不使用時間戳，前後雙方聯調時查看起來更加友好）

後端json序列化、反序列化框架： 定義任何一種高效的json工具都行，例如：Fastjson、Gson、Jackson lib

序列化、反序列化日期格式規范： pattern=”yyyy-MM-dd HH:mm:ss”,timezone = “GMT+8”，除特出場景可以使用pattern=”yyyy-MM-dd”,timezone = “GMT+8”

不要隨意自定義convert處理日期格式以及其他特殊格式轉換，應該交由基礎框架組或架構組統一在框架層面解決，對業務開發透明，或者在有些小公司由Leader或高開來擔當。

3.3BindingResult

	/*
     * 添加用戶，使用@RequestBody將請求體映射到Action方法參數中
     * 使用@Valid註解驗證請求參數的合法性
     * 使用BindingResult處理校驗結果
     * @param user
     * @param result
     * @return
     */
      @PostMapping("/user")
      public User create(@Valid @RequestBody User user, BindingResult result){
         if(result.hasErrors()){
             result.getAllErrors().stream().forEach(error -> {
                 FieldError fieldError = (FieldError)error;
                 String message = fieldError.getField() + " " + error.getDefaultMessage();
                 System.out.println(message);
             });
             return null;
         }
         System.out.println(user.toString());
         user.setId(5l);
         return user;
     }

4、用戶信息修改與刪除

PUT和DELETE並不復雜，大傢也熟悉，用於對後臺數據的更新和刪除。

4.1用戶信息修改

對資源更新的請求方法通常是是PUT，但有時候也可能是POST。那麼問題來瞭，都是更新資源區別在哪裡？

PUT POST
在HTTP中PUT被定義為冪等的請求方法 而POST則不是
操作是作用於一個具體資源之上 作用於一個集合資源之上
URL在客戶端確定使用PUT URL在服務端確定使用POST

比較直觀的是資源URL的不同

4.2案例

前端界面

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script src="../js/jquery.min.js"></script>
    <script>
        $(function () {
            // 查詢所有
            $('#btn1').click(function () {
                $.get('/employees', function (data) {
                    console.log(data);
                });
            });
            // 查詢一個
            $('#btn2').click(function () {
                $.get('/employees/10', function (data) {
                    console.log(data);
                });
            });
            // 添加
            $('#btn3').click(function () {
                $.post('/employees', "id=11", function (data) {
                    console.log(data);
                });
            });
            // 修改
            $('#btn4').click(function () {
                $.ajax({
                    url: "/employees",
                    type: "PUT",
                    data: {id: 1, name: "小肥羊", age: 10},
                    success: function (data) {
                        console.log(data);
                    }
                });
            });
            // 刪除
            $('#btn5').click(function () {
                $.ajax({
                    url: "/employees/13",
                    type: "DELETE",
                    data: {id: 1},
                    success: function (data) {
                        console.log(data);
                    }
                });
            });

        });
    </script>
</head>
<body>
<button id="btn1">查詢所有</button>
<button id="btn2">查詢一個</button>
<button id="btn3">添加</button>
<button id="btn4">修改</button>
<button id="btn5">刪除</button>
</body>
</html>

後端控制器

package com.yy.web.controller;
import com.yy.domain.Employee;
import com.yy.util.JsonResult;
import org.springframework.stereotype.Controller;
import org.springframework.stereotype.Repository;
import org.springframework.web.bind.annotation.*;
import java.util.Arrays;
import java.util.List;
/**
 * @program: restful-demo
 * @ClassName: EmployeeController
 * @description:
 * @author: YanYang
 * @create: 2021-06-23 15:04
 **/
@RestController
@RequestMapping("employees")
public class EmployeeController {
    /**
     * 2個接口設計都是用相同資源，相同請求方法，此時 SpringMVC 無法識別，
     * 認為是同一方法，報錯：Ambiguous mapping. [模糊映射]
     *
     * RESTful 解決方案：使用 參數路徑 方式
     *      具體實現：將參數作為請求映射路徑一部分，[參與映射路徑區分]
     *      比如：查詢指定 id 的員工信息接口設計
     *      @RequestMapping(value = "/employees/{id}", method = RequestMethod.GET)
     *      其中 "/employees/{id}" 參數路徑，{id} 就是路徑參數
     *
     *      訪問該接口時：http:localhost:8080/employees/1  其中 1 是 id 參數
     *      接口接收路徑參數：使用 @PathVariable，表示將參數路徑上的參數解析，並賦值給指定變量
     *      如果路徑參數與變量名不一致，使用 @PathVariable("eid")明確指定
     *
     */
    // 查詢所有（數據是模擬的）
//    @RequestMapping(value = "/employees", method = RequestMethod.GET)
    @GetMapping
    public List<Employee> list() {
        return Arrays.asList(new Employee(1L,"小肥羊", 10), new Employee(2L, "熊大", 11));
    }
    // 查詢單個（數據是模擬的）
//    @RequestMapping(value = "/employees/{id}", method = RequestMethod.GET)
    @GetMapping("/{eid}")
    public Employee queryById(@PathVariable("eid") Long id) {
        System.out.println("查詢單個 = " + id);
        return new Employee(3L, "熊二", 8);
    }
    // 添加（數據是模擬的）
//    @RequestMapping(value = "/employees", method = RequestMethod.POST)
    @PostMapping
    public Employee add(@ModelAttribute("employee") Employee employee) {
        System.out.println("添加 = " + employee.getId());
        return employee;
    }
    // 修改（數據是模擬的）
//    @RequestMapping(value = "/employees", method = RequestMethod.PUT)
    @PutMapping
    public Employee update(@ModelAttribute("employee") Employee employee) {
        System.out.println("修改 = " + employee.getId());
        employee.setId(employee.getId());
        employee.setName(employee.getName());
        employee.setAge(employee.getAge());
        return employee;
    }
    // 刪除（數據是模擬的）
//    @RequestMapping(value = "/employees/{id}", method = RequestMethod.DELETE)
    @DeleteMapping("/{id}")
    public String delete(@PathVariable Long id) {
        System.out.println("刪除 = " + id);
        if (id != null && 1 == id) {
            return "刪除成功";
        }
        return "刪除失敗";
    }
}

到此這篇關於SpringBoot RESTful接口入門講解的文章就介紹到這瞭,更多相關SpringBoot RESTful內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：