自定义AutoConfiguration的实现

个人认为springboot相比spring有如下特点

  1. 自带web容器,只要具备jre环境,一行命令就可以启动
  2. 开箱即用的自动化配置功能,用户无需担心相关依赖,配置相关Bean,大部分技术springboot自动为你搞定,你只需要在配置文件中配点参数即可
  3. 模块化扩展,在官方autoConfiguration中没找到你要用的框架,没关系,仿照着写一个就好了,写得好你也可以发到maven库供其他人使用,避免重复造轮子。
    4.既然扩展和使用这么简便,自然在springcloud中可以大显身手了,目前springcloud中已经有很多插件了,他们构成了一个体系。而这些插件都是使用了springboot,具备开箱即用,插件化。

那如何定制自己的插件呢?我们可以仿照FreeMarkerAutoConfiguration来写

  1. 定义FreeMarkerAutoConfiguration
@Configuration
//必须存在指定类
@ConditionalOnClass({ freemarker.template.Configuration.class,FreeMarkerConfigurationFactory.class })
//在指定配置类后面配置
@AutoConfigureAfter(WebMvcAutoConfiguration.class)
//启用指定的properties类
@EnableConfigurationProperties(FreeMarkerProperties.class)
public class FreeMarkerAutoConfiguration {
    private final ApplicationContext applicationContext;
    private final FreeMarkerProperties properties;
    //定义一个构造器,形参会自动注入进来
    public FreeMarkerAutoConfiguration(ApplicationContext applicationContext,FreeMarkerProperties properties) {
        this.applicationContext = applicationContext;
        this.properties = properties;
    }
  
    //实例化完后调用,一般用于初始化
    @PostConstruct
    public void checkTemplateLocationExists() {
    
    }
    //可以定义内部类
    protected static class FreeMarkerConfiguration {
        //这样也可以注入
        @Autowired
    protected FreeMarkerProperties properties;
        
        
    }
    //内部还可以继续定义配置类
    @Configuration
    @ConditionalOnClass({ Servlet.class, FreeMarkerConfigurer.class })
    //上下文必须是WebApplicationContext
    @ConditionalOnWebApplication
    public static class FreeMarkerWebConfiguration extends FreeMarkerConfiguration {
        @Bean
        //在BeanFactory中不存在指定类型Bean时,当前Bean才会生效
    @ConditionalOnMissingBean(FreeMarkerConfig.class)
     public FreeMarkerConfigurer freeMarkerConfigurer() {
              FreeMarkerConfigurer configurer = new FreeMarkerConfigurer();
          applyProperties(configurer);
          return configurer;
      }
          
          @Bean
          public freemarker.template.Configuration freeMarkerConfiguration(FreeMarkerConfig configurer){
              return configurer.getConfiguration();
          }

        @Bean
         //在BeanFactory中不存在指定名称Bean时,当前Bean才会生效
        @ConditionalOnMissingBean(name = "freeMarkerViewResolver")
        //检查指定name的值是否为true,如果未找到,就使用matchIfMissing的值
        @ConditionalOnProperty(name = "spring.freemarker.enabled", matchIfMissing = true)
        public FreeMarkerViewResolver freeMarkerViewResolver() {
            FreeMarkerViewResolver resolver = new FreeMarkerViewResolver();
            this.properties.applyToViewResolver(resolver);
            return resolver;
        }
        
    @Bean
    @ConditionalOnMissingBean
   //检查spring是否启用Spring resource handling chain,没有启用当前Bean也不会生效
    @ConditionalOnEnabledResourceChain
    public ResourceUrlEncodingFilter resourceUrlEncodingFilter() {
           return new ResourceUrlEncodingFilter();
    }
     }
}
  1. 定义Properties类
@ConfigurationProperties(prefix = "spring.freemarker")
public class FreeMarkerProperties{
    .....
}
  1. classpath路径下添加spring-configuration-metadata.json
{
  "groups": [
      {
      "name": "spring.freemarker",
      "type": "org.springframework.boot.autoconfigure.freemarker.FreeMarkerProperties",
      "sourceType": "org.springframework.boot.autoconfigure.freemarker.FreeMarkerProperties"
      },
    {
      "name": "spring.freemarker.cache",
      "type": "java.lang.Boolean",
      "description": "Enable template caching.",
      "sourceType": "org.springframework.boot.autoconfigure.freemarker.FreeMarkerProperties",
      "defaultValue": false
    },
    {
      "name": "spring.freemarker.charset",
      "type": "java.nio.charset.Charset",
      "description": "Template encoding.",
      "sourceType": "org.springframework.boot.autoconfigure.freemarker.FreeMarkerProperties",
      "defaultValue": "UTF-8"
    },
    ....
   ]
}
  1. 添加依赖
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容