Spring Boot實戰：Restful API的構建

来源:https://www.cnblogs.com/paddix/archive/2018/01/09/8215245.html
-Advertisement-
Play Games

本文講解瞭如果通過Spring boot來實現前後端的交互，首先演示了傳統的數據交互方式，然後重點講解如何設計一個Restful的API，並通過Spring boot來實現相關的API。 ...


　　上一篇文章講解了通過Spring boot與JdbcTemplate、JPA和MyBatis的集成，實現對資料庫的訪問。今天主要給大家分享一下如何通過Spring boot向前端返回數據。

　　在現在的開發流程中，為了最大程度實現前後端的分離，通常後端介面只提供數據介面，由前端通過Ajax請求從後端獲取數據併進行渲染再展示給用戶。我們用的最多的方式就是後端會返回給前端一個JSON字元串，前端解析JSON字元串生成JavaScript的對象，然後再做處理。本文就來演示一下Spring boot如何實現這種模式，本文重點會講解如何設計一個Restful的API，並通過Spring boot來實現相關的API。不過，為了大家更好的瞭解Restful風格的API，我們先設計一個傳統的數據返回介面，這樣大家可以對比著來理解。

一、非Restful介面的支持

　　我們這裡以文章列表為例，實現一個返迴文章列表的介面，代碼如下：

@Controller
@RequestMapping("/article")
public class ArticleController {

    @Autowired
    private ArticleService articleService;

    @RequestMapping("/list.json")
    @ResponseBody
    public List<Article> listArticles(String title, Integer pageSize, Integer pageNum) {
        if (pageSize == null) {
            pageSize = 10;
        }
        if (pageNum == null) {
            pageNum = 1;
        }
        int offset = (pageNum - 1) * pageSize;
        return articleService.getArticles(title, 1L, offset, pageSize);
    }
}

　　這個ArticleService的實現很簡單，就是簡單的封裝了ArticleMapper的操作，ArticleMapper的內容大家可以參考上一篇的文章，ArticleService的實現類如下：

@Service
public class ArticleServiceImpl implements ArticleService {

    @Autowired
    private ArticleMapper articleMapper;

    @Override
    public Long saveArticle(@RequestBody Article article) {
        return articleMapper.insertArticle(article);
    }

    @Override
    public List<Article> getArticles(String title,Long userId,int offset,int pageSize) {
        Article article = new Article();
        article.setTitle(title);
        article.setUserId(userId);
        return articleMapper.queryArticlesByPage(article,offset,pageSize);
    }

    @Override
    public Article getById(Long id) {
        return articleMapper.queryById(id);
    }

    @Override
    public void updateArticle(Article article) {
        article.setUpdateTime(new Date());
        articleMapper.updateArticleById(article);
    }
}

　　運行Application.java這個類，然後訪問：http://locahost:8080/article/list.json，就可以看到如下的結果：

　　ArticleServiceImpl這個類是一個很普通的類，只有一個Spring的註解@Service，標識為一個bean以便於通過Spring IoC容器來管理。我們再來看看ArticleController這個類，其實用過Spring MVC的人應該都熟悉這幾個註解，這裡簡單解釋一下：

　　@Controller 標識一個類為控制器。

　　@RequestMapping URL的映射。

　　@ResponseBody 返回結果轉換為JSON字元串。

　　@RequestBody 表示接收JSON格式字元串參數。

　　通過這個三個註解，我們就能輕鬆的實現通過URL給前端返回JSON格式數據的功能。不過大家肯定有點疑惑，這不都是Spring MVC的東西嗎？跟Spring boot有什麼關係？其實Spring boot的作用就是為我們省去了配置的過程，其他功能確實都是Spring與Spring MVC來為我們提供的，大家應該記得Spring boot通過各種starter來為我們提供自動配置的服務，我們的工程裡面之前引入過這個依賴：

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
</dependency>

　　這個是所有Spring boot的web工程都需要引入的jar包，也就是說只要是Spring boot的web的工程，都預設支持上述的功能。這裡我們進一步發現，通過Spring boot來開發web工程，確實為我們省了許多配置的工作。

 

二、Restful API設計

　　好了，我們現在再來看看如何實現Restful API。實際上Restful本身不是一項什麼高深的技術，而只是一種編程風格，或者說是一種設計風格。在傳統的http介面設計中，我們一般只使用了get和post兩個方法，然後用我們自己定義的辭彙來表示不同的操作，比如上面查詢文章的介面，我們定義了article/list.json來表示查詢文章列表，可以通過get或者post方法來訪問。而Restful API的設計則通過HTTP的方法來表示CRUD相關的操作。因此，除了get和post方法外，還會用到其他的HTTP方法，如PUT、DELETE、HEAD等，通過不同的HTTP方法來表示不同含義的操作。下麵是我設計的一組對文章的增刪改查的Restful API：

介面URL HTTP方法 介面說明
 /article  POST  保存文章
 /article/{id}  GET  查詢文章列表
 /article/{id}  DELETE  刪除文章
 /article/{id}  PUT  更新文章信息

 　　這裡可以看出，URL僅僅是標識資源的路勁，而具體的行為由HTTP方法來指定。

 

三、Restful API實現

　　現在我們再來看看如何實現上面的介面，其他就不多說，直接看代碼：

@RestController
@RequestMapping("/rest")
public class ArticleRestController {

    @Autowired
    private ArticleService articleService;

    @RequestMapping(value = "/article", method = POST, produces = "application/json")
    public WebResponse<Map<String, Object>> saveArticle(@RequestBody Article article) {
        article.setUserId(1L);
        articleService.saveArticle(article);
        Map<String, Object> ret = new HashMap<>();
        ret.put("id", article.getId());
        WebResponse<Map<String, Object>> response = WebResponse.getSuccessResponse(ret);
        return response;
    }

    @RequestMapping(value = "/article/{id}", method = DELETE, produces = "application/json")
    public WebResponse<?> deleteArticle(@PathVariable Long id) {
        Article article = articleService.getById(id);
        article.setStatus(-1);
        articleService.updateArticle(article);
        WebResponse<Object> response = WebResponse.getSuccessResponse(null);
        return response;
    }

    @RequestMapping(value = "/article/{id}", method = PUT, produces = "application/json")
    public WebResponse<Object> updateArticle(@PathVariable Long id, @RequestBody Article article) {
        article.setId(id);
        articleService.updateArticle(article);
        WebResponse<Object> response = WebResponse.getSuccessResponse(null);
        return response;
    }

    @RequestMapping(value = "/article/{id}", method = GET, produces = "application/json")
    public WebResponse<Article> getArticle(@PathVariable Long id) {
        Article article = articleService.getById(id);
        WebResponse<Article> response = WebResponse.getSuccessResponse(article);
        return response;
    }
}

　　我們再來分析一下這段代碼，這段代碼和之前代碼的區別在於：

　　（1）我們使用的是@RestController這個註解，而不是@Controller，不過這個註解同樣不是Spring boot提供的，而是Spring MVC4中的提供的註解，表示一個支持Restful的控制器。

　　（2）這個類中有三個URL映射是相同的，即都是/article/{id}，這在@Controller標識的類中是不允許出現的。這裡的可以通過method來進行區分，produces的作用是表示返回結果的類型是JSON。

　　（3）@PathVariable這個註解，也是Spring MVC提供的，其作用是表示該變數的值是從訪問路徑中獲取。

　　所以看來看去，這個代碼還是跟Spring boot沒太多的關係，Spring boot也僅僅是提供自動配置的功能，這也是Spring boot用起來很舒服的一個很重要的原因，因為它的侵入性非常非常小，你基本感覺不到它的存在。

 

四、測試

　　代碼寫完了，怎麼測試？除了GET的方法外，都不能直接通過瀏覽器來訪問，當然，我們可以直接通過postman來發送各種http請求。不過我還是比較支持通過單元測試類來測試各個方法。這裡我們就通過Junit來測試各個方法：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = Application.class)
public class ArticleControllerTest {

    @Autowired
    private ArticleRestController restController;

    private MockMvc mvc;

    @Before
    public void setUp() throws Exception {
        mvc = MockMvcBuilders.standaloneSetup(restController).build();
    }

    @Test
    public void testAddArticle() throws Exception {
        Article article = new Article();
        article.setTitle("測試文章000000");
        article.setType(1);
        article.setStatus(2);
        article.setSummary("這是一篇測試文章");
        Gson gosn = new Gson();
        RequestBuilder builder = MockMvcRequestBuilders
                .post("/rest/article")
                .accept(MediaType.APPLICATION_JSON)
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .content(gosn.toJson(article));

        MvcResult result = mvc.perform(builder).andReturn();
        System.out.println(result.getResponse().getContentAsString());
    }

    @Test
    public void testUpdateArticle() throws Exception {
        Article article = new Article();
        article.setTitle("更新測試文章");
        article.setType(1);
        article.setStatus(2);
        article.setSummary("這是一篇更新測試文章");
        Gson gosn = new Gson();
        RequestBuilder builder = MockMvcRequestBuilders
                .put("/rest/article/1")
                .accept(MediaType.APPLICATION_JSON)
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .content(gosn.toJson(article));
        MvcResult result = mvc.perform(builder).andReturn();
    }

    @Test
    public void testQueryArticle() throws Exception {
        RequestBuilder builder = MockMvcRequestBuilders
                .get("/rest/article/1")
                .accept(MediaType.APPLICATION_JSON)
                .contentType(MediaType.APPLICATION_JSON_UTF8);
        MvcResult result = mvc.perform(builder).andReturn();
        System.out.println(result.getResponse().getContentAsString());
    }

    @Test
    public void testDeleteArticle() throws Exception {
        RequestBuilder builder = MockMvcRequestBuilders
                .delete("/rest/article/1")
                .accept(MediaType.APPLICATION_JSON)
                .contentType(MediaType.APPLICATION_JSON_UTF8);
        MvcResult result = mvc.perform(builder).andReturn();
    }
}

　　執行結果這裡就不給大家貼了，大家有興趣的話可以自己實驗一下。整個類要說明的點還是很少，主要這些東西都與Spring boot沒關係，支持這些操作的原因還是上一篇文章中提到的引入對應的starter：

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
</dependency>

　　因為要執行HTTP請求，所以這裡使用了MockMvc，ArticleRestController通過註入的方式實例化，不能直接new，否則ArticleRestController就不能通過Spring IoC容器來管理，因而其依賴的其他類也無法正常註入。通過MockMvc我們就可以輕鬆的實現HTTP的DELETE/PUT/POST等方法了。

，

五、總結

　　本文講解瞭如果通過Spring boot來實現Restful的API，其實大部分東西都是Spring和Spring MVC提供的，Spring boot只是提供自動配置的功能。但是，正是這種自動配置，為我們減少了很多的開發和維護工作，使我們能更加簡單、高效的實現一個web工程，從而讓我們能夠更加專註於業務本身的開發，而不需要去關心框架的東西。這篇文章中我們提到了可以通過postman和junit的方式來訪問Restful 介面，下篇文章我們會介紹另外一種方式來訪問，有興趣的可以繼續關註一下。

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • JavaScript ES6 let、const
    在ES6中，增加了2個聲明變數的關鍵字：let 和 const。在這裡將詳細介紹let與var的區別、Babel對let的處理以及const的簡單使用。 ...
  • 中小型研發團隊架構實踐三要點
    中小型研發團隊很多，而社區在中小型研發團隊架構實踐方面的探討卻很少。中小型研發團隊特別是 50 至 200 人的研發團隊，在早期的業務探索階段，更多關註業務邏輯，快速迭代以驗證商業模式，很少去關註技術架構。 這時如果繼續按照原有的架構及研發模式，會出現大量的問題，再也無法玩下去了。能不能有一套可直接 ...
  • OLAP與數據倉庫------《Designing Data-Intensive Applications》讀書筆記4
    由於第三章的內容比較多，這裡我們拆分成兩篇讀書筆記來記錄。上一章我們聊了聊如何資料庫是如何實現存儲和檢索的，今天這篇我們繼續來看看OLTP與OLAP存儲引擎的區別與聯繫。 1.OLTP與OLAP 聯機事務處理過程（ O n L ine T ransaction P rocessing）也就是我們通常 ...
  • (五)：C++分散式實時應用框架——微服務架構的演進
    OCS(online charging system，線上計費系統)在進行雲化改造的過程中，從實用主義角度出發，微服務架構並不是我們的目標。雖然我們也對系統進行了容器化改造(Docker)，並根據業務進程的功能將系統分成了好幾類的容器，但這一切多是出於對系統中的某些處理節點進行動態擴縮容的需要，跟微... ...
  • JDBC、mybatis、hibernate連接資料庫
    JDBC連接資料庫五步驟: 一、載入驅動 Class.forName(“com.mysql.jdbc.Driver”); 二、建立連接 Connection conn = DriverManager.getConnection(“jdbc:mysql://localhost:8080/資料庫名”,” ...
  • 分散式事務介紹
    公司創立之初，一個web服務和一個資料庫實例即可滿足戶需求。隨著業務量的增長，性能問題就會越來越突出。架構於是變成了多個web服務，和一個讀寫分離的資料庫群( 主多從)，這種架構或許也能 撐上千萬的用戶。但隨著進一步發展，會發現業務複雜度越來越高 ，耦合也比較嚴重，而且資料庫也成了性能瓶頸。這時就不 ...
  • Java學習筆記15（面向對象八：匿名對象、內部類）
    匿名對象： 是指創建對象的時候，只有創建對象的語句，卻沒有把對象地址值賦給某個變數 創建一個普通對象： Person p = new Person(); 創建一個匿名對象： new Person(); 註意： 1.匿名對象只能使用一次 2.匿名對象可以作為參數傳遞 3.匿名對象可以當作方法的返回值 ...
  • .Net轉Java.04.踩到switch的坑
    今天線上有個NullPointerException 的異常，我翻了一下代碼，拋異常的竟然是switch語句 我有種不祥的預感，本地做了實驗 結果是 Java的switch如果傳入null值，會拋出 java.lang.NullPointerException 的異常 看下麵的代碼，不要指望會跳到d ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類