SpringBoot扩展SpringMVC原理并实现全面接管
如果想在springboot中扩展一些springmvc的配置,例如需要配置自定义的视图解析器或拦截器等,需要怎么实现呢?
例如,自定义一个视图解析器:
@configuration public class myconfig implements webmvcconfigurer { @override public void addviewcontrollers(viewcontrollerregistry registry) { registry.addviewcontroller("/index").setviewname("index"); } }
我们只需要编写一个配置类去实现webmvcconfigurer接口,并选择实现接口中的方法,不能标注@enablewebmvc,这些webmvcconfigurer接口中的方法就是springmvc所可以扩展的配置
注意:在springboot1.0版本中扩展springmvc配置是继承webmvcconfigureradapter类,但在2.0以上的版本中已经过时,官方推荐使用以上实现webmvcconfigurer接口的方式进行扩展,因为在2.0版本中webmvcconfigurer接口有了默认实现。
webmvcconfigurer方法介绍:这里只列举几个比较关键的方法
public interface webmvcconfigurer { //定制url匹配规则 default void configurepathmatch(pathmatchconfigurer configurer) { } //内容协商机制 default void configurecontentnegotiation(contentnegotiationconfigurer configurer) { } //异步任务执行器。 default void configureasyncsupport(asyncsupportconfigurer configurer) { } //使用默认servlet处理静态资源 default void configuredefaultservlethandling(defaultservlethandlerconfigurer configurer) { } //添加格式转换器 default void addformatters(formatterregistry registry) { } //添加拦截器 default void addinterceptors(interceptorregistry registry) { } //添加视图解析器 default void addviewcontrollers(viewcontrollerregistry registry) { } }
扩展mvc的实现原理:
我们都知道webmvcautoconfiguration是springmvc的自动配置类,当在做其他配置导入时,导入了@import(enablewebmvcconfiguration.class)这样一个注解,这个注解有什么用?
@configuration(proxybeanmethods = false)
@import(enablewebmvcconfiguration.class)
@enableconfigurationproperties({ webmvcproperties.class, resourceproperties.class })
@order(0)
public static class webmvcautoconfigurationadapter implements webmvcconfigurer {
}
点进这个注解,发现他还是webmvcautoconfiguration里的一个静态内部类,但他继承了delegatingwebmvcconfiguration
@configuration(proxybeanmethods = false)
public static class enablewebmvcconfiguration extends delegatingwebmvcconfiguration implements resourceloaderaware {
}
再点进这个delegatingwebmvcconfiguration类里,开头有这样一段代码,有一个configurers属性,类型是webmvcconfigurercomposite ,这个webmvcconfigurercomposite类也实现了webmvcconfigurer,当@autowired标注在一个方法上说明,这个方法的参数都从容器中获取,这里是从容器中获取所有的webmvcconfigurer,并赋值给了configurers属性
@configuration(proxybeanmethods = false) public class delegatingwebmvcconfiguration extends webmvcconfigurationsupport { private final webmvcconfigurercomposite configurers = new webmvcconfigurercomposite(); @autowired(required = false) public void setconfigurers(list<webmvcconfigurer> configurers) { if (!collectionutils.isempty(configurers)) { this.configurers.addwebmvcconfigurers(configurers); } } }
在这个类往下看,发现这个类的方法跟webmvcconfigurer接口里的方法一样,以这个视图解析器举例,方法里调用了这个方法this.configurers.addviewcontrollers(registry)
@configuration(proxybeanmethods = false) public class delegatingwebmvcconfiguration extends webmvcconfigurationsupport { private final webmvcconfigurercomposite configurers = new webmvcconfigurercomposite(); @autowired(required = false) public void setconfigurers(list<webmvcconfigurer> configurers) { if (!collectionutils.isempty(configurers)) { this.configurers.addwebmvcconfigurers(configurers); } } ... @override protected void addviewcontrollers(viewcontrollerregistry registry) { this.configurers.addviewcontrollers(registry); } }
点进configurers.addviewcontrollers(registry),这个方法是把容器中所有的addviewcontrollers()都执行一遍。<mark style="box-sizing: border-box; outline: 0px; background-color: rgb(248, 248, 64); color: rgb(0, 0, 0); overflow-wrap: break-word;">因为我们自己写的配置类也注入到了容器里,所以我们的配置也会被调用,并且也被springboot自动配置上,所以springmvc的自动配置和我们的扩展配置都会起作用</mark>;
class webmvcconfigurercomposite implements webmvcconfigurer { ... @override public void addviewcontrollers(viewcontrollerregistry registry) { for (webmvcconfigurer delegate : this.delegates) { delegate.addviewcontrollers(registry); } } }
还有上面在写自定义配置类时为什么不能标注@enablewebmvc
因为一但标注了@enablewebmvc,所有都是我们自己配置;所有的springmvc的自动配置都失效了。<mark style="box-sizing: border-box; outline: 0px; background-color: rgb(248, 248, 64); color: rgb(0, 0, 0); overflow-wrap: break-word;">原理又是怎么样的?</mark>
给自己的配置类加上@enablewebmvc
@configuration @enablewebmvc public class myconfig implements webmvcconfigurer { @override public void addviewcontrollers(viewcontrollerregistry registry) { registry.addviewcontroller("/index").setviewname("index"); } }
这个注解导入了@import(delegatingwebmvcconfiguration.class)
@retention(retentionpolicy.runtime)
@target(elementtype.type)
@documented
@import(delegatingwebmvcconfiguration.class)
public @interface enablewebmvc {
}
这个类继承了webmvcconfigurationsupport
public class delegatingwebmvcconfiguration extends webmvcconfigurationsupport {
}
我们再回头看一下webmvcautoconfiguration,@conditionalonmissingbean(webmvcconfigurationsupport.class)这个注解的意思就是容器中没有这个组件的时候,这个自动配置类才生效
小结:大概了解到springboot扩展springmvc的原理和全面接管springmvc,但springboot中还有其他很多配置,只要了解其中的原理,其他配置也就一通百通了。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。