Java注解

最新推荐文章于 2023-07-22 22:06:11 发布
最新推荐文章于 2023-07-22 22:06:11 发布
阅读量451 收藏
点赞数
分类专栏： Java SE 文章标签： java 注解
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/winfredzen/article/details/51603688
版权

Java注解

注解：Java提供了一种原程序中的元素关联任何信息和任何元数据的途径和方法

JDK中的注解

@Override 表示覆盖父类的方法
@Deprecated表示方法已经过时了，使用@SuppressWarnings("deprecation") 来忽略过时的警告

@SuppressWarnings("deprecation")
public void sing(){
    Person person = new Child();
    person.sing();
}

常见第三方注解

Spring的常见注解：

  • @Autowired-可以对成员变量、方法、构造函数、类，进行注释。默认按类型装配
  • @Service-用于标注业务层组件
  • @Repository-用于标注数据访问组件，即DAO组件

注解的分类

按照运行机制分类:

  • 源码注解 - 注解只在源码中存在，编译成.class文件就不存在了
  • 编译时注解 - 注解在源码和.class文件中都存在(@Override,@Deprecated,@SuppressWarnings)都属于编译时注解
  • 运行时注解 - 在运行阶段还起作用，甚至会影响运行逻辑的注解，例如Spring的@Autowired注解

按照来源来分:

  • 来自JDK的注解
  • 来自第三方的注解
  • 自定义的注解

元注解对注解进行注解

自定义注解

自定义注解的语法要求

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description {
    String desc();

    String author();

    int age() default 18;
}
  1. 使用@interface关键字定义注解
  2. 成员以无参数无异常方式声明，如String desc();
  3. 可以使用default为成员指定一个默认值，如int age() default 18;
  4. 成员类型是受限的，合法的类型包括原始类型及String，Class，Annotation，Enumeration
  5. 如果注解只有一个成员变量，则成员必须取名为value(),在使用时可以忽略成员名和赋值号(=)
  6. 注解类可以没有成员，没有成员的注解成为标识注解

元注解

参考自：深入理解Java：注解（Annotation）自定义注解入门
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它annotation类型作说明。Java5.0定义的元注解：

  1. @Target 作用域
  2. @Retention 生命周期
  3. @Documented 生成javadoc时会包含注解
  4. @Inherited 允许子类继承

元注解

@Target
@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

作用：用于描述注解的使用范围(作用域)（即：被描述的注解可以用在什么地方）

取值(ElementType)有：

  1. CONSTRUCTOR:用于描述构造器
  2. FIELD:用于描述域
  3. LOCAL_VARIABLE:用于描述局部变量
  4. METHOD:用于描述方法
  5. PACKAGE:用于描述包
  6. PARAMETER:用于描述参数
  7. TYPE:用于描述类、接口(包括注解类型) 或enum声明

使用实例：

@Target(ElementType.TYPE)
public @interface Table {
    /**
     * 数据表名称注解，默认值为类名称
     * @return
     */
    public String tableName() default "className";
}

@Target(ElementType.FIELD)
public @interface NoDBColumn {

}

@Retention
@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

取值（RetentionPoicy）有：

  1. SOURCE:在源文件中有效（即源文件保留）
  2. CLASS:在class文件中有效（即class保留）
  3. RUNTIME:在运行时有效（即运行时保留）

例子：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

使用自定义注解
使用注解的语法，如下：

这里写图片描述

这里@Description作用于eyeColor()方法

解析注解

通过反射获取类、函数或成员上的运行时注解信息，从而实现动态控制程序运行的逻辑

创建一个名为Description的注解，如下：

    package com.imooc.zhujie;

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

    @Target({ElementType.TYPE, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    @Documented
    public @interface Description {

        String value();

    }

Child类中的使用Description注解，如下：

    package com.imooc.zhujie;

    @Description("I am class annotation")
    public class Child implements Person{

        @Override
        @Description("I am method annotation")
        public String name() {
            // TODO Auto-generated method stub
            return null;
        }

        @Override
        public int age() {
            // TODO Auto-generated method stub
            return 0;
        }

        @Override
        public void sing() {
            // TODO Auto-generated method stub

        }



    }

如何解析注解？

    public static void main(String[] args) {
        //使用类加载器加载类
        try {
            Class c = Class.forName("com.imooc.zhujie.Child");
            //找到类上面的注解
            boolean isExist = c.isAnnotationPresent(Description.class);
            if (isExist) {
                //拿到注解实例
                Description d = (Description) c.getAnnotation(Description.class);
                System.out.println(d.value());
            }

            //找到方法上的注解
            Method[] ms = c.getMethods();
            for (Method method : ms) {
                boolean isMExist = method.isAnnotationPresent(Description.class);
                if (isMExist) {
                    Description d = method.getAnnotation(Description.class);
                    System.out.println(d.value());
                }
            }

            //另外一种解析方法
            for (Method method : ms) {
                Annotation[] as = method.getAnnotations();
                for (Annotation annotation : as) {
                    if (annotation instanceof Description) {
                        Description d = (Description)annotation;
                        System.out.println(d.value());
                    }
                }
            }

        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }

应用

这个应用的实例是，代替Hibernate的解决方案，核心代码通过注解来实现

需求：
1.有一张用户表，字段包括用户ID，用户名，昵称，年龄，性别，所在城市，邮箱，手机号
2.方便对每个字段或字段组合进行检索，并打印出SQL
3.使用方式要足够简单

首先考虑的是代码如何与数据库进行映射?
数据库有表名，有字段名，那代码如何知道数据库的表名和字段名呢？考虑使用注解

创建Table注解，用来注解类，表示表名

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

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {

    String value();

}

创建Column注解

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

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {

    String value();

}

创建一个查询方法，通过对象来查询，步骤大致如下：
1.获取table的名字
2.遍历所有的字段，处理每个字段对应的sql

代码如下，详细过程参见注释

    private static String query(Object f)
    {
        StringBuilder sb = new StringBuilder();
        //1.获取class
        Class c = f.getClass();
        //2.获取到table的名字
        boolean exists =  c.isAnnotationPresent(Table.class);
        if (!exists) {
            return null;
        }
        Table t = (Table) c.getAnnotation(Table.class);
        String tableName = t.value();

        sb.append("select * from ").append(tableName).append(" where 1=1 ");

        //3.遍历所有的字段
        Field[] fields = c.getDeclaredFields();
        for (Field field : fields) {
            //4.处理每个字段对应的sql
            //4.1获取到字段名  拼装sql
            boolean fExists = field.isAnnotationPresent(Column.class);
            if (!fExists) {
                continue;
            }
            Column column =  field.getAnnotation(Column.class);
            String columnName = column.value();

            //4.2获取到字段的值
            String fieldName = field.getName();
            String getMethodName = "get" + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1);
            Object fieldValue = null;
            try {
                Method getMethod = c.getMethod(getMethodName);
                fieldValue = getMethod.invoke(f);
            } catch (Exception e) {
                e.printStackTrace();
            } 

            //4.3拼装sql
            if (fieldValue == null || (fieldValue instanceof Integer && (Integer)fieldValue==0)) {
                continue;
            }
            sb.append(" and ").append(columnName);
            if (fieldValue instanceof String) {//字符串添加单引号
                if (((String) fieldValue).contains(",")) {//in条件，分割
                    String[] values = ((String) fieldValue).split(",");
                    sb.append(" in(");
                    for (String v : values) {
                        sb.append("'").append(v).append("'").append(",");
                    }
                    sb.deleteCharAt(sb.length()-1);//删除最后一个逗号
                    sb.append(")");
                }else{
                    sb.append(" = ").append("'").append(fieldValue).append("'");
                }
            }else if(fieldValue instanceof Integer){
                sb.append(" = ").append(fieldValue);
            }
        }

        return sb.toString();
    }

测试如下：

        Filter f1 = new Filter();
        f1.setId(10);//查询id为10的用户

        Filter f2 = new Filter();
        f2.setUserName("lucy");//查询用户名为lucy的用户

        Filter f3 = new Filter();
        f3.setEmail("liu@123.com,zh@163.com,7777@qq.com");//查询邮箱为任意一个的用户

        String sql1 = query(f1);
        String sql2 = query(f2);
        String sql3 = query(f3);

        System.out.println(sql1);
        System.out.println(sql2);
        System.out.println(sql3);

控制台输出如下：

select * from user where 1=1  and id = 10
select * from user where 1=1  and user_name = 'lucy'
select * from user where 1=1  and email in('liu@123.com',' zh@163.com',' 7777@qq.com')

参考：

winfredzen
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Java注解简单使用实例解析
08-18
Java注解简单使用实例解析 Java注解简单使用实例解析是Java语言中的一种 元数据形式，用于提供补充信息给编译器、虚拟机或其他工具。在Java中，注解可以出现在各种语法元素上，如类、方法、字段、参数等。今天，...
Java 注解
12-22
提到注解，我们会不由的想到注释，其实注解和注释不是一个东西，注释的作用就是解释代码，方便理解和阅读，说白了就是给程序员看的。而注解则不是，注解的作用比较大，可以进行编译检查、生成doc文档或者进行代码...
java元注解_Java的元注解
weixin_33636371的博客
02-22 761
注解是一系列元数据，它利用元数据来解释、说明程序代码(即被注解的对象)。注解的作用包括：1、提供信息给编译器，编译器可以利用注解来探测错误和警告信息。2、软件工具可以利用注解信息来生成代码、HTML文档或者做其他相应处理。3、运行时的处理，某些注解可以在程序运行时接受代码的提取。注解通过关键字@interface进行定义，如：public @interface TestAnnotation {}元...
Java元注解
weixin_48554146的博客
03-30 2631
Java 注解（Annotation）,也叫元数据
java元注解
zh123456_789的博客
09-14 1148
java元注解 本文主要针对于java8，java8定义了6个标准元注解：@Target，@Retention，@Documented，@Inherited，@Repeatable和@Native。 1.@Target注解。 @Target注解的作用是：描述注解的使用范围（即被修饰的注解可以用在什么地方）。 @Target注解源码： @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) pub
Java源注解
qq_42191775的博客
02-18 523
Java源注解 1、@Documented: 用于标记在生成javadoc时是否将注解包含进去，可以看到这个注解和@Override一样，注解中空空如也，什么东西都没有。 2、@Target 用于定义注解可以在什么地方使用，默认可以在任何地方使用，也可以指定使用的范围，开发中将注解用。 TYPE : 类、接口或enum声明 FIELD: 域(属性)声明 METHOD: 方法声明 PA...
java 元注解
Trival_dreamy的博客
11-23 127
一、注解：深入理解JAVA注解 　　要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。 1、元注解（meta-annotation）： 　　元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java...
java 注解
10-15
===如果你想对 java有 更多 的理 解你 可以 下载 看 看
java注解和反射的个人学习笔记
03-01
java注解和反射的个人学习笔记
java注解之运行时修改字段的注解值操作
08-24
Java 注解是 Java 语言的一种特殊的注释方式，用于标注Java代码。注解可以在编译期、运行期对代码进行处理和修改。常见的 Java 注解有 @Override、@Deprecated 等。 Java 注解的分类 Java 注解可以分为三种：源码...
java 原生注解（基于java8）整理记录
qingdatiankong的博客
01-12 1123
参考资料：https://docs.oracle.com/javase/8/docs/api/ Java内部原生注解，共有 11 个，java.lang中有5个、java.lang.annotation 中有6个。 ①java.lang中5个：作用在代码的注解 @Deprecated：标记已过时方法。如果使用该方法，会报编译警告 @FunctionalInterface（java8新增）：标记在接口上，表示该接口为：函数式接口。指仅仅只包含一个抽象方法的接口，例如Runnable @Override：标
Java注解——元注解
最新发布
qq_58461006的博客
07-22 1065
写在注解定义上的注解叫元注解（注解是给程序提供信息，写在注解上的注解是给注解提供信息，给信息提供信息的叫元信息）。
Java源程序的注释
weixin_45714733的博客
12-21 456
什么是注释？注释的作用是什么？ * 出现在java源程序中对java源程序的解释说明。 * 注释不会被编译在 .class文件中 * 一个好的开发习惯应该是多写注释，这样程序的可读性比较强。 java中的注释有哪些？怎么写呢？ 1.单行注释 // 单行注释 ， 只注释当前行。 2.多行注释 （注释符中间所有内容都会被注释） ...
java中的注解
robin912的专栏
06-17 177
注解的语法 注解同class和interface一样，属于Java的一种类型。 定义: public @interface CustomAnnotation { } 使用: @CustomAnnotation public class Example { } 元注解 用于注解注解的标签 元标签有 @Retention、@Documented、@Target、@Inher...
Java元注解有哪些
乐乐的博客
04-06 2452
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它annotation类型作说明。Java5.0定义的元注解有以下几种： 元注解是指注解的注解，Java中有： ① @Retention: 定义注解的保留策略 SOURCE : 保留在源文件 CLASS : 保留在class文件 RUNTIME : 保留在运行时 ② @Ta...
Java注解中的元注解
李章勇的博客
01-03 350
　　Java注解中的四个元注解分别是：@Target，@Retention，@Documented，@Inherited。 　　元注解是java API提供的，是专门用来定义注解的注解，其作用分别如下：       （1）@Target 表示该注解用于什么地方，可能的值在枚举类 ElemenetType 中，包括：           ElemenetType.CONSTRUCTOR-------...
详述Java元注解
qq_46091702的博客
02-01 243
元注解用于修饰自定义注解，常用的元注解有@Target、@Retention 、@Documented、@Inherited和@Repeatable。 1、@Target： 指定被修饰自定义注解的位置，ElementType.FIELD应用于全局属性，ElementType.METHOD应用于方法，ElementType.PARAMETER应用于方法的参数，ElementType.TYPE应用于类、接口或者枚举声明。 @Target({ElementType.TYPE,ElementType.MET
java 注解
06-02
Java注解是Java语言的一个重要特性，它是一种代码级别的元数据，可以为Java程序元素(如类、方法、变量等)添加信息和标记。Java注解可以在编译时、运行时或者两者都有使用。 Java中的注解使用@符号作为标识符，例如：@Override、@Deprecated、@SuppressWarnings等。注解可以用于代码的文档化、检查、优化、框架和库的配置等多种场景。 Java注解的定义方式是使用@interface关键字。注解定义的基本语法如下： ``` public @interface AnnotationName { //注解元素 } ``` 其中，注解元素可以是基本数据类型、String类型、Class类型、枚举类型、注解类型或以上类型的数组类型。注解元素可以有默认值，使用default关键字指定。 Java注解的使用方式是在目标元素前加上注解，例如： ``` @AnnotationName public void method() { //方法体 } ``` 注解也可以使用参数，参数使用key-value的方式指定，例如： ``` @AnnotationName(key1 = "value1", key2 = "value2") public void method() { //方法体 } ``` Java注解的处理方式是使用反射机制，可以通过反射获取注解的信息，用于实现各种功能。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值