一个使用Spring,Spring Boot 和Spring Cloud设置微服务系统的简单示例。
微服务允许从许多协作组件构建大型系统。它在流程级别执行Spring在组件级别执行的操作:松散耦合的流程而不是松散耦合的组件。
例如,设想一个在线商店,为用户帐户、产品目录订单处理和购物车提供单独的微服务:
不可避免地,要构建这样一个系统,必须设置和配置许多移动部件。如何让它们协同工作并不明显——你需要很好地熟悉Spring Boot,因为Spring Cloud充分利用了它,需要几个Netflix或其他OSS项目,当然,还有一些Spring配置“魔力”!
在本文中,我旨在通过逐步构建最简单的系统来阐明事物是如何工作的。因此,我将只实现大系统的一小部分—用户帐户服务。
Web应用程序将使用restful api向帐户服务microservice发出请求。我们还需要添加一个发现服务,以便其他进程能够找到彼此。
此应用程序的代码如下: http://github.com/paulc4/microservices-demo
对其工作原理的描述非常详细。不耐烦的读者可能更喜欢简单地看代码。注意,它在一个项目中包含三个微服务。
好吧,我们开始吧…
服务注册
当多个进程协同工作时,它们需要找到彼此。如果您曾经使用过Java的RMI机制,您可能还记得它依赖于一个中央注册表,这样RMI进程就可以找到彼此。微服务也有同样的要求。
Netflix的开发人员在构建系统时遇到了这个问题,他们创建了一个名为 Eureka 的注册服务器(希腊语为“我找到了”)。对我们来说幸运的是,他们使他们的发现服务器开源,而且Spring已经并入Spring Cloud,这使得运行Eureka服务器更加容易。下面是完整的discovery server应用程序:
@SpringBootApplication @EnableEurekaServer public class ServiceRegistrationServer { public static void main(String[] args) { // Tell Boot to look for registration-server.yml System.setProperty("<a href="https://javakk.com/tag/spring" title="查看更多关于 spring 的文章" target="_blank">spring</a>.config.name", "registration-server"); SpringApplication.run(ServiceRegistrationServer.class, args); } }
就这么简单!
SpringCloud构建在SpringBoot上,并使用父级和启动POM。POM的重要部分包括:
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.1.RELEASE</version> </parent> <dependencies> <dependency> <!-- Setup Spring Boot --> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <!-- Setup Spring MVC & REST, use Embedded Tomcat --> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <!-- <a href="https://javakk.com/tag/spring-cloud" title="查看更多关于 Spring Cloud 的文章" target="_blank">Spring Cloud</a> starter --> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter</artifactId> </dependency> <dependency> <!-- Eureka for service registration --> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-eureka-server</artifactId> </dependency> </dependencies> <!-- Spring Cloud dependencies --> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Finchley.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
这个POM已经改变,因为我最初写的文章使用springboot作为其父代,而不是springcloud。Spring云依赖关系是通过依赖关系管理部分提供的。
github代码中还包含一个示例gradle构建文件。
默认情况下,Spring引导应用程序寻找应用程序属性或者 application.yml
配置文件。通过设置 spring.config.name
属性,我们可以告诉SpringBoot查找不同的文件—如果您在同一个项目中有多个SpringBoot应用程序,这很有用—我很快就会这么做。
此应用程序寻找 registration-server.properties
或 registration-server.yml
. 以下是注册的相关 registration-server.yml
:
# Configure this Discovery Server eureka: instance: hostname: localhost client: # Not a client, don't register with yourself (unless running # multiple discovery servers for redundancy) registerWithEureka: false fetchRegistry: false server: port: 1111 # HTTP (Tomcat) port
默认情况下,Eureka在端口8761上运行,但这里我们将使用端口1111。另外,通过在进程中包含注册码,我可能是一个服务器或客户机。配置指定我不是客户机,并停止服务器进程尝试向自身注册。
现在尝试运行RegistrationServer(请参阅下面的运行应用程序的帮助)。您可以在此处打开Eureka仪表板: http://localhost:1111
,显示应用程序的部分将为空。
从现在起,我们将提到发现服务器,因为它可能是Eureka或Consul。
Spring Cloud还支持Consul作为Eureka的替代品。您可以使用脚本启动consur代理(它的注册服务器),然后客户机使用它来查找他们的微服务。
创建微服务:帐户服务
微服务是处理定义良好的需求的独立流程。
在使用Spring配置应用程序时,我们强调松耦合和紧密内聚,这不是新概念(Larry Constantine在20世纪60年代末首次定义了这些概念),但现在我们将它们应用于交互组件(Springbeans),而不是交互过程。
在这个例子中,我有一个简单的帐户管理微服务,它使用Spring数据实现jpaccount repository,Spring REST提供一个RESTful接口来访问帐户信息。在大多数方面,这是一个简单的 Spring Boot application
。
它的特殊之处在于它在启动时向发现服务器注册。以下是Spring Boot启动类:
@EnableAutoConfiguration @EnableDiscoveryClient @Import(AccountsWebApplication.class) public class AccountsServer { @Autowired AccountRepository accountRepository; public static void main(String[] args) { // Will configure using accounts-server.yml System.setProperty("spring.config.name", "accounts-server"); SpringApplication.run(AccountsServer.class, args); } }
注释完成了以下工作:
1. @EnableAutoConfiguration
将其定义为Spring引导应用程序。
2. @EnableDiscoveryClient
这将启用服务注册和发现。在本例中,此进程使用其应用程序名称(见下文)向discovery server服务注册自己。
3. @Import
( AccountsWebApplication.class
)-这个Java配置类设置其他所有内容(请参阅下面的详细信息)。
使这成为一项微服务的是通过 @EnableDiscoveryClient
向发现服务器注册,其YML配置完成了设置:
# Spring properties spring: application: name: accounts-service # Discovery Server Access eureka: client: serviceUrl: defaultZone: http://localhost:1111/eureka/ # HTTP Server server: port: 2222 # HTTP (Tomcat) port
请注意,此文件
1. 将应用程序名称设置为 accounts-service
。此服务使用此名称注册,也可以使用此名称访问-请参阅下面的。
2. 指定要侦听的自定义端口( 2222
)。我所有的进程都在使用Tomcat,它们不能都监听端口 8080
。
3. Eureka服务进程的URL-来自上一节。
现在运行 AccountsService
应用程序并让它完成初始化。刷新仪表板 http://localhost:1111
并且您应该看到“应用程序”下列出的 ACCOUNTS-SERVICE
。注册最多需要30秒(默认情况下),所以请耐心检查 RegistrationService
的日志输出
欲了解更多详情,请点击此处: http://localhost:1111/eureka/apps/
您应该看到如下内容:
<applications> <versions__delta>1</versions__delta> <apps__hashcode>UP_1_</apps__hashcode> <application> <name>ACCOUNTS-SERVICE</name> <instance> <hostName>autgchapmp1m1.corp.emc.com</hostName> <app>ACCOUNTS-SERVICE</app> <ipAddr>172.16.84.1</ipAddr><status>UP</status> <overriddenstatus>UNKNOWN</overriddenstatus> <port enabled="true">3344</port> <securePort enabled="false">443</securePort> ... </instance> </application> </applications>
警告:不要尝试使用Eclipse/STS的内部web查看器显示XML输出,因为它不能这样做。改用你最喜欢的网络浏览器。
或者转到 http://localhost:1111/eureka/apps/ACCOUNTS-SERVICE
,只需查看 AccountsService
的详细信息-如果未注册,您将获得404。
配置选项
注册时间:注册最多需要30秒,因为这是默认的客户端刷新时间。您可以通过设置 eureka.instance.leaseRenewalIntervalInSeconds=秒
属性设置为较小的数字(在演示应用程序中,我已将其设置为5)。在生产中不建议这样做。
eureka: instance: leaseRenewalIntervalInSeconds: 5 # DO NOT DO THIS IN PRODUCTION
注册Id:进程(微服务)使用唯一的Id向发现服务注册。如果另一个进程使用相同的Id注册,它将被视为重新启动(例如某种故障转移或恢复),第一个进程注册将被丢弃。这为我们提供了所需的容错系统。
为了运行同一进程的多个实例(为了负载平衡和恢复能力),它们需要用一个唯一的id注册。
在Angel release train下,客户机用于向发现服务器注册的实例id是从客户机的服务名称(与Spring应用程序名称相同)以及客户机的主机名称派生而来的。因此,在同一主机上运行的相同进程将具有相同的id,因此只有一个进程可以注册。
幸运的是,您可以通过客户端的Eureka元数据映射手动设置id属性,如下所示:
eureka: instance: metadataMap: instanceId: ${spring.application.name}:${spring.application.instance_id:${server.port}}
自从Brixton发布train以来,这是默认的。那它做什么呢?
我们正在将instanceId设置为 application-name:instance_id
,但如果未定义 instance_id
,则将改用 application-name::server-port
。请注意 spring.application.instance_id
仅在使用CloudFoundry时设置,但它方便地为同一应用程序的每个实例提供唯一的id号。在其他地方运行时,我们可以使用服务器端口执行类似的操作(因为同一台机器上的不同实例必须侦听不同的端口)。你经常看到的另一个例子是 ${spring.application.name}:${spring.application.instance_id:${random.value}}
但我个人发现,使用端口号可以很容易地识别每个实例—随机值只是长字符串,没有任何意义。
注意:语法 ${x:${y}}
是 ${x} != null ? ${x} : ${y}
。
自从Brixton发布以来,它还有一个专门的属性:
eureka: instance: instanceId: ${spring.application.name}:${spring.application.instance_id:${random.value}}
访问微服务:Web服务
为了使用RESTful服务,Spring提供了 RestTemplate
类。这允许您向RESTful服务器发送HTTP请求,并以多种格式获取数据,例如JSON和XML。
可以使用哪种格式取决于类路径上是否存在 marshaling
类—例如,JAXB总是被检测到,因为它是Java的标准部分。如果类路径中存在Jackson jar,则支持JSON。
微服务(discovery)客户机可以使用restemplate,Spring会自动将其配置为支持微服务(稍后会有更多)。
注意: Accounts
微服务提供了一个基于HTTP的RESTful接口,但是可以使用任何合适的协议。使用 AMQP 或 JMS 的消息传递是一个明显的替代方案(在这种情况下,不再需要发现服务器—相反,进程需要知道要与之交谈的队列的名称,可以考虑为此使用Spring云配置服务器)。