【轉】Spring Boot項目部署到tomcat下無法Nacos中註冊服務

問題

使用Nacos作爲註冊中心的Spring Boot項目，以war包形式部署到服務器上，啓動項目發現該服務無法在Nacos中註冊。

分析

查看源碼，需從nacos的註冊類找起，查找後發現，nacos註冊類NacosAutoServiceRegistration繼承了Spring Cloud中AbstractAutoServiceRegistration, 而在AbstractAutoServiceRegistration中綁定了一個監聽事件，監聽內置容器啓動完成事件，監聽到獲取容器端口後向註冊中心註冊。

@EventListener({WebServerInitializedEvent.class})
    public void bind(WebServerInitializedEvent event) {
        ApplicationContext context = event.getApplicationContext();
        if (!(context instanceof ConfigurableWebServerApplicationContext) ||
         !"management".equals(((ConfigurableWebServerApplicationContext)context).getServerNamespace())) {
            this.port.compareAndSet(0, event.getWebServer().getPort());
            this.start();
        }
 
}

而使用外部容器時，不能監聽到事件，所以自動註冊失敗。

解決方案

Spring Boot提供了ApplicationRunner接口，是在應用起好之後執行一些初始化動作。通過這個接口我們可以實現啓動項目後註冊服務。使用這種方法，需要在配置文件中配置端口號，如果一個應用部署很多端口，每個應用都要配置，很不方便。故可獲取外部tomcat自動設置端口。經測試，方法可行。

package com.bjbde.trade.configurer;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.cloud.alibaba.nacos.registry.NacosAutoServiceRegistration;
import org.springframework.stereotype.Component;
 
import javax.management.MBeanServer;
import javax.management.ObjectName;
import javax.management.Query;
import java.lang.management.ManagementFactory;
import java.util.Set;
 
@Component
public class NacosConfig implements ApplicationRunner {
 
    @Autowired(required = false)
    private NacosAutoServiceRegistration registration;
 
    @Value("${server.port}")
    Integer port;
 
    @Override
    public void run(ApplicationArguments args) {
        if (registration != null && port != null) {
            Integer tomcatPort = port;
            try {
                tomcatPort = new Integer(getTomcatPort());
            } catch (Exception e) {
                e.printStackTrace();
            }
            registration.setPort(tomcatPort);
            registration.start();
        }
    }
 
	/**
	*	獲取外部tomcat端口
	*/
    public String getTomcatPort() throws Exception {
        MBeanServer beanServer = ManagementFactory.getPlatformMBeanServer();
        Set<ObjectName> objectNames = beanServer.queryNames(new ObjectName("*:type=Connector,*"), 
        Query.match(Query.attr("protocol"), Query.value("HTTP/1.1")));
        String port = objectNames.iterator().next().getKeyProperty("port");
        return port;
    }
}

提示

在部署項目要注意版本問題，如Spring Boot 2.0.6應該部署在tomcat8以上版本，筆者就曾忽略這個版本而部署到tomcat7中，導致項目啓動報錯。 Spring Boot與tomcat版本對應的問題可參照另外一篇博客

https://my.oschina.net/u/3193075/blog/3084074