Java注解
注解概述
3、注解
3.1、注解，或者叫做注釋類型，英文單詞是：Annotation
疑問：注解到底是干啥的？？？？？？？？？
3.2、注解Annotation是一種引用數據類型。編譯之后也是生成xxx.class文件。
3.3、怎么自定義注解呢？語法格式？
[修飾符列表] @interface 注解類型名{
}
3.4、注解怎么使用，用在什么地方？
第一：注解使用時的語法格式是：
@注解類型名
第二：注解可以出現在類上、屬性上、方法上、變量上、形參等....
注解還可以出現在注解類型上。
3.5、JDK內置了哪些注解呢？
java.lang包下的注釋類型：
掌握：
Deprecated 用 @Deprecated 注釋的程序元素，表示該元素已過時。
不鼓勵程序員使用這樣的元素，通常是因為它很危險或存在更好的選擇。
掌握：
Override 表示一個方法聲明打算重寫超類中的另一個方法聲明。如果
修改了重寫的方法或者父類中沒有該方法，那么使用該注解就會在編譯階段報錯！
不用掌握：
SuppressWarnings 指示應該在注釋元素(以及包含在該注釋元素中的
所有程序元素)中取消顯示指定的編譯器警告。
3.6、元注解
什么是元注解？
用來標注“注解類型”的“注解”，稱為元注解。
常見的元注解有哪些？
Target
Retention
關于Target注解：
這是一個元注解，用來標注“注解類型”的“注解”
這個Target注解用來標注“被標注的注解”可以出現在哪些位置上。
@Target(ElementType.METHOD)：表示“被標注的注解”只能出現在方法上。
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, MODULE, PARAMETER, TYPE})
表示該注解可以出現在：
構造方法上
字段上
局部變量上
方法上
包上
模塊上
參數上
....
類上...
關于Retention注解：
這是一個元注解，用來標注“注解類型”的“注解”
這個Retention注解用來標注“被標注的注解”最終保存在哪里。
@Retention(RetentionPolicy.SOURCE)：表示該注解只被保留在java源文件中，編譯之后沒有這個注解。
@Retention(RetentionPolicy.CLASS)：表示該注解被保存在class文件中。
@Retention(RetentionPolicy.RUNTIME)：表示該注解被保存在class文件中，并且在運行時可以被反射機制所讀取。
3.7、Retention的源代碼
//元注解
public @interface Retention {
//屬性
RetentionPolicy value();
}
RetentionPolicy的源代碼：
public enum RetentionPolicy {
SOURCE,
CLASS,
RUNTIME
}
//@Retention(value=RetentionPolicy.RUNTIME)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation{}
3.8、Target的源代碼
3.9、注解在開發中有什么用呢？
需求：
假設有這樣一個注解，叫做：@Id
這個注解只能出現在類上面，當這個類上有這個注解的時候，
要求這個類中必須有一個int類型的id屬性。如果沒有這個屬性
就報異常。如果有這個屬性則正常執行！
4、JDK新特性
后續。。。。。。。
一、如何定義和使用注解？
自定義注解：
[修飾符列表] @interface 注解類型名{
}
//自定義注解
public @interface MyAnnotation {
}
使用注解：如果沒有使用 @Target 的話可以在任何位置上使用注解：
如：類 / 接口 / 枚舉 /注解 / 上。
屬性、方法、方法形參上。
@Target 是什么注解，有什么用，有哪些屬性值？
用來標注“被標注的注解”可以出現在哪些位置上。
ANNOTATION_TYPE：注釋類型聲明
CONSTRUCTOR：構造方法聲明
LOCAL_VARIABLE：局部變量聲明
TYPE：類、接口(包括注釋類型)或枚舉聲明
FIELD：字段聲明(包括枚舉常量)
METHOD：方法聲明
PARAMETER：參數聲明
PACKAGE：包聲明
@MyAnnotation //出現在類上
public class Person {
@MyAnnotation //出現在屬性上
private int no;
@MyAnnotation
private String name;
@MyAnnotation //出現在方法上
public Person() {
}
@MyAnnotation
public Person(@MyAnnotation int no, @MyAnnotation String name) { //出現在參數上
this.no = no;
this.name = name;
}
@MyAnnotation
public int getNo() {
return no;
}
@MyAnnotation
public void setNo(int no) {
this.no = no;
}
@MyAnnotation
public String getName() {
return name;
}
@MyAnnotation
public void setName(String name) {
this.name = name;
}
}
二、JDK lang包下的Override注解
Override注解的特點：
該注解只能注解方法。
該注解給是給編譯器參考的，和運行階段沒有關系。
凡是java中的方法帶有這個注解的，編譯器都會進行編譯檢查，如果這個方法不是重寫父類的方法，編譯器報錯。
/*
關于JDK lang包下的Override注解
源代碼：
public @interface Override {
}
標識性注解，給編譯器做參考的。
編譯器看到方法上有這個注解的時候，編譯器會自動檢查該方法是否重寫了父類的方法。
如果沒有重寫，報錯。
這個注解只是在編譯階段起作用，和運行期無關！
*/
// @Override這個注解只能注解方法。
// @Override這個注解是給編譯器參考的，和運行階段沒有關系。
// 凡是java中的方法帶有這個注解的，編譯器都會進行編譯檢查，如果這個方法不是重寫父類的方法，編譯器報錯。
//@Override
public class AnnotationTest02 {
//@Override
private int no;
@Override
public String toString() {
return "toString";
}
}
三、@Deprecated 表示當前元素已過時
@Deprecated 可以用在類上、方法上、屬性上...表示當前元素已經過時。
@Deprecated 用在類上表示該類已經過時。
@Reprecated 用在方法上表示該方法已經過時。
@Reprecated 用在字段上表示該字段已經過時。
// 表示這個類已過時。
@Deprecated
public class AnnotationTest03 {
@Deprecated
private String s;
public static void main(String[] args) {
AnnotationTest03 at = new AnnotationTest03();
at.doSome();
}
@Deprecated
public void doSome(){
System.out.println("do something!");
}
// Deprecated這個注解標注的元素已過時。
// 這個注解主要是向其它程序員傳達一個信息，告知已過時，有更好的解決方案存在。
@Deprecated
public static void doOther(){
System.out.println("do other...");
}
}
class T {
public static void main(String[] args) {
AnnotationTest03 at = new AnnotationTest03();
at.doSome();
AnnotationTest03.doOther();
try {
Class c = Class.forName("java.util.Date");
Object obj = c.newInstance();
} catch (Exception e) {
e.printStackTrace();
}
}
}
四、注解中定義屬性
重要結論：如果一個注解當中有屬性，那么必須給屬性賦值。(除非該屬性使用default指定了默認值)
@MyAnnotation(屬性名=屬性值,屬性名=屬性值,屬性名=屬性值)
MyAnnotation注解：
public @interface MyAnnotation {
/**
* 我們通常在注解當中可以定義屬性，以下這個是MyAnnotation的name屬性。
* 看著像1個方法，但實際上我們稱之為屬性name。
* @return
*/
String name();
/*
顏色屬性
*/
String color();
/*
年齡屬性
*/
int age() default 25; //屬性指定默認值
}
MyAnnotationTest：測試
public class MyAnnotationTest {
// 報錯的原因：如果一個注解當中有屬性，那么必須給屬性賦值。(除非該屬性使用default指定了默認值。)
/*@MyAnnotation
public void doSome(){
}*/
//@MyAnnotation(屬性名=屬性值,屬性名=屬性值,屬性名=屬性值)
//指定name屬性的值就好了。
@MyAnnotation(name = "zhangsan", color = "紅色")
public void doSome(){
}
}
五、注解中屬性只有value時可以省略
如果一個注解的屬性的名字是value，并且只有一個屬性的話，在使用的時候，該屬性名可以省略。
注意：只有是屬性名是value的時候才可以，如果是name，哪怕該注解只有這一個屬性，也不可能省略。
public @interface MyAnnotation {
/*
指定一個value屬性。
*/
String value();
//String email();//在這要是再有個email，那value屬性名就不能省略了。
}
/*
如果一個注解的屬性的名字是value，并且只有一個屬性的話，在使用的時候，該屬性名可以省略。
*/
public class MyAnnotationTest {
// 報錯原因：沒有指定屬性的值。
/*@MyAnnotation
public void doSome(){
}*/
@MyAnnotation(value = "hehe")
public void doSome(){
}
@MyAnnotation("haha")//value可以省略
public void doOther(){
}
}
六、注解當中屬性的種類
注解當中的屬性可以是哪一種類型？
屬性的類型可以是：byte short int long float double boolean char String Class 枚舉類型
以及以上每一種的數組形式。
public @interface MyAnnotation {
int value1();
String value2();
int[] value3();
String[] value4();
Season value5();
Season[] value6();
Class parameterType();
Class[] parameterTypes();
}
在使用注解給屬性賦值時，數組形式用｛屬性值，屬性值，屬性值...｝
在使用注解給屬性賦值時，數組形式也可用｛枚舉值，枚舉值，枚舉值...｝
public class OtherAnnotationTest {
// 數組是大括號
@OtherAnnotation(age = 25, email = {"zhangsan@123.com", "zhangsan@sohu.com"}, seasonArray = Season.WINTER)
public void doSome(){
}
// 如果數組中只有1個元素：大括號可以省略。
@OtherAnnotation(age = 25, email = "zhangsan@123.com", seasonArray = {Season.SPRING, Season.SUMMER})
public void doOther(){
}
}
七、通過反射獲取注解對象屬性的值
示例1:獲得類上注解的屬性的值
注解類：MyAnnotation
注意：如果想通過反射獲取注解相關的內容。
則元注解 @Retention 的值必須是 @Retention(RetentionPolicy.RUNTIME)
否者反射獲取不到，會報錯！
//只允許該注解可以標注類、方法
@Target({ElementType.TYPE, ElementType.METHOD})
// 希望這個注解可以被反射
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
/*
value屬性,有默認值。
*/
String value() default "北京大興區";
}
測試類：MyAnnotationTest
@MyAnnotation("上海浦東區")
public class MyAnnotationTest {
//@MyAnnotation//編譯報錯
int i;
//@MyAnnotation，編譯報錯，不能用在構造方法上
public MyAnnotationTest(){
}
@MyAnnotation
public void doSome(){
//@MyAnnotation//編譯報錯
int i;
}
}
通過反射獲取注解對象屬性的值：ReflectAnnotationTest
public class ReflectAnnotationTest {
public static void main(String[] args) throws Exception{
// 獲取這個類
Class c = Class.forName("com.example.java.annotation5.MyAnnotationTest");
// 判斷類上面是否有@MyAnnotation
//System.out.println(c.isAnnotationPresent(MyAnnotation.class)); // true
if(c.isAnnotationPresent(MyAnnotation.class)){
// 獲取該注解對象
MyAnnotation myAnnotation = (MyAnnotation)c.getAnnotation(MyAnnotation.class);
//System.out.println("類上面的注解對象" + myAnnotation); // @com.bjpowernode.java.annotation5.MyAnnotation()
// 獲取注解對象的屬性怎么辦？和調接口沒區別。
String value = myAnnotation.value();
System.out.println(value);
}
// 判斷String類上面是否存在這個注解
Class stringClass = Class.forName("java.lang.String");
System.out.println(stringClass.isAnnotationPresent(MyAnnotation.class)); // false
}
}
示例2：獲得方法上注解上屬性的值
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
/*
username屬性
*/
String username();
/*
password屬性
*/
String password();
}
public class MyAnnotationTest {
@MyAnnotation(username = "admin", password = "456456")
public void doSome(){
}
public static void main(String[] args) throws Exception{
// 獲取MyAnnotationTest的doSome()方法上面的注解信息。
Class c = Class.forName("com.bjpowernode.java.annotation6.MyAnnotationTest");
// 獲取doSome()方法
Method doSomeMethod = c.getDeclaredMethod("doSome");
// 判斷該方法上是否存在這個注解
if(doSomeMethod.isAnnotationPresent(MyAnnotation.class)) {
MyAnnotation myAnnotation = doSomeMethod.getAnnotation(MyAnnotation.class);
System.out.println(myAnnotation.username());//admin
System.out.println(myAnnotation.password());//456456
}
}
}
八、案例：注解在開發中有什么用？
需求：
假設有這樣一個注解，叫做：@MustHasIdPropertyAnnotation
這個注解只能出現在類上面，當這個類上有這個注解的時候，
要求這個類中必須有一個int類型的id屬性。如果沒有這個屬性
就報異常。如果有這個屬性則正常執行！
首先定義一個注解：
// 表示這個注解只能出現在類上面
@Target(ElementType.TYPE)
// 該注解可以被反射機制讀取到
@Retention(RetentionPolicy.RUNTIME)
public @interface MustHasIdPropertyAnnotation {
}
// 這個注解@Id用來標注類，被標注的類中必須有一個int類型的id屬性，沒有就報異常。
然后自定義一個異常類，在沒有這個id屬性顯示異常信息:
//自定義異常類
public class HasNotIdPropertyException extends RuntimeException {
public HasNotIdPropertyException(){
}
public HasNotIdPropertyException(String s){
super(s);
}
}
使用注解的類：
@MustHasIdPropertyAnnotation
public class User {
int id;
String name;
String password;
}
測試類：
實現步驟：
獲得使用注解的類的字節碼文件：Class userClass = Class.forName("com.example.java.annotation7.User");
判斷類上是否存在 Id 注解。if(userClass.isAnnotationPresent(MustHasIdPropertyAnnotation.class)){}
存在id注解，判斷有沒有id字段，如果有id字段且類型是int型。
Field[] fields = userClass.getDeclaredFields();
boolean isOk = false; // 給一個默認的標記
for(Field field : fields){
if("id".equals(field.getName()) && "int".equals(field.getType().getSimpleName())){
// 表示這個類是合法的類。有@Id注解，則這個類中必須有int類型的id
isOk = true; // 表示合法
break;
}
}
Id 注解或者沒有id字段或者類型不是int型。
// 判斷是否合法
if(!isOk){
throw new HasNotIdPropertyException("被@MustHasIdPropertyAnnotation注解標注的類中必須要有一個int類型的id屬性！");
}
完整代碼：
public class Test {
public static void main(String[] args) throws Exception{
// 獲取類
Class userClass = Class.forName("com.example.java.annotation7.User");
// 判斷類上是否存在Id注解
if(userClass.isAnnotationPresent(MustHasIdPropertyAnnotation.class)){
// 當一個類上面有@MustHasIdPropertyAnnotation注解的時候，要求類中必須存在int類型的id屬性
// 如果沒有int類型的id屬性則報異常。
// 獲取類的屬性
Field[] fields = userClass.getDeclaredFields();
boolean isOk = false; // 給一個默認的標記
for(Field field : fields){
if("id".equals(field.getName()) && "int".equals(field.getType().getSimpleName())){
// 表示這個類是合法的類。有@Id注解，則這個類中必須有int類型的id
isOk = true; // 表示合法
break;
}
}
// 判斷是否合法
if(!isOk){
throw new HasNotIdPropertyException("被@MustHasIdPropertyAnnotation注解標注的類中必須要有一個int類型的id屬性！");
}
}
}
}
