2. 程式人生 > >使用自定義註解實現Dao 層

使用自定義註解實現Dao 層

阿新 • • 發佈：2019-02-16

定義（百度詞條）

註解（Annotation），也叫元資料。一種程式碼級別的說明。它是JDK1.5及以後版本引入的一個特性，與類、介面、列舉是在同一個層次。它可以宣告在包、類、欄位、方法、區域性變數、方法引數等的前面，用來對這些元素進行說明，註釋。

       比如我們最常見的 @ Override 就是註解，除了JDK以及第三方註解，可以通過自定義註解來實現一些意想不到的效果。在這裡我們使用自定義註解來實現JDBC中的Dao層，通過例子可以體會自定義註解的妙用。

首先先看自定義註解的語法要求

@Target({Element.METHOD,Element.TYPE}) //註解作用的位置
@Retention(RUNTIME)//註解作用的時間

//使用@interface鍵字定義註解
Public @interface Description{
//成員以無參無異常方式宣告
   String desc();
   String author();
//可以用default為成員制定一個預設值
   Int age() default 18; 
}

關於自定義註解還有以下注意：

1、成員型別是受限的，合法的型別包括原始型別及String Class Annotation Enumeration

2、如果註解只有一個成員，則成員必須取名為value()在使用時可以忽略成員名和賦值號（=）

3、註解類可以沒有成員 沒有成員的註解成為標識註解

下面通過查詢學生資訊的例子，來展示自定義註解的妙用。

//關於表名的註解
package test;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

@Retention(RUNTIME)
@Target(TYPE)
 

/**
*@author Nut
*@version 2018年3月26日 下午10:48:49
*自定義註解：
*通過獲取value的值，可以得到要使用的資料庫中的表名
*描述使用者表的註解
*/
public @interface TableName {

	String value();
}
關於表中列名的註解
package test;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

@Retention(RUNTIME)
@Target(FIELD)
 

/**
*@author Nut
*@version 2018年3月26日 下午10:51:47
*自定義註解：
*通過獲取value的值，可以獲取資料庫的表的列名
*描述使用者表屬性欄位的註解
*/
public @interface ColumnName {

	String value();
}


//一個Student學生類
package test;

/**
 * @author Nut
 * @version 2018年3月26日 下午10:37:12 關於學生的
 */

@TableName("student")
public class Student {

	// 學生ID
	@ColumnName("ID")
	private String stuid;
	// 學生姓名
	@ColumnName("name")
	private String stuname;
	// 學生年齡
	@ColumnName("age")
	private int stuage;
	// 學生出生地
	@ColumnName("birthcity")
	private String stubirthcity;
	// 學生郵箱
	@ColumnName("email")
	private String stuemail;

	public Student() {
	}

	public Student(String stuID, String stuName, int stuAge, String stuBirthCity, String email) {
		super();
		this.stuid = stuID;
		this.stuname = stuName;
		this.stuage = stuAge;
		this.stubirthcity = stuBirthCity;
		this.stuemail = email;
	}

	public String getStuid() {
		return stuid;
	}

	public void setStuid(String stuid) {
		this.stuid = stuid;
	}

	public String getStuname() {
		return stuname;
	}

	public void setStuname(String stuname) {
		this.stuname = stuname;
	}

	public int getStuage() {
		return stuage;
	}

	public void setStuage(int stuage) {
		this.stuage = stuage;
	}

	public String getStubirthcity() {
		return stubirthcity;
	}

	public void setStubirthcity(String stubirthcity) {
		this.stubirthcity = stubirthcity;
	}

	public String getStuemail() {
		return stuemail;
	}

	public void setStuemail(String stuemail) {
		this.stuemail = stuemail;
	}

}
//下面是最重要的！！！

一些相關函式（Class類）

(Class<A> annotationClass)

          如果存在該元素的指定型別的註釋，則返回這些註釋，否則返回 null。

          返回此元素上存在的所有註釋。

          返回直接存在於此元素上的所有註釋。

          返回一個 Method 物件，該物件反映此 Class 物件所表示的類或介面的指定已宣告方法。

          返回 Method 物件的一個數組，這些物件反映此 Class 物件表示的類或介面宣告的所有方法，包括公共、保護、預設（包）訪問和私有方法，但不包括繼承的方法。

(String name, Class<?>... parameterTypes)

          返回一個 Method 物件，它反映此 Class 物件所表示的類或介面的指定公共成員方法。


          返回一個包含某些 Method 物件的陣列，這些物件反映此 Class 物件所表示的類或介面（包括那些由該類或介面宣告的以及從超類和超介面繼承的那些的類或介面）的公共 member 方法。

          返回一個 Field 物件，該物件反映此 Class 物件所表示的類或介面的指定已宣告欄位。

          返回 Field 物件的一個數組，這些物件反映此 Class 物件所表示的類或介面所宣告的所有欄位。

          返回一個 Field 物件，它反映此 Class 物件所表示的類或介面的指定公共成員欄位。


          返回一個包含某些 Field 物件的陣列，這些物件反映此 Class 物件所表示的類或介面的所有可訪問公共欄位。

          以 String 的形式返回此 Class 物件所表示的實體（類、介面、陣列類、基本型別或 void）名稱。

          如果此 Class 物件表示一個註釋型別則返回 true。


          如果指定型別的註釋存在於此元素上，則返回 true，否則返回 false。

package test;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

/**
 * @author Nut
 * @version 2018年3月27日 上午8:48:26 
 * 通過傳入要查詢的條件返回sql語句 
 * 優點在於，無論返回ID，還是返回姓名，只需要用一個函式即可
 */
public class returnSql {

	/**
	 * @param obj
	 * @return 返回查詢語句
	 */
	public static String testQuery(Object obj) {
		// 儲存要返回的sql語句
		StringBuilder sb = new StringBuilder();
		Class<?> c1 = obj.getClass();
		/*
		 * 是否包含TableName型別的註解 對於資料庫是保證是否包含資料庫中的表
		 */
		if (!c1.isAnnotationPresent(TableName.class)) {
			return null;
		}
		// 獲取表的名字
		TableName t = (TableName) c1.getAnnotation(TableName.class);
		String tableName = t.value();
		// 將表名拼接到sql語句
		// 1=1保證sql語句在沒有查詢條件時正常
		sb.append("select * from ").append(tableName).append(" where 1=1");
		//
		Field[] fields = c1.getDeclaredFields();
		// 通過判斷field的不同型別，分別處理，拼接sql語句
		for (Field field : fields) {
			/*
			 * 是否包含ColumnName的註解 對於資料庫就是是否包含表中列名
			 */
			if (!field.isAnnotationPresent(ColumnName.class)) {
				continue;
			}
			// 獲取列的名字
			ColumnName cn = (ColumnName) field.getAnnotation(ColumnName.class);
			String columName = cn.value();
			// 通過get方法，得到值
			Object methodValue = null;
			String methodName = field.getName();
			String getMethodName = "get" + methodName.substring(0, 1).toUpperCase()
					+ methodName.substring(1).toLowerCase();
			try {
				Method method = c1.getMethod(getMethodName);
				methodValue = method.invoke(obj);
			} catch (Exception e) {
				e.printStackTrace();
			}
			if (methodValue == null || (methodValue instanceof Integer && (Integer) methodValue == 0)) {
				continue;
			}
			sb.append(" and ").append(columName);
			if (methodValue instanceof String) {
				if (((String) methodValue).contains(",")) {
					String[] s = ((String) methodValue).split(",");
					sb.append(" in(");
					for (String string : s) {
						sb.append("'").append(string).append("',");
					}
					sb.deleteCharAt(sb.length() - 1);
					sb.append(")");
				} else {
					sb.append("='").append(methodValue).append("'");
				}
			} else if (methodValue instanceof Integer) {
				sb.append("=").append(methodValue);
			}
		}
		return sb.toString();
	}

}
//這是這是一個數據庫連線Class

關於這部分可以詳見我的另一篇部落格JDBC詳解

package test;

/**
*@author Nut
*@version 2018年3月26日 下午10:58:37
*/
import java.sql.*;

public class DBhelper {

	// SqlServer資料庫驅動
	private static String driverName = "com.microsoft.sqlserver.jdbc.SQLServerDriver";

	// SqlServer資料庫連結地址
	private static String dbURL = "jdbc:sqlserver://localhost:1433;DatabaseName=Stu";// ？為你的資料庫名稱

	// 資料庫名稱
	private static String userName = "sa";// ？ = 你的資料庫名稱

	// 資料庫密碼
	private static String userPwd = "*****";// ？ = 你的資料庫密碼

	private static Connection conn = null;

	// 靜態程式碼塊載入資料庫驅動
	static {
		try {
			Class.forName(driverName);
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}

	// 通過單例模式返回資料庫連線
	public static Connection getConnection() throws SQLException {

		if (conn == null) {
			conn = DriverManager.getConnection(dbURL, userName, userPwd);
		}
		return conn;

	}

	public static void main(String[] args) {

		Connection conn;
		try {
			conn = DBhelper.getConnection();
			if (conn != null) {
				System.out.println("資料庫連線成功");
			} else {
				System.out.println("資料庫連線失敗");
			}
		} catch (SQLException e) {
			e.printStackTrace();
		}

	}
}
//執行sql語句
package test;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * @author Nut
 * @version 2018年3月27日 下午1:02:23 通過returnSql返回的查詢語句來查詢資料庫
 */
public class executeSql {
	/*
	 * select語句查詢
	 */
	public static Student executeQuerySql(Object obj) {
		Connection conn = null; // 資料庫連線
		PreparedStatement stmt = null; // 預編譯 執行速度相對較快
		ResultSet rs = null; // 結果集

		try {
			conn = DBhelper.getConnection();// 實現資料庫連線
			String sql = returnSql.testQuery(obj);
			// 輸入SQL語句，通過+來實現資料的動態傳入
			stmt = conn.prepareStatement(sql); // 預編譯SQL語句
			rs = stmt.executeQuery();

			// 用於產生單個結果集的語句，例如 SELECT 語句。 被使用最多的執行 SQL 語句的方法是
			// executeQuery。這個方法被用來執行 SELECT 語句，它幾乎是使用最多的 SQL 語句

			if (rs.next()) {
				Student student = new Student();// 例項一個物件
				student.setStuid(rs.getString("ID"));
				student.setStuname(rs.getString("name"));
				student.setStuage(rs.getInt("age"));
				student.setStubirthcity(rs.getString("birthcity"));
				student.setStuemail(rs.getString("email"));
				// rs.getString("D#")獲取結果集中的值，通過SETTER函式複製
				return student;// 返回物件
			}
			return null;
		} catch (SQLException e) {
			e.printStackTrace();
			return null;
		} finally {
			// 關閉結果集
			if (rs != null) {
				try {
					rs.close();
					rs = null; // 賦值為null 相當於刪除
				} catch (SQLException e) {
					e.printStackTrace();
				}
			}
			if (stmt != null) {
				try {
					stmt.close();
					stmt = null;
				} catch (SQLException e) {
					e.printStackTrace();
				}
			}
		}
	}//結束

}
//測試類
package test;
/**
*@author Nut
*@version 2018年3月27日 下午1:00:53
*/
public class test {

	public static void main(String[] args) {
		Student s1 = new Student();
		s1.setStuname("A");
		Student newStu1 = executeSql.executeQuerySql(s1);
		System.out.println(newStu1.getStuid());
		
		Student s2 = new Student();
		s2.setStuid("s003");
		Student newStu2 = executeSql.executeQuerySql(s2);
		System.out.println(newStu2.getStuname());
 
	}

}

結果：



資料庫設計及資料


最後：可以看出通過自定義註解可以給我們在寫資料庫連線提供一種新的思路。相比之前我之前的提供的方法，有了較好的相容性。

最後的最後：編寫不易，如對你有用，請點個贊吧！




相關推薦

Mybatis自定義註解實現DAO層--實現DAO層介面

  Java新增自定義註解：https://www.cnblogs.com/0xcafedaddy/p/6095187.html 1、自定義一個註解@MybatisRepository用作dao掃描 /** * @author cao * @description 前沿my

使用自定義註解實現Dao 層

定義（百度詞條）註解（Annotation），也叫元資料。一種程式碼級別的說明。它是JDK1.5及以後版本引入的一個特性，與類、介面、列舉是在同一個層次。它可以宣告在包、類、欄位、方法、區域性變數、方法引數等的前面，用來對這些元素進行說明，註釋。       比如我們最常見的

SpringVC 攔截器+自定義註解 實現權限攔截

json.js 加載 bean media tar attr esp 權限 encoding 1.springmvc配置文件中配置 <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://w

Spring AOP 自定義註解實現日誌管理

目錄 一、配置檔案 二、新建一個日誌實體類Log 三、編寫 service 層 四、編寫 service 層的實現 serviceimpl 五、自定義註解類 六、編寫切面類 七、spring + aop 需要的 jar 包 部落格的程式碼是基於 SSM 環境編寫的

SpringBoot 通過自定義註解實現AOP切面程式設計例項

一直心心念的想寫一篇關於AOP切面例項的博文，拖更了許久之後，今天終於著手下筆將其完成。 基礎概念 1、切面(Aspect) 首先要理解‘切’字，需要把物件想象成一個立方體，傳統的面向物件變成思維，類定義完成之後（封裝）。每次例項化一個物件，對類定義中的成員變數賦值，就相當於對這個立方體進行了一個定義，

spring-AOP+自定義註解實現日誌管理（註解方式實現）

一、場景 後臺管理系統中，管理員作業系統時生成日誌儲存在資料庫中。 二、實現 1、jar包依賴 <!-- https://mvnrepository.com/artifact/org.springframework/spring-aop --> <dependency&

java/springboot自定義註解實現AOP

  java註解 即是註釋了，百度解釋：也叫元資料。一種程式碼級別的說明。 個人理解：就是內容可以被程式碼理解的註釋，一般是一個類。 元資料 也叫元註解，是放在被定義的一個註解類的前面 ，是對註解一種限制。 談下這兩個： @Retention 和 @Target  

使用自定義註解實現登入使用者獲取

業務功能場景 在程式碼程式中很多介面的呼叫會有限制，需要使用者在登入狀態下才能進行操作(需要眾多使用者的資訊等)，這裡就使用註解在呼叫介面的時候進行驗證攔截。 自定義一個註解 package com.timothy.annotation; import jav

java自定義註解在service層不生效原因

在做對資料加redis快取時，我這面採用了Spring-Aop的方式通過切面將資料存放在redis中，但是業務場景是，當前端呼叫了controller層的介面時，會走一些簽名校驗，如果校驗過了才會真正呼叫service層去取資料，所以我自己定義的註解載入controlle

《SpringBoot學習篇》（5）AOP+自定義註解實現日誌管理

用到的AOP註解：@Aspect  @Pointcut  @After 首先看一下如何呼叫自定義註解： @MyLog(module="老師模組", method="查詢全部") @RequestMapping("/all") public List

springAOP與自定義註解實現細粒度許可權控制管理

IOC與AOP無疑是spring的核心，提供了非常強大的功能，這兩個思想為我們開發帶來了巨大的方便。 這裡我們aop簡單實現一些許可權控制，用到的aop提供的環繞通知，至於spring提供了那些通知，大家可以自行百度。 <bean id="privilegeAspec

使用Spring Aop自定義註解實現自動記錄日誌

百度加自己琢磨，以下親測有效，所以寫下來記錄，也方便自己回顧瀏覽加深印象之類，有什麼問題可以評論一起解決，不完整之處也請大佬指正，一起進步哈哈（1）首先配置檔案： <!-- 宣告自動為spring容器中配置@aspectj切面的bean建立代理 ，織入切面 --> <aop:

資料脫敏——基於Java自定義註解實現日誌欄位脫敏

　　上文說了資料過敏主要有兩個思路：第一個就是在序列化實體之前先把需要脫敏的欄位進行處理，之後正常序列化；第二個就是在實體序列化的時候，對要脫敏的欄位進行處理。 脫敏實現思路 　　這裡探討第一種方法，用基於自定義註解的方式實現日誌脫敏。 　　要對

SpringMvc擴充套件自定義註解實現web加密解密 不侵入業務程式碼

SpringMvc擴充套件自定義註解實現web解密 不侵入業務程式碼(1) 1.需求 在專案中spring web服務為外部APP提供rest介面，為了 安全考慮 一般會加入自己的驗證，常規 的簽名+資料加密， 當然一個好的架構師或者負責人會在專案初期會考慮到的問題現老程

Spring AOP自定義註解實現許可權控制

1.建立註解類，controller控制層使用該註解進行許可權控制使用 import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.R

spring 自定義註解實現登陸攔截

需求：自定義一個註解，使得controller層的類或者方法在寫上這個註解後，會有登陸驗證。實現原理：（1）先寫一個自定義註解，註解上可以通過註釋確定是類/方法可以加此註解。（2）之後，寫一個攔截器，攔截器內可以通過handler得到被攔截器攔截的類或者方法，之後可以通過這個

spring 自定義註解實現日誌統一處理

需求：通過註解的方式 統一處理controller和service的日誌（實現上可能不太嚴謹，主要是實現流程）原理：先自定義註解。用aop切面攔截方法的使用，看是否有對應的自定義的註解，如果有，在切面中進行日誌的統一列印，可以獲取到加了註解方法的類名、方法名、引數。如果想每個

AOP加自定義註解實現redis註解快取

  很早之前學習了redis，在這次畢業設計中使用redis對熱點資料進行快取，其中使用spring-data-redis還有@Cacheable、@CachePut和@CacheEvict這3個註解。註解的方式避免了在業務方法中參雜太多非業務的邏輯程式碼，比如日誌和事務，

自定義註解實現--簡單理解版

一、背景知識 XML方案的配置可以說讓人眼花繚亂，如網站開發時用到的web.xml,Mybatis的配置xml，Spring的Beans.xml，常常是滿滿的一大頁，配置和排錯都很不容易。但是從JDK5.0版本開始引入的Annotation(註解)就可以幫助程

自定義註解實現日誌管理

首先定義一個註解： @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD}) @Documented public @interface LogAnnotation { //模組