构建服务治理——Eureka

简单微服务架构如下：

简单微服务架构

服务治理的工程也是一个典型的Spring Boot应用：

首先构建一个parent工程，具体是为了将一些通用的依赖在一个地方引入，和普通的maven工程用法一样，

pom.xml如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--因为是基于Spring boot进行开发，所以这里继承了Spring boot的pom-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <!--parent的group、版本定义-->
    <groupId>com.jyswm</groupId>
    <artifactId>common-parent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>common-parent</name>
    <!--注意打包文件格式是pom-->
    <packaging>pom</packaging>
    <description>Demo project for Spring Boot</description>
    <!--通用属性、JDK版本及通用依赖包版本定义-->
    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>2020.0.3</spring-cloud.version>
        <guava.version>20.0</guava.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter</artifactId>
        </dependency>

        <!--Guava工具包-->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>${guava.version}</version>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.10</version>
        </dependency>
        <!--fastjson-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.58</version>
        </dependency>
       <!--commons-lang3-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.7</version>
        </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>

</project>

接下来构建服务治理eureka工程

pom.xml如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--将parent指定为common-parent-->
    <parent>
        <groupId>com.jyswm</groupId>
        <artifactId>common-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <artifactId>demo-eureka</artifactId>
    <name>demo-eureka</name>
    <description>Demo project for Spring Boot</description>

    <dependencies>
        <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-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

启动类代码如下：

//通过@EnableEurekaServer注解，SpringBoot在启动应用的时候就会自动构建一个默认的服务治理服务器。
@EnableEurekaServer
@SpringBootApplication
public class DemoEurekaApplication {

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

}

配置文件如下(application.yml)：

server:
  port: 8110
eureka:
  client:
    #启动服务完成后是否将该服务注册到服务治理服务器上
    register-with-eureka: false
    #表示应用启动后不需要从服务治理服务器中同步已注册的服务注册列表数据到本地
    fetch-registry: false
  server:
    wait-time-in-ms-when-sync-empty: 5

应用第一次与服务治理服务器同步注册服务列表数据后，默认以每30秒的频率与治理服务器进行同步。在配置中，可以通过属性eureka.client.registry-fetch-interval-seconds重新指定同步的时间间隔。

启动服务，浏览器访问，控制台界面如下：

Eureka服务器控制台

然后构建一个用户服务，注册到eureka中

pom.xml如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--将parent指定为common-parent-->
    <parent>
        <groupId>com.jyswm</groupId>
        <artifactId>common-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <artifactId>demo-user</artifactId>
    <name>demo-user</name>
    <description>Demo project for Spring Boot</description>

    <dependencies>
        <dependency>
            <groupId>com.jyswm</groupId>
            <artifactId>demo-service</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <!--数据源连接池-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.25</version>
        </dependency>
        <!--JPA依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <!--依赖eureka-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!--这是一个web类型项目-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

用户服务启动类如下：

//@EnableDiscoveryClient注解表示这是一个Eureka客户端，通过该注解，在Spring Boot启动完毕之后，
// 就会根据配置中的信息尝试与服务治理服务器进行连接，连接成功之后进行服务注册或者服务注册信息的同步。
@EnableDiscoveryClient
@SpringBootApplication
public class DemoUserApplication {

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

}

配置文件如下(application.yml)：

server:
  port: 2110
spring:
  application:
    name: demo-user

  datasource:
    name: test
    url: jdbc:mysql:// xxxxxx
      GMT%2B8
    username: xxxx
    password: xxxxxx
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver

#eureka相关配置
eureka:
  instance:
    prefer-ip-address: true
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8110/eureka

启动用户服务，查看eureka控制台如下：

用户服务已经注册到了注册中心

注意：一个服务实例注册到Eureka服务器时大概需要30秒才能够在控制台中查看到该服务。这是因为，Eureka要求服务提供者必须发送3次心跳（默认每次心跳间隔为10秒）后才认为该服务实例已经准备好，可以对外提供服务了。因此，当启动完一个服务实例时，在Eureka控制台中没有立即显示是一种正常现象。

对于每一个需要注册到Eureka服务器的服务都需要提供以下两个ID:

application.name：即应用的ID，用来对服务进行分组，相同的ID表示这些服务实例所提供的服务是相同的。当使用Spring Boot构建微服务时，该ID将使用spring. application.name属性所设置的值
instanceId：也就是微服务实例ID，用来标识每一个注册到Eureka服务器中的服务实例。默认情况下该值是由：服务宿主机器名称+服务名称+端口号构成。

最后构建一个商品服务来调用用户服务

pom.xml和上面用户服务的pom.xml相同，启动类也相同

配置文件如下(application.yml)，也只有服务的端口不同：

 server:
  port: 2120
spring:
  application:
    name: demo-product
# 下面相同的省略

启动商品服务，注册中心控制台如下：

注册中心控制台

调用用户微服务

在Spring Cloud中提供了多种实现方式，下面先来一个最直接的方式，通过RestTemplate来调用。

商品服务API代码如下：

@Slf4j
@RestController
@AllArgsConstructor
@RequestMapping("/product")
public class ProductController extends BaseController {

    private final RestTemplate restTemplate;

    /**
     * 根据用户ID获取用户
     *
     * @param id 用户ID
     * @return
     */
    @GetMapping(value = "/getUser/{id}")
    public BaseResult<UserVo> getUser(@PathVariable("id") String id) {
        try {
            log.debug("获取用户 入参id: {}", id);
            UserVo userVo = restTemplate.getForEntity(
                    "http://demo-user/user/getUser/{id}", UserVo.class, id).getBody();
            log.debug("获取用户到的用户userVo: 【{}】", userVo.toString());
            return success(userVo);
        } catch (Exception e) {
            return error("请求异常");
        }
    }

商品服务启动类稍作修改，如下：

@EnableDiscoveryClient
@SpringBootApplication
public class DemoProductApplication {
    
    //创建一个RestTemplate Bean
    @Bean(value = "restTemplate")
    @LoadBalanced
    RestTemplate restTemplate() {
        return new RestTemplate();
    }

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

}

用户服务API代码如下：

@Slf4j
@RestController
@AllArgsConstructor
@RequestMapping("/user")
public class UserController extends BaseController {

    @GetMapping(value = "/getUser/{id}")
    public UserVo getUser(@PathVariable("id") String id) {
        UserVo userVo = new UserVo();
        userVo.setId(id);
        userVo.setName(id);
        return userVo;
    }
}

一切准备就绪，发起调用，如下:

服务调用

然后通过Postman请求商品服务的获取用户接口：http://localhost:2120/product/getUser/123，如上图所示得到了用户信息，说明商品服务已经能够正确地通过Eureka访问到用户微服务了。

构建服务治理——Eureka

推荐阅读更多精彩内容