詳解springboot@getmapping

一、getmapping介紹

getmapping指的是一個用於處理HTTP GET請求的註解，被應用在Spring Boot的Controller層方法上，告訴Spring Boot哪個請求能夠被該方法所處理。當一個HTTP GET請求到達該Controller時，Spring Boot會調用對應的方法，方法中的處理結果被返回給客戶端。

例如，我們有一個GetUserController，它有一個findUser方法，該方法處理HTTP GET請求，並返回用戶相關信息。

@GetMapping("/users/{id}")
public User findUser(@PathVariable Long id) {
    return userService.findById(id);
}

上述代碼中，我們用@GetMapping註解處理與”/users/{id}”匹配的HTTP GET請求，並將路徑變數id映射到方法參數id上，然後從userService中獲取用戶相關信息，並返回給客戶端。

二、映射請求路徑

使用@GetMapping註解來處理HTTP GET請求，它支持一個路徑參數，用於映射請求路徑。我們可以使用字元串來指定請求的路徑:

@GetMapping("/users")
public List getUsers() {
    return userService.findAll();
}

上述代碼中，我們使用@GetMapping(“/users”)來映射/users路徑，當用戶請求該路徑時將會調用getUsers方法來處理。

另外，我們可以定義帶有路徑變數的路徑，例如：

@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
    return userService.findById(id);
}

上述代碼中，我們使用@GetMapping(“/users/{id}”)來映射含有路徑變數的路徑/users/{id}，當用戶請求該路徑時將會調用getUserById方法來處理。

三、映射請求參數

除了路徑之外，我們還可以使用@RequestParam註解來映射請求參數。我們可以通過@RequestParam註解來指定請求參數名：

@GetMapping("/users")
public List getUsersByPage(@RequestParam Integer page, @RequestParam Integer size) {
    return userService.findUsersByPage(page, size);
}

上述代碼中，我們使用@GetMapping(“/users”)來映射/users路徑，使用@RequestParam註解來獲取客戶端傳遞進來的兩個參數 page 和 size，然後調用userService中類似於findUsersByPage方法去查詢對應頁碼和每頁的大小，返回查詢結果給客戶端。

四、跳轉路徑和重定向路徑

除了返回數據，getmapping還能夠用於處理請求的路徑跳轉和重定向。我們可以使用ModelAndView和RedirectView對象來處理跳轉路徑和重定向路徑。在返回值中加上View實例，返回客戶端。

@GetMapping("/")
public ModelAndView index() {
    ModelAndView modelAndView = new ModelAndView("index");
    return modelAndView;
}

@GetMapping("/home")
public RedirectView home() {
    RedirectView redirectView = new RedirectView("/index");
    return redirectView;
}

上述代碼中，我們使用ModelAndView對象處理index請求，它將返回一個名為index的模板。使用RedirectView對象處理home請求，它將返回一個重定向路徑為/index的視圖。

五、使用@ResponseBody註解

當我們在Controller方法中返回一個對象或集合時，該對象或集合會自動序列化為JSON或XML格式返回給客戶端。但是，如果我們返回一個字元串或其他非JSON或XML格式數據，則需要使用@ResponseBody註解來告訴Spring Boot將其直接返回給客戶端。

@GetMapping("/greeting")
@ResponseBody
public String greeting() {
    return "Hello, world!";
}

上述代碼中，我們使用@ResponseBody註解告訴Spring Boot將字元串「Hello, world!」直接返回給客戶端。

六、處理異常情況

getmapping也支持處理異常情況，我們可以使用@ExceptionHandler註解來定義異常處理程序：

@GetMapping("/users/{id}")
public User findUser(@PathVariable Long id) throws UserNotFoundException {
    User user = userService.findById(id);
    if (user == null) {
        throw new UserNotFoundException();
    }
    return user;
}

@ExceptionHandler(UserNotFoundException.class)
public ResponseEntity handleUserNotFoundException(UserNotFoundException e) {
    return ResponseEntity.status(HttpStatus.NOT_FOUND).body("User not found");
}

上述代碼中，我們在findUser方法中如果找不到用戶，則拋出UserNotFoundException異常。然後，我們定義了一個handleUserNotFoundException方法，該方法使用ResponseEntity返回一個字元串「User not found」，並返回HTTP 404狀態碼。

結論

本文介紹了Spring Boot中使用getmapping註解處理HTTP GET請求的方法，包括映射請求路徑、請求參數、跳轉路徑和重定向路徑、使用@ResponseBody註解和處理異常情況等。getmapping提供了一種簡單而方便的方式來處理HTTP GET請求，從而使得開發更加高效和快速。