Spring Boot Rest常用框架註解詳情簡介

Posted on by

前言：

讓我們瞭解一下Spring Boot Rest框架註釋。它是如此簡單和快速。在本文中，我將嘗試解釋Spring Boot Rest API的不同註釋。這些註釋是Spring Boot中REST API所必需的。

開始Spring Boot Rest的先決條件

最需要瞭解的是Spring容器或IOC。除此之外，還必須具備Java註釋的基本知識。因為Spring Boot應用程序充滿瞭註釋。最後但並非最不重要的一點是，應該澄清REST的概念，至少是基本概念。例如GET、POST、PUT、DELETE和Request body和response、headers等。

在Spring Initializer創建Spring Boot項目

Spring Boot最棒的一點是它有一個web應用程序用於入門。隻需點擊幾個表單字段和按鈕，就可以準備好初學者文件。這包括pom。包含所有必需依賴項的xml。隻需轉到Spring Initializer：https://start.spring.io/。如下面的屏幕截圖所示，填寫適當的數據。然後單擊右上角的添加依賴項按鈕。鍵入並選擇Web。我還將為log和Pojo添加Lombok。

Spring Boot Rest常用註解簡介

完成後，隻需單擊generate按鈕，就會下載一個包含這些文件的zip文件（pom.xml）。將其解壓縮並在IDE中打開。我將使用IntelliJ IDEA。這個IDE幫助我利用各種功能提高工作效率。 

Spring Boot註解

整個Spring Boot都依賴於註釋。對於不同的需求和過程，有各種註釋。其餘部分有4-5個主要註釋。讓我們一個接一個地看它們，並將它們應用到我們的示例中。

@RestController

類上使用瞭@RestController註釋。它將類定義為Rest的控制器。這是一個RESTful版本的控制器，添加瞭ResponseBy的組合。這樣，您的響應就會自動轉換為JSON、XML或任何已定義的響應類型，而無需單獨使用ResponseBy註釋。

@RestController
public class ArticleRestController {}

其餘的註釋在@RestController類下使用。

@RequestMapping

用於將特定端點映射到函數或方法。這有助於定義端點的路徑、方法、響應類型、請求類型等。

@RequestMapping(value = "/articles", method = RequestMethod.GET,  produces = "application/json")
public List<Article> getArticles() { }

在上面的示例中，值表示它映射到的路徑。例如，localhost:8080/articles。方法類型是GET，它生成“application/json”作為響應（不過，這是默認值，您可以跳過它）。

@RequestParam

URL中的查詢參數，即？key=value&key1=value1由@RequestParam註釋獲取。這用於函數的參數。它有各種選項，如required、defaultValue等。然後將查詢參數加載到指定的參數中。

@RequestMapping(value = "/article", method = RequestMethod.GET)
public Article getArticleByName(
   @RequestParam(value = "articleName", required = true) String articleName
) {}

在上面的例子中，如果我們調用URL GET localhost/article？articleName=springboot，將在articleName參數中加載“springboot”。我已經把reuired=true，所以如果我們不傳遞articleName，它將向用戶拋出一個錯誤。

@PathVariable

有沒有想過，在不傳遞查詢參數的情況下，服務器如何知道要加載哪篇文章？看看這篇文章的網址 post URL不包含查詢參數，而是一個普通的斜杠分隔字符串。服務器在PathVariable的幫助下讀取它，它看起來是這樣的，/article/{articleslaug}。替換{articleSlug}的任何字符串都將被視為PathVariable。

@RequestMapping(value = "/article/{articleSlug}", method = RequestMethod.GET)
public Article getArticle(@PathVariable("articleSlug") String articleSlug) {}

請記住，{articleSlug}在RequestMapping和PathVariable中應該是相同的（沒有{}）。如果不匹配，則無法加載。

@RequestBody

對於POST或PUT方法，您不會通過URL獲取所有數據，對嗎？這些方法有一個適當的請求主體。RequestBody註釋有助於將給定的請求正文自動映射到參數。主要是JSON到POJO。

@RequestMapping(value = "/article", method = RequestMethod.POST)
public Article createArticle(@RequestBody NewArticlePojo newArticle){}

請求主體將自動映射到NewArticlePojo類，並基於鍵填充字段。

REST方法的特定註釋

在上面的解釋中，您一定已經看到我使用特定的方法編寫瞭RequestMapping。但這太多餘瞭。為瞭解決這個問題，Spring Boot提供瞭預定義的方法映射。這些隻是@RequestMapping的擴展。

@GetMapping

@GetMapping用於將RequestMapping替換為method=RequestMethod。獲取參數。現在通過查看，我們知道這是一個GET請求。

@PostMapping和@PutMapping

PostMapping是用method=RequestMethod替換RequestMapping。類似地，PutMapping將用method=RequestMethod替換RequestMethod.PUT

@DeleteMapping

DeleteMapping用method=RequestMethod替換RequestMethod.DELETE

到此這篇關於Spring Boot Rest常用框架註解詳情簡介的文章就介紹到這瞭,更多相關Spring Boot Rest解內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：