SpringCloud之服務註冊與發現Eureka+客戶端Feign

時間 2020-08-12 標籤 springcloud 服務註冊發現 eureka 客戶端 feign

前言

SpringCloud 是微服務中的翹楚，最佳的落地方案。前端

Eureka 做爲註冊中心，是 SpringCloud 體系中最重要最核心的組件之一。java

Feign 使用接口加註解的方式調用服務，配合 Eureka 還能實現負載均衡。git

源碼

GitHub地址：https://github.com/intomylife/SpringCloudgithub

環境

JDK 1.8.0 +
Maven 3.0 +
SpringBoot 2.0.3
SpringCloud Finchley.RELEASE

開發工具

IntelliJ IDEA

正文

commons 工程

commons 工程 - POM 文件

<?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.zwc</groupId>
    <artifactId>springcloud-eureka-commons</artifactId>
    <version>1.0</version>

    <!-- 工程名稱和描述 -->
    <name>springcloud-eureka-commons</name>
    <description>公用工程</description>

    <!-- 打包方式 -->
    <packaging>jar</packaging>

    <!-- 在 properties下聲明相應的版本信息，而後在dependency下引用的時候用 ${} 就能夠引入該版本jar包了 -->
    <properties>
        <!-- 編碼 -->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <!-- jdk -->
        <java.version>1.8</java.version>

        <!-- SpringBoot -->
        <platform-bom.version>Cairo-SR3</platform-bom.version>

        <!-- SpringCloud -->
        <spring-cloud-dependencies.version>Finchley.RELEASE</spring-cloud-dependencies.version>
    </properties>

    <!-- 加入依賴 -->
    <dependencies>

    </dependencies>

    <!-- 依賴 jar 包版本管理的管理器 -->
    <!-- 若是 dependencies 裏的 dependency 本身沒有聲明 version 元素，那麼 maven 就此處來找版本聲明。 -->
    <!-- 若是有，就會繼承它；若是沒有就會報錯，告訴你沒有版本信息 -->
    <!-- 優先級：若是 dependencies 裏的 dependency 已經聲明瞭版本信息，就不會生效此處的版本信息了 -->
    <dependencyManagement>
        <dependencies>
            <!-- SpringBoot -->
            <dependency>
                <groupId>io.spring.platform</groupId>
                <artifactId>platform-bom</artifactId>
                <version>${platform-bom.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- SpringCloud -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud-dependencies.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>

配置一些共用依賴

commons 工程 - 項目結構

service 工程

此工程下有四個模塊：一個註冊中心，兩個提供者以及一個消費者web

registry-service（註冊中心）

registry-service - POM 文件

<?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>com.zwc</groupId>
        <artifactId>springcloud-eureka-service</artifactId>
        <version>1.0</version>
    </parent>

    <!-- 三座標 -->
    <groupId>com.zwc</groupId>
    <artifactId>springcloud-eureka-registry-service</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <!-- 工程名稱描述 -->
    <name>springcloud-eureka-registry-service</name>
    <description>註冊中心</description>

    <!-- 打包方式 -->
    <packaging>jar</packaging>

    <!-- 在 properties下聲明相應的版本信息，而後在dependency下引用的時候用 ${} 就能夠引入該版本jar包了 -->
    <properties>

    </properties>

    <!-- 加入依賴 -->
    <dependencies>
        <!-- commons工程 依賴 -->
        <dependency>
            <groupId>com.zwc</groupId>
            <artifactId>springcloud-eureka-commons</artifactId>
            <version>1.0</version>
        </dependency>

        <!-- 服務註冊中心 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
    </dependencies>

    <!-- 插件依賴 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

主要是加入 spring-cloud-starter-netflix-eureka-server 依賴

registry-service - application.yml 配置文件

# 端口
server:
  port: 8761

# 應用名稱
spring:
  application:
    name: eurka-server

eureka:
  instance:
    # 使用 ip 代替實例名
    prefer-ip-address: true
    # 實例的主機名
    hostname: ${spring.cloud.client.ip-address}
    # 實例的 ID 規則
    instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
  client:
    # 是否向註冊中心註冊本身
    registerWithEureka: false
    # 是否向註冊中心獲取註冊信息
    fetchRegistry: false
    serviceUrl:
      # 註冊中心地址
      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

這裏使用了默認的 8761 端口，固然也能夠更改，不過在發現調用服務端的註冊中心地址端口要與它一致

registry-service - 啓動類

package com.zwc;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@SpringBootApplication
@EnableEurekaServer
public class SpringcloudEurekaRegistryServiceApplication {

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

}

在啓動類中添加 @EnableEurekaServer 註解表示此工程是註冊中心

registry-service - 啓動項目

1. 項目啓動成功後訪問 http://localhost:8761/ 便可看到 eureka-server 主頁面spring

Provider（提供者）

Provider - POM 文件

<?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>com.zwc</groupId>
        <artifactId>springcloud-eureka-providerfirst-service</artifactId>
        <version>1.0</version>
    </parent>

    <!-- 三座標 -->
    <groupId>com.zwc</groupId>
    <artifactId>springcloud-eureka-providerfirst-service-core</artifactId>
    <version>1.0</version>

    <!-- 工程名稱描述 -->
    <name>springcloud-eureka-providerfirst-service-core</name>
    <description>提供者一號服務工程 - 核心</description>

    <!-- 打包方式 -->
    <packaging>jar</packaging>

    <!-- 在 properties下聲明相應的版本信息，而後在dependency下引用的時候用 ${} 就能夠引入該版本jar包了 -->
    <properties>

    </properties>

    <!-- 加入依賴 -->
    <dependencies>
        <!-- commons工程 依賴 -->
        <dependency>
            <groupId>com.zwc</groupId>
            <artifactId>springcloud-eureka-commons</artifactId>
            <version>1.0</version>
        </dependency>

        <!-- api工程 依賴 -->
        <dependency>
            <groupId>com.zwc</groupId>
            <artifactId>springcloud-eureka-providerfirst-service-api</artifactId>
            <version>1.0</version>
        </dependency>

        <!-- 提供者消費者 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
    </dependencies>

    <!-- 插件依賴 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

主要是加入 spring-cloud-starter-netflix-eureka-client 依賴

Provider - application.yml 配置文件

# 端口
server:
  port: 8090

# 應用名稱
spring:
  application:
    name: say-hello

eureka:
  instance:
    # 使用 ip 代替實例名
    prefer-ip-address: true
    # 實例的主機名
    hostname: ${spring.cloud.client.ip-address}
    # 實例的 ID 規則
    instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
  client:
    serviceUrl:
      # 註冊中心地址
      defaultZone: http://${eureka.instance.hostname}:8761/eureka/

注意此處配置註冊中心地址的端口爲 8761 也就是上面註冊中心工程配置的端口
有兩個提供者工程，只有此處的端口不一致，此處端口爲 8090，另外一個端口爲 8091。就再也不贅述
兩個提供者工程做用是爲了達到負載均衡的效果
spring.application.name：應用名稱，被消費者調用時須要用到

Provider - controller 前端控制器

package com.zwc.providerfirst.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @ClassName SayHelloController
 * @Desc TODO   Say Hello
 * @Date 2019/5/15 15:28
 * @Version 1.0
 */
@RestController
public class SayHelloController {

    /*
     * @ClassName SayHelloController
     * @Desc TODO   讀取配置文件中的端口
     * @Date 2019/5/15 15:49
     * @Version 1.0
     */
    @Value("${server.port}")
    private String port;

    /*
     * @ClassName SayHelloController
     * @Desc TODO   Say Hello
     * @Date 2019/5/15 15:30
     * @Version 1.0
     */
    @RequestMapping("/hello")
    public String hello(){
        return "Hello Spring Cloud！！！port：" + port;
    }

}

提供一個服務：輸出 Hello 和端口

Provider - 啓動類

package com.zwc;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

@SpringBootApplication
@EnableEurekaClient
public class SpringcloudEurekaProviderfirstServiceCoreApplication {

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

}

添加 @EnableEurekaClient 註解表示此工程能夠向註冊中心提供服務

Provider - 啓動項目

1. 項目啓動成功後訪問 http://localhost:8090/hello 看到輸出內容 'Hello Spring Cloud！！！port：8090'apache

2. 刷新 http://localhost:8761/（註冊中心）能夠看到服務已經被註冊進來了api

3. 同理，還有一個提供者工程只是端口不一致，也啓動起來app

4. 項目啓動成功後訪問 http://localhost:8091/hello 看到輸出內容 'Hello Spring Cloud！！！port：8091'負載均衡

5. 再次刷新 http://localhost:8761/（註冊中心）能夠看到相同的服務有兩個提供者

Consumer（消費者）

Consumer - POM 文件

<?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>com.zwc</groupId>
        <artifactId>springcloud-eureka-consumer-service</artifactId>
        <version>1.0</version>
    </parent>

    <!-- 三座標 -->
    <groupId>com.zwc</groupId>
    <artifactId>springcloud-eureka-consumer-service-core</artifactId>
    <version>1.0</version>

    <!-- 工程名稱描述 -->
    <name>springcloud-eureka-consumer-service-core</name>
    <description>消費者服務工程 - 核心</description>

    <!-- 打包方式 -->
    <packaging>jar</packaging>

    <!-- 在 properties下聲明相應的版本信息，而後在dependency下引用的時候用 ${} 就能夠引入該版本jar包了 -->
    <properties>

    </properties>

    <!-- 加入依賴 -->
    <dependencies>
        <!-- commons工程 依賴 -->
        <dependency>
            <groupId>com.zwc</groupId>
            <artifactId>springcloud-eureka-commons</artifactId>
            <version>1.0</version>
        </dependency>

        <!-- api工程 依賴 -->
        <dependency>
            <groupId>com.zwc</groupId>
            <artifactId>springcloud-eureka-consumer-service-api</artifactId>
            <version>1.0</version>
        </dependency>

        <!-- 提供者消費者 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- feign -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
    </dependencies>

    <!-- 插件依賴 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

與提供者一致，須要加入 spring-cloud-starter-netflix-eureka-client 依賴
還須要加入 Feign 的起步依賴 spring-cloud-starter-openfeign

Consumer - application.yml 配置文件

# 端口
server:
  port: 8080

# 應用名稱
spring:
  application:
    name: service-feign

eureka:
  instance:
    # 使用 ip 代替實例名
    prefer-ip-address: true
    # 實例的主機名
    hostname: ${spring.cloud.client.ip-address}
    # 實例的 ID 規則
    instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
  client:
    serviceUrl:
      # 註冊中心地址
      defaultZone: http://${eureka.instance.hostname}:8761/eureka/

注意此處配置註冊中心地址的端口爲 8761 也就是上面註冊中心工程配置的端口
spring.application.name：應用名稱，被消費者調用時須要用到，它在消費的同時也能夠被消費

Consumer - 服務調用

package com.zwc.consumer.api.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @ClassName FeignApi
 * @Desc TODO   使用 Feign 調用 Api - 接口
 * @Date 2019/5/15 16:11
 * @Version 1.0
 */
@FeignClient("say-hello")
public interface FeignApi {

    /*
     * @ClassName FeignApi
     * @Desc TODO   經過 say-hello 服務名調用 /hello 方法
     * @Date 2019/5/15 16:17
     * @Version 1.0
     */
    @RequestMapping("/hello")
    String hello();

}

經過 @FeignClient("say-hello") 註解來指定調用哪一個服務
say-hello 就是提供者的 spring.application.name：應用名稱
String hello();：能夠發現，此方法就是提供者 SayHelloController 中的方法，只不過這裏要定義成接口
注意要與提供者具備相同返回值，相同方法名以及相同參數

Consumer - controller 前端控制器

package com.zwc.consumer.controller;

import com.zwc.consumer.api.feign.FeignApi;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * @ClassName FeignController
 * @Desc TODO   使用 Feign 調用 Api - 前端控制器
 * @Date 2019/5/15 16:18
 * @Version 1.0
 */
@RestController
public class FeignController {

    @Autowired(required = false)
    private FeignApi feignApi;

    /*
     * @ClassName FeignController
     * @Desc TODO   調用 Say Hello 方法
     * @Date 2019/5/15 16:20
     * @Version 1.0
     */
    @RequestMapping("/feign")
    public String feign(){
        return feignApi.hello();
    }

}

使用 @Autowired 註解裝配 Bean，經過此 Bean 中的方法調用服務
此類對外暴露接口，調用的實則是提供者的服務

Consumer - 啓動類

package com.zwc;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
public class SpringcloudEurekaConsumerServiceCoreApplication {

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

}

添加 @EnableEurekaClient 註解表示此工程能夠向註冊中心提供服務
添加 @EnableFeignClients 註解表示開啓 Feign 功能進行遠程調用

Consumer - 啓動項目

1. 項目啓動成功後屢次訪問 http://localhost:8080/feign

2. 能夠發現輪流輸出 'Hello Spring Cloud！！！port：8090' 和 'Hello Spring Cloud！！！port：8091'

3. 此時已經達到了負載均衡的效果

4. 再次刷新 http://localhost:8761/（註冊中心）能夠看到此時多了一個消費者

service 工程 - 項目結構

把多工程項目使用 IntelliJ IDEA 打開

把項目從 GitHub 中下載到你的本地
打開 IntelliJ IDEA
點擊 File -> Open
打開你下載到本地的項目目錄
springcloud-eureka -> springcloud-eureka-service（選擇打開此工程）
打開 service 工程後
再次點擊 File -> Project Structrue
選擇 Modules，點擊 '+' 符號
點擊 Import Module
仍是打開你下載到本地的項目目錄
springcloud-eureka -> springcloud-eureka-commons -> pom.xml
點擊 OK
點擊 Next，Finish
點擊 Apply，OK

擴展

CentOS7中使用Docker簡單部署SpringCloud項目

但願可以幫助到你

over