[技術博客] SPRINGBOOT自定義注解

SPRINGBOOT自定義注解

在springboot中，有各種各樣的注解，這些注解能夠簡化我們的配置，提高開發效率。一般來說，springboot提供的注解已經佷豐富了，但如果我們想針對某個特定情景來添加注解，就可以使用自定義注解。

自定義注解的步驟

實現這個自定義注解一般主要有以下幾個步驟。

• maven導入相關的依賴
• 聲明注解
• 注解的具體實現
• 使用注解的實例

在phyweb項目中的應用

之所以會想到這個自定義注解，是因為我們在給用戶發送郵件這個模塊中，用戶如果提交了請求，提交按鈕被禁用，這個時候用戶如果刷新頁面的話，這仍然是一條post請求，而后面的這條請求我們不應該處理，而是提醒用戶已經發送了。

• 引入相關依賴

	 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
     </dependency>

     <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>21.0</version>
     </dependency>

• 聲明自定義注解

	@Target(ElementType.METHOD)
	@Retention(RetentionPolicy.RUNTIME)
	@Documented
	@Inherited
	public @interface LocalLock {
	    String key() default "";
	    int expire() default 5;
	}

• 注解實現

	@Aspect
	@Configuration
	public class LockMethodInterceptor {
	
	    private static final Cache<String, Object> CACHES = CacheBuilder.newBuilder()
	            // 最大緩存 100 個
	            .maximumSize(1000)
	            // 設置寫緩存后 60 秒鍾過期
	            .expireAfterWrite(60, TimeUnit.SECONDS)
	            .build();
	
	    @Around("execution(public * *(..)) && @annotation(com.buaabetatwo.phyweb.annotation.LocalLock)")
	    public Object interceptor(ProceedingJoinPoint pjp) {
	        myToken = 1;
	        MethodSignature signature = (MethodSignature) pjp.getSignature();
	        Method method = signature.getMethod();
	        LocalLock localLock = method.getAnnotation(LocalLock.class);
	        String key = getKey(localLock.key(), pjp.getArgs());
	        if (!StringUtils.isEmpty(key)) {
	            if (CACHES.getIfPresent(key) != null) {
	                myToken = 0;
	                // throw new RuntimeException("請勿重復請求");
	            }
	            // 如果是第一次請求,就將 key 當前對象壓入緩存中
	            CACHES.put(key, key);
	        }
	
	        try {
	            return pjp.proceed();
	        } catch (Throwable throwable) {
	            throw new RuntimeException("服務器異常");
	        } finally {
	            // CACHES.invalidate(key)
	        }
	    }
	
	
	    private String getKey(String keyExpress, Object[] args) {
	        for (int i = 0; i < args.length; i++) {
	            keyExpress = keyExpress.replace("arg[" + i + "]", args[i].toString());
	        }
	        return keyExpress;
	    }

• 使用注解

	@LocalLock(key = "myToken")  //
    @PostMapping("/reset-email")
    public String postResetEmail(String email, Model model) {
    }

經過以上四個步驟，我們的自定義注解LocalLock就大功告成了，當用戶打開密碼找回頁面，輸入郵箱后，60秒內再次刷新頁面會被攔截掉，也就是不會出現重復提交表單的情況了。如下圖所示。