SpringBoot常见注解

最新推荐文章于 2023-03-06 10:36:09 发布
最新推荐文章于 2023-03-06 10:36:09 发布
阅读量380 收藏
点赞数
分类专栏： spring boot注解 文章标签： java spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42825815/article/details/104721216
版权

一、Spring Web MVC注解

1.1 @RequestMapping

@RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行映射。SpringMVC通过RequestMappingHandlerMapping和RequestMappingHandlerAdapter两个类来提供对@RequestMapping注解的支持。
@RequestMapping注解对请求处理类中的处理方法进行标注：@RequestMapping注解拥有以下六个配置的特性：

  • value：映射的请求URL或其他别名
  • method：兼容HTTP的方法名
  • params：根据HTTP参数的存在、缺省或值，对请求进行处理
  • header：根据HTTP Header的存在、缺省或值，对请求进行过滤
  • consume：设定在HTTP请求正文中允许使用的媒体类型
  • product：在HTTP响应体中允许使用的媒体类型

注意：
在使用@RequestMapping之前，要对请求处理的类使用@Controller或@RestController注解。

@RestController
public class TestController {

    @RequestMapping(value = "/demo/test", method = RequestMethod.POST)
    public String test() {
        return "/test";
    }
}

@RestController
@RequestMapping(value = "/demo")
public class TestController {

    @RequestMapping(value = "/test", method = RequestMethod.POST)
    public String test() {
        return "/test";
    }
}
1.2@RequestBody

@RequestBody在处理请求方法的参数列表中使用，它可以将请求参数绑定到一个对象中，请求主体参数是通过 HttpMessageConverter传递的，根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外，还可以通过@Valid注解对请求主体中的参数进行校验。

@RestController
@RequestMapping(value = "/order")
public class TestController {

    @Autowired
    private OrderService orderService;

    @PostMapping("/create")
    public OrderDTO createOrder(@Valid @RequestBody OrderDTO orderDTO){
        return orderService.create(orderDTO);
    }
}
1.3 @GetMapping

@GetMapping注解用于处理HTTP GET请求，并将请求映射到具体的处理方法中。具体的说，@GetMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.GET)

@GetMapping的使用示例：

@RestController
@RequestMapping(value = "/order")
public class TestController {

    @Autowired
    private OrderService orderService;

    @GetMapping("/find/{id}")
    public OrderDTO findOneById(@PathVariable(name = "id") String id){
        return orderService.findOne(id);
    }
}
1.4 @PutMapping

@PutMapping注解用于处理HTTP PUT请求，并将请求映射到具体的处理方法中。具体的说，@PutMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.PUT)

@PutMapping的使用示例：

@RestController
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;

    @PutMapping("/paid/{id}")
    public OrderDTO paid(@PathVariable(name = "id") String id){
        OrderDTO orderDTO = orderService.findOne(id);
        return orderService.paid(orderDTO);
    }
}
1.5 @PostMapping

@PostMapping注解用于处理HTTP POST请求，并将请求映射到具体的处理方法中。具体的说，@PostMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.POST)

@PostMapping的使用示例：

@RestController
@RequestMapping(value = "/order")
public class TestController {

    @Autowired
    private OrderService orderService;

    @PostMapping("/orders")
    public OrderDTO cancelOrder(@Valid @RequestBody OrderDTO orderDTO){
        return orderService.cancel(orderDTO);
    }
}
1.6 @DeleteMapping

@DeleteMapping注解用于处理HTTP DELETE请求，并将请求映射到具体的处理方法中。具体的说，@DeleteMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.DELETE)

@DeleteMapping的使用示例：

@RestController
@RequestMapping(value = "/order")
public class TestController {

    @Autowired
    private OrderService orderService;

    @DeleteMapping("/cancel/{id}")
    public OrderDTO cancelOrder(@PathVariable(name = "id") String id){
        OrderDTO orderDTO = orderService.findOne(id);
        return orderService.cancel(orderDTO);
    }
}
1.7 @PatchMapping

@PatchMapping注解用于处理HTTP PATCH请求，并将请求映射到具体的处理方法中。具体的说，@PatchMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.PATCH)

@PatchMapping的使用示例：

@RestController
@RequestMapping(value = "/order")
public class TestController {
    @PatchMapping("/orders/patch")
    public ResponseEntity<Object> patch(){
        return new ResponseEntity<>("Patch method response message", HttpStatus.OK);
    }
}
1.8 @ResponseBody

@ResponseBody会将Controller层中的方法返回值写入到HTTP响应中。@ResponseBody只能用在@Controller注解标记的类中。如果在被@RestController注解标记的类中，则不需要@ResponseBody注解进行标注。@RestController相当于是@Controller和@ResponseBody的组合注解。

@ResponseBody的使用示例：

@Controller
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;
    
    @ResponseBody
    @PutMapping("/orders/{id}")
    public OrderDTO findById(@PathVariable(name = "id") String id){
        return orderService.findOne(id);
    }
}
1.9 @PathVariable

@PathVariable注解是将方法中的参数绑定到请求URI的模板变量上。可以通过@RequestMapping注解来指定URI的模板变量，然后使用@PathVariable注解将方法中的参数绑定到模板上，@PathVariable注解允许我们使用value或name属性给参数取一个别名。
@PathVariable的使用示例：

@Controller
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;

    @ResponseBody
    @PutMapping("/orders/{id}")
    public OrderDTO findById(@PathVariable(name = "id") String id){
        return orderService.findOne(id);
    }
}

模板变量名需要使用“{ }”进行包裹，如果方法的参数名与URI模板变量名一致，则在@PathVariable中就可以省略别名的定义。
简单示例：

@Controller
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;

    @ResponseBody
    @PutMapping("/orders/{id}")
    public OrderDTO findById(@PathVariable String id){
        return orderService.findOne(id);
    }
}

提示：如果参数是一个非必须的，可选的项，则可以在@PathVariable中设置require = false，默认是true

1.10@RequestParam

@RequestParam注解用于将方法的参数与web请求的传递的参数进行绑定。使用@RequestParam可以轻松获取HTTP请求参数的值。
@RequestParam的使用示例：

@Controller
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;

    @ResponseBody
    @PutMapping("/orders/{id}")
    public OrderDTO findById(@RequestParam(name = "id") String id ){
        return orderService.findOne(id);
    }
}

@RequestParam注解的其他属性配置与@PathVariable的配置相同，特别的是，如果传递的参数为空，还可以通过defaultValue设置一个默认值。
示例代码如下：

@Controller
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;

    @ResponseBody
    @GetMapping
    public OrderDTO findById(@RequestParam(name = "id", defaultValue = "1") String id ){
        return orderService.findOne(id);
    }
}
1.11 @Controller

@Controller是@Component注解的一个延伸，Spring会自动扫描并配置被该注解标注的类。此注解用于标注Spring MVC的控制器。
@Controller的使用示例：

@Controller
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;

    @ResponseBody
    @PutMapping("/orders/{id}")
    public OrderDTO findById(@RequestParam(name = "id", defaultValue = "1") String id ){
        return orderService.findOne(id);
    }
}
1.12 @RestController

@RestController是再Spring 4.0开始引入的，这是一个特定的控制器注解。此注解是一个组合注解相当于，@Controller和@ResponseBody的快捷方式，当使用此注解时，不需要在方法上使用@ResponseBody注解。
@RestController的使用示例：

在这里插入代码片

@RestController
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;

    @PutMapping("/orders/{id}")
    public OrderDTO findById(@RequestParam(name = "id", defaultValue = "1") String id ){
        return orderService.findOne(id);
    }
}

2、Spring Bean注解

2.1 @ComponentScan

@ComponentScan用于配置Spring需要扫描的被组件注解注释的类所在的包，可以通过配置其basePackages属性或者value属性来配置需要扫描的包路径。value属性是basePackages的别名。
@ComponentScan的使用示例：

@Configuration
@ComponentScan(basePackages = "com.henya.config")
public class TestConfig {
    // ...
}
2.2 @Component

@Component注解用于标注一个普通的组件类，它没有明确的业务范围，只是告知Spring被此注解标注的类需要被纳入到Spring Bean容器中进行管理。
@Component的使用示例：

@Component
public class TestConfig {

    public void testComponent(){
        // ...
    }
}
2.3 @Service

@Service注解是@Component的一个延伸（特例），它用于标注业务逻辑类。与@Component注解一样，被此注解标注的类，会自动被Spring所管理。
@Service的使用示例：

@Service
public class ProductServiceImpl implements ProductService {

    @Autowired
    private ProductInfoDao productInfoDao;

    @Override
    public ProductInfo findOne(String productId) {
        return productInfoDao.findOne(productId);
    }
}
2.4 @Repository

@Repository注解是@Component注解的延伸，与@Component注解一样，被此注解标注的类会被Spring容器管理起来，@Repository注解用于标注DAO层的数据持久化类。
@Repository的使用示例：

@Repository
public interface TestRepository extends JpaRepository<OrderDTO, String> {
    // ...
}

3、容器配置注解

3.1@Autowired

@Autowired注解用于标记Spring将要解析和注入的依赖项。此注解可以作用在构造函数，字段和Setter方法上。
作用在构造函数示例：

@RestController
public class TestController {
    private OrderService orderService;

    @Autowired
    TestController(OrderService orderService){
        this.orderService = orderService;
    }
}

作用在字段示例：

@RestController
@RequestMapping(value = "/order")
public class TestController {
    @Autowired
    private OrderService orderService;

    @PutMapping("/orders/{id}")
    public OrderDTO findById(@RequestParam(name = "id", defaultValue = "1") String id ){
        return orderService.findOne(id);
    }
}

作用在Setter方法上示例：

@RestController
public class TestController {
    private OrderService orderService;

    @Autowired
    public void setOrderService(OrderService orderService){
        this.orderService = orderService;
    }
}
3.2 @Primary

当系统中需要配置多个具有相同类型的Bean时，@Primary可以定义这些Bean的优先级。
@Primary的使用示例：

public interface MessageService {
    String sendMessage();
}

@Primary
@Component
public class EmailMessageImpl implements MessageService {
    @Override
    public String sendMessage() {
        return "this is send email method message";
    }
}

@Component
public class DingDingMessageImpl implements MessageService {
    @Override
    public String sendMessage() {
        return "this is send dingding method message";
    }
}

@Component
public class WeChatMessageImpl implements MessageService {

    @Override
    public String sendMessage() {
        return "this is send wechat method message";
    }
}

@RestController
public class MessageController {
    @Autowired
    private MessageService messageService;

    @GetMapping("/info")
    public String info(){
        return messageService.sendMessage();
    }
}

输出结果为this is send email method message，说明EmailMessageImpl 的优先级较高。

四、Spring Boot注解

4.1@SpringBootApplication

@SpringBootApplication是一个快捷的配置注解，被他标注的类中，可以定义一个或多个Bean，并自动触发自动配置Bean和自动扫描组件。此注解相当于是@Configuration、@EnableAutoConfiguration和@ComponentScan的组合。SpringBoot主程序类中，就是用来此注解。
@SpringBootApplication的使用示例：

@SpringBootApplication
public class SellApplication {

	public static void main(String[] args) {
		SpringApplication.run(SellApplication.class, args);
	}
}
4.2 @EnableAutoConfiguration

@EnableAutoConfiguration注解用于告知Spring，根据当前类路径下引入的依赖包，自动配置与这些依赖包相关的配置项。

4.3 @ConditionalOnClass与@ConditionalOnMissingClass

这两个注解属于类条件注解，它们根据是否存在某个类作为判断依据来决定是否要执行某些配置。
简单使用示例：

@Configuration
@ConditionalOnClass(OrderDTO.class)
public class MessageController {
  // ...
}
4.4 @ConditionalOnBean与@ConditionalOnMissingBean

这两个注解属于对象条件注解，根据是否存在某个对象作为依据来决定是否要执行某些配置方法。
简单使用示例：

@Bean
@ConditionalOnBean
LocalContainerEntityManagerFactoryBean entityManagerFactory(){
        // ...
}
@Bean
@ConditionalOnMissingBean
public LocalContainerEntityManagerFactoryBean myBean(){
       // ...
}
4.5 @ConditionalOnProperty

@ConditionalOnProperty注解会根据Spring配置文件中的配置项是否满足配置要求，从而决定是否要执行被标注的方法。

4.6 @ConditionalOnResource

@ConditionalOnResource注解是当某个配置文件存在时，则执行被其标注的方法。

4.7 @ConditionalOnWebApplication与@ConditionalOnNotWebApplication

这两个注解用于判断当前应用程序是否是Web应用程序。如果是Web应用程序，则使用Spring WebApplicationContext，并定义其会话的生命周期。

Hen_YA
关注
专栏目录
【微服务】springboot 自定义注解+反射+aop实现动态修改请求参数
congge
09-01 8913
springboot 动态修改请求参数常用方案
使用Springboot注入带参数的构造函数实例
08-19
主要介绍了使用Springboot注入带参数的构造函数实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
SpringBoot 常用注解大全，赶快收藏起来啦！
技术交流，进来交个朋友
04-17 1450
一、注解(annotations)列表 @SpringBootApplication： 包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上下文。 @Configuration： 等同于spring的XML配置文件；使用J...
关于 Spring Boot 中的一些注解使用
凄戚的博客
03-31 359
1. 关于项目中使用 @Autowired 注解 刚开始接触 spring boot 的时候看到别人在字段上添加 @Autowired 自己也就跟着这样写了，刚 开始只是注意到字段有下划线，这个如果是 Mapper 的话，在 dto 上添加 @Repository 就可以解決，但是还是可以看到注解报错，鼠标悬浮显示“不推荐这样使用注解“，那么正确的方式是怎样的呢？ 有两种方式： 基于构造函数的依赖注入：对于必须的依赖项，使用构造函数注入，可以使它们成为 final且 不为null。综合来看 Constru
springboot中使用注解获取前台header信息
星月昭铭的博客
11-30 1万+
今天在写vue时，需要实现一个功能，就是前台通过header(请求头)将token发送到服务端，后台使用的是springboot，第一下想到是springboot注解，但是百度了挺久发现很多人都是使用的原生servlet对象来获取头信息，其实springboot(mvc)中有一个获取请求头信息的注解@RequestHeader() public String addAddress(@Request...
SpringBoot常见注解的使用
weixin_43808717的博客
06-30 227
1、@PathVariable注解 /** * If the method parameter is {@link java.util.Map Map<String, String>;} * then the map is populated with all path variable names and values. */ @Target(ElementType.PARAMETER) @Retention(RetentionPolicy.RUNTIME) @Documented pu
SpringBoot 常用注解汇总
m0_67401153的博客
06-12 5万+
目录Spring Boot 常用注解汇总一、启动注解 @SpringBootApplication@SpringBootConfiguration 注解，继承@Configuration注解，主要用于加载配置文件@EnableAutoConfiguration 注解，开启自动配置功能@ComponentScan 注解，主要用于组件扫描和自动装配二、Controller 相关注解@Controller@RestController 复合注解@RequestBody@RequestMapping@GetMapp
Springboot常见注解的基本作用
weixin_45708827的博客
01-04 463
@RestController 返回json @Controller 控制层，返回指定页面（前后端不分离时用） @ResponseBody 将java对象转为json格式的数据 @RequestBody 将json格式的数据转为java对象 @RequestMapping 配置URL映射 @RequestMapping(value = "/get/{id}", method = RequestMethod.GET)等 ...
springboot 常用注解
fwdwqdwq的博客
08-02 1112
在springboot中，摒弃了spring以往项目中大量繁琐的配置，遵循约定大于配置的原则，通过自身默认配置，极大的降低了项目搭建的复杂度。同样在springboot中，大量注解的使用，使得代码看起来更加简洁，提高开发的效率。这些注解不光包括springboot自有，也有一些是继承自spring的。...
Spring SpringMVC SpringBoot 常用注解说明
以前冷现在热
03-31 4784
Spring SpringMVC SpringBoot 常用注解说明Spring注解与xml配置的区别不使用注解的案例@Autowired@Qualifier@Resource@Service使用注解来构造IoC容器@Component@Controller@Service@ RepositorySpring常用注解汇总Spring MVC@Controller@RequestMapping使用 ...
40 个 SpringBoot 常用注解：让生产力爆表！
Java之间
06-09 140
往期热门文章： 1、BigDecimal使用不当，造成P0事故！ 2、改造BeanUtils，优雅实现List数据拷贝 3、SpringBoot 启动时自动执行代码的几种方式，还有谁不会？？ 4、让人上瘾的新一代开发神器，彻底告别Controller、Service、Dao等方法 5、延时消息常见实现方案来源：ramostear.com一、Spring Web MVC ...
太厉害了！终于有人把Spring Boot常用注释讲明白了！
SQY0809的博客
08-03 457
前言 Spring Boot 是由 Pivotal 团队提供的全新框架，其设计目的是用来简化新 Spring 应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。 Java学习笔记共享地址：spring boot的核心技术100多页学习笔记 Spring Boot 被认为是 Spring MVC 的“接班人”，它可以帮我们自动配置，如果默认配置不能满足需求，我们还可以替换掉自动配置类，使用自己的配置。另外，Spring Boot 还集成了嵌入式的 Web 服
40 个 SpringBoot 常用注解
am的博客
08-10 377
本次课程总结了Spring Boot中常见的各类型注解的使用方式，让大家能够统一的对Spring Boot常用注解有一个全面的了解。由于篇幅的原因，关于Spring Boot不常用的一些注解，将在下一次分享中进行补充和说明。...
Spring Boot核心注解的组成
header_s的博客
11-08 350
Spring Boot的核心注解组成初始SpringBootSpring Boot的核心注解 初始SpringBoot Spring BootSpring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置；简述为“规约大于配置”的原则 Spring Boot的核心注解 @SpringBootApplica...
SpringBoot常用注解大全（详细）
一个苦命Java码农的博客
03-06 3823
SpringBoot的常用注解，自己学习SpringBoot的时候看一位大佬的博客，这是我感觉写的最详细的一篇SpringBoot注解解析。
一下明白@GetMapping、@PostMapping、@PutMapping、@DeleteMapping注解
qq_43280993的博客
10-16 1万+
value里面的请求路径是前端传过来的，通常来说就是在地址栏上输入http://localhost:8080/xxx/xxx/ 什么的，后端接收到同样匹配的路径之后，进入对象的方法里面，然后做完一系列的操作之后把数据return给前端对应的东西。是@RequestMapping(value="这里写的是请求的路径",method = RequestMethod.POST)的缩写。restful风格对比普通的Controller是相对安全和简单的，四个提交对应增删改查，写法也变的简单，
postmapping注解_Spring注解介绍
weixin_39538693的博客
12-06 2757
本文主要介绍Spring中一些常见注解的部分属性配置介绍以及一些不常用注解的简单介绍。下面让我们直接进入主题吧。@RequestMapping @RequestMapping可以说是SpringMVC以及OpenFeign中最常用的注解，其主要用于映射Web请求。produces属性配置 当前主流服务大部分都是使用JSON作为数据交换格式，即通过配置MappingJa...
SpringBoot注解最全详解(整合超详细版本)
热门推荐
浩瀚星空
07-30 35万+
使用注解的优势： 1.采用纯java代码，不在需要配置繁杂的xml文件 2.在配置中也可享受面向对象带来的好处 3.类型安全对重构可以提供良好的支持 4.减少复杂配置文件的同时亦能享受到springIoC容器提供的功能 一、注解详解（配备了完善的释义）------(可采用ctrl+F 来进行搜索哦~~~~) @SpringBootAppli...
@getMapping与@postMapping注解
weixin_45443551的博客
06-16 5612
GetMapping注解浅浅谈
springboot常见注解
最新发布
04-11
Sure, there are several common annotations used in Spring Boot. Here are a few examples: 1. @RestController: This annotation is used to define a RESTful controller which returns JSON or XML data to ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值