关山难越,谁悲失路之人;萍水相逢,尽是他乡之客。
百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程教程 > 技术文章 > 正文

Java中的注解:自定义注解和预定义注解

guanshanw 2023-09-16 10:49 26 浏览 0 评论

Java 中的注解(Annotation)是一种元数据,在代码中添加注解可以提供额外的信息,帮助编译器、工具和框架更好地理解代码。Java 的注解分为预定义注解和自定义注解两种。

一、预定义注解

预定义注解是指 Java 语言中已经定义好的注解,可以直接使用。Java SE 提供了许多预定义注解,这些注解在 JDK 中已经实现,并且提供相应的处理器对注解进行处理。以下是一些常见的预定义注解:

1、@Override

用于修饰方法,表示该方法是覆盖了父类或实现了接口中的方法,如果不是,则会产生编译错误。该注解可以帮助开发者检查是否正确地重写了方法。

2、@Deprecated

用于修饰类、方法或字段,表示该类、方法或字段已经被废弃,不再建议使用,而且未来可能会被移除。该注解可以帮助开发者明确哪些代码已经过时,提示开发者应该使用替代方法。

3、@SuppressWarnings

用于忽略编译器警告,可以指定要忽略的警告类型。该注解可以帮助开发者在必要时关闭编译器的警告,以便更方便的书写代码。

4、@SafeVarargs

用于修饰泛型方法,表示这个方法是安全的可变参数,不会因为类型转换错误而导致异常。该注解可以帮助开发者在泛型方法中正确地使用可变参数。

5、@FunctionalInterface

用于修饰函数式接口,表示该接口只有一个抽象方法,可以被用作 Lambda 表达式或方法引用。该注解可以帮助开发者标识哪些接口是函数式接口,从而避免在使用 Lambda 表达式时出现编译错误。

二、自定义注解

自定义注解是指由开发者自己定义的注解,可以根据需要自由规定注解名称、属性和取值等信息。自定义注解也可以使用在类、方法、成员变量等上,以提供额外的元数据信息,帮助编写更加优雅的代码。以下是自定义注解的基本格式:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value();
}

自定义注解需要用 @interface 关键字进行声明,其中的 Target 和 Retention 是元注解(meta-annotation),用来定义注解的行为和使用方式。我们也可以在声明注解时添加其他的元数据信息,如:注解属性和默认取值等。

1、注解属性

注解属性(Annotation Attributes)可以看作是注解的成员变量,使用注解时可以为这些属性赋值。注解属性定义的格式为类型 属性名() default 默认值。以下是一个例子:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String name();
    int age() default 18;
}

在上述代码中,我们定义了两个注解属性:name 和 age,其中 age 设置了默认值为 18。使用自定义注解时,可以按照以下格式进行赋值:

@MyAnnotation(name="张三", age=20)
public class MyClass {
    // ...
}

2、注解处理器

自定义注解也需要被各种工具和框架所识别和处理,这就需要使用注解处理器(Annotation Processor)。注解处理器可以读取和解析注解信息,做出相应的操作,如生成文档、生成代码等。

注解处理器一般需要继承 AbstractProcessor 类,并实现 process 方法。该方法会在编译时被调用,用于读取和处理注解信息,生成相应的输出。以下是一个简单的注解处理器:

@SupportedAnnotationTypes("com.example.MyAnnotation")
public class MyAnnotationProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (TypeElement annotation : annotations) {
            for (Element element : roundEnv.getElementsAnnotatedWith(annotation)) {
                // 处理注解信息
            }
        }
        return true;
    }
}

在上述代码中,我们通过 SupportedAnnotationTypes 注解指定了要处理的自定义注解,然后在 process 方法中读取和处理注解信息。

三、总结

注解是 Java 语言中一种非常有用的特性,可以为程序提供额外的元数据信息。Java 中的注解分为预定义注解和自定义注解两种,预定义注解已经由 JDK 实现,并提供相应的处理器对注解进行处理;自定义注解则需要开发者根据需求自行定义,并使用注解处理器进行处理。在实际开发中,注解能够显著提高代码的可读性、可维护性和可扩展性,值得我们在编码过程中充分利用和探索。

相关推荐

七条简单命令让您玩转Git
七条简单命令让您玩转Git

凭借着出色的协作能力、快速部署效果与代码构建辅助作用,Git已经得到越来越多企业用户的青睐。除了用于开发商业及消费级应用之外,众多科学及政府机构也开始尝试使用这...

2023-10-07 12:14 guanshanw

基本完整的关于Git分支branch的操作
基本完整的关于Git分支branch的操作

Git使用背景项目中要用到dev或者其他分支开发完代码,需要将该分支合并到master的需求操作步骤下面以dev名称为lex为分支名为例来操作一遍客户端操作:...

2023-10-07 12:14 guanshanw

Git 进阶(合并与变基)
Git 进阶(合并与变基)

在Git中整合来自不同分支的修改主要有两种方法:合并(merge)以及变基(rebase)合并(merge)merge流程图merge的原理是找到这两个分...

2023-10-07 12:13 guanshanw

Git学习笔记 003 Git进阶功能 part5 合并(第一部分)

合并(merge)是很常用的操作。尤其是一个庞大的很多人参与开发的企业级应用。一般会设定一个主分支,和多个副分支。在副分支开发完成后,合并到主分支中。始终保持主分支是一个完整的,稳定的最新状态的分支。...

非标题党,三张图帮你理解git merge和git rebase的区别
非标题党,三张图帮你理解git merge和git rebase的区别

初始场景:基于正常的开发分支修改几个小bug,然后在合并到开发分支上。gitmergegitcheckoutfeaturegitmergeho...

2023-10-07 12:13 guanshanw

git 初次使用(01)
git 初次使用(01)

先从github上克隆代码下来:使用vscode克隆代码如下图,填写上github仓库地址:vscode有时候克隆代码速度比较慢,可以用命令行方式克隆gitc...

2023-10-07 12:12 guanshanw

Git 远程操作

4.Git远程操作命令说明gitremote远程版本库操作gitfetch从远程获取版本库gitpull下载远程代码并合并gitpush上传远程代码并合并4.1远程版本库操作gitre...

Git常用命令-总结
Git常用命令-总结

创建git用户$gitconfig--globaluser.name"YourName"$gitconfig--globaluser.em...

2023-10-07 12:12 guanshanw

git中删除从别人clone下来项目的git信息,并修改为自己的分支

如果你从别人的Git存储库中克隆了一个项目,并想要删除与该存储库相关的Git信息,并将其修改为你自己的分支,则可以执行以下步骤:使用gitclone命令克隆存储库:gitclone<u...

git系列-回滚和放弃本地修改

回滚历史提交就是reset的功能。这种情况是已经提交远程仓库,需要回滚到之前的提交。gitreset--hardcommitId//注:强制提交后,当前版本后面的提交版本将会删掉!gi...

GIT使用小技巧大全
GIT使用小技巧大全

在大型软件工程的开发过程中,版本控制是无法绕过去的;目前来说,最火的版本控制软件就是GIT了。早两年SVN比较火,不过被大神linus喷了几次后,就日落西山了,...

2023-10-07 12:11 guanshanw

git相关命令-上
git相关命令-上

这些命令都是看了文档后,个人觉得比较有用的一些,展示给大家。回到远程仓库的状态抛弃本地所有的修改,回到远程仓库的状态。gitfetch--all&...

2023-10-07 12:10 guanshanw

Git命令行接口:掌握Git的必备技能
Git命令行接口:掌握Git的必备技能

Git是一款强大的分布式版本控制工具,它支持命令行界面操作。熟练掌握Git命令行接口,是开发者使用Git的必备技能之一。在这篇文章中,我们将介绍Git命令行接口...

2023-10-07 12:10 guanshanw

Git命令详解
Git命令详解

相信各位小伙伴们应该都对git有一些了解,毕竟作为代码管理的神器,就算不是IT行业的小伙伴肯定也或多或少的听说过一些。今天就来和小伙伴们分享一下自己总结的常用命...

2023-10-07 12:10 guanshanw

工作7年收集到的git命令
工作7年收集到的git命令

概念git中的术语解释:仓库也叫版本库(repository)stage:暂存区,add后会存到暂存区,commit后提交到版本库git安装linux...

2023-10-07 12:10 guanshanw

取消回复欢迎 发表评论: