2022就業季|Spring認證教你,如何使用 Spring 構建 REST 服務(二)
書接上文???
HTTP 是平臺
要使用 Web 層次包裝您的存儲庫,您必須使用 Spring MVC。多虧了 Spring Boot,代碼基礎設施很少。相反,我們可以專注于行動:
nonrest/src/main/java/payroll/EmployeeController.java
package payroll;
import java.util.List;
import org.springframework.web.bind.annotation.DeleteMapping;
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.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
class EmployeeController {
private final EmployeeRepository repository;
EmployeeController(EmployeeRepository repository) {
this.repository = repository;
}
// Aggregate root
// tag::get-aggregate-root[]
@GetMapping("/employees")
List<Employee> all() {
return repository.findAll();
}
// end::get-aggregate-root[]
@PostMapping("/employees")
Employee newEmployee(@RequestBody Employee newEmployee) {
return repository.save(newEmployee);
}
// Single item
@GetMapping("/employees/{id}")
Employee one(@PathVariable Long id) {
return repository.findById(id)
.orElseThrow(() -> new EmployeeNotFoundException(id));
}
@PutMapping("/employees/{id}")
Employee replaceEmployee(@RequestBody Employee newEmployee, @PathVariable Long id) {
return repository.findById(id)
.map(employee -> {
employee.setName(newEmployee.getName());
employee.setRole(newEmployee.getRole());
return repository.save(employee);
})
.orElseGet(() -> {
newEmployee.setId(id);
return repository.save(newEmployee);
});
}
@DeleteMapping("/employees/{id}")
void deleteEmployee(@PathVariable Long id) {
repository.deleteById(id);
}
}
@RestController表示每個方法返回的數據會直接寫入響應體,而不是渲染模板。
AnEmployeeRepository由構造函數注入到控制器中。
我們有每個操作的路由(@GetMapping、@PostMapping、@PutMapping和@DeleteMapping,對應于 HTTP GET、POST、PUT和DELETE調用)。(注意:閱讀每種方法并了解它們的作用很有用。)
EmployeeNotFoundException是用于指示何時查找但未找到員工的異常。
nonrest/src/main/java/payroll/EmployeeNotFoundException.java
package payroll;
class EmployeeNotFoundException extends RuntimeException {
EmployeeNotFoundException(Long id) {
super("Could not find employee " + id);
}
}
當EmployeeNotFoundException拋出 an 時,Spring MVC 配置的這個額外花絮用于呈現HTTP 404:
nonrest/src/main/java/payroll/EmployeeNotFoundAdvice.java
package payroll;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
@ControllerAdvice
class EmployeeNotFoundAdvice {
@ResponseBody
@ExceptionHandler(EmployeeNotFoundException.class)
@ResponseStatus(HttpStatus.NOT_FOUND)
String employeeNotFoundHandler(EmployeeNotFoundException ex) {
return ex.getMessage();
}
}
@ResponseBody表示此建議直接呈現到響應正文中。
@ExceptionHandlerEmployeeNotFoundException將建議配置為僅在拋出an 時才響應。
@ResponseStatus說要發出一個HttpStatus.NOT_FOUND,即一個HTTP 404。
建議的主體生成內容。在這種情況下,它會給出異常的消息。
要啟動應用程序,請右鍵單擊其中并從 IDEpublic static void main中PayRollApplication選擇運行,或者:
Spring Initializr 使用 maven 包裝器,所以輸入:
$ ./mvnw clean spring-boot:run
或者使用您安裝的 Maven 版本輸入:
$ mvn clean spring-boot:run
當應用程序啟動時,我們可以立即對其進行詢。
$ curl -v localhost:8080/員工
這將產生:
* 嘗試 ::1...* TCP_NODELAY 設置* 連接到 localhost (::1) 端口 8080 (#0)> GET /員工 HTTP/1.1> 主機:本地主機:8080> 用戶代理:curl/7.54.0> 接受:*/*>< HTTP/1.1 200< 內容類型:application/json;charset=UTF-8< 傳輸編碼:分塊< 日期:格林威治標準時間 2018 年 8 月 9 日星期四 17:58:00<* 連接 #0 到主機 localhost 保持不變[{"id":1,"name":"Bilbo Baggins","role":"竊賊"},{"id":2,"name":"Frodo Baggins","角色":"小偷"} ]
在這里,您可以看到壓縮格式的預加載數據。
如果您嘗試查詢一個不存在的用戶......
$ curl -v localhost:8080/employees/99
你得到…
* 嘗試 ::1...* TCP_NODELAY 設置* 連接到 localhost (::1) 端口 8080 (#0)> 獲取 /employees/99 HTTP/1.1> 主機:本地主機:8080> 用戶代理:curl/7.54.0> 接受:*/*>< HTTP/1.1 404< 內容類型: text/plain;charset=UTF-8< 內容長度:26< 日期:格林威治標準時間 2018 年 8 月 9 日星期四 18:00:56<* 連接 #0 到主機 localhost 保持不變找不到員工 99
此消息很好地顯示了HTTP 404錯誤以及自定義消息Could not find employee 99。
顯示當前編碼的交互并不難……
如果您使用 Windows 命令提示符發出 cURL 命令,則以下命令可能無法正常工作。您必須選擇一個支持單引號參數的終端,或者使用雙引號,然后轉義 JSON 中的那些。
要創建新Employee記錄,我們在終端中使用以下命令——$開頭的表示后面是終端命令:
$ curl -X POST localhost:8080/employees -H 'Content-type:application/json' -d '{"name": "Samwise Gamgee", "role": "gardener"}'
然后它存儲新創建的員工并將其發送回給我們:
{"id":3,"name":"Samwise Gamgee","role":"gardener"}
您可以更新用戶。讓我們改變他的角色。
$ curl -X PUT localhost:8080/employees/3 -H 'Content-type:application/json' -d '{"name": "Samwise Gamgee", "role": "ring bearer"}'
我們可以看到輸出中反映的變化。
{"id":3,"name":"Samwise Gamgee","role":"戒指持有者"}
您構建服務的方式可能會產生重大影響。在這種情況下,我們說update,但replace是更好的描述。例如,如果未提供名稱,則它將被取消。
最后,您可以像這樣刪除用戶:
$ curl -X DELETE 本地主機:8080/employees/3# 現在如果我們再看一遍,它就不見了$ curl localhost:8080/employees/3找不到員工 3
這一切都很好,但是我們有 RESTful 服務了嗎?(如果你沒有聽懂提示,答案是否定的。)
少了什么東西?
......未完待續......
以上就是今天關于Spring的一些討論,對你有幫助嗎?如果你有興趣深入了解,歡迎到Spring中國教育管理中心留言交流!
轉載請在文章開頭和結尾顯眼處標注:作者、出處和鏈接。不按規范轉載侵權必究。
未經授權嚴禁轉載,授權事宜請聯系作者本人,侵權必究。
本文禁止轉載,侵權必究。
授權事宜請至數英微信公眾號(ID: digitaling) 后臺授權,侵權必究。
評論
評論
推薦評論
暫無評論哦,快來評論一下吧!
全部評論(0條)