說明

通過實現訂單的增刪改查，初步瞭解web相關的構建和使用

REStful API規劃

常用註解說明

1. @Controller：修飾class，用來建立處理http請求的物件
2. @RestController：Spring4之後加入的註解，原來在@Controller中返回json需要@ResponseBody來配合，如果直接用@RestController替代@Controller就不需要再配置@ResponseBody，預設返回json格式。
3. @RequestMapping：配置url對映
4. @PathVariable：通過 @PathVariable 可以將 URL 中佔位符引數繫結到控制器處理方法的入參中：URL 中的 {xxx} 佔位符可以通過@PathVariable(“xxx“) 繫結到操作方法的入參中。
5. @ModelAttribute：
   ①繫結請求引數到命令物件：放在功能處理方法的入參上時，用於將多個請求引數繫結到一個命令物件，從而簡化繫結流程，而且自動暴露為模型資料用於檢視頁面展示時使用；
   ②暴露表單引用物件為模型資料：放在處理器的一般方法（非功能處理方法）上時，是為表單準備要展示的表單引用物件，如註冊時需要選擇的所在城市等，而且在執行功能處理方法（@RequestMapping註解的方法）之前，自動新增到模型物件中，用於檢視頁面展示時使用；
   ③暴露@RequestMapping方法返回值為模型資料：放在功能處理方法的返回值上時，是暴露功能處理方法的返回值為模型資料，用於檢視頁面展示時使用。
6. @RequestParam：獲取url中的引數，用於將請求引數區資料對映到功能處理方法的引數上。

程式碼參考

實體類order

package com.sunld.domain;

public class Order {

    /**
     * 訂單id
     */
    private Integer id;
    /**
     * 訂單名稱
     */
    private String orderName;
    /**
     * 訂單型別
     */
    private String orderType;

    /**
     * get、set方法
     */
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getOrderName() {
        return orderName;
    }
    public void setOrderName(String orderName) {
        this.orderName = orderName;
    }
    public String getOrderType() {
        return orderType;
    }
    public void setOrderType(String orderType) {
        this.orderType = orderType;
    }
    @Override
    public String toString() {
        return "Order [id=" + id + ", orderName=" + orderName + ", orderType=" + orderType + "]";
    }
}

Controller：OrderController

package com.sunld;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.sunld.domain.Order;

@RestController
//定義統一的入口，通過這裡配置使下面的對映都在/orders下
@RequestMapping("/orders")
public class OrderController {

    //定義執行緒安全的map用來儲存訂單資訊
    private static final Map<Integer , Order> staticOrderMap = 
            Collections.synchronizedMap(new HashMap<Integer, Order>());

    /**
     * 查詢所有訂單
     * url地址：http://127.0.0.1:8080/orders/
     * 還可以通過@RequestParam從頁面中傳遞引數來進行查詢條件或者翻頁資訊的傳遞
     * @return
     */
    @RequestMapping(value = "/" , method = RequestMethod.GET)
    public List<Order> getOrders(){
        List<Order> orderList = new ArrayList<Order>(staticOrderMap.values());
        return orderList;
    }

    /**
     * 新增訂單
     * url地址：http://127.0.0.1:8080/orders/add
     * @ModelAttribute：用來接收form中的訂單資訊
     * 除了@ModelAttribute繫結引數之外，還可以通過@RequestParam從頁面中傳遞引數
     * @param order
     * @return
     */
    @RequestMapping(value = "/add", method = RequestMethod.POST)
    public String addOrder(@ModelAttribute Order order) {
        if(order != null) {
            staticOrderMap.put(order.getId(), order);
            return "success";
        }
        return "failure";
    }

    /**
     * 根據訂單id獲取訂單資訊
     * url地址：http://127.0.0.1:8080/orders/1234
     * url中的id可通過@PathVariable繫結到函式的引數中
     * @return
     */
    @RequestMapping(value = "/{id}" , method = RequestMethod.GET)
    public Order getOrderById(@PathVariable Integer id) {
        return staticOrderMap.get(id);
    }
    /**
     * 根據訂單id更新訂單資訊
     * url地址：http://127.0.0.1:8080/orders/update/1234
     * @param id
     * @param order
     * @return
     */
    @RequestMapping(value = "/update/{id}" , method = RequestMethod.POST)
    public String updateOrderById(@PathVariable Integer id, @ModelAttribute Order order) {
        Order o = staticOrderMap.get(id);
        if(o != null && order != null) {
            o.setOrderName(order.getOrderName());
            o.setOrderType(order.getOrderType());
            staticOrderMap.put(id, o);
            return "success";
        }else {
            return "failure";
        }
    }
    /**
     * 根據訂單ID刪除訂單資訊
     * url地址：http://127.0.0.1:8080/orders/delete/1234
     * @param id
     * @return
     */
    @RequestMapping(value="/delete/{id}", method=RequestMethod.DELETE) 
    public String deleteOrderById(@PathVariable Integer id) { 
        staticOrderMap.remove(id); 
        return "success"; 
    } 
}

測試類：OrderControllerTest

package com.sunld.controller;

import static org.hamcrest.CoreMatchers.equalTo;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.ResultActions;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;

import com.sunld.OrderController;

@RunWith(SpringRunner.class)
@SpringBootTest
public class OrderControllerTest {
    private MockMvc mvc; 

    @Before 
    public void setUp() throws Exception { 
        mvc = MockMvcBuilders.standaloneSetup(new OrderController()).build(); 
    } 

    @Test
    public void testOrderController() throws Exception {
        //1.建立查詢所有訂單，結果返回為空
        System.out.println("=====================初次查詢所有訂單資訊start=====================");
        getOrders()
           .andExpect(MockMvcResultMatchers.content().string(equalTo("[]")))
           .andReturn();
        System.out.println("=====================初次查詢所有訂單資訊end=======================");
        System.out.println("=====================第一次新增訂單start=========================");
        // 2、post提交一個訂單
        mvc.perform(MockMvcRequestBuilders.post("/orders/add")
                        .param("id", "1234")
                        .param("orderName", "購買平板電腦")
                        .param("orderType", "線上付款")
                        .accept(MediaType.APPLICATION_JSON))
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andDo(MockMvcResultHandlers.print())
            .andExpect(MockMvcResultMatchers.content().string(equalTo("success")))
            .andReturn();
        //2.1、查詢所有訂單
        /**
         * 結果應該為"[{\"id\":1234,\"orderName\":\"購買平板電腦\",\"orderType\":\"線上付款\"}]"
         */
        getOrders()
           .andExpect(MockMvcResultMatchers.content().string(equalTo("[{\"id\":1234,\"orderName\":\"購買平板電腦\",\"orderType\":\"線上付款\"}]")))
           .andReturn();
        System.out.println("=====================第一次新增訂單end===========================");
        System.out.println("=====================再次新增訂單start===========================");
        //3、再新增一個訂單
        mvc.perform(MockMvcRequestBuilders.post("/orders/add")
                .param("id", "3456")
                .param("orderName", "購買奶粉")
                .param("orderType", "貨到付款")
                .accept(MediaType.APPLICATION_JSON))
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print())
           .andExpect(MockMvcResultMatchers.content().string(equalTo("success")))
           .andReturn();
        //3.1、檢視所有訂單資訊
        /**
         * 訂單資訊：
         * [{"id":3456,"orderName":"購買奶粉","orderType":"貨到付款"},{"id":1234,"orderName":"購買平板電腦","orderType":"線上付款"}]
         */
        getOrders();
        System.out.println("=====================再次新增訂單end=============================");
        System.out.println("=====================修改存在編號的訂單start============================");
        //4、修改編號為1234的訂單：該訂單存在
        mvc.perform(MockMvcRequestBuilders.post("/orders/update/1234")
                .param("orderName", "訂單名稱由【購買平板電腦】修改為【再次購買平板電腦】")
                .param("orderType", "線上付款")
                .accept(MediaType.APPLICATION_JSON))
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print())
           .andReturn();
        //4.1查詢訂單1234
        getOrdersById("1234");
        System.out.println("=====================修改存在編號的訂單end==============================");
        System.out.println("=====================修改訂單編號不存在的訂單start==============================");
        //5、修改編號為1的訂單、該訂單不存在,直接返回failure
        mvc.perform(MockMvcRequestBuilders.post("/orders/update/1")
                .param("orderName", "訂單名稱由【購買平板電腦】修改為【再次購買平板電腦】")
                .param("orderType", "線上付款")
                .accept(MediaType.APPLICATION_JSON))
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print())
           .andExpect(MockMvcResultMatchers.content().string(equalTo("failure")))
           .andReturn();
        System.out.println("=====================修改訂單編號不存在的訂單end==============================");
        //6、刪除訂單1234
        mvc.perform(MockMvcRequestBuilders.delete("/orders/delete/1234").accept(MediaType.APPLICATION_JSON))
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print())
           .andExpect(MockMvcResultMatchers.content().string(equalTo("success")))
           .andReturn();
        //6、1檢視所有訂單
        getOrders();
    }

    private ResultActions getOrders() throws Exception {
        return mvc.perform(MockMvcRequestBuilders.get("/orders/").accept(MediaType.APPLICATION_JSON))
                  .andExpect(MockMvcResultMatchers.status().isOk())
                  .andDo(MockMvcResultHandlers.print());
//                .andReturn();
    }

    private ResultActions getOrdersById(String id) throws Exception {
        return mvc.perform(MockMvcRequestBuilders.get("/orders/" + id).accept(MediaType.APPLICATION_JSON))
                  .andExpect(MockMvcResultMatchers.status().isOk())
                  .andDo(MockMvcResultHandlers.print());
//                .andReturn();
    }
}

總結

參考

程式碼