注册中心 Eureka 源码解析 —— 调试环境搭建（含源码）

Posted 2020-10-26

1. 依赖工具
   Gradle
   JDK
   IntelliJ IDEA
2. 源码拉取
   https://github.com/Netflix/eureka.git
   使用 IntelliJ IDEA 从 Fork 出来的仓库拉取代码。拉取完成后，Gradle 会下载依赖包，可能会花费一些时间，耐心等待下。

本文基于 master 分支。

3. Eureka-Server 启动
   Eureka-Server 启动调试方式，有三种方式，我们来尝试每一种。

3.1 MockRemoteEurekaServer
com.netflix.eureka.AbstractTester，测试抽象类，有如下实现子类：

使用任意一个子类的单元测试执行即可执行 Eureka-Server 逻辑的调试，这里以 com.netflix.eureka.resources.ApplicationsResourceTest 作为例子。
具有1-5工作经验的，面对目前流行的技术不知从何下手，需要突破技术瓶颈的可以加群。在公司待久了，过得很安逸，但跳槽时面试碰壁。需要在短时间内进修、跳槽拿高薪的可以加群。如果没有工作经验，但基础非常扎实，对java工作机制，常用设计思想，常用java开发框架掌握熟练的可以加群。java架构群：582505643一起交流。
Debug 运行 ApplicationsResourceTest#testFullAppsGetJson() 单元测试。在方法执行前，ApplicationsResourceTest#setUp() 会运行，初始化 Eureka-Server 模拟环境，例如：
com.netflix.eureka.mock.MockRemoteEurekaServer ( 模拟 Eureka-Server )。

因为是模拟环境，对 Eureka-Server 的操作不是 Eureka-Client 请求 Eureka-Server 的方式，而是直接调用单元测试对应的方法。例如：

// ApplicationsResourceTest.javabr/>@Test
public void testFullAppsGetJson() throws Exception {
Response response = applicationsResource.getContainers(
Version.V2.name(),
MediaType.APPLICATION_JSON,
null, // encoding
EurekaAccept.full.name(),
null, // uriInfo
null // remote regions
);

String json = String.valueOf(response.getEntity());
DecoderWrapper decoder = CodecWrappers.getDecoder(CodecWrappers.LegacyJacksonJson.class);

Applications decoded = decoder.decode(json, Applications.class);
// test per app as the full apps list include the mock server that is not part of the test apps
for (Application application : testApplications.getRegisteredApplications()) {
Application decodedApp = decoded.getRegisteredApplications(application.getName());
assertThat(EurekaEntityComparators.equal(application, decodedApp), is(true));
}
}
直接调用 ApplicationsResource#getContainers(...) 方法。
总结：这种方式，简单粗暴，容易上手。当然，它的缺点是模拟。刚开始调试 Eureka-Server 可以尝试这种方式。

3.2 Eureka-Server war 包
第一步，编译 Eureka-Server war 包。该步骤可能消耗漫长的时间，如果执行失败，请不断重试。命令如下：

cd eureka
./gradlew clean build
第二步，Debug 运行com.netflix.eureka.resources.EurekaClientServerRestIntegrationTest 任意单元测试方法。

总结：这种方式，编译的过程比较痛苦，不排除失败的可能性。每次增加对代码的注册后，都需要重新编译打包。因此不建议采用。那咋办呢？见第三种。良心如博主，赶紧关注博主的×××公众号：【芋道源码】。

3.3 Eureka-Server 直接启动
第一步，修改 EurekaClientServerRestIntegrationTest#startServer() 方法，解决第二种方式使用 war 包运行每次修改代码都需要重新编译的问题，实现代码如下：

// EurekaClientServerRestIntegrationTest.java
private static void startServer() throws Exception {
server = new Server(8080);

// TODO Thread.currentThread().getContextClassLoader() 获取不到路径，先暂时这样；
WebAppContext webAppCtx = new WebAppContext(new File("./eureka-server/src/main/webapp").getAbsolutePath(), "/");
webAppCtx.setDescriptor(new File("./eureka-server/src/main/webapp/WEB-INF/web.xml").getAbsolutePath());
webAppCtx.setResourceBase(new File("./eureka-server/src/main/resources").getAbsolutePath());
webAppCtx.setClassLoader(Thread.currentThread().getContextClassLoader());
server.setHandler(webAppCtx);
server.start();

eurekaServiceUrl = "http://localhost:8080/v2";
}
笔者不太熟悉 Gradle 的打包方式，使用 Thread.currentThread().getContextClassLoader().getResource() 方法，一直无法拿到路径，有知道的同学麻烦告知下。
第二步，Debug 运行com.netflix.eureka.resources.EurekaClientServerRestIntegrationTest 任意单元测试方法。TODO[0003]：Thread.currentThread().getContextClassLoader() 获取不到路径，先暂时这样；

总结：这种方式，完美。建议使用该方式调试。

4. Eureka-Client 启动
   我们以 com.netflix.eureka.ExampleEurekaClient 为例子。

第一步，在 EurekaClientServerRestIntegrationTest#setUp() 方法末尾添加 Thread.sleep(Long.MAX_VALUE) 代码。

第二步，按照「 3.3 Eureka-Server 直接启动」方法启动 Eureka-Server。

第三步，将 EurekaClientServerRestIntegrationTest#injectEurekaConfiguration 复制到 ExampleEurekaClient 类里。

第四步，在 ExampleEurekaClient#main() 方法的第一行，添加 injectEurekaConfiguration() 代码。

第五步，Debug 运行 ExampleEurekaClient#main() 方法。

eureka-examples 模块还提供别的例子，可以逐个调试