SpringBoot自定义注解作为starter引入pom

 

在我们项目开发工程中大多时候会遇到一些公共的程序代码需要进行集成使用，比如使用一个注解来定义在方法上，当进入该方法时我们可以记录一些日志信息，该日志信息可以记录进入该方法的时间及离开的时间，以及一些参数的验证，下面主要介绍使用拦截器的方式来实现一个注解，通过拦截器来判断如果方法上使用了该注解，那么我们记录进入、离开以及在该方法的执行时长的日志记录。

1.我们创建一个自定义项目取名为testAnnotation，注意的是我这里创建的是pom项目，生成的基本pom文件内容是:

 

<groupId>testAnnotation</groupId>
<artifactId>testAnnotation</artifactId>
<version>1.0-SNAPSHOT</version>

 

 

2.引入SpringBoot相关的配置

 

   <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.7.RELEASE</version>
    </parent>

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

 因为这里使用的是拦截器，所以必须引入spring-boot-starter-web。

 

 

3.创建一个用于测试的注解LoggerAnnotation的注解类

 

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author liaoyubo
 * @version 1.0 2017/9/14
 * @description 自定义一个注解
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LoggerAnnotation {
}

 

 

4.创建一个拦截器类LoggerInterceptor，该类继承自HandlerInterceptorAdapter，用于处理调用注解后的方法的日志记录。

 

import com.annotation.log.LoggerAnnotation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;

/**
 * @author liaoyubo
 * @version 1.0 2017/9/14
 * @description 通过拦截器的方式实现自定义的日志记录
 */
public class LoggerInterceptor extends HandlerInterceptorAdapter{

    private Logger logger = LoggerFactory.getLogger(LoggerInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        Method method = handlerMethod.getMethod();
        //获取当前方法上的指定注解
        LoggerAnnotation loggerAnnotation = method.getAnnotation(LoggerAnnotation.class);
        //判断当前注解是否存在
        if(loggerAnnotation != null){
            long startTime = System.currentTimeMillis();
            request.setAttribute("startTime",startTime);
            logger.info("进入" + method.getName() + "方法的时间是：" + startTime);
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        Method method = handlerMethod.getMethod();
        //获取当前方法上的指定注解
        LoggerAnnotation loggerAnnotation = method.getAnnotation(LoggerAnnotation.class);
        //判断当前注解是否存在
        if(loggerAnnotation != null){
            long endTime = System.currentTimeMillis();
            long startTime = (Long) request.getAttribute("startTime");
            long periodTime = endTime - startTime;
            logger.info("离开" + method.getName() + "方法的时间是：" + endTime);
            logger.info("在" + method.getName() + "方法的时长是：" + periodTime);
        }
    }
}

 

 

5.将拦截器类注入到适配器中，否则不能正常拦截访问。

 

import com.annotation.interceptor.LoggerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**
 * @author liaoyubo
 * @version 1.0 2017/9/14
 * @description 注册自定义的拦截器
 */
@Configuration
public class InterceptorRegister extends WebMvcConfigurerAdapter {



    @Bean
    public LoggerInterceptor loggerInterceptor(){
        return new LoggerInterceptor();
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(loggerInterceptor());
    }

}

 

6.这个是非常重要的一步，不然在其他项目中是无法正常执行自定义的过滤器的，最初我也没有注意，

 

所以在这里纠结了很久，在resources目录下的META-INFO\spring.factories文件中添加

 

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.annotation.common.InterceptorRegister

 如果resources目录下没有上面所说的META-INFO和spring.factories，则自己新建。

 

 

7.打包生成jar到本地的中央仓库，然后就可以引用了。

 

 

我们新建另外一个SpringBoot项目用于测试上面的注解。

 

8.在新项目中引入上面生成的jar：

<dependency>
     <groupId>testAnnotation</groupId>
     <artifactId>testAnnotation</artifactId>
     <version>1.0-SNAPSHOT</version>
</dependency>

 

9.新建一个用于测试自定义注解的restful类:

import com.annotation.log.LoggerAnnotation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author liaoyubo
 * @version 1.0 2017/9/15
 * @description
 */
@RestController
public class AnnotationController {

    @RequestMapping("/annotationTest")
    @LoggerAnnotation
    public void annotationTest() throws InterruptedException {
        Thread.sleep(5000);
    }
}

 

10.启动程序后，通过访问连接地址http://localhost:8080/annotationTest就可以得到以下

的输出结果:

2017-09-15 13:52:27.015  INFO 407336 --- [nio-8080-exec-1] c.a.interceptor.LoggerInterceptor        : 进入annotationTest方法的时间是：1505454747015
2017-09-15 13:52:32.202  INFO 407336 --- [nio-8080-exec-1] c.a.interceptor.LoggerInterceptor        : 离开annotationTest方法的时间是：1505454752202
2017-09-15 13:52:32.202  INFO 407336 --- [nio-8080-exec-1] c.a.interceptor.LoggerInterceptor        : 在annotationTest方法的时长是：5187

 以上就是自定义注解，然后通过pom的方式引入到新项目的过程。