Spring AOP如何實(shí)現(xiàn)簡(jiǎn)單的日志切面

本篇文章給大家分享的是有關(guān)Spring AOP如何實(shí)現(xiàn)簡(jiǎn)單的日志切面，小編覺(jué)得挺實(shí)用的，因此分享給大家學(xué)習(xí)，希望大家閱讀完這篇文章后可以有所收獲，話(huà)不多說(shuō)，跟著小編一起來(lái)看看吧。

AOP

1.什么是 AOP ？

AOP 的全稱(chēng)為 Aspect Oriented Programming，譯為面向切面編程，是通過(guò)預(yù)編譯方式和運(yùn)行期動(dòng)態(tài)代理實(shí)現(xiàn)核心業(yè)務(wù)邏輯之外的橫切行為的統(tǒng)一維護(hù)的一種技術(shù)。AOP 是面向?qū)ο缶幊蹋∣OP）的補(bǔ)充和擴(kuò)展。 利用 AOP 可以對(duì)業(yè)務(wù)邏輯各部分進(jìn)行隔離，從而達(dá)到降低模塊之間的耦合度，并將那些影響多個(gè)類(lèi)的公共行為封裝到一個(gè)可重用模塊，從而到達(dá)提高程序的復(fù)用性，同時(shí)提高了開(kāi)發(fā)效率，提高了系統(tǒng)的可操作性和可維護(hù)性。

2.為什么要用 AOP ？

在實(shí)際的 Web 項(xiàng)目開(kāi)發(fā)中，我們常常需要對(duì)各個(gè)層面實(shí)現(xiàn)日志記錄，性能統(tǒng)計(jì)，安全控制，事務(wù)處理，異常處理等等功能。如果我們對(duì)每個(gè)層面的每個(gè)類(lèi)都獨(dú)立編寫(xiě)這部分代碼，那久而久之代碼將變得很難維護(hù)，所以我們把這些功能從業(yè)務(wù)邏輯代碼中分離出來(lái)，聚合在一起維護(hù)，而且我們能靈活地選擇何處需要使用這些代碼。

3.AOP 的核心概念

Spring AOP

1.簡(jiǎn)介

AOP 是 Spring 框架中的一個(gè)核心內(nèi)容。在 Spring 中，AOP 代理可以用 JDK 動(dòng)態(tài)代理或者 CGLIB 代理 CglibAopProxy 實(shí)現(xiàn)。Spring 中 AOP 代理由 Spring 的 IOC 容器負(fù)責(zé)生成和管理，其依賴(lài)關(guān)系也由 IOC 容器負(fù)責(zé)管理。

2.相關(guān)注解

利用 AOP 實(shí)現(xiàn) Web 日志處理

1.構(gòu)建項(xiàng)目

2.添加依賴(lài)

<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<!-- 熱部署模塊 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
			<optional>true</optional> <!-- 這個(gè)需要為 true 熱部署才有效 -->
		</dependency>
		<!-- Spring AOP -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-aop</artifactId>
		</dependency>
	</dependencies>

3.Web 日志注解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ControllerWebLog {
	 String name();//所調(diào)用接口的名稱(chēng)
     boolean intoDb() default false;//標(biāo)識(shí)該條操作日志是否需要持久化存儲(chǔ)
}

4.實(shí)現(xiàn)切面邏輯

@Aspect
@Component
@Order(100)
public class WebLogAspect {

	private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);

	private ThreadLocal<Map<String, Object>> threadLocal = new ThreadLocal<Map<String, Object>>();

	/**
	 * 橫切點(diǎn)
	 */
	@Pointcut("execution(public * cn.zwqh.springboot.controller..*.*(..))")
	public void webLog() {
	}
	/**
	 * 接收請(qǐng)求，并記錄數(shù)據(jù)
	 * @param joinPoint
	 * @param controllerWebLog
	 */
	@Before(value = "webLog()&& @annotation(controllerWebLog)")
	public void doBefore(JoinPoint joinPoint, ControllerWebLog controllerWebLog) {
		// 接收到請(qǐng)求
		RequestAttributes ra = RequestContextHolder.getRequestAttributes();
		ServletRequestAttributes sra = (ServletRequestAttributes) ra;
		HttpServletRequest request = sra.getRequest();
		// 記錄請(qǐng)求內(nèi)容，threadInfo存儲(chǔ)所有內(nèi)容
		Map<String, Object> threadInfo = new HashMap<>();
		logger.info("URL : " + request.getRequestURL());
		threadInfo.put("url", request.getRequestURL());
		logger.info("URI : " + request.getRequestURI());
		threadInfo.put("uri", request.getRequestURI());
		logger.info("HTTP_METHOD : " + request.getMethod());
		threadInfo.put("httpMethod", request.getMethod());
		logger.info("REMOTE_ADDR : " + request.getRemoteAddr());
		threadInfo.put("ip", request.getRemoteAddr());
		logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
				+ joinPoint.getSignature().getName());
		threadInfo.put("classMethod",
				joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
		logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
		threadInfo.put("args", Arrays.toString(joinPoint.getArgs()));
		logger.info("USER_AGENT"+request.getHeader("User-Agent"));
		threadInfo.put("userAgent", request.getHeader("User-Agent"));
		logger.info("執(zhí)行方法：" + controllerWebLog.name());
		threadInfo.put("methodName", controllerWebLog.name());
		threadLocal.set(threadInfo);
	}
	/**
	 * 執(zhí)行成功后處理
	 * @param controllerWebLog
	 * @param ret
	 * @throws Throwable
	 */
	@AfterReturning(value = "webLog()&& @annotation(controllerWebLog)", returning = "ret")
	public void doAfterReturning(ControllerWebLog controllerWebLog, Object ret) throws Throwable {
		Map<String, Object> threadInfo = threadLocal.get();
		threadInfo.put("result", ret);
		if (controllerWebLog.intoDb()) {
			//插入數(shù)據(jù)庫(kù)操作
			//insertResult(threadInfo);
		}
		// 處理完請(qǐng)求，返回內(nèi)容
		logger.info("RESPONSE : " + ret);
	}
	/**
	 * 獲取執(zhí)行時(shí)間
	 * @param proceedingJoinPoint
	 * @return
	 * @throws Throwable
	 */
	@Around(value = "webLog()")
	public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
		long startTime = System.currentTimeMillis();
		Object ob = proceedingJoinPoint.proceed();
		Map<String, Object> threadInfo = threadLocal.get();
		Long takeTime = System.currentTimeMillis() - startTime;
		threadInfo.put("takeTime", takeTime);
		logger.info("耗時(shí)：" + takeTime);
		threadLocal.set(threadInfo);
		return ob;
	}
	/**
	 * 異常處理
	 * @param throwable
	 */
	@AfterThrowing(value = "webLog()", throwing = "throwable")
	public void doAfterThrowing(Throwable throwable) {
		RequestAttributes ra = RequestContextHolder.getRequestAttributes();

		ServletRequestAttributes sra = (ServletRequestAttributes) ra;

		HttpServletRequest request = sra.getRequest();
		// 異常信息
		logger.error("{}接口調(diào)用異常，異常信息{}", request.getRequestURI(), throwable);
	}

}

5.測(cè)試接口

@RestController
@RequestMapping("/user")
public class UserController {

	@GetMapping("/getOne")
	@ControllerWebLog(name = "查詢(xún)", intoDb = true)
	public String getOne(Long id, String name) {

		return "1234";
	}
}

6.運(yùn)行測(cè)試

瀏覽器請(qǐng)求：http://127.0.0.1:8080/user/getOne?id=1&name=zwqh ，可以看到后臺(tái)日志輸出：

日志記錄只是一個(gè)簡(jiǎn)單的示例，而 Spring AOP 的應(yīng)用讓整個(gè)系統(tǒng)變的更加有條不紊，在其他場(chǎng)景應(yīng)用也很強(qiáng)大。 它幫助我們降低模塊間耦合度，提高程序復(fù)用性，提高開(kāi)發(fā)效率，提高系統(tǒng)可做性和可維護(hù)性。

以上就是Spring AOP如何實(shí)現(xiàn)簡(jiǎn)單的日志切面，小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘９ぷ鲿?huì)見(jiàn)到或用到的。希望你能通過(guò)這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注億速云行業(yè)資訊頻道。