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

時間 2019-11-09

標籤重拾後端 spring boot 找回熟悉 controller service 欄目 Spring 简体版

原文原文鏈接

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

找回熟悉的Controller，Service

Controller哪兒去了？

對於不少習慣了Spring開發的同窗來說，Controller，Service，DAO 這些套路忽然間都沒了會有不適感。其實呢，這些東西還在，只不過對於較簡單的情景下，這些都變成了系統背後幫你作的事情。這一小節咱們就先來看看如何將Controller再召喚回來。召喚回來的好處有哪些呢？首先咱們能夠自定義API URL的路徑，其次能夠對參數和返回的json結構作必定的處理。java

若是要讓 TodoController 能夠和 TodoRepository 配合工做的話，咱們固然須要在 TodoController 中須要引用 TodoRepository。git

public class TodoController {
    @Autowired
    private TodoRepository repository;
    //省略其它部分
}複製代碼

@Autowired 這個修飾符是用於作依賴性注入的，上面的用法叫作 field injection，直接作類成員的注入。但Spring如今鼓勵用構造函數來作注入，因此，咱們來看看構造函數的注入方法：github

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中的方法去增刪改查便可。web

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;
    }
}複製代碼

上面的代碼中須要再說明幾個要點：spring

爲何在類上標記 @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能夠在依賴注入時能夠找到這個類。mongodb

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作一下測試：json

Service呢？在哪裏？

熟悉Spring的童鞋確定會問，咱們剛纔的作法等於直接是Controller訪問Data了，隔離不夠啊。其實我以爲有不少時候，這種簡單設計是挺好的，由於業務尚未到達那步，過於複雜的設計其實沒啥太大意義。但這裏咱們仍是一步步來實踐一下，找回你們熟悉的感受。後端

回到原來的熟悉模式再簡單不過的，新建一個 TodoService 接口，定義一下目前的增刪改查幾個操做：app

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);
    }
}複製代碼