SpringBoot配置嵌入式Servlet容器

妖狐艹你老母 2022-03-25 07:18 256阅读 0赞

## 1、定制和修改Servlet容器的相关配置 ##

### 第一种方法直接修改application.yml配置文件 ###

server:
      port: 8082
      tomcat:
        uri-encoding: UTF-8
      servlet:
        context-path: /

### 第二种方法：在springboot2.x中，编写配置类，注入ConfigurableServletWebServerFactory ###

@Configuration
    public class MyServerConfig {
    
        //定制嵌入式容器相关参数
        @Bean
        public ConfigurableServletWebServerFactory configurableServletWebServerFactory() {
            TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
            factory.setPort(8081);
            factory.setUriEncoding(Charset.forName("UTF-8"));
            return factory;
        }
    }

### 在springboot1.x中的方式如下： ###

@Bean
    public EmbeddedServletContainerCustomizer embeddedServletContainerCustomizer(){ 
        return new EmbeddedServletContainerCustomizer() {           
            //定制嵌入式的Servlet容器相关的规则         
            @Override         
            public void customize(ConfigurableEmbeddedServletContainer container) { 
                container.setPort(8083);       
            }
         };
    }

## 2、注册Servlet三大组件Servlet、Filter、Listener ##

### 定义servlet、filter、listener如下： ###

//servlet
    public class MyServlet extends HttpServlet {
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            doPost(req, resp);
        }
    
        @Override
        protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            resp.getWriter().println("hello MyServlet");
        }
    }
    
    
    //filter
    public class MyFilter implements Filter {
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
            System.out.println("过滤器生效了...");
            //放行
            filterChain.doFilter(servletRequest, servletResponse);
        }
    
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
    
        }
    
        @Override
        public void destroy() {
    
        }
    }
    
    //listener
    public class MyListener implements ServletContextListener {
    
        @Override
        public void contextInitialized(ServletContextEvent sce) {
            System.out.println("项目启动...");
        }
    
        @Override
        public void contextDestroyed(ServletContextEvent sce) {
            System.out.println("项目停止...");
        }
    }

### 将servlet、filter、listener注入到容器中。 ###

//注册自己的Servlet
        @Bean
        public ServletRegistrationBean servletRegistrationBean() {
            ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean();
            servletRegistrationBean.setServlet(new MyServlet());
            servletRegistrationBean.setUrlMappings(Arrays.asList("/hello", "/aaa"));
            servletRegistrationBean.setLoadOnStartup(1);
            return servletRegistrationBean;
        }
    
        //注册自己的filter
        @Bean
        public FilterRegistrationBean filterRegistrationBean() {
            FilterRegistrationBean<MyFilter> myFilterFilterRegistrationBean = new FilterRegistrationBean<>();
            myFilterFilterRegistrationBean.setFilter(new MyFilter());
            //对 "/hello", "/aaa" 进行过滤
            myFilterFilterRegistrationBean.setUrlPatterns(Arrays.asList("/hello", "/aaa"));
            return myFilterFilterRegistrationBean;
        }
    
    
        //注册自己的监听器
        @Bean
        public ServletListenerRegistrationBean servletListenerRegistrationBean() {
            ServletListenerRegistrationBean servletListenerRegistrationBean = new ServletListenerRegistrationBean();
            servletListenerRegistrationBean.setListener(new MyListener());
            return servletListenerRegistrationBean;
        }

### 还有一种方法是直接使用注解，更方便。 ###

在自己定义的servlet上面加上

@WebServlet(urlPatterns = {"/hello", "/aaa"})

在自己定义的Filter上面加上

@WebFilter(urlPatterns = {"/hello", "/aaa"})

在自己定义的Listener上加上

@WebListener

此外要告诉springboot开启扫描，在springboot启动类上面加上

@ServletComponentScan，上面的注解就会生效

## 3、替换为其他servlet容器 ##

在springboot中默认容器是Tomcat，并且springboot还支持Jetty和Udertow,如何将Tomcat替换为其他容器呢？

**使用Jetty作为servlet容器**

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <exclusions>
                    
                    <exclusion>
                        <artifactId>org.springframework.boot</artifactId>
                        <groupId>spring-boot-starter-tomcat</groupId>
                    </exclusion>
                </exclusions>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jetty</artifactId>
            </dependency>

![20190119134258199.png][]

**使用Undertow作为servlet容器**

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <exclusions>
                    
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-tomcat</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-undertow</artifactId>
            </dependency>

![20190119134835199.png][]

## 4、使用外部的Servlet容器 ##

步骤：

第一步：创建项目时打包方式为war， 可以使用IDEA补全目录结构（webapp/WEB-INF/web.xml）

第二步：将tomcat的scope指定为provided

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
                <scope>provided</scope>
            </dependency>

第三步：编写一个类，继承SpringBootServletInitializer实现里面的configure方法。在此方法中启动springboot主类。

public class ServletInitializer extends SpringBootServletInitializer {
    
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
            return application.sources(SpringbootJspApplication.class);
        }
    
    }

第四步：启动服务器。可以利用IDEA指定外部的servlet容器。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3VqaWFuX0xpdQ_size_16_color_FFFFFF_t_70][]

[20190119134258199.png]: /images/20220325/f785dd484d4f49e691d0730a021db8a1.png
[20190119134835199.png]: /images/20220325/db27c7767a7e4625a73d7d6b7a6507f6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3VqaWFuX0xpdQ_size_16_color_FFFFFF_t_70]: /images/20220325/c68e75c8a02b4cfbafe1186c91379997.png