Spring Boot 教程8：配置 Spring Boot Web 应用程序

Spring Boot 教程8：配置 Spring Boot Web 应用程序

声明

这个系列文章是翻译自https://www.baeldung.com/的系列博客，个人感觉是一个非常不错的Spring Boot 教程。原网站属于一个公司，主要开展有偿培训业务，但提供相关文字教程的免费阅读和下载。因为我并没有在网页找到相关版权描述信息，所以并不能确定是否可以自由翻译和转载，如果有版权问题，请联系我，我会撤下这个系列文章。

原文地址：Configuring A Spring Boot Application

因为版权的关系，本文禁止转载。

---

概述

Spring Boot 可以做很多事情;在本教程中，我们将介绍一些靴子中比较有趣的配置选项。

端口号

在主要的单机应用中，主HTTP端口默认为8080;我们可以轻松地配置靴子使用不同的端口：

server.port=8083

对于基于YAML的配置：

server:
    port: 8083

我们还可以通过编程方式自定义服务器端口：

@Component
public class CustomizationBean implements
  WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
 
    @Override
    public void customize(ConfigurableServletWebServerFactory container) {
        container.setPort(8083);
    }
}

上下文路径

默认情况下，上下文路径（context path）为“/”。如果这不是理想的，你需要改变它——像 /app_name，这里是快速和简单的方法来做它通过属性：

server.servlet.contextPath=/springbootapp

对于基于YAML的配置：

server:
    servlet:
        contextPath:/springbootapp

最后，也可以通过编程方式进行更改：

@Component
public class CustomizationBean
  implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
 
    @Override
    public void customize(ConfigurableServletWebServerFactorycontainer) {
        container.setContextPath("/springbootapp");
    }
}

空白标签错误页

如果您没有在配置中指定任何自定义实现，Spring Boot 会自动注册 BasicErrorController bean。

然而，这个默认控制器当然可以被配置为：

public class MyCustomErrorController implements ErrorController {
 
    private static final String PATH = "/error";
    
    @GetMapping(value=PATH)
    public String error() {
        return "Error haven";
    }
}

自定义错误信息

Boot 默认提供 /error 映射，以合理的方式处理错误。

如果你想配置更具体的错误页面，可以使用统一的Java DSL来自定义错误处理：

@Component
public class CustomizationBean
  implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
 
    @Override
    public void customize(ConfigurableServletWebServerFactorycontainer) {        
        container.addErrorPages(new ErrorPage(HttpStatus.BAD_REQUEST, "/400"));
        container.addErrorPages(new ErrorPage("/errorHaven"));
    }
}

在这里，我们专门处理了Bad Request以匹配/400路径，并处理了所有其他路径以匹配公共路径。

一个非常简单的 /errorHaven 实现：

@GetMapping("/errorHaven")
String errorHeaven() {
    return "You have reached the haven of errors!!!";
}

输出：

You have reached the haven of errors!!!

以编程方式关闭 Boot 应用程序

您可以在 SpringApplication 的帮助下以编程方式关闭Boot应用程序。它有一个静态 exit() 方法，接受两个参数：ApplicationContext 和 ExitCodeGenerator ：

@Autowired
public void shutDown(ExecutorServiceExitCodeGenerator exitCodeGenerator) {
    SpringApplication.exit(applicationContext, exitCodeGenerator);
}

通过这种实用方法，我们可以关闭应用程序。

配置日志级别

您可以轻松地调整 Boot 应用程序中的日志记录级别;从1.2.0版开始，您可以在主属性文件中配置日志级别：

logging.level.org.springframework.web: DEBUG
logging.level.org.hibernate: ERROR

就像使用标准Spring应用程序一样，您可以通过在classpath中添加自定义的XML或属性文件并在pom中定义库来激活不同的日志记录系统，如Logback，log4j，log4j2等。

注册一个新的 Servlet

如果你在嵌入式服务器的帮助下部署应用程序，你可以在 Boot 应用程序中注册新的Servlet，方法是从常规配置中将它们暴露为bean：

@Bean
public HelloWorldServlet helloWorld() {
    return new HelloWorldServlet();
}

或者，您可以使用 ServletRegistrationBean：

@Bean
public SpringHelloServletRegistrationBean servletRegistrationBean() {
 
    SpringHelloServletRegistrationBean bean = new SpringHelloServletRegistrationBean(
      new SpringHelloWorldServlet(), "/springHelloWorld/*");
    bean.setLoadOnStartup(1);
    bean.addInitParameter("message", "SpringHelloWorldServlet special message");
    return bean;
}

在 Boot 应用程序中配置 Jetty 或 Undertow

Spring Boot 启动器通常使用Tomcat作为默认的嵌入式服务器。如果需要更改，您可以排除Tomcat依赖项，并包含Jetty或Undertow：

配置 Jetty

<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-jetty</artifactId>
</dependency>

@Bean
public JettyEmbeddedServletContainerFactory  jettyEmbeddedServletContainerFactory() {
    JettyEmbeddedServletContainerFactory jettyContainer = 
      new JettyEmbeddedServletContainerFactory();
    
    jettyContainer.setPort(9000);
    jettyContainer.setContextPath("/springbootapp");
    return jettyContainer;
}

配置 Undertow

<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>

@Bean
public UndertowEmbeddedServletContainerFactory embeddedServletContainerFactory() {
    UndertowEmbeddedServletContainerFactory factory = 
      new UndertowEmbeddedServletContainerFactory();
    
    factory.addBuilderCustomizers(new UndertowBuilderCustomizer() {
        @Override
        public void customize(io.undertow.Undertow.Builder builder) {
            builder.addHttpListener(8080, "0.0.0.0");
        }
    });
    
    return factory;
}

结论

在这篇快速文章中，我们讨论了一些更有趣和有用的Spring Boot 配置选项。

当然，在参考文档中还有很多很多选项可以根据您的需求配置和调整 Boor 应用程序——这些只是我发现的一些更有用的选项。

本文中使用的代码可以在我们的Github存储库中找到。