初识Spring Cloud--Eureka服务注册中心搭建

女爷i 2022-04-13 08:47 312阅读 0赞

首先，来认识一下SpringCloud：

Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理、服务发现、断路器、智能路由、微代理、控制总线、一次性令牌、全局锁、领导选举、分布式会话、集群状态)。分布式系统的协调导致了样板模式，使用Spring Cloud开发人员可以快速建立实现这些模式的服务和应用程序。它们可以在任何分布式环境中很好地工作，包括开发人员自己的笔记本电脑、裸金属数据中心和云计算等托管平台([http://spring.io/projects/spring-cloud][http_spring.io_projects_spring-cloud])。

作为一款微服务框架SpringCloud在最近的几年时间里经历了快速的发展，下面我们来搭建一个SpringCloud服务注册的项目:

SpringCloud默认使用eureka作为注册中心，下面是eureka的架构图:

![eureka_architecture.png][]

下面，我们先对服务端进行配置:

1.首先，通过springboot项目的向导创建一个项目，导入spring cloud相关的依赖，具体的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.example</groupId>
    	<artifactId>sc01</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<packaging>jar</packaging>
    
    	<name>sc01</name>
    	<description>eureka server test</description>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.1.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>Greenwich.M3</spring-cloud.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-aop</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>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-undertow</artifactId>
    		</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-milestones</id>
    			<name>Spring Milestones</name>
    			<url>https://repo.spring.io/milestone</url>
    			<snapshots>
    				<enabled>false</enabled>
    			</snapshots>
    		</repository>
    	</repositories>
    </project>

2.在application.properties配置文件中添加相关的配置:

server.port=8989
    
    eureka.instance.hostname=server01
    eureka.instance.prefer-ip-address=true
    
    eureka.client.serviceUrl.defaultZone=http://${eureka.instance.hostname}:${server.port}/eureka/
    eureka.client.registerWithEureka=false
    eureka.client.fetchRegistry=false

这里我们指定注册中心的服务端端口号为8989，实例的主机名为server01，  eureka.client.registerWithEureka设置为false意味着自身仅作为服务器，不作为客户端； eureka.client.fetchRegistry:设置为false意味着无需注册自身；eureka.client.serviceUrl.defaultZone表示服务注册中心的位置 。

3.在启动类上添加@EnableEurekaServer注解并启动，通过浏览器打开[http://localhost:8989/][http_localhost_8989]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbGlzaGFkYWE_size_16_color_FFFFFF_t_70][]

至此，一个注册中心的服务端建立完毕。

下面我们再来创建服务的提供者，也即Client端:

1.在client端中，除了之前的一些依赖还需要加入web相关的依赖，具体的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.example</groupId>
        <artifactId>sc02</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>sc02</name>
        <description>eureka client</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.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>Greenwich.M3</spring-cloud.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </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-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
    </project>

2.对Client进行相关的配置:

server.port=8990
    spring.application.name=service01
    eureka.instance.hostname=server01
    eureka.client.serviceUrl.defaultZone= http://localhost:8989/eureka/
    eureka.client.registerWithEureka=true
    eureka.client.fetchRegistry=true

我们可以通过 spring.application.name来指明这个服务的名称。

3.然后在启动类上加上@EnableEurekaClient注解，并启动.

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbGlzaGFkYWE_size_16_color_FFFFFF_t_70 1][]

打开控制面板，可以发现相应的服务已经成功注册。

通过前面的介绍，我们大致对Eureka有所了解了，但是Eureka的安全性又如何呢？在安全性方面Eureka默认提供了一个HTTP Basic 验证方案，具体的设置如下：

1.在eureka server引入Spring Security相关的依赖:

<dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-security</artifactId>
    </dependency>

2.有一点需要注意，Spring Security默认开启了csrf([相关资料][Link 1]）,这里可以直接将csrf关闭，或者忽略某些请求，不然客户端是无法注册上的。

/**
     * Created by lusaijie on 2018/11/20.
     */
    @EnableWebSecurity
    @Configuration
    public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
        @Override
        protected void configure(HttpSecurity http) throws Exception {
            http.csrf().ignoringAntMatchers("/eureka/**");
            super.configure(http);
        }
    }

3.在server端对spring security进行相关的配置:

spring.security.user.name=lsj
    spring.security.user.password=123
    spring.security.basic.enabled=true

4.因为加了密码校验，所以客户端在进行注册的时候也需要将用户名以及密码传入:

eureka.client.serviceUrl.defaultZone= http://lsj:123@localhost:8989/eureka/

到这里，还没有结束，依然有一些小细节值得注意：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbGlzaGFkYWE_size_16_color_FFFFFF_t_70 2][]

这里边注册的服务如果已经down掉，依然会显示UP，原因是Eureka Server具有自我保护机制。Eureka Server在运行期间，会统计心跳失败的比例在15分钟之内是否低于85%，如果出现低于的情况（网络抖动等情况），Eureka Server会将当前的实例注册信息保护起来，同时提示警告。

我们可以通过下面的方式关闭：

服务端配置:

eureka.server.enable-self-preservation=false

客户端配置:

eureka.instance.lease-renewal-interval-in-seconds=1
    eureka.instance.lease-expiration-duration-in-seconds=2

在控制面板上边还有显示节点信息的功能，如果需要查看某个节点的信息可以通过spring-boot-actuator组件进行查看，现在需要查看的是client信息，这里需要在client端导入相关的依赖:

<dependency>           
          <groupId>org.springframework.boot</groupId>         
          <artifactId>spring-boot-starter-actuator</artifactId>     
     </dependency>

在配置文件中进行配置，设定Eureka按照IP地址而不是域名进行访问，并打开相应的端点:

eureka.instance.prefer-ip-address=true
    management.endpoints.enabled-by-default=false
    management.endpoint.info.enabled=true
    management.endpoint.health.enabled=true

2.服务的名称过长，可读性不好，这个可以通过在配置文件中添加:

eureka.instance.instance-id=service01-8990

即可:

![20181201165802917.PNG][]

3.当然这个查看info信息只是一个空的json串，我们可以手动在配置文件中进行相关的配置和说明:

在application.properties文件中添加如下的代码:

info.app.name=service01
    info.company.name= www.lsj.com
    info.build.artifactId= @project.artifactId@
    info.build.version= @project.version@

我们通过@标识符来表示这是一个变量，然后通过maven的插件进行解析,导入maven插件,对pom文件做如下的更改:

<build>
            <finalName>service01</finalName>
            <resources>
                <resource>
                    <directory>src/main/resources</directory>
                    <filtering>true</filtering>
                </resource>
            </resources>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <delimiters>
                            <delimit>@</delimit>
                        </delimiters>
                    </configuration>
                </plugin>
            </plugins>
    </build>

![20181201224753183.PNG][]

至此，一个最简单的入门级程序编写完毕，代码没写几行，竟然实现了这么多功能，依赖于Spring Boot 的易用性，Spring Cloud真是简洁到了极致!

[http_spring.io_projects_spring-cloud]: http://spring.io/projects/spring-cloud
[eureka_architecture.png]: https://raw.githubusercontent.com/Netflix/eureka/master/images/eureka_architecture.png
[http_localhost_8989]: http://localhost:8989/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbGlzaGFkYWE_size_16_color_FFFFFF_t_70]: /images/20220413/c2bc76eae1c64abb8e16fcecece96c1b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbGlzaGFkYWE_size_16_color_FFFFFF_t_70 1]: /images/20220413/729b51529b9e4732ba0ab98d2382646d.png
[Link 1]: https://www.owasp.org/index.php/Cross-Site_Request_Forgery_%28CSRF%29
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbGlzaGFkYWE_size_16_color_FFFFFF_t_70 2]: /images/20220413/22bb510a91f943dfa94e1568fffa9de4.png
[20181201165802917.PNG]: /images/20220413/bf4a115b09084b21bf32339847050bd7.png
[20181201224753183.PNG]: /images/20220413/3f9d4ecbb6f84f3e9f88623f3595eba4.png