SpringCloud入坑记-初识Eureka

Dear 丶 2022-04-24 09:26 154阅读 0赞

![在这里插入图片描述][20190420223451330.png_pic_center]

接触基于SpringCloud的微服务设计已经一年多了，在学习与实践过程中，走了很多弯路，也遇到了一些坑。这些文章将按照我对微服务的理解，有体系地讲述SpringCloud入坑那点事儿。

有幸从头参与了公司从单体应用到微服务架构的演进过程，从最开始的蒙蔽状态到如今的略知一二，深知其中不易。如今，公司项目已经成功上线，终于有机会将自己的思想沉淀为文字，记录曾经奋斗的痕迹。

在深入细节之前，应该对事物的整体有一个祖略的认识，前一篇文章[《我认识的微服务》][Link 1] 从宏观层面对微服务讲述了我对微服务的理解。

## 什么是Eureka ##

**Eureka是由Netflix开源的基于Rest的服务发现组件，包含Eureka Server和Eureka Client**

服务发现与注册中心Eurek是软件开发演进的产物，对于单体架构，它存在的意义不大，但是在微服务时代，它的存在可以解决很多棘手的问题。  
传统的软件集中式管理，以`war`包为部署方式，暴露的主机名与端口号相对固定。可以通过`http://ip:port/context-path/soruce?param`的方式调用。微服务的重要理念就是服务拆分，独立部署，如果服务很多，就需要维护一个庞大的参数列表，要是通过Docker部署，端口号动态分配，处理起来更复杂了。  
`Eureka`正是在这样的背景下产生的，它动态获取注册到自己的实例信息，并使其他服务可以通过服务名调用，很好地解决了上述问题。

## 版本选择 ##

目前，SpringCloud迭代速度很快，我选择的是相对稳定并且新颖的F版，它要求Boot版本高于2.x  
![1555750860x2890174249.png][]

*  SpringCloud Finchley.SR2
 *  SpringBoot 2.1.1.RELEASE

这里的`Finchley`是SpringCloud的大版本号，它是英国伦敦地铁站的站台名。这个名词首字母刚好遵循英文字母的顺序，当前活跃的几个版本`Dalston`、`Edgware`、`Finchley`、`Greenwich`，在讲述的时候，一般我们只取其首字母。  
这里的SR指的是第二个"Service Release"版，而GA指的是"Generally Available"，说明是稳定版。

## 项目初次搭建 ##

为了能更好地管理所有的服务模块，需要首先搭建一个项目骨架。

在此之前先需要知道的技术与准备的环境。

*  Java 8(最低的支持版本)
 *  Maven (SpringBoot需要用到)
 *  Spring Boot (构建SpringCloud必须的)
 *  IntelliJ IDEA (这个。。。确实比Eclipse好用很多)

1.  在Idea中新建一个Maven项目，我暂命名为`springcloud-learn`
2.  删除其中的`src`目录
3.  修改`pom.xml`，最重要的就是`<packaging>pom</packaging>`，说明这是一个管理项目的工程。还可以在其中添加公共依赖，`<parent>`中指定SpringBoot的版本是`2.1.1.RELEASE`，`<dependencyManagement>`中指定SpringCloud的版本是`Finchley.SR2`，在之后的项目中，不需要再指定版本信息。  
    ![在这里插入图片描述][20190420223548521.png]

<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.chao</groupId>
      <artifactId>springcloud-learn</artifactId>
      <version>1.0-SNAPSHOT</version>
      <packaging>pom</packaging>
      <name>springcloud-learn</name>
      <url>https://github.com/cj96248/springcloud-learn</url>
    
      <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.1.RELEASE</version>
      </parent>
    
      <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
      </properties>
    
      <dependencyManagement>
        <dependencies>
          <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Finchley.SR2</version>
            <type>pom</type>
            <scope>import</scope>
          </dependency>
        </dependencies>
      </dependencyManagement>
    
    </project>

## 创建服务注册中心服务端 ##

在上面项目骨架的基础上，建立一个新模块`eureka server`。一般地，通过Idea可以直接创建一个SpringBoot项目，但是我习惯基于最原始的Maven项目来改造。

### 创建模块 ###

1.  新建一个模块`ms-a1-eureka-server`
2.  创建一个目录`resources`，右键选择`Mark Directory As`为`Resources Root`。
3.  删掉多余的文件。

*  红色方框中就是刚刚新加的内容  
    ![在这里插入图片描述][20190420224635328.png]

**检查是否成功**：  
1、在新建模块的pom中应该找到如下片段：

<parent>
        <artifactId>springcloud-learn</artifactId>
        <groupId>com.chao</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

2、在最外层的项目pom中应该找到如下片段：

<modules>
        <module>ms-a1-eureka-server</module>
    </modules>

### 从零开始创建Eureka Server ###

1、 添加依赖

<dependencies>
            <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-server</artifactId>
            </dependency>
        </dependencies>

> 父模块中已经指定了版本，这里不需要再指定版本号。

2、添加注解

*  修改启动类：

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

*  添加配置文件类（加注解）：

@Configuration
    @EnableEurekaServer
    public class CustomConfig { 
    }

> 一般，大家习惯将`@EnableEurekaServer`添加到启动类上，我不喜欢在启动类上添加很多东西，新建一个配置类，专门用来添加一些个性化的配置，目前不用在其中添加任何内容，未来扩展的时候可以添加相关配置。

3、添加配置

在`resources`目录下，添加文件`application.yml`文件，并添加如下内容：

server:
      port: 8761
    
    eureka:
      client:
        register-with-eureka: false
        fetch-registry: false
        service-url:
          defaultZone: http://localhost:8761/eureka

在默认情况下`erureka server`也是一个`eureka client`，需要指定两个参数`eureka.client.registerWithEureka：false`和`fetchRegistry：false`来表明自己是一个eureka server。`http://localhost:8761/eureka`是默认的eureka地址，既然是默认的，可以不写吗？  
在源码`EurekaClientConfigBean.java`类中，有下面一行代码，说明我们可以在测试环境下省略这个配置。  
`this.serviceUrl.put("defaultZone", "http://localhost:8761/eureka/")`

下面是最简易的eureka server配置。

server:
      port: 8761
    eureka:
      client:
        register-with-eureka: false
        fetch-registry: false

项目当前的结构：  
![在这里插入图片描述][20190420224810887.png]

### 查看euerka server管控台 ###

启动工程,打开浏览器访问：`http://localhost:8761` ,界面如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qaWFuZ2NoYW8uYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70]

## 商品服务-服务注册中心客户端 ##

创建一个新的模块`ms-a1-product-plain`。

1、 添加依赖

<dependencies>
            <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>
        </dependencies>

2、添加注解

添加配置文件类（加注解）：

@Configuration
    @EnableEurekaClient
    public class CustomConfig { 
    }

> 和之前唯一不的不同就是添加的为`@EnableEurekaClient`，标明这是eureka客户端。

3、添加配置

在`resources`目录下，添加文件`application.yml`文件，并添加如下内容：

server:
      port: 8080
    spring:
      application:
        name: product-plain
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8761/eureka

配置比之前少了一些，不过新加了一个配置`spring.application.name`，它是该配置文件中唯一一个不能少了的参数。`server.port`不配置默认是8080，`service-url`不配置默认是`http://localhost:8761/eureka`，在测试环境还能正常使用。`name`不配置的话，默认是`UNKNOWN`，后续工作就无法展开了。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qaWFuZ2NoYW8uYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1]

## 未完待续 ##

大部分文章在此时就结束了，其实eureka需要讨论的东西还很多，鉴于篇幅太长，在下一节中，我还将深入分析eureka的其他内容。

项目代码托管于[Github][]。

[20190420223451330.png_pic_center]: /images/20220217/5a7fc4d241d64bd59eaf50dd27ceb205.png
[Link 1]: https://jiangchao.blog.csdn.net/article/details/88937514
[1555750860x2890174249.png]: http://1.z9ls.com/t6/701/1555750860x2890174249.png
[20190420223548521.png]: /images/20220217/c7d2c9fd7869495a9c6aa094c770fc5d.png
[20190420224635328.png]: /images/20220217/fedf1396f319494fba3a4effb7318d6b.png
[20190420224810887.png]: /images/20220217/817f2927d7ac4f3d94d6df5b905cd27c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qaWFuZ2NoYW8uYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70]: /images/20220217/35634a6bf68647159b17b049e81663cc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qaWFuZ2NoYW8uYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1]: /images/20220217/936643dc90754862b99f64482eb7da5a.png
[Github]: https://github.com/cj96248/springcloud-learn