spring自动装配机制

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；

starter的原理：

springboot的自动装配机制

image

属性文件自动装配

image

  • 需求，我们准备弄个日志相关的starter,当别人依赖我们的jar包时，在需要打印日志的方法上贴上对应的注解即可,日志打印的前置通知和后置通知内容可以在application.yml或者application.properties中配置

    思路： 我们需要定义一个注解：这样别人在需要打日志的地方贴上该注解即可：

package org.example.annotation;

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

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

接着，我们要让注解生效，所以需要一个切面类：

package org.example.config;

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

import java.util.Arrays;

@org.aspectj.lang.annotation.Aspect
public class MyLogAspect {

    private MyLogProperties myLogProperties;

    public MyLogAspect(MyLogProperties myLogProperties) {
        this.myLogProperties = myLogProperties;
    }

    @Pointcut("@annotation(org.example.annotation.MyLog)")
    public void myLogPointCut() {}

    @Around("myLogPointCut()")
    public Object invoke(ProceedingJoinPoint joinPoint){
        System.out.println(myLogProperties.getPerfix()+"---"+ Arrays.toString(joinPoint.getArgs()));
        Object proceed = null;
        try {
            proceed = joinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        System.out.println(myLogProperties.getSubfix()+"---"+ Arrays.toString(joinPoint.getArgs()));
        return proceed;

    }

}

切面类中有个配置文件类：

package org.example.config;


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

@ConfigurationProperties(prefix = "mylog")
public class MyLogProperties {

    private String perfix;
    private String subfix;

    public String getPerfix() {
        if (StringUtils.isEmpty(perfix)) {
            return "默认前缀";
        }
        return perfix;
    }

    public void setPerfix(String perfix) {
        this.perfix = perfix;
    }

    public String getSubfix() {
        if (StringUtils.isEmpty(subfix)) {
            return "默认后缀";
        }
        return subfix;
    }

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

要让上面类注入spring容器，需要一个配置类：

package org.example.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(MyLogProperties.class)
@ConditionalOnBean(MyLogConfiguration.class)
public class MyLogAutoConfiguration {
    @Bean
    public MyLogAspect myLogAspect(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=org.example.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></pre>

因为我们项目用到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>

至此，项目创建完毕： 现在看下整体情况：

image.png

项目打包进行测试：

image

新建web项目引入我们的日志依赖：

<dependency>
      <groupId>org.example</groupId>
      <artifactId>start-demo</artifactId>
      <version>2.0-SNAPSHOT</version>
    </dependency>

测试项目提供一个controller,对应方法贴上我们的日志注解：

package org.example;

import org.example.annotation.EnableMyLog;
import org.example.annotation.MyLog;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * Hello world!
 *
 */
@SpringBootApplication
@RestController

public class App {
    @GetMapping("/test")
    @MyLog
    public String test() {
        return "1";
    }

    public static void main( String[] args ) {
        SpringApplication.run(App.class, args);
    }
}

测试项目的整体情况：


image.png

此时我们没有在yml中配置日志前缀，启动测试项目测试：

浏览器输入：http://localhost/test

控制台输出：


image.png

我们在yml配置文件输入前后缀：


image.png

可见，有提示，跟我们配置其他组件的属性一样：

至此，我们实现了一个完整的springboot starter,在springboot项目中，很多组件的底层原理都是这样实现的，通过这种实现，可以做底层架构，然后给其他服务使用，如可以校验请求参数，处理返回结果等

附加git代码地址： https://github.com/shizhenshuang123/start-demo

上面的实现，有个问题，当我不想用该功能时，相关的bean也会注入容器中，那如果我想实现动态可插拔功能，怎么处理？

要实现可插拔功能，那关键是对MyLogAutoConfiguration 这个配置类下手了，用到@ConditionalOnBean(xx.class)注解，当容器中含有xxbean时，才会使得配置生效，那如何使得xxbean可以注入容器，那就要用到@EnableXX注解

xxbean只是一个标记类，不用作特殊配置：

package org.example.config;

public class MyLogConfiguration {
}

@EnableXX注解:

package org.example.annotation;


import org.example.config.MyLogConfiguration;
import org.springframework.context.annotation.Import;

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(MyLogConfiguration.class)
public @interface EnableMyLog {
}

修改MyLogAutoConfiguration配置类：

package org.example.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(MyLogProperties.class)
@ConditionalOnBean(MyLogConfiguration.class)  // 当容器中有这个xxbean就会使得下面配置生效
public class MyLogAutoConfiguration {
    @Bean
    public MyLogAspect myLogAspect(MyLogProperties myLogProperties) {
        return new MyLogAspect(myLogProperties);
    }

}

通过上面代码知道，如果要使得MyLogAutoConfiguration生效，容器中必须有LogMarkerConfiguration这个标志bean,容器中要有这个标志bean,就要用到@EnableMyLog注解，因此，当第三方引用我们的依赖时，只需要再主启动类上加入@EnableMyLog注解即可：

附加： zuul网关实现可插拔的原理也是一样：

image
image
image
image
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,362评论 5赞 477
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,330评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,247评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,560评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,580评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,569评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,929评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,587评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,840评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,366评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,945评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2赞 342