一、添加aop starter依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
二：自定義字段翻譯注解。（修改功能時，需要顯示如某字段修改前為張三，修改后為李四，name字段對應(yīng)的中文注釋）
package com.test.common.annotation;
import java.lang.annotation.*;
/**
* 寫入日志表時，字段對應(yīng)的中文注釋
*/
@Retention(RetentionPolicy.RUNTIME) // 注解會在class字節(jié)碼文件中存在，在運行時可以通過反射獲取到
@Target({ElementType.FIELD,ElementType.METHOD})//定義注解的作用目標(biāo)**作用范圍字段、枚舉的常量/方法
@Documented //說明該注解將被包含在javadoc中
public @interface FieldMeta {
/**
* 漢字全稱
* @return
*/
String value();
}
使用FieldMeta自定義注解,看個人業(yè)務(wù)自行覺得是否需要重新定義實體
package com.test.customer.domain;
import java.math.BigDecimal;
import java.util.Date;
import java.util.List;
import java.util.Map;
import com.test.common.annotation.FieldMeta;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import com.test.common.core.domain.BaseEntity;
public class TestDangAnDetail extends BaseEntity {
private static final long serialVersionUID = 1L;
/**
* 次數(shù)
*/
@FieldMeta("總次數(shù)")
private Long CountNum;
}
parseClass調(diào)用查詢方法的類（查詢數(shù)據(jù)工具類）
//抽象類
public interface ContentParser {
/**
* 獲取信息返回查詢出的對象
*
* @param joinPoint 查詢條件的參數(shù)
* @param dbAccessLogger 注解
* @return 獲得的結(jié)果
*/
Object getOldResult(JoinPoint joinPoint, DBAccessLogger dbAccessLogger,String sqlSessionFactoryName);
/**
* 獲取信息返回查詢出的對象
*
* @param joinPoint 查詢條件的參數(shù)
* @param dbAccessLogger 注解
* @return 獲得的結(jié)果
*/
Object getNewResult(JoinPoint joinPoint, DBAccessLogger dbAccessLogger,String sqlSessionFactoryName);
}
實現(xiàn)類 ：通過該實現(xiàn)類獲取更新前后的數(shù)據(jù)。
該實現(xiàn)類的實現(xiàn)原理為：獲取入?yún)⒊鋈氲膇d值，獲取sqlSessionFactory,通過sqlSessionFactory獲取selectByPrimaryKey（）該方法，執(zhí)行該方法可獲取id對應(yīng)數(shù)據(jù)更新操作前后的數(shù)據(jù)。
@Component
public class DefaultContentParse implements ContentParser {
/**
* 獲取更新方法的第一個參數(shù)解析其id
* @param joinPoint 查詢條件的參數(shù)
* @param enableModifyLog 注解類容
* @return
*/
@Override
public Object getOldResult(JoinPoint joinPoint, DBAccessLogger enableModifyLog,String sqlSessionFactoryName) {
Object info = joinPoint.getArgs()[0];
Object id = ReflectionUtils.getFieldValue(info, "id");
Assert.notNull(id,"未解析到id值，請檢查入?yún)⑹欠裾_");
Class<?> aClass = enableModifyLog.serviceClass();
Object result = null;
try {
SqlSessionFactory sqlSessionFactory = SpringUtil.getBean(sqlSessionFactoryName);
Object instance = Proxy.newProxyInstance(
aClass.getClassLoader(),
new Class[]{aClass},
new MyInvocationHandler(sqlSessionFactory.openSession().getMapper(aClass))
);
Method selectByPrimaryKey = aClass.getDeclaredMethod("selectByPrimaryKey", Long.class);
//調(diào)用查詢方法
result = selectByPrimaryKey.invoke(instance, id);
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
@Override
public Object getNewResult(JoinPoint joinPoint, DBAccessLogger enableModifyLog,String sqlSessionFactoryName) {
return getOldResult(joinPoint,enableModifyLog,sqlSessionFactoryName);
}
}
三：定義AOP切面
注意：如不返回操作是否成功狀態(tài)可能會導(dǎo)致前端出現(xiàn)警告，JSON為空不能被解析
import com.test.common.annotation.FieldMeta;
import com.test.common.core.domain.entity.SysUser;
import com.test.common.enums.BusinessStatus;
import com.test.common.enums.OperatorType;
import com.test.common.utils.*;
import com.test.customer.domain.UserDataOperationLogs;
import com.test.customer.service.IUserDataOperationLogsService;
import com.test.framework.service.OperateLog;
import com.test.common.enums.BusinessType;
import com.test.framework.service.ContentParser;
import com.test.system.domain.SysOperLog;
import com.test.system.service.ISysOperLogService;
import lombok.extern.slf4j.Slf4j;
import com.alibaba.fastjson.JSON;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
/**
* 攔截@EnableGameleyLog注解的方法
* 將具體修改存儲到數(shù)據(jù)庫中
*/
@Aspect
@Component
@Slf4j
public class OperateAspect {
@Autowired
private IUserDataOperationLogsService iUserDataOperationLogsService;
@Autowired
private DefaultContentParse defaultContentParse;
@Autowired
private ApplicationContext applicationContext;
// 環(huán)繞通知
@Around("@annotation(operateLog)")
public Object around(ProceedingJoinPoint joinPoint, OperateLog operateLog) throws Throwable{
Map<String, Object> oldMap=new HashMap<>();
UserDataOperationLogs lg = new UserDataOperationLogs();
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 當(dāng)不傳默認(rèn)operateType時 根據(jù)Method類型自動匹配
setAnnotationType(request, operateLog);
// fixme 1.0.9開始不再提供自動存入username功能,請在存儲實現(xiàn)類中自行存儲
// 從切面織入點處通過反射機制獲取織入點處的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Object[] args=joinPoint.getArgs(); // 請求參數(shù)
// 獲取當(dāng)前的用戶
SysUser currentUser = ShiroUtils.getSysUser();
lg.setCreateBy(currentUser.getLoginName());
lg.setStatus(0l);
lg.setUpdateTime(new Date());
if (OperateType.UPDATE.equals(operateLog.operateType())) {
try {
ContentParser contentParser=(ContentParser) applicationContext.getBean(operateLog.parseclass());
Object oldObject = contentParser.getResult(joinPoint, operateLog);
if (operateLog.needDefaultCompare()) {
oldMap = (Map<String, Object>) objectToMap(oldObject); // 存儲修改前的對象
lg.setStoreId((Long) oldMap.get("storeId"));
lg.setItemId((Long) oldMap.get("itemId"));
}
} catch (Exception e) {
e.printStackTrace();
log.error("service加載失敗:", e);
}
}
// joinPoint.proceed()執(zhí)行前是前置通知，執(zhí)行后是后置通知
Object object=joinPoint.proceed();
if (OperateType.UPDATE.equals(operateLog.operateType())) {
ContentParser contentParser;
try {
String responseParams=JSON.toJSONString(object);
contentParser=(ContentParser) applicationContext.getBean(operateLog.parseclass());
object = contentParser.getResult(joinPoint, operateLog);
} catch (Exception e) {
log.error("service加載失敗:", e);
}
// 默認(rèn)不進行比較，可以自己在logService中自定義實現(xiàn)，降低對性能的影響
if (operateLog.needDefaultCompare()) {
lg.setContent(defaultDealUpdate(object, oldMap));
}
// 如果使用默認(rèn)緩存 則需要更新到最新的數(shù)據(jù)
if(operateLog.defaultCache()
&& operateLog.parseclass().equals(DefaultContentParse.class)){
defaultContentParse.updateCache(joinPoint, operateLog,object);
}
} else{
String responseParams=JSON.toJSONString(object);
}
//保存當(dāng)前日志到數(shù)據(jù)庫中
int logs = iUserDataOperationLogsService.insertUserDataOperationLogs(lg);
log.info("新增用戶操作數(shù)據(jù)日志成功");
//返回用戶的操作是否成功
AjaxResult ajaxResult = logs > 0 ? success() : error();
return ajaxResult;
}
private String defaultDealUpdate(Object newObject, Map<String, Object> oldMap){
try {
Map<String, Object> newMap = (Map<String, Object>) objectToMap(newObject);
StringBuilder str = new StringBuilder();
Object finalNewObject = newObject;
oldMap.forEach((k, v) -> {
Object newResult = newMap.get(k);
if (null!=v && !v.equals(newResult)) {
Field field = ReflectionUtils.getAccessibleField(finalNewObject, k);
FieldMeta dataName = field.getAnnotation(FieldMeta.class);
SysUser currentUser = ShiroUtils.getSysUser();
if (null!=dataName) {
str.append("【"+currentUser.getLoginName()+"】").append("修改了【").append(dataName.value() +"】").append("將【").append(v).append("】").append(" 改為：【").append(newResult).append("】。\n");
}
}
});
return str.toString();
} catch (Exception e) {
log.error("比較異常", e);
throw new RuntimeException("比較異常",e);
}
}
private Map<?, ?> objectToMap(Object obj) {
if (obj == null) {
return null;
}
ObjectMapper mapper = new ObjectMapper();
mapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 如果使用JPA請自己打開這條配置
// mapper.addMixIn(Object.class, IgnoreHibernatePropertiesInJackson.class);
Map<?, ?> mappedObject = mapper.convertValue(obj, Map.class);
return mappedObject;
}
private void setAnnotationType(HttpServletRequest request,OperateLog modifyLog){
if(!modifyLog.operateType().equals(OperateType.NONE)){
return;
}
String method=request.getMethod();
if(RequestMethod.GET.name().equalsIgnoreCase(method)){
ReflectAnnotationUtil.updateValue(modifyLog, "operateType", OperateType.SELECT);
} else if(RequestMethod.POST.name().equalsIgnoreCase(method)){
ReflectAnnotationUtil.updateValue(modifyLog, "operateType", OperateType.ADD);
} else if(RequestMethod.PUT.name().equalsIgnoreCase(method)){
ReflectAnnotationUtil.updateValue(modifyLog, "operateType", OperateType.UPDATE);
} else if(RequestMethod.DELETE.name().equalsIgnoreCase(method)){
ReflectAnnotationUtil.updateValue(modifyLog, "operateType", OperateType.DELETE);
}
}
}
或者寫成
//環(huán)繞通知切面，切點：DBAccessLogger 更新攔截數(shù)據(jù)
@Aspect
@Component
@Order(1)
public class DBAccessLoggerAspect {
// 注入Service用于把日志保存數(shù)據(jù)庫
@Autowired
private LogService logService;
@Around("@annotation(com.****.log.DBAccessLogger)") // 環(huán)繞通知
public Object execute(ProceedingJoinPoint pjp) throws Exception {
// 獲得當(dāng)前訪問的class
Class<?> className = pjp.getTarget().getClass();
// 獲得訪問的方法名
String methodName = pjp.getSignature().getName();
@SuppressWarnings("rawtypes")
Class[] argClass = ((MethodSignature) pjp.getSignature()).getParameterTypes();
// 操作結(jié)果，默認(rèn)為成功
Long operResult = DictLogConstant.LOGS_OPER_SUCCESS;
//返回值
Object rvt = null;
Method method = className.getMethod(methodName, argClass);
DBAccessLogger dbAcessLoggerannotation = method.getAnnotation(DBAccessLogger.class);
String accessTable = dbAcessLoggerannotation.accessTable();
DBOperationType accessType = dbAcessLoggerannotation.accessType();
DatabaseEnum databaseEnum = dbAcessLoggerannotation.accessDatasource();
String accessDatasource = databaseEnum.constName;
//crd操作直接執(zhí)行方法
if (accessType == DBOperationType.DELETE || accessType == DBOperationType.SELECT || accessType == DBOperationType.CREATE) {
try {
rvt = pjp.proceed();
} catch (Throwable e) {
e.printStackTrace();
throw new RuntimeException(e.getMessage());
}
// 如果沒有返回結(jié)果，則不將該日志操作寫入數(shù)據(jù)庫。
if (rvt == null) return rvt;
}
if ((accessType == DBOperationType.DELETE)
&& ((CUDResult) rvt).getReturnVal() == 0) {
operResult = DictLogConstant.LOGS_OPER_FAILURE;
}
if (accessTable != null) {
if (accessType == DBOperationType.SELECT) {
Log sysLog = new Log();
/**
設(shè)置要存放的日志信息
**/
logService.createLog(sysLog);
}
else if (accessType == DBOperationType.DELETE || accessType == DBOperationType.CREATE) {
for (Long recordId : ((CUDResult) rvt).getRecordIds()) {
Log sysLog = new Log();
/**
設(shè)置要存放的日志信息
**/
logService.createLog(sysLog);
}
}
else {
//更新操作
Log sysLog = new Log();
/**
設(shè)置日志信息
**/
//獲取更行前的數(shù)據(jù)
Map<String, Object> oldMap = null;
Object oldObject;
try {
ContentParser contentParser = SpringUtil.getBean(dbAcessLoggerannotation.parseClass());
//獲取更行前的數(shù)據(jù)
oldObject = contentParser.getOldResult(pjp, dbAcessLoggerannotation, databaseEnum.sqlsessionName);
oldMap = (Map<String, Object>) objectToMap(oldObject);
} catch (Exception e) {
e.printStackTrace();
}
//執(zhí)行service
Object serviceReturn;
try {
serviceReturn = pjp.proceed();
} catch (Throwable throwable) {
throwable.printStackTrace();
throw new RuntimeException(throwable.getMessage());
}
CUDResult crudResult = (CUDResult) serviceReturn;
Object afterResult = null;
try {
ContentParser contentParser = SpringUtil.getBean(dbAcessLoggerannotation.parseClass());
//更新后的數(shù)據(jù)
afterResult = contentParser.getNewResult(pjp, dbAcessLoggerannotation, databaseEnum.sqlsessionName);
} catch (Exception e) {
e.printStackTrace();
}
//修改前后的變化
sysLog.setOperation(accessType.getValue());
try {
String updatedefrent = defaultDealUpdate(afterResult, oldMap);
sysLog.setParams(updatedefrent);
} catch (Exception e) {
e.printStackTrace();
}
/**
設(shè)置日志信息
**/
logService.createLog(sysLog);
return serviceReturn;
}
}
if (operResult.longValue() == DictLogConstant.LOGS_OPER_FAILURE) {
// 當(dāng)數(shù)據(jù)庫的UPDATE 和 DELETE操作沒有對應(yīng)的數(shù)據(jù)記錄存在時，拋出異常
throw new DBAccessException(accessType.getValue() + "的數(shù)據(jù)記錄不存在！");
}
return rvt;
}
private Map<?, ?> objectToMap(Object obj) {
if (obj == null) {
return null;
}
ObjectMapper mapper = new ObjectMapper();
mapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
//如果使用JPA請自己打開這條配置
//mapper.addMixIn(Object.class, IgnoreHibernatePropertiesInJackson.class);
Map<?, ?> mappedObject = mapper.convertValue(obj, Map.class);
return mappedObject;
}
/**
*
* @param newObject 更新過后的結(jié)果
* @param oldMap 更新前的結(jié)果
* @return
*/
private String defaultDealUpdate(Object newObject, Map<String, Object> oldMap) {
try {
Map<String, Object> newMap = (Map<String, Object>) objectToMap(newObject);
StringBuilder str = new StringBuilder();
Object finalNewObject = newObject;
oldMap.forEach((k, v) -> {
Object newResult = newMap.get(k);
if (v != null && !v.equals(newResult)) {
Field field = ReflectionUtils.getAccessibleField(finalNewObject, k);
//獲取類上的注解
DataName dataName = field.getAnnotation(DataName.class);
if (field.getType().getName().equals("java.util.Date")) {
SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
if (dataName != null) {
str.append("【").append(dataName.name()).append("】從【")
.append(format.format(v)).append("】改為了【").append(format.format(newResult)).append("】;\n");
} else {
str.append("【").append(field.getName()).append("】從【")
.append(format.format(v)).append("】改為了【").append(format.format(newResult)).append("】;\n");
}
} else {
if (dataName != null) {
str.append("【").append(dataName.name()).append("】從【")
.append(v).append("】改為了【").append(newResult).append("】;\n");
} else {
str.append("【").append(field.getName()).append("】從【")
.append(v).append("】改為了【").append(newResult).append("】;\n");
}
}
}
});
return str.toString();
} catch (Exception e) {
throw new RuntimeException("比較異常", e);
}
}
}
四：自定義日志注解
package com.test.framework.service;
import com.test.common.utils.IService;
import com.test.common.utils.OperateType;
import com.test.framework.service.impl.DefaultContentParse;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 記錄編輯詳細(xì)信息的標(biāo)注
* @author
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface OperateLog {
// 模塊名稱
String moduleCode() default "";
// 操作的類型 可以直接調(diào)用OperateType 不傳時根據(jù)METHOD自動確定
OperateType operateType() default OperateType.NONE;
// 獲取編輯信息的解析類，目前為使用id獲取，復(fù)雜的解析需要自己實現(xiàn)，默認(rèn)不填寫則使用默認(rèn)解析類
Class parseclass() default DefaultContentParse.class;
// 查詢數(shù)據(jù)庫所調(diào)用的class文件
Class serviceclass() default IService.class;
// 具體業(yè)務(wù)操作名稱
String handleName() default "";
// 是否需要默認(rèn)的改動比較
boolean needDefaultCompare() default false;
// id的類型
Class idType() default Long.class;
// 是否使用默認(rèn)本地緩存
boolean defaultCache() default false;
}
五、@OperateLog注解使用
/**
* 修改記錄詳情
* @OperateLog:AOP自定義日志注解
*/
@PostMapping("/editSave")
@OperateLog(moduleCode="editSave", operateType= OperateType.UPDATE, handleName="修改檔案信息", needDefaultCompare=true)
@ResponseBody
public AjaxResult editSave(TCustomerItemRecDetail tCustomerItemRecDetail){
return toAjax(testDangAnDetailService.updateTestDangAnDetail(tCustomerItemRecDetail));
}
修改功能時，需要實現(xiàn)我們自定義的IService接口，并重寫 selectById 方法，在修改前我們需要根據(jù)主鍵id去數(shù)據(jù)庫查詢對應(yīng)的信息，然后在和修改后的值進行比較。文章來源：http://www.zghlxwxcb.cn/news/detail-818246.html
文章來源地址http://www.zghlxwxcb.cn/news/detail-818246.html
六：IService接口
/**
* 修改時需要記錄修改前后的值時，需要根據(jù)主鍵id去查詢修改前的值時需要
* @author zhang
*/
public interface IService<T, S> {
T selectById(S id);
}
到了這里，關(guān)于spring boot 使用AOP+自定義注解+反射實現(xiàn)操作日志記錄修改前數(shù)據(jù)和修改后對比數(shù)據(jù)，并保存至日志表的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
