Java注解

最新推荐文章于 2024-05-11 23:45:05 发布
最新推荐文章于 2024-05-11 23:45:05 发布
阅读量399 收藏
点赞数
分类专栏： SpringBoot 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Hao_ge_666/article/details/131502004
版权

一、什么是注解

        注解是放在Java源码的类、字段、方法、参数前的一种特殊的“注释”，和普通注释的区别是，普通注释被编译器直接忽略，注解则可以被编译器打包进入Class文件。如下图所示就是lombok中的一些注解。

注解的作用：

        从JVM角度看，注解本身对代码逻辑没有任何影响，如何使用注解完全由工具决定。Java的注解可以分为三类：

        第一类是由编辑器使用的注解，例如@Override（让编辑器检查该方法是正确的实现了覆写）；@SuppressWarnings（告诉编译器忽略此处代码产生的警告）等等，这类注解不会被编译进入.class文件，它们在编译后就被编译器扔掉了。

        第二类是由工具处理.class文件使用的注解，比如有些工具会在加载class的时候，对class做动态修改，实现一些特殊的功能。这类注解会被编译进入.class文件，但加载结束后并不会存在于内存中。这类注解只被一些底层库使用，一般我们不必自己处理。

        第三类是程序运行期间能够读取的注解，他们加载之后一直存在于JVM中，也是最常用的注解。

二、定义注解

        定义一个注解时，还可以定义配置参数，配置参数可以包括所有基本类型、String、枚举或上面三种类型和Class的数组。因为配置参数必须是常量，所以，上述限制保证了注解在定义时就已经确定了每个参数的值。注解的配置参数可以有默认值，缺少某个配置参数时将使用默认值（强烈建议写默认值）。如果在定义的时候只写了注解，相当于全部使用默认值。如果参数名名称是value且只有这一个参数，可以省略参数名称，直接在（）里面写值就可以。

        Java语言中使用@interface语法来定义注解，格式如下：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Demo13_Annotation {
    int min() default 0;
    int max() default 255;
}

注解的参数类似于无参数方法，可以使用default设置一个默认值（推荐），最常用的参数应当命名为value。

        查看上面代码我们可以发现，在注解的定义中也是用到了一些注解，这些注解就被称为元注解，元注解可以修饰其它注解，Java标准库中已经定义了一些元注解，我们只需要使用即可。

        元注解最常用的有两种，分别是@Target和@Retention。

2.1、@Target

        使用@Target可以定义注解能够被应用于源码的哪些位置：

        1、类或接口：ElementType.TYPE；

        2、字段：ElementType.FIELD；

        3、方法：ElementType.METHOD；

        4、构造方法：ElementType.CONSTRUCTOR；

        5、参数方法：ElementType.PARAMETER。

        例如上图中我们定义了只能被应用于字段Field。如果可以用于多个位置，可以把@Target的参数变为数组。

2.2、@Retention

        使用@Retention可以定义注解的生命周期：

        1、仅编译期：RetentionPolicy.SOURCE；

        2、仅Class文件：RetentionPolicy.CLASS；

        3、运行期：RetentionPolicy.RUNTIME。

        如果@Retention不存在，默认是Class。通常我们定义的都是RUNTIME。

2.3、@Repeatable

        可以定义注解是否可重复，应用不广泛。

2.4、@Inherited

        定义子类是否可以继承父类定义的注解，仅针对@Target(ElementType.TYPE)类型的注解有效。

可以看一下NotBlank的注解：

 综上，定义注解的步骤：

        1、使用@interface定义注解：

public @interface Demo13_Annotation {
}

        2、添加参数、默认值：

public @interface Demo13_Annotation {
    int min() default 0;
    int max() default 255;
}

        3、用元注解配置注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Demo13_Annotation {
    int min() default 0;
    int max() default 255;
}

        其中必须设置 @Target和@Retention，@Retention一般为RUNTIME。

三、处理注解

        Java的注解本身对于代码逻辑没有任何影响，其中SOURCE类型的注解在编译期就被丢掉了；CLASS的注解仅保存在class文件中，不被加载至JVM；RUNTIME类型的注解会被加载至JVM且在运行期可以被程序读取。

        如何使用注解完全由工具决定，这里我们只讨论RUNTIME类型的注解。

        JAVA提供了使用反射API判断注解是否存在和读取注解的方法：

3.1、判断某个注解是否存在

  • Class.isAnnotationPresent(Class)：是否存在于Class
  • Field.isAnnotationPresent(Class)：是否存在于Field
  • Method.isAnnotationPresent(Class)
  • Constructor.isAnnotationPresent(Class)

例如判断@Report是否存在于Person类：

Person.class.isAnnotationPresent(Report.class);

3.2、利用反射读取注解

  • Class.getAnnotation(Class)
  • Field.getAnnotation(Class)
  • Method.getAnnotation(Class)
  • Constructor.getAnnotation(Class)

例如获取Person定义的@Report注解：

// 获取Person定义的@Report注解:
Report report = Person.class.getAnnotation(Report.class);
int type = report.type();
String level = report.level();

使用反射读取注解有两种方法：

        1、先判断是否存在，如果存在，再读取：

Class cls = Person.class;
if (cls.isAnnotationPresent(Report.class)) {
    Report report = cls.getAnnotation(Report.class);
    ...
}

        2、直接读取注解，如果注解不存在，返回null：

Class cls = Person.class;
Report report = cls.getAnnotation(Report.class);
if (report != null) {
   ...
}

四、使用注解

4.1、声明一个注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Demo13_Annotation {
    int min() default 0;
    int max() default 255;
}

4.2、声明一个类使用注解

public class Demo14_UseAnnotation {
    
    @Demo13_Annotation(min = 3, max = 25)
    private String name;

    @Demo13_Annotation(min = 11, max = 11)
    private String phone;

    public Demo14_UseAnnotation(){

    }

    public Demo14_UseAnnotation(String name, String phone){
        this.name = name;
        this.phone = phone;
    }

}

4.3、定义方法来使用注解

void check(Demo14_UseAnnotation demo14_UseAnnotation) throws IllegalArgumentException, ReflectiveOperationException{

        for (Field field:demo14_UseAnnotation.getClass().getDeclaredFields()){  // 遍历所有Field（包含私有）
            field.setAccessible(true);  // 如果是私有，设置访问权限
            if(field.isAnnotationPresent(Demo13_Annotation.class)){  // 判断注解是否存在
                Demo13_Annotation demo13_Annotation = field.getAnnotation(Demo13_Annotation.class);  // 如果存在则读取注解 
                Object value = field.get(demo14_UseAnnotation);  // 通过反射获取该字段值
                if (value instanceof String){  // 判断是否为String
                    String s = (String) value;
                    if (s.length() < demo13_Annotation.min() || s.length() > demo13_Annotation.max()){  // 判断是否满足注解的min和max
                        throw new IllegalArgumentException("Invalid field: " + field.getName());
                    }
                }
            }
        }
    }

4.4、调用注解方法

import java.lang.reflect.Field;

public class Demo15_HandlingAnnotation{
    public static void main(String[] args) throws IllegalArgumentException, ReflectiveOperationException {

        Demo15_HandlingAnnotation demo15_HandlingAnnotation = new Demo15_HandlingAnnotation();

        Demo14_UseAnnotation demo14_UseAnnotation = new Demo14_UseAnnotation("张三", "12345678910");
        demo15_HandlingAnnotation.check(demo14_UseAnnotation);  // 调用注解方法

    }

    void check(Demo14_UseAnnotation demo14_UseAnnotation) throws IllegalArgumentException, ReflectiveOperationException{

        for (Field field:demo14_UseAnnotation.getClass().getDeclaredFields()){  // 遍历所有Field（包含私有）
            field.setAccessible(true);  // 如果是私有，设置访问权限
            if(field.isAnnotationPresent(Demo13_Annotation.class)){  // 判断注解是否存在
                Demo13_Annotation demo13_Annotation = field.getAnnotation(Demo13_Annotation.class);  // 如果存在则读取注解 
                Object value = field.get(demo14_UseAnnotation);  // 通过反射获取该字段值
                if (value instanceof String){  // 判断是否为String
                    String s = (String) value;
                    if (s.length() < demo13_Annotation.min() || s.length() > demo13_Annotation.max()){  // 判断是否满足注解的min和max
                        throw new IllegalArgumentException("Invalid field: " + field.getName());
                    }
                }
            }
        }
    }
}

通过上述过程我们就完成了注解的定义和使用。

五、实际应用

        使用注解和AOP完成日志记录功能。

5.1、定义日志注解类

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {

    //模块
    String value() default "Null";

    //功能
    String action() default "Null";

}

5.2、定义日志切面

@Aspect
@Component
@Slf4j
public class SystemLogAspect {

    // 定义切点 @Pointcut
    // 在注解的位置切入代码
    @Pointcut("@annotation(com....Log)")
    public void logPointCut(){
    }

    // 切面 配置通知
    @Before("logPointCut()")
    public void before(JoinPoint joinPoint){

        //通过反射获取注解
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        Log actionLog = method.getAnnotation(Log.class);

        if(actionLog != null){
            // 获取注解内容
            String value = actionLog.value();
            String action = actionLog.action();
            // 获取HttpServletRequest
            HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
            // 获取请求方法
            String httpMethod = request.getMethod();
            // 获取请求路径
            String requestURL = request.getRequestURI();
            // 获取用户IP
            String ip = request.getRemoteAddr();
            if (ip.equals("0:0:0:0:0:0:0:1")){
                ip = "127.0.0.1";
            }
            // 获取浏览器信息
            String browser = UserAgent.parseUserAgentString(request.getHeader("User-Agent")).getBrowser().getName();

            // ......其它需求
            log.info("action = " + action + ", value = " + value + ", httpMethod = " + httpMethod + ", requestURL = " + requestURL + ", ip = " + ip + ", browser = " + browser );

        }
    }
}

参考链接：使用注解 - 廖雪峰的官方网站

帅帅气气的黑猫警长
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Java 注解
12-22
提到注解，我们会不由的想到注释，其实注解和注释不是一个东西，注释的作用就是解释代码，方便理解和阅读，说白了就是给程序员看的。而注解则不是，注解的作用比较大，可以进行编译检查、生成doc文档或者进行代码...
java 注解
10-15
===如果你想对 java有 更多 的理 解你 可以 下载 看 看
java标注
Code Writers
08-11 1477
Java注解是一个很重要的知识点，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行注解。 掌握好Java注解有利于学习框架底层实现。@mikechen Java注解定义 Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。 Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。 Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置
java注解大全
Mr. Ding的小博客
05-18 8802
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注解全面总结
最新发布
2401_83915450的博客
05-11 970
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
【Java基础】学java注解，看这一篇文章就够了
fumeidonga的博客
05-08 2251
注解是一种标记，使类或接口附加额外信息，帮助编译器和 JVM 完成一些特定功能。Annotation(注解)也被称为元数据(Metadata)是JDK1.5及以后版本引入的，用于修饰包、类、接口、字段、方法参数、局部变量等。如：常见的 @Override、@Deprecated和@SuppressWarnings其核心思想是java的ioc（inversion of control），也叫di（dependency injection，依赖注入），是一种面向对象编程中的设计模式。
Java注解-超详细教程（附源码）
lililuni的博客
10-30 6977
111
Java注解简单使用实例解析
08-18
主要介绍了Java注解简单使用实例解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
java注解和反射的个人学习笔记
03-01
java注解和反射的个人学习笔记
全面解析Java注解
12-22
　对于Java开发人员来说，在编写代码时，除了源程序以外，我们还会使用Javadoc标签对类、方法或成员变量进行注释，以便使用Javadoc工具生成和源代码配套的Javadoc文档。这些@param、@return等Javadoc标签是注解标签...
java注解详解
weixin_42330641的博客
07-08 2523
java注解了解一下
Java自定义注解
weixin_67450855的博客
11-05 1万+
注解分类（根据Annotation是否包含成员变量,可以把Annotation分为两类）:标记Annotation:没有成员变量的Annotation;这种Annotation仅利用自身的存在与否来提供信息元数据Annotation:包含成员变量的Annotation;它们可以接受(和提供)更多的元数据;
java常用的注解（个人笔记）
一个后端菜鸟的博客
11-23 2975
一、java的内置注解（java 7 后额外添加了后三个注解）@Override-重写方法@Deprecatd 过时方法使用会编译警告@SuppessWarnings 忽略声明警告 @Target --标记注解为哪个java成员 @Inherited 标记注解继承哪个注解 @SafeVarargs 忽略任何参数关于 泛型变量的方法和构造函数产生的警告 @FunctionalInterface @Repeatable ...
java中注解的定义、创建和使用
qq_45752401的博客
12-24 3119
1，注解概述 什么是注解：Annotation注解，是一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次 对比注释： ​ 注释是给程序员看的，注解是给程序看的。（注解不会影响代码的正常执行） 注解的作用： ​ 主要用于取代 XML 和 properties 配置文件 2，JDK提供的注解 注解 说明 @Deprecated 表示被修饰的方法已经过时。过时的方法不建议使用，但仍可以使用 @Override JDK5.0 表示复写父类的方法；jdk6
Java基本注解详解(超级详细)
热门推荐
qq_44885775的博客
04-19 2万+
原文链接： 今日头条 Java注解是一个很重要的知识点，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行注解。 掌握好Java注解有利于学习框架底层实现。@mikechen Java注解定义 Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。 Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。 Java注解是附加在代码中的一些元信息，用于一些工具
java之注解的定义和使用
m0_64365419的博客
12-10 2020
interface 注解名注：一般情况下将Retention的值定义为：Retention.RUNTIME} } @Retention(value = RetentionPolicy . RUNTIME) //表示该注解在运行时仍然有效 @Documented //表示将该注解生成在javadoc中 @Inherited //表示子类可以继承父类的注解 //表示该注解可应用在方法上，如果应用到类上就会报错， //若还想应用在类上，则可在后面直接添加ElementType.TYPE @Target({
java基础-注解定义和解析
weixin_50369190的博客
10-25 635
java自定义注解的定义和使用，常用元注解，注解的解析。
Springboot 创建自定义注解，并在拦截器中判断注解是否存在
u013595395的博客
09-01 4647
一、创建自定义注解 @Target({ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) public @interface 不用鉴权 { String value(); int 单个变量() default 1; String[] 数组() default {}; } @interface 这种返回类型，表示这个东西是自定义注解 @Targe 指定注解可以放在哪里，HETHOD是方法上，TYPE是类、接口、枚举
java 注解
06-02
Java注解是Java语言的一个重要特性，它是一种代码级别的元数据，可以为Java程序元素(如类、方法、变量等)添加信息和标记。Java注解可以在编译时、运行时或者两者都有使用。 Java中的注解使用@符号作为标识符，例如...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值