記事ディレクトリ
私は以前、ロギングにSpring AOPを使用してブログを書いたことがあります。
このブログでは、Spring AOPテクノロジーを使用して、アプリケーション内のすべてのコントローラーをクロスカットし、コントローラーにアクセスするためのすべてのリクエストがログに記録されます。
しかし、実際の毎日の生産では、すべてのアクセスを記録するのではなく、AOPのエントリポイントを区別する必要があるいくつかの特別なリクエストを記録します。
Javaアノテーションを使用してコントローラーを区別でき、Spring AOPはアノテーションのエントリーポイントもサポートします。
プロジェクト環境を構築する
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.4.RELEASE</version>
</parent>
<dependencies>
<!--SpringMVC的启动器依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--Spring整合junit测试的启动器依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--Spring AOP的启动器依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!--lombck的依赖,用于生产getter和setter方法-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--MyBatisPlus的启动器依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
データベースログテーブルを作成する
CREATE TABLE `log` (
`id` int(10) NOT NULL AUTO_INCREMENT,
`visit_time` datetime DEFAULT NULL,
`username` varchar(20) DEFAULT NULL,
`ip` varchar(20) DEFAULT NULL,
`uri` varchar(50) DEFAULT NULL,
`method` varchar(100) DEFAULT NULL,
`execution_time` bigint(20) DEFAULT NULL,
`exception_name` varchar(50) DEFAULT NULL,
`exception_message` varchar(20) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=19 DEFAULT CHARSET=utf8;
ログエンティティクラスを作成する
@Data
@TableName("log")
public class Log {
@TableId(type = IdType.AUTO)
private Long id;
private Date visitTime;
private String username;
private String ip;
private String uri;
private String method;
private Long executionTime;
private String exceptionName;
private String exceptionMessage;
}
ロギングノートを作成する
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogAnnotation {
}
コントローラーレイヤーインターフェイスの書き込み
- コントローラーレイヤーのインターフェイスメソッドは、SpringBoot + MyBatisPlusブログによって構築されたプロジェクト環境に基づいて構築されています。
@RestController
@RequestMapping("user")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("page/{currentPage}")
public ResponseEntity<IPage<User>> findUserByPage(
@PathVariable("currentPage") Integer currentPage,
@RequestParam(defaultValue = "5") Integer size) throws Exception {
return ResponseEntity.ok(userService.findUserByPage(currentPage, size));
}
@PostMapping("add")
public ResponseEntity<Void> saveUser(User user) throws Exception {
userService.saveUser(user);
return ResponseEntity.status(HttpStatus.OK).build();
}
@LogAnnotation
@DeleteMapping("{id}")
public ResponseEntity<Void> delUserById(@PathVariable("id") Integer id) throws Exception {
userService.delUserById(id);
return ResponseEntity.status(HttpStatus.OK).build();
}
@LogAnnotation
@PutMapping("update")
public ResponseEntity<Void> updateUser(User user) throws Exception {
userService.updateUser(user);
return ResponseEntity.status(HttpStatus.OK).build();
}
}
AOPアスペクトクラスの記述
@Aspect
@Component
public class LogAop {
@Autowired
private HttpServletRequest request;
@Autowired
private LogDao logDao;
private Log log;
//切入点中的值使用@annotation,表示这是一个注解切入点,凡是被该注解标识的方法,都会被AOP切入
@Pointcut("@annotation(com.hrp.annotation.LogAnnotation)")
public void controllerAOP(){}
@Before("controllerAOP()")
public void doBefore(){
log = new Log();
log.setVisitTime(new Date());
}
@After("controllerAOP()")
public void doAfter(JoinPoint joinPoint){
log.setExecutionTime(System.currentTimeMillis() - log.getVisitTime().getTime());
log.setIp(request.getRemoteAddr());
log.setUri(request.getRequestURI());
log.setMethod("[类名]"+joinPoint.getTarget().getClass()+"[方法名]"+joinPoint.getSignature().getName());
}
@AfterReturning("controllerAOP()")
public void doAfterReturning(){
logDao.insert(log);
}
@AfterThrowing(value = "controllerAOP()",throwing = "e")
public void doException(Exception e){
log.setExceptionName(e.getClass().getName());
log.setExceptionMessage(e.getMessage());
logDao.insert(log);
}
}
機能テスト
プロジェクトを開始し、コントローラーレイヤーの4つのパスにアクセスすると、結果は次のようになります。
RUI | コメントするかどうか | AOPは割り込んでいますか |
---|---|---|
/ user / page / {currentPage} | いいえ | いいえ |
/ user / add | いいえ | いいえ |
/ユーザーID} | はい | はい |
/ user / update | はい | はい |