Java註解的定義及使用介紹（程式碼範例）

這篇文章帶給大家的內容是關於Java註解的定義及使用介紹（程式碼範例），有一定的參考價值，有需要的朋友可以參考一下，希望對你有幫助。

Java的註解在實際專案中使用得非常的多，特別是在使用了Spring之後。

本文會介紹Java註解的語法，以及在Spring中使用註解的範例。

註解的語法

註解的例子

以Junit中的@Test註解為例

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
    long timeout() default 0L;
}

可以看到@Test註解上有@Target()和@Retention()兩個註解。
這種註解了註解的註解，稱為元註解。
跟聲明了數據的數據，稱為元數據是一種意思。

之後的註解的格式是

修饰符 @interface 注解名 {   
    注解元素的声明1 
    注解元素的声明2   
}

註解的元素宣告有兩種形式

type elementName();
type elementName() default value;  // 带默认值

常見的元註解

#@Target註解

@Target註解用於限制註解能在哪些項目上應用，沒有加上@Target的註解可以應用於任何項上。

在java.lang.annotation.ElementType類別中可以看到所有@Target接受的項目

• ##TYPE 在【類別、介面、註解】上使用

• #FIELD 在【欄位、列舉常數】上使用

• METHOD 在【方法】上使用

• #PARAMETER 在【參數】上使用

• CONSTRUCTOR 在【建構子】上使用

• LOCAL_VARIABLE 在【局部變數】上使用

• ANNOTATION_TYPE 在【註解】上使用

• PACKAGE 在【套件】上使用

• TYPE_PARAMETER 在【類型參數】上使用Java 1.8 引入

• TYPE_USE 在【任何宣告類型的地方】上使用Java 1.8 引入

@Test註解只允許在方法上使用。

@Target(ElementType.METHOD)
public @interface Test { ... }

如果要支援多項，則傳入多個值。

@Target({ElementType.TYPE, ElementType.METHOD})
public @interface MyAnnotation { ... }

此外元註解也是註解，也符合註解的語法，如

@Target註解。
@Target(ElementType.ANNOTATION_TYPE)顯示@Target註解只能使用在註解上。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    ElementType[] value();
}

@Retention註解

@Retention指定註解應該保留多長時間，預設為RetentionPolicy.CLASS。 在
java.lang.annotation.RetentionPolicy可看到所有的項目

• SOURCE 不包含在類別檔案中

• CLASS 包含在類別檔案中，不載入虛擬機器

• RUNTIME  包含在類檔案中，由虛擬機載入，可以用反射API取得

@Test註解會載入到虛擬機，可以透過程式碼取得

@Retention(RetentionPolicy.RUNTIME)
public @interface Test { ... }

@Documented註解

主要用於歸檔工具辨識。被註解的元素能被

Javadoc或類似的工具文檔化。

@Inherited註解

加入了

@Inherited註解的註解，所註解的類別的子類別也將擁有這個註解

註解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyAnnotation { ... }

父類別

@MyAnnotation 
class Parent { ... }

子類別

Child會加在Parent上的@MyAnnotation繼承下來

class Child extends Parent { ... }

@Repeatable註解

Java 1.8 引入的註解，標識註解是可重複使用的。

註解1

public @interface MyAnnotations {   
    MyAnnotation[] value();   
}

註解2

@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {   
    int value();
}

有使用

@Repeatable()時的使用

@MyAnnotation(1)
@MyAnnotation(2)
@MyAnnotation(3)
public class MyTest { ... }

沒使用

@Repeatable()時的使用，@MyAnnotation去掉@Repeatable元註解

@MyAnnotations({
    @MyAnnotation(1), 
    @MyAnnotation(2),
    @MyAnnotation(3)})
public class MyTest { ... }

這個註解還是很有用的，讓我們的程式碼變得簡潔不少，

Spring的@ComponentScan註解也用到這個元註解。

元素的型別

支援的元素型別

• #8種基本資料型別（

  byte，short，char，int，long，float，double，boolean

#' )

String

####enum###############註解類型#############陣列（所有上邊類型的陣列）######## ####範例######枚舉類別###

public enum Status {
    GOOD,
    BAD
}

###註解1###

@Target(ElementType.ANNOTATION_TYPE)
public @interface MyAnnotation1 {
    int val();
}

###註解2###

@Target(ElementType.TYPE)
public @interface MyAnnotation2 {
    
    boolean boo() default false;
    
    Class<?> cla() default Void.class;
    
    Status enu() default Status.GOOD;
    
    MyAnnotation1 anno() default @MyAnnotation1(val = 1);
    
    String[] arr();
    
}

###使用時，無預設值的元素必須傳值###

@MyAnnotation2(
        cla = String.class,
        enu = Status.BAD,
        anno = @MyAnnotation1(val = 2),
        arr = {"a", "b"})
public class MyTest { ... }

######Java###內建的註解#########@Override###註解######告訴編譯器這個是個覆寫父類別的方法。如果父類別刪除了該方法，則子類別會報錯。 #########@Deprecated###註解######表示被註解的元素已被棄用。 #########@SuppressWarnings###註解######告訴編譯器忽略警告。 #########@FunctionalInterface###註解######Java 1.8 所引入的註解。此註解會強制編譯器###javac###檢查一個介面是否符合函數介面的標準。 ###

特别的注解

有两种比较特别的注解

• 标记注解 ： 注解中没有任何元素，使用时直接是 @XxxAnnotation, 不需要加括号

• 单值注解 ： 注解只有一个元素，且名字为value，使用时直接传值，不需要指定元素名@XxxAnnotation(100)

利用反射获取注解

Java的AnnotatedElement接口中有getAnnotation()等获取注解的方法。
而Method，Field，Class，Package等类均实现了这个接口，因此均有获取注解的能力。

例子

注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
public @interface MyAnno {   
    String value();   
}

被注解的元素

@MyAnno("class")
public class MyClass {
    
    @MyAnno("feild")
    private String str;
    
    @MyAnno("method")
    public void method() { }
    
}

获取注解

public class Test {
    
    public static void main(String[] args) throws Exception {
    
        MyClass obj = new MyClass();
        Class<?> clazz = obj.getClass();
        
        // 获取对象上的注解
        MyAnno anno = clazz.getAnnotation(MyAnno.class);
        System.out.println(anno.value());
        
        // 获取属性上的注解
        Field field = clazz.getDeclaredField("str");
        anno = field.getAnnotation(MyAnno.class);
        System.out.println(anno.value());
        
        // 获取方法上的注解
        Method method = clazz.getMethod("method");
        anno = method.getAnnotation(MyAnno.class);
        System.out.println(anno.value());
    }
    
}

在Spring中使用自定义注解

注解本身不会有任何的作用，需要有其他代码或工具的支持才有用。

需求

设想现有这样的需求，程序需要接收不同的命令CMD，
然后根据命令调用不同的处理类Handler。
很容易就会想到用Map来存储命令和处理类的映射关系。

由于项目可能是多个成员共同开发，不同成员实现各自负责的命令的处理逻辑。
因此希望开发成员只关注Handler的实现，不需要主动去Map中注册CMD和Handler的映射。

最终效果

最终希望看到效果是这样的

@CmdMapping(Cmd.LOGIN)
public class LoginHandler implements ICmdHandler {
    @Override
    public void handle() {
        System.out.println("handle login request");
    }
}

@CmdMapping(Cmd.LOGOUT)
public class LogoutHandler implements ICmdHandler {
    @Override
    public void handle() {
        System.out.println("handle logout request");
    }
}

开发人员增加自己的Handler，只需要创建新的类并注上@CmdMapping(Cmd.Xxx)即可。

具体做法

具体的实现是使用Spring和一个自定义的注解
定义@CmdMapping注解

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Component
public @interface CmdMapping {
    int value();   
}

@CmdMapping中有一个int类型的元素value，用于指定CMD。这里做成一个单值注解。
这里还加了Spring的@Component注解，因此注解了@CmdMapping的类也会被Spring创建实例。

然后是CMD接口，存储命令。

public interface Cmd {
    int REGISTER = 1;
    int LOGIN    = 2;
    int LOGOUT   = 3;
}

之后是处理类接口，现实情况接口会复杂得多，这里简化了。

public interface ICmdHandler { 
    void handle();   
}

上边说过，注解本身是不起作用的，需要其他的支持。下边就是让注解生效的部分了。
使用时调用handle()方法即可。

@Component
public class HandlerDispatcherServlet implements 
    InitializingBean, ApplicationContextAware {

    private ApplicationContext context;

    private Map<Integer, ICmdHandler> handlers = new HashMap<>();
    
    public void handle(int cmd) {
        handlers.get(cmd).handle();
    }
    
    public void afterPropertiesSet() {
        
        String[] beanNames = this.context.getBeanNamesForType(Object.class);

        for (String beanName : beanNames) {
            
            if (ScopedProxyUtils.isScopedTarget(beanName)) {
                continue;
            }
            
            Class<?> beanType = this.context.getType(beanName);
            
            if (beanType != null) {
                
                CmdMapping annotation = AnnotatedElementUtils.findMergedAnnotation(
                        beanType, CmdMapping.class);
                
                if(annotation != null) {
                    handlers.put(annotation.value(), (ICmdHandler) context.getBean(beanType));
                }
            }
        }
        
    }

    public void setApplicationContext(ApplicationContext applicationContext)
            throws BeansException {   
        this.context = applicationContext;
    }

}

主要工作都是Spring做，这里只是将实例化后的对象put到Map中。

测试代码

@ComponentScan("pers.custom.annotation")
public class Main {

    public static void main(String[] args) {
        
        AnnotationConfigApplicationContext context 
            = new AnnotationConfigApplicationContext(Main.class);
            
        HandlerDispatcherServlet servlet = context.getBean(HandlerDispatcherServlet.class);
        
        servlet.handle(Cmd.REGISTER);
        servlet.handle(Cmd.LOGIN);
        servlet.handle(Cmd.LOGOUT);

        context.close();
    }
}

> 完整项目

总结

可以看到使用注解能够写出很灵活的代码，注解也特别适合做为使用框架的一种方式。
所以学会使用注解还是很有用的，毕竟这对于上手框架或实现自己的框架都是非常重要的知识。

以上是Java註解的定義及使用介紹（程式碼範例）的詳細內容。更多資訊請關注PHP中文網其他相關文章！