自定義springboot - starter 實現日志打印，並支持動態可插拔

本文轉載自查看原文 2020-05-30 15:20 1449 springboot

1. starter 命名規則：

springboot項目有很多專一功能的starter組件，命名都是spring-boot-starter-xx,如spring-boot-starter-logging，spring-boot-starter-web,

如果是第三方的starter命名一般是：xx-springboot-starter 如：mongodb-plus-spring-boot-starter，mybatis-spring-boot-starter；
2. starter的原理：

2.1 springboot的自動裝配機制

2.2 屬性文件自動裝配

3. 需求，我們准備弄個日志相關的starter,當別人依賴我們的jar包時，在需要打印日志的方法上貼上對應的注解即可,日志打印的前置通知和后置通知內容可以在application.yml或者application.properties中配置

思路：我們需要定義一個注解：這樣別人在需要打日志的地方貼上該注解即可：

package com.yang.log.hui.annotion;

import java.lang.annotation.*;

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

接着，我們要讓注解生效，所以需要一個切面類：

package com.yang.log.hui.config;


import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;

import java.util.Arrays;

@Aspect
public class MyLogAspect {
    private MylogProperties mylogProperties;
    public MyLogAspect(MylogProperties mylogProperties) {  當一個bean沒有無參構造器時，spring創建bean時，對於構造器參數會從容器中取，這里其實是省略了@Autowired，該注解可以用在方法參數上
        this.mylogProperties=mylogProperties;
    }

    @Pointcut("@annotation(com.yang.log.hui.annotion.MyLogAnnotation)")
    public void logAnnotationAnnotationPointcut() {
    }
    @Around("logAnnotationAnnotationPointcut()")
    public Object logInvoke(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println(mylogProperties.getOrDefualtPrefix("請求參數")+ Arrays.toString(joinPoint.getArgs())); //如果配置文件配了對應的前綴，就用配置文件的，否則用默認的
        Object obj = joinPoint.proceed();
        System.out.println(mylogProperties.getOrDefualtSubfix("返回值：")+ obj.toString());//跟前綴一樣
        return obj;
    }


}

切面類中有個配置文件類：

package com.yang.log.hui.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.util.StringUtils;

@ConfigurationProperties(value ="mylog") //這個注解可以讓配置文件中的屬性根據前綴來注入對應的屬性
public class MylogProperties {
    //日志前綴
    private String prefix;  //會自動找配置文件中 mylog.prefix的值
    //日志后綴
    private String subfix; //會自動找配置文件中 mylog.subfix的值


    public String getOrDefualtPrefix(String defualtPrefix){
        if(StringUtils.isEmpty(prefix)){
            return defualtPrefix;
        }
        return prefix;
    }

    public String getOrDefualtSubfix(String defualtSubfix){
        if(StringUtils.isEmpty(subfix)){
            return defualtSubfix;
        }
        return subfix;
    }

    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }

    public void setSubfix(String subfix) {
        this.subfix = subfix;
    }


}

要讓上面類注入spring容器，需要一個配置類：

package com.yang.log.hui.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(MylogProperties.class) //該注解可以使MylogProperties注入spring容器
public class MyLogAutoConfiguration {
    @Bean
    public MyLogAspect myLogAspect(@Autowired MylogProperties mylogProperties){
        return new MyLogAspect(mylogProperties);
    }
}

到此為止，只要MyLogAutoConfiguration 注入spring容器了，那么他里面的bean也會被注入，而怎么樣使得MyLogAutoConfiguration 注入spring呢，那就要用到springboot的自動裝配機制：

在resources下創建一個META-INF文件夾，然后在創建一個文件：spring.factories文件加入內容：key是固定的org.springframework.boot.autoconfigure.EnableAutoConfiguration，value可以有多個

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.yang.log.hui.config.MyLogAutoConfiguration

依賴：平時我們在寫application.yml時會有提示，那么我也想讓我的日志配置也會生效，也就是當我輸入mylog時，會提示mylog.prefix 或者mylog.subfix,此時需要下面的配置：

      <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
       </dependency>

因為我們項目用到springboot和aop，所以需要：

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

注意：maven打包時，不能用spring-boot-maven-plugin,我用它打包沒報錯，給其他服務引用對應的jar時，啟動報錯了。需要換成：

 <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

至此，項目創建完畢：現在看下整體情況：

pom文件整體：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yang.xiao.hui</groupId>
    <artifactId>log-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>log-spring-boot-starter</name>
    <description>Demo project for Spring Boot</description>
    <packaging>jar</packaging>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
       </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

項目打包進行測試：

新建web項目引入我們的日志依賴：

    <dependency>
           <groupId>com.yang.xiao.hui</groupId>
           <artifactId>log-spring-boot-starter</artifactId>
           <version>0.0.1-SNAPSHOT</version>
       </dependency>

測試項目提供一個controller,對應方法貼上我們的日志注解：

package com.yang.xiao.hui.product.controller;

import com.yang.log.hui.annotion.MyLogAnnotation;
import com.yang.xiao.hui.product.entity.Product;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class ProductController {
    @RequestMapping("/info/{id}")
    @ResponseBody
    @MyLogAnnotation //這個是我們的日志注解
    public Product getProductInfo(@PathVariable("id") Integer id){
        Product product = new Product();
        product.setId(id);
        product.setName("蘋果手機");
        return product;
    }
}

測試項目的整體情況：

此時我們沒有在yml中配置日志前綴，啟動測試項目測試：

瀏覽器輸入：http://localhost:8673/info/3

控制台輸出：

我們在yml配置文件輸入前后綴：

可見，有提示，跟我們配置其他組件的屬性一樣：

重啟測試項目，再次在瀏覽器輸入：http://localhost:8673/info/3

至此，我們實現了一個完整的springboot starter,在springboot項目中，很多組件的底層原理都是這樣實現的，通過這種實現，可以做底層架構，然后給其他服務使用，如可以校驗請求參數，處理返回結果等

附加git代碼地址： https://gitee.com/yangxioahui/log-spring-boot-starter.git

上面的實現，有個問題，當我不想用該功能時，相關的bean也會注入容器中，那如果我想實現動態可插拔功能，怎么處理？

要實現可插拔功能，那關鍵是對MyLogAutoConfiguration 這個配置類下手了，用到@ConditionalOnBean(xx.class)注解，當容器中含有xxbean時，才會使得配置生效，那如何使得xxbean可以注入容器，那就要用到@EnableXX注解

xxbean只是一個標記類，不用作特殊配置：

public class LogMarkerConfiguration {
}

@EnableXX注解:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(LogMarkerConfiguration.class) //往容器中注入xxBean
public @interface EnableMyLog {
}

修改MyLogAutoConfiguration配置類：

@Configuration
@EnableConfigurationProperties(MylogProperties.class)
@ConditionalOnBean(LogMarkerConfiguration.class) //當容器中有這個xxbean就會使得下面配置生效
public class MyLogAutoConfiguration {
    @Bean
    public MyLogAspect myLogAspect(@Autowired MylogProperties mylogProperties){
        return new MyLogAspect(mylogProperties);
    }
}

通過上面代碼知道，如果要使得MyLogAutoConfiguration生效，容器中必須有LogMarkerConfiguration這個標志bean,容器中要有這個標志bean,就要用到@EnableMyLog注解，因此，當第三方引用我們的依賴時，只需要再主啟動類上加入@EnableMyLog注解即可：

附加： zuul網關實現可插拔的原理也是一樣：

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 springboot自定義starter實現（springboot）自定義Starter SpringBoot自定義Starter SpringBoot（八）Starter機制 - 自定義Starter springboot自定義starter SpringBoot自定義starter及自動配置自定義一個springboot starter SpringBoot應用篇（一）：自定義starter Springboot 自動配置 & 自定義Starter SpringBoot編寫自定義的starter 專題