第一章 JAVA基础知识系列 -- 第二节 注解概念及应用

2024-05-01 09:08

本文主要是介绍第一章 JAVA基础知识系列 -- 第二节 注解概念及应用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

JAVA 注解概念及应用

注解的定义

定义:注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。

注解在JDK1.5版本被引用,其作为代码的描述或注释,并不直接影响代码运行效果。可以通过反射机制提取注解并进行业务处理。

一、自定义注解
1、注解的定义
@Documented   (1)
@Target(ElementType.METHOD)   (2)
@Retention(RetentionPolicy.SOURCE)   (3)
@Inherited   (4)
public @interface DemoAnnotation {   (5)String[] value() default {};  (6)
}

(1) @Documented 表明这个注解应该被 javadoc工具记
(2) @Target 说明了该注解所修饰的对象范围,范围标识如下所示:

类型范围
ElementType.TYPE类、接口(包括注释类型)或枚举声明
ElementType.FIELD字段声明(包括枚举常量)
ElementType.METHOD方法声明
ElementType.PARAMETER正式的参数声明
ElementType.CONSTRUCTOR构造函数声明
ElementType.LOCAL_VARIABLE局部变量声明
ElementType.ANNOTATION_TYPE注释类型声明,作为注解的注解
ElementType.PACKAGE包装声明
ElementType.TYPE_PARAMETER类型参数声明 (since1.8)
ElementType.TYPE_USE类型的使用 (since1.8)

(3) @Retention 用来标注注解的声明周期,其可选参数如下:

类型含义
RetentionPolicy.SOURCE只保留在源文件中
RetentionPolicy.CLASS保留在class文件中,在加载到JVM虚拟机时丢弃
RetentionPolicy.RUNTIME注解保留在程序运行期间,此时可以通过反射获得定义在某个类上的所有注解。

(4) @Inherited 允许子注解继承该注解

(5) @interface 注解定义标识

(6) String[] value() default {}; 表示注解的参数,可以通过 调用该注解的,对应方法获得设置在注解上的信息

((DemoAnnotation) annotation).value()

以上语法可以获得 DemoAnnotation注解的value属性值
注意:在使用注解对目标进行注释时,当有且仅有value属性需要使用时,可以直接在注释的参数中填写内容,无效使用KEY=VALUE 模式。

2、代码添加注解

根据注解修饰对象的范围,在允许的范围内添加注解
如:

    @Overridepublic int insert(User user) {userMapper.insert(user);return user.getId();}

示例中的 @Override 注解为JDK内置注解,用于源码阶段的方法覆盖,其功能为覆盖接口中的 insert(User user) 方法。

3、注解的业务处理

针对 @RetentionRetentionPolicy.RUNTIME的注解,提供注解处理器功能,以实现特定业务逻辑
首先,可以通过Class对象的 isAnnotationPresent() 方法判断他是否应用了某个注解

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

然后,通过Class对象的 getAnnotation()getAnnotations() 方法获取 Annotation 对象或对象数组

public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}public Annotation[] getAnnotations() {}
以下为注解处理器示例代码

首先,定义一个注解

package org.items.annotation;/*** @author tysite*         Date Created 2019/5/30*/import java.lang.annotation.*;@Documented
@Target(value={ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface DemoAnnotation {String value() default "demo";String color() default "Red";
}

然后,将注解注释到含有main方法的类中

package org.items.annotation;import java.lang.reflect.Field;
import java.lang.reflect.Method;/*** @author tysite*         Date Created 2019/5/30*/
@DemoAnnotation(value = "猪", color = "黑")
public class AnnotationTest {public static void main(String[] args) {//验证注解是否存在if (AnnotationTest.class.isAnnotationPresent(DemoAnnotation.class)) {DemoAnnotation annotation = AnnotationTest.class.getAnnotation(DemoAnnotation.class);System.out.println("类 [AnnotationTest] 的 注解是 =>\t" + annotation.color() + " " + annotation.value());} else {System.out.println("类 [AnnotationTest] 无 DemoAnnotation 注解");}try {//获取指定属性Field field = AnnotationTest.class.getDeclaredField("demo");//解决私有成员变量获取限制问题field.setAccessible(true);if (field.isAnnotationPresent(DemoAnnotation.class)){DemoAnnotation demoAnnotation = field.getAnnotation(DemoAnnotation.class);System.out.println("成员变量 [demo] 的 注解是 =>\t" + demoAnnotation.color()+" "+demoAnnotation.value());} else {System.out.println("成员变量 [demo] 无DemoAnnotation注解");}Method method = AnnotationTest.class.getDeclaredMethod("showAnnotation");if (method.isAnnotationPresent(DemoAnnotation.class)) {DemoAnnotation methodAnnotation = method.getAnnotation(DemoAnnotation.class);System.out.println("私有方法 [showAnnotation] 的 注解是 =>\t" + methodAnnotation.color()+" "+methodAnnotation.value());} else {System.out.println("私有方法 [showAnnotation] 无DemoAnnotation注解");}} catch (NoSuchFieldException e) {e.printStackTrace();} catch (NoSuchMethodException e1) {e1.printStackTrace();}}@DemoAnnotation(value = "兔", color = "白")String demo;@DemoAnnotation(value = "猫", color = "橘")private void showAnnotation() {}
}

最后,执行该main方法,显示注解结果

类 [AnnotationTest] 的 注解是 => 黑 猪
成员变量 [demo] 的 注解是 => 白 兔
私有方法 [showAnnotation] 的 注解是 => 橘 猫

二、常用注解
1、JDK提供的注解
注解名称注解功能
@Override用于重写父类的方法 或 实现接口类的方法时,标记方法覆盖关系
@Deprecated标记被注释目标 (类、方法、属性等) 已弃用,不建议继续使用
@suppressWarnings编译时忽略被注释目标的警告
@FunctionalInterface(jdk1.8更新) 表示:用来指定某个接口必须是函数式接口,否则就会编译出错。
2、SpringBoot 提供的常用注解
注解名称注解功能
@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。参考文献:SpringBoot之@EnableAutoConfiguration注解
@ComponentScan组件扫描注解,用于自动发现和装配Bean。相当于配置文件的<context:component-scan>
@ConfigurationSpring Java配置注解,其作用相当于一个xml配置文件
@ConfigurationProperties配置属性前缀设置注解
@SpringBootApplication该注解为 @EnableAutoConfiguration、@Configuration、@ComponentScan的集合,应用于SpringBoot项目的启动类
@Bean该注解标注相当于XML中配置的Bean
@ValueSpringBoot 配置文件属性赋值注解,可以是常量、application.propreties属性或表达式
@Repository用于标注数据访问组件的注解
@ServiceService层组件注解
@Component泛指组件注解,不进行具体分类,建议对可分类的组件不要使用该注解,而应该使用诸如@Service这种具有分类含义的注解。
@Autowired@Autowired注解是按照类型(byType)装配依赖对象,默认情况下它要求依赖对象必须存在,如果允许null值,可以设置它的required属性为false。如果我们想使用按照名称(byName)来装配,可以结合@Qualifier注解一起使用。
@Qualifier当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用
@Controller控制器类定义注解
@RequestMapping请求处理注解, 用于设定接收请求的类型、URL路径、请求参数等
@ResponseBody该注解标注表示方法返回数据写入到 HTTP Response body 中,并以json结构返回数据
@RestController该注解为@Controller 和 @ResponseBody的整合注解
@ExceptionHandler异常处理注解,当该注解标注方法时,如遇到注解value标记的注解抛出,则以被注释方法进行处理

注意:springboot还提供了很多其他的注解,不在此进行一一列举,此处仅列举出相对常用的注解

三、Spring 的 @AliasFor 说明

该注解用于实现Spring框架中,注解别名设定,以便注解的灵活应用,具体细节请参考以下文章
https://blog.csdn.net/wolfcode_cn/article/details/80654730

如有错误,欢迎大家斧正

这篇关于第一章 JAVA基础知识系列 -- 第二节 注解概念及应用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/951276

相关文章

Java五子棋之坐标校正

上篇针对了Java项目中的解构思维,在这篇内容中我们不妨从整体项目中拆解拿出一个非常重要的五子棋逻辑实现:坐标校正,我们如何使漫无目的鼠标点击变得有序化和可控化呢? 目录 一、从鼠标监听到获取坐标 1.MouseListener和MouseAdapter 2.mousePressed方法 二、坐标校正的具体实现方法 1.关于fillOval方法 2.坐标获取 3.坐标转换 4.坐

Spring Cloud:构建分布式系统的利器

引言 在当今的云计算和微服务架构时代,构建高效、可靠的分布式系统成为软件开发的重要任务。Spring Cloud 提供了一套完整的解决方案,帮助开发者快速构建分布式系统中的一些常见模式(例如配置管理、服务发现、断路器等)。本文将探讨 Spring Cloud 的定义、核心组件、应用场景以及未来的发展趋势。 什么是 Spring Cloud Spring Cloud 是一个基于 Spring

Javascript高级程序设计(第四版)--学习记录之变量、内存

原始值与引用值 原始值:简单的数据即基础数据类型,按值访问。 引用值:由多个值构成的对象即复杂数据类型,按引用访问。 动态属性 对于引用值而言,可以随时添加、修改和删除其属性和方法。 let person = new Object();person.name = 'Jason';person.age = 42;console.log(person.name,person.age);//'J

java8的新特性之一(Java Lambda表达式)

1:Java8的新特性 Lambda 表达式: 允许以更简洁的方式表示匿名函数(或称为闭包)。可以将Lambda表达式作为参数传递给方法或赋值给函数式接口类型的变量。 Stream API: 提供了一种处理集合数据的流式处理方式,支持函数式编程风格。 允许以声明性方式处理数据集合(如List、Set等)。提供了一系列操作,如map、filter、reduce等,以支持复杂的查询和转

Java面试八股之怎么通过Java程序判断JVM是32位还是64位

怎么通过Java程序判断JVM是32位还是64位 可以通过Java程序内部检查系统属性来判断当前运行的JVM是32位还是64位。以下是一个简单的方法: public class JvmBitCheck {public static void main(String[] args) {String arch = System.getProperty("os.arch");String dataM

详细分析Springmvc中的@ModelAttribute基本知识(附Demo)

目录 前言1. 注解用法1.1 方法参数1.2 方法1.3 类 2. 注解场景2.1 表单参数2.2 AJAX请求2.3 文件上传 3. 实战4. 总结 前言 将请求参数绑定到模型对象上,或者在请求处理之前添加模型属性 可以在方法参数、方法或者类上使用 一般适用这几种场景: 表单处理:通过 @ModelAttribute 将表单数据绑定到模型对象上预处理逻辑:在请求处理之前

eclipse运行springboot项目,找不到主类

解决办法尝试了很多种,下载sts压缩包行不通。最后解决办法如图: help--->Eclipse Marketplace--->Popular--->找到Spring Tools 3---->Installed。

JAVA读取MongoDB中的二进制图片并显示在页面上

1:Jsp页面: <td><img src="${ctx}/mongoImg/show"></td> 2:xml配置: <?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001

Java面试题:通过实例说明内连接、左外连接和右外连接的区别

在 SQL 中,连接(JOIN)用于在多个表之间组合行。最常用的连接类型是内连接(INNER JOIN)、左外连接(LEFT OUTER JOIN)和右外连接(RIGHT OUTER JOIN)。它们的主要区别在于它们如何处理表之间的匹配和不匹配行。下面是每种连接的详细说明和示例。 表示例 假设有两个表:Customers 和 Orders。 Customers CustomerIDCus

22.手绘Spring DI运行时序图

1.依赖注入发生的时间 当Spring loC容器完成了 Bean定义资源的定位、载入和解析注册以后,loC容器中已经管理类Bean 定义的相关数据,但是此时loC容器还没有对所管理的Bean进行依赖注入,依赖注入在以下两种情况 发生: 、用户第一次调用getBean()方法时,loC容器触发依赖注入。 、当用户在配置文件中将<bean>元素配置了 lazy-init二false属性,即让