Spring Boot - Cách lấy cổng đang chạy

Tôi có một ứng dụng khởi động mùa xuân (sử dụng tomcat 7 được nhúng) và tôi đã cài đặt ứng dụng server.port = 0của mình application.propertiesđể tôi có thể có một cổng ngẫu nhiên. Sau khi máy chủ được khởi động và chạy trên một cổng, tôi cần có thể nhận được cổng đã được chọn.

Tôi không thể sử dụng @Value("$server.port")vì nó bằng không. Đây là một thông tin có vẻ đơn giản, vậy tại sao tôi không thể truy cập nó từ mã java của mình? Làm thế nào tôi có thể truy cập nó?

Cũng có thể truy cập cổng quản lý theo cách tương tự, ví dụ:

  @SpringBootTest(classes = {Application.class}, webEnvironment = WebEnvironment.RANDOM_PORT)
  public class MyTest {

    @LocalServerPort
    int randomServerPort;

    @LocalManagementPort
    int randomManagementPort;

Spring's Environment giữ thông tin này cho bạn.

@Autowired
Environment environment;

String port = environment.getProperty("local.server.port");

Nhìn bề ngoài, điều này trông giống với việc đưa vào một trường được chú thích @Value("${local.server.port}")(hoặc @LocalServerPortgiống hệt), theo đó lỗi tự động tạo ra khi khởi động vì giá trị không có sẵn cho đến khi khởi tạo hoàn toàn ngữ cảnh. Sự khác biệt ở đây là lệnh gọi này được thực hiện ngầm trong logic nghiệp vụ thời gian chạy thay vì được gọi khi khởi động ứng dụng, và do đó 'lazy-fetch' của cổng được giải quyết ổn.

Cảm ơn @Dirk Lachowski đã chỉ tôi đúng hướng. Giải pháp này không thanh lịch như tôi muốn, nhưng tôi đã làm được. Đọc tài liệu mùa xuân, tôi có thể nghe trên EmbeddedServletContainerInitializedEvent và nhận cổng sau khi máy chủ khởi động và chạy. Đây là những gì nó trông như thế này -

import org.springframework.boot.context.embedded.EmbeddedServletContainerInitializedEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;




    @Component
    public class MyListener implements ApplicationListener<EmbeddedServletContainerInitializedEvent> {

      @Override
      public void onApplicationEvent(final EmbeddedServletContainerInitializedEvent event) {
          int thePort = event.getEmbeddedServletContainer().getPort();
      }
    }

Để những người khác đã định cấu hình ứng dụng của họ như ứng dụng của tôi được hưởng lợi từ những gì tôi đã trải qua ...

Không có giải pháp nào ở trên phù hợp với tôi vì tôi có một ./configthư mục ngay dưới cơ sở dự án của mình với 2 tệp:

application.properties
application-dev.properties

Trong đó, application.propertiestôi có:

spring.profiles.active = dev  # set my default profile to 'dev'

Trong application-dev.propertiestôi có:

server_host = localhost
server_port = 8080

Điều này là do đó khi tôi chạy lọ béo của mình từ CLI, các *.propertiestệp sẽ được đọc từ ./configdir và tất cả đều tốt.

Chà, hóa ra các tệp thuộc tính này hoàn toàn ghi đè webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORTcài đặt trong @SpringBootTestthông số kỹ thuật Spock của tôi. Bất kể tôi đã thử gì, ngay cả khi webEnvironmentđặt thành RANDOM_PORTSpring sẽ luôn khởi động vùng chứa Tomcat được nhúng trên cổng 8080 (hoặc bất kỳ giá trị nào tôi đã đặt trong ./config/*.propertiestệp của mình ).

Cách DUY NHẤT tôi có thể khắc phục điều này là thêm một chú thích rõ ràng properties = "server_port=0"vào @SpringBootTestthông số kỹ thuật tích hợp Spock của tôi:

@SpringBootTest (webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, properties = "server_port=0")

Sau đó, và chỉ sau đó, Spring cuối cùng mới bắt đầu quay Tomcat trên một cổng ngẫu nhiên. IMHO đây là một lỗi khung kiểm tra Spring, nhưng tôi chắc chắn rằng họ sẽ có ý kiến ​​riêng về điều này.

Hy vọng điều này đã giúp ai đó.

Bạn có thể lấy cổng đang được sử dụng bởi một phiên bản Tomcat nhúng trong quá trình kiểm tra bằng cách đưa vào giá trị local.server.port như sau:

// Inject which port we were assigned
@Value("${local.server.port}")
int port;

Bắt đầu với Spring Boot 1.4.0, bạn có thể sử dụng điều này trong thử nghiệm của mình:

import org.springframework.boot.context.embedded.LocalServerPort;

@SpringBootTest(classes = {Application.class}, webEnvironment = WebEnvironment.RANDOM_PORT)
public class MyTest {

  @LocalServerPort
  int randomPort;

  // ...
}

Không có giải pháp nào trong số này hiệu quả với tôi. Tôi cần biết cổng máy chủ trong khi xây dựng bean cấu hình Swagger. Sử dụng ServerProperties phù hợp với tôi:

import javax.annotation.PostConstruct;
import javax.inject.Inject;
import javax.ws.rs.ApplicationPath;

import io.swagger.jaxrs.config.BeanConfig;
import io.swagger.jaxrs.listing.ApiListingResource;
import io.swagger.jaxrs.listing.SwaggerSerializers;

import org.glassfish.jersey.server.ResourceConfig;
import org.springframework.stereotype.Component;

@Component
@ApplicationPath("api")
public class JerseyConfig extends ResourceConfig 
{
    @Inject
    private org.springframework.boot.autoconfigure.web.ServerProperties serverProperties;

    public JerseyConfig() 
    {
        property(org.glassfish.jersey.server.ServerProperties.BV_SEND_ERROR_IN_RESPONSE, true);
    }

    @PostConstruct
    protected void postConstruct()
    {
        // register application endpoints
        registerAndConfigureSwaggerUi();
    }

    private void registerAndConfigureSwaggerUi()
    {
        register(ApiListingResource.class);
        register(SwaggerSerializers.class);

        final BeanConfig config = new BeanConfig();
        // set other properties
        config.setHost("localhost:" + serverProperties.getPort()); // gets server.port from application.properties file         
    }
}

Ví dụ này sử dụng cấu hình tự động Spring Boot và JAX-RS (không phải Spring MVC).

Sau Spring Boot 2, rất nhiều thứ đã thay đổi. Các câu trả lời đưa ra ở trên hoạt động trước Spring Boot 2. Bây giờ nếu bạn đang chạy ứng dụng của mình với các đối số thời gian chạy cho cổng máy chủ, thì bạn sẽ chỉ nhận được giá trị tĩnh với @Value("${server.port}"), được đề cập trong tệp application.properties . Bây giờ để có được cổng thực tế mà máy chủ đang chạy, hãy sử dụng phương pháp sau:

    @Autowired
    private ServletWebServerApplicationContext server;

    @GetMapping("/server-port")
    public String serverPort() {

        return "" + server.getWebServer().getPort();
    }

Ngoài ra, nếu bạn đang sử dụng các ứng dụng của mình dưới dạng Ứng dụng khách Eureka / Discovery với tải cân bằng RestTemplatehoặc WebClient, phương pháp trên sẽ trả về số cổng chính xác.

Bạn có thể lấy cổng máy chủ từ

HttpServletRequest

@Autowired
private HttpServletRequest request;

@GetMapping(value = "/port")
public Object getServerPort() {
   System.out.println("I am from " + request.getServerPort());
   return "I am from  " + request.getServerPort();
}
    

Hãy đảm bảo rằng bạn đã nhập đúng gói

import org.springframework.core.env.Environment;

và sau đó sử dụng đối tượng Môi trường

@Autowired
private Environment env;    // Environment Object containts the port number

 @GetMapping("/status")
  public String status()
    {
   return "it is runing on"+(env.getProperty("local.server.port"));
    }

Tôi đã giải quyết nó bằng một loại đậu ủy nhiệm. Máy khách được khởi tạo khi cần thiết, khi đó cổng sẽ khả dụng:

@Component
public class GraphQLClient {

    private ApolloClient apolloClient;
    private final Environment environment;

    public GraphQLClient(Environment environment) {
        this.environment = environment;
    }

    public ApolloClient getApolloClient() {
        if (apolloClient == null) {
            String port = environment.getProperty("local.server.port");
            initApolloClient(port);
        }
        return apolloClient;
    }

    public synchronized void initApolloClient(String port) {
        this.apolloClient = ApolloClient.builder()
                .serverUrl("http://localhost:" + port + "/graphql")
                .build();
    }

    public <D extends Operation.Data, T, V extends Operation.Variables> GraphQLCallback<T> graphql(Operation<D, T, V> operation) {
        GraphQLCallback<T> graphQLCallback = new GraphQLCallback<>();
        if (operation instanceof Query) {
            Query<D, T, V> query = (Query<D, T, V>) operation;
            getApolloClient()
                    .query(query)
                    .enqueue(graphQLCallback);
        } else {
            Mutation<D, T, V> mutation = (Mutation<D, T, V>) operation;
            getApolloClient()
                    .mutate(mutation)
                    .enqueue(graphQLCallback);

        }
        return graphQLCallback;
    }
}