java中常用注解(更新中)

已于 2024-08-21 21:29:02 修改
阅读量1.2k 收藏 16
点赞数 22
分类专栏： Java 文章标签： java 开发语言
于 2024-08-14 11:19:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37377838/article/details/141185704
版权

元注解:修饰注解的注解

@Target(ElementType.位置)

作用：声明被修饰的注解只能在哪些位置使用,属于空间范畴
位置:

  1. TYPE，类，接口
  2. FIELD，成员变量
  3. METHOD，成员方法
  4. PARAMETER，方法参数
  5. CONSTRUCTOR，构造器
  6. LOCAL_VARIABLE，局部变量

@Retention(RetentionPolicy.保留周期)

作用：声明注解的保留周期,属于时间范畴
保留周期:

  1. SOURCE: 只作用在源码阶段，字节码文件中不存在
  2. CLASS（默认值）: 保留到字节码文件阶段，运行阶段不存在
  3. RUNTIME（开发常用）: 一直保留到运行阶段。

Spring

@ComponentScan(“com.itheima”)

标注在主配置类上，用于声明包扫描的范围

image.png

控制反转(IOC)

Bean 的创建

标注在自己开发的类上，用于将当前类对象放入Spring容器:

@Controller：在表示层类上使用
@Service：在业务层类上使用
@Repository：在持久层类上使用
@Component：在不属于三层的类上使用
Bean的作用域

标注在类上，声明对象是单例还是多例:

  • @Scope(“singleton”)：创建单例对象
  • @Scope(“prototype”)：创建多例对象

@Lazy 延迟对象创建时机

依赖注入

@Autowired

标注在属性上，表示自动依赖注入，用于从Spring容器中获取属性的值,Spring会根据被标注对象的类型自动从IOC容器中查找

  • 如果找不到，就会报错 NoSuchBeanDefinitionException
  • 如果恰好找到一个，就会自动完成依赖注入
  • 如果找到了多个，也会报错 NoUniqueBeanDefinitionException

image.png

@Qualifier
  • 依赖注入时，根据一个接口查到了多个对象，使用这两个注解确定使用哪个对象
  • 标注在要赋值的属性上，代表在按照类型匹配的基础上，再按照指定名称匹配
  • 注意：@Qualifier注解无法单独使用，必须配合@Autowired注解使用

@Primary
  • 依赖注入时，根据一个接口查到了多个对象，使用这两个注解确定使用哪个对象
  • @Primary标注在实现类上，表示当一个接口有多个实现的类时，默认使用哪个作为主实现
  • 注意：在同一个接口下，不能同时在多个实现类设置

第三方Bean

@Bean

写在方法上，表示将该方法的返回对象添加到Spring容器中，Bean的名称默认是方法名

@Configuration

写在配置类上，表示该类是一个配置类，Spring在启动的时候会自动扫描加载类中的配置

测试类优化

@RunWith(SpringJUnit4ClassRunner.class)

帮我们启动Spring容器
//等价于

//        1.读取配置类中的配置信息,然后启动spring容器
AnnotationConfigApplicationContext act = 
new AnnotationConfigApplicationContext(SpringConfig.class);

@ContextConfiguration(classes = SpringConfig.class)

指定配置类

image.png

Spring AOP

@EnableAspectJAutoProxy :激活切面自动代理

写在配置类中

@PointCut:切入点表达式
  • 作用：主要用来决定项目中的哪些方法需要加入通知
  • 常见形式：
    • execution(……)：根据方法的签名来匹配
    • @annotation(……) ：根据注解匹配

image.png

image.png

@Aspect:定义切面类,加上@Component注解

image.png

@Order:主要用来控制配置类的加载顺序

image.png

通知类型(前四个和后边的环绕通知互斥,直接用环绕通知就可以)

@Before：前置通知

此注解标注的通知方法在目标方法前被执行

@AfterReturning： 返回后通知

此注解标注的通知方法在目标方法后被执行，有异常不会执行

@AfterThrowing： 异常后通知

此注解标注的通知方法发生异常后执行

@After：后置通知

此注解标注的通知方法在目标方法后被执行，无论是否有异常都会执行

@Around环绕通知

需要自己调用 ProceedingJoinPoint.proceed() 来让原始方法执行，其他通知不需要考虑目标方法执行
@Around环绕通知方法的返回值，必须指定为Object，来接收原始方法的返回结果

事务管理

@Transactional

位置：业务（service）层的方法上、类上、接口上
作用：将当前方法交给spring进行事务管理，方法执行前，开启事务；成功执行完毕，提交事务；出现异常，回滚事务

SpringMvc

Controller类上

@Controller
  • 标注在表示层,Spring会使用注解标注的类创建出对象，然后放入容器
  • 简化：@RestController = @Controller + @ResponseBody ;所以可以直接使用@RestController

@ResponseBody
  • 作用：将方法返回值直接响应，如果返回值类型是 实体对象/集合 ，将会转换为JSON格式响应
  • 位置：Controller方法上/类上(如果标在类上,代表类中所有方法上都生效)
  • 简化：@RestController = @Controller + @ResponseBody ;

所以可以直接使用@RestController

@RestController

image.png

@RestController中包含5个注解,所以可以直接省略@Controller和@ResponseBody注解

方法上+类上

@RequestMapping:用于映射web请求,包括访问路径和参数
  • 位置: 方法 类
  • @RequestMapping(value = “/user/demo1”,method = RequestMethod.GET
  • 属性:
    • value： 等同于path，用于为当前方法绑定访问路径
    • method：用于限制请求类型，如果省略此选项，代表不对请求类型做限制
  • 注意：此注解也可以标注在类上，代表类中的所有方法都可以共用一段URL

Restful风格接口:根据请求类型使用不同的注解

@PostMapping

用于增加信息

@PutMapping

用于更改信息

@GetMapping

用于查询信息

@DeleteMapping

用于删除信息

接收参数

@RequestParam :集合

1. 场景1:使用List或者Set接收参数的时候
请求参数名与形参集合名称相同且请求参数为多个，使用@RequestParam 绑定参数关系
image.png

** 2.场景2:接收参数名和URL路径中参数不一样的时候**
** 3.场景3:给参数设置默认值**
image.png

@DateTimeFormat:日期参数格式转换

image.png

@RequestBody :请求体中json
  • SpringMVC也可以接收请求体中的json字符串为参数，并且自动封装为指定对象
  • 使用 @RequestBody 标注请求参数之前,表示从请求体中接收json参数,并且封装到指定的对象
  • @RequestBody 只能标注在对象或者是一个Map前面

image.png

@PathVariable:路径参数
  • @PathVariable: 通过请求路径传入参数
  • 步骤:
    • 1)请求路径上使用{}占位
    • 2)使用@PathVariable将占位符位置的数据赋值到指定的参数

image.png

全局异常处理

@RestControllerAdvice

标注在类上，声明当前类是一个用于专门处理异常的类
image.png

@ExceptionHandler

标注在方法上，声明当前方法可以处理哪些异常
image.png

SpringBoot

定时任务控制

@Scheduled

@Scheduled注解是Spring Boot提供的用于定时任务控制的注解，主要用于控制任务在某个指定时间执行，或者每隔一段时间执行。
@Scheduled需要配合@EnableScheduling使用。使用时，将@Scheduled注解放在待定时的方法名上方，将 @EnableScheduling放在项目主启动类类名上方。


@Scheduled主要有三种配置执行时间的方式：cron、fixedRate和fixedDelay。
**关于 fixedRate 和 **fixedDelay的区别：

  • fixedRate** 的间隔时间是上次任务开始后，开始计算时间间隔，达到指定时间间隔后，开始执行下一次任务；**
  • 而 fixedDelay 的间隔时间是上次任务结束后，开始计算时间间隔，达到指定时间间隔后，开始执行下一次任务。
  • cron是@Scheduled的一个参数，是一个字符串，以空格隔开。
cron表达式格式：
@Scheduled(cron = "{秒数} {分钟} {小时} {日期} {月份} {星期}")
 
“30 10 1 20 10 ? 2011” 2011年10月20号1点10分30秒触发任务 
 
“30 10 1 ? 10 * 2011” 2011年10月每天1点10分30秒触发任务

自动生成构造方法

@RequiredArgsConstructor
  • @RequiredArgsConstructor是一个Lombok提供的注解，用于自动生成构造函数。
  • 基于构造方法为属性赋值，容器通过调用类的构造方法将其进行依赖注入.
  • 可以用来代替@Autowired注解注入
  1. 声明的变量必须加上final修饰
  2. 区别:
    • @Autowired :
    • @RequiredArgsConstructor:
      1. 先在 controller 类上添加注解:
        在这里插入图片描述
      2. 用到的时候可以直接

SpringCloud

Feign

@EnableFeignClients
  • 在启动类中使用,用于启用 Feign 客户端的功能
  • 会自动扫描指定的包和子包，查找所有标记了 `@FeignClient 的接口
  • basePackages** 属性:用来指定要扫描的基础包或类**
  • 可以与 @Configuration 注解一起使用，允许你在同一个类中定义配置和启用 Feign 客户端。

image.png

@FeignClient
  • 用于标记一个接口作为 Feign 客户端。
  • 可以在该注解中指定服务名（**name**）、服务路径（path）等信息。

image.png

Conditional 系列注解

此系列注解为按照条件判断

@ConditionalonClass()
  • 该注解可以用在类及方法上；类指的是标有@Configuration的类，方法是标有@Bean的方法
  • @ConditionalOnClass注解的作用是当项目中存在某个类时才会使标有该注解的类或方法生效
  • 属性: name属性，name属性指定的是全限类名，也就是包含包名+类名
  • image.png
啊我不会写代码啊
关注
专栏目录
java注解大全(非常全面)
10-20
主要包括：普通java注解，hibernate注解，spring注解，struts2注解，对于学习注解的朋友有很大的帮助！
SpringBoot 中常用注解及各种注解作用
08-27
本篇文章将介绍几种SpringBoot 中常用注解及各个注解的作用，感兴趣的朋友跟随脚本之家小编一起学习吧
JAVA常用注解
weixin_30266885的博客
10-31 146
JDK自带注解 @Override　　重写，标识覆盖它的父类的方法 @Deprecated 　　已过期，表示方法是不被建议使用的 @Suppvisewarnings　　 压制警告，抑制警告 元注解 @Target　　表示该注解用于什么地方，可取的值包括： ElemenetType.CONSTRUCTOR　　　　 构造器声明 ElemenetType.FIE...
Java知识点二-常用注解
qq_43718622的博客
12-12 335
Java注解
java-常用注解
loners_htmll的博客
04-25 1582
Java-常用注解
java标注
Code Writers
08-11 1629
Java注解是一个很重要的知识点，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行注解。 掌握好Java注解有利于学习框架底层实现。@mikechen Java注解定义 Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。 Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。 Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置
Java注解「详解」
weixin_56433857的博客
04-13 7542
注解（Annotation）是Java语言中的一种特殊语法结构，它可以在代码中嵌入元数据（metadata），用于一些特殊的标记和说明。注解可以在编译时被读取，并在运行时使用。@注解名称(属性名1=属性值1, 属性名2=属性值2, ...)其中，符号表示这是一个注解，注解名称是一个标识符，类似于Java中的类名或接口名。注解名称后面的括号中可以包含零个或多个属性，属性的格式是属性名=属性值，多个属性之间用逗号分隔。// ...此处使用了@Deprecated。
java注解大全
Mr. Ding的小博客
05-18 1万+
java 1、最基础注解（spring-context包下的org.springframework.stereotype） 1.1、@Controller @Service @Repository @Configuration @Component 1.2、 @Bean 2、最基础注解（spring-web包下的org.springframework.web.bind.annotation） 2.1、@ResponseBody 2.2、@RequestBody 2.3、@RequestMap.
Java-注解详解
最新发布
yueerba126的博客
07-02 5874
Retention：注解的保留策略。该注解指明了被它所注解的注解被保留的时间长短。@Retention 包含一个名为 value 的成员变量，该 value 成员变量是 RetentionPolicy，RetentionPolicy 是枚举类型，值有如下几个：RetentionPolicy.SOURCE：注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视，不记录在 class 文件中。RetentionPolicy.CLASS：注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
Java注解-最通俗易懂的讲解
热门推荐
怪咖@的博客
09-24 1万+
Java注解（Annotation），也叫`元数据`。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在`包、类、字段、方法、局部变量、方法参数`等的前面，用来对这些元素进行说明，注释。
spring springMVC中常用注解解析
08-27
下面我们将详细讲解一些常用的注解。 1. **@Configuration 和 @ComponentScan** - `@Configuration`：这是一个核心注解，用于标记一个类作为Spring配置元数据的源，类似于XML配置文件中的`<beans>`元素。 - `@...
谈谈Java中自定义注解及使用场景
09-07
Java中的自定义注解是一种强大的工具，允许程序员在代码中添加元数据，这些元数据可以在编译时或运行时被解析和使用。自定义注解是Java 5引入的新特性，它增强了代码的可读性和可维护性，同时也简化了框架和库的开发...
Java常用内置注解用法分析
08-25
在本文中，我们将详细介绍Java常用内置注解的用法，并通过实例形式分析了Java使用@SuppressWarnings关闭警告信息以及@Depreca标注的元素不使用两种注解使用方法。 一、 @SuppressWarnings注解 @SuppressWarnings...
java或Java框架中常用的注解及其作用详解_资料.docx
12-23
4. **Spring其他常用注解** - `@Configuration`：声明一个类作为Spring配置源，可以定义`@Bean`方法来创建和配置Bean。 - `@Scope`：定义Bean的作用域，如单例(`singleton`)或原型(`prototype`)。 - `@Lazy`：...
java常用的注解（个人笔记）
一个后端菜鸟的博客
11-23 4881
一、java的内置注解（java 7 后额外添加了后三个注解）@Override-重写方法@Deprecatd 过时方法使用会编译警告@SuppessWarnings 忽略声明警告 @Target --标记注解为哪个java成员 @Inherited 标记注解继承哪个注解 @SafeVarargs 忽略任何参数关于 泛型变量的方法和构造函数产生的警告 @FunctionalInterface @Repeatable ...
Java注解总结
weixin_51001722的博客
06-01 4654
Bean注解主要用于方法上，有点类似于工厂方法，当使用了@Bean注解，我们可以连续使用多种定义bean时用到的注解，譬如用@Qualifier注解定义工厂方法的名称，用@Scope注解定义该bean的作用域范围，譬如是singleton还是prototype等。这个是Spring5.0里面新加入的一个注解，它是一个加速注解，也就是说默认Spring容器一启动的时候，所有的组件才会进行加载创建对象，如果有大量的组件经常要用到，又不想等Spring容器启动的时候才加载并创建对象，那么就可以标注。
Java注解详解
程序员小杨哥的博客
10-13 1万+
什么是注解，为什么用注解，Java的常用注解？
Java中常用注解
weixin_50993955的博客
11-21 387
Java中常用注解
java spring中常用注解
05-19
Java Spring 中常用的注解有： 1. @Controller：标识一个类是 Spring MVC 控制器。 2. @RestController：标识一个类是 Spring MVC RESTful 控制器，返回的数据是 JSON/XML 等格式。 3. @RequestMapping：定义请求的 URL 映射，可以用于类和方法上。 4. @PathVariable：获取 URL 中的参数值。 5. @RequestParam：获取请求参数的值。 6. @RequestBody：获取请求体的内容。 7. @ResponseBody：将返回值转换成 JSON/XML 等格式。 8. @Autowired：自动装配依赖的 Bean。 9. @Bean：声明一个 Bean。 10. @Component：标识一个类是 Spring 组件。 11. @Configuration：声明一个类是 Spring 配置类。 12. @Value：获取配置文件中的属性值。 13. @Profile：定义不同环境下的 Bean。 14. @Scheduled：定时任务的注解。 15. @Transactional：声明一个方法需要事务支持。 16. @Cacheable：声明一个方法的返回值需要缓存。 17. @Valid：数据校验的注解。 这些注解在开发过程中非常常用，掌握它们可以提高工作效率。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值