Java進階之走進RESTful接口

Posted on 2021-05-20 by WalkonNet

一、什麼是API

API (應用程序編程接口) 兩種用法

1.類似jar的使用:A軟件將功能打包成組件(功能塊:比如java中的jar),讓B軟件導入直接使用

2.http請求方式:A項目(系統)提供一個映射方法路徑,B項目(系統)發起http請求得到對應功能 (應用請求方式)

應用接口:很多情況下,需要把系統的部分功能(組件)作為服務暴露給外部的其他應用使用,所以就需要把系統中的服務作為API接口暴露出去,一般分為公共接口和私用接口(公司內部)

二、瞭解Web技術的發展階段

靜態內容階段:Web 由大量的靜態 HTML 文檔組成
CGI程序階段：Web 服務器增加瞭一些編程 API，可以提供一些動態的內容
腳本語言階段:服務器端出現瞭 ASP、PHP、JSP、ColdFusion 等支持 session 的腳本語言技術,瀏覽器端出現瞭 Java Applet、JavaScript 等技術
瘦客戶端應用階段:服務器端出現瞭獨立於 Web 服務器的應用服務器。同時出現瞭 Web MVC 開發模式
RIA 應用階段:出現瞭多種 RIA（Rich Internet Application）技術,應用最為廣泛的 RIA 技術是 DHTML+Ajax
移動 Web 應用階段:出現瞭大量面向移動設備的 Web 應用開發技術 Android、iOS 、H5等

三、前後端分離模式

前後端分離,字面意思就是前端+後端分離,傳統的開發模式前後端耦合過高,不利於維護,一旦前後端任意一方換,不利於開發.

在這裡插入圖片描述

優點:

前後端責任分離,後端負責數據,前端負責頁面
提高工作效率,無需等待對方開發工作結束
增強代碼的可維護性
應對復雜的前端需求

四、RESTful風格

是一種規范,規范後端編寫的邏輯. REST是一種設計API的模式(風格),常用JSON數據格式(能被JS直接讀取) , REST隻是一種設計風格 , 而不是標準

五、restful規范與傳統規范的區別

傳統的請求映射方法(接口)設計考慮要點:

1.請求路徑 : /employee/list

2.請求方法:GET/POST

3.請求參數: employee對象

4.請求響應值: JsonResult對象

RESTful風格接口約束的要點:

1.請求路徑: 要求是操作資源(實體對象:domain)名稱復數 /employees

2.請求方式: 使用請求方式替換資源CRUD操作 :POST–新增 ,GET–查詢 ,DELETE–刪除 ,PUT–更新

3.請求參數:跟之前一樣,需求決定

4.請求響應值:跟之前一樣,需求決定,但是建議返回值都是json格式

六、RESTful設計

網絡上的所有事物都被抽象為資源

restful認為,每個資源都有自己唯一的資源定位符(URI),
  每個URI都代表瞭一種資源,以一張圖片為例:圖片有自己的路徑,
  所以圖片也是一種資源. 所以URI中不用動詞,隻用名詞.
  一般數據庫的表都是記錄同種的集合,所以為名詞為復數 
  這就是為什麼請求路徑中的操作資源要加 s ,
  可以不遵循這個規范(看自己喜歡或者公司規范)

資源狀態轉換

當我們訪問一個網站,必然代表客戶端和服務端間的互動,這種互動,會涉及資源間的狀態變化,HTTP協議，是一個無狀態協議,所以資源的狀態保存在服務器中,如果需要改變狀態,需要使用http方法去讓服務器資源發生改變.簡單的說就是,對應請求發生改變

新增 :從無到有
更新:從某個狀態變成另一個狀態
刪除 :從有到無

使用統一接口

REST要求，必須通過統一的接口來對資源執行各種操作

GET: 查詢全部list http://localhost:8080/employees
GET :查詢單個 http://localhost:8080/employees/1 (1是id參數值,同時也是請求路徑的一部分)
POST: http://localhost:8080/employees?新增的員工信息
PUT: http://localhost:8080/employees?id=1 更新 id為1的員工信息
DELETE: http://localhost:8080/employees?id=1 更新 id為2的員工信息
HEAD：獲得一個資源的元數據，比如一個資源的hash值或者最後修改日期
OPTIONS：獲得客戶端針對一個資源能夠實施的操作,獲取該資源的api

員工列表查詢與員工單個查詢,使用相同映射路徑" /employees 和相同請求方法:RequestMethod.GET,
導致請求路徑(路徑+請求方法)一樣,報錯

restful提供解決方案:使用參數路徑方法
    參數路徑:將參數作為請求路徑的一部分  /employee/{id}       
    還要加上註解@PathVariable,將id拿到
        
瀏覽器/postman發起請求時使用:
   http://localhost:8080/employee/1 其中1是id參數值,同時也是請求路徑的一部分
  另外,請求映射方法必須使用@PathVariable 進行參數讀取
      
 註意: 如果路徑參數標記與請求參數名不一致時 ,怎麼辦?
        可以使用@PathVariable("eid") value屬性指定

七、例子:

@Controller
public class EmployeeController {

    @RequestMapping(value = "employees",method = RequestMethod.GET)
    @ResponseBody
    public List<Employee> list(){
        List<Employee> employees = Arrays.asList(new Employee(1L, "小羅", 22), new Employee(2L, "小軒", 18));
        return  employees;
    }

    @RequestMapping(value = "employees/{id}",method = RequestMethod.GET)
    @ResponseBody
    public Employee get(@PathVariable Long id){
        List<Employee> employees = Arrays.asList(new Employee(1L, "xxx", 22), new Employee(2L, "qqq", 22));
        return employees.get((int) (id-1));
    }

    @RequestMapping(value = "employees",method = RequestMethod.POST)
    @ResponseBody
    public Employee save(Employee employee){
        employee.setId(1L);
        return employee ;
    }
    
    @RequestMapping(value = "employees",method = RequestMethod.DELETE)
    @ResponseBody
    public JsonResult delete(Long id){
        return new JsonResult(true,"刪除成功");

    }
    @RequestMapping(value = "employees",method = RequestMethod.PUT)
    @ResponseBody
    public JsonResult update(Long id){
        return new JsonResult(true,"更新成功");

    }
}

參數路徑方法與傳統方式對比

參數路徑方式:
   優點:可以隱藏參數,避免暴露參數,相對安全
   缺點:如果參數較多,url過長 不建議使用            
   參數較少選用參數路徑方法

同一資源具有多種表現形式

HTTP請求的頭信息中用Accept和Content-Type字段表現形式

Accept與Content-Type的區別

1.Accept屬於請求頭， Content-Type屬於實體頭。

2.Accept代表發送端（客戶端）希望接受的數據類型。Content-Type代表發送端（客戶端|服務器）發送的實體數據的數據類型。

Accept：application/json :代表客戶端希望接受得數據類型是json類型,後臺返回json數據
Content-Type：application/json:代表發送端發送數據格式是json,後臺要以這種格式類接收前端的數據

八、使用Ajax發送請求

刪除,更新操作
    $.ajax({
        url:  路徑   ,
        type:  類型  ,
        data: 參數{id:111},
        success:(回調函數)function(data){
            
        }
    })

<script>
        $(function () {
    		//查全部
            $("#btn1").click(function () {
                $.get("/employees" ,function (data) {
                    console.log(data);
                })
            });
			//查單個
            $("#btn2").click(function () {
                $.get("/employees/1" ,function (data) {
                    console.log(data);
                })
            });

			//新增
            $("#btn4").click(function () {
                $.post("/employees" ,{name:"xiao",age:18},function (data) {
                    console.log(data);
                })
            });
			//刪除
            $("#btn3").click(function () {
                $.ajax({
                    url:"/employees",
                    type: "DELETE",
                    data:{id:1},
                    success:function (data) {
                        console.log(data);
                    }
                })
            });

			//更新
            $("#btn5").click(function () {
                $.ajax({
                    url:"/employees",
                    type: "PUT",
                    data:{id:1},
                    success:function (data) {
                        console.log(data);
                    }
                })
            })
        })
    </script>

springMVC默認不支持put請求,需要額外處理put或patch請求方式的過濾器,Springboot支持

<filter>
	<filter-name>httpPutFormContentFilter</filter-name>
	<filter-class>org.springframework.web.filter.HttpPutFormContentFilter</filter-class>
</filter>

<filter-mapping>
	<filter-name>httpPutFormContentFilter</filter-name>
	<servlet-name>springMVC</servlet-name>
</filter-mapping>

九、相關註解

@GetMapper、@PostMapping、@DeleteMapping、@PutMapping

等價於 method =RequestMethod.GET|POST|DELETE|PUT

@RestController

等價於 @Controller +@ResponseBody

@PathVariable

通過 @PathVariable 可以將 URL 中占位符參數綁定到控制器處理方法參數中

URL 中的 {xxx} 占位符可以通過@PathVariable(“xxx“) 綁定到操作方法的參數中。

@RequestMapping標簽屬性

params :要求請求中必須攜帶指定名稱的參數    
          params="name" :必須攜帶name參數
          params="name=xuan" :必須攜帶name參數,並且name=xuan 
    
 headers :請求頭，限定要處理請求的請求頭信息，隻有匹配才會被方法處理
    
consume :等價於Content-Type  
value/path：映射路徑
method：限定請求的方式

優化RESTful規范的例子代碼

@RestController
@RequestMapping("employees")
public class EmployeeController {

    @GetMapping
    public List<Employee> list(){
        List<Employee> employees = Arrays.asList(new Employee(1L, "小羅", 22), new Employee(2L, "小軒", 18));
        return  employees;
    }

    @GetMapping(value = "/{id}")
    public Employee get(@PathVariable Long id){
        List<Employee> employees = Arrays.asList(new Employee(1L, "xxx", 22), new Employee(2L, "qqq", 22));
        return employees.get((int) (id-1));
    }

    @PostMapping
    public Employee save(Employee employee){
        employee.setId(1L);
        return employee ;
    }

    @DeleteMapping
    public JsonResult delete(Long id){
        return new JsonResult(true,"刪除成功");
    }

    @PutMapping
    public JsonResult update(Long id){
        return new JsonResult(true,"更新成功");
    }
}

API接口測試工具

Postman, Insomnia

RESTful開發框架

常見的有 SpringMVC , jersey , play

到此這篇關於Java進階之走進RESTful的文章就介紹到這瞭,更多相關Java RESTful內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

Java進階之走進RESTful接口

一、什麼是API

二、瞭解Web技術的發展階段

三、前後端分離模式

四、RESTful風格

五、restful規范與傳統規范的區別

六、RESTful設計

七、例子:

八、使用Ajax發送請求

九、相關註解

推薦閱讀：

發佈留言取消回覆

近期文章

一、什麼是API

二、瞭解Web技術的發展階段

三、前後端分離模式

四、RESTful風格

五、restful規范與傳統規范的區別

六、RESTful設計

七、例子:

八、使用Ajax發送請求

九、相關註解

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆