Spring AOP如何实现简单的日志切面

本篇文章给大家分享的是有关Spring AOP如何实现简单的日志切面，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。

AOP

1.什么是 AOP ？

AOP 的全称为 Aspect Oriented Programming，译为面向切面编程，是通过预编译方式和运行期动态代理实现核心业务逻辑之外的横切行为的统一维护的一种技术。AOP 是面向对象编程（OOP）的补充和扩展。 利用 AOP 可以对业务逻辑各部分进行隔离，从而达到降低模块之间的耦合度，并将那些影响多个类的公共行为封装到一个可重用模块，从而到达提高程序的复用性，同时提高了开发效率，提高了系统的可操作性和可维护性。

2.为什么要用 AOP ？

在实际的 Web 项目开发中，我们常常需要对各个层面实现日志记录，性能统计，安全控制，事务处理，异常处理等等功能。如果我们对每个层面的每个类都独立编写这部分代码，那久而久之代码将变得很难维护，所以我们把这些功能从业务逻辑代码中分离出来，聚合在一起维护，而且我们能灵活地选择何处需要使用这些代码。

3.AOP 的核心概念

Spring AOP

1.简介

AOP 是 Spring 框架中的一个核心内容。在 Spring 中，AOP 代理可以用 JDK 动态代理或者 CGLIB 代理 CglibAopProxy 实现。Spring 中 AOP 代理由 Spring 的 IOC 容器负责生成和管理，其依赖关系也由 IOC 容器负责管理。

2.相关注解

利用 AOP 实现 Web 日志处理

1.构建项目

2.添加依赖

                                        org.springframework.boot                        spring-boot-starter-web                                                        org.springframework.boot                        spring-boot-starter-test                        test                                                                        org.springframework.boot                        spring-boot-devtools                        true                                                                         org.springframework.boot                        spring-boot-starter-aop                        

3.Web 日志注解

@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)public @interface ControllerWebLog {         String name();//所调用接口的名称     boolean intoDb() default false;//标识该条操作日志是否需要持久化存储}

4.实现切面逻辑

@Aspect@Component@Order(100)public class WebLogAspect {        private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);        private ThreadLocal> threadLocal = new ThreadLocal>();        /**         * 横切点         */        @Pointcut("execution(public * cn.zwqh.springboot.controller..*.*(..))")        public void webLog() {        }        /**         * 接收请求，并记录数据         * @param joinPoint         * @param controllerWebLog         */        @Before(value = "webLog()&& @annotation(controllerWebLog)")        public void doBefore(JoinPoint joinPoint, ControllerWebLog controllerWebLog) {                // 接收到请求                RequestAttributes ra = RequestContextHolder.getRequestAttributes();                ServletRequestAttributes sra = (ServletRequestAttributes) ra;                HttpServletRequest request = sra.getRequest();                // 记录请求内容，threadInfo存储所有内容                Map 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("执行方法：" + controllerWebLog.name());                threadInfo.put("methodName", controllerWebLog.name());                threadLocal.set(threadInfo);        }        /**         * 执行成功后处理         * @param controllerWebLog         * @param ret         * @throws Throwable         */        @AfterReturning(value = "webLog()&& @annotation(controllerWebLog)", returning = "ret")        public void doAfterReturning(ControllerWebLog controllerWebLog, Object ret) throws Throwable {                Map threadInfo = threadLocal.get();                threadInfo.put("result", ret);                if (controllerWebLog.intoDb()) {                        //插入数据库操作                        //insertResult(threadInfo);                }                // 处理完请求，返回内容                logger.info("RESPONSE : " + ret);        }        /**         * 获取执行时间         * @param proceedingJoinPoint         * @return         * @throws Throwable         */        @Around(value = "webLog()")        public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {                long startTime = System.currentTimeMillis();                Object ob = proceedingJoinPoint.proceed();                Map threadInfo = threadLocal.get();                Long takeTime = System.currentTimeMillis() - startTime;                threadInfo.put("takeTime", takeTime);                logger.info("耗时：" + 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("{}接口调用异常，异常信息{}", request.getRequestURI(), throwable);        }}

5.测试接口

@RestController@RequestMapping("/user")public class UserController {        @GetMapping("/getOne")        @ControllerWebLog(name = "查询", intoDb = true)        public String getOne(Long id, String name) {                return "1234";        }}

6.运行测试

浏览器请求：http://127.0.0.1:8080/user/getOne?id=1&name=zwqh ，可以看到后台日志输出：

日志记录只是一个简单的示例，而 Spring AOP 的应用让整个系统变的更加有条不紊，在其他场景应用也很强大。 它帮助我们降低模块间耦合度，提高程序复用性，提高开发效率，提高系统可做性和可维护性。

以上就是Spring AOP如何实现简单的日志切面，小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注行业资讯频道。