Spring Cloud之Eureka服务注册与发现（配置搭建使

作者: 小码的小坑 | 来源:发表于2017-10-02 01:21 被阅读738次

解决什么问题

➟Eureka搭建的前置技术

➟Eureka的搭建

➟Eureka主要配置项说明

前置技术

➟对spring有一定了解

➟对spring boot有一定了解，并且已经搭建起spring boot开发环境。如果未搭建，可以直接到官网下载STS

➟由于spring boot内容比较多且重要，可以作为一个独立的框架直接应用在项目中，所以后续会开一个专题讲解

➟对maven有一定了解

开发环境

➟JDK1.8

➟开发工具：STS

Eureka的搭建

➟新建项目File > New > Other... > 找到并选择Maven下的Maven Project > Next

➟选择自己的Workspace，建议增加并选择一个新的工作集，集中管理当前项目以及后续需要整合的全部spring cloud系列组件项目。> Next

➟选择quickstart（注：本项目是WEB状态的项目，每个微服务实例、组件都是以WEB状态提供服务，但是本项最终打包为jar文件，所以无需使用WEB原型的项目，请注意区分WEB状态和WEB原型。）

➟填写项目基础信息，完成。


Group Id:com.my.integration.eureka//可自定义，等同于项目包名

Artifact Id:my-integration-eureka//可自定义，等同于项目名

Version:默认

Package:com.my.integration.eureka//可自定义，项目包名

➟项目新建完后在项目根目录下找到pom.xml文件并修改如下：

<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.my.integration.eureka</groupId>
    <artifactId>my-integration-eureka</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>my-integration-eureka</name>

    <!-- 封装spring boot 封装spring starter封装、自动配置autoconfiguration等等 -->
    <parent>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-parent</artifactId>
        <version>Dalston.SR1</version>
        <relativePath />
    </parent>

    <!-- 把版本号等依赖关系的管理让依赖组管理 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Dalston.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>
    <!-- ####################以上配置除了项目基础信息外，其他为基础依赖关系，后续项目直接复用就可以无需修改，版本统一为父类的Dalston.SR1####################### -->


    <dependencies>
        <!-- *spring-boot-starter-web web项目，集成容器tomcat -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 建议集成spring-boot-starter-actuator 管理工具/web 查看堆栈，动态刷新配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!-- *cloud eureka组件 注册中心 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka-server</artifactId>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

注：如果项目出现莫名的小红叉，项目名右键>maven>update project；
如果项目是第一次使用以上的包，maven会自动下载相关的包以及依赖包，但是下载过程很有可能因为网络原因出现包下载失败，具体表现为pom.xml文件某行有小叉叉，可能的报错为：
Failure to transfer org.apache.maven.plugins:maven-xxx-plugin:pom:2.7.1 from http://repo1.maven.org/maven2 was cached in the local repository, resolution will not be reattempted until the update interval of central has elapsed or updates are forced
在系统根目录下找到本地仓库m2隐藏文件夹下的repository文件夹，然后根据提示的错误信息找到对应路径下的文件夹里面的.lastupdated文件，删除后重新下载。

➟项目目录src/main/下新增resources文件夹，该文件夹下增加3个文件：application.yml，bootstrap.yml，logback-spring.xml
application.yml文件，内附部分主要配置说明。由于是单机环境，所以部分配置写死。可以自行修改或者看我后续综合集群的配置说明。

# 上下文初始化加载
info:
  name: Eureka server，简书：http://www.jianshu.com/u/538905f64fab 微信公众号：小码的小坑
  contact: 小码的小坑

spring:
  profiles:
    active: dev
---
spring:
  profiles: dev
server:
  port: 8881
eureka:
  client:
    # 是否注册到eurekaserver
    registerWithEureka: true
    # 是否拉取信息，如果开启，可能会有报错，不影响。原因是service初始化未完成，节点还没生成，客户端拉取信息执行了。
    fetchRegistry: true
    # eureka server地址
    serviceUrl:
      defaultZone: http://127.0.0.1:8881/eureka/
  server:
    # 在Eureka服务器获取不到集群里对等服务器上的实例时，需要等待的时间，单位为毫秒，默认为1000 * 60 * 5
    waitTimeInMsWhenSyncEmpty: 60000
    # 自我保护模式，当出现网络分区、eureka在短时间内丢失过多客户端时，会进入自我保护模式，即一个服务长时间没有发送心跳，eureka也不会将其删除，默认为true
    enableSelfPreservation: true
    # 集群里eureka节点的变化信息更新的时间间隔，单位为毫秒，默认为10 * 60 * 1000
    peerEurekaNodesUpdateIntervalMs: 600000
  instance:
    # 与此实例相关联的主机名，是其他实例可以用来进行请求的准确名称
    hostname: eureka1
---
spring:
  profiles: eureka1
server:
  port: 8881
eureka:
  client:
    registerWithEureka: true
    fetchRegistry: true
    serviceUrl:
      defaultZone: http://127.0.0.1:8881/eureka/,http://127.0.0.1:8882/eureka/
  server:
    waitTimeInMsWhenSyncEmpty: 0
  instance:
    hostname: eureka1
    metadataMap: 
      instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}

---
spring:
  profiles: eureka2
server:
  port: 8882
eureka:
  client:
    registerWithEureka: true
    fetchRegistry: true
    serviceUrl:
      defaultZone: http://127.0.0.1:8881/eureka/,http://127.0.0.1:8882/eureka/
  server:
    waitTimeInMsWhenSyncEmpty: 0
  instance:
    hostname: eureka2
    metadataMap: 
      instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}


---
spring:
  profiles: eureka3
server:
  port: 8883
eureka:
  client:
    registerWithEureka: true
    fetchRegistry: true
    serviceUrl:
      defaultZone: http://eureka1:8881/eureka/,http://eureka2:8882/eureka/,http://eureka3:8883/eureka/
  server:
    waitTimeInMsWhenSyncEmpty: 0
  instance:
    hostname: eureka3
    metadataMap: 
      instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}

bootstrap.yml优先级高于application，用于配置部分先置于application的配置信息，如部分环境变量等。后续综合集群中会增加内容。

# 比application context先加载
# 配置应用名称
spring:
  application:
    name: eureka-server

logback-spring.xml：log的配置，方便日志的查看以及后续的综合集群时日志的管理

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    
    <springProperty scope="context" name="springAppName"
        source="spring.application.name" />

    <!-- You can override this to have a custom pattern -->
    <property name="CONSOLE_LOG_PATTERN"
        value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}" />

    <!-- Appender to log to console -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!-- Minimum logging level to be presented in the console logs -->
            <level>DEBUG</level>
        </filter>
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>

    <logger name="com.my" level="debug"/>
    <logger name="com.netflix.eureka" level="debug"/>
    <logger name="org.springcloud" level="debug"/>
    <root level="warn">
        <appender-ref ref="console" />
    </root>
</configuration>

➟项目目录src/main/java下找到包com.my.integration.eureka下的App.java文件修改为：

package com.my.integration.eureka;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

/**
 * 
 * @author my
 * 
 * @SpringBootApplication为SpringBoot入口注解
 * @EnableEurekaServer注解就可以让应用变为Eureka服务器，这是因为spring boot封装了Eureka Server，可以嵌入到应用中直接使用。
 *
 */
@SpringBootApplication
@EnableEurekaServer
public class App {
private static Logger logger = LoggerFactory.getLogger(App.class);
    
    public static void main(String[] args) {
        logger.debug("Initializing EurekaApp -------------------------------------------");
        long startTime = System.currentTimeMillis();
        
        new SpringApplicationBuilder(App.class).web(true).run(args);
        
        if (logger.isDebugEnabled()) {
            long elapsedTime = System.currentTimeMillis() - startTime;
            logger.debug("start EurekaApp completed in " + elapsedTime + "ms -------------------------------------------");
        }
    }
}

➟直接运行App.java，等待项目启动完毕后访问：http://127.0.0.1:8881/（如果修改了配置文件请对应修改访问地址和端口）
➟集群测试：application.yml中可以通过active配置的切换来启动多个eureka服务。先用eureka1的版本在App.java中通过Run as启动Spring Boot App;启动完毕后修改active配置为eureka2,再次启动。这个时候就可以看到两个eureka服务集群被启动。可以通过http://127.0.0.1:8881/或者http://127.0.0.1:8882/查看。

# 上下文初始化加载
info:
  name: Eureka server，简书：http://www.jianshu.com/u/538905f64fab 微信公众号：小码的小坑
  contact: 小码的小坑

spring:
  profiles:
    # 在这里修改active的版本配置信息：默认的dev为单机测试，eureka1和eureka2为单机集群测试，eureka3为集群的配置方式，但是后续还需吧部分粘合配置代码写活。
    active: eureka1

注：由于是本机测试，所以部分代码配置的地址是被写死的，后续综合集群时，装载到在docker前会通过环境变量或者定义的方式把配置写活。如下面的IP地址配置：

eureka:
  client:
    registerWithEureka: true
    fetchRegistry: true
    serviceUrl:
      defaultZone: http://127.0.0.1:8881/eureka/,http://127.0.0.1:8882/eureka/

注：如果在eureka后台中出现以下红字提示，可以不用管，这是当前服务节点进入了保护模式。

EMERGENCY! EUREKA MAY BE INCORRECTLY CLAIMING INSTANCES ARE UP WHEN THEY'RE NOT. RENEWALS ARE LESSER THAN THRESHOLD AND HENCE THE INSTANCES ARE NOT BEING EXPIRED JUST TO BE SAFE.

➟用例客戶端集群测试：
→参看之前的maven项目构建过程，新建一个名为my_test的项目
→pom.xml修改为：

<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.my.test</groupId>
    <artifactId>my_test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>my_test</name>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

<!-- 把版本号等依赖关系的管理让依赖组管理 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Dalston.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <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>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>
</project>

→项目目录src/main/下新增resources文件夹，该文件夹下增加1个文件：application.yml，配置为：

eureka:
  client:
    serviceUrl:
      #注意这里的配置需要和eureka中启动的版本内容一样
      defaultZone: http://localhost:8881/eureka/
server:
  #定义测试用例端口。修改另外一个端口号后再启动一次，可以看到集群效果
  port: 8981
spring:
  application:
    #用例名
    name: service-test

→项目目录src/main/java下找到包com.my.test下的App.java文件修改为：

package com.my.test;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
@EnableEurekaClient
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
    
    
    @Value("${server.port}")
    String serverPort;
    
    @RequestMapping("/test/eureka")
    public String home(@RequestParam String name) {
        return "test " + name + " from port:" + serverPort;
    }
}

→运行eureka项目中的App.java文件。启动完毕后，运行该java文件。可以通过修改8981端口在启动一个测试客户端查看集群效果。
→访问http://127.0.0.1:8881/查看eureka后台，可以看到eureka和客户端实例情况。

1111.png

➟自此所有整合完成。由于增加客户端仅仅是为了测试效果，所以使用了简单的配置文件写死的方式完成，实际生产环境中，这里配置是不合理的。后续综合集成时，会通过变量配置、接口等方式将粘合代码去除。

Spring Cloud之Eureka服务注册与发现（配置搭建使

解决什么问题

前置技术

开发环境

Eureka的搭建

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读