Spring Boot中如何構建Restful API

這篇文章主要為大家展示了“Spring Boot中如何構建Restful API”，內容簡而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領大家一起研究并學習一下“Spring Boot中如何構建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方法來指定。

三、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”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！