springboot扫描自定义的servlet和filter代码详解

 更新时间:2017年10月10日 14:41:57   作者:叶长风  
本文是一篇根据作者工作经历总结出来的关于springboot扫描自定义的servlet和filter代码详解的文章,小编觉得非常不错,这里给大家分享下,和朋友们一起学习,进步。

这几天使用spring boot编写公司一个应用,在编写了一个filter,用于指定编码的filter,如下:

/**
 * Created by xiaxuan on 16/11/1.
 */
@WebFilter(urlPatterns = "/*",filterName="CharacterEncodeFilter",
    initParams={
        @WebInitParam(name="encoding",value="UTF-8"),
        @WebInitParam(name = "forceEncoding", value = "true")
    })
@Singleton
public class CharacterEncodingFilter implements Filter {
  private String encoding = "UTF-8";
  private boolean forceEncoding = true;
  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
    this.encoding = filterConfig.getInitParameter("encoding");
    String force = filterConfig.getInitParameter("forceEncoding");
    this.forceEncoding = (force == null) || Boolean.valueOf(force);
  }
  @Override
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    if (this.forceEncoding || request.getCharacterEncoding() == null) {
      request.setCharacterEncoding(this.encoding);
      response.setCharacterEncoding(this.encoding);
    }
    chain.doFilter(request, response);
  }
  @Override
  public void destroy() {
  }
  public void setEncoding(String encoding) {
    this.encoding = encoding;
  }
  public void setForceEncoding(boolean forceEncoding) {
    this.forceEncoding = forceEncoding;
  }
}

但是在实际使用的时候,却是完全没有起作用,后来查看了一下springboot的官方文档,filter和servlet、listener之类的需要单独进行注册才能使用,但是spring boot里面提供了一个注解来替代,为@ServletComponentScan,这个注解直接加在对应的Application启动类上即可,如下:

@SpringBootApplication
@ServletComponentScan
@ComponentScan
public class SpringBootWebApplication {
  public static void main(String[] args) {
    SpringApplication.run(SpringBootWebApplication.class, args);
  }
}

这样编写完之后,如果对应的filter是在自己当前模块下的某个package中的时候是可以起作用的,但是如果本身项目中有多个模块的时候,如果filter在一个类似与core下的package中,这样注解加上去并没有多大用处,最后会发现这个filter仍然没有起作用。

我自己编写的应用有两个,最开始的做法是把filter从core包中拆出来,然后在两个模块中各自添加一个,但是这样未免有些代码冗余,并且实现方式并不优雅,然后我查看了下@ServletComponentScan的源码,里面确实是有更好的解决方法。

@ServletComponentScan的源码如下:

/**
 * Enables scanning for Servlet components ({@link WebFilter filters}, {@link WebServlet
 * servlets}, and {@link WebListener listeners}). Scanning is only performed when using an
 * embedded Servlet container.
 * <p>
 * Typically, one of {@code value}, {@code basePackages}, or {@code basePackageClasses}
 * should be specified to control the packages to be scanned for components. In their
 * absence, scanning will be performed from the package of the class with the annotation.
 *
 * @author Andy Wilkinson
 * @since 1.3.0
 * @see WebServlet
 * @see WebFilter
 * @see WebListener
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(ServletComponentScanRegistrar.class)
public @interface ServletComponentScan {
  /**
   * Alias for the {@link #basePackages()} attribute. Allows for more concise annotation
   * declarations e.g.: {@code @ServletComponentScan("org.my.pkg")} instead of
   * {@code @ServletComponentScan(basePackages="org.my.pkg")}.
   * @return the base packages to scan
   */
  @AliasFor("basePackages")
  String[] value() default {};
  /**
   * Base packages to scan for annotated servlet components. {@link #value()} is an
   * alias for (and mutually exclusive with) this attribute.
   * <p>
   * Use {@link #basePackageClasses()} for a type-safe alternative to String-based
   * package names.
   * @return the base packages to scan
   */
  @AliasFor("value")
  String[] basePackages() default {};
  /**
   * Type-safe alternative to {@link #basePackages()} for specifying the packages to
   * scan for annotated servlet components. The package of each class specified will be
   * scanned.
   * @return classes from the base packages to scan
   */
  Class<?>[] basePackageClasses() default {};
}

这里有一个value()属性,上面的注解默认为basePackage,那么在扫描的时候就只扫描当前模块下面的包,其他不扫描,如果要连同其他模块一起扫描的话,给这个属性加上值即可,如下:

@ServletComponentScan(value = "cn.com")

如上,自定义的filter和servlet就可以正常起作用。

总结

以上就是本文关于springboot扫描自定义的servlet和filter代码详解的全部内容,希望对大家有所帮助。感兴趣的朋友可以参阅:浅谈Java注解和动态代理 、Java之Spring注解配置bean实例代码解析浅谈Springboot之于Spring的优势等。有什么问题可以随时留言,小编会及时回复大家。同时希望朋友们对脚本之家网站多多支持!

相关文章

  • IDEA创建Spring项目无法选择Java8的问题及解决

    IDEA创建Spring项目无法选择Java8的问题及解决

    文章描述了在使用Spring创建项目时遇到的问题,通过将服务器地址从https://start.spring.io/替换为https://start.aliyun.com/,成功解决了无法选择Java8的问题
    2025-01-01
  • Java实现文件上传下载以及查看功能

    Java实现文件上传下载以及查看功能

    这篇文章主要为大家详细介绍了java如何实现文件上传和下载以及查看功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • Maven项目如何查找jar包是由哪个依赖引入的

    Maven项目如何查找jar包是由哪个依赖引入的

    这篇文章主要介绍了Maven项目如何查找jar包是由哪个依赖引入的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • Hadoop组件简介

    Hadoop组件简介

    Hadoop作为一种分布式基础架构,可以使用户在不了解分布式底层细节的情况下,开发分布式程序。接下来通过本文给大家分享Hadoop组件简介,感兴趣的朋友一起看看吧
    2017-09-09
  • Mybatis的详细使用教程

    Mybatis的详细使用教程

    这篇文章主要介绍了Mybatis的详细使用教程,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2016-12-12
  • Java并发编程之详解CyclicBarrier线程同步

    Java并发编程之详解CyclicBarrier线程同步

    在之前的文章中已经为大家介绍了java并发编程的工具:BlockingQueue接口,ArrayBlockingQueue,DelayQueue,LinkedBlockingQueue,PriorityBlockingQueue,SynchronousQueue,BlockingDeque接口,ConcurrentHashMap,CountDownLatch,本文为系列文章第十篇,需要的朋友可以参考下
    2021-06-06
  • 在Mybatis中association标签多层嵌套的问题

    在Mybatis中association标签多层嵌套的问题

    这篇文章主要介绍了在Mybatis中association标签多层嵌套的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Java使用ffmpeg和mencoder实现视频转码

    Java使用ffmpeg和mencoder实现视频转码

    这篇文章主要为大家详细介绍了Java使用ffmpeg和mencoder实现视频转码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-12-12
  • Jackson的用法实例分析

    Jackson的用法实例分析

    这篇文章主要介绍了Jackson的用法实例分析,用于处理Java的json格式数据非常实用,需要的朋友可以参考下
    2014-08-08
  • 使用Spring底层组件实现Aware接口

    使用Spring底层组件实现Aware接口

    这篇文章主要介绍了使用Spring底层组件实现Aware接口,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07

最新评论