用大白話聊聊JavaSE -- 自定義注解入門


注解在JavaSE中算是比較高級的一種用法了,為什么要學習注解,我想大概有以下幾個原因:

1. 可以更深層次地學習Java,理解Java的思想.

2. 有了注解的基礎,能夠方便閱讀各種框架的源碼,比如hibernate,SpringMVC等等。里面就用到了大量的注解。即便無法閱讀源碼,以后使用這些框架,會有一種心理上的安全感

3. 方便今后跟別人吹牛。(當然,這也很重要。)

好了,話不多說,我們開始吧。

1. 從注釋的角度來理解注解

我想了很久,最終決定以這個小標題作為第一節的標題,我們在編寫Java代碼的時候,為了讓我們的代碼看起來通俗易懂,就會加上注釋信息。

比如,我們寫一個方法,會標注上這個方法的作者,作用,版本等信息。是的,作為一個程序員,編寫優雅的注釋是一個非常重要的好習慣。

例:

/**
 * 用於判斷是否是空字符串
 * 方法名:isEmpty
 * 創建人:剽悍一小兔
 * 時間:2016年9月21日-下午6:56:33
 * @param str
 * @return boolean
 */
public static boolean isEmpty(String str) {
    return null == str  || str.equals("")
            || str.matches("\\s*");
}

這是一個字符串判空的函數,函數名為isEmpty,雖然看名字大概也能猜到它的作用,可是,一旦加上了注釋,瞬間就變得更加清晰了,不是嗎?

這種注釋,當代碼被執行的時候,執行機制會自動忽略掉他們,因為這些文字其實是給程序員看的,而不是給執行機制看的。

寫注釋是一種美德。

那么,注解又是什么呢?

我個人對它的看法是:所謂的注解,就是寫給電腦看的高級注釋。

你可能經常會看到代碼里面出現@XXX的標志,乍一看感覺挺高深的。反正我當年就是這種感覺,頭腦里第一個反應就是這肯定很難!

我還是那句話,如果你總想着復雜,那么就永遠看不到簡單。

我們寫注釋,是給人看的,而注解就是寫給電腦看的。就這么簡單。

這么說可能有點抽象,沒關系,我們來一個快速入門吧。

2.提出問題

新建一個Java項目

Paste_Image.png

項目名稱就叫做Annotation吧
Paste_Image.png

在src旁邊右鍵,新建一個util包,也就是工具包。

Paste_Image.png

弄一個專門處理日期的工具類
Paste_Image.png

隨便寫一個日期格式化的方法。

package util;

import java.util.Date;
import java.text.SimpleDateFormat;

public class DateUtil {
	
	public static String formatDate( Date date , String formatPattern ){
		return new SimpleDateFormat(formatPattern).format(date);
	}
	
}

注意,導包的時候要是java.util.Date;,而不是java.sql.Date;

測試:

Date now = new Date();//獲取當前日期
System.out.println(now);
System.out.println(formatDate(now,"yyyy-MM-dd hh:mm:ss"));

控制台打印:
Wed Sep 21 19:24:57 CST 2016
2016-09-21 07:24:57

這說明,我們寫的方法應該是正確的。

很好,那么接下來要解決一個什么問題呢?就是說,如果我想通過代碼來獲取關於這個方法的信息,那么該如何做呢?

寫注釋肯定是不行的,因為注釋是寫個程序員看的,電腦看不懂,更別提獲取注釋的內容了,是吧?

於是,注解,這一種高級的注釋就出現了。

3.編寫注解

關於注解,要明確三個問題:

  1. 要給誰加注解啊?
  2. 什么時候注解起作用啊?
  3. 要注解那些東西呢?

因為是快速入門,所以大概知道這些就足夠了。

現在,我們來新建一個注解,毫無疑問,所謂的注解,它還是一個Java類,你不要被它嚇到。

新建一個注解包。
Paste_Image.png

new一個Annotation,就叫MethodNote,意思就是說,這個是加在方法上的,為了給方法加一些電腦能看得懂的說明。

Paste_Image.png

第一個問題是要給誰加注解啊?那么,這個注解類是需要加在方法上的,於是就這樣寫:

Paste_Image.png

這就表示,該注解要加在方法上。

接下來,讓我們來明確第二個問題:什么時候注解起作用啊?

我們希望在程序運行的時候,注解發揮作用,就是說,當你的程序跑起來了,電腦才開始閱讀這些注解。

Paste_Image.png

這句話的意思就是說,我這個注解啊,是在程序跑起來的時候,RUNTIME嘛,就是跑起來的時候,才發揮作用的。

非常好,那么最后一個問題:要注解那些東西呢?

一個方法,最重要的信息包括:作用,創建時間,作者,版本,返回值等等。我們隨便抽取幾個,就作用和創建時間吧!

Paste_Image.png

這種寫法有點類似於寫接口的方法。

好了,我們的第一個注解就編寫完成了!寫好了就馬上用唄,現在我們給日期格式化的方法加上咱自己編寫的注解。

@MethodNote(createTime = "2016-9-21")
public static String formatDate(Date date , String formatPattern){
	return new SimpleDateFormat(formatPattern).format(date);
}

這就是所謂的注解,其實也很簡單的吧。就是這么來的,它歸根到底還是一個Java類。

4.通過Java反射獲取方法的注解信息

好了,回到正題,我們已經對formatDate方法進行了注解,那么,既然這個注解是寫給電腦看的,那么電腦就肯定有辦法在其他Java類中獲得這些信息,對吧?

如何獲得呢,對了,用反射機制。

上代碼:

public static void main(String[] args) throws NoSuchMethodException, SecurityException {

	Class classOfDateUtil = DateUtil.class;
	Method formatDate = classOfDateUtil.getMethod("formatDate", Date.class,String.class);
	MethodNote methodNote = formatDate.getAnnotation(MethodNote.class);

	System.out.println("方法描述:" + methodNote.description());
	System.out.println("創建日期:" + methodNote.createTime());
}

結果:

方法描述:作者很懶,沒有寫本方法的作用。
創建日期:2016-9-21

本章結束 ...

本章對Java自定義注解做了一個快速入門,希望對你有所幫助。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM