SpringCloud微服务注册和消费模式总结

蔚落 2022-02-15 01:37 224阅读 0赞

> ### SpringCloud微服务注册和消费模式总结 ###

** 1.【微服务注册过程】：**

**（1）maven依赖：**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    	<modelVersion>4.0.0</modelVersion>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.1.4.RELEASE</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.caox</groupId>
    	<artifactId>eureka-server</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>eureka-server</name>
    	<description>Demo project for Spring Boot</description>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    		<spring-cloud.version>Greenwich.SR1</spring-cloud.version>
    		<apollo-client.version>1.1.0</apollo-client.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.projectlombok</groupId>
    			<artifactId>lombok</artifactId>
    			<optional>true</optional>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>com.ctrip.framework.apollo</groupId>
    			<artifactId>apollo-client</artifactId>
    			<version>${apollo-client.version}</version>
    		</dependency>
    
    		<dependency>
    			<groupId>com.ctrip.framework.apollo</groupId>
    			<artifactId>apollo-core</artifactId>
    			<version>${apollo-client.version}</version>
    		</dependency>
    	</dependencies>
    
    	<dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>${spring-cloud.version}</version>
    				<type>pom</type>
    				<scope>import</scope>
    			</dependency>
    		</dependencies>
    	</dependencyManagement>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    	<repositories>
    		<repository>
    			<id>aliyun-maven</id>
    			<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
    		</repository>
    		<repository>
    			<id>spring-milestones</id>
    			<name>Spring Milestones</name>
    			<url>https://repo.spring.io/milestone</url>
    			<snapshots>
    				<enabled>false</enabled>
    			</snapshots>
    		</repository>
    	</repositories>
    
    </project>

**（2）主配置文件application.yml:**

server:
      port: 8761
    
    eureka:
      instance:
        hostname: localhost
      client:
        registerWithEureka: false
        fetchRegistry: false
        serviceUrl:
          defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

**（3）主程序切入口：**

** 2.【Eureka Client 服务提供者】：**

**（1）maven依赖：**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    	<modelVersion>4.0.0</modelVersion>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.1.4.RELEASE</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.caox</groupId>
    	<artifactId>provider-server</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>provider-server</name>
    	<description>Demo project for Spring Boot</description>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    		<spring-cloud.version>Greenwich.SR1</spring-cloud.version>
    		<apollo-client.version>1.1.0</apollo-client.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-actuator</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-eureka-client</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.projectlombok</groupId>
    			<artifactId>lombok</artifactId>
    			<optional>true</optional>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    
             
    		<dependency>
    			<groupId>com.ctrip.framework.apollo</groupId>
    			<artifactId>apollo-client</artifactId>
    			<version>${apollo-client.version}</version>
    		</dependency>
    
    		<dependency>
    			<groupId>com.ctrip.framework.apollo</groupId>
    			<artifactId>apollo-core</artifactId>
    			<version>${apollo-client.version}</version>
    		</dependency>
    	</dependencies>
    
    	<dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>${spring-cloud.version}</version>
    				<type>pom</type>
    				<scope>import</scope>
    			</dependency>
    		</dependencies>
    	</dependencyManagement>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    </project>

**（2）主配置文件:**

eureka:
      client:
        serviceUrl:
          defaultZone: http://localhost:8761/eureka/
    server:
      port: 8762
    spring:
      application:
        name: provider-test

**（3） 主程序切入口：**

**（4）服务Controller层提供方法：**

package com.caox.controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    /**
     * @author : nazi
     * @version : 1.0
     * @date : 2019/4/22 17:02
     */
    @Controller
    public class ProviderController {
    
        @Value("${server.port}")
        private String port;
    
        @RequestMapping(value = "hi")
        @ResponseBody
        public String hello(){
            return "hello world! I am from " + port;
        }
    }

**3. 【使用LoadBalancerClient服务消费模式】：负载均衡**

**（1）maven依赖：**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.voyer</groupId>
        <artifactId>voyer-consumer-test</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>voyer-consumer-test</name>
        <description>Demo project for Spring Boot</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.0.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
            <spring-cloud.version>Finchley.M9</spring-cloud.version>
        </properties>
    
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</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-eureka-client</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
        <repositories>
            <repository>
                <id>spring-snapshots</id>
                <name>Spring Snapshots</name>
                <url>https://repo.spring.io/snapshot</url>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
            </repository>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
    
    </project>

**（2）默认启动程序:  注入`RestTemplate`**

package com.caox;
    
    import com.alibaba.dubbo.spring.boot.annotation.EnableDubboConfiguration;
    import com.ctrip.framework.apollo.spring.annotation.EnableApolloConfig;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.bind.annotation.CrossOrigin;
    import org.springframework.web.client.RestTemplate;
    
    
    @CrossOrigin  //允许跨越访问
    @SpringBootApplication
    @EnableApolloConfig
    @EnableDubboConfiguration
    @EnableEurekaClient
    public class SpringBootWebDemoApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(SpringBootWebDemoApplication.class, args);
    	}
    
    	@Bean
    	public RestTemplate restTemplate() {
    		return new RestTemplate();
    	}
    
    }

**（3） 服务Controller层提供方法：**

@RestController
    public class ConsumerController {
        @Autowired
        LoadBalancerClient loadBalancerClient;
        @Autowired
        RestTemplate restTemplate;
    
        @RequestMapping("/hi")
        public String hello(){
            ServiceInstance serviceInstance = loadBalancerClient.choose("provider-test");
            String url = "http://" + serviceInstance.getHost() + ":" + serviceInstance.getPort() + "/hi";
            System.out.println(url);
            return restTemplate.getForObject(url, String.class);
        }
    }

其中 provider-test是指 Eureka  Client 服务提供者 服务实例名，配置是 spring.application.name

**4. 【使用Ribbon****服务消费模式】：负载均衡**

**（1）maven依赖：**

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

**（2）默认启动程序: **

package com.caox;
    
    import com.ctrip.framework.apollo.spring.annotation.EnableApolloConfig;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.client.loadbalancer.LoadBalanced;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.client.RestTemplate;
    
    @SpringBootApplication
    @EnableApolloConfig
    //@EnableEurekaClient
    @EnableDiscoveryClient
    // 如果选用的注册中心是eureka，那么就推荐@EnableEurekaClient，如果是其他的注册中心，那么推荐使用@EnableDiscoveryClient。
    public class ConsumerRibbonApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(ConsumerRibbonApplication.class, args);
    	}
    
    	@Bean
    	@LoadBalanced
    	public RestTemplate restTemplate() {
    		return new RestTemplate();
    	}
    }

**（3） 服务Controller层提供方法：**

package com.caox.controller;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    
    /**
     * @author : nazi
     * @version : 1.0
     * @date : 2019/4/22 14:01
     */
    @RestController
    public class ConsumerController {
        @Autowired
        RestTemplate restTemplate;
        @RequestMapping("/hi")
        public String hello(){
            return restTemplate.getForObject("http://spring-boot-web/hi", String.class);
        }
    }

**5. 【使用Feign****服务消费模式】：负载均衡**

**（1）maven依赖：**

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

**（2）默认启动程序: **

**（3）接口服务层：**

package com.caox.service;
    
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    
    /**
     * @author : nazi
     * @version : 1.0
     * @date : 2019/4/22 16:34
     */
    @FeignClient(value = "spring-boot-web")
    public interface ConsumerService {
        @RequestMapping(value = "/hi",method = RequestMethod.GET)
        String hiFromProvider();
    }

**（4）服务Controller层提供方法：**

package com.caox.controller;
    
    import com.caox.service.ConsumerService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * @author : nazi
     * @version : 1.0
     * @date : 2019/4/22 16:33
     */
    @RestController
    public class ConsumerController {
        @Autowired
        ConsumerService consumerService;
    
        @RequestMapping(value = "/hi",method = RequestMethod.GET)
        public String hi(){
            return consumerService.hiFromProvider();
        }
    }

** 参考文献：**[服务的注册与发现（Eureka）][Eureka]、[服务消费（LoadBalancerClient、Ribbon、Feign）][LoadBalancerClient_Ribbon_Feign]

**其中 EnableDiscoveryClient与EnableEurekaClient的区别：**[Spring Cloud源码分析之Eureka篇第三章：EnableDiscoveryClient与EnableEurekaClient的区别(Edgware版本)][Spring Cloud_Eureka_EnableDiscoveryClient_EnableEurekaClient_Edgware]

[Eureka]: https://www.jianshu.com/p/8fb6110f86a5
[LoadBalancerClient_Ribbon_Feign]: https://www.jianshu.com/p/562045489d9d
[Spring Cloud_Eureka_EnableDiscoveryClient_EnableEurekaClient_Edgware]: https://blog.csdn.net/boling_cavalry/article/details/82668480