Spring?Boot應(yīng)用打WAR包后無(wú)法注冊(cè)到Nacos的問(wèn)題及解決方法

更新時(shí)間：2024年06月06日 11:04:45 作者：柳岸花開(kāi)

當(dāng)我們將?Spring?Boot?應(yīng)用打包成?WAR?并部署到外部?Tomcat?服務(wù)器時(shí),可能會(huì)遇到服務(wù)無(wú)法注冊(cè)到?Nacos?的情況,其原因主要是應(yīng)用獲取不到正確的服務(wù)器端口,下面給大家介紹Spring?Boot?應(yīng)用打?WAR?包后無(wú)法注冊(cè)到?Nacos的問(wèn)題及解決方法,感興趣的朋友跟隨小編一起看看吧

在微服務(wù)架構(gòu)中，服務(wù)注冊(cè)與發(fā)現(xiàn)是至關(guān)重要的一環(huán)。Nacos 作為阿里巴巴開(kāi)源的注冊(cè)中心，能夠很好地滿(mǎn)足這一需求。然而，在將 Spring Boot 應(yīng)用打包成 WAR 部署到外部服務(wù)器時(shí)，可能會(huì)遇到服務(wù)無(wú)法注冊(cè)到 Nacos 的問(wèn)題。本文將詳細(xì)講解這一問(wèn)題的解決方案。

問(wèn)題描述

在開(kāi)發(fā)過(guò)程中，通常使用 JAR 包運(yùn)行 Spring Boot 應(yīng)用，這種方式下，服務(wù)注冊(cè)到 Nacos 通常沒(méi)有問(wèn)題。然而，當(dāng)我們將 Spring Boot 應(yīng)用打包成 WAR 并部署到外部 Tomcat 服務(wù)器時(shí)，可能會(huì)遇到服務(wù)無(wú)法注冊(cè)到 Nacos 的情況。其原因主要是應(yīng)用獲取不到正確的服務(wù)器端口。

解決方案

為了在 WAR 包部署時(shí)正確地注冊(cè)服務(wù)到 Nacos，我們需要?jiǎng)討B(tài)地獲取實(shí)際使用的服務(wù)器端口，并將其設(shè)置到 Nacos 的服務(wù)注冊(cè)中。以下是一個(gè)具體的實(shí)現(xiàn)代碼：

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 應(yīng)用打 WAR 包后無(wú)法注冊(cè)到 Nacos 的問(wèn)題
 * 通過(guò)動(dòng)態(tài)獲取服務(wù)器端口并注冊(cè)到 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();
        }
    }
    /**
     * 獲取實(shí)際使用的服務(wù)器端口
     */
    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. 類(lèi)與注解

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

@Slf4j：Lombok 提供的注解，用于生成日志記錄器。
@ConditionalOnProperty：只有在 project.deploy.mode 屬性值為 war 時(shí)，才會(huì)創(chuàng)建這個(gè) NacosConfig bean。
@Component：標(biāo)記為 Spring 的組件，使其能夠被 Spring 掃描和管理。
ApplicationRunner：實(shí)現(xiàn)該接口的 run 方法將在應(yīng)用啟動(dòng)時(shí)運(yùn)行。

2. 自動(dòng)注入與配置

@Autowired
private NacosAutoServiceRegistration registration;
@Value("${server.port:8080}")
Integer port;

@Autowired：注入 Nacos 的服務(wù)注冊(cè)類(lèi) NacosAutoServiceRegistration。
@Value：注入配置文件中的端口號(hào)，如果未配置則默認(rèn)使用 6888 端口。

3. 啟動(dòng)時(shí)設(shè)置端口

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

在應(yīng)用啟動(dòng)時(shí)嘗試獲取實(shí)際使用的服務(wù)器端口，如果獲取失敗則使用配置文件中的端口。
將端口設(shè)置到 Nacos 的服務(wù)注冊(cè)中，并啟動(dòng)服務(wù)注冊(cè)。

4. 獲取實(shí)際端口

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

通過(guò) JMX 管理接口獲取實(shí)際使用的 HTTP 端口。

總結(jié)

通過(guò)上述代碼，我們可以實(shí)現(xiàn)在 Spring Boot 應(yīng)用啟動(dòng)時(shí)，動(dòng)態(tài)獲取并設(shè)置 Nacos 注冊(cè)的端口號(hào)。這對(duì)于在不同環(huán)境中部署應(yīng)用非常有用，可以避免硬編碼端口號(hào)帶來(lái)的問(wèn)題。同時(shí)，結(jié)合 Nacos 的服務(wù)注冊(cè)與發(fā)現(xiàn)功能，可以更加靈活地管理微服務(wù)架構(gòu)中的各個(gè)服務(wù)。

到此這篇關(guān)于Spring Boot 應(yīng)用打 WAR 包后無(wú)法注冊(cè)到 Nacos怎么辦的文章就介紹到這了,更多相關(guān)Spring Boot打 WAR 包無(wú)法注冊(cè)到 Nacos內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: