spring-boot integrate with consul client

最新推荐文章于 2025-05-23 16:11:18 发布

原创最新推荐文章于 2025-05-23 16:11:18 发布 · 747 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#consul

spring-boot 同时被 2 个专栏收录

10 篇文章

订阅专栏

微服务

4 篇文章

订阅专栏

本文介绍如何在Spring Boot应用中使用Consul进行服务注册和服务发现。通过配置Consul客户端并实现ApplicationListener接口来自动注册服务，同时创建服务发现组件以获取可用的服务实例。

Setup the consul environment

Please refer to below article
https://blog.youkuaiyun.com/yaominhua/article/details/82316287

Add dependency to pom.xml

<dependency>
    <groupId>com.orbitz.consul</groupId>
    <artifactId>consul-client</artifactId>
    <version>1.2.4</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

Register the service when application startup

Create the Consul client bean

@Configuration
public class ConsulConfig {

    @Bean
    public Consul consul() {
        // default host is localhost and defalt port is 8500
        return Consul.newClient();
    }

}

Create application listener

public class ConsulRegisterListener implements ApplicationListener<ContextRefreshedEvent> {

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        Consul consul = event.getApplicationContext().getBean(Consul.class);
        int port = 8080;
        int interval = 10;
        String serviceName = "helloWorldService";
        List<String> tag = new ArrayList<>();
        Map<String, String> meta = new HashMap<>();
        try {
            consul.agentClient().register(port,
                    URI.create("http://localhost:8080/actuator/health").toURL(),
                    interval,
                    serviceName,
                    serviceName,
                    tag,
                    meta);
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }
    }

}

Add listener to SpringApplication

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication sa = new SpringApplication(Application.class);
        sa.addListeners(new ConsulRegisterListener());
        sa.run(args);
    }

}

Discover the service

Create a server class to store the available servers

public class Server {

    private String host;
    private int port;

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public int getPort() {
        return port;
    }

    public void setPort(int port) {
        this.port = port;
    }

}

Create the discovery service

@Component
public class ServiceDiscovery {

    @Autowired
    private Consul consul;

    public List<Server> getServerList(String serviceName) {
        List<Server> upServerList = new ArrayList<>();
        List<ServiceHealth> availableServers = consul.healthClient().getHealthyServiceInstances(serviceName).getResponse();
        availableServers.forEach(x -> {
            Server server = new Server();
            server.setHost(x.getNode().getAddress());
            server.setPort(x.getService().getPort());
            upServerList.add(server);
        });
        return upServerList;
    }

}

Create the controller to have a test

@RestController
@RequestMapping("helloWorld")
public class HelloWorldController {

    @Autowired
    private ServiceDiscovery serviceDiscovery;

    @RequestMapping(value="serverList/{serviceName}",method=RequestMethod.GET)
    public List<Server> getServerList(@PathVariable("serviceName") String serviceName) {
        return serviceDiscovery.getServerList("serviceName");
    }

}