重拾後端之Spring Boot（三）：找回熟悉的Controller，Service

接灰的電子產品發表於2017-03-02
後端Spring BootController

重拾後端之Spring Boot（一）：REST API的搭建可以這樣簡單
重拾後端之Spring Boot（二）：MongoDb的無縫整合
重拾後端之Spring Boot（三）：找回熟悉的Controller，Service
重拾後端之Spring Boot（四）：使用 JWT 和 Spring Security 保護 REST API

找回熟悉的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;
    }
}複製程式碼

上面的程式碼中需要再說明幾個要點：

  1. 為什麼在類上標記 @RequestMapping("/todos") 後在每個方法上還需要新增 @RequestMapping？類上面定義的 @RequestMapping 的引數會預設應用於所有方法，但如果我們發現某個方法需要有自己的特殊值時，就需要定義這個方法的對映引數。比如上面例子中 addTodo，路徑也是 todos，但要求 Request的方法是 POST，所以我們給出了 @RequestMapping(method = RequestMethod.POST)。但 getTodo 方法的路徑應該是 todos/:id，這時我們要給出 @RequestMapping(value = "/{id}", method = RequestMethod.GET)
  2. 這些方法接受的引數也使用了各種修飾符，@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做一下測試：

重拾後端之Spring Boot（三）：找回熟悉的Controller，Service
測試一下Controller

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帶給我們的便利吧。

本章程式碼：github.com/wpcfan/spri…

重拾後端之Spring Boot（一）：REST API的搭建可以這樣簡單
重拾後端之Spring Boot（二）：MongoDb的無縫整合
重拾後端之Spring Boot（三）：找回熟悉的Controller，Service
重拾後端之Spring Boot（四）：使用 JWT 和 Spring Security 保護 REST API

相關文章