java shujuku表注解依赖 javaee注解

转载

hochie 2023-07-17 16:23:17

文章标签 java shujuku表注解依赖 bc Java 成员变量 文章分类 Java 后端开发

JavaEE - 10注解

（2）注解（Annotation）

（2.1）注解（Annotation）概述

从JDK5.0开始，Java增加了对元数据（MetaData）的支持，就是Annotation（注解）。
Annotation就是代码里的特殊标记，这些标记可以在编译、类加载、运行时被读取，并执行相应的处理。
通过使用Annotation，可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。
代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或进行部署。
Annotation 可以像修饰符一样被使用，可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明，这些信息被保存在Annotation的"name=value"中。
JavaSE中，注解使用目的比较简单，例如标记过时的功能、忽略警告等。可以用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
未来的开发模式都是基于注解的。JPA、Spring2.5、Hibernate3.x、Struts2都基于注解了。框架 = 注解 + 反射 + 设计模式。

（2.2）注解示例

使用Annotation时要在前面增加@符号，并把该Annotation当成一个修饰符使用。用于修饰它支持的程序元素。
生成文档相关的注解

@author 标明开发该类模块的作者，多个作者之间使用,分隔
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@since 从哪个版本开始增加的
@param 对方法中某参数的说明，如果没有参数就不能写；格式要求： @param 形参名形参类型形参说明
@return 对方法返回值的说明，返回值类型为void就不能写；格式要求： @return 返回值类型返回值说明
@exception 对方法可能抛出的异常进行说明，如果没有用throws显示抛出异常就不能写；格式要求： @exception 异常类型异常说明
说明： @param @return和@exception 都只用于方法； @param 和 @exception 可以并列多个。

编译时进行格式检查JDK内置的三个基本注解

@Override： 限定重写父类方法，该注解只能用于方法
@Deprecated：
@SuppressWarnings： 抑制编译期警告

public class AnnotationTest {
    public static void main(String[] args) {
        @SuppressWarnings("unused")
        int num = 10;

        @SuppressWarnings({"unused","rawtypes"})
        ArrayList list = new ArrayList();
    }
}

跟踪代码依赖性，实现替换配置文件功能

Servlet3.0提供了注解，使得不再需要在Web.xml文件中进行Servlet的部署。 @WebServlet("/login")

@WebServlet("/login")
public class LoginServlet extends HttpServlet {
    protected void doGet(){}
    protected void doPost(){}
}
//-------------------------------------------------
<servlet>
    <servlet-name>LoginServlet</servlet-name>
    <servlet-class>com.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>LoginServlet</servlet-name>
    <url-pattern>/login</url-pattern>
</servlet-mapping>

Spring框架中关于"事务"的管理 @Transactional()

（2.3）如何自定义注解

参照@SupperssWarnings定义
注解声明为： @interface
内部定义成员，通常使用value表示。
可以指定成员的默认值，使用default定义。
如果自定义注解没有成员，表明是一个标识作用。
如果注解有成员，在使用注解时，需要指明成员的值。
自定义注解必须配上注解的信息处理流程（使用反射）才有意义。

public @interface MyAnnotation {
    String value();
}

@MyAnnotation(value = "hi")
public class Person {
    private String name;
    private int age;
    // 省略getter setter 等代码
}

（2.4）JDK的元注解

JDK的元Annotation用于修饰其他Annotation定义
JDK5.0 提供了4个标准的meta-annotation类型，分别是：

Retention
Target
Documented
Inherited

（2.4.1）@Retention注解

@Retention用于修饰一个注释定义，指定该注解的声明周期，包含一个RetentionPolicy类型的成员变量。

描述注解保留的时间范围（即：被描述的注解在它所修饰的类中可以被保留到何时）。
Reteniton注解用来限定那些被它所注解的注解类在注解到其他类上以后，可被保留到何时。
一共有三种策略，定义在RetentionPolicy枚举中。使用@Retention时必须为该value成员变量指定值。

public enum RetentionPolicy { 
    SOURCE, // 在源文件中有效，源文件保留，编译器直接丢弃这种策略的注释 
    CLASS,  // 在class文件中有效，编译期保留，当运行Java程序时，JVM不会保留注释，默认值 
    RUNTIME // 在运行时有效，运行期保留，当运行Java程序时，JVM会保留注释。可通过反射去获取注解信息。 
}

（2.4.2）@Target注解

用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰哪些程序元素。包含一个名为value的成员变量。

取值（ElementType）		取值
CONSTRUCTOR	用于描述构造器	PACKAGE	用于描述包
FIELD	用于描述域	PARAMETER	用于描述参数
LOCAL_VARIABLE	用于描述局部变量	TYPE	用于描述类、接口（包括注解类型）或enum声明
METHOD	用于描述方法

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

（2.4.3）@Documented注解

描述在使用 javadoc 工具为类生成帮助文档时是否要保留其注解信息。默认是不包括的。
定义为Documented的注解必须设置Retention值为RUNTIME。

（2.4.4）@Inherited注解

被它修饰的注解具有继承性。如果某个类使用了被@Inherited修饰的注解，则其子类将自动具有该注解。
标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解。
实际应用中使用较少

（2.5）通过反射获取注解信息

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, CONSTRUCTOR, METHOD, PACKAGE, PARAMETER})
@Documented
public @interface MyAnnotation {
    String value();
}

@Test
    public void test1(){
        Class clazz = Person.class;
        Annotation[] annotations = clazz.getAnnotations();
        for(int i = 0; i< annotations.length; i++){
            System.out.println(annotations[i]);  // @MyAnnotation(value=hi)
        }
    }

（2.6）JDK8中注解新特性

（2.6.1）可重复注解

@MyAnnotation(value = "hi")
@MyAnnotation(value = "abc") 
public class Person {
    ......
}

在类上，使用重复注解报错

Duplicate annotation. The declaration of 'MyAnnotation' does not have a valid java.lang.annotation.Repeatable annotation

方式一：

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

@MyAnnotations({@MyAnnotation(value = "hi"), @MyAnnotation(value = "abc")})
public class Person {
}

方式二：JDK8 可重复注解

在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class。
MyAnnotation的Target 和 Retention 和 MyAnnotations 要相同。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}
//---------------------------
@Inherited
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, CONSTRUCTOR, METHOD, PARAMETER, LOCAL_VARIABLE})
public @interface MyAnnotation {
    String value();
}

@MyAnnotation(value = "hi")
@MyAnnotation(value = "123")
//@MyAnnotations({@MyAnnotation(value = "hi"), @MyAnnotation(value = "abc")})
public class Person {}

（2.6.2）类型注解

JDK1.8之后，@Target的参数类型 ElementType枚举值多了两个：TYPE_PARAMETER，TYPE_USER。

ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）。
ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以使用在任何地方

@Inherited
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, CONSTRUCTOR, METHOD, PARAMETER, LOCAL_VARIABLE, TYPE_PARAMETER, TYPE_USE})
public @interface MyAnnotation {
    String value() default "hello";
}

public class MyAnnotationTest {
    public static void main(String[] args) {
        Generic generic = new Generic();
        generic.show();
    }
}

class Generic<@MyAnnotation T>{
    public void show() throws @MyAnnotation RuntimeExeception {
        ArrayList<@MyAnnotation String> list = new ArrayList<>();
        int num = (@MyAnnotation int) 10L;
        list.add("abc");
        list.add("def");
        System.out.println(list);
        System.out.println(num);
    }
}

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。