Spring Boot - 如何获取正在运行的端口

时间:2015-05-18 20:14:48

标签: spring spring-boot port embedded-tomcat-7

我有一个spring boot应用程序(使用嵌入式tomcat 7),我在CONTRIBUTING.md中设置了server.port = 0,所以我可以有一个随机端口。服务器启动并在端口上运行后,我需要能够获得所选的端口。

我不能使用application.properties因为它是零。这是一个看似简单的信息,为什么我不能从我的java代码中访问它?我该如何访问它?

11 个答案:

答案 0 :(得分:62)

是否也可以以类似的方式访问管理端口,例如:

public JsonResult Create (TLSModel T)
    {
        bool status = true;            
        TicketMaster ticket = new TicketMaster { Titel = T.Titel };
        foreach(var i in T.TicketDetails)
        {
            ticket.TicketDetails.Add(i);
        }
        db.TicketMasters.Add(ticket);
        db.SaveChanges();
        return new JsonResult { Data = new { status = status } };            
    }    

答案 1 :(得分:43)

Spring's Environment为您保留这些信息。

@Autowired
Environment environment;

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

从表面上看,这看起来与注入注释@Value("${local.server.port}")(或@LocalServerPort的字段相同)的字段相同,从而在启动时抛出自动装配失败,因为在上下文之前该值不可用完全初始化。这里的区别在于,此调用隐式在运行时业务逻辑中进行,而不是在应用程序启动时调用,因此端口的“lazy-fetch”可以解决。

答案 2 :(得分:18)

感谢@Dirk Lachowski指出我正确的方向。解决方案并不像我希望的那样优雅,但我得到了它的工作。阅读spring docs,我可以监听EmbeddedServletContainerInitializedEvent并在服务器启动并运行后获取端口。这是它的样子 -

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();
      }
    }

答案 3 :(得分:10)

您可以通过注入local.server.port值来获取嵌入式Tomcat实例在测试期间使用的端口:

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

答案 4 :(得分:9)

从Spring Boot 1.4.0开始,您可以在测试中使用它:

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

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

  @LocalServerPort
  int randomPort;

  // ...
}

答案 5 :(得分:8)

就像其他配置了我们的应用程序的人一样,从我经历过的事情中受益......

上述解决方案都不适用于我,因为我的项目基础下有一个./config目录,包含2个文件:

application.properties
application-dev.properties

application.properties我有:

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

application-dev.properties我有:

server_host = localhost
server_port = 8080

当我从CLI运行我的胖罐时,*.properties目录中的./config文件将被读取,并且一切都很好。

嗯,事实证明这些属性文件完全覆盖了我的Spock规范中webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT中的@SpringBootTest设置。无论我尝试了什么,即使将webEnvironment设置为RANDOM_PORT Spring也总是在端口8080上启动嵌入式Tomcat容器(或者我在./config/*.properties文件中设置的任何值)。< / p>

我能够克服这个问题的 ONLY 方法是在我的Spock集成规范中向properties = "server_port=0"注释中添加一个明确的@SpringBootTest

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

然后,只有这样,Spring终于开始在一个随机端口上启动Tomcat。恕我直言这是一个Spring测试框架错误,但我相信他们对此有自己的看法。

希望这有助于某人。

答案 6 :(得分:5)

这些解决方案都不适合我。构建Swagger配置bean时,我需要知道服务器端口。使用ServerProperties为我工作:

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

此示例使用Spring Boot自动配置和JAX-RS(不是Spring MVC)。

答案 7 :(得分:2)

您可以从

获取服务器端口
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();
}
    

答案 8 :(得分:1)

Spring Boot 2之后,发生了很多变化。上面给出的答案在Spring Boot 2之前有效。现在,如果使用服务器端口的运行时参数运行应用程序,则只能使用@Value("${server.port}")获得静态值,这在应用程序中已提到.properties 文件。现在,要获取运行服务器的实际端口,请使用以下方法:

    @Autowired
    private ServletWebServerApplicationContext server;

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

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

此外,如果您将应用程序用作负载平衡为RestTemplateWebClient的Eureka / Discovery Client,则上述方法将返回确切的端口号。

答案 9 :(得分:0)

请确保您导入了正确的软件包

import org.springframework.core.env.Environment;

然后使用环境对象

@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"));
    }

答案 10 :(得分:0)

我用一种代理bean解决了它。客户端在需要时进行初始化,届时该端口应该可用:

@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;
    }
}