详解springboot@getmapping

发布时间：2023-05-20

一、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<User> 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<User> 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<String> handleUserNotFoundException(UserNotFoundException e) {
    return ResponseEntity.status(HttpStatus.NOT_FOUND).body("User not found");
}

上述代码中，我们在findUser方法中如果找不到用户，则抛出UserNotFoundException异常。然后，我们定义了一个handleUserNotFoundException方法，该方法使用ResponseEntity<String>返回一个字符串“User not found”，并返回HTTP 404状态码。

结论

本文介绍了Spring Boot中使用getmapping注解处理HTTP GET请求的方法，包括映射请求路径、请求参数、跳转路径和重定向路径、使用@ResponseBody注解和处理异常情况等。getmapping提供了一种简单而方便的方式来处理HTTP GET请求，从而使得开发更加高效和快速。

推荐文章