springboot扫描自定义的servlet和filter代码详解
这几天使用springboot编写公司一个应用，在编写了一个filter，用于指定编码的filter，如下：
/**
*Createdbyxiaxuanon16/11/1.
*/
@WebFilter(urlPatterns="/*",filterName="CharacterEncodeFilter",
initParams={
@WebInitParam(name="encoding",value="UTF-8"),
@WebInitParam(name="forceEncoding",value="true")
})
@Singleton
publicclassCharacterEncodingFilterimplementsFilter{
privateStringencoding="UTF-8";
privatebooleanforceEncoding=true;
@Override
publicvoidinit(FilterConfigfilterConfig)throwsServletException{
this.encoding=filterConfig.getInitParameter("encoding");
Stringforce=filterConfig.getInitParameter("forceEncoding");
this.forceEncoding=(force==null)||Boolean.valueOf(force);
}
@Override
publicvoiddoFilter(ServletRequestrequest,ServletResponseresponse,FilterChainchain)throwsIOException,ServletException{
if(this.forceEncoding||request.getCharacterEncoding()==null){
request.setCharacterEncoding(this.encoding);
response.setCharacterEncoding(this.encoding);
}
chain.doFilter(request,response);
}
@Override
publicvoiddestroy(){
}
publicvoidsetEncoding(Stringencoding){
this.encoding=encoding;
}
publicvoidsetForceEncoding(booleanforceEncoding){
this.forceEncoding=forceEncoding;
}
}
但是在实际使用的时候，却是完全没有起作用，后来查看了一下springboot的官方文档，filter和servlet、listener之类的需要单独进行注册才能使用，但是springboot里面提供了一个注解来替代，为@ServletComponentScan，这个注解直接加在对应的Application启动类上即可，如下：
@SpringBootApplication
@ServletComponentScan
@ComponentScan
publicclassSpringBootWebApplication{
publicstaticvoidmain(String[]args){
SpringApplication.run(SpringBootWebApplication.class,args);
}
}
这样编写完之后，如果对应的filter是在自己当前模块下的某个package中的时候是可以起作用的，但是如果本身项目中有多个模块的时候，如果filter在一个类似与core下的package中，这样注解加上去并没有多大用处，最后会发现这个filter仍然没有起作用。
我自己编写的应用有两个，最开始的做法是把filter从core包中拆出来，然后在两个模块中各自添加一个，但是这样未免有些代码冗余，并且实现方式并不优雅，然后我查看了下@ServletComponentScan的源码，里面确实是有更好的解决方法。
@ServletComponentScan的源码如下：
/**
*EnablesscanningforServletcomponents({@linkWebFilterfilters},{@linkWebServlet
*servlets},and{@linkWebListenerlisteners}).Scanningisonlyperformedwhenusingan
*embeddedServletcontainer.
*
*Typically,oneof{@codevalue},{@codebasePackages},or{@codebasePackageClasses}
*shouldbespecifiedtocontrolthepackagestobescannedforcomponents.Intheir
*absence,scanningwillbeperformedfromthepackageoftheclasswiththeannotation.
*
*@authorAndyWilkinson
*@since1.3.0
*@seeWebServlet
*@seeWebFilter
*@seeWebListener
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(ServletComponentScanRegistrar.class)
public@interfaceServletComponentScan{
/**
*Aliasforthe{@link#basePackages()}attribute.Allowsformoreconciseannotation
*declarationse.g.:{@code@ServletComponentScan("org.my.pkg")}insteadof
*{@code@ServletComponentScan(basePackages="org.my.pkg")}.
*@returnthebasepackagestoscan
*/
@AliasFor("basePackages")
String[]value()default{};
/**
*Basepackagestoscanforannotatedservletcomponents.{@link#value()}isan
*aliasfor(andmutuallyexclusivewith)thisattribute.
*
*Use{@link#basePackageClasses()}foratype-safealternativetoString-based
*packagenames.
*@returnthebasepackagestoscan
*/
@AliasFor("value")
String[]basePackages()default{};
/**
*Type-safealternativeto{@link#basePackages()}forspecifyingthepackagesto
*scanforannotatedservletcomponents.Thepackageofeachclassspecifiedwillbe
*scanned.
*@returnclassesfromthebasepackagestoscan
*/
Class[]basePackageClasses()default{};
}
这里有一个value()属性，上面的注解默认为basePackage,那么在扫描的时候就只扫描当前模块下面的包，其他不扫描，如果要连同其他模块一起扫描的话，给这个属性加上值即可，如下：
@ServletComponentScan(value="cn.com")
如上，自定义的filter和servlet就可以正常起作用。
总结
以上就是本文关于springboot扫描自定义的servlet和filter代码详解的全部内容，希望对大家有所帮助。感兴趣的朋友可以参阅：浅谈Java注解和动态代理 、Java之Spring注解配置bean实例代码解析、浅谈Springboot之于Spring的优势等。有什么问题可以随时留言，小编会及时回复大家。同时希望朋友们对毛票票网站多多支持！