Spring Cloud 微服务研究之Spring Cloud Eureka

Spring Cloud Eureka

项目实例以及文章参考： http://cxytiandi.com/blog/detail/17470

GitHub: https://github.com/hanmosi/tay-spring-cloud/tree/master/chentay-eureka

Eureka介绍

Spring Cloud Eureka是Spring Cloud Netflix项目下的服务治理模块。
而Spring Cloud Netflix项目是Spring Cloud的子项目之一，主要内容是
对Netflix公司一系列开源产品的包装，它为Spring Boot应用提供了自配置的
Netflix OSS整合。通过一些简单的注解，开发者就可以快速的在应用中配置一
下常用模块并构建庞大的分布式系统。它主要提供的模块包括：服务发现（Eureka），
断路器（Hystrix），智能路由（Zuul），客户端负载均衡（Ribbon）等。

配置服务注册中心，好处在于，我们不需要知道究竟有多少服务供我们使用，只需要关注服务注册中心
是否存在我们想要使用的服务。即，当我们需要调用某一个服务的时候，首先会到Eureka中去拉取服务
列表，如果存在对应的服务，则获取对应的信息进行相应的调用请求。

Spring Cloud中使用Eureka

注意：这里使用Gradle来进行项目管理（有需要的同学，可以自行了解Gradle的使用），因此首先创建一个Gradle项目

• 在build.gradle中添加对应的依赖包

buildscript {
    ext {
        springBootVersion = '2.0.0.RELEASE'
    }
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

group = 'org.tay.chen'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
    mavenCentral()
    maven { url "http://maven.aliyun.com/nexus/content/groups/public/" }
    maven { url "https://repo.spring.io/milestone" }
}


ext {
    springCloudVersion = 'Finchley.M9'
}

dependencies {
    compile('org.springframework.boot:spring-boot-starter-actuator')
    compile('org.springframework.cloud:spring-cloud-starter-netflix-eureka-server')
    runtime('org.springframework.boot:spring-boot-devtools')
    compileOnly('org.projectlombok:lombok')
    testCompile('org.springframework.boot:spring-boot-starter-test')
}

dependencyManagement {
    imports {
        mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
    }
}

• 接着在启动类中使用@EnableEurekaServer注解，使之成为EurekaServer（服务注册中心）

/**
 * 服务注册中心
 *
 * @author chentai
 * @since 2018/03/23
 */
@EnableEurekaServer
@SpringBootApplication
public class ChentayEurekaApplication {

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

• 最后编写配置文件application.yml(这里推荐使用yaml配置)

server:
 port: 8761

spring:
  application:
    name: chentay-eureka

eureka:
  instance:
    hostname: localhost
# 作为服务注册中心，不需要向注册中心注册发现自己，所以设置为false
  client:
    register-with-eureka: false
# 由于注册中心的职责就是维护服务实例，它并不需要去检索服务，所以也设置为false
    fetch-registry: false
  server:
    enable-self-preservation: true # 关闭自我保护

最后运行启动类，访问 http://localhost:8761 就可以打开Eureka管理页面了。

至此，一个简单的Eureka（服务注册中心）应用便搭建成功了。

Eureka增加权限认证

上面我们简单的介绍了下注册中心Eureka，文章地址：https://github.com/hanmosi/tay-spring-cloud/blob/master/chentay-eureka/eureka.md

Eureka自带了一个web的管理页面，方便我们查询注册到上面的实例信息，但是有一个问题是如果这个地址有公网IP的话，必然能直接访问到，这样是不安全的。

如何解决这个问题呢？加用户认证即可！通过spring-security来开始用户认证。

• 在build.gradle中添加spring-security的依赖包

dependencies {
    compile('org.springframework.boot:spring-boot-starter-security')
}

注意，本实例的Spring Cloud项目是基于Spring Boot 2.0建立的，其中Spring Boot 2.0之前一些旧的配置已经不推荐使用，并且使用之后无效。

• 比如在这之前，我们添加spring-security依赖之后，可以直接在yaml文件里面配置一下内容即可

# 增加权限认证
security:
  basic:
    enabled: true
  user:
    name: chentay
    password: chentay

• 当然在Spring Boot 2.0之前的版本还需要注意一点，就是配置了用户密码之后，项目中的注册中心地址的配置也需要改变,需要加上认证的用户名和密码。

eureka:
  client:
    service-url:
      defaultZone: http://chentay:chentay@localhost:8761/eureka/

• 此时配置完成，重启服务，不出意外，我们可以通过配置好的用户密码进行访问服务注册管理页面。但是不幸的是，Spring Boot 2.0已经不推荐使用这样的操作，并且，security认证的密码信息必须经过加密，否则不予通过。因此，想要对我们的eureka服务进行简单的权限控制，就必须通过WebSecurityConfigurerAdapter 来进行简单的认证配置了。有需要的同学可以自行了解Spring Security。

/**
 * 权限过滤认证
 *
 * @author chentai
 * @since 2018/03/24
 */
@Configuration
@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter{

    @Bean
    public BCryptPasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }

    @Override
    public AuthenticationManager authenticationManagerBean() throws Exception {
        return super.authenticationManagerBean();
    }

    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.inMemoryAuthentication()
                .withUser("chentay").password(passwordEncoder().encode("chentay")).roles("ADMIN");
    }

    @Override
    public void configure(WebSecurity web) throws Exception {
        super.configure(web);
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        super.configure(http);
    }
}

从代码可以看出，我们使用了@Configuration、@EnableWebSecurity两个注解，将我们的类注入到配置里面，同时开启安全认证。这里值得注意的是，必须对密码进行加密处理。

至此，我们的安全认证已经配置完成，重启服务，输入我们设置的用户密码，OK，能够成功访问！

Eureka 服务上下线监控

如果仅仅是本地调试，我们不需要监控服务的上下线。但是，生产环境中，我们的微服务模块绝不仅仅只有那么几个，可能存在的微服务会很多。
这时候我们总不能安排一个人实时查看Eureka服务列表，此时，我们有必要对我们的服务的上下线进行监控。

在Eureka服务中进行检测通知，Eureka中提供了事件监听的方式来支持扩展

• EurekaInstanceCanceledEvent 服务下线事件

• EurekaInstanceRegisteredEvent 服务注册事件

• EurekaInstanceRenewedEvent 服务续约事件

• EurekaRegistryAvailableEvent Eureka注册中心启动事件

• EurekaServerStartedEvent Eureka Server启动事件

/**
 * Eureka事件监控
 *
 * @author chentai
 * @since 2018/03/24
 */
@Slf4j
@Component
public class EurekaStateChangeListener {

    @Autowired
    private DateFormatUtils dateFormatUtils;

    @EventListener
    public void listen(EurekaInstanceCanceledEvent event) {
        log.error("{}\t{} 服务下线",event.getServerId(),event.getAppName());
    }
    @EventListener
    public void listen(EurekaInstanceRegisteredEvent event) {
        InstanceInfo instanceInfo = event.getInstanceInfo();
        log.info("{}进行注册",instanceInfo.getAppName());
    }
    @EventListener
    public void listen(EurekaInstanceRenewedEvent event) {
        log.info("{}\t{} 服务进行续约",event.getServerId(),event.getAppName());
    }
    @EventListener
    public void listen(EurekaRegistryAvailableEvent event) {
        log.info("{} 注册中心启动",dateFormatUtils.stampToDate(event.getTimestamp()));
    }
    @EventListener
    public void listen(EurekaServerStartedEvent event) {
        log.info("{} Eureka Server 启动",dateFormatUtils.stampToDate(event.getTimestamp()));
    }

}

这里只是演示事件的效果，具体在什么事件中需要做什么操作，需要发邮件还是发短信，需要大家按自己的需求去实现了。

注意：在Eureka集群环境下，每个节点都会触发事件，这个时候需要控制下发送通知的行为，不控制的话每个节点都会发送通知。