這篇文章主要介紹如何使用Spring Boot創(chuàng)建簡單的REST服務,文中介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們一定要看完!
站在用戶的角度思考問題,與客戶深入溝通,找到乳源網(wǎng)站設計與乳源網(wǎng)站推廣的解決方案,憑借多年的經(jīng)驗,讓設計與互聯(lián)網(wǎng)技術(shù)結(jié)合,創(chuàng)造個性化、用戶體驗好的作品,建站類型包括:成都網(wǎng)站設計、網(wǎng)站建設、企業(yè)官網(wǎng)、英文網(wǎng)站、手機端網(wǎng)站、網(wǎng)站推廣、主機域名、網(wǎng)站空間、企業(yè)郵箱。業(yè)務覆蓋乳源地區(qū)。
你將學習
什么是 REST 服務?
如何使用 Spring Initializr 引導創(chuàng)建 Rest 服務應用程序?
如何創(chuàng)建獲取 REST 服務以檢索學生注冊的課程?
如何為學生注冊課程創(chuàng)建 Post REST 服務?
如何利用 postman 執(zhí)行 rest 服務?
本教程使用的 rest 服務
在本教程中,我們將使用適當?shù)?URI 和 HTTP 方法創(chuàng)建三個服務:
@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 發(fā)送 POST 請求來為學生注冊一門課程
您將需要的工具
Maven 3.0+ 是您的構(gòu)建工具
你最喜歡的 IDE。我們使用 Eclipse。
JDK 1.8+
完整的 spring booot rest Maven 項目代碼示例子
我們的 Github 存儲庫包含所有代碼示例 - https://github.com/in28minutes/in28minutes.github.io/tree/master/code-zip-files
帶有單元和集成測試的 REST 服務
Website-springbootrestservices-simplerestserviceswithunitandintegrationtests.zip
什么是 REST?
REST 代表 REpresentational State Transfer。REST 指定了一組體系結(jié)構(gòu)約束。任何滿足以下這些條件的服務都稱為 RESTful 服務。
RESTful Web Service 的五個重要條件:
客戶端 - 服務器:應該有一個服務生產(chǎn)者和一個服務使用者。
接口(URL)是統(tǒng)一的并且暴露資源。
該服務是無狀態(tài)的。
服務結(jié)果應該是可緩存的。例如 HTTP 緩存。
服務應該采用分層架構(gòu)??蛻舳瞬粦撝苯舆B接到服務器 - 它可能從中間層獲取信息 - 緩存。
理查森成熟度模型
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。創(chuàng)建一個帳戶,你做一個 POST。Uri 看起來像 posts/1/comments/5 和 accounts/1/friends/1.
等級 3:HATEOAS (Hypermedia as the engine of application state)。您不僅可以了解所請求的信息,還可以了解服務消費者可以采取的下一個可能的操作。當請求有關(guān) Facebook 用戶的信息時,REST 服務可以返回用戶詳細信息以及有關(guān)如何獲取他最近的帖子,如何獲取他最近的評論以及如何檢索他朋友的列表的信息。
使用適當?shù)恼埱蠓椒?/strong>
始終使用 HTTP 方法。有關(guān)每種 HTTP 方法的最佳做法如下所述:
GET:不應該更新任何東西。應該是冪等的(多次調(diào)用相同的結(jié)果)??赡艿姆祷卮a 200(OK)+ 404(NOT FOUND)+400(BAD REQUEST)
POST:應該創(chuàng)建新的資源。理想情況下返回 JSON 和鏈接到新創(chuàng)建的資源。盡可能使用相同的返回碼。另外:返回碼 201(創(chuàng)建)是可能的。
PUT:更新已知資源。例如:更新客戶詳細信息。可能的返回碼:200(OK)
DELETE:用于刪除資源。
項目結(jié)構(gòu)
以下屏幕截圖顯示了我們將創(chuàng)建的項目的結(jié)構(gòu)。
一些細節(jié):
StudentController.java - rest 控制器提供上面討論的所有三種服務方法。
Course.java, Student.java, StudentService.java - 應用程序的業(yè)務邏輯。StudentService 提供了一些我們從 Rest 控制器中消耗的方法。
StudentControllerIT.java - rest 服務的集成測試。
StudentControllerTest.java - test 服務的單元測試。
StudentServicesApplication.java - Spring Boot 應用程序的啟動器。要運行該應用程序,只需將該文件作為 Java 應用程序啟動。
pom.xml - 包含構(gòu)建此項目所需的所有依賴。我們將使用 Spring Boot Starter Web。
使用 Spring Initializr 引導創(chuàng)建 REST 服務
用 Spring Initializr 創(chuàng)建一個 REST 服務是非常的容易小菜一碟。我們將使用 Spring Web MVC 作為我們的 web 層框架。
Spring Initializr http://start.spring.io/ 是引導創(chuàng)建 Spring Boot 項目的好工具。
如上圖所示,必須執(zhí)行以下步驟
啟動 Spring Initializr 并選擇以下內(nèi)容
選擇 com.in28minutes.springboot 為 Group
選擇 student-services 為 Artifact
選擇以下依賴項
Web
Actuator
DevTools
點擊生成項目。
將項目導入 Eclipse。文件 - > 導入 - > 現(xiàn)有的 Maven 項目。
如果你想了解這個項目的所有文件,你可以繼續(xù)向下閱讀。
應用業(yè)務層實現(xiàn)
所有應用都需要數(shù)據(jù)。我們將使用 ArrayList 這種內(nèi)存數(shù)據(jù)存儲,而不是與真實數(shù)據(jù)庫交互。
一名學生可以參加多門課程。課程有一個 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) - 為現(xiàn)有學生添加課程
請參閱下面這些文件,具體的實現(xiàn)服務類 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 的值將映射到此參數(shù)。
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 執(zhí)行獲取服務
我們將向 http:// localhost:8080 / students / Student1 / courses / Course1 發(fā)起請求以測試該服務?;貞缦滤?。
{ "id": "Course1", "name": "Spring", "description": "10 Steps", "steps": [ "Learn Maven", "Import Project", "First Example", "Second Example" ] }
下面的圖片顯示了我們?nèi)绾螆?zhí)行 Postman 的 Get Service - 我最喜歡的運行 rest 服務的工具。
添加 POST Rest 服務
當資源創(chuàng)建成功時,POST 服務應該返回創(chuàng)建的狀態(tài)(201)。
@PostMapping(“/students/{studentId}/courses”):為 POST 請求映射 URL
@RequestBody Course newCourse:使用綁定將請求正文綁定到課程對象。
ResponseEntity.created(location).build():返回已創(chuàng)建的狀態(tài)。還將創(chuàng)建資源的位置作為響應標題返回。
@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(); }
執(zhí)行 POST Rest 服務
示例請求如下所示。它包含了學生注冊課程的所有細節(jié)。
{ "name": "Microservices", "description": "10 Steps", "steps": [ "Learn How to Break Things Up", "Automate the hell out of everything", "Have fun" ] }
下圖顯示了我們?nèi)绾螐?Postman 執(zhí)行 Post 服務 - 我最喜歡的運行 rest 服務的工具。確保你去 Body 選項卡并選擇 raw。從下拉菜單中選擇 JSON。將上述請求復制到 body 中。
我們使用的 URL 是 http:// localhost:8080 / students / Student1 / courses。
完整的代碼示例
pom.xml
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.in28minutes.springboot</groupId> <artifactId>student-services</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>student-services</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.4.4.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
src/main/java/com/in28minutes/springboot/controller/StudentController.java
import java.net.URI; import java.util.List; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.servlet.support.ServletUriComponentsBuilder; 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); } @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(); } }
src/main/java/com/in28minutes/springboot/model/Course.java
import java.util.List; public class Course { private String id; private String name; private String description; private List<String> steps; // Needed by Caused by: com.fasterxml.jackson.databind.JsonMappingException: // Can not construct instance of com.in28minutes.springboot.model.Course: // no suitable constructor found, can not deserialize from Object value // (missing default constructor or creator, or perhaps need to add/enable // type information?) public Course() { } public Course(String id, String name, String description, List<String> steps) { super(); this.id = id; this.name = name; this.description = description; this.steps = steps; } public String getId() { return id; } public void setId(String id) { this.id = id; } public String getDescription() { return description; } public String getName() { return name; } public List<String> getSteps() { return steps; } @Override public String toString() { return String.format( "Course [id=%s, name=%s, description=%s, steps=%s]", id, name, description, steps); } @Override public int hashCode() { final int prime = 31; int result = 1; result = prime * result + ((id == null) ? 0 : id.hashCode()); return result; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (getClass() != obj.getClass()) return false; Course other = (Course) obj; if (id == null) { if (other.id != null) return false; } else if (!id.equals(other.id)) return false; return true; } }
src/main/java/com/in28minutes/springboot/model/Student.java
package com.in28minutes.springboot.model; import java.util.List; public class Student { private String id; private String name; private String description; private List<Course> courses; public Student(String id, String name, String description, List<Course> courses) { super(); this.id = id; this.name = name; this.description = description; this.courses = courses; } public String getId() { return id; } public void setId(String id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getDescription() { return description; } public void setDescription(String description) { this.description = description; } public List<Course> getCourses() { return courses; } public void setCourses(List<Course> courses) { this.courses = courses; } @Override public String toString() { return String.format( "Student [id=%s, name=%s, description=%s, courses=%s]", id, name, description, courses); } }
src/main/java/com/in28minutes/springboot/service/StudentService.java
package com.in28minutes.springboot.service; import java.math.BigInteger; import java.security.SecureRandom; import java.util.ArrayList; import java.util.Arrays; import java.util.List; import org.springframework.stereotype.Component; import com.in28minutes.springboot.model.Course; import com.in28minutes.springboot.model.Student; @Component public class StudentService { private static List<Student> students = new ArrayList<>(); static { //Initialize Data Course course1 = new Course("Course1", "Spring", "10 Steps", Arrays .asList("Learn Maven", "Import Project", "First Example", "Second Example")); Course course2 = new Course("Course2", "Spring MVC", "10 Examples", Arrays.asList("Learn Maven", "Import Project", "First Example", "Second Example")); Course course3 = new Course("Course3", "Spring Boot", "6K Students", Arrays.asList("Learn Maven", "Learn Spring", "Learn Spring MVC", "First Example", "Second Example")); Course course4 = new Course("Course4", "Maven", "Most popular maven course on internet!", Arrays.asList( "Pom.xml", "Build Life Cycle", "Parent POM", "Importing into Eclipse")); Student ranga = new Student("Student1", "Ranga Karanam", "Hiker, Programmer and Architect", new ArrayList<>(Arrays .asList(course1, course2, course3, course4))); Student satish = new Student("Student2", "Satish T", "Hiker, Programmer and Architect", new ArrayList<>(Arrays .asList(course1, course2, course3, course4))); students.add(ranga); students.add(satish); } public List<Student> retrieveAllStudents() { return students; } public Student retrieveStudent(String studentId) { for (Student student : students) { if (student.getId().equals(studentId)) { return student; } } return null; } public List<Course> retrieveCourses(String studentId) { Student student = retrieveStudent(studentId); if (student == null) { return null; } return student.getCourses(); } public Course retrieveCourse(String studentId, String courseId) { Student student = retrieveStudent(studentId); if (student == null) { return null; } for (Course course : student.getCourses()) { if (course.getId().equals(courseId)) { return course; } } return null; } private SecureRandom random = new SecureRandom(); public Course addCourse(String studentId, Course course) { Student student = retrieveStudent(studentId); if (student == null) { return null; } String randomId = new BigInteger(130, random).toString(32); course.setId(randomId); student.getCourses().add(course); return course; } }
src/main/java/com/in28minutes/springboot/StudentServicesApplication.java
package com.in28minutes.springboot; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class StudentServicesApplication { public static void main(String[] args) { SpringApplication.run(StudentServicesApplication.class, args); } }
以上是“如何使用Spring Boot創(chuàng)建簡單的REST服務”這篇文章的所有內(nèi)容,感謝各位的閱讀!希望分享的內(nèi)容對大家有幫助,更多相關(guān)知識,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道!
當前題目:如何使用SpringBoot創(chuàng)建簡單的REST服務
URL鏈接:http://jinyejixie.com/article10/jojodo.html
成都網(wǎng)站建設公司_創(chuàng)新互聯(lián),為您提供建站公司、網(wǎng)站內(nèi)鏈、服務器托管、響應式網(wǎng)站、標簽優(yōu)化、搜索引擎優(yōu)化
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)