1. 背景描述
通常我们在项目中，都需要打印日志，方便系统的维护和排查错误的需要，如下所示。
@Service public class PredictService { private static final Logger LOGGER = LoggerFactory.getLogger(PredictController.class); public Response intent(IntentPredictVO vo) { LOGGER.info("意图预测入口，robotId：{}，questionId：{}， question：{}", vo.getRobotId(),vo.getQuestionId(), vo.getQuestion()); Response<IntentPredictDTO> dto = ...; LOGGER.info("意图预测返回，robotId：{}，questionId：{}， question：{}，结果：{}", vo.getQuestionId(), vo.getQuestion(), JSONObject.toJSONString(dto)); return Response.success(dto); } public Response nextintents(NextIntentPredictVO vo) { LOGGER.info("下一个意图预测入口，robotId：{}，questionId：{}， question：{}", vo.getRobotId(),vo.getQuestionId(), vo.getQuestion()); Response<NextIntentPredictDTO> process = ...; LOGGER.info("下一个意图预测返回，robotId：{}，questionId：{}， question：{}，结果：{}", vo.getQuestionId(), vo.getQuestion(), JSONObject.toJSONString(process.getData())); return process; } ... } 复制代码
从上面的代码，我们发现一个问题，其实基本都是重复的日志代码，让系统看着特别臃肿，接下来我们就讲解如何通过Spring AOP(代理模式-动态代理)来改善上面的情况，让系统更加简洁。
什么是代理模式？
通过代理控制对对象的访问，可以详细控制访问某个（某类）对象的方法，在调用这个方法之前做前置处理，调用这个方法后做后置处理。
真实角色--定义真实角色所要实现的业务逻辑，供代理角色调用。关注真正的业务逻辑。（相当于明星）
代理角色--是真实角色的代理，通过真实角色的业务逻辑方法实现抽象方法，并可以附加自己的操作。将统一的流程控制放到代理角色中处理。（相当于经纪人）
下面我们就用Spring AOP来改造日志，进行统一处理。
2. 编写拦截规则的注解
@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface PredictLog { String value() default ""; } 复制代码
3. 编写使用注解的被拦截类（真实角色）
@Service public class PredictService{ @PredictLog("意图预测") public Response intent(IntentPredictVO vo) { Response<IntentPredictDTO> dto = ...; return Response.success(dto); } @PredictLog("下一个意图预测") public Response nextintents(NextIntentPredictVO vo) { Response<NextIntentPredictDTO> process = ...; return process; } ... } 复制代码
4. 编写切面-动态代理（代理角色：核心方法做统一的流程控制）
注意：
- 上面的NextIntentPredictVO 和IntentPredictVO 都是继承RobotQuestionVO。
- 这里简单理解成代理角色（Spring内部使用CGLIB代理或JDK动态代理动态生成代理类和对象）
@Aspect @Component @Slf4j public class PredictLogAop { @Pointcut("@annotation(predictLog)") public void predictLogCut(PredictLog predictLog) { } @Around("predictLogCut(predictLog)") public Object predictLogCutAround(ProceedingJoinPoint pjp, PredictLog predictLog) throws Throwable { String businessName = predictLog.value(); RobotQuestionVO robotQuestion = null; Object[] args = pjp.getArgs(); if (args.length > 0) { String params = JSONObject.toJSONString(args[0]); robotQuestion = JSONObject.parseObject(params, RobotQuestionVO.class); log.info("{}入口， 请求参数: {} .", businessName, JSONObject.toJSONString(robotQuestion)); } // 执行方法 Object result = pjp.proceed(); log.info("{}返回， 请求参数: {}，结果: {} .", businessName, JSONObject.toJSONString(robotQuestion), JSONObject.toJSONString(result)); return result; } } 复制代码
5. 运行结果
public class main { public static void main(String[] args) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AopApplication.class); PredictService predictService = context.getBean(PredictService.class); predictService.intent(); predictService.nextintents(); } } 复制代码
结果如下:
意图预测入口， 请求参数: {"question":"我的贷款还未审核","questionId":"C875FFC0C66B2DF1D725A0BCC905EA28_2","robotId":"xxxx"} .
...(真正的业务逻辑)
意图预测返回， 请求参数: {"question":"我的贷款还未审核","questionId":"C875FFC0C66B2DF1D725A0BCC905EA28_2","robotId":"xxxx"}， 结果: {"code":"10000","message":"ok"} .
下一个意图预测入口， 请求参数: {"question":"我的贷款还未审核","questionId":"C875FFC0C66B2DF1D725A0BCC905EA28_2","robotId":"xxxx"} .
...(真正的业务逻辑)
下一个意图预测返回， 请求参数: {"question":"我的贷款还未审核","questionId":"C875FFC0C66B2DF1D725A0BCC905EA28_2","robotId":"xxxx"}， 结果: {"code":"10000","message":"ok"} .
6. 总结
代理模式给我们带来的好处:
- 可以使真实角色操作更加纯粹, 不用去关心一些闲杂的事情。
- 闲杂事情让代理去做,实现业务的分工。
- 当闲杂事情发生变化的时候, 真实角色是不用去管的, 代理角色去管就行, 这样就方便各角色的集中管理。
本文通过Spring AOP将日志代码抽离，基于注解实现打印重复日志，简化了系统。
