如何使Javamelody使用不同的端口（Spring Boot + 暴露两个HTTP端口）

Question

我有一个Spring Boot Web应用程序，它在端口8080上公开REST API。它还使用Spring Boot管理端点（http://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-monitoring.html）暴露了管理端口8081。 我没有任何自定义的Tomcat配置来实现这一点。我只是在我的application.properties文件中拥有属性management.port=8081。

我已经按照https://github.com/javamelody/javamelody/wiki/UserGuideAdvanced#spring-boot-app中的说明配置了JavaMelody（我有自定义的JavaMelodyConfiguration类，其中包含org.springframework.boot.web.servlet.FilterRegistrationBean，用于注册net.bull.javamelody.MonitoringFilter）。

@Bean
    public FilterRegistrationBean javaMelody() {
        final FilterRegistrationBean javaMelody = new FilterRegistrationBean();
        javaMelody.setFilter(new MonitoringFilter());
        javaMelody.setAsyncSupported(true);
        javaMelody.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ASYNC);
        javaMelody.addUrlPatterns("/*");
        return javaMelody;
    }

使用这个配置，Javamelody会暴露在8080端口（业务端口）。我想将其移动到8081端口（管理端口）。如何更改？

我使用的是Spring Boot 1.4.2.RELEASE和javamelody 1.62.0。

- Bartosz Bilicki

---

搜索您的项目以查找8080，并查看是否找到更改为8081的位置。 - StackFlowed

这不会解决我的问题。我仍然希望我的应用程序将业务 REST API 暴露在 8080 端口，管理 API 暴露在 8081 端口，而 javamelody 则在 8081 端口上。 - Bartosz Bilicki

Answer 1

如果目标是从Java Melody 1.76版本开始暴露管理端口的监控，则要简单得多。

您需要Spring Boot 2.x，actuator以及在yml或properties文件中：

- management.server.port：{您的自定义端口} - management.endpoints.web.exposure.include：{通常您想要的内容}，监控 - javamelody.management-endpoint-monitoring-enabled：true 更多详细信息请参见：https://github.com/javamelody/javamelody/wiki/SpringBootStarter#configuration-in-case-of-management-port

- Michał Cegielski

Answer 2

编辑：这个答案依然正确，但是看一下被接受的答案可能会有更简单的解决方案。

EmbeddedTomcatConfiguration.java

package ...

import java.util.ArrayList;
import java.util.List;

import org.apache.catalina.connector.Connector;
import org.apache.commons.lang.StringUtils;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.embedded.EmbeddedServletContainerFactory;
import org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class EmbeddedTomcatConfiguration {

    @Value("${server.additionalPorts}")
    private String additionalPorts;

    @Bean
    public EmbeddedServletContainerFactory servletContainer() {
        TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();
        Connector[] additionalConnectors = this.additionalConnector();
        if (additionalConnectors != null && additionalConnectors.length > 0) {
            tomcat.addAdditionalTomcatConnectors(additionalConnectors);
        }
        return tomcat;
    }

    private Connector[] additionalConnector() {
        if (StringUtils.isBlank(this.additionalPorts)) {
            return null;
        }
        String[] ports = this.additionalPorts.split(",");
        List<Connector> result = new ArrayList<>();
        for (String port : ports) {
            Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
            connector.setScheme("http");
            connector.setPort(Integer.valueOf(port));
            result.add(connector);
        }
        return result.toArray(new Connector[] {});
    }
}

application.yml

server:
  port: ${appPort:8800}
  additionalPorts: 8880,8881

Application.java

@SpringBootApplication
@ComponentScan(...)
@Import(EmbeddedTomcatConfiguration.class)
public Application {

    public static void main(String[] args) {
        SpringApplication.run(Application .class, args);
    }
}

我建议限制从特定端口访问javamelody，可以通过扩展javamelody过滤器来实现，如果请求来自特定端口，则只需链接请求，否则返回404错误。

日志信息如下：

INFO  TomcatEmbeddedServletContainer:185 - Tomcat started on port(s): 8800 (http) 8880 (http) 8881 (http)

此方法BTW在这些端口上暴露了其他终端点。为了解决这个问题并将javamelody过滤器(/monitoring)限制在特定端口上，您需要编写一个过滤器来验证从允许的端口请求的路径（servlet和过滤器路径），同时记住这些过滤器的顺序非常重要。

基于此答案和我已经可用的部分源代码，我已经发布了一篇关于这个主题的博客文章，网址是http://tech.asimio.net/2016/12/15/Configuring-Tomcat-to-Listen-on-Multiple-ports-using-Spring-Boot.html。

- ootero

---

谢谢！使用这样的配置，当我按照描述注册javamelody时（我已经编辑了我的问题以包括它），net.bull.javamelody.MonitoringFilter会被注册到两个端口吗？ - Bartosz Bilicki

假设您想使用管理端口和管理上下文路径访问Javamelody UI，我建议将Javamelody过滤器映射到/admin/monitoring。 - ootero

我指的是将 server.servlet-path 设置为 /，将 management.context-path 设置为 /admin。 - ootero

Answer 3

您可以通过MvcEndpoint使用ReportServlet。类似于这样：

    import net.bull.javamelody.MonitoringFilter;
    import net.bull.javamelody.ReportServlet;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.actuate.endpoint.Endpoint;
    import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint;
    import org.springframework.boot.web.servlet.FilterRegistrationBean;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.bind.annotation.GetMapping;

    import javax.servlet.ServletConfig;
    import javax.servlet.ServletException;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;

    /**
     * We configure the Java Melody {@link MonitoringFilter} normally, but disables all access to the UI. Instead,
     * we create a {@link ReportServlet}, and expose it through a {@link MvcEndpoint} in {@link #javaMelodyReportEndpoint()}.
     */
    @Configuration
    public class JavaMelodyConfiguration {

        private final ServletConfig servletConfig;

        @Autowired
        public JavaMelodyConfiguration(ServletConfig servletConfig) {
            this.servletConfig = servletConfig;
        }

        @Bean
        MvcEndpoint javaMelodyReportEndpoint() {
            ReportServlet reportServlet = new ReportServlet();
            // We initialize the servlet with the servlet configuration from the server that runs on server.port, as
            // it currently only uses it to access the Collector instance, and some system information.
            reportServlet.init(servletConfig);

            return new MvcEndpoint() {
                @Override
                public String getPath() {
                    return "/monitoring";
                }

                @Override
                public boolean isSensitive() {
                    return false;
                }

                @Override
                public Class<? extends Endpoint> getEndpointType() {
                    return null;
                }

                @GetMapping
                public void report(HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws ServletException, IOException {
                    reportServlet.service(httpRequest, httpResponse);
                }
            };
        }

        @Bean
        FilterRegistrationBean javaMelodyFilterRegistration() {
            FilterRegistrationBean javaMelody = new FilterRegistrationBean();
            javaMelody.setFilter(monitoringFilter());
            javaMelody.setName("javamelody");
            return javaMelody;
        }

        @Bean
        MonitoringFilter monitoringFilter() {
            return new MonitoringFilter() {
                @Override
                protected boolean isAllowed(HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException {
                    // We allow no access to the report (/monitoring) from this filter, access is done through the
                    // MvcEndpoint above, using the management port.
                    return false;
                }
            };
        }
    }

（我也在这里发布了：https://github.com/javamelody/javamelody/issues/601）

- Anders Båtstrand