springboot的controller层的常用注解说明

更新时间：2023年10月25日 16:32:34 作者：旺仔001

这篇文章主要介绍了springboot的controller层的常用注解说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

1、@RestController

将一个类标识为控制器，并使其支持RESTful风格的API。它是@Controller和@ResponseBody的组合注解。

@Controller 将当前修饰的类注入SpringBoot IOC容器，使得从该类所在的项目跑起来的过程中，这个类就被实例化。

@ResponseBody 它的作用简短截说就是指该类中所有的API接口返回的数据，甭管你对应的方法返回Map或是其他Object，它会以Json字符串的形式返回给客户端

@RestController
public class UserController {
    // Controller methods
}

2、@RequestMapping

映射HTTP请求到处理方法或控制器类级别。

可以用于类级别的注解来定义基本的URL路径，并且可以在方法级别的注解中添加进一步的路径。

@RestController
@RequestMapping("/users")
public class UserController {
    // Methods with specific request mappings
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        // Method implementation
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        // Method implementation
    }
}

3、@GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping

分别映射HTTP的GET、POST、PUT、DELETE和PATCH请求到处理方法。

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        // Method implementation
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        // Method implementation
    }

    @PutMapping("/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        // Method implementation
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        // Method implementation
    }

    @PatchMapping("/{id}")
    public User partialUpdateUser(@PathVariable Long id, @RequestBody UserPartialUpdateRequest request) {
        // Method implementation
    }
}

4、@PathVariable

用于将URL路径中的占位符参数绑定到处理方法的参数上

@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
    // Method implementation
}

5、@RequestParam

用于将请求参数绑定到处理方法的参数上。

可以指定参数的名称、是否必需以及默认值。

@GetMapping("/users")
public List<User> getUsersByRole(@RequestParam("role") String role) {
    // Method implementation
}

6、@RequestBody

用于将请求体中的数据绑定到处理方法的参数上，通常用于处理POST请求的JSON数据。

@PostMapping("/users")
public User createUser(@RequestBody User user) {
   // Method implementation
}

7、@RequestHeader

用于将请求头中的信息绑定到处理方法的参数上。

@GetMapping("/users")
public List<User> getUsersByLocale(@RequestHeader("Accept-Language") String locale) {
    // Method implementation
}

8、@ResponseBody

将方法的返回值直接作为HTTP响应的内容返回，而不是将其解析为视图。

@GetMapping("/users/{id}")
@ResponseBody
public User getUserById(@PathVariable Long id) {
    // Method implementation
}

9、@ResponseStatus

设置响应的HTTP状态码。

@DeleteMapping("/users/{id}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteUser(@PathVariable Long id) {
   // Method implementation
}

10、@ModelAttribute

用于绑定请求参数到一个模型对象，并使其可在视图中访问。

@GetMapping("/users/{id}")
public String getUserDetails(@PathVariable Long id, @ModelAttribute("message") String message) {
    // Method implementation
}

11、@Valid

用于验证绑定的请求参数，结合JSR-303 Bean Validation规范进行数据校验。

@PostMapping("/users")
public ResponseEntity<?> createUser(@Valid @RequestBody User user, BindingResult result) {
    if (result.hasErrors()) {
        // Handle validation errors
    }
    // Method implementation
}

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

关于SSM框架下各层的解释说明(Controller等)
这篇文章主要介绍了关于SSM框架下各层的解释说明(Controller等)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-02-02
使用lombok的@Data会导致栈溢出StackOverflowError问题
这篇文章主要介绍了使用lombok的@Data会导致栈溢出StackOverflowError问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-11-11
Java编程之多线程死锁与线程间通信简单实现代码
这篇文章主要介绍了Java编程之多线程死锁与线程间通信简单实现代码，具有一定参考价值，需要的朋友可以了解下。
2017-10-10
Java NIO Files类读取文件流方式小结
本文主要介绍了Java NIO Files类读取文件流方式小结，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-07-07
java中ZXing 生成、解析二维码图片的小示例
ZXing 是一个开源 Java 类库用于解析多种格式的 1D/2D 条形码，这篇文章主要介绍了java中ZXing 生成、解析二维码图片的小示例，有兴趣的可以了解一下。
2017-01-01
Android Home键监听的实现代码
这篇文章主要介绍了Android Home 键监听的实现代码,小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-12-12
在Java的JDBC使用中设置事务回滚的保存点的方法
这篇文章主要介绍了在Java的JDBC使用中设置事务回滚的保存点的方法,JDBC是Java用于连接各种数据库的API,需要的朋友可以参考下
2015-12-12
Java利用序列化实现对象深度clone的方法
这篇文章主要介绍了Java利用序列化实现对象深度clone的方法,实例分析了java序列化及对象克隆的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-07-07
一文详解Java中Map和Set接口的使用方法
Map和set是一种专门用来进行搜索的容器或者数据结构,其搜索的效率与其具体的实例化子类有关,可能在查找时进行一些插入和删除的操作,即动态查找,那上述两种方式就不太适合了,本节介绍的Map和Set是一种适合动态查找的集合容器,需要的朋友可以参考下
2024-08-08
MyBatis实现SQL映射文件
映射器是 MyBatis 中最复杂并且是最重要的组件,本文主要介绍了MyBatis实现SQL映射文件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2024-06-06