springAOP實現操作日志記錄，並記錄請求參數與編輯前后字段的具體改變

 本文為博主原創，未經允許不得轉載：

 　　在項目開發已經完成多半的情況下,需要開發進行操作日志功能的開發,由於操作的重要性,需要記錄下操作前的參數和請求時的參數,

在網上找了很多,沒找到可行的方法.由於操作日志用注解方式的AOP記錄操作日志比較便捷,所以想到了在注解中定義操作前查詢數據

詳情的bean,查詢方法及參數,參數類型,在aop進行方法執行前,對指定的bean,方法,參數進行調用,獲得修改前的參數,並進行保存.

此處需要注意:

1.在前面中調用指定bean的方法時,不可用反射進行調用,反射不能加載spring容器,無法獲取指定的spring bean,下面方法中封裝的獲取spring bean的

　　工具類也需要配置為bean,而且被spring加載,才可以;

2.@Aspect注解的類一定要配置成bean，而且被spring加載，才可以，即同時配置@Component和@Aspect,或在spring的配置文件進行bean的配置

3.如果配置了bean，要檢索component-scan掃描范圍是否包括Aspect類；

一.定義切面執行的注解(該注解可根據自己實現的內容進行自定義)

 1 import java.lang.annotation.Documented;
 2 import java.lang.annotation.Retention; 3 import java.lang.annotation.Target; 4 5 import java.lang.annotation.ElementType; 6 import java.lang.annotation.RetentionPolicy; 7 8 @Target({ElementType.PARAMETER, ElementType.METHOD}) 9 @Retention(RetentionPolicy.RUNTIME) 10 @Documented 11 public @interface SystemControllerLog { 12 13 /**查詢模塊*/ 14 String module() default ""; 15 16 /**查詢模塊名稱*/ 17 String methods() default ""; 18 19 /**查詢的bean名稱*/ 20 String serviceClass() default ""; 21 22 /**查詢單個詳情的bean的方法*/ 23 String queryMethod() default ""; 24 25 /**查詢詳情的參數類型*/ 26 String parameterType() default ""; 27 28 /**從頁面參數中解析出要查詢的id， 29 * 如域名修改中要從參數中獲取customerDomainId的值進行查詢 30 */ 31 String parameterKey() default ""; 32 33 /**是否為批量類型操作*/ 34 boolean paramIsArray() default false; 35 36 }

 

 二.切面執行的方法

 
 import java.lang.reflect.Method;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
 
 import org.apache.commons.lang3.StringUtils;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.Signature;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Pointcut;
 import org.aspectj.lang.reflect.MethodSignature;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 import org.springframework.util.ReflectionUtils;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
 
 import com.alibaba.fastjson.JSON;
 import com.alibaba.fastjson.JSONArray;
 import com.alibaba.fastjson.JSONObject;
 import com.suning.fucdn.common.RequestResult;
 import com.suning.fucdn.common.enums.FucdnStrConstant;
 import com.suning.fucdn.entity.log.SystemControllerLogInfo;
 import com.suning.fucdn.impl.service.log.LogServiceImpl;
 import com.suning.fucdn.vo.AdminUserVO;
 
 /**
  * 
  * 〈一句話功能簡述:操作日志切面記錄操作〉<br> 
  * 〈功能詳細描述〉
  *
  * @author xiang
  * @see [相關類/方法]（可選）
  * @since [產品/模塊版本] （可選）
  */
 @Component
 @Aspect
 public class ControllerLogAopAspect {
     
     private static final Logger LOGGER = LoggerFactory.getLogger(ControllerLogAopAspect.class);
     
     //注入service,用來將日志信息保存在數據庫
     @Autowired
     private LogServiceImpl logservice;
     
      //配置接入點,如果不知道怎么配置,可以百度一下規則
　　　　　　//指定controller的類進行切面　　@Pointcut("execution(* com.controller..CustomerController.*(..))||execution(* com.controller.ManageController.*(..))")  

      @Pointcut("execution(* com.controller..*.*(..))")  
      private void controllerAspect(){
          System.out.println("point cut start");
      }//定義一個切入點
  
      @SuppressWarnings({ "rawtypes", "unused" })
      @Around("controllerAspect()")
      public Object around(ProceedingJoinPoint pjp) throws Throwable {
          //常見日志實體對象
          SystemControllerLogInfo log = new SystemControllerLogInfo(); 
          //獲取登錄用戶賬戶
          HttpServletRequest httpRequest = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
         
          //方法通知前獲取時間,為什么要記錄這個時間呢？當然是用來計算模塊執行時間的
          //獲取系統時間
          String time = new SimpleDateFormat(FucdnStrConstant.YEAR_MONTH_DAY_HOUR_MINUTE_SECOND.getConstant()).format(new Date());
          log.setStartTime(time);
          
          //獲取系統ip,這里用的是我自己的工具類,可自行網上查詢獲取ip方法
          //String ip = GetLocalIp.localIp();
          //log.setIP(ip);
          
         // 攔截的實體類，就是當前正在執行的controller
         Object target = pjp.getTarget();
         // 攔截的方法名稱。當前正在執行的方法
         String methodName = pjp.getSignature().getName();
         // 攔截的方法參數
         Object[] args = pjp.getArgs();
         //String params = Arrays.toString(pjp.getArgs());
         JSONArray operateParamArray = new JSONArray();
         for (int i = 0; i < args.length; i++) {
             Object paramsObj = args[i];
             //通過該方法可查詢對應的object屬於什么類型：String type = paramsObj.getClass().getName();
         if(paramsObj instanceof String || paramsObj instanceof JSONObject){
             String str = (String) paramsObj;
             //將其轉為jsonobject
             JSONObject dataJson = JSONObject.parseObject(str);
             if(dataJson == null || dataJson.isEmpty() || "null".equals(dataJson)){
                 break;
             }else{
                 operateParamArray.add(dataJson);
             }
         }else if(paramsObj instanceof Map){
             //get請求，以map類型傳參
             //1.將object的map類型轉為jsonobject類型
             Map<String, Object> map = (Map<String, Object>) paramsObj;
             JSONObject json =new JSONObject(map);
             operateParamArray.add(json);
         }
         }
         //設置請求參數
         log.setOperateParams(operateParamArray.toJSONString());
         // 攔截的放參數類型
         Signature sig = pjp.getSignature();
         MethodSignature msig = null;
         if (!(sig instanceof MethodSignature)) {
             throw new IllegalArgumentException("該注解只能用於方法");
         }
         msig = (MethodSignature) sig;
         
         Class[] parameterTypes = msig.getMethod().getParameterTypes();
         Object object = null;
         // 獲得被攔截的方法
         Method method = null;
         try {
             method = target.getClass().getMethod(methodName, parameterTypes);
         } catch (NoSuchMethodException e1) {
             LOGGER.error("ControllerLogAopAspect around error",e1);
         } catch (SecurityException e1) {
             LOGGER.error("ControllerLogAopAspect around error",e1);
         }
         if (null != method) {
             // 判斷是否包含自定義的注解，說明一下這里的SystemLog就是我自己自定義的注解
             if (method.isAnnotationPresent(SystemControllerLog.class)) {
                 
                 //此處需要對用戶進行區分：1為admin user 2為customer user
                 // get session
                 HttpSession httpSession = httpRequest.getSession(true);
                 // 從session獲取登錄用戶
                 AdminUserVO adminUserVO = (AdminUserVO) httpSession
                         .getAttribute(FucdnStrConstant.SESSION_KEY_ADMIN.getConstant());
                 long adminUserId = adminUserVO.getAdminUserId();
                 log.setUserId(String.valueOf(adminUserId));
                 
                 SystemControllerLog systemlog = method.getAnnotation(SystemControllerLog.class);
                 
                 log.setModule(systemlog.module());
                 log.setMethod(systemlog.methods());
                 //請求查詢操作前數據的spring bean
                 String serviceClass = systemlog.serviceClass();
                 //請求查詢數據的方法
                 String queryMethod = systemlog.queryMethod();
                 //判斷是否需要進行操作前的對象參數查詢
                 if(StringUtils.isNotBlank(systemlog.parameterKey())
                     &&StringUtils.isNotBlank(systemlog.parameterType())
                     &&StringUtils.isNotBlank(systemlog.queryMethod())
                     &&StringUtils.isNotBlank(systemlog.serviceClass())){
                     boolean isArrayResult = systemlog.paramIsArray();
                      //參數類型
                     String paramType = systemlog.parameterType();
                     String key = systemlog.parameterKey();
                     
                     if(isArrayResult){//批量操作
                         //JSONArray jsonarray = (JSONArray) object.get(key);
                         //從請求的參數中解析出查詢key對應的value值
                         String value = "";
                         JSONArray beforeParamArray = new JSONArray();
                         for (int i = 0; i < operateParamArray.size(); i++) {
                             JSONObject params =  operateParamArray.getJSONObject(i);
                             JSONArray paramArray = (JSONArray) params.get(key);
                             if (paramArray != null) {
                                 for (int j = 0; j < paramArray.size(); j++) {
                                     String paramId =  paramArray.getString(j);
                                     //在此處判斷spring bean查詢的方法參數類型
                                     Object data = getOperateBeforeData(paramType, serviceClass, queryMethod, paramId);
                                     JSONObject json = (JSONObject) JSON.toJSON(data);
                                     beforeParamArray.add(json);
                                 }
                             }
                         }
                         log.setBeforeParams(beforeParamArray.toJSONString());
                         
                     }else{//單量操作
                         
                         //從請求的參數中解析出查詢key對應的value值
                         String value = "";
                         for (int i = 0; i < operateParamArray.size(); i++) {
                             JSONObject params =  operateParamArray.getJSONObject(i);
                             value = params.getString(key);
                             if(StringUtils.isNotBlank(value)){
                                 break;
                             }
                         }
                         //在此處獲取操作前的spring bean的查詢方法
                         Object data = getOperateBeforeData(paramType, serviceClass, queryMethod, value);
                         JSONObject beforeParam = (JSONObject) JSON.toJSON(data);
                         log.setBeforeParams(beforeParam.toJSONString());
                     }
                 }
                 
                 try {
                     //執行頁面請求模塊方法，並返回
                     object = pjp.proceed();
                     //獲取系統時間
                     String endTime = new SimpleDateFormat(FucdnStrConstant.YEAR_MONTH_DAY_HOUR_MINUTE_SECOND.getConstant()).format(new Date());
                     log.setEndTime(endTime);
                     //將object 轉化為controller封裝返回的實體類：RequestResult
                     RequestResult requestResult = (RequestResult) object;
                     if(requestResult.isResult()){
                         //操作流程成功
                         if(StringUtils.isNotBlank(requestResult.getErrMsg())){
                             log.setResultMsg(requestResult.getErrMsg());
                         }else if(requestResult.getData() instanceof String){
                             log.setResultMsg((String) requestResult.getData());
                         }else{
                             log.setResultMsg("執行成功");
                         }
                     }else{
                         log.setResultMsg("失敗");
                     }
                     //保存進數據庫
                     logservice.saveLog(log);
                 } catch (Throwable e) {
                     String endTime = new SimpleDateFormat(FucdnStrConstant.YEAR_MONTH_DAY_HOUR_MINUTE_SECOND.getConstant()).format(new Date());
                     log.setEndTime(endTime);
                     
                     log.setResultMsg(e.getMessage());
                     logservice.saveLog(log);
                 }
             } else {
                 //沒有包含注解
                 object = pjp.proceed();
             }
         } else { 
             //不需要攔截直接執行
             object = pjp.proceed();
         }
         return object;
      }
      
      /**
       * 
       * 功能描述: <br>
       * 〈功能詳細描述〉
       *
       * @param paramType:參數類型
       * @param serviceClass：bean名稱
       * @param queryMethod：查詢method
       * @param value：查詢id的value
       * @return
       * @see [相關類/方法](可選)
       * @since [產品/模塊版本](可選)
       */
      public Object getOperateBeforeData(String paramType,String serviceClass,String queryMethod,String value){
         Object obj = new Object();
          //在此處解析請求的參數類型，根據id查詢數據，id類型有四種：int，Integer,long,Long
          if(paramType.equals("int")){
              int id = Integer.parseInt(value);
              Method  mh = ReflectionUtils.findMethod(SpringContextUtil.getBean(serviceClass).getClass(), queryMethod,Long.class );
             //用spring bean獲取操作前的參數,此處需要注意：傳入的id類型與bean里面的參數類型需要保持一致
             obj = ReflectionUtils.invokeMethod(mh,  SpringContextUtil.getBean(serviceClass),id);
              
          }else if(paramType.equals("Integer")){
              Integer id = Integer.valueOf(value);
              Method  mh = ReflectionUtils.findMethod(SpringContextUtil.getBean(serviceClass).getClass(), queryMethod,Long.class );
             //用spring bean獲取操作前的參數,此處需要注意：傳入的id類型與bean里面的參數類型需要保持一致
             obj = ReflectionUtils.invokeMethod(mh,  SpringContextUtil.getBean(serviceClass),id);
              
          }else if(paramType.equals("long")){
              long id = Long.parseLong(value);
              Method  mh = ReflectionUtils.findMethod(SpringContextUtil.getBean(serviceClass).getClass(), queryMethod,Long.class );
             //用spring bean獲取操作前的參數,此處需要注意：傳入的id類型與bean里面的參數類型需要保持一致
             obj = ReflectionUtils.invokeMethod(mh,  SpringContextUtil.getBean(serviceClass),id);
              
          }else if(paramType.equals("Long")){
              Long id = Long.valueOf(value);
              Method  mh = ReflectionUtils.findMethod(SpringContextUtil.getBean(serviceClass).getClass(), queryMethod,Long.class );
             //用spring bean獲取操作前的參數,此處需要注意：傳入的id類型與bean里面的參數類型需要保持一致
             obj = ReflectionUtils.invokeMethod(mh,  SpringContextUtil.getBean(serviceClass),id);
          }
          return obj;
      }
 }

 

 三.獲取spring bean的工具類

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;


/**
 * 獲取spring容器，以訪問容器中定義的其他bean
 *  xiang
 *  MOSTsView 3.0 2009-11-16
 */
@Component
public class SpringContextUtil implements ApplicationContextAware{
     
    private static ApplicationContext   applicationContext;
 
    /**
     * 實現ApplicationContextAware接口的回調方法，設置上下文環境
     */
    public void setApplicationContext(ApplicationContext applicationContext){
        SpringContextUtil.applicationContext = applicationContext;
    }
 
    public static ApplicationContext getApplicationContext(){
        return applicationContext;
    }
 
    /**
     * 獲取對象
     * @return  Object 一個以所給名字注冊的bean的實例 (service注解方式，自動生成以首字母小寫的類名為bean name)
     */
    public static Object getBean(String name) throws BeansException{
        return applicationContext.getBean(name);
    }
}

 

 四.操作日志對應的實體類

 1 public class SystemControllerLogInfo{
 2     
 3     private long id; 4 5 /**用戶id*/ 6 private String userId; 7 8 /**用戶類型*/ 9 private int userType; 10 11 /**操作模塊*/ 12 private String module; 13 14 /**操作類型*/ 15 private String method; 16 17 /**操作前參數*/ 18 private String beforeParams; 19 20 /**操作時請求參數*/ 21 private String operateParams; 22 23 /**開始時間*/ 24 private String startTime; 25 26 /**結束時間*/ 27 private String endTime; 28 29 /**操作狀態描述*/ 30 private int resultStatus; 31 32 /**操作結果描述*/ 33 private String resultMsg;

 

 五.進行注解切面調用

 1 @ResponseBody
 2     @RequestMapping(value = "/delete", method = { RequestMethod.POST }) 3 @SystemControllerLog(module="域名管理",methods="域名刪除",serviceClass="domainConfService",queryMethod="queryDomain",parameterType="Long",parameterKey="customerDomainId") 4 public RequestResult delete(@RequestBody String param) { 5 // 定義請求數據 6 RequestResult result = new RequestResult(); 7 // 接收數據 8 CustomerDomain customerDomain = JSONObject.parseObject(param, CustomerDomain.class); 9 // 更新客戶域名 10 try { 11 String data = domainConfService.deleteDomain(customerDomain.getId()); 12 // 設置true 13 if (StringUtils.isBlank(data)) { 14 result.setData("刪除成功"); 15 } else { 16  result.setData(data); 17  } 18 result.setResult(true); 19 } catch (Exception e) { 20 // 記錄錯誤信息，並返回 21 LOGGER.error("delete failed", e); 22  result.setErrMsg(e.getMessage()); 23  } 24 // 返回 25 return result; 26 }

 

 六.數據實例

 補充：get請求參數類型解析和記錄

 JSONArray operateParamArray = new JSONArray();
        for (int i = 0; i < args.length; i++) {
            Object paramsObj = args[i];
            //通過該方法可查詢對應的object屬於什么類型：String type = paramsObj.getClass().getName();
            if(paramsObj instanceof String || paramsObj instanceof JSONObject){
                String str = (String) paramsObj;
                //將其轉為jsonobject
                JSONObject dataJson = JSONObject.parseObject(str);
                if(dataJson == null || dataJson.isEmpty() || "null".equals(dataJson)){
                    break;
                }else{
                    operateParamArray.add(dataJson);
                }
            }else if(paramsObj instanceof Map){
                //get請求，以map類型傳參
                //1.將object的map類型轉為jsonobject類型
                Map<String, Object> map = (Map<String, Object>) paramsObj;
                JSONObject json =new JSONObject(map);
                operateParamArray.add(json);
            }
        }

get請求的controller示例：

@ResponseBody
    @RequestMapping(value = "/add", method = { RequestMethod.GET })
    @SystemControllerLog(module="域名管理",methods="域名新增")
    public RequestResult addDomain(@RequestParam Map<String, String> paramMap) {