Springboot插件如何開(kāi)發(fā)

本篇內(nèi)容主要講解“Springboot插件如何開(kāi)發(fā)”，感興趣的朋友不妨來(lái)看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來(lái)帶大家學(xué)習(xí)“Springboot插件如何開(kāi)發(fā)”吧!

一 背景

項(xiàng)目新增監(jiān)控系統(tǒng)，對(duì)各個(gè)系統(tǒng)進(jìn)行監(jiān)控接口調(diào)用情況，初期的時(shí)候是在各個(gè)項(xiàng)目公共引用的依賴包里面新增aop切面來(lái)完成對(duì)各個(gè)系統(tǒng)的接口調(diào)用進(jìn)行監(jiān)控，但是這樣有缺點(diǎn)，一是不同項(xiàng)目的接口路徑不同，導(dǎo)致aop切面要寫多個(gè)切面路徑，二是一些不需要進(jìn)行監(jiān)控的系統(tǒng)，因?yàn)橐肓斯舶脖槐O(jiān)控了，這樣侵入性就太強(qiáng)了。為了解決這個(gè)問(wèn)題，就可以通過(guò)springboot的可插拔屬性了。

二 監(jiān)控日志插件開(kāi)發(fā)

1 新建aop切面執(zhí)行類MonitorLogInterceptor

@Slf4j
public class MonitorLogInterceptor extends MidExpandSpringMethodInterceptor<MonitorAspectAdviceProperties> {
   @Override
   public Object invoke(MethodInvocation methodInvocation) throws Throwable {
       Object result = null;
       HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
       //拿到請(qǐng)求的url
       String requestURI = request.getRequestURI();
       if (StringUtils.isEmpty(requestURI)) {
           return result;
       }
       try {
           result = methodInvocation.proceed();
       } catch (Exception e) {
           buildRecordData(methodInvocation, result, requestURI, e);
           throw e;
       }
       //參數(shù)數(shù)組
       buildRecordData(methodInvocation, result, requestURI, null);
       return result;

我們可以看到它實(shí)現(xiàn)了MidExpandSpringMethodInterceptor<T>

@Slf4j
public abstract class MidExpandSpringMethodInterceptor<T> implements MethodInterceptor {
    @Setter
    @Getter
    protected T properties;
    /**
     * 主動(dòng)注冊(cè)，生成AOP工廠類定義對(duì)象
     */
    protected String getExpression() {
        return null;
    }
    @SuppressWarnings({"unchecked"})
    public AbstractBeanDefinition doInitiativeRegister(Properties properties) {
        String expression = StringUtils.isNotBlank(this.getExpression()) ? this.getExpression() : properties.getProperty("expression");
        if (StringUtils.isBlank(expression)) {
            log.warn("中臺(tái)SpringAop插件 " + this.getClass().getSimpleName() + " 缺少對(duì)應(yīng)的配置文件 或者 是配置的攔截路徑為空 導(dǎo)致初始化跳過(guò)");
            return null;
        }
        BeanDefinitionBuilder definition = BeanDefinitionBuilder.genericBeanDefinition(AspectJExpressionPointcutAdvisor.class);
        this.setProperties((T) JsonUtil.toBean(JsonUtil.toJson(properties), getProxyClassT()));
        definition.addPropertyValue("advice", this);
        definition.addPropertyValue("expression", expression);
        return definition.getBeanDefinition();
    }
    /**
     * 獲取代理類上的泛型T
     * 單泛型 不支持多泛型嵌套
     */
    private Class<?> getProxyClassT() {
        Type genericSuperclass = this.getClass().getGenericSuperclass();
        ParameterizedType parameterizedType = (ParameterizedType) genericSuperclass;
        return (Class<?>) parameterizedType.getActualTypeArguments()[0];
    }
}

而最終是實(shí)現(xiàn)了MethodInterceptor，這個(gè)接口是 方法攔截器,用于Spring AOP編程中的動(dòng)態(tài)代理.實(shí)現(xiàn)該接口可以對(duì)需要增強(qiáng)的方法進(jìn)行增強(qiáng).

我們注意到我的切面執(zhí)行類并沒(méi)有增加任何@Compont和@Service等將類注入到spring的bean中的方法，那他是怎么被注入到bean中的呢，因?yàn)槭褂昧藄pi機(jī)制

SPI機(jī)制的實(shí)現(xiàn)在項(xiàng)目的資源文件目錄中，增加spring.factories文件，內(nèi)容為

com.dst.mid.common.expand.springaop.MidExpandSpringMethodInterceptor=\
  com.dst.mid.monitor.intercept.MonitorLogInterceptor

這樣就可以在啟動(dòng)過(guò)程直接被注冊(cè)，并且被放到spring容器中了。還有一個(gè)問(wèn)題就是，切面執(zhí)行類有了，切面在哪里呢。

@Configuration
@Slf4j
@Import(MidExpandSpringAopAutoStarter.class)
public class MidExpandSpringAopAutoStarter implements ImportBeanDefinitionRegistrar {
    private static final String BEAN_NAME_FORMAT = "%s%sAdvisor";
    private static final String OS = "os.name";
    private static final String WINDOWS = "WINDOWS";
    @SneakyThrows
    @SuppressWarnings({"rawtypes"})
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        // 1 獲取MidExpandSpringMethodInterceptor類的所有實(shí)現(xiàn)集合
        List<MidExpandSpringMethodInterceptor> list = SpringFactoriesLoader.loadFactories(MidExpandSpringMethodInterceptor.class, null);
        if (!CollectionUtils.isEmpty(list)) {
            String expandPath;
            Properties properties;
            BeanDefinition beanDefinition;
            // 2 遍歷類的所有實(shí)現(xiàn)集合
            for (MidExpandSpringMethodInterceptor item : list) {
                // 3 獲取資源文件名稱 資源文件中存儲(chǔ)需要加入配置的
                expandPath = getExpandPath(item.getClass());
                // 4 加載資源文件
                properties = PropertiesLoaderUtils.loadAllProperties(expandPath + ".properties");
                // 5 賦值beanDefinition為AspectJExpressionPointcutAdvisor

                if (Objects.nonNull(beanDefinition = item.doInitiativeRegister(properties))) {
                    // 6 向容器中注冊(cè)類  注意這個(gè)beanname是不存在的，但是他賦值beanDefinition為AspectJExpressionPointcutAdvisor是動(dòng)態(tài)代理動(dòng)態(tài)生成代理類所以不會(huì)報(bào)錯(cuò)
                    registry.registerBeanDefinition(String.format(BEAN_NAME_FORMAT, expandPath, item.getClass().getSimpleName()), beanDefinition);
                }
            }
        }
    }
    /**
     * 獲取資源文件名稱
     */
    private static String getExpandPath(Class<?> clazz) {
        String[] split = clazz.getProtectionDomain().getCodeSource().getLocation().getPath().split("/");
        if (System.getProperty(OS).toUpperCase().contains(WINDOWS)) {
            return split[split.length - 3];
        } else {
            return String.join("-", Arrays.asList(split[split.length - 1].split("-")).subList(0, 4));
        }
    }
}

這個(gè)就是切面注冊(cè)類的處理，首先實(shí)現(xiàn)了ImportBeanDefinitionRegistrar，實(shí)現(xiàn)他的registerBeanDefinitions方法可以將想要注冊(cè)的類放入spring容器中，看下他的實(shí)現(xiàn)

• 1 獲取MidExpandSpringMethodInterceptor類的所有實(shí)現(xiàn)集合

• 2 遍歷類的所有實(shí)現(xiàn)集合

• 3 獲取資源文件名稱 資源文件中存儲(chǔ)需要加入配置的

• 4 加載資源文件

• 5 賦值beanDefinition為AspectJExpressionPointcutAdvisor

• 6 向容器中注冊(cè)類 注意這個(gè)beanname是不存在的，但是他賦值beanDefinition為AspectJExpressionPointcutAdvisor是動(dòng)態(tài)代理動(dòng)態(tài)生成代理類所以不會(huì)報(bào)錯(cuò)

看到這里，還有一個(gè)問(wèn)題ImportBeanDefinitionRegistrar實(shí)際上是將類注冊(cè)到容器中，但是還需要一個(gè)步驟就是他要被容器掃描才行，以往的方式是項(xiàng)目中通過(guò)路徑掃描，但是我們是插件，不能依賴于項(xiàng)目，而是通過(guò)自己的方式處理，這時(shí)候就需要用@Import(MidExpandSpringAopAutoStarter.class)來(lái)處理了。

通過(guò)以上處理就實(shí)現(xiàn)了監(jiān)控插件的處理，然后再使用時(shí)，只需要將這個(gè)項(xiàng)目引入到不同需要監(jiān)控的項(xiàng)目上就可以了。

到此，相信大家對(duì)“Springboot插件如何開(kāi)發(fā)”有了更深的了解，不妨來(lái)實(shí)際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！