美文网首页
Spring Cloud(三)服务消费

Spring Cloud(三)服务消费

作者: Lord_East | 来源:发表于2019-01-22 12:22 被阅读0次

    服务消费

    Spring Cloud(一)服务注册与发现中,我们提供了服务提供者的工程项目,既然有服务的提供方,那么如何去消费所提供的服务,SpringCloud中提供了多种方式来实现,该模块主要就介绍了服务消费,内容包含了服务消费(基础),服务消费(Ribbon),服务消费(Feign)。


    服务消费(基础)

    创建一个服务消费者工程,命名为:service-consumer,并在pom.xml中引入依赖:

        <parent>
            <groupId>com.wkedong.springcloud</groupId>
            <artifactId>parent</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-config</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-sleuth-zipkin</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-sleuth</artifactId>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.39</version>
            </dependency>
            <dependency>
                <groupId>commons-fileupload</groupId>
                <artifactId>commons-fileupload</artifactId>
                <version>1.3.3</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    

    在消费者的pom文件中,我们依赖了config配置中心(方便配置文件管理),zipkin和sleuth服务追踪(后续文章会进行介绍),fastjson(在调用接口时使用的是Json传参),commons-fileupload(上传文件所需依赖)

    在对工程的配置文件,bootstrap.yml如下:

    eureka:
      client:
        healthcheck:
          enabled: true #健康检查开启
        serviceUrl:
          defaultZone: http://localhost:6060/eureka/  #注册中心服务地址
    server:
      port: 7010  #当前服务端口
    spring:
      ## 从配置中心读取文件
      cloud:
        config:
          uri: http://localhost:6010/
          label: master
          profile: dev
          name: service-consumer
      application:
        name: service-consumer    #当前服务ID
      zipkin:
        base-url: http://localhost:6040 #zipkin服务地址
      sleuth:
        enabled: true #服务追踪开启
        sampler:
          percentage: 1 #zipkin收集率
    

    创建服务应用的主类ServiceConsumerApplication.java如下:

    /**
     * @author wkedong
     * 2019/1/5
     * Consumer
     */
    @SpringBootApplication
    @EnableDiscoveryClient
    public class ServiceConsumerApplication {
    
        @Bean
        @LoadBalanced
        RestTemplate restTemplate() {
            return new RestTemplate();
        }
    
        public static void main(String[] args) {
            new SpringApplicationBuilder(ServiceConsumerApplication.class).web(true).run(args);
        }
    }
    

    其实在主类中我们注入了restTemplate,注解@LoadBalanced已经默认开启了负载均衡的配置。

    主类中我们初始化RestTemplate,用来真正发起REST请求。关于RestTemplate的介绍可以查看详解RestTemplate
    创建ConsumerController.java来实现/testGet/testPost/testFile接口,如下:

    /**
     * @author wkedong
     * 消费者
     * 2019/1/5
     */
    @RestController
    public class ConsumerController {
        private final Logger logger = Logger.getLogger(getClass());
    
        @Autowired
        private RestTemplate restTemplate;
    
        @GetMapping(value = "/testGet")
        public String testGet() {
            logger.info("===<call testGet>===");
            return restTemplate.getForObject("http://service-producer/testGet", String.class);
        }
    
        @PostMapping(value = "/testPost")
        public String testPost(@RequestParam("name") String name) {
            logger.info("===<call testPost>===");
            JSONObject json = new JSONObject();
            json.put("name", name);
            return restTemplate.postForObject("http://service-producer/testPost", json, String.class);
        }
    
        @PostMapping(value = "/testFile", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
        public String testFile(@RequestParam("file") MultipartFile file) {
            logger.info("===<call testFile>===");
            File path = null;
            if (file != null) {
                try {
                    String filePath = "D:\\tempFile";
                    path = new File(filePath); //判断文件路径下的文件夹是否存在,不存在则创建
                    if (!path.exists()) {
                        path.mkdirs();
                    }
                    File savedFile = new File(filePath + "\\" + file.getOriginalFilename());
                    boolean isCreateSuccess = savedFile.createNewFile(); // 是否创建文件成功
                    if (isCreateSuccess) {
                        //将文件写入
                        file.transferTo(savedFile);
                    }
                    HttpHeaders headers = new HttpHeaders();
                    FileSystemResource fileSystemResource = new FileSystemResource(savedFile);
                    MediaType type = MediaType.parseMediaType("multipart/form-data");
                    headers.setContentType(type);
                    MultiValueMap<String, Object> param = new LinkedMultiValueMap<>();
                    param.add("file", fileSystemResource);
                    HttpEntity<MultiValueMap<String, Object>> files = new HttpEntity<>(param, headers);
                    return restTemplate.postForObject("http://service-producer/testFile", files, String.class);
                } catch (Exception e) {
                    e.printStackTrace();
                } finally {
                    if (path != null) {
                        path.delete();
                    }
                }
            }
            return "文件有误";
        }
    }
    
    • 这里的请求的地址我们使用了魔法值,在后续真正的项目实施时,可以定义一个常量类来统一管理储存请求地址。
    • 文件上传接口不能直接调用服务端接口传输MultipartFile文件,所以做了部分处理。

    工程至此创建完成了,分别启动注册中心,服务提供方,和该工程,并访问 http://localhost:7010/testGet ,会出现以下页面:

    Hello, Spring Cloud! My port is 6070 Get info By Mybatis is {"address":"江苏南京","birthday":"1994-12-21","name":"wkedong"}
    

    服务消费(Ribbon)

    Spring Cloud Ribbon

    Spring Cloud Ribbon是基于Netflix Ribbon实现的一套客户端负载均衡的工具。它是一个基于HTTP和TCP的客户端负载均衡器。它可以通过在客户端中配置ribbonServerList来设置服务端列表去轮询访问以达到均衡负载的作用。

    上面是基础的使用Spring封装的RestTemplate来进行服务的消费,在此基础上实现负载均衡的配置只需要在pom文件中新增依赖:

            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-ribbon</artifactId>
            </dependency>
    

    我们将service-consumer工程拷贝一份改名为service-consumer-ribbon,配置文件修改为:

    eureka:
      client:
        healthcheck:
          enabled: true #健康检查开启
        serviceUrl:
          defaultZone: http://localhost:6060/eureka/  #注册中心服务地址
    server:
      port: 7030  #当前服务端口
    spring:
      ## 从配置中心读取文件
      cloud:
        config:
          uri: http://localhost:6010/
          label: master
          profile: dev
          name: service-consumer-ribbon
      application:
        name: service-consumer-ribbon    #当前服务ID
      zipkin:
        base-url: http://localhost:6040 #zipkin服务地址
      sleuth:
        enabled: true #服务追踪开启
        sampler:
          percentage: 1 #zipkin收集率
    

    新建RibbonController.java实现/testRibbon接口:

    /**
     * @author wkedong
     * RobbinDemo
     * 2019/1/5
     */
    @RestController
    public class RibbonController {
        private final Logger logger = Logger.getLogger(getClass());
    
        @Autowired
        private RestTemplate restTemplate;
    
        @GetMapping(value = "/testRibbon")
        public String testRibbon() {
            logger.info("===<call testRibbon>===");
    
            //执行http请求Producer服务的provide映射地址,返回的数据为字符串类型
            //PRODUCER:提供者(Producer服务)的注册服务ID
            //provide :消费方法
            return restTemplate.getForObject("http://service-producer/testRibbon", String.class);
        }
    }
    

    然后启动eureka,config,service-producer,service-consumer-ribbon访问/testRibbon接口观察返回数据,负载均衡的效果可以通过启动多个service-producer来进行观察。
    启动多个服务端之后,调用该接口会发现端口号在变化,这就是Ribbon实现的轮值负载均衡机制。


    服务消费(Feign)

    上面是基础及实现了负载均衡来使用Spring封装的RestTemplate来进行服务的消费,下面介绍下利用Feign来进行服务的消费。

    Spring Cloud Feign

    Spring Cloud Feign是一套基于Netflix Feign实现的声明式服务调用客户端。它使得编写Web服务客户端变得更加简单。
    我们只需要通过创建接口并用注解来配置它既可完成对Web服务接口的绑定。它具备可插拔的注解支持,包括Feign注解、JAX-RS注解。它也支持可插拔的编码器和解码器。
    Spring Cloud Feign还扩展了对Spring MVC注解的支持,同时还整合了Ribbon和Eureka来提供均衡负载的HTTP客户端实现。

    这里继续使用之前的服务注册中心eureka,配置中心config和服务提供者service-producer,在此基础上新建工程service-consumer-feign,在pom文件中引用相应依赖:

         <parent>
            <groupId>com.wkedong.springcloud</groupId>
            <artifactId>parent</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-config</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-feign</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-sleuth-zipkin</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-sleuth</artifactId>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.39</version>
            </dependency>
            <dependency>
                <groupId>io.github.openfeign.form</groupId>
                <artifactId>feign-form</artifactId>
                <version>3.0.3</version>
            </dependency>
            <dependency>
                <groupId>io.github.openfeign.form</groupId>
                <artifactId>feign-form-spring</artifactId>
                <version>3.0.3</version>
            </dependency>
            <dependency>
                <groupId>commons-fileupload</groupId>
                <artifactId>commons-fileupload</artifactId>
                <version>1.3.3</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    

    主要是多了spring-cloud-starter-feign依赖,实现feign的操作

    在配置文件bootstrap.yml添加如下配置:

    eureka:
      client:
        healthcheck:
          enabled: true #健康检查开启
        serviceUrl:
          defaultZone: http://localhost:6060/eureka/  #注册中心服务地址
    server:
      port: 7020  #当前服务端口
    spring:
      ## 从配置中心读取文件
      cloud:
        config:
          uri: http://localhost:6010/
          label: master
          profile: dev
          name: service-consumer-feign
      application:
        name: service-consumer-feign    #当前服务ID
      zipkin:
        base-url: http://localhost:6040 #zipkin服务地址
      sleuth:
        enabled: true #服务追踪开启
        sampler:
          percentage: 1 #zipkin收集率
    

    工程应用主类中追加@EnableFeignClients注解,声明为Feign服务应用:

    /**
     * @author wkedong
     */
    @EnableFeignClients
    @EnableDiscoveryClient
    @SpringBootApplication
    public class ServiceConsumerFeignApplication {
    
        public static void main(String[] args) {
            new SpringApplicationBuilder(ServiceConsumerFeignApplication.class).web(true).run(args);
        }
    
        @Configuration
        class MultipartSupportConfig {
            @Bean
            public Encoder feignFormEncoder() {
                return new SpringFormEncoder();
            }
        }
    }
    

    支持文件上传,设置feign文件Encoder配置。

    创建一个Feign的客户端接口定义。使用@FeignClient注解来指定这个接口所要调用的服务名称,接口中定义的各个函数使用Spring MVC的注解就可以来绑定服务提供方的REST接口,这里绑定service-producer中的/testFeign/testFile接口:

    /**
     * @author wkedong
     * FeignDemo
     * 2019/1/14
     */
    @FeignClient("service-producer")
    public interface FeignService {
    
        @GetMapping(value = "/testFeign")
        String testFeign();
    
        @PostMapping(value = "/testFile", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
        String testFeignFile(@RequestPart(value = "file") MultipartFile file);
    }
    

    创建一个Controller来调用该客户端:

    /**
     * @author wkedong
     * FeignDemo
     * 2019/1/14
     */
    @RestController
    public class FeignController {
    
        private final Logger logger = Logger.getLogger(getClass());
    
        @Autowired
        FeignService feignService;
    
        @GetMapping("/testFeign")
        public String testFeign() {
            logger.info("===<call testFeign>===");
            return feignService.testFeign();
        }
    
        @PostMapping(value = "/testFeignFile", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
        public String testFeignFile(@RequestParam("file") MultipartFile file) {
            logger.info("===<call testFeignFile>===");
            File path = null;
            if (file != null) {
                try {
                    String filePath = "D:\\tempFile";
                    //判断文件路径下的文件夹是否存在,不存在则创建
                    path = new File(filePath);
                    if (!path.exists()) {
                        path.mkdirs();
                    }
                    File tempFile = new File(filePath + "\\" + file.getOriginalFilename());
                    // 是否创建文件成功
                    boolean isCreateSuccess = tempFile.createNewFile();
                    if (isCreateSuccess) {
                        //将文件写入
                        file.transferTo(tempFile);
                    }
                    DiskFileItem fileItem = (DiskFileItem) new DiskFileItemFactory().createItem("file",
                            MediaType.MULTIPART_FORM_DATA_VALUE, true, file.getOriginalFilename());
    
                    try (InputStream input = new FileInputStream(tempFile); OutputStream os = fileItem.getOutputStream()) {
                        IOUtils.copy(input, os);
                    } catch (Exception e) {
                        throw new IllegalArgumentException("Invalid file: " + e, e);
                    }
                    MultipartFile multi = new CommonsMultipartFile(fileItem);
                    return feignService.testFeignFile(multi);
                } catch (Exception e) {
                    e.printStackTrace();
                } finally {
                    if (path != null) {
                        path.delete();
                    }
                }
            }
            return "文件有误";
        }
    
    }
    

    通过Spring Cloud Feign来实现服务调用的方式更加简单了,通过@FeignClient定义的接口声明我们需要依赖的微服务接口。具体使用的时候就跟调用本地方法一样的进行调用。
    由于Feign是基于Ribbon实现的,所以它自带了客户端负载均衡功能,也可以通过Ribbon的IRule进行策略扩展。另外,Feign还整合的Hystrix来实现服务的容错保护,后续文章中再对Hysrix进行介绍。
    至此代码编写结束,启动eureka,config,service-producer,service-consumer-feign访问/testFeign接口观察返回数据,负载均衡的效果可以通过启动多个service-producer来进行观察。


    文章目录:

    整体demo的GitHub地址:Spring-Cloud

    相关文章

      网友评论

          本文标题:Spring Cloud(三)服务消费

          本文链接:https://www.haomeiwen.com/subject/hjdljqtx.html