第一章 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使用protobuf-maven-plugin的插件编译proto文件详解

《java使用protobuf-maven-plugin的插件编译proto文件详解》:本文主要介绍java使用protobuf-maven-plugin的插件编译proto文件,具有很好的参考价... 目录protobuf文件作为数据传输和存储的协议主要介绍在Java使用maven编译proto文件的插件

Java中的数组与集合基本用法详解

《Java中的数组与集合基本用法详解》本文介绍了Java数组和集合框架的基础知识,数组部分涵盖了一维、二维及多维数组的声明、初始化、访问与遍历方法,以及Arrays类的常用操作,对Java数组与集合相... 目录一、Java数组基础1.1 数组结构概述1.2 一维数组1.2.1 声明与初始化1.2.2 访问

Javaee多线程之进程和线程之间的区别和联系(最新整理)

《Javaee多线程之进程和线程之间的区别和联系(最新整理)》进程是资源分配单位,线程是调度执行单位,共享资源更高效,创建线程五种方式:继承Thread、Runnable接口、匿名类、lambda,r... 目录进程和线程进程线程进程和线程的区别创建线程的五种写法继承Thread,重写run实现Runnab

Java 方法重载Overload常见误区及注意事项

《Java方法重载Overload常见误区及注意事项》Java方法重载允许同一类中同名方法通过参数类型、数量、顺序差异实现功能扩展,提升代码灵活性,核心条件为参数列表不同,不涉及返回类型、访问修饰符... 目录Java 方法重载(Overload)详解一、方法重载的核心条件二、构成方法重载的具体情况三、不构

Java通过驱动包(jar包)连接MySQL数据库的步骤总结及验证方式

《Java通过驱动包(jar包)连接MySQL数据库的步骤总结及验证方式》本文详细介绍如何使用Java通过JDBC连接MySQL数据库,包括下载驱动、配置Eclipse环境、检测数据库连接等关键步骤,... 目录一、下载驱动包二、放jar包三、检测数据库连接JavaJava 如何使用 JDBC 连接 mys

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置(核心数、队列容量、拒绝策略等)及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略(Rejected

一文详解SpringBoot中控制器的动态注册与卸载

《一文详解SpringBoot中控制器的动态注册与卸载》在项目开发中,通过动态注册和卸载控制器功能,可以根据业务场景和项目需要实现功能的动态增加、删除,提高系统的灵活性和可扩展性,下面我们就来看看Sp... 目录项目结构1. 创建 Spring Boot 启动类2. 创建一个测试控制器3. 创建动态控制器注

Java操作Word文档的全面指南

《Java操作Word文档的全面指南》在Java开发中,操作Word文档是常见的业务需求,广泛应用于合同生成、报表输出、通知发布、法律文书生成、病历模板填写等场景,本文将全面介绍Java操作Word文... 目录简介段落页头与页脚页码表格图片批注文本框目录图表简介Word编程最重要的类是org.apach

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

SpringBoot+Docker+Graylog 如何让错误自动报警

《SpringBoot+Docker+Graylog如何让错误自动报警》SpringBoot默认使用SLF4J与Logback,支持多日志级别和配置方式,可输出到控制台、文件及远程服务器,集成ELK... 目录01 Spring Boot 默认日志框架解析02 Spring Boot 日志级别详解03 Sp