1. Обзор
Spring Boot предоставляет разумные значения по умолчанию для многих свойств конфигурации. Но иногда нам нужно настроить их с нашими значениями для конкретного случая.
Распространенным вариантом использования является изменение порта по умолчанию для встроенного сервера.
В этом кратком руководстве мы рассмотрим несколько способов добиться этого.
2. Использование файлов свойств
Самый быстрый и простой способ настроить Spring Boot — переопределить значения свойств по умолчанию.
Для порта сервера мы хотим изменить свойство server.port .
По умолчанию встроенный сервер запускается на порту 8080.
Итак, давайте посмотрим, как предоставить другое значение в файле application.properties :
server.port=8081
Теперь сервер запустится на порту 8081.
И мы можем сделать то же самое, если используем файл application.yml :
server:
port : 8081
Оба файла автоматически загружаются Spring Boot, если они помещены в каталог src/main/resources приложения Maven.
2.1. Порты, зависящие от среды
Если у нас есть приложение, развернутое в разных средах, мы можем захотеть, чтобы оно работало на разных портах в каждой системе.
Мы можем легко добиться этого, объединив подход файлов свойств с профилями Spring. В частности, мы можем создать файл свойств для каждой среды.
Например, у нас будет файл application-dev.properties с таким содержимым:
server.port=8081
Затем мы добавим еще один файл application-qa.properties с другим портом:
server.port=8082
Теперь конфигурации файлов свойств должно быть достаточно для большинства случаев. Однако есть и другие варианты этой цели, поэтому давайте рассмотрим и их.
3. Программная конфигурация
Мы можем настроить порт программно, установив определенное свойство при запуске приложения или настроив конфигурацию встроенного сервера.
Во-первых, давайте посмотрим, как установить свойство в основном классе @SpringBootApplication :
@SpringBootApplication
public class CustomApplication {
public static void main(String[] args) {
SpringApplication app = new SpringApplication(CustomApplication.class);
app.setDefaultProperties(Collections
.singletonMap("server.port", "8083"));
app.run(args);
}
}
Далее, чтобы настроить конфигурацию сервера, мы должны реализовать интерфейс WebServerFactoryCustomizer :
@Component
public class ServerPortCustomizer
implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
@Override
public void customize(ConfigurableWebServerFactory factory) {
factory.setPort(8086);
}
}
Обратите внимание, что это относится к версии Spring Boot 2.x.
Для Spring Boot 1.x мы можем аналогичным образом реализовать интерфейс EmbeddedServletContainerCustomizer .
4. Использование аргументов командной строки
При упаковке и запуске нашего приложения в виде jar-файла мы можем установить аргумент server.port с помощью команды java :
java -jar spring-5.jar --server.port=8083
или используя эквивалентный синтаксис:
java -jar -Dserver.port=8083 spring-5.jar
5. Порядок оценки
В заключение давайте посмотрим на порядок, в котором эти подходы оцениваются Spring Boot.
По сути, приоритет конфигураций
- конфигурация встроенного сервера
- аргументы командной строки
- файлы свойств
- основная конфигурация
@SpringBootApplication
6. Заключение
В этой статье мы увидели, как настроить порт сервера в приложении Spring Boot.
Как всегда, исходный код примеров доступен на GitHub .