ホームページ >Java >&#&チュートリアル >SpringBoot が AOP を使用してインターフェイス操作ログを記録する方法
1. AOP とは
AOP: アスペクト指向プログラミング
AOP は A には焦点を当てません特定のクラスまたは特定のメソッド; 多数のリソースを制御し、多数のクラスとメソッドに焦点を当てます。
2.AOP アプリケーションのシナリオと共通用語
権限制御、キャッシュ制御、トランザクション制御、分散トレース、例外処理
ターゲット: ターゲット クラス、つまり、プロキシする必要があるクラス。例: UserService
Joinpoint: いわゆる接続ポイントは、インターセプトされる可能性のあるメソッドを指します。例: すべてのメソッド
PointCut ポイントカット: 拡張された接続ポイント。例: addUser()
アドバイス通知/拡張、コードを拡張します。例: after、before
Weaving (ウィービング): 拡張アドバイスをターゲット オブジェクト target に適用して、新しいプロキシ オブジェクト proxy を作成するプロセスを指します。
側面: ポイントカットと通知アドバイスの組み合わせです
3. AOP の特徴
1)モジュール間の結合を強化し、ビジネスコードの集約を改善します。 (高い凝集性と低い結合性)
2) コードの再利用性の向上
3) システムのスケーラビリティの向上。 (上位バージョンは下位バージョンと互換性があります)
#4) 元の機能に影響を与えることなく新しい機能を追加できます##2. SpringBoot は AOP を使用してプロセスを実装します
<!-- Spring AOP --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>2.ログ エンティティ クラスをカプセル化する
@Getter @Setter @ApiModel(value = "Systemlog对象", description = "") public class Systemlog implements Serializable { private static final long serialVersionUID = 1L; @ApiModelProperty("ID") @TableId(value = "id", type = IdType.AUTO) private Integer id; @ApiModelProperty("用户名") private String userName; @ApiModelProperty("用户ID") private Integer userId; @ApiModelProperty("操作描述") private String operate; @ApiModelProperty("模块") private String module; @ApiModelProperty("创建日志时间") @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") private Date createTime; @ApiModelProperty("操作结果") private String result; }3.アノテーション クラスを記述する(カスタム ログ アノテーションclass)
/** * controller层切面日志注解 * @author hsq */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface SystemControllerLog { // 操作描述 String operate(); // 模块 String module(); }4.操作ログのアスペクトクラスを記述します
** * @author hsq */ @Aspect @Component public class SystemLogAspect { private static final Logger logger = LoggerFactory.getLogger(SystemLogAspect.class); @Autowired private ISystemlogService iSystemlogService; @Autowired private UserService userService; /** * Controller层切点 */ @Pointcut("@annotation(com.hsq.demo.config.SystemControllerLog)") public void SystemControllerLog(){ } /** * 前置通知 用于拦截Controller层记录用户的操作的开始时间 * @param joinPoint 切点 * @throws InterruptedException */ @Before("SystemControllerLog()") public void doBefore(JoinPoint joinPoint) throws InterruptedException{ logger.info("进入日志切面前置通知!"); } @After("SystemControllerLog()") public void doAfter(JoinPoint joinPoint) { logger.info("进入日志切面后置通知!"); } /**value切入点位置 * returning 自定义的变量,标识目标方法的返回值,自定义变量名必须和通知方法的形参一样 * 特点:在目标方法之后执行的,能够获取到目标方法的返回值,可以根据这个返回值做不同的处理 */ @AfterReturning(value = "SystemControllerLog()", returning = "ret") public void doAfterReturning(Object ret) throws Throwable { } /*** * 异常通知 记录操作报错日志 * * @param joinPoint * * @param e * */ @AfterThrowing(pointcut = "SystemControllerLog()", throwing = "e") public void doAfterThrowing(JoinPoint joinPoint, Throwable e) { logger.info("进入日志切面异常通知!!"); logger.info("异常信息:" + e.getMessage()); } //使用这个方法先注释前面三个方法,留before方法就行 /** * 通知包裹了目标方法,在目标方法调用之前和之后执行自定义的行为 * ProceedingJoinPoint切入点可以获取切入点方法上的名字、参数、注解和对象 * @param joinPoint */ @Around("SystemControllerLog() && @annotation(systemControllerLog)") public Result doAfterReturning(ProceedingJoinPoint joinPoint, SystemControllerLog systemControllerLog) throws Throwable { logger.info("设置日志信息存储到表中!"); //joinPoint.proceed() 结果集 //参数数组 Object[] args = joinPoint.getArgs(); //请求参数数据 String requestJson = JSONUtil.toJsonStr(args); //方法名 String methodName = joinPoint.getSignature().getName(); //得到request HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest(); //得到token String token = request.getHeader("token"); String userId = JWT.decode(token).getAudience().get(0); User user = userService.getById(userId); logger.info("得到用户信息:"+user.toString()); //写入数据库操作日志 Systemlog systemlog = new Systemlog(); systemlog.setUserId(user.getUid()); systemlog.setUserName(user.getUname()); systemlog.setOperate(systemControllerLog.operate()); systemlog.setModule(systemControllerLog.module()); systemlog.setCreateTime(new Date()); //存入返回的结果集 joinPoint.proceed() Result proceed = (Result) joinPoint.proceed(); systemlog.setResult(JSONUtil.toJsonStr(joinPoint.proceed())); //保存 saveSystemLog(systemlog); return proceed; } }5.コントローラーを使用します
@GetMapping("/userListPage") @SystemControllerLog(operate = "用户查询",module = "用户管理") public Result findUserList( @RequestParam Integer pageNum, @RequestParam Integer pageSize, @RequestParam String username, @RequestParam String loveValue, @RequestParam String address) {} @PostMapping("/addOrUpdate") @SystemControllerLog(operate = "用户修改或者添加",module = "用户管理") public Result addOrUpdateUser(@RequestBody User user){}6. データベースレコード
以上がSpringBoot が AOP を使用してインターフェイス操作ログを記録する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。