使用AOP設置日誌

時間 2019-12-05

標籤使用 aop 設置日誌简体版

原文原文鏈接

在java開發中日誌的管理有不少種。我通常會使用過濾器，或者是Spring的攔截器進行日誌的處理。若是是用過濾器比較簡單，只要對全部的.do提交進行攔截，而後獲取action的提交路徑就能夠獲取對每一個方法的調用。而後進行日誌記錄。使用過濾器的好處是能夠本身選擇性的對某一些方法進行過濾，記錄日誌。可是實現起來有點麻煩。

另一種就是使用Spring的AOP了。這種方式實現起來很是簡單，只要配置一下配置文件就能夠了。但是這種方式會攔截下全部的對action的每一個操做。使得效率比較低。不過想作詳細日誌這個方法仍是很是好的。下面我就介紹一下使用Spring AOP進行日誌記錄的方式。 html

第一種。Spring AOP對普通類的攔截操做 java

首先咱們要寫一個普通類，此類做爲日誌記錄類。好比 spring

[java] view plain copy print ?

package chen.hui.log
public classs MyLog{
//在類裏面寫方法，方法名詩能夠任意的。此處我用標準的before和after來表示
public void before(){
System.out.println("被攔截方法調用以前調用此方法，輸出此語句");
}
public void after(){
System.out.println("被攔截方法調用以後調用此方法，輸出此語句");
}
}

其次咱們在寫一個類做爲被攔截類（Spring的AOP就是攔截這個類裏面的方法） express

[java] view plain copy print ?

package chen.hui.log
public class Test{//此類中方法能夠寫任意多個。我只寫一個
public void test(){
Sytem.out.println("測試類的test方法被調用");
}
}

最後進行配置文件的編寫。在Spring的配置文件中咱們須要進行幾句話的配置數組

[html] view plain copy print ?

<bean id="testLog" class="chen.hui.log.MyLog"></bean>
<aop:config>
<aop:aspect id="b" ref="testLog">
<aop:pointcut id="log" expression="execution(* chen.hui.log.*.*(..))"/>
<aop:before pointcut-ref="log" method="before"/>
<aop:after pointcut-ref="log" method="after"/>>
</aop:aspect>
</aop:config>

到此處整個程序完成，在MyLog類裏面的before和after方法添加日誌邏輯代碼就能夠完成日誌的管理。以上是對普通類的管理，若是隻想攔截某一個類。只要把倒數第二個 * 改爲類名就能夠了。 app

第二：使用Spring AOP對action作日誌管理 測試

若是是想攔截action對action作日誌管理，基本和上面差很少，可是要注意。如下幾點 ui

首先仍是要寫一個普通類，不過此類中的方法須要傳入參數。好比 this

[java] view plain copy print ?

package chen.hui.log
import org.aspectj.lang.JoinPoint;
public classs MyLog{
//在類裏面寫方法，方法名詩能夠任意的。此處我用標準的before和after來表示
//此處的JoinPoint類能夠獲取，action全部的相關配置信息和request等內置對象。
public void before(JoinPoint joinpoint){
joinpoint.getArgs();//此方法返回的是一個數組，數組中包括request以及ActionCofig等類對象
System.out.println("被攔截方法調用以前調用此方法，輸出此語句");
}
public void after(JoinPoint joinpoint){
System.out.println("被攔截方法調用以後調用此方法，輸出此語句");
}
}

其次咱們在寫一個action類做爲被攔截類（Spring的AOP就是攔截這個類裏面的方法） spa

[java] view plain copy print ?

package chen.hui.log
public class LoginAction{//此類中方法能夠寫任意多個。我只寫一個
public void test(){
Sytem.out.println("測試類的test方法被調用");
}
}

最後進行配置文件的編寫。在Spring的配置文件中咱們須要進行幾句話的配置

[html] view plain copy print ?

<bean id="testLog" class="chen.hui.log.MyLog"></bean>
<aop:config>
<aop:aspect id="b" ref="testLog">
<aop:pointcut id="log" expression="execution(* chen.hui.log.*.*(..))"/>
<aop:before pointcut-ref="log" method="before"/>
<aop:after pointcut-ref="log" method="after"/>
</aop:aspect>
</aop:config>

除了參數外其餘地方基本和普通類類似。

須要注意的是：普通類能夠監控單一的類，而action在配置文件中只能到包名而不能到action的類名。否則會報錯。就是說若是要記錄日誌就要記錄全部的action而不能記錄其中一個，這是我試了很久得出的結果。

前幾天作項目時，在作系統日誌這一塊，都是在每一個方法裏手寫代碼來添加，以爲很繁瑣，考慮到spring有aop的功能，便尋思着用AOP來作這個日誌功能。

首先須要傳入日誌記錄的具體操做名稱，咱們能夠用java的註解功能來帶入參數，代碼以下：

Java代碼

/**
* 類的方法描述註解
* @author LuoYu
*/
@Target (ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface Log {
/** 要執行的操做類型好比：add操做 **/
public String operationType() default "";
/** 要執行的具體操做好比：【添加倉庫】 **/
public String operationName() default "";
}

註解類編寫好以後，就要考慮spring我切面的問題目了，首先咱們要建立一個切點，也就是須要插入的代碼塊，代碼以下：

Java代碼

/**
* 經過Spring AOP來添加系統日誌
* @author LuoYu
*/
public class LogAspect extends BaseAction{
private static final long serialVersionUID = -5063868902693772455L;
private Log logger = LogFactory.getLog(LogAspect.class);
@SuppressWarnings( { "rawtypes", "unchecked" } )
public void doSystemLog(JoinPoint point) throws Throwable {
Object[] param = point.getArgs();
Method method = null;
String methodName = point.getSignature().getName();
if (!(methodName.startsWith("set") || methodName.startsWith("get")||methodName.startsWith("query"))){
Class targetClass = point.getTarget().getClass();
method = targetClass.getMethod(methodName, param[0].getClass());
if (method != null) {
boolean hasAnnotation = method.isAnnotationPresent(com.tlj.pcxt.common.logaop.Log.class);
if (hasAnnotation) {
com.tlj.pcxt.common.logaop.Log annotation = method.getAnnotation(com.tlj.pcxt.common.logaop.Log.class);
String methodDescp = annotation.operationType()+annotation.operationName();
if (logger.isDebugEnabled()) {
logger.debug("Action method:" + method.getName() + " Description:" + methodDescp);
}
User appUser=(User) this.getHttpServletRequest().getSession().getAttribute("user");
if(appUser!=null){
try{
com.tlj.pcxt.entity.admin.Log logInfo=new com.tlj.pcxt.entity.admin.Log();
logInfo.setIp(this.getHttpServletRequest().getRemoteAddr());
logInfo.setSubmitUser(appUser);
logInfo.setContent(annotation.operationType()+","+appUser.getUserName()+
"執行【"+annotation.operationName()+"】操做,影響數據的ID集合爲["+getID(param[0])+"]");
this.logService.save(logInfo);
}catch(Exception ex){
logger.error(ex.getMessage());
}
}
}
}
}
}
/**
* 經過java反射來從傳入的參數object裏取出咱們須要記錄的id,name等屬性，
* 此處我取出的是id
*@author 羅宇
*@date 2013-4-11
*@param obj
*@return
*@return String
*/
public String getID(Object obj){
if(obj instanceof String){
return obj.toString();
}
PropertyDescriptor pd = null;
Method method = null;
String v = "";
try{
pd = new PropertyDescriptor("id", obj.getClass());
method = pd.getReadMethod();
v = String.valueOf(method.invoke(obj));
}catch (Exception e) {
e.printStackTrace();
}
return v;
}
}

切入代碼編寫好以後，須要在applicatioContext.xml裏配置切入規則，也就是說要在哪些方法執行的時候來切入上面編寫的代碼：配置如下：

Xml代碼

<aop:aspectj-autoproxy/>
<bean id="logAspect" class="com.tlj.pcxt.common.logaop.LogAspect"/>
<aop:config>
<aop:aspect ref="logAspect">
<aop:pointcut id="logPointCut" expression="
(execution(* com.tlj.pcxt.service.*.*Impl.add*(..)))
or (execution(* com.tlj.pcxt.service.*.*Impl.update*(..)))
or (execution(* com.tlj.pcxt.service.*.*Impl.delete*(..)))
"/>
<aop:after pointcut-ref="logPointCut" method="doSystemLog"/>
</aop:aspect>
</aop:config>

在此我配置的時在方法執行以後插入代碼塊

Xml代碼

<aop:after pointcut-ref="logPointCut" method="doSystemLog"/>

而且是在全部以add,update,delete開頭的方法才執行，其他的方法將再也不匹配。

調用方法以下，

Java代碼

@Log(operationType="add操做:",operationName="添加倉庫房間")
public void addWareHouseRoom(WareHouseRoom wareHouseRoom) throws ServiceException {
try{
this.getWareHouseRoomDao().save(wareHouseRoom);
}catch (Exception e) {
throw new ServiceException(e);
}
}