Spring Boot应用打WAR包后无法注册到Nacos的问题及解决方法

 更新时间:2024年06月06日 11:04:45   作者:柳岸花开  
当我们将 Spring Boot 应用打包成 WAR 并部署到外部 Tomcat 服务器时,可能会遇到服务无法注册到 Nacos 的情况,其原因主要是应用获取不到正确的服务器端口,下面给大家介绍Spring Boot 应用打 WAR 包后无法注册到 Nacos的问题及解决方法,感兴趣的朋友跟随小编一起看看吧

在微服务架构中,服务注册与发现是至关重要的一环。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;
}

通过 JMX 管理接口获取实际使用的 HTTP 端口。

总结

通过上述代码,我们可以实现在 Spring Boot 应用启动时,动态获取并设置 Nacos 注册的端口号。这对于在不同环境中部署应用非常有用,可以避免硬编码端口号带来的问题。同时,结合 Nacos 的服务注册与发现功能,可以更加灵活地管理微服务架构中的各个服务。

到此这篇关于Spring Boot 应用打 WAR 包后无法注册到 Nacos怎么办的文章就介绍到这了,更多相关Spring Boot打 WAR 包无法注册到 Nacos内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring一步到位精通拦截器

    Spring一步到位精通拦截器

    拦截器(Interceptor)是一种动态拦截方法调用的机制,在SpringMVC中动态拦截控制器方法的执行。本文将详细讲讲SpringMVC中拦截器的概念及入门案例,感兴趣的可以尝试一下
    2023-01-01
  • SpringBoot使用thymeleaf实现前端表格

    SpringBoot使用thymeleaf实现前端表格

    虽然现在流行前后端分离,但是后端模版在一些关键地方还是非常有用的,例如邮件模版、代码模版等。当然也不排除一些古老的项目后端依然使用动态模版。Thymeleaf 简洁漂亮、容易理解,并且完美支持 HTML5,可以直接打开静态页面,同时不新增标签,只需增强属性
    2022-10-10
  • Java 数据流之Broadcast State

    Java 数据流之Broadcast State

    这篇文章主要介绍了Java 数据流之Broadcast State,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-09-09
  • spring bean标签的primary属性用法讲解

    spring bean标签的primary属性用法讲解

    这篇文章主要介绍了spring bean标签的primary属性用法讲解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Mybatis实现Mapper动态代理方式详解

    Mybatis实现Mapper动态代理方式详解

    这篇文章主要为大家详细介绍了Mybatis实现Mapper动态代理方式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-08-08
  • 初次使用IDEA创建maven项目的教程

    初次使用IDEA创建maven项目的教程

    这篇文章主要介绍了初次使用IDEA创建maven项目的教程讲解,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2018-01-01
  • Maven pom.xml文件获取当前时间戳方式

    Maven pom.xml文件获取当前时间戳方式

    这篇文章主要介绍了Maven pom.xml文件获取当前时间戳方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 解决MyBatis返回结果类型为Boolean的问题

    解决MyBatis返回结果类型为Boolean的问题

    这篇文章主要介绍了解决MyBatis返回结果类型为Boolean的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-11-11
  • Jmeter解析返回参数以及解析并操作json方式

    Jmeter解析返回参数以及解析并操作json方式

    本文总结了Java或JMeter的BeanShell脚本中处理JSON字符串的常用操作,包括解析JSON数组、JSON对象和嵌套的JSON字符串,并提供了示例代码和打印结果
    2025-02-02
  • java自动生成编号的实现(格式:yyMM+四位流水号)

    java自动生成编号的实现(格式:yyMM+四位流水号)

    这篇文章主要介绍了java自动生成编号的实现(格式:yyMM+四位流水号),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10

最新评论