Anotaciones comunes de SpringBoot

2024-07-12

@ControladorRest

Es el acoplamiento de @ResponseBody y @Controller,

@Controller indica que la clase es un controlador y @ResponseBody indica que el objeto devuelto por el método del controlador se usa directamente como el cuerpo de la respuesta HTTP, en lugar de como una vista.

Comentarios escritos en listas de parámetros.

@VariableDePath：

@GetMapping("/users/{userId}")

Se utiliza para extraer variables de plantillas de URL.
Cuando define una API RESTful, puede usarla para capturar los parámetros de ruta definidos en la URL.
Por ejemplo, si tienes un patrón de URL/users/{userId}y la URL solicitada es/users/123,Entonces123se puede utilizar comouserIdParámetros pasados a los métodos del controlador.
generalmente con@RequestMappingo@GetMapping、@PostMappingÚselo junto con otras anotaciones.


@GetMapping("/users/{userId}")
public User getUserById(@PathVariable("userId") int userId) { // 根据userId获取用户信息 }

@RequestParam：

Se utiliza para extraer valores de los parámetros de consulta de la solicitud.
Le permite acceder a la parte de la cadena de consulta de la URL, p.?name=value。
Se puede utilizar incluso si no se especifican parámetros en la solicitud.required=falseLa propiedad se establece como opcional, o pordefaultValueLa propiedad proporciona un valor predeterminado.
generalmente con@RequestMappingo@GetMapping、@PostMappingÚselo junto con otras anotaciones.


@GetMapping("/search") 
public List<User> searchUsers(@RequestParam(value = "name", required = false) String name) { // 根据提供的name参数搜索用户 }

@CuerpoDeSolicitación

@RequestBodyLe permite convertir automáticamente el cuerpo de la solicitud (JSON, XML, etc.) enviado por el cliente (a través de un convertidor apropiado, como Jackson o JAXB) y vincularlo a un objeto.
cuando usas@RequestBody Cuando , se espera que la solicitud enviada por el cliente tenga un cuerpo de solicitud que no esté vacío. Si el cuerpo de la solicitud está vacío, Spring generará una excepción.
Se utiliza para asignar el cuerpo de la solicitud HTTP a los parámetros del método del controlador.
Se utiliza principalmente para solicitudes como POST, PUT y PATCH, que generalmente requieren que el cliente envíe datos para crear o actualizar recursos.


@PostMapping("/users")
public ResponseEntity<?> addUser(@RequestBody User user) {
    // 将接收到的User对象保存到数据库
    userService.addUser(user);
    return ResponseEntity.ok().build();
}

Compartir tecnología