Springboot 實現(xiàn) Restful 服務(wù)，基于 HTTP / JSON 傳輸 | 泥瓦匠BYSocket

2023-05-10 14:20 更新
摘要: 原創(chuàng)出處:www.bysocket.com 泥瓦匠BYSocket 希望轉(zhuǎn)載，保留摘要，謝謝！
“怎樣的人生才是沒有遺憾的人生？我的體會是：
（1）擁有健康；
（2）創(chuàng)造“難忘時刻”；
（3）盡力做好自己，不必改變世界；
（4）活在當下。”
– 《向死而生》李開復

Spring Boot 系列文章：《Spring Boot 那些事》

基于上一篇《Springboot 整合 Mybatis 的完整 Web 案例》，這邊我們著重在 控制層 講講。講講如何在 Springboot 實現(xiàn) Restful 服務(wù)，基于 HTTP / JSON 傳輸。

一、運行 springboot-restful 工程

git clone 下載工程 springboot-learning-example ，項目地址見 GitHub – https://github.com/JeffLi1993/springboot-learning-example。下面開始運行工程步驟（Quick Start）：

 

1.數(shù)據(jù)庫準備

a.創(chuàng)建數(shù)據(jù)庫 springbootdb：

CREATE DATABASE springbootdb;

b.創(chuàng)建表 city ：(因為我喜歡徒步)

DROP TABLE IF EXISTS  `city`;
CREATE TABLE `city` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT'城市編號',
  `province_id` int(10) unsigned  NOT NULL COMMENT'省份編號',
  `city_name` varchar(25) DEFAULT NULL COMMENT'城市名稱',
  `description` varchar(25) DEFAULT NULL COMMENT'描述',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

c.插入數(shù)據(jù)

INSERT cityVALUES (1 ,1,'溫嶺市','BYSocket 的家在溫嶺。');

2. springboot-restful 工程項目結(jié)構(gòu)介紹

springboot-restful 工程項目結(jié)構(gòu)如下圖所示：
org.spring.springboot.controller – Controller 層
org.spring.springboot.dao – 數(shù)據(jù)操作層 DAO
org.spring.springboot.domain – 實體類
org.spring.springboot.service – 業(yè)務(wù)邏輯層
Application – 應(yīng)用啟動類
application.properties – 應(yīng)用配置文件，應(yīng)用啟動會自動讀取配置
3.改數(shù)據(jù)庫配置
打開 application.properties 文件， 修改相應(yīng)的數(shù)據(jù)源配置，比如數(shù)據(jù)源地址、賬號、密碼等。（如果不是用 MySQL，自行添加連接驅(qū)動 pom，然后修改驅(qū)動名配置。）

 

4.編譯工程
在項目根目錄 springboot-learning-example，運行 maven 指令：
?mvn clean install?

 

5.運行工程
右鍵運行 springboot-restful 工程 Application 應(yīng)用啟動類的 main 函數(shù)。
用 postman 工具可以如下操作，
根據(jù) ID，獲取城市信息
GET http://127.0.0.1:8080/api/city/1
獲取城市列表
GET http://127.0.0.1:8080/api/city
新增城市信息
POST http://127.0.0.1:8080/api/city
更新城市信息
PUT http://127.0.0.1:8080/api/city
刪除城市信息
DELETE http://127.0.0.1:8080/api/city/2

 

二、springboot-restful 工程控制層實現(xiàn)詳解

1.什么是 REST?
REST 是屬于 WEB 自身的一種架構(gòu)風格，是在 HTTP 1.1 規(guī)范下實現(xiàn)的。Representational State Transfer 全稱翻譯為表現(xiàn)層狀態(tài)轉(zhuǎn)化。Resource：資源。比如 newsfeed；Representational：表現(xiàn)形式，比如用JSON，富文本等；State Transfer：狀態(tài)變化。通過HTTP 動作實現(xiàn)。
理解 REST ,要明白五個關(guān)鍵要素：
資源（Resource）
資源的表述（Representation）
狀態(tài)轉(zhuǎn)移（State Transfer）
統(tǒng)一接口（Uniform Interface）
超文本驅(qū)動（Hypertext Driven）
6 個主要特性：
面向資源（Resource Oriented）
可尋址（Addressability）
連通性（Connectedness）
無狀態(tài)（Statelessness）
統(tǒng)一接口（Uniform Interface）
超文本驅(qū)動（Hypertext Driven）
具體這里就不一一展開，詳見 http://www.infoq.com/cn/articles/understanding-restful-style

 

2.Spring 對 REST 支持實現(xiàn)

CityRestController.java 城市 Controller 實現(xiàn) Restful HTTP 服務(wù)

public class CityRestController {
   @Autowired
   private CityService cityService;
   @RequestMapping(value ="/api/city/{id}", method = RequestMethod.GET)
   public City findOneCity(@PathVariable("id") Long id) {
       return cityService.findCityById(id);
   }
   @RequestMapping(value ="/api/city", method = RequestMethod.GET)
   public List<City> findAllCity() {
       return cityService.findAllCity();
   }
   @RequestMapping(value ="/api/city", method = RequestMethod.POST)
   public void createCity(@RequestBody City city) {
       cityService.saveCity(city);
   }
   @RequestMapping(value ="/api/city", method = RequestMethod.PUT)
   public void modifyCity(@RequestBody City city) {
       cityService.updateCity(city);
   }
   @RequestMapping(value ="/api/city/{id}", method = RequestMethod.DELETE)
   public void modifyCity(@PathVariable("id") Long id) {
       cityService.deleteCity(id);
   }
}

 

代碼詳解：
@RequestMapping 處理請求地址映射。
method – 指定請求的方法類型：POST/GET/DELETE/PUT 等
value – 指定實際的請求地址
consumes – 指定處理請求的提交內(nèi)容類型，例如 Content-Type 頭部設(shè)置application/json, text/html
produces – 指定返回的內(nèi)容類型
@PathVariable URL 映射時，用于綁定請求參數(shù)到方法參數(shù)
@RequestBody 這里注解用于讀取請求體 body 的數(shù)據(jù)，通過 HttpMessageConverter 解析綁定到對象中

 

3.HTTP 知識補充
GET            請求獲取Request-URI所標識的資源
POST          在Request-URI所標識的資源后附加新的數(shù)據(jù)
HEAD         請求獲取由Request-URI所標識的資源的響應(yīng)消息報頭
PUT            請求服務(wù)器存儲一個資源，并用Request-URI作為其標識
DELETE       請求服務(wù)器刪除Request-URI所標識的資源
TRACE        請求服務(wù)器回送收到的請求信息，主要用于測試或診斷
CONNECT  保留將來使用
OPTIONS   請求查詢服務(wù)器的性能，或者查詢與資源相關(guān)的選項和需求

 

三、小結(jié)

Springboot 實現(xiàn) Restful 服務(wù)，基于 HTTP / JSON 傳輸，適用于前后端分離。這只是個小demo，沒有加入bean validation這種校驗。還有各種業(yè)務(wù)場景。
歡迎掃一掃我的公眾號關(guān)注 — 及時得到博客訂閱哦！
— http://www.bysocket.com/ —
— https://github.com/JeffLi1993 —



以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號