使用自定義註解+Spring切面 實現日誌記錄

在平常的專案程式設計中,我們會經常使用到日誌,用來記錄各種事件.但是,有些日誌記錄套路實在是太像了,我們不得不要寫很多遍.

比如在Spring中,我們要使用日誌記錄每個controller的訪問和結束時間,該怎麼辦呢.

下面是我認為比較簡單的一種方法: 自定義註解+Spring切面 .

下面使用SpringBoot快速搭建一個專案來進行演示.具體pom檔案檢視原始碼

1. 建立一個Controller:

@RestController
public class HelloController {


    @RequestMapping
 
("/hello")
    @LoggerManage(logDescription = "hello")
    public String hello() {
        return "hello";
    }

    @RequestMapping("/login/{username}/{password}")
    @LoggerManage(logDescription = "登陸")
    public String login(@PathVariable("username") String username,
                        @PathVariable
 
("password") String password ) {
        return "登陸成功";


    }


}

我們要在controller的方法 hello() 上使用自定義註解以便AOP進行捕獲

1. 自定義一個註解: LoggerManage

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LoggerManage {

    public String logDescription();
}

這個註解很簡單隻有一個對方法的描述.並且這是一個方法級別的註解.

1. 建立切面

/**
 * 日誌切面
 *
 * @author itguang
 * @create 2017-12-09 9:18
 **/
@Aspect
@Component
public class LoggerAdvice {
    private Logger logger = Logger.getLogger(this.getClass());

    @Before("within(com.itguang.springbootaop..*) && @annotation(loggerManage)")
    public void addBeforeLogger(JoinPoint joinPoint, LoggerManage loggerManage) {
        LocalDateTime now = LocalDateTime.now();

        logger.info(now.toString()+"執行[" + loggerManage.logDescription() + "]開始");
        logger.info(joinPoint.getSignature().toString());

        logger.info(parseParames(joinPoint.getArgs()));

    }

    @AfterReturning("within(com.itguang.springbootaop..*) && @annotation(loggerManage)")
    public void addAfterReturningLogger(JoinPoint joinPoint, LoggerManage loggerManage) {
        LocalDateTime now = LocalDateTime.now();
        logger.info(now.toString()+"執行 [" + loggerManage.logDescription() + "] 結束");
    }

    @AfterThrowing(pointcut = "within(com.itguang.springbootaop..*) && @annotation(loggerManage)", throwing = "ex")
    public void addAfterThrowingLogger(JoinPoint joinPoint, LoggerManage loggerManage, Exception ex) {
        LocalDateTime now = LocalDateTime.now();
        logger.error(now.toString()+"執行 [" + loggerManage.logDescription() + "] 異常", ex);
    }

    private String parseParames(Object[] parames) {

        if (null == parames || parames.length <= 0) {
            return "";

        }
        StringBuffer param = new StringBuffer("傳入引數 # 個:[ ");
        int i =0;
        for (Object obj : parames) {
            i++;
            if (i==1){
                param.append(obj.toString());
                continue;
            }
            param.append(" ,").append(obj.toString());
        }
        return param.append(" ]").toString().replace("#",String.valueOf(i));
    }


}

需要注意的是我們需要把建立的切面類標識為一個Spring可管理的Bean. 即新增@Component 註解或@Service註解都可以.

通過 JoinPoint 我們可以可到切入點的很多資訊,包括全限定名,和引數

within(): 限制連線點指定匹配的型別.

測試

現在我們的工作就做完了,我們測試下

檢視日誌輸出:

: 2017-12-09T10:45:38.194執行[hello]開始
: String com.itguang.springbootaop.web.HelloController.hello()
: 2017-12-09T10:45:38.196執行 [hello] 結束

再次檢視日誌輸出:

2017-12-09T10:54:15.516執行[登陸]開始
 String com.itguang.springbootaop.web.HelloController.login(String,String)
傳入引數 2 個:[ itguang ,123456 ]
2017-12-09T10:54:15.522執行 [登陸] 結束

之後,我們如果想記錄某個Controller裡方法的執行情況,就可以在方法上新增此註解就可以了,怎麼樣?是不是很優雅呢.