知識庫 / Spring / Spring Boot RSS 訂閱

因此，我們可以將其用於處理驗證錯誤：

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(MethodArgumentNotValidException.class)
public Map<String, String> handleValidationExceptions(
  MethodArgumentNotValidException ex) {
    Map<String, String> errors = new HashMap<>();
    ex.getBindingResult().getAllErrors().forEach((error) -> {
        String fieldName = ((FieldError) error).getField();
        String errorMessage = error.getDefaultMessage();
        errors.put(fieldName, errorMessage);
    });
    return errors;
}

我們指定了 MethodArgumentNotValidException 異常作為需要處理的異常。因此，Spring Boot會在指定的 User 對象無效時調用該方法。

該方法將每個無效字段的名稱和後置驗證錯誤消息存儲在一個 Map 中。然後，它將 Map 作為 JSON 格式返回給客户端，以便進行進一步處理。

簡單來説，REST 控制器允許我們輕鬆處理不同端點的請求，驗證 User 對象，並將響應發送為 JSON 格式。

該設計足夠靈活，可以處理通過多個 Web 層（包括模板引擎如 Thymeleaf 以及功能齊全的 JavaScript 框架如 Angular）的控制器響應。

6. 測試 REST 控制器

我們可以輕鬆地使用集成測試來測試我們的 REST 控制器的功能。

讓我們首先進行模擬/自動注入 <em >UserRepository</em> 接口實現，以及 <em >UserController</em> 實例，以及 <em >MockMvc</em> 對象：

@RunWith(SpringRunner.class) 
@WebMvcTest
@AutoConfigureMockMvc
public class UserControllerIntegrationTest {

    @MockBean
    private UserRepository userRepository;
    
    @Autowired
    UserController userController;

    @Autowired
    private MockMvc mockMvc;

    //...
    
}

由於我們僅測試 Web 層，因此使用 @WebMvcTest 註解。它允許我們使用 Spring Test 提供的靜態方法集輕鬆測試請求和響應。同時，它還利用了 MockMvcRequestBuilders 和 MockMvcResultMatchers 類。

現在，讓我們使用有效的和無效的 User 對象在請求體中，測試 addUser() 方法：

@Test
public void whenPostRequestToUsersAndValidUser_thenCorrectResponse() throws Exception {
    MediaType textPlainUtf8 = new MediaType(MediaType.TEXT_PLAIN, Charset.forName("UTF-8"));
    String user = "{\"name\": \"bob\", \"email\" : \"[email protected]\"}";
    mockMvc.perform(MockMvcRequestBuilders.post("/users")
      .content(user)
      .contentType(MediaType.APPLICATION_JSON_UTF8))
      .andExpect(MockMvcResultMatchers.status().isOk())
      .andExpect(MockMvcResultMatchers.content()
        .contentType(textPlainUtf8));
}

@Test
public void whenPostRequestToUsersAndInValidUser_thenCorrectResponse() throws Exception {
    String user = "{\"name\": \"\", \"email\" : \"[email protected]\"}";
    mockMvc.perform(MockMvcRequestBuilders.post("/users")
      .content(user)
      .contentType(MediaType.APPLICATION_JSON_UTF8))
      .andExpect(MockMvcResultMatchers.status().isBadRequest())
      .andExpect(MockMvcResultMatchers.jsonPath("$.name", Is.is("Name is mandatory")))
      .andExpect(MockMvcResultMatchers.content()
        .contentType(MediaType.APPLICATION_JSON_UTF8));
    }
}

此外，我們還可以使用免費的 API 生命週期測試應用程序（例如 Postman）測試 REST 控制器 API。

7. 運行示例應用程序

最後，我們可以使用標準 main() 方法運行我們的示例項目：

@SpringBootApplication
public class Application {
    
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    
    @Bean
    public CommandLineRunner run(UserRepository userRepository) throws Exception {
        return (String[] args) -> {
            User user1 = new User("Bob", "[email protected]");
            User user2 = new User("Jenny", "[email protected]");
            userRepository.save(user1);
            userRepository.save(user2);
            userRepository.findAll().forEach(System.out::println);
        };
    }
}

正如預期的那樣，我們應該在控制枱中看到幾個 User 對象被打印出來。

向 http://localhost:8080/users 端點發送一個有效的 User 對象，將會返回字符串 “User is valid”。

同樣，向帶有缺少 name 和 email 值的 User 對象發送 POST 請求，將會返回以下響應：

{
  "name":"Name is mandatory",
  "email":"Email is mandatory"
}

8. 結論

在本文中，我們學習了在 Spring Boot 中進行驗證的基礎知識。