一.什么是AOP
要理解切面編程，就需要先理解什么是切面。用刀把一個西瓜分成兩瓣，切開的切口就是切面；炒菜，鍋與爐子共同來完成炒菜，鍋與爐子就是切面。web層級設計中，web層->網關層->服務層->數據層，每一層之間也是一個切面。編程中，對象與對象之間，方法與方法之間，模塊與模塊之間都是一個個切面。
我們一般做活動的時候，一般對每一個接口都會做活動的有效性校驗（是否開始、是否結束等等）、以及這個接口是不是需要用戶登錄。
按照正常的邏輯，我們可以這么做。
這有個問題就是，有多少接口，就要多少次代碼copy。對於一個“懶人”，這是不可容忍的。好，提出一個公共方法，每個接口都來調用這個接口。這里有點切面的味道了。
同樣有個問題，我雖然不用每次都copy代碼了，但是，每個接口總得要調用這個方法吧。於是就有了切面的概念，我將方法注入到接口調用的某個地方（切點）。
這樣接口只需要關心具體的業務，而不需要關注其他非該接口關注的邏輯或處理。
紅框處，就是面向切面編程
2.Joint point（連接點）：表示在程序中明確定義的點，典型的包括方法調用，對類成員的訪問以及異常處理程序塊的執行等等，它自身還可以嵌套其它 joint point。一個類的所有方法前、后、拋出異常時等都是連接點。
Pointcut（切點）：表示切入點。用於定義通知應該切入到哪些連接點上，不同的通知通常需要切入到不同的連接點上。切入點就是來定義哪些類里面的哪些方法會得到通知。
Advice(通知）：表示通知。是切面的具體實現方法。可分為前置通知（Before）、后置通知（AfterReturning）、異常通知（AfterThrowing）、最終通知（After）和環繞通知（Around）五種。實現方法具體屬於哪類通知，是在配置文件和注解中指定的。在實際開發中通常是切面類中的一個方法，具體屬於哪類通知，通過方法上的注解區分。
Target（目標對象）：表示目標對象。那些即將切入切面的對象，也就是那些被通知的對象從前有一個叫爪哇的小縣城, 在一個月黑風高的晚上, 這個縣城中發生了命案. 作案的凶手十分狡猾, 現場沒有留下什么有價值的線索. 不過萬幸的是, 剛從隔壁回來的老王恰好在這時候無意中發現了凶手行凶的過程, 但是由於天色已晚, 加上凶手蒙着面, 老王並沒有看清凶手的面目, 只知道凶手是個男性, 身高約七尺五寸. 爪哇縣的縣令根據老王的描述, 對守門的士兵下命令說: 凡是發現有身高七尺五寸的男性, 都要抓過來審問. 士兵當然不敢違背縣令的命令, 只好把進出城的所有符合條件的人都抓了起來.
在 Spring AOP 中 Joint point 指代的是所有方法的執行點, 而 point cut 是一個描述信息, 它修飾的是 Joint point, 通過 point cut, 我們就可以確定哪些 Joint point 可以被織入 Advice. 對應到我們在上面舉的例子, 我們可以做一個簡單的類比, Joint point 就相當於 爪哇的小縣城里的百姓,pointcut 就相當於 老王所做的指控, 即凶手是個男性, 身高約七尺五寸, 而 Advice 則是施加在符合老王所描述的嫌疑人的動作: 抓過來審問.
Joint point ： 爪哇的小縣城里的百姓: 因為根據定義, Joint point 是所有可能被織入 Advice 的候選的點, 在 Spring AOP中, 則可以認為所有方法執行點都是 Joint point. 而在我們上面的例子中, 命案發生在小縣城中, 按理說在此縣城中的所有人都有可能是嫌疑人.
Pointcut ：男性, 身高約七尺五寸: 我們知道, 所有的方法(joint point) 都可以織入 Advice, 但是我們並不希望在所有方法上都織入 Advice, 而 Pointcut 的作用就是提供一組規則來匹配joinpoint, 給滿足規則的 joinpoint 添加 Advice. 同理, 對於縣令來說, 他再昏庸, 也知道不能把縣城中的所有百姓都抓起來審問, 而是根據凶手是個男性, 身高約七尺五寸, 把符合條件的人抓起來. 在這里 凶手是個男性, 身高約七尺五寸 就是一個修飾謂語, 它限定了凶手的范圍, 滿足此修飾規則的百姓都是嫌疑人, 都需要抓起來審問.
Advice ：抓過來審問, Advice 是一個動作, 即一段 Java 代碼, 這段 Java 代碼是作用於 point cut 所限定的那些 Joint point 上的. 同理, 對比到我們的例子中, 抓過來審問 這個動作就是對作用於那些滿足 男性, 身高約七尺五寸 的爪哇的小縣城里的百姓.
Aspect:：Aspect 是 point cut 與 Advice 的組合, 因此在這里我們就可以類比: “根據老王的線索, 凡是發現有身高七尺五寸的男性, 都要抓過來審問” 這一整個動作可以被認為是一個 Aspect.
三.Aop實現日志管理模塊
1.准備：日志表
2.定義切入點（Pointcut ），該地方定義了控制層和業務層，
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Documented
public @interface SystemControllerLog {
String module() default "" ;//系統功能
String actionType() default "" ;//操作類型 0登錄 1增加 2編輯 3刪除 4其它
int categoryId() default 2;//分類Id 1-登陸2-訪問3-操作4-異常
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Documented
public @interface SystemServiceLog {
String module() default "" ;//系統功能
String actionType() default "" ;//操作類型 0登錄 1增加 2編輯 3刪除 4其它
int categoryId() default 2;//分類Id 1-登陸2-訪問3-操作4-異常
}
3.切面類
SignAop類使用了@Aspect注解，則該類可以被AOP容器識別為切面。
@Aspect
@Component
@Slf4j
public class LogAop {
@Autowired
private SnowFlake snowFlake;
@Autowired
private SchoolLogMapper schoolLogMapper;
@Autowired
private SchoolHumanMapper schoolHumanMapper;
//Pointcut聲明一個切入點，
//注：作為切入點簽名的方法必須返回void類型
@Pointcut("@annotation( com.woke.project.camp.entity.SystemControllerLog) ||" +
" @annotation( com.woke.project.camp.entity.SystemServiceLog)")
public void logPoinCut() {
}
// 切面 配置通知 后置通知
@AfterReturning(value = "logPoinCut()", returning = "res")
@Transactional
public void saveSysLog(JoinPoint joinPoint, Object res) throws Exception {
log.info(">>>>>>>>>>>>日志AOP開始<<<<<<<<<<<<");
// 保存日志
SchoolLog schoollog = new SchoolLog();
SchoolHuman schoolHuman=new SchoolHuman();
// 從切面織入點處通過反射機制獲取織入點處的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 獲取切入點所在的方法
Method method = signature.getMethod();
// 獲取操作
SystemControllerLog systemControllerLog = method.getAnnotation(SystemControllerLog.class);
SystemControllerLog systemServiceLog = method.getAnnotation(SystemControllerLog.class);
if (systemControllerLog != null) {
String actionType = systemControllerLog.actionType();
String module = systemControllerLog.module();
schoollog.setOperatetype(actionType);//操作類型 0登錄 1增加 2編輯 3刪除 4其它
schoollog.setModulename(module);//系統功能
schoollog.setCategoryid(systemControllerLog.categoryId());//分類 1-登陸2-訪問3-操作4-異常
}
if (systemServiceLog != null) {
String actionType = systemServiceLog.actionType();
String module = systemServiceLog.module();
schoollog.setOperatetype(actionType);//操作類型 0登錄 1增加 2編輯 3刪除 4其它
schoollog.setModulename(module);//備注
schoollog.setCategoryid(systemServiceLog.categoryId());//分類 1-登陸2-訪問3-操作4-異常
}
Map<String, Object> map = new HashMap<>();
for (int j = 0; j < ((MethodSignature) joinPoint.getSignature()).getParameterNames().length; j++) {
for (int i = 0; i < joinPoint.getArgs().length; i++) {
map.put((((MethodSignature) joinPoint.getSignature()).getParameterNames())[j], (joinPoint.getArgs())[i]);
}
}
HttpServletRequest request = (HttpServletRequest) map.get("request");
String humanId = request.getHeader("humanId");
String ip = getIpAddr(request);
String urlAddress = request.getHeader("urlAddress");
if (StringUtils.isNotEmpty(urlAddress) && urlAddress.contains("?")) {
urlAddress = urlAddress.substring(0, urlAddress.lastIndexOf("?"));
}
String path = request.getRequestURI();
// log.info("獲得前端參數：userid={},urlAddress={},path={}", userid, urlAddress, path);
if ((path.contains("/ymt/login"))) {
String account = request.getParameter("account");
schoolHuman = schoolHumanMapper.getAccountM(account);
} else {
//忘記密碼
if (path.contains("/ymt/updatePassword")) {
String account = request.getParameter("account");
schoolHuman = schoolHumanMapper.getAccountM(account);
} else {
// swagger 調用時它是空的 正常情況下權限接口會擋住
if (StringUtils.isEmpty(humanId)) {
schoolHuman = new SchoolHuman();
} else {
schoolHuman = schoolHumanMapper.selectByPrimaryKeyM(Long.valueOf(humanId));
}
}
}
// 獲取瀏覽器信息
Browser browser = UserAgent.parseUserAgentString(request.getHeader("User-Agent")).getBrowser();
// 獲取瀏覽器版本號
Version version = browser.getVersion(request.getHeader("User-Agent"));
String info = browser.getName() + "-" + version.getVersion();
try {
schoollog.setBrowser(info);
schoollog.setLogid(String.valueOf(snowFlake.nextId()));//id
schoollog.setIpaddress(ip);
schoollog.setOperatetime(new Date());
if (!ObjectUtils.isEmpty(schoolHuman)) {
schoollog.setOperateuserid(String.valueOf(schoolHuman.getHumanId()));//用戶id
schoollog.setOperateaccount(schoolHuman.getUsername());//賬號
schoollog.setOperateusername(schoolHuman.getHumanName());//用戶姓名
schoollog.setIpaddress(ip);
schoollog.setIpaddressname(urlAddress);
if (((Result) res).getCode() == 200) {
schoollog.setExecuteresult(0);
schoollog.setDescription("成功");
} else {
schoollog.setExecuteresult(1);
}
// 調用service保存SysLog實體類到數據庫
int i = schoolLogMapper.insertSelective(schoollog);
log.info(">>>>>>>>>>>>日志AOP結束<<<<<<<<<<<<");
}
} catch (Exception e) {
schoollog.setBrowser(info);
schoollog.setLogid(String.valueOf(snowFlake.nextId()));//id
schoollog.setIpaddress(ip);
schoollog.setOperatetime(new Date());//操作時間
if (!ObjectUtils.isEmpty(schoolHuman)) {
schoollog.setOperateuserid(String.valueOf(schoolHuman.getHumanId()));//用戶id
schoollog.setOperateaccount(schoolHuman.getUsername());//賬號
schoollog.setOperateusername(schoolHuman.getHumanName());//用戶姓名
}
schoollog.setIpaddress(ip);
schoollog.setIpaddressname(urlAddress);
schoollog.setExecuteresult(1);
schoollog.setDescription("異常");
int i = schoolLogMapper.insertSelective(schoollog);
log.info(">>>>>>>>>>>>日志AOP異常<<<<<<<<<<<<");
}
}
private String getIpAddr(HttpServletRequest request) {
String ip = request.getHeader("x-forwarded-for");
if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("Proxy-Client-IP");
}
if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("WL-Proxy-Client-IP");
}
if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
ip = request.getRemoteAddr();
}
return ip;
}
}
4.查詢日志
5，給需要在系統管理模塊展示的操作的類上加注解
@SystemControllerLog(module="停用帳號",actionType="2",categoryId=3)
注意：一定要加
6.結果
