作者：liuxiaopeng
https://www.cnblogs.com/paddix/p/8215245.html
在現在的開發流程中，為了最大程度實作前后端的分離，通常后端介面只提供資料介面，由前端通過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本身不是一項什么高深的技術，而只是一種編程風格，或者說是一種設計風格，架構必備「RESTful API」設計技巧經驗總結，這篇推薦看下，
在傳統的http介面設計中，我們一般只使用了get和post兩個方法，然后用我們自己定義的詞匯來表示不同的操作，比如上面查詢文章的介面，我們定義了article/list.json來表示查詢文章串列，可以通過get或者post方法來訪問，
而Restful API的設計則通過HTTP的方法來表示CRUD相關的操作，因此，除了get和post方法外，還會用到其他的HTTP方法，如PUT、DELETE、HEAD等，通過不同的HTTP方法來表示不同含義的操作，下面是我設計的一組對文章的增刪改查的Restful API：
這里可以看出，URL僅僅是標識資源的路勁，而具體的行為由HTTP方法來指定，
三、Restful API實作
現在我們再來看看如何實作上面的介面，其他就不多說，直接看代碼：
@RestController
@RequestMapping("/rest")
public class ArticleRestController {
@Autowired
private ArticleService articleService;
@RequestMapping(value =https://www.cnblogs.com/javastack/p/ "/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 =https://www.cnblogs.com/javastack/p/ "/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 =https://www.cnblogs.com/javastack/p/ "/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 =https://www.cnblogs.com/javastack/p/ "/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;
}
}
我們再來分析一下這段代碼，這段代碼和之前代碼的區別在于：
-
我們使用的是@RestController這個注解，而不是@Controller，不過這個注解同樣不是Spring boot提供的，而是Spring MVC4中的提供的注解，表示一個支持Restful的控制器，
-
這個類中有三個URL映射是相同的，即都是/article/{id}，這在@Controller標識的類中是不允許出現的，這里的可以通過method來進行區分，produces的作用是表示回傳結果的型別是JSON，
-
@PathVariable這個注解，也是Spring MVC提供的，其作用是表示該變數的值是從訪問路徑中獲取，
所以看來看去，這個代碼還是跟Spring boot沒太多的關系，Spring boot也僅僅是提供自動配置的功能，這也是Spring boot用起來很舒服的一個很重要的原因，因為它的侵入性非常非常小，你基本感覺不到它的存在，
四、測驗
代碼寫完了，怎么測驗？
除了GET的方法外，都不能直接通過瀏覽器來訪問，當然，我們可以直接通過postman來發送各種http請求，
不過我還是比較支持通過單元測驗類來測驗各個方法，推薦：Spring Boot 單元測驗詳解+實戰教程，這里我們就通過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工程，從而讓我們能夠更加專注于業務本身的開發，而不需要去關心框架的東西，
關注公眾號Java技術堆疊回復"面試"獲取我整理的2020最全面試題及答案，
推薦去我的博客閱讀更多：
1.Java JVM、集合、多執行緒、新特性系列教程
2.Spring MVC、Spring Boot、Spring Cloud 系列教程
3.Maven、Git、Eclipse、Intellij IDEA 系列工具教程
4.Java、后端、架構、阿里巴巴等大廠最新面試題
覺得不錯，別忘了點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/154795.html
標籤：Java
上一篇：一直報錯，大神們求解