詳解Spring Boot實戰(zhàn)之Restful API的構(gòu)建
上一篇文章講解了通過Spring boot與JdbcTemplate、JPA和MyBatis的集成，實現(xiàn)對數(shù)據(jù)庫的訪問。今天主要給大家分享一下如何通過Spring boot向前端返回數(shù)據(jù)。
在現(xiàn)在的開發(fā)流程中，為了最大程度實現(xiàn)前后端的分離，通常后端接口只提供數(shù)據(jù)接口，由前端通過Ajax請求從后端獲取數(shù)據(jù)并進(jìn)行渲染再展示給用戶。我們用的最多的方式就是后端會返回給前端一個JSON字符串，前端解析JSON字符串生成JavaScript的對象，然后再做處理。本文就來演示一下Spring boot如何實現(xiàn)這種模式，本文重點會講解如何設(shè)計一個Restful的API，并通過Spring boot來實現(xiàn)相關(guān)的API。不過，為了大家更好的了解Restful風(fēng)格的API，我們先設(shè)計一個傳統(tǒng)的數(shù)據(jù)返回接口，這樣大家可以對比著來理解。
一、非Restful接口的支持
我們這里以文章列表為例，實現(xiàn)一個返回文章列表的接口，代碼如下：
@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的實現(xiàn)很簡單，就是簡單的封裝了ArticleMapper的操作，ArticleMapper的內(nèi)容大家可以參考上一篇的文章，ArticleService的實現(xiàn)類如下：
@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，就可以看到如下的結(jié)果：
ArticleServiceImpl這個類是一個很普通的類，只有一個Spring的注解@Service，標(biāo)識為一個bean以便于通過Spring IoC容器來管理。我們再來看看ArticleController這個類，其實用過Spring MVC的人應(yīng)該都熟悉這幾個注解，這里簡單解釋一下：
@Controller 標(biāo)識一個類為控制器。
@RequestMapping URL的映射。
@ResponseBody 返回結(jié)果轉(zhuǎn)換為JSON字符串。
@RequestBody 表示接收J(rèn)SON格式字符串參數(shù)。
通過這個三個注解，我們就能輕松的實現(xiàn)通過URL給前端返回JSON格式數(shù)據(jù)的功能。不過大家肯定有點疑惑，這不都是Spring MVC的東西嗎？跟Spring boot有什么關(guān)系？其實Spring boot的作用就是為我們省去了配置的過程，其他功能確實都是Spring與Spring MVC來為我們提供的，大家應(yīng)該記得Spring boot通過各種starter來為我們提供自動配置的服務(wù)，我們的工程里面之前引入過這個依賴：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
這個是所有Spring boot的web工程都需要引入的jar包，也就是說只要是Spring boot的web的工程，都默認(rèn)支持上述的功能。這里我們進(jìn)一步發(fā)現(xiàn)，通過Spring boot來開發(fā)web工程，確實為我們省了許多配置的工作。
二、Restful API設(shè)計
好了，我們現(xiàn)在再來看看如何實現(xiàn)Restful API。實際上Restful本身不是一項什么高深的技術(shù)，而只是一種編程風(fēng)格，或者說是一種設(shè)計風(fēng)格。在傳統(tǒng)的http接口設(shè)計中，我們一般只使用了get和post兩個方法，然后用我們自己定義的詞匯來表示不同的操作，比如上面查詢文章的接口，我們定義了article/list.json來表示查詢文章列表，可以通過get或者post方法來訪問。而Restful API的設(shè)計則通過HTTP的方法來表示CRUD相關(guān)的操作。因此，除了get和post方法外，還會用到其他的HTTP方法，如PUT、DELETE、HEAD等，通過不同的HTTP方法來表示不同含義的操作。下面是我設(shè)計的一組對文章的增刪改查的Restful API：
| 接口URL | HTTP方法 | 接口說明 |
| /article | POST | 保存文章 |
| /article/{id} | GET | 查詢文章列表 |
| /article/{id} | DELETE | 刪除文章 |
| /article/{id} | PUT | 更新文章信息 |
這里可以看出，URL僅僅是標(biāo)識資源的路勁，而具體的行為由HTTP方法來指定。
三、Restful API實現(xiàn)
現(xiàn)在我們再來看看如何實現(xiàn)上面的接口，其他就不多說，直接看代碼：
@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;
}
}
我們再來分析一下這段代碼，這段代碼和之前代碼的區(qū)別在于：
（1）我們使用的是@RestController這個注解，而不是@Controller，不過這個注解同樣不是Spring boot提供的，而是Spring MVC4中的提供的注解，表示一個支持Restful的控制器。
（2）這個類中有三個URL映射是相同的，即都是/article/{id}，這在@Controller標(biāo)識的類中是不允許出現(xiàn)的。這里的可以通過method來進(jìn)行區(qū)分，produces的作用是表示返回結(jié)果的類型是JSON。
（3）@PathVariable這個注解，也是Spring MVC提供的，其作用是表示該變量的值是從訪問路徑中獲取。
所以看來看去，這個代碼還是跟Spring boot沒太多的關(guān)系，Spring boot也僅僅是提供自動配置的功能，這也是Spring boot用起來很舒服的一個很重要的原因，因為它的侵入性非常非常小，你基本感覺不到它的存在。
四、測試
代碼寫完了，怎么測試？除了GET的方法外，都不能直接通過瀏覽器來訪問，當(dāng)然，我們可以直接通過postman來發(fā)送各種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();
}
}
執(zhí)行結(jié)果這里就不給大家貼了，大家有興趣的話可以自己實驗一下。整個類要說明的點還是很少，主要這些東西都與Spring boot沒關(guān)系，支持這些操作的原因還是上一篇文章中提到的引入對應(yīng)的starter：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency>
因為要執(zhí)行HTTP請求，所以這里使用了MockMvc，ArticleRestController通過注入的方式實例化，不能直接new，否則ArticleRestController就不能通過Spring IoC容器來管理，因而其依賴的其他類也無法正常注入。通過MockMvc我們就可以輕松的實現(xiàn)HTTP的DELETE/PUT/POST等方法了。
五、總結(jié)
本文講解了如果通過Spring boot來實現(xiàn)Restful的API，其實大部分東西都是Spring和Spring MVC提供的，Spring boot只是提供自動配置的功能。但是，正是這種自動配置，為我們減少了很多的開發(fā)和維護(hù)工作，使我們能更加簡單、高效的實現(xiàn)一個web工程，從而讓我們能夠更加專注于業(yè)務(wù)本身的開發(fā)，而不需要去關(guān)心框架的東西。這篇文章中我們提到了可以通過postman和junit的方式來訪問Restful 接口，下篇文章我們會介紹另外一種方式來訪問，有興趣的可以繼續(xù)關(guān)注一下。
以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
解決2022.3.1版本中?IDEA中?XML文件提示屎黃色背景的方法
這篇文章主要介紹了解決2022.3.1版本中?IDEA中?XML文件屎黃色背景?的方法,本文通過圖文并茂的形式給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-01-01
下面小編就為大家?guī)硪黄猨ava讀取http請求中的body實例代碼。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-09-09
MybatisPlus結(jié)合groupby實現(xiàn)分組和sum求和的步驟
這篇文章主要介紹了MybatisPlus結(jié)合groupby實現(xiàn)分組和sum求和的步驟,這次使用的是LambdaQueryWrapper,使用QueryWrapper相對來說簡單點就不寫了,本文分步驟給大家介紹的非常詳細(xì),感興趣的朋友一起看看吧2023-12-12
下面小編就為大家?guī)硪黄ㄟ^Class類獲取對象(實例講解)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-06-06
SpringBoot統(tǒng)一數(shù)據(jù)返回格式的實現(xiàn)示例
本文主要介紹了SpringBoot統(tǒng)一數(shù)據(jù)返回格式,它提高了代碼的可維護(hù)性和一致性,并改善了客戶端與服務(wù)端之間的通信,具有一定的參考價值,感興趣的可以了解一下2024-05-05
Spring框架廣泛應(yīng)用于多種場景中,下面這篇文章主要給大家介紹了關(guān)于Spring框架中重要注解及其應(yīng)用的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-08-08
這篇文章主要介紹了使用springboot訪問圖片本地路徑并映射成url的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
idea配置多環(huán)境啟動方式dev、test、prod
這篇文章主要介紹了idea配置多環(huán)境啟動方式dev、test、prod,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-09-09
本文主要介紹了Java 生成隨機單據(jù)號的實現(xiàn)示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-09-09
Java中的ConcurrentLinkedQueue松散隊列解析
這篇文章主要介紹了Java中的ConcurrentLinkedQueue松散隊列解析,鏈表是松散的,鏈表節(jié)點并不都是有效的,允許存在無效節(jié)點val=null,但是只有最后一個節(jié)點才能next=null,需要的朋友可以參考下2023-12-12