注解基本介紹

Annotation(注解)是JDK5.0及以后版本引入的。它可以用于創(chuàng)建文檔，跟蹤代碼中的依賴性，甚至執(zhí)行基本編譯時檢查。注解是以‘@注解名’在代碼中存在的，根據(jù)注解參數(shù)的個數(shù)，我們可以將注解分為：標(biāo)記注解、單值注解、完整注解三類。它們都不會直接影響到程序的語義，只是作為注解(標(biāo)識)存在，我們可以通過反射機(jī)制編程實(shí)現(xiàn)對這些元數(shù)據(jù)的訪問。另外，你可以在編譯時選擇代碼里的注解是否只存在于源代碼級，或者它也能在class文件中出現(xiàn)

注解定義

注解定義很簡單：

@Target(ElementType.PARAMETER)

public @interface Test {}

使用時以@Test方式標(biāo)記在方法體，類或參數(shù)上。Target(ElementType.PARA

METER)可以定義注解的標(biāo)記類型。

常用 SPRING注解

1.@Controller

@Controller注解將一個類標(biāo)明為用來接收HTTP請求控制器

2.@RequesMapping

@RequestMapping注解將特定的URL和具體的控制器類或控制類類中的方法綁定

3.@PathVariable

添加@PathVariable注解，可以直接在方法中使用請求URI中的值。

4.@Repository

用于將數(shù)據(jù)訪問層(DAO層) 的類標(biāo)識為Spring Bean。具體只需將該注解標(biāo)注

在 DAO類上即可。同時，為了讓Spring能夠掃描類路徑中的類并識別出

@Repository注解，需要在XML配置文件中啟用Bean的自動掃描功能，這可

以通過

package=”bookstore.dao”/>? ?如此，我們就不再需要在XML中顯式使用

進(jìn)行 Bean 的配置。Spring在容器初始化時將自動掃描base-package

指定的包及其子包下的所有class文件，所有標(biāo)注了@Repository的類都將被冊

為 SpringBean。

控制層使用的注解介紹

作用：參數(shù)注解。

com.sgcc.uap.rest.annotation.ColumnRequestParam

請求體是{columns:["id","name"]}的形式，指明方法的參數(shù)是從請求體中獲取的字符串?dāng)?shù)組。

用于在獲取元數(shù)據(jù)信息時，從請求體獲取顯示的列，并將列名封裝為字符串?dāng)?shù)組。

例如：請求參數(shù)為params={“columns”:[“id”,“name”,“sex”]}，返回?cái)?shù)據(jù)為：String[]{“id”,“name”,“sex”}

使用示例：@RequestMapping("/meta")

public @ColumnResponseBodyListgetMetaData(

@ColumnRequestParam("params")String[] columns) {

…………

}

作用：方法體注解，對返回值進(jìn)行攔截。

攔截List類型的返回值，將返回值解析為JSON格式字符串,如：

{“columns”:[{“name”:”id”,”caption”:”編號”,”length”:32},{},{},…]}

com.sgcc.uap.rest.annotation.ColumnResponseBody

響應(yīng)體是{columns:[{},{},{}……]}的形式，指明將方法返回值轉(zhuǎn)化為JSON格式列信息,

將返回的對象轉(zhuǎn)換為json串。

返回對象為ViewAttributeData，

返回?cái)?shù)據(jù)格式為:

{"columns":[{"name":"id","caption":"ID",nullable:false,dataType:"string"},...]}

3. @IdRequestBody:

作用：參數(shù)注解。

攔截請求體為{params:{primaryKey: ”EMP_ID” ,? ids:[”001”, “002”,……] }}格式的數(shù)據(jù)，將此數(shù)據(jù)轉(zhuǎn)換為字符串?dāng)?shù)組。如

[“0001”,”0002”]。

com.sgcc.uap.rest.annotation.IdRequestBody

指明方法的參數(shù)是從請求體中獲取的字符串?dāng)?shù)組 ，并將主鍵信息封裝為IDRequestObject對象。通過getPrimarykey()和getIds()取出主鍵名稱和主鍵值

例如：用于刪除操作從請求體中獲取主鍵

public @VoidResponseBody

Object delete(@IdRequestBodyIDRequestObjectid) {

。。。。。。

}

4. @ItemRequestParam:

作用：參數(shù)注解。

com.sgcc.uap.rest.annotation.ItemRequestParam

攔截請求數(shù)據(jù){“itemType”:”school”}，將數(shù)據(jù)的itemType解析，返回字符串。例如返回：school。

該注解用于在樹場景中取出節(jié)點(diǎn)的itemType。使用示例:

public @TreeResponseBody

ListgetNodes(@PathVariableString id,

@ItemRequestParam("params")StringitemType){

。。。。。。

}

5. @ItemsRequestBody:

作用：參數(shù)注解。

com.sgcc.uap.rest.annotation.ItemsRequestBody

攔截請求體的數(shù)據(jù)格式：

{“items”:[{“id”:”01”,”name”:”n1”},{},{},…]}和{“parentID”:”0003329281”,“items”:[{“id”:”01”,”name”:”n1”},{},{},…]}

將數(shù)據(jù)轉(zhuǎn)化為List格式，list中map封裝一個item數(shù)據(jù)

使用示例：用于保存場景，將請求體中的記錄封裝為到list中。

public @ItemResponseBody

ListsaveSchool(@ItemsRequestBodyListlist) {

。。。。

}

6. @ItemsResponseBody：

作用：方法體注解。

攔截返回?cái)?shù)據(jù)。將返回的list集合轉(zhuǎn)化為json字符串。

{“items”:[{“id”:”01”,”name”:”n1”},{},{},…] ,itemCount:100}

com.sgcc.uap.rest.annotation.ItemResponseBody

攔截返回?cái)?shù)據(jù)。將返回的list集合轉(zhuǎn)化為json字符串。指明返回值將以

{items:[{}{}{}{}]}的形式返回。使用示例：

public @ItemResponseBody

QueryResultObjectquery(@QueryRequestParam("params")

RequestConditionparams){

。。。。。

}

7. @QueryRequestParam:

作用：參數(shù)注解。

com.sgcc.uap.rest.annotation.QueryRequestParam

GET請求中從url中通過指定KEY值將參數(shù)取出，用于查詢條件。

QueryRequestParam("params"),將url中的{"params":{"filter":"name??='eqe'&sex='female'","orderStr":"age","columns":"id,name,age,sex"}}轉(zhuǎn)換為RequestCondition對象。使用實(shí)例：

public @ItemResponseBody

QueryResultObjectquery(@QueryRequestParam("params")RequestCondition

params){

。。。。。

}

8. @QueryRequestParam:

作用：參數(shù)注解。

com.sgcc.uap.rest.annotation.QueryRequestParam

GET請求中從url中通過指定KEY值將參數(shù)取出，用于查詢條件。

QueryRequestParam("params"),將url中的{"params":{"filter":"name??='eqe'&sex='female'","orderStr":"age","columns":"id,name,age,sex"}}轉(zhuǎn)換為RequestCondition對象。使用實(shí)例：

public @ItemResponseBody

QueryResultObjectquery(@QueryRequestParam("params")RequestCondition

params){

。。。。。

}

9. @RawResponseBody:

作用：方法體注解。

攔截返回值，對于字符串類型的返回值可以原樣輸出。

對于List或?qū)ο箢愋偷姆祷刂缔D(zhuǎn)換為響應(yīng)的json字符串輸出。方便用戶封裝自定義的格式。

com.sgcc.uap.rest.annotation.RawResponseBody

指明方法的返回值應(yīng)當(dāng)以原生返回值的形式，綁定到響應(yīng)體中 ，使用該注解的方法應(yīng)當(dāng)返回object。

使用示例：將方法中返回的字符串原樣輸出，用于自己拼裝返回的格式，不用平臺的json轉(zhuǎn)換。

public @RawResponseBodyObject test(){

return"welcome!";

}

示例中的方法將字符串”welcome!”原樣返回。

11. @VoidResponseBody：

作用：將空返回值包裝為通用的返回格式。

com.sgcc.uap.rest.annotation.VoidResponseBody

用于沒有特定返回值得方法注解，將對象轉(zhuǎn)換為統(tǒng)一的json串。如：

{

"successful":true,??? ————方法是否調(diào)用成功

"resultHint":"",?????————異常信息

"resultValue":?“”???————數(shù)據(jù)信息是空的

}

例如：刪除操作

public @VoidResponseBody

Object delete(@IdRequestBodyIDRequestObjectid) {

。。。。

}

Hibernate實(shí)體映射注解支持

平臺已經(jīng)引入了hibernate的注解功能，具體用法與hibernate注解映射相同，

詳細(xì)用法可參考Hibernate注解映射相關(guān)文檔。

@Entity

@Table(name= "O_ORG")

publicclass?ORG implementsjava.io.Serializable{

@Id

@GenericGenerator(name="ORG_ID",strategy="uuid")

@GeneratedValue(generator="ORG_ID")

@Column(name="ORG_ID")

public String?getId() {

return this.id;

}

public void?setId(Stringid) {

this.id = id;

}

}

總結(jié)

以上是生活随笔為你收集整理的sg-uap mysql_SG-UAP常用注解介绍的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。