摘要:引言在用的時候發現能自動生成,同時帶有一些注解,這引起了我的好奇。注解來源于之類的其他語言。關閉不當的編譯器警告。允許子類繼承父類中的注解。五通過注解反射生成語句接下來,我用一個例子來解釋注解的作用。
引言
在用hibernate的時候發現idea能自動生成JavaBean,同時帶有一些注解,這引起了我的好奇。當在學習Android的時候,我發現XUtils這個工具包中的DBUtils也能夠使用類似hibernate的注解。于是乎在java編程思想中找了找有關注解的用法。
一 注解定義注解(也稱為元數據)為我們在代碼中添加信息提供了一種形式化的方法,使我們可以在稍后某個時刻非常方便的使用這些數據。注解來源于C#之類的其他語言。
注解的語法比較簡單,除了@符號外,它與java的固有語法一致。javaSE5中內置了三種注解:
二 基本語法@Override:定義覆蓋超類,當覆寫對應不上被覆蓋的方法,編譯器發出錯誤提示。
@Deprecated:當使用了該注解,即表示這個方法已經不推薦被使用。
@SuppressWarnings:關閉不當的編譯器警告。
我們使用自定義的注解對一個方法進行注解:
public class Testable{ public void execute() { System.out.println("execute..."); } @WETest void taskStart() { execute(); } }
在上邊的代碼中,我們對taskStart方法使用了注解,接下來我們對WETest注解進行定義:
import java.lang.annotation.*; @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface WETest{}三 定義注解
我們給上邊的注解添加一些內容:
import java.lang.annotation.*; @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface WETest{ public int id(); public String Notes() default "there is no Notes"; }
同樣,我們對Testable類使用最新的注解:
public class Testable{ @WETest(id=666) public void execute() { System.out.println("execute..."); } @WETest(id=666,Notes="this is a method") void taskStart() { execute(); } }
注解就是這么使用的,當注解內容沒有填寫時,他會使用默認的值,如execute方法,他沒有定義Notes,那么Notes默認值為"there is no Notes"。
四 元注解我們看到注解上邊有兩行內容,它們是元注解,專門對注解的解釋。元注解一共有四種,分別是:
五 通過注解反射生成SQL語句@Target:表示該注解可以用到哪些地方,ElementType,CONSTRUCTOR構造器聲明,FIELD域聲明(包括enum實例),LOCAL_VARIABLE局部變量聲明,METHOD方法,PACKAGE包,PARAMETER參數,TYPE類、接口或enum。
@Retention:表示需要在什么級別上使用,RetentionPolicy,SOURCE注解會被編譯器丟掉,CLASS在class文件中可用會被VM拋棄,RUNTIME在VM運行期也會保留可以通過反射獲取注解信息。
@Documented:將注解包含在Javadoc中。
@Inherited:允許子類繼承父類中的注解。
接下來,我用一個例子來解釋注解的作用。先編寫一些注解定義:
//DBTable.java 用來生成數據表 package annotations; 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 DBTable { public String name() default ""; } //Constraints.java 用來定義約束項 package annotations; 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 Constraints { boolean primarykey() default false; boolean allownull() default true; } //PrimaryKey.java 將Constraints中的primarykey定義為真,表示為主鍵 package annotations; import java.lang.annotation.*; @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface PrimaryKey { Constraints constraints() default @Constraints(primarykey = true); } //SQLInteger.java 定義列的類型 package annotations; import java.lang.annotation.*; @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface SQLInteger { String name() default ""; Constraints constraints() default @Constraints; } //SQLString.java 定義列的類型 package annotations; import java.lang.annotation.*; @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface SQLString { int value() default 64; String name() default ""; Constraints constraints() default @Constraints; } 接下來寫一個javabean,使用上述注解: //User.java import annotations.Constraints; import annotations.DBTable; import annotations.SQLInteger; import annotations.SQLString; @DBTable(name="user") public class User { @SQLInteger(name="id",constraints = @Constraints(primarykey=true)) public Integer id; @SQLString(value=30) public String name; @SQLString(name="passwd",constraints=@Constraints(allownull=false)) public String password; /*可以不用 public void setId(Integer id) { this.id = id; } public void setName(String name) { this.name = name; } public void setPassword(String password) { this.password = password; } public Integer getId() { return id; } public String getName() { return name; } public String getPassword() { return password; }*/ }
我們看到注解中可以使用注解,在SQLInteger中我們使用了Constraints注解。
接下來我們寫一個注解處理器:
//Test.java import java.lang.annotation.Annotation; import java.lang.reflect.Field; import java.util.ArrayList; import java.util.List; import java.util.Scanner; import annotations.Constraints; import annotations.DBTable; import annotations.SQLInteger; import annotations.SQLString; public class Test { public static String getConstraints(Constraints con) { String constraints = ""; if(!con.allownull()) { constraints +=" NOT NULL"; } if(con.primarykey()) { constraints += " PRIMARY KEY"; } return constraints; } public static void main(String[] args) throws ClassNotFoundException { Scanner s = new Scanner(System.in); String name = s.next(); //從控制臺輸入一個類名,我們輸入User即可 Class> cl = Class.forName(name); //加載類,如果該類不在默認路徑底下,會報 java.lang.ClassNotFoundException DBTable dbTable = cl.getAnnotation(DBTable.class); //從User類中獲取DBTable注解 if(dbTable == null){ //如果沒有DBTable注解,則直接返回,我們寫了,當然有 return; } String tableName = (dbTable.name().length()<1)?cl.getName():dbTable.name();//獲取表的名字,如果沒有在DBTable中定義,則獲取類名作為Table的名字 ListcolumnDefs = new ArrayList (); for(Field field : cl.getDeclaredFields()) //獲取聲明的屬性 { String columnName = null; Annotation[] anns = field.getDeclaredAnnotations();//獲取注解,一個屬性可以有多個注解,所以是數組類型 if(anns.length < 1) { continue; } if(anns[0] instanceof SQLInteger) //判斷注解類型 { SQLInteger sInt = (SQLInteger)anns[0]; columnName = (sInt.name().length()<1)?field.getName():sInt.name();//獲取列名稱與獲取表名一樣 columnDefs.add(columnName+" INT"+getConstraints(sInt.constraints()));//使用一個方法,自己寫的getConstraints(Constraints constraints)獲取列定義 } if(anns[0] instanceof SQLString) { SQLString sStr = (SQLString)anns[0]; columnName = (sStr.name().length()<1)?field.getName().toUpperCase():sStr.name(); columnDefs.add(columnName + " VARCHAR("+sStr.value()+")"+getConstraints(sStr.constraints())); } } StringBuilder createCommand = new StringBuilder("CREATE TABLE "+tableName+"("); for(String columnDef :columnDefs) { createCommand.append(" "+columnDef+","); } String tableCreate = createCommand.substring(0,createCommand.length()-1)+" );"; System.out.println(tableCreate); //打印出來 } }
我們可以采用上述方法動態的處理一些數據,例如創建數據表。
六 總結注意:注解不支持繼承例如 extends @xxx。 注解的default默認值不可以為null
使用注解可以減少對xml等外部文件的依賴,使得對類的定義可以在一處實現,避免了一個類兩處定義的麻煩。spring和hibernate就采用的這樣的方法。
更多文章:http://blog.gavinzh.com
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/64375.html
摘要:文章系列從零入門系列之從零入門系列之程序結構設計說明前言本篇文章開始代碼實踐,系統設計從底向上展開,因此本篇先介紹如何實現數據庫表實體類的設計實現。主鍵由數據庫自動生成主要是自動增長型主鍵由程序控制。 文章系列 【從零入門系列-0】Sprint Boot 之 Hello World 【從零入門系列-1】Sprint Boot 之 程序結構設計說明 前言 本篇文章開始代碼實踐,系統...
摘要:入門筆記簡介是一種基于的實現了設計模式的請求驅動類型的輕量級框架,是系開源項目中的一個,和配合使用。配置在中需要添加使用的和映射規則。入門較快,而掌握起來相對較難。 SpringMVC入門筆記 1. 簡介 Spring MVC是一種基于Java的實現了Web MVC設計模式的請求驅動類型的輕量級Web框架 ,是Spring系開源項目中的一個,和IoC配合使用。通過策略接口,Spring...
摘要:一定義是一款優秀的持久層框架,它支持定制化存儲過程以及高級映射。別名與類中的屬性名保持一致。接口的名字建議為,與文件保持一致編寫文件,名字與接口名保持一致。 一、定義 MyBatis 是一款優秀的持久層框架,它支持定制化 SQL、存儲過程以及高級映射。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設置參數以及獲取結果集。MyBatis 可以使用簡單的 XML 或注解來配置和映射...
閱讀 4021·2021-11-22 13:53
閱讀 3617·2021-11-19 11:29
閱讀 1265·2021-09-08 09:35
閱讀 3162·2020-12-03 17:26
閱讀 514·2019-08-29 16:06
閱讀 2106·2019-08-26 13:50
閱讀 1180·2019-08-23 18:32
閱讀 2153·2019-08-23 18:12