6 Methods to Configure port for a Spring Boot Software? Instance Tutorial

Methodology 5: Programmatically in Code

In sure circumstances, you might need to configure the port programmatically in your Java code. To attain this, create a configuration class and annotate it with @Configuration. Then, outline a bean of kind EmbeddedServletContainerCustomizer to customise the embedded servlet container settings. Here is an instance:

import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;

@Configuration
public class PortConfiguration {

    @Bean
    public EmbeddedServletContainerCustomizer containerCustomizer() {
        return (ConfigurableEmbeddedServletContainer container) -> {
            container.setPort(your_desired_port_number);
        };
    }
}

Methodology 6: Configuring Port Vary

In some circumstances, you might have to configure a variety of ports as an alternative of a particular port. This may be helpful when working a number of situations of your Spring Boot software or when deploying in a clustered setting. To configure a port vary, you may modify the appliance.properties file or use any of the beforehand talked about strategies.

To configure a port vary in software.properties, use the next syntax:

server.port=your_starting_port_number-your_ending_port_number

Exchange your_starting_port_number and your_ending_port_number with the specified vary of port numbers. For instance, server.port=8080-8090 configures the appliance to run on ports starting from 8080 to 8090.

Alternatively, you may apply the identical configurations utilizing YAML, command line arguments, setting variables, or programmatically in code, as mentioned within the earlier strategies.

Methodology 7: Random Port Allocation

Spring Boot gives an choice to allocate a random obtainable port to your software. This may be helpful in eventualities the place you do not need to hardcode a particular port and as an alternative let the system assign an obtainable port dynamically. To allow random port allocation, merely omit the server.port configuration in your software.properties or software.yml file.

When the appliance begins, Spring Boot robotically assigns an obtainable port. You possibly can retrieve the dynamically allotted port programmatically utilizing the getLocalPort() technique from the EmbeddedWebApplicationContext or WebServerApplicationContext courses. This lets you log or show the assigned port throughout runtime.

import org.springframework.beans.manufacturing unit.annotation.Autowired;
import org.springframework.boot.net.context.WebServerApplicationContext;
import org.springframework.stereotype.Part;

@Part
public class PortLogger {

    @Autowired
    personal WebServerApplicationContext applicationContext;

    public void logPort() {
        int port = applicationContext.getWebServer().getPort();
        System.out.println("Software is working on port: " + port);
    }
}

Within the instance above, the PortLogger element logs the assigned port throughout runtime.

server {
    hear 80;
    server_name your_domain.com;

    location / {
        proxy_pass http://localhost:your_desired_port_number;
        proxy_set_header Host $host;
        proxy_set_header X-Actual-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

Exchange your_desired_port_number with the port quantity the place your Spring Boot software is working. Save the configuration file and restart the reverse proxy server. Requests obtained on the desired port will probably be forwarded to your Spring Boot software.

Conclusion

That is all about learn how to configure port for a spring Boot software. Configuring the port for a Spring Boot software provides you management over the community port on which your software listens. On this article, we explored totally different strategies to configure the port, together with utilizing configuration recordsdata, command line arguments, setting variables, and programmatically in code. We additionally mentioned configuring port ranges and enabling random port allocation.

By choosing the suitable technique based mostly in your necessities, you may successfully customise the port configuration to your Spring Boot software. Whether or not you want a particular port, a variety of ports, or dynamic allocation, Spring Boot gives the flexibleness to adapt to your wants and guarantee clean software deployment and operation.