{"id":21997827,"url":"https://github.com/eacdy/spring-cloud-wii","last_synced_at":"2025-04-30T21:07:26.487Z","repository":{"id":57725424,"uuid":"204917454","full_name":"eacdy/spring-cloud-wii","owner":"eacdy","description":"An easy way to integrate polyglot apps for Spring Cloud.","archived":false,"fork":false,"pushed_at":"2019-10-31T09:13:23.000Z","size":50,"stargazers_count":76,"open_issues_count":3,"forks_count":25,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-30T21:07:21.464Z","etag":null,"topics":["spring-cloud","spring-cloud-alibaba","spring-cloud-gateway"],"latest_commit_sha":null,"homepage":"http://www.itmuch.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eacdy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-28T11:38:18.000Z","updated_at":"2023-10-19T13:36:30.000Z","dependencies_parsed_at":"2022-09-11T19:21:44.535Z","dependency_job_id":null,"html_url":"https://github.com/eacdy/spring-cloud-wii","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eacdy%2Fspring-cloud-wii","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eacdy%2Fspring-cloud-wii/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eacdy%2Fspring-cloud-wii/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eacdy%2Fspring-cloud-wii/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eacdy","download_url":"https://codeload.github.com/eacdy/spring-cloud-wii/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251782761,"owners_count":21642986,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["spring-cloud","spring-cloud-alibaba","spring-cloud-gateway"],"created_at":"2024-11-29T22:18:28.481Z","updated_at":"2025-04-30T21:07:26.468Z","avatar_url":"https://github.com/eacdy.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring Cloud Wii\n\n![wii](wii.png)\n\n\u003e LOGO制作网站：`http://www.uugai.com/`\n\nSpring Cloud Wii是一个用来 **快速整合** Spring Cloud 与 **异构微服务** 的框架，灵感来自 [Spring Cloud Netflix Sidecar](https://github.com/spring-cloud/spring-cloud-netflix/tree/master/spring-cloud-netflix-sidecar) 。目前支持的服务发现组件：\n\n* Nacos\n* Consul\n\n\n\n## 术语\n\n### 异构微服务\n\n非Spring Cloud应用，统称异构微服务。比如你的遗留项目，或者非JVM应用。\n\n### “完美整合”的三层含义\n\n* 享受服务发现的优势\n* 有负载均衡\n* 有断路器\n\n\n\n## 为什么要造这个轮子？\n\n原因有两点：\n\n* Spring Cloud子项目 `Spring Cloud Netflix Sidecar` 是可以快速整合异构微服务的。然而，Sidecar只支持使用Eureka作为服务发现，**如果使用其他服务发现组件就抓瞎了**。\n* **Sidecar是基于Zuul 1.x的**，Spring Cloud官方明确声明，未来将会逐步淘汰Zuul。今年早些时候，我有给Spring Cloud官方提出需求，希望官方实现一个基于Spring Cloud Gateway的新一代Sidecar，然而官方表示并没有该计划。详见：\u003chttps://github.com/spring-cloud/spring-cloud-gateway/issues/735\u003e\n\n既然没有，索性自己写了。\n\n\n\n## 原理\n\n* Wii根据配置的异构微服务的IP、端口等信息，**将异构微服务的IP/端口注册到服务发现组件上** 。\n* Wii实现了 **健康检查** ，Wii会定时检测异构微服务是否健康。如果发现异构微服务不健康，Wii会自动将代表异构微服务的Wii实例下线；如果异构微服务恢复正常，则会自动上线。最长延迟是30秒，详见 `WiiChecker#check` 。\n\n\n\n## 要求\n\n- 【必须】你的异构微服务需使用HTTP通信。这一点严格来说不算要求，因为Spring Cloud本身就是基于HTTP的；\n- 【可选】如果微服务配置了 `wii.health-check-url` ，则表示开启了Wii的健康检查，此时，你的异构微服务需实现健康检查（可以是空实现，只要暴露一个端点，返回类似 `{\"status\": \"UP\"}` 的字符串即可）。\n\n\n\n## 使用示例\n\n* 如使用Nacos作为服务发现组件，详见 `examples/spring-cloud-wii-example-nacos` \n* 如使用Consul作为服务发现组件，详见 `examples/spring-cloud-wii-example-consul`\n\n\n\n### 示例代码（以Nacos服务发现为例）\n\n* 依赖管理：Spring Cloud Alibaba版本必须是2.1.x+，否则会报错。这主要是因为Spring Cloud Alibaba修改了包名命名…不同版本的类名包结构不同，而Wii使用了Nacos的类，所以版本必须保持一致。\n\n  ```xml\n  \u003cdependencyManagement\u003e\n    \u003cdependencies\u003e\n      \u003cdependency\u003e\n        \u003cgroupId\u003eorg.springframework.cloud\u003c/groupId\u003e\n        \u003cartifactId\u003espring-cloud-dependencies\u003c/artifactId\u003e\n        \u003cversion\u003e${spring-cloud.version}\u003c/version\u003e\n        \u003ctype\u003epom\u003c/type\u003e\n        \u003cscope\u003eimport\u003c/scope\u003e\n      \u003c/dependency\u003e\n      \u003cdependency\u003e\n        \u003cgroupId\u003ecom.alibaba.cloud\u003c/groupId\u003e\n        \u003cartifactId\u003espring-cloud-alibaba-dependencies\u003c/artifactId\u003e\n        \u003cversion\u003e2.1.0.RELEASE\u003c/version\u003e\n        \u003ctype\u003epom\u003c/type\u003e\n        \u003cscope\u003eimport\u003c/scope\u003e\n      \u003c/dependency\u003e\n    \u003c/dependencies\u003e\n  \u003c/dependencyManagement\u003e\n  ```\n\n* 加依赖：\n\n  ```xml\n  \u003cdependency\u003e\n    \u003cgroupId\u003ecom.itmuch\u003c/groupId\u003e\n    \u003cartifactId\u003espring-cloud-wii\u003c/artifactId\u003e\n    \u003cversion\u003e0.0.1-SNAPSHOT\u003c/version\u003e\n  \u003c/dependency\u003e\n  ```\n\n* 写配置：\n\n  ```yaml\n  server:\n    port: 8070\n  spring:\n    cloud:\n      nacos:\n        discovery:\n          server-addr: localhost:8848\n      gateway:\n        discovery:\n          locator:\n            enabled: true\n    application:\n      name: wii-node-service\n  wii:\n    # 异构微服务的IP\n    ip: 127.0.0.1\n    # 异构微服务的端口\n    port: 8060\n    # 异构微服务的健康检查URL\n    health-check-url: http://localhost:8060/health.json\n  ```\n\n  配置比较简单，就是把Wii注册到Nacos上，然后添加了几行wii的配置。\n\n\n\n### 异构微服务\n\n我这里准备了一个NodeJS编写的简单微服务。\n\n```javascript\nvar http = require('http');\nvar url = require(\"url\");\nvar path = require('path');\n\n// 创建server\nvar server = http.createServer(function(req, res) {\n    // 获得请求的路径\n    var pathname = url.parse(req.url).pathname;\n    res.writeHead(200, { 'Content-Type' : 'application/json; charset=utf-8' });\n    // 访问http://localhost:8060/，将会返回{\"index\":\"欢迎来到首页\"}\n    if (pathname === '/') {\n        res.end(JSON.stringify({ \"index\" : \"欢迎来到首页\" }));\n    }\n    // 访问http://localhost:8060/health，将会返回{\"status\":\"UP\"}\n    else if (pathname === '/health.json') {\n        res.end(JSON.stringify({ \"status\" : \"UP\" }));\n    }\n    // 其他情况返回404\n    else {\n        res.end(\"404\");\n    }\n});\n// 创建监听，并打印日志\nserver.listen(8060, function() {\n    console.log('listening on localhost:8060');\n});\n```\n\n\n\n\n\n### 测试\n\n#### 测试1：Spring Cloud微服务完美调用异构微服务\n\n你的Spring Cloud项目整合Ribbon，只需构建 `http://wii-node-service` 就可以请求到异构微服务了。\n\n示例：\n\nRibbon请求 `http://wii-node-service/` 会请求到 `http://localhost:8060/` 以此类推。\n\n至于断路器，正常为你的Spring Cloud微服务整合Sentinel或者Hystirx、Resilience4J即可 。\n\n\n\n#### 测试2：异构微服务完美调用Spring Cloud微服务\n\n由于Wii基于Spring Cloud Gateway，而网关自带转发能力啊。\n\n示例：\n\n如果你有一个Spring Cloud微服务叫做 `spring-cloud-microservice` ，那么NodeJS应用只需构建 `http://localhost:8070/spring-cloud-microservice/**` ，Wii就会把请求转发到 `spring-cloud-microservice` 的 `/**` 。\n\n而Spring Cloud Gateway是整合了Ribbon的，所以实现了负载均衡；Spring Cloud Gateway还可以整合Sentinel或者Hystirx、Resilience4J，所以也带有了断路器。\n\n\n\n## Wii优缺点分析\n\nWii的设计和Sidecar基本一致，优缺点和Sidecar的优缺点也是一样的。\n\n优点：\n\n* 接入简单，几行代码就可以将异构微服务整合到Spring Cloud生态\n* 不侵入原代码\n\n缺点：\n\n* 每接入一个异构微服务实例，都需要额外部署一个Wii实例，增加了部署成本（虽然这个成本在Kubernetes环境中几乎可以忽略不计（只需将Wii实例和异构微服务作为一个Pod部署即可））；\n* 异构微服务调用Spring Cloud微服务时，本质是把Wii当网关在使用，经过了一层转发，性能有一定下降。\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feacdy%2Fspring-cloud-wii","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feacdy%2Fspring-cloud-wii","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feacdy%2Fspring-cloud-wii/lists"}