Spring Boot 应用打 WAR 包后无法注册到 Nacos怎么办

news2024/11/19 20:25:03

你好，我是柳岸花开。

在微服务架构中，服务注册与发现是至关重要的一环。Nacos 作为阿里巴巴开源的注册中心，能够很好地满足这一需求。然而，在将 Spring Boot 应用打包成 WAR 部署到外部服务器时，可能会遇到服务无法注册到 Nacos 的问题。本文将详细讲解这一问题的解决方案。

问题描述

在开发过程中，通常使用 JAR 包运行 Spring Boot 应用，这种方式下，服务注册到 Nacos 通常没有问题。然而，当我们将 Spring Boot 应用打包成 WAR 并部署到外部 Tomcat 服务器时，可能会遇到服务无法注册到 Nacos 的情况。其原因主要是应用获取不到正确的服务器端口。

解决方案

为了在 WAR 包部署时正确地注册服务到 Nacos，我们需要动态地获取实际使用的服务器端口，并将其设置到 Nacos 的服务注册中。以下是一个具体的实现代码：

import com.alibaba.cloud.nacos.registry.NacosAutoServiceRegistration;
import lombok.extern.slf4j.Slf4j;
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.boot.autoconfigure.condition.ConditionalOnProperty;
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;

/**
 * 解决 Spring Boot 应用打 WAR 包后无法注册到 Nacos 的问题
 * 通过动态获取服务器端口并注册到 Nacos
 */
@Slf4j
@ConditionalOnProperty(prefix = "project.deploy", name = "mode", havingValue = "war")
@Component
public class NacosConfig implements ApplicationRunner {

    @Autowired
    private NacosAutoServiceRegistration registration;

    @Value("${server.port:8080}")
    Integer port;

    @Override
    public void run(ApplicationArguments args) {
        if (registration != null && port != null) {
            Integer serverPort = port;
            try {
                serverPort = new Integer(getServerPort());
            } catch (Exception e) {
                log.warn("getServerPort warn", e);
                log.info("getServerPort fail, use the config-file's port {}", port);
            }
            registration.setPort(serverPort);
            registration.start();
        }
    }

    /**
     * 获取实际使用的服务器端口
     */
    public String getServerPort() 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");
        log.debug("getServerPort {}", port);
        return port;
    }
}

代码解析

1. 类与注解

@Slf4j
@ConditionalOnProperty(prefix = "project.deploy", name = "mode", havingValue = "war")
@Component
public class NacosConfig implements ApplicationRunner {

@Slf4j：Lombok 提供的注解，用于生成日志记录器。
@ConditionalOnProperty：只有在 project.deploy.mode 属性值为 war 时，才会创建这个 NacosConfig bean。
@Component：标记为 Spring 的组件，使其能够被 Spring 扫描和管理。
ApplicationRunner：实现该接口的 run 方法将在应用启动时运行。

2. 自动注入与配置

@Autowired
private NacosAutoServiceRegistration registration;

@Value("${server.port:8080}")
Integer port;

@Autowired：注入 Nacos 的服务注册类 NacosAutoServiceRegistration。
@Value：注入配置文件中的端口号，如果未配置则默认使用 6888 端口。

3. 启动时设置端口

@Override
public void run(ApplicationArguments args) {
    if (registration != null && port != null) {
        Integer serverPort = port;
        try {
            serverPort = new Integer(getServerPort());
        } catch (Exception e) {
            log.warn("getServerPort warn", e);
            log.info("getServerPort fail, use the config-file's port {}", port);
        }
        registration.setPort(serverPort);
        registration.start();
    }
}

在应用启动时尝试获取实际使用的服务器端口，如果获取失败则使用配置文件中的端口。
将端口设置到 Nacos 的服务注册中，并启动服务注册。

4. 获取实际端口

public String getServerPort() 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");
    log.debug("getServerPort {}", port);
    return port;
}