SpringCloud之Ribbon的组件使用

Ribbon是Netflix发布的云中间层服务开源项目，其主要功能是提供客户端实现负载均衡算法。Ribbon客户端组件提供一系列完善的配置项如连接超时，重试等。简单的说，Ribbon是一个客户端负载均衡器，可以在配置文件中Load Balancer后面的所有机器，Ribbon会自动的帮助你基于某种规则(如简单轮询，随机连接等)去连接这些机器，也很容易使用Ribbon实现自定义的负载均衡算法。

创建Ribbon服务提供方zx-ribbon-service

引入主要依赖

    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

bootstrap.yml配置信息

spring:
  application:
    name: zx-ribbon-service

application.yml配置信息

server:
  port: 8006

logging:
  config: classpath:logback.xml

eureka:
  client:
    healthcheck:
      enabled: true
    service-url:
      defaultZone: http://zxdemo:zxdemopwd@127.0.0.1:8002/eureka/
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1

编写一个controller

@RestController
@RequestMapping("/api/demo")
public class DemoApiController {

    private static final Logger logger = LoggerFactory.getLogger(DemoApiController.class);

    @Value("${server.port}")
    private String port;

    @Value("${spring.application.name}")
    private String applicationName;

    @GetMapping("getData")
    public String getData(String id) {
        logger.info("/api/demo/getData id:{}",id);

        return applicationName+":"+port+",接收到参数id:"+id;
    }

    @PostMapping("getMapData")
    public String getMapData(@RequestBody Map<String,Object> map) {
        ObjectMapper mapper = new ObjectMapper();
        String mapStr = "";
        try {
            mapStr = mapper.writeValueAsString(map);
            logger.info("/api/demo/getMapData map:{}", mapStr);
        } catch (Exception e) {
            logger.error("参数处理异常 e",e);
        }

        return applicationName+":"+port+",接收到参数 map:"+mapStr;
    }
}

启动类

@SpringBootApplication
@EnableEurekaClient
@ComponentScan(basePackages = {"com.zx.springcloud.**"})
public class RibbonServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(RibbonServiceApplication.class, args);
    }
}

启动注册中心和服务提供方

启动注册中心(不清楚注册中心eureka搭建的请点击这里),注册中心启动好之后，然后再启动服务提供方zx-ribbon-service，都启动好之后，如图：

可以看到zx-ribbon-service服务已经注册到eureka上了。

创建Ribbon服务消费方zx-ribbon-client

引入依赖

    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
     <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

ribbon主要依赖：spring-cloud-starter-netflix-ribbon

bootstrap.yml配置信息

spring:
  application:
    name: zx-ribbon-client

application.yml配置信息

server:
  port: 8007

logging:
  config: classpath:logback.xml

eureka:
  client:
    healthcheck:
      enabled: true
    service-url:
      defaultZone: http://zxdemo:zxdemopwd@127.0.0.1:8002/eureka/
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1

ribbon负载配置

@Configuration
public class RestTemplateConfig {

    @Bean
    @LoadBalanced
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}

@LoadBalanced启动ribbon负载

示例service

@Service
public class DemoService {

    private static final Logger logger = LoggerFactory.getLogger(DemoService.class);

    @Autowired
    private RestTemplate restTemplate;

    public String getData(String id) {
        logger.info("DemoService->getData id:{}",id);
        return restTemplate.getForObject("http://ZX-RIBBON-SERVICE/api/demo/getData?id="+id,String.class);
    }

    public String getMapData(Map<String, Object> map) {
        ObjectMapper mapper = new ObjectMapper();
        try {
            logger.info("DemoService->getMapData map:{}",mapper.writeValueAsString(map));
        } catch (Exception e) {
            logger.error("参数处理异常 e",e);
        }

        ResponseEntity<String> response = restTemplate.postForEntity("http://ZX-RIBBON-SERVICE/api/demo/getMapData", map, String.class);

        return response.getBody();
    }
}

示例controller

@RestController
@RequestMapping("/demo")
public class DemoApiController {

    private static final Logger logger = LoggerFactory.getLogger(DemoApiController.class);

    @Autowired
    private DemoService demoService;

    @GetMapping("getData")
    public String getData(@RequestParam("id") String id) {
        logger.info("into /demo/getData id:{}",id);

        String result = demoService.getData(id);
        logger.info("/demo/getData 结果 result:{}",result);
        return result;
    }

    @GetMapping("getMapData")
    public String getMapData() {
        Map<String, Object> map= new HashMap<>();
        map.put("id", 1L);
        map.put("name", "测试一把");

        String result = demoService.getMapData(map);
        logger.info("/demo/getMapData 结果 result:{}",result);

        return result;
    }
}

启动类

@SpringBootApplication
@EnableEurekaClient
@ComponentScan(basePackages = {"com.zx.springcloud.**"})
public class RibbonClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(RibbonClientApplication.class, args);
    }

}

以上编写完之后启动zx-ribbon-client，如果没有意外，该服务是注册到eureka上了，如图：

为了演示ribbon的负载均衡，我们改变zx-ribbon-service端口，然后再启动一个服务提供方，zx-ribbon-service这个时候是两个节点了，如图：

调用演示

多次请求接口 http://127.0.0.1:8007/demo/getData?id=5，结果如图：

从日志可以看出，负载起作用了。

演示一下传递map参数

本文项目源码地址：

https://github.com/cdzxkj/zx_springcloud_demo

转载请注明来自：

https://blog.csdn.net/javanian

欢迎访问博主的独立站：

http://www.muzijinxin.com/