重拾后端之Spring Boot(一):REST API的搭建可以這樣簡單
重拾后端之Spring Boot(二):MongoDb的無縫集成
重拾后端之Spring Boot(三):找回熟悉的Controller,Service
重拾后端之Spring Boot(四):使用 JWT 和 Spring Security 保護 REST API
重拾后端之Spring Boot(五):跨域、自定義查詢及分頁
重拾后端之Spring Boot(六):熱加載、容器和多項目
找回熟悉的Controller,Service
Controller哪兒去了?
對于很多習慣了Spring開發的同學來講,Controller
,Service
,DAO
這些套路突然間都沒了會有不適感。其實呢,這些東西還在,只不過對于較簡單的情景下,這些都變成了系統背后幫你做的事情。這一小節我們就先來看看如何將Controller再召喚回來。召喚回來的好處有哪些呢?首先我們可以自定義API URL的路徑,其次可以對參數和返回的json結構做一定的處理。
如果要讓 TodoController
可以和 TodoRepository
配合工作的話,我們當然需要在 TodoController
中需要引用 TodoRepository
。
public class TodoController {
@Autowired
private TodoRepository repository;
//省略其它部分
}
@Autowired
這個修飾符是用于做依賴性注入的,上面的用法叫做 field injection
,直接做類成員的注入。但Spring現在鼓勵用構造函數來做注入,所以,我們來看看構造函數的注入方法:
public class TodoController {
private TodoRepository repository;
@Autowired
public TodoController(TodoRepository repository){
this.repository = repository;
}
//省略其它部分
}
當然我們為了可以讓Spring知道這是一個支持REST API的 Controller
,還是需要標記其為 @RestController
。由于默認的路徑映射會在資源根用復數形式,由于todo是輔音后的o結尾,按英語習慣,會映射成 todoes
。但這里用 todos
比 todoes
更舒服一些,所以我們再使用另一個 @RequestMapping("/todos")
來自定義路徑。這個 Controller
中的其它方法比較簡單,就是利用repository中的方法去增刪改查即可。
package dev.local.todo;
import org.bson.types.ObjectId;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/todos")
public class TodoController {
private TodoRepository repository;
@Autowired
public TodoController(TodoRepository repository){
this.repository = repository;
}
@RequestMapping(method = RequestMethod.GET)
public List<Todo> getAllTodos(@RequestHeader(value = "userId") String userId) {
return repository.findByUserId(new ObjectId(userId));
}
@RequestMapping(method = RequestMethod.POST)
Todo addTodo(@RequestBody Todo addedTodo) {
return repository.insert(addedTodo);
}
@RequestMapping(value = "/{id}", method = RequestMethod.GET)
public Todo getTodo(@PathVariable String id) {
return repository.findOne(id);
}
@RequestMapping(value = "/{id}", method = RequestMethod.PUT)
Todo updateTodo(@PathVariable String id, @RequestBody Todo updatedTodo) {
updatedTodo.setId(id);
return repository.save(updatedTodo);
}
@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
Todo removeTodo(@PathVariable String id) {
Todo deletedTodo = repository.findOne(id);
repository.delete(id);
return deletedTodo;
}
}
上面的代碼中需要再說明幾個要點:
- 為什么在類上標記
@RequestMapping("/todos")
后在每個方法上還需要添加@RequestMapping
?類上面定義的@RequestMapping
的參數會默認應用于所有方法,但如果我們發現某個方法需要有自己的特殊值時,就需要定義這個方法的映射參數。比如上面例子中addTodo
,路徑也是todos
,但要求 Request的方法是POST
,所以我們給出了@RequestMapping(method = RequestMethod.POST)
。但getTodo
方法的路徑應該是todos/:id
,這時我們要給出@RequestMapping(value = "/{id}", method = RequestMethod.GET)
- 這些方法接受的參數也使用了各種修飾符,
@PathVariable
表示參數是從路徑中得來的,而@RequestBody
表示參數應該從 Http Request的body
中解析,類似的@RequestHeader
表示參數是 Http Request的Header中定義的。
在可以測試之前,我們還需要使用 @Repository
來標記 TodoRepository
,以便于Spring可以在依賴注入時可以找到這個類。
package dev.local.todo;
import org.bson.types.ObjectId;
import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.stereotype.Repository;
import java.util.List;
/**
* Created by wangpeng on 2017/1/26.
*/
@Repository
public interface TodoRepository extends MongoRepository<Todo, String>{
List<Todo> findByUserId(ObjectId userId);
}
接下來就可以用PostMan做一下測試:

Service呢?在哪里?
熟悉Spring的童鞋肯定會問,我們剛才的做法等于直接是Controller訪問Data了,隔離不夠啊。其實我覺得有很多時候,這種簡單設計是挺好的,因為業務還沒有到達那步,過于復雜的設計其實沒啥太大意義。但這里我們還是一步步來實踐一下,找回大家熟悉的感覺。
回到原來的熟悉模式再簡單不過的,新建一個 TodoService
接口,定義一下目前的增刪改查幾個操作:
public interface TodoService {
Todo addTodo(Todo todo);
Todo deleteTodo(String id);
List<Todo> findAll(String userId);
Todo findById(String id);
Todo update(Todo todo);
}
為預防我們以后使用 MySQL
等潛在的 “可擴展性”,我們給這個接口的實現命名為 MongoTodoServiceImpl
,然后把 Controller
中的大部分代碼拿過來改改就行了。當然為了系統可以找到這個依賴并注入需要的類中,我們標記它為 @Service
@Service
public class MongoTodoServiceImpl implements TodoService{
private final TodoRepository repository;
@Autowired
MongoTodoServiceImpl(TodoRepository repository) {
this.repository = repository;
}
@Override
public Todo addTodo(Todo todo) {
return repository.insert(todo);
}
@Override
public Todo deleteTodo(String id) {
Todo deletedTodo = repository.findOne(id);
repository.delete(id);
return deletedTodo;
}
@Override
public List<Todo> findAll(String userId) {
return repository.findByUserId(new ObjectId(userId));
}
@Override
public Todo findById(String id) {
return repository.findOne(id);
}
@Override
public Todo update(Todo todo) {
repository.save(todo);
return todo;
}
}
最后把Controller中的所有方法改為使用Service的簡單調用就大功告成了。
public class TodoController {
private TodoService service;
@Autowired
public TodoController(TodoService service){
this.service = service;
}
@RequestMapping(method = RequestMethod.GET)
public List<Todo> getAllTodos(@RequestHeader(value = "userId") String userId) {
return service.findAll(userId);
}
@RequestMapping(method = RequestMethod.POST)
Todo addTodo(@RequestBody Todo addedTodo) {
return service.addTodo(addedTodo);
}
@RequestMapping(value = "/{id}", method = RequestMethod.GET)
public Todo getTodo(@PathVariable String id) {
return service.findById(id);
}
@RequestMapping(value = "/{id}", method = RequestMethod.PUT)
Todo updateTodo(@PathVariable String id, @RequestBody Todo updatedTodo) {
updatedTodo.setId(id);
return service.update(updatedTodo);
}
@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
Todo removeTodo(@PathVariable String id) {
return service.deleteTodo(id);
}
}
說實話如果每個簡單類都這么寫,我深深地趕腳背離了Spring Boot的意圖,雖然你能舉出1000個理由這么做有好處。類似的,DAO或DTO要寫起來也很簡單,但我還是建議在業務沒有復雜之前還是享受Spring Boot帶給我們的便利吧。
本章代碼:https://github.com/wpcfan/spring-boot-tut/tree/chap03
重拾后端之Spring Boot(一):REST API的搭建可以這樣簡單
重拾后端之Spring Boot(二):MongoDb的無縫集成
重拾后端之Spring Boot(三):找回熟悉的Controller,Service
重拾后端之Spring Boot(四):使用 JWT 和 Spring Security 保護 REST API
重拾后端之Spring Boot(五):跨域、自定義查詢及分頁
有問題的童鞋可以加入我的小密圈討論: http://t.xiaomiquan.com/jayRnaQ (該鏈接7天內(5月14日前)有效)
另外,我的 《Angular 從零到一》出版了,下面是書籍的內容簡介:
本書系統介紹Angular的基礎知識與開發技巧,可幫助前端開發者快速入門。共有9章,第1章介紹Angular的基本概念,第2~7章從零開始搭建一個待辦事項應用,然后逐步增加功能,如增加登錄驗證、將應用模塊化、多用戶版本的實現、使用第三方樣式庫、動態效果制作等。第8章介紹響應式編程的概念和Rx在Angular中的應用。第9章介紹在React中非常流行的Redux狀態管理機制,這種機制的引入可以讓代碼和邏輯隔離得更好,在團隊工作中強烈建議采用這種方案。本書不僅講解Angular的基本概念和最佳實踐,而且分享了作者解決問題的過程和邏輯,講解細膩,風趣幽默,適合有面向對象編程基礎的讀者閱讀。
歡迎大家圍觀、訂購、提出寶貴意見。
京東鏈接:https://item.m.jd.com/product/12059091.html?from=singlemessage&isappinstalled=0