微服務架構專案實戰：Spring Boot 如何建立簡單的 REST 服務

你將學習

什麼是 REST 服務？
如何使用 Spring Initializr 引導建立 Rest 服務應用程式？
如何建立獲取 REST 服務以檢索學生註冊的課程？
如何為學生註冊課程建立 Post REST 服務？
如何利用 postman 執行 rest 服務？

本教程使用的 rest 服務

在本教程中，我們將使用適當的 URI 和 HTTP 方法建立三個服務：

@GetMapping（“/ students / {studentId} / courses”）：您可以使用請求方法 Get 和示例 uri / students / Student1 / courses 來查詢特定學生已註冊的課程。

@GetMapping(“/students/{studentId}/courses/{courseId}”)：您可以使用請求方法 Get 和示例 uri / students / Student1 / courses / Course1 獲取特定學生的特定課程。

@PostMapping(“/students/{studentId}/courses”) ：您可以通過向 UURI /students/Student1/courses 傳送 POST 請求來為學生註冊一門課程

您將需要的工具

Maven 3.0+ 是您的構建工具
你最喜歡的 IDE。我們使用 Eclipse。
JDK 1.8+

完整的 spring booot rest Maven 專案程式碼示例子

我們的 Github 儲存庫包含所有程式碼示例 - github.com/in28minutes…

帶有單元和整合測試的 REST 服務
Website-springbootrestservices-simplerestserviceswithunitandintegrationtests.zip

什麼是 REST？

REST 代表 REpresentational State Transfer。REST 指定了一組體系結構約束。任何滿足以下這些條件的服務都稱為 RESTful 服務。

RESTful Web Service 的五個重要條件：

客戶端 - 伺服器：應該有一個服務生產者和一個服務使用者。
介面（URL）是統一的並且暴露資源。
該服務是無狀態的。
服務結果應該是可快取的。例如 HTTP 快取。
服務應該採用分層架構。客戶端不應該直接連線到伺服器 - 它可能從中間層獲取資訊 - 快取。

理查森成熟度模型

Richardson 成熟度模型用於識別 Restful Web Service 的成熟度級別。以下是不同級別和特點：

級別 0：以 REST 風格公開 SOAP Web 服務。公開的操作使用 REST 服務（http：// server / getPosts，http：// server / deletePosts，http：// server / doThis，http：// server / doThat 等）。
級別 1：使用正確的 URI（使用名詞）公開資源。例如：http：// server / accounts，http：// server / accounts / 10。但是，HTTP 方法並未使用。
級別 2：資源使用正確的 URI + HTTP 方法。例如，要更新一個賬戶，你需要做一個 PUT。建立一個帳戶，你做一個 POST。Uri 看起來像 posts/1/comments/5 和 accounts/1/friends/1.
等級 3：HATEOAS (Hypermedia as the engine of application state)。您不僅可以瞭解所請求的資訊，還可以瞭解服務消費者可以採取的下一個可能的操作。當請求有關 Facebook 使用者的資訊時，REST 服務可以返回使用者詳細資訊以及有關如何獲取他最近的帖子，如何獲取他最近的評論以及如何檢索他朋友的列表的資訊。

使用適當的請求方法

始終使用 HTTP 方法。有關每種 HTTP 方法的最佳做法如下所述：

GET：不應該更新任何東西。應該是冪等的（多次呼叫相同的結果）。可能的返回碼 200（OK）+ 404（NOT FOUND）+400（BAD REQUEST）
POST：應該建立新的資源。理想情況下返回 JSON 和連結到新建立的資源。儘可能使用相同的返回碼。另外：返回碼 201（建立）是可能的。
PUT：更新已知資源。例如：更新客戶詳細資訊。可能的返回碼：200（OK）
DELETE：用於刪除資源。

專案結構

以下螢幕截圖顯示了我們將建立的專案的結構。

一些細節：

StudentController.java - rest 控制器提供上面討論的所有三種服務方法。
Course.java, Student.java, StudentService.java - 應用程式的業務邏輯。StudentService 提供了一些我們從 Rest 控制器中消耗的方法。
StudentControllerIT.java - rest 服務的整合測試。
StudentControllerTest.java - test 服務的單元測試。
StudentServicesApplication.java - Spring Boot 應用程式的啟動器。要執行該應用程式，只需將該檔案作為 Java 應用程式啟動。
pom.xml - 包含構建此專案所需的所有依賴。我們將使用 Spring Boot Starter Web。

在此我向大家推薦一個架構學習交流群。交流學習群號：575745314 裡面會分享一些資深架構師錄製的視訊錄影：有Spring，MyBatis，Netty原始碼分析，高併發、高效能、分散式、微服務架構的原理，JVM效能優化、分散式架構等這些成為架構師必備的知識體系。還能領取免費的學習資源，目前受益良多

使用 Spring Initializr 引導建立 REST 服務

用 Spring Initializr 建立一個 REST 服務是非常的容易小菜一碟。我們將使用 Spring Web MVC 作為我們的 web 層框架。

Spring Initializr start.spring.io/ 是引導建立 Spri… Boot 專案的好工具。

如上圖所示，必須執行以下步驟

啟動 Spring Initializr 並選擇以下內容
- 選擇 com.in28minutes.springboot 為 Group
- 選擇 student-services 為 Artifact
- 選擇以下依賴項
  - Web
  - Actuator
  - DevTools
點選生成專案。
將專案匯入 Eclipse。檔案 - > 匯入 - > 現有的 Maven 專案。
如果你想了解這個專案的所有檔案，你可以繼續向下閱讀。

應用業務層實現

所有應用都需要資料。我們將使用 ArrayList 這種記憶體資料儲存，而不是與真實資料庫互動。

一名學生可以參加多門課程。課程有一個 ID，名稱，說明和完成課程需要完成的步驟列表。學生有一個身份證，姓名，說明和他 / 她目前註冊的課程列表。StudentService 提供以下公開方法

public List retrieveAllStudents() - 檢索所有學生的詳細資訊
public Student retrieveStudent(String studentId) - 檢索特定的學生詳細資訊
public List retrieveCourses(String studentId) - 檢索學生註冊的所有課程
public Course retrieveCourse(String studentId, String courseId) - 檢索學生註冊的特定課程的詳細資訊
public Course addCourse(String studentId, Course course) - 為現有學生新增課程

請參閱下面這些檔案，具體的實現服務類 StudentService 和模型類 Course 和 Student。

src/main/java/com/in28minutes/springboot/model/Course.java
src/main/java/com/in28minutes/springboot/model/Student.java
src/main/java/com/in28minutes/springboot/service/StudentService.java

新增幾個 GET Rest 服務

Rest 服務 StudentController 暴露了幾個 get 服務。

@Autowired private StudentService studentService ：我們使用 Spring Autowiring 將 student 服務自動注入到 StudentController。
@GetMapping(“/students/{studentId}/courses”)：以 studentId 作為路徑變數公開獲取服務
@GetMapping(“/students/{studentId}/courses/{courseId}”)：公開獲取服務以檢索學生的特定課程。
@PathVariable String studentId：來自 uri 的 studentId 的值將對映到此引數。

package com.in28minutes.springboot.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import com.in28minutes.springboot.model.Course;
import com.in28minutes.springboot.service.StudentService;

@RestController
public class StudentController {

	@Autowired
	private StudentService studentService;

	@GetMapping("/students/{studentId}/courses")
	public List<Course> retrieveCoursesForStudent(@PathVariable String studentId) {
		return studentService.retrieveCourses(studentId);
	}
	
	@GetMapping("/students/{studentId}/courses/{courseId}")
	public Course retrieveDetailsForCourse(@PathVariable String studentId,
			@PathVariable String courseId) {
		return studentService.retrieveCourse(studentId, courseId);
	}

}
複製程式碼

使用 Postman 執行獲取服務
我們將向 http：// localhost：8080 / students / Student1 / courses / Course1 發起請求以測試該服務。迴應如下所示。

{
  "id": "Course1",
  "name": "Spring",
  "description": "10 Steps",
  "steps": [
    "Learn Maven",
    "Import Project",
    "First Example",
    "Second Example"
  ]
}
複製程式碼

下面的圖片顯示了我們如何執行 Postman 的 Get Service - 我最喜歡的執行 rest 服務的工具。

新增 POST Rest 服務

當資源建立成功時，POST 服務應該返回建立的狀態（201）。

@PostMapping(“/students/{studentId}/courses”)：為 POST 請求對映 URL
@RequestBody Course newCourse：使用繫結將請求正文繫結到課程物件。
ResponseEntity.created(location).build()：返回已建立的狀態。還將建立資源的位置作為響應標題返回。

	@PostMapping("/students/{studentId}/courses")
	public ResponseEntity<Void> registerStudentForCourse(
			@PathVariable String studentId, @RequestBody Course newCourse) {

		Course course = studentService.addCourse(studentId, newCourse);

		if (course == null)
			return ResponseEntity.noContent().build();

		URI location = ServletUriComponentsBuilder.fromCurrentRequest().path(
				"/{id}").buildAndExpand(course.getId()).toUri();

		return ResponseEntity.created(location).build();
	}
複製程式碼

執行 POST Rest 服務
示例請求如下所示。它包含了學生註冊課程的所有細節。

{
  "name": "Microservices",
  "description": "10 Steps",
  "steps": [
    "Learn How to Break Things Up",
    "Automate the hell out of everything",
    "Have fun"
  ]
}
複製程式碼

下圖顯示了我們如何從 Postman 執行 Post 服務 - 我最喜歡的執行 rest 服務的工具。確保你去 Body 選項卡並選擇 raw。從下拉選單中選擇 JSON。將上述請求複製到 body 中。

我們使用的 URL 是 http：// localhost：8080 / students / Student1 / courses。