Java進階之走進RESTful接口
一、什么是API
API (應(yīng)用程序編程接口) 兩種用法
1.類似jar的使用:A軟件將功能打包成組件(功能塊:比如java中的jar),讓B軟件導(dǎo)入直接使用
2.http請求方式:A項目(系統(tǒng))提供一個映射方法路徑,B項目(系統(tǒng))發(fā)起http請求得到對應(yīng)功能 (應(yīng)用請求方式)
應(yīng)用接口:很多情況下,需要把系統(tǒng)的部分功能(組件)作為服務(wù)暴露給外部的其他應(yīng)用使用,所以就需要把系統(tǒng)中的服務(wù)作為API接口暴露出去,一般分為公共接口和私用接口(公司內(nèi)部)
二、了解Web技術(shù)的發(fā)展階段
- 靜態(tài)內(nèi)容階段:Web 由大量的靜態(tài) HTML 文檔組成
- CGI程序階段:Web 服務(wù)器增加了一些編程 API,可以提供一些動態(tài)的內(nèi)容
- 腳本語言階段:服務(wù)器端出現(xiàn)了 ASP、PHP、JSP、ColdFusion 等支持 session 的腳本語言技術(shù),瀏覽器端出現(xiàn)了 Java Applet、JavaScript 等技術(shù)
- 瘦客戶端應(yīng)用階段:服務(wù)器端出現(xiàn)了獨立于 Web 服務(wù)器的應(yīng)用服務(wù)器。同時出現(xiàn)了 Web MVC 開發(fā)模式
- RIA 應(yīng)用階段:出現(xiàn)了多種 RIA(Rich Internet Application)技術(shù),應(yīng)用最為廣泛的 RIA 技術(shù)是 DHTML+Ajax
- 移動 Web 應(yīng)用階段:出現(xiàn)了大量面向移動設(shè)備的 Web 應(yīng)用開發(fā)技術(shù) Android、iOS 、H5等
三、前后端分離模式
前后端分離,字面意思就是 前端+后端分離,傳統(tǒng)的開發(fā)模式前后端耦合過高,不利于維護,一旦前后端任意一方換,不利于開發(fā).
優(yōu)點:
- 前后端責(zé)任分離,后端負責(zé)數(shù)據(jù),前端負責(zé)頁面
- 提高工作效率,無需等待對方開發(fā)工作結(jié)束
- 增強代碼的可維護性
- 應(yīng)對復(fù)雜的前端需求
四、RESTful風(fēng)格
是一種規(guī)范,規(guī)范后端編寫的邏輯. REST是一種設(shè)計API的模式(風(fēng)格),常用JSON數(shù)據(jù)格式(能被JS直接讀取) , REST只是一種設(shè)計風(fēng)格 , 而不是標(biāo)準(zhǔn)
五、restful規(guī)范與傳統(tǒng)規(guī)范的區(qū)別
傳統(tǒng)的請求映射方法(接口)設(shè)計考慮要點:
1.請求路徑 : /employee/list
2.請求方法:GET/POST
3.請求參數(shù): employee對象
4.請求響應(yīng)值: JsonResult對象
RESTful風(fēng)格接口約束的要點:
1.請求路徑: 要求是操作資源(實體對象:domain)名稱復(fù)數(shù) /employees
2.請求方式: 使用請求方式替換資源CRUD操作 :POST–新增 ,GET–查詢 ,DELETE–刪除 ,PUT–更新
3.請求參數(shù):跟之前一樣,需求決定
4.請求響應(yīng)值:跟之前一樣,需求決定,但是建議返回值都是json格式
六、RESTful設(shè)計
網(wǎng)絡(luò)上的所有事物都被抽象為資源
restful認為,每個資源都有自己唯一的資源定位符(URI), 每個URI都代表了一種資源,以一張圖片為例:圖片有自己的路徑, 所以圖片也是一種資源. 所以URI中不用動詞,只用名詞. 一般數(shù)據(jù)庫的表都是記錄同種的集合,所以為名詞為復(fù)數(shù) 這就是為什么請求路徑中的操作資源要加 s , 可以不遵循這個規(guī)范(看自己喜歡或者公司規(guī)范)
資源狀態(tài)轉(zhuǎn)換
當(dāng)我們訪問一個網(wǎng)站,必然代表客戶端和服務(wù)端間的互動,這種互動,會涉及資源間的狀態(tài)變化,HTTP協(xié)議,是一個無狀態(tài)協(xié)議,所以資源的狀態(tài)保存在服務(wù)器中,如果需要改變狀態(tài),需要使用http方法去讓服務(wù)器資源發(fā)生改變.簡單的說就是,對應(yīng)請求發(fā)生改變
新增 :從無到有 更新:從某個狀態(tài)變成另一個狀態(tài) 刪除 :從有到無
使用統(tǒng)一接口
REST要求,必須通過統(tǒng)一的接口來對資源執(zhí)行各種操作
- GET: 查詢?nèi)縧ist http://localhost:8080/employees
- GET :查詢單個 http://localhost:8080/employees/1 (1是id參數(shù)值,同時也是請求路徑的一部分)
- POST: http://localhost:8080/employees?新增的員工信息
- PUT: http://localhost:8080/employees?id=1 更新 id為1的員工信息
- DELETE: http://localhost:8080/employees?id=1 更新 id為2的員工信息
- HEAD:獲得一個資源的元數(shù)據(jù),比如一個資源的hash值或者最后修改日期
- OPTIONS:獲得客戶端針對一個資源能夠?qū)嵤┑牟僮?獲取該資源的api
員工列表查詢與員工單個查詢,使用相同映射路徑" /employees 和相同請求方法:RequestMethod.GET, 導(dǎo)致請求路徑(路徑+請求方法)一樣,報錯 restful提供解決方案:使用參數(shù)路徑方法 參數(shù)路徑:將參數(shù)作為請求路徑的一部分 /employee/{id} 還要加上注解@PathVariable,將id拿到 瀏覽器/postman發(fā)起請求時使用: http://localhost:8080/employee/1 其中1是id參數(shù)值,同時也是請求路徑的一部分 另外,請求映射方法必須使用@PathVariable 進行參數(shù)讀取 注意: 如果路徑參數(shù)標(biāo)記與請求參數(shù)名不一致時 ,怎么辦? 可以使用@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,"更新成功"); } }
參數(shù)路徑方法與傳統(tǒng)方式對比
參數(shù)路徑方式: 優(yōu)點:可以隱藏參數(shù),避免暴露參數(shù),相對安全 缺點:如果參數(shù)較多,url過長 不建議使用 參數(shù)較少選用參數(shù)路徑方法
同一資源具有多種表現(xiàn)形式
HTTP請求的頭信息中用Accept和Content-Type字段表現(xiàn)形式
Accept與Content-Type的區(qū)別
1.Accept屬于請求頭, Content-Type屬于實體頭。
2.Accept代表發(fā)送端(客戶端)希望接受的數(shù)據(jù)類型。Content-Type代表發(fā)送端(客戶端|服務(wù)器)發(fā)送的實體數(shù)據(jù)的數(shù)據(jù)類型。
Accept:application/json :代表客戶端希望接受得數(shù)據(jù)類型是json類型,后臺返回json數(shù)據(jù) Content-Type:application/json:代表發(fā)送端發(fā)送數(shù)據(jù)格式是json,后臺要以這種格式類接收前端的數(shù)據(jù)
八、使用Ajax發(fā)送請求
刪除,更新操作 $.ajax({ url: 路徑 , type: 類型 , data: 參數(shù){id:111}, success:(回調(diào)函數(shù))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>
九、相關(guān)注解
@GetMapper、@PostMapping、@DeleteMapping、@PutMapping
等價于 method =RequestMethod.GET|POST|DELETE|PUT
@RestController
等價于 @Controller +@ResponseBody
@PathVariable
通過 @PathVariable 可以將 URL 中占位符參數(shù)綁定到控制器處理方法參數(shù)中
URL 中的 {xxx} 占位符可以通過@PathVariable(“xxx“) 綁定到操作方法的參數(shù)中。
@RequestMapping標(biāo)簽屬性
params :要求請求中必須攜帶指定名稱的參數(shù) params="name" :必須攜帶name參數(shù) params="name=xuan" :必須攜帶name參數(shù),并且name=xuan headers :請求頭,限定要處理請求的請求頭信息,只有匹配才會被方法處理 consume :等價于Content-Type value/path:映射路徑 method:限定請求的方式
優(yōu)化RESTful規(guī)范的 例子代碼
@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開發(fā)框架
常見的有 SpringMVC , jersey , play
到此這篇關(guān)于Java進階之走進RESTful的文章就介紹到這了,更多相關(guān)Java RESTful內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java實現(xiàn)CORS跨域請求的實現(xiàn)方法
本篇文章主要介紹了Java實現(xiàn)CORS跨域請求的實現(xiàn)方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-09-09Java Volatile應(yīng)用單例模式實現(xiàn)過程解析
這篇文章主要介紹了Java Volatile應(yīng)用單例模式實現(xiàn)過程解析,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-11-11