前言

這一篇總結一下spring boot中web模組中常用的東西。

構建Restful風格的簡單CRUD

Restful風格，現在我還暫時解釋不清楚，只能意會。具體參考這篇部落格——restful風格介紹

URL	請求型別	介面功能
/users	GET	查詢使用者列表
/users	POST	建立一個使用者
/users/id	GET	根據id查詢一個使用者
/users/id	PUT	根據id更新一個使用者資訊
/users/id	DELETE	根據id刪除一個使用者資訊

準備domain物件

package com.learn.springbootresuful.domain;

/**
 * 
 * @author liman
 * @createtime 2018年8月22日
 * @contract 15528212893
 * @comment:
 *
 */
public class User {
	private Long id;
	private String name;
	private Integer age;

	public Long getId() {
		return id;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public Integer getAge() {
		return age;
	}

	public void setAge(Integer age) {
		this.age = age;
	}

}

 完成controller

其中用到的一些註解需要注意的就是@ModelAttribute和@PathVariable即可，第一個是spring mvc中常用的模型檢視物件標籤。

package com.learn.springbootresuful.web;

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.learn.springbootresuful.domain.User;

@RestController
@RequestMapping(value = "/users")
public class UserController {
	
	static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());

	@RequestMapping(value = "/", method = RequestMethod.GET)
	public List<User> getUserList() {
		List<User> allUser = new ArrayList<User>(users.values());
		return allUser;
	}

	@RequestMapping(value = "/", method = RequestMethod.POST)
	public String postUser(@ModelAttribute User user) {
		// 處理/users/的post請求
		// 除了@ModelAttribute繫結之外，還可以通過@RequestParam從頁面中傳參
		users.put(user.getId(), user);
		return "success";
	}

	@RequestMapping(value = "/{id}", method = RequestMethod.GET)
	public User getUser(@PathVariable Long id) {
		return users.get(id);
	}

	@RequestMapping(value = "/{id}", method = RequestMethod.PUT)
	public String putUser(@PathVariable Long id, @ModelAttribute User user) {
		User u = users.get(id);
		u.setName(user.getName());
		u.setAge(user.getAge());
		users.put(id, u);
		return "success";
	}

	@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
	public String deleteUser(@PathVariable Long id) {
		users.remove(id);
		return "success";
	}
}

controller的測試程式碼

package com.learn.springbootresuful;

import static org.hamcrest.Matchers.equalTo;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockServletContext;
import org.springframework.test.context.junit.jupiter.web.SpringJUnitWebConfig;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.RequestBuilder;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;

import com.learn.springbootresuful.web.HelloController;
import com.learn.springbootresuful.web.UserController;

/**
 * 
 * @author liman
 * @createtime 2018年8月22日
 * @contract 15528212893
 * @comment:
 *
 */

@RunWith(SpringJUnit4ClassRunner.class)
@SpringJUnitWebConfig(classes = MockServletContext.class)
@SpringBootConfiguration
@WebAppConfiguration
public class UserControllerTests {

	private MockMvc mvc;

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

	/**
	 * 測試獲取使用者資訊列表，應該為空
	 * 
	 * @throws Exception
	 */
	 @Test
	 public void getHello() throws Exception {
	 mvc.perform(MockMvcRequestBuilders.get("/").accept(MediaType.APPLICATION_JSON))
	 .andExpect(status().isOk()).andExpect(status().isOk());
	
	 }
	@Test
	public void testUserController() throws Exception {
		RequestBuilder request = null;
		// 1、get查一下user列表，應該為空
		request = get("/users/");
		mvc.perform(request).andExpect(status().isOk()).andExpect(content().string(equalTo("[]")));

		// 2、post提交一個user
		request = post("/users/").param("id", "1").param("name", "測試大師").param("age", "20");
		mvc.perform(request)
				// .andDo(MockMvcResultHandlers.print())
				.andExpect(content().string(equalTo("success")));

		// 3、get獲取user列表，應該有剛才插入的資料
		request = get("/users/");
		mvc.perform(request).andExpect(status().isOk())
				.andExpect(content().string(equalTo("[{\"id\":1,\"name\":\"測試大師\",\"age\":20}]")));

		// 4、put修改id為1的user
		request = put("/users/1").param("name", "測試終極大師").param("age", "30");
		mvc.perform(request).andExpect(content().string(equalTo("success")));

		// 5、get一個id為1的user
		request = get("/users/1");
		mvc.perform(request).andExpect(content().string(equalTo("{\"id\":1,\"name\":\"測試終極大師\",\"age\":30}")));

		// 6、del刪除id為1的user
		request = delete("/users/1");
		mvc.perform(request).andExpect(content().string(equalTo("success")));

		// 7、get查一下user列表，應該為空
		request = get("/users/");
		mvc.perform(request).andExpect(status().isOk()).andExpect(content().string(equalTo("[]")));
	}
}

 靜態資源的訪問（Thymeleaf）

spring boot 中預設的靜態資源存放在classpath下

 spring boot提供了一些模板用於渲染html頁面常見的有Thymeleaf、FreeMarker、Velocity、Groovy、Mustache。這裡對這些也不做詳細介紹

引入Thymeleaf 依賴

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

Controller程式碼

@Controller
@RequestMapping(value="/hello")
public class HelloController {
	
	@RequestMapping("/")
	public String index(ModelMap map) {
		map.addAttribute("host","http://www.baidu.com");
		return "index";
	}
	
}

index.html模板頁

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8" />
    <title></title>
</head>
<body>
<h1 th:text="${host}">Hello World</h1>
</body>
</html>

測試結果

全域性異常的處理

spring boot中提供了一個預設的異常處理請求/error，如果業務程式碼中丟擲異常了，spring boot會去請求這個路徑，然後跳轉到spring boot預設的異常頁面，這個非常不友好。瞭解全域性的異常處理，另一方面對以後養成良好的開發習慣也有一些幫助。

1、定義統一的異常處理類

@ControllerAdvice
public class GlobalExceptionHandler {
	public static final String DEFAULT_ERROR_VIEW="error";
	
	//這裡註解中需要指定異常型別，根據不同的異常，會有不同的處理函式
	@ExceptionHandler(value = Exception.class)
	public ModelAndView defaultErrorHandler(HttpServletRequest request,Exception exception) {
		ModelAndView mav = new ModelAndView();
		mav.addObject("exception",exception);
		mav.addObject("url",request.getRequestURL());
		mav.setViewName(DEFAULT_ERROR_VIEW);
		return mav;
	}
}

@ControllerAdvice定義統一的異常處理類，@ExceptionHandler(value=[異常型別])，上述程式碼中的DEFAULT_ERROR_VIEW只是錯誤頁面的路徑。

2、error.html頁面

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8" />
    <title>異常頁面</title>
</head>
<body>
    <h1>Error Handler</h1>
    <div th:text="${url}"></div>
    <div th:text="${exception.message}"></div>
</body>
</html>

3、測試結果

針對如何將錯誤資訊以json格式返回，在做實驗的時候出現了異常問題，這個後面會補上

To be continued......（未完待續......） 

整合Swagger2

To be continued ......

總結

其實寫到這裡，spring boot中常用的web模組的東西都已經做了一個簡單的總結了，但是都只是一些helloworld，並沒有實際深入。