标签:迁移 instance image pps rop oid 进入 exp mapping
alpha是什么:
获取源码:
$ git clone https://github.com/apache/servicecomb-pack.git
$ cd servicecomb-pack
Saga可通过以下任一方式进行构建:
只构建可执行文件:
$ mvn clean install -DskipTests
同时构建可执行文件和docker镜像:
$ mvn clean install -DskipTests -Pdocker
同时构建可执行文件以及Saga发行包
$ mvn clean install -DskipTests -Prelease
在执行以上任一指令后,可在alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar
中找到alpha server的可执行文件。
<dependency>
<groupId>org.apache.servicecomb.pack</groupId>
<artifactId>omega-spring-starter</artifactId>
<version>${pack.version}</version>
</dependency>
<dependency>
<groupId>org.apache.servicecomb.pack</groupId>
<artifactId>omega-transport-resttemplate</artifactId>
<version>${pack.version}</version>
</dependency>
注意: 请将${pack.version}
更改为实际的版本号。版本迁移提示: 从0.3.0 开始,整个项目的代码库名由servicecomb-saga改名为servicecomb-pack, 与此同时我们也更新了对应发布包的组名以及相关包名。如果你的项目是从saga 0.2.x 迁移过来,请按照下表所示进行修改。
name | 0.2.x | 0.3.x |
---|---|---|
groupId | org.apache.servicecomb.saga | org.apache.servicecomb.pack |
Package Name | org.apache.servicecomb.saga | org.apache.servicecomb.pack |
添加Saga的注解及相应的补偿方法以一个转账应用为例:
在全局事务的起点添加 @SagaStart
的注解。
import org.apache.servicecomb.pack.omega.context.annotations.SagaStart;
?
timeout=10) (
public boolean transferMoney(String from, String to, int amount) {
transferOut(from, amount);
transferIn(to, amount);
}
注意: 默认情况下,超时设置需要显式声明才生效。
在子事务处添加 @Compensable
的注解并指明其对应的补偿方法。
import javax.transaction.Transactional;
import org.apache.servicecomb.pack.omega.transaction.annotations.Compensable;
?
timeout=5, compensationMethod="cancel") (
public boolean transferOut(String from, int amount) {
repo.reduceBalanceByUsername(from, amount);
}
public boolean cancel(String from, int amount) {
repo.addBalanceByUsername(from, amount);
}
注意: 实现的服务使用相当的参数,实现的服务和补偿必须满足幂等的条件,同时建议使用Spring @Transactional标注提供本地事务保证。
注意: 默认情况下,超时设置需要显式声明才生效。
注意: 若全局事务起点与子事务起点重合,需同时声明 @SagaStart
和 @Compensable
的注解。
增加 alpha.cluster.address 参数
alpha
cluster
address alpha-server.servicecomb.io8080
对转入服务重复第二步即可。
从pack-0.3.0开始, 你可以在服务函数或者取消函数中通过访问 OmegaContext 来获取 gloableTxId 以及 localTxId 信息。
在一般情况下,Omega能够替你处理事务上下文的传递工作(详情见服务间通信流程),因此你的代码并不需要知道事务上下文的存在。而事务上下文的传递实际上是通过在请求方注入、在接受方提取来完成的,下面举一个请例子来说明这个过程:
Service A:
@SagaStart public void foo() { restTemplate.postForEntity("http://service-b/bar", ...); }
Service B:
@GetMapping("/bar") @Compensable public void bar() { ... }
我们可以先来看看Omega是怎么传递事务上下文的:
Service A的foo方法会开启一个新的全局事务。
TransactionClientHttpRequestInterceptor会在RestTemplate请求Service B时在Http请求头中注入事务上下文信息。
当Servce B接收到请求时,TransactionHandlerInterceptor会从请求头中提取事务上下文信息。
目前Omega支持以下形式的隐式事务上下文传递:
omega-transport-{dubbo,feign,resttemplate,servicecomb}。
同线程内调用(基于OmegaContext的ThreadLocal字段)。
标注了@OmegaContextAware的java.util.concurrent.Executor{Service}。
那么问题来了,如果无法隐式传递事务上下文怎么办?比如Service A使用某种RPC机制件来调用Service B,而你又没有办法注入或提取事务上下文信息。这个时候你只能采用显式的方式把事务上下文传递出去。ServiceComb Pack从0.5.0开始提供了两个类来实现这一点。
Service A:
@SagaStart public void foo(BarCommand cmd) { TransactionContext localTxContext = omegaContext.getTransactionContext(); someRpc.send(cmd, localTxContext); }
Service B:
public void listen(BarCommand cmd, TransactionContext injectedTxContext) { bar(cmd, injectedTxContext); } @Compensable public void bar(BarCommand cmd, TransactionContext injectedTxContext) { ... // TransactionContext localTxContext = omegaContext.getTransactionContext(); }
需要注意的是bar
方法接收到的是注入的事务上下文,在进入bar
之后从OmegaContext得到的是本地事务上下文(Omega替你开启了新的事务)。如果Service B也需要显式地传递事务上下文,那么应该使用本地事务上下文。
Service A:
public class BarCommand {} public class BarCommandWithTxContext extends BarCommand implements TransactionContextProperties { // setter getter for globalTxId // setter getter for localTxId } @SagaStart public void foo(BarCommand cmd) { BarCommandWithTxContext cmdWithTxContext = new BarCommandWithTxContext(cmd); cmdWithTxContext.setGlobalTxId(omegaContext.globalTxId()); cmdWithTxContext.setLocalTxId(omegaContext.localTxId()); someRpc.send(cmdWithTxContext); }
Service B:
public void listen(BarCommandWithTxContext cmdWithTxContext) { bar(cmdWithTxContext); } @Compensable public void bar(BarCommandWithTxContext cmdWithTxContext) { ... // TransactionContext localTxContext = omegaContext.getTransactionContext(); }
和前面一种方式类似,TransactionContextProperties.get{Global,Local}TxId()返回的也是注入的事务上下文信息。
在对应的方法中添加TccStart 和 Participate标注 以一个转账应用为例:
在全局事务的起点添加 @TccStart
的注解。
import org.apache.servicecomb.pack.omega.context.annotations.TccStart; @TccStart public boolean transferMoney(String from, String to, int amount) { transferOut(from, amount); transferIn(to, amount); }
Note: 当前TCC还不支持Timeout
在子事务尝试方法处添加 @Participate
的注解并指明其对应的执行以及补偿方法名,
import javax.transaction.Transactional; import org.apache.servicecomb.pack.omega.transaction.annotations.Participate; @Participate(confirmMethod = "confirm", cancelMethod = "cancel") @Transactional public void transferOut(String from, int amount) { // check banalance } @Transactional public void confirm(String from, int amount) { repo.reduceBalanceByUsername(from, amount); } @Transactional public void cancel(String from, int amount) { repo.addBalanceByUsername(from, amount); }
注意:confirm
和cancel
方法的参数列表应该与@Participate
方法一样,并且它们必须是幂等。我们强烈建议使用Spring的@Transactional
来保证本地事务的一致性。
注意: 若全局事务起点与子事务起点重合,需同时声明 @TccStart
和 @Participate
的注解。
增加 alpha.cluster.address 参数
alpha: cluster: address: alpha-server.servicecomb.io:8080
对转入服务重复第二步即可。
从pack-0.3.0开始, 你可以在服务函数或者取消函数中通过访问 OmegaContext 来获取 gloableTxId 以及 localTxId 信息。
与Saga的@Compensable
一样,TCC的@Participate
也支持显式传递事务上下文,详情可参阅Saga章节。
运行postgreSQL,
docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
如果你想使用MySQL做为后台数据库,可以参考 此文档。
运行alpha。在运行alpha前,请确保postgreSQL已正常启动。可通过docker或可执行文件的方式来启动alpha。
通过docker运行:
docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
通过可执行文件运行:
java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar 1、postgresql java -D"spring.profiles.active=prd" -D"spring.datasource.url=jdbc:postgresql://localhost:5432/saga?useSSL=false" -D"spring.datasource.username=root" -D"spring.datasource.password=root" -jar alpha-server-0.5.0-exec.jar 2、mysql支持 2.1 创建插件目录 2.2 java -D"spring.profiles.active=mysql" -D"loader.path=./plugins" -D"spring.datasource.url=jdbc:mysql://localhost:3306/saga?useSSL=false&serverTimezone=Asia/Shanghai" -D"spring.datasource.username=root" -D"spring.datasource.password=root" -D"spring.cloud.consul.host=http://127.0.0.1" -D"spring.cloud.consul.port=8500" -D"spring.cloud.consul.enabled=true" -D"alpha.server.port=8011" -D"server.port=8092" -jar alpha-server-0.5.0-exec.jar // 集群支持 -D"alpha.cluster.master.enabled=true"
注意: 请在执行命令前将${saga_version}
和${host_address}
更改为实际值。
注意: 默认情况下,8080端口用于处理omega处发起的gRPC的请求,而8090端口用于处理查询存储在alpha处的事件信息。
配置omega。在 application.yaml
添加下面的配置项:
spring: application: name: {application.name} alpha: cluster: address: {alpha.cluster.addresses}
然后就可以运行相关的微服务了,可通过访问http://${alpha-server:port}/saga/events 来获取所有的saga事件信息。
详情请参考启用 SSL文档.
支持Alpha启动时注册到发现服务,Omega通过发现服务获取Alpha的实例列表和gRPC地址
运行alpha
运行时增加 spring.cloud.consul.enabled=true
参数
java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false --spring.datasource.username=saga --spring.datasource.password=saga --spring.cloud.consul.enabled=true --spring.cloud.consul.host=${consul_host} --spring.cloud.consul.port=${consul_port} --spring.profiles.active=prd java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://localhost:5432/saga?useSSL=false --spring.datasource.username=root --spring.datasource.password=root --spring.cloud.consul.enabled=true --spring.cloud.consul.host=${consul_host} --spring.cloud.consul.port=${consul_port} --spring.profiles.active=prd
注意:${consul_host}
是 consul 地址, ${consul_port}
是 consul 端口
注意: 更多 Consul 参数请参考 Spring Cloud Consul 2.xSpring Cloud Consul 1.x
验证是否注册成功
访问 Consul 的注册实例查询接口curl http://127.0.0.1:8500/v1/agent/services
可以看到如下注册信息,在你 Tags 中可以看到 Alpha 的 gRPC 访问地址已经注册
{ "servicecomb-alpha-server-0-0-0-0-8090": { "ID": "servicecomb-alpha-server-0-0-0-0-8090", "Service": "servicecomb-alpha-server", "Tags": [ "alpha-server-host=0.0.0.0", "alpha-server-port=8080", "secure=false" ], "Meta": {}, "Port": 8090, "Address": "10.50.7.14", "Weights": { "Passing": 1, "Warning": 1 }, "EnableTagOverride": false } }
注意: 默认情况下注册的服务名是servicecomb-alpha-server
,如果你需要自定义服务名可以在运行Alpha的时候通过命令行参数spring.application.name
配置
配置omega
在项目中引入依赖包 omega-spring-cloud-consul-starter
<dependency> <groupId>org.apache.servicecomb.pack</groupId> <artifactId>omega-spring-cloud-consul-starter</artifactId> <version>${pack.version}</version> </dependency>
在 application.yaml
添加下面的配置项:
spring: cloud: consul: discovery: register: false host: 127.0.0.1 port: 8500 alpha: cluster: register: type: consul
spring.cloud.consul.host
配置 Consul 注册中心的地址,spring.cloud.consul.port
配置 Consul 注册中心的端口,spring.cloud.consul.discovery.register=false
表示不注册自己到注册中心,更多 Consul 客户端配置可以参考Spring Cloud Consul 2.xSpring Cloud Consul 1.x
alpha.cluster.register.type=consul
配置Omega获取Alpha的方式是通过 Consul 的注册中心
spring boot 版本兼容
如果你的项目使用的不是spring boot 2.1.1版本,那么请参照此列表增加兼容的spring-cloud-starter-consul-discovery版本
spring boot | spring-cloud-starter-consul-discovery |
---|---|
2.1.x.RELEASE | 2.1.1.RELEASE |
2.0.x.RELEASE | 2.0.2.RELEASE |
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-consul-discovery</artifactId> <version>2.0.2.RELEASE</version> </dependency> </dependencies> </dependencyManagement>
注意: 如果你在启动Alpha的时候通过命令行参数spring.application.name
自定义了服务名,那么你需要在Omega中通过参数alpha.cluster.serviceId
指定这个服务名
编译 eureka 的版本
使用 -Pspring-cloud-eureka
参数编译支持 eureka 的版本
git clone https://github.com/apache/servicecomb-pack.git cd servicecomb-pack mvn clean install -DskipTests=true -Pspring-cloud-eureka
运行alpha
运行时增加 eureka.client.enabled=true
参数
java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false --spring.datasource.username=saga --spring.datasource.password=saga --eureka.client.enabled=true --eureka.client.service-url.defaultZone=http://127.0.0.1:8761/eureka \ --spring.profiles.active=prd
注意: 更多 eureka 参数请参考 Spring Cloud Netflix 2.xSpring Cloud Netflix 1.x
验证是否注册成功
访问Eureka的注册实例查询接口curl http://127.0.0.1:8761/eureka/apps/
可以看到如下注册信息,在你metadata中可以看到Alpha的gRPC访问地址<servicecomb-alpha-server>0.0.0.0:8080</servicecomb-alpha-server>
已经注册
<applications> <versions__delta>1</versions__delta> <apps__hashcode>UP_1_</apps__hashcode> <application> <name>SERVICECOMB-ALPHA-SERVER</name> <instance> <instanceId>0.0.0.0::servicecomb-alpha-server:8090</instanceId> <hostName>0.0.0.0</hostName> <app>SERVICECOMB-ALPHA-SERVER</app> <ipAddr>0.0.0.0</ipAddr> <status>UP</status> ... <metadata> <management.port>8090</management.port> <servicecomb-alpha-server>0.0.0.0:8080</servicecomb-alpha-server> </metadata> ... </instance> </application> </applications>
注意: 默认情况下注册的服务名是SERVICECOMB-ALPHA-SERVER
,如果你需要自定义服务名可以在运行Alpha的时候通过命令行参数spring.application.name
配置
配置omega
在项目中引入依赖包 omega-spring-cloud-eureka-starter
<dependency> <groupId>org.apache.servicecomb.pack</groupId> <artifactId>omega-spring-cloud-eureka-starter</artifactId> <version>${pack.version}</version> </dependency>
在 application.yaml
添加下面的配置项:
eureka: client: service-url: defaultZone: http://127.0.0.1:8761/eureka alpha: cluster: register: type: eureka
eureka.client.service-url.defaultZone
配置Eureka注册中心的地址,更多Eureka客户端配置可以参考Spring Cloud Netflix 2.x 或 Spring Cloud Netflix 1.x
alpha.cluster.register.type=eureka
配置Omega获取Alpha的方式是通过Eureka的注册中心
spring boot 版本兼容
如果你的项目使用的不是spring boot 2.1.1版本,那么请参照此列表增加兼容的spring-cloud-starter-consul-discovery版本
spring boot | spring-cloud-starter-netflix-eureka-client |
---|---|
2.1.x.RELEASE | 2.1.1.RELEASE |
2.0.x.RELEASE | 2.0.3.RELEASE |
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> <version>2.0.3.RELEASE</version> </dependency> </dependencies> </dependencyManagement>
注意: 如果你在启动Alpha的时候通过命令行参数spring.application.name
自定义了服务名,那么你需要在Omega中通过参数alpha.cluster.serviceId
指定这个服务名
运行alpha
运行时增加 spring.cloud.zookeeper.enabled=true
参数
java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false --spring.datasource.username=saga --spring.datasource.password=saga --spring.cloud.zookeeper.enabled=true --spring.cloud.zookeeper.connectString=${zookeeper_host}:${zookeeper_port} --spring.profiles.active=prd
注意:${zookeeper_host}
是 zookeeper 地址, ${zookeeper_port}
是 zookeeper 端口
注意: 更多 Zookeeper 参数请参考 Spring Cloud Zookeeper 2.xSpring Cloud Zookeeper 1.x
验证是否注册成功
访问Zookeeper的实例, 在znode /services/servicecomb-alapha-server 下,查看服务注册znode, 在注册的znode中,存在类似以下值
{ "name": "servicecomb-alpha-server", "id": "9b2223ae-50e6-49a6-9f3b-87a1ff06a016", "address": "arch-office", "port": 8090, "sslPort": null, "payload": { "@class": "org.springframework.cloud.zookeeper.discovery.ZookeeperInstance", "id": "servicecomb-alpha-server-1", "name": "servicecomb-alpha-server", "metadata": { "servicecomb-alpha-server": "arch-office:8080" } }, "registrationTimeUTC": 1558000134185, "serviceType": "DYNAMIC", "uriSpec": { "parts": [ { "value": "scheme", "variable": true }, { "value": "://", "variable": false }, { "value": "address", "variable": true }, { "value": ":", "variable": false }, { "value": "port", "variable": true } ] } }
注意: 默认情况下注册的服务名是servicecomb-alpha-server
,如果你需要自定义服务名可以在运行Alpha的时候通过命令行参数spring.application.name
配置
配置omega
在项目中引入依赖包 omega-spring-cloud-zookeeper-starter
<dependency> <groupId>org.apache.servicecomb.pack</groupId> <artifactId>omega-spring-cloud-zookeeper-starter</artifactId> <version>${pack.version}</version> </dependency>
在 application.yaml
添加下面的配置项:
spring: cloud: zookeeper: enabled: true connectString: 127.0.0.1:2181 alpha: cluster: register: type: zookeeper
spring.cloud.zookeeper.connectString
配置 Zookeeper 注册中心的地址,更多zookeeper客户端配置可以参考Spring Cloud Zookeeper 2.xSpring Cloud Zookeeper 1.x
alpha.cluster.register.type=zookeeper
配置Omega获取Alpha的方式是通过 Zookeeper 的注册中心
spring boot 版本兼容
如果你的项目使用的不是spring boot 2.1.1版本,那么请参照此列表增加兼容的spring-cloud-starter-zookeeper-discovery版本
spring boot | spring-cloud-starter-zookeeper-discovery |
---|---|
2.1.x.RELEASE | 2.1.1.RELEASE |
1.5.17.RELEASE | 1.2.2.RELEASE |
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-zookeeper-discovery</artifactId> <version>2.1.1.RELEASE</version> </dependency> </dependencies> </dependencyManagement>
注意: 如果你在启动Alpha的时候通过命令行参数spring.application.name
自定义了服务名,那么你需要在Omega中通过参数alpha.cluster.serviceId
指定这个服务名
运行alpha
运行时增加 nacos.client.enabled=true
参数
java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false --spring.datasource.username=saga --spring.datasource.password=saga --spring.cloud.nacos.discovery.enabled=true --spring.cloud.nacos.discovery.serverAddr=${nacos_host}:${nacos_port} --nacos.client.enabled=true --spring.profiles.active=prd
注意:${nacos_host}
是 nacos 地址, ${nacos_port}
是 nacos 端口
注意: 更多 Nacos 参数请参考 Spring Cloud Nacos Discovery
验证是否注册成功
访问Nacos的实例, 通过nacos 提供的openapicurl -X GET ‘http://127.0.0.1:8848/nacos/v1/ns/instance/list?serviceName=servicecomb-alpha-server‘
可以看到如下服务注册信息,在metadata 中可以发现gRPC的地址已经被注册
{ "metadata": {}, "dom": "servicecomb-alpha-server", "cacheMillis": 3000, "useSpecifiedURL": false, "hosts": [ { "valid": true, "marked": false, "metadata": { "preserved.register.source": "SPRING_CLOUD", "servicecomb-alpha-server": "192.168.2.28:8080" }, "instanceId": "192.168.2.28#8090#DEFAULT#DEFAULT_GROUP@@servicecomb-alpha-server", "port": 8090, "healthy": true, "ip": "192.168.2.28", "clusterName": "DEFAULT", "weight": 1, "ephemeral": true, "serviceName": "servicecomb-alpha-server", "enabled": true } ], "name": "DEFAULT_GROUP@@servicecomb-alpha-server", "checksum": "d9e8deefd1c4f198980f4443d7c1b1fd", "lastRefTime": 1562567653565, "env": "", "clusters": "" }
注意: 默认情况下注册的服务名是servicecomb-alpha-server
,如果你需要自定义服务名可以在运行Alpha的时候通过命令行参数spring.application.name
配置
配置omega
在项目中引入依赖包 omega-spring-cloud-nacos-starter
<dependency> <groupId>org.apache.servicecomb.pack</groupId> <artifactId>omega-spring-cloud-nacos-starter</artifactId> <version>${pack.version}</version> </dependency>
在 application.yaml
添加下面的配置项:
spring: cloud: nacos: discovery: enabled: true serverAddr: 127.0.0.1:8848 alpha: cluster: register: type: nacos
spring.cloud.nacos.discovery.serverAddr
配置 Nacos 注册中心的地址,更多Nacos 参数请参考 Spring Cloud Nacos Discovery
alpha.cluster.register.type=nacos
配置Omega获取Alpha的方式是通过 Nacos 的注册中心
spring boot 版本兼容
如果你的项目使用的不是spring boot 2.1.1版本,那么请参照此列表增加兼容的spring-cloud-starter-alibaba-nacos-discovery版本
spring boot | spring-cloud-starter-alibaba-nacos-discovery |
---|---|
2.1.x.RELEASE | 0.2.2.RELEASE |
1.5.17.RELEASE | 0.1.2.RELEASE |
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> <version>0.2.2.RELEASE</version> </dependency> </dependencies> </dependencyManagement>
注意: 如果你在启动Alpha的时候通过命令行参数spring.application.name
自定义了服务名,那么你需要在Omega中通过参数alpha.cluster.serviceId
指定这个服务名
Alpha 可以通过部署多实例的方式保证高可用,使用 alpha.cluster.master.enabled=true
参数开启集群支持
获取源码:
$ git clone https://github.com/apache/servicecomb-pack.git
$ cd servicecomb-pack
Saga可通过以下任一方式进行构建:
只构建可执行文件:
$ mvn clean install -DskipTests
同时构建可执行文件和docker镜像:
$ mvn clean install -DskipTests -Pdocker
同时构建可执行文件以及Saga发行包
$ mvn clean install -DskipTests -Prelease
在执行以上任一指令后,可在alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar
中找到alpha server的可执行文件。
<dependency>
<groupId>org.apache.servicecomb.pack</groupId>
<artifactId>omega-spring-starter</artifactId>
<version>${pack.version}</version>
</dependency>
<dependency>
<groupId>org.apache.servicecomb.pack</groupId>
<artifactId>omega-transport-resttemplate</artifactId>
<version>${pack.version}</version>
</dependency>
注意: 请将${pack.version}
更改为实际的版本号。版本迁移提示: 从0.3.0 开始,整个项目的代码库名由servicecomb-saga改名为servicecomb-pack, 与此同时我们也更新了对应发布包的组名以及相关包名。如果你的项目是从saga 0.2.x 迁移过来,请按照下表所示进行修改。
name | 0.2.x | 0.3.x |
---|---|---|
groupId | org.apache.servicecomb.saga | org.apache.servicecomb.pack |
Package Name | org.apache.servicecomb.saga | org.apache.servicecomb.pack |
添加Saga的注解及相应的补偿方法以一个转账应用为例:
在全局事务的起点添加 @SagaStart
的注解。
import org.apache.servicecomb.pack.omega.context.annotations.SagaStart;
?
timeout=10) (
public boolean transferMoney(String from, String to, int amount) {
transferOut(from, amount);
transferIn(to, amount);
}
注意: 默认情况下,超时设置需要显式声明才生效。
在子事务处添加 @Compensable
的注解并指明其对应的补偿方法。
import javax.transaction.Transactional;
import org.apache.servicecomb.pack.omega.transaction.annotations.Compensable;
?
timeout=5, compensationMethod="cancel") (
public boolean transferOut(String from, int amount) {
repo.reduceBalanceByUsername(from, amount);
}
public boolean cancel(String from, int amount) {
repo.addBalanceByUsername(from, amount);
}
注意: 实现的服务使用相当的参数,实现的服务和补偿必须满足幂等的条件,同时建议使用Spring @Transactional标注提供本地事务保证。
注意: 默认情况下,超时设置需要显式声明才生效。
注意: 若全局事务起点与子事务起点重合,需同时声明 @SagaStart
和 @Compensable
的注解。
增加 alpha.cluster.address 参数
alpha
cluster
address alpha-server.servicecomb.io8080
对转入服务重复第二步即可。
从pack-0.3.0开始, 你可以在服务函数或者取消函数中通过访问 OmegaContext 来获取 gloableTxId 以及 localTxId 信息。
在一般情况下,Omega能够替你处理事务上下文的传递工作(详情见服务间通信流程),因此你的代码并不需要知道事务上下文的存在。而事务上下文的传递实际上是通过在请求方注入、在接受方提取来完成的,下面举一个请例子来说明这个过程:
Service A:
@SagaStart public void foo() { restTemplate.postForEntity("http://service-b/bar", ...); }
Service B:
@GetMapping("/bar") @Compensable public void bar() { ... }
我们可以先来看看Omega是怎么传递事务上下文的:
Service A的foo方法会开启一个新的全局事务。
TransactionClientHttpRequestInterceptor会在RestTemplate请求Service B时在Http请求头中注入事务上下文信息。
当Servce B接收到请求时,TransactionHandlerInterceptor会从请求头中提取事务上下文信息。
目前Omega支持以下形式的隐式事务上下文传递:
omega-transport-{dubbo,feign,resttemplate,servicecomb}。
同线程内调用(基于OmegaContext的ThreadLocal字段)。
标注了@OmegaContextAware的java.util.concurrent.Executor{Service}。
那么问题来了,如果无法隐式传递事务上下文怎么办?比如Service A使用某种RPC机制件来调用Service B,而你又没有办法注入或提取事务上下文信息。这个时候你只能采用显式的方式把事务上下文传递出去。ServiceComb Pack从0.5.0开始提供了两个类来实现这一点。
Service A:
@SagaStart public void foo(BarCommand cmd) { TransactionContext localTxContext = omegaContext.getTransactionContext(); someRpc.send(cmd, localTxContext); }
Service B:
public void listen(BarCommand cmd, TransactionContext injectedTxContext) { bar(cmd, injectedTxContext); } @Compensable public void bar(BarCommand cmd, TransactionContext injectedTxContext) { ... // TransactionContext localTxContext = omegaContext.getTransactionContext(); }
需要注意的是bar
方法接收到的是注入的事务上下文,在进入bar
之后从OmegaContext得到的是本地事务上下文(Omega替你开启了新的事务)。如果Service B也需要显式地传递事务上下文,那么应该使用本地事务上下文。
Service A:
public class BarCommand {} public class BarCommandWithTxContext extends BarCommand implements TransactionContextProperties { // setter getter for globalTxId // setter getter for localTxId } @SagaStart public void foo(BarCommand cmd) { BarCommandWithTxContext cmdWithTxContext = new BarCommandWithTxContext(cmd); cmdWithTxContext.setGlobalTxId(omegaContext.globalTxId()); cmdWithTxContext.setLocalTxId(omegaContext.localTxId()); someRpc.send(cmdWithTxContext); }
Service B:
public void listen(BarCommandWithTxContext cmdWithTxContext) { bar(cmdWithTxContext); } @Compensable public void bar(BarCommandWithTxContext cmdWithTxContext) { ... // TransactionContext localTxContext = omegaContext.getTransactionContext(); }
和前面一种方式类似,TransactionContextProperties.get{Global,Local}TxId()返回的也是注入的事务上下文信息。
在对应的方法中添加TccStart 和 Participate标注 以一个转账应用为例:
在全局事务的起点添加 @TccStart
的注解。
import org.apache.servicecomb.pack.omega.context.annotations.TccStart; @TccStart public boolean transferMoney(String from, String to, int amount) { transferOut(from, amount); transferIn(to, amount); }
Note: 当前TCC还不支持Timeout
在子事务尝试方法处添加 @Participate
的注解并指明其对应的执行以及补偿方法名,
import javax.transaction.Transactional; import org.apache.servicecomb.pack.omega.transaction.annotations.Participate; @Participate(confirmMethod = "confirm", cancelMethod = "cancel") @Transactional public void transferOut(String from, int amount) { // check banalance } @Transactional public void confirm(String from, int amount) { repo.reduceBalanceByUsername(from, amount); } @Transactional public void cancel(String from, int amount) { repo.addBalanceByUsername(from, amount); }
注意:confirm
和cancel
方法的参数列表应该与@Participate
方法一样,并且它们必须是幂等。我们强烈建议使用Spring的@Transactional
来保证本地事务的一致性。
注意: 若全局事务起点与子事务起点重合,需同时声明 @TccStart
和 @Participate
的注解。
增加 alpha.cluster.address 参数
alpha: cluster: address: alpha-server.servicecomb.io:8080
对转入服务重复第二步即可。
从pack-0.3.0开始, 你可以在服务函数或者取消函数中通过访问 OmegaContext 来获取 gloableTxId 以及 localTxId 信息。
与Saga的@Compensable
一样,TCC的@Participate
也支持显式传递事务上下文,详情可参阅Saga章节。
运行postgreSQL,
docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
如果你想使用MySQL做为后台数据库,可以参考 此文档。
运行alpha。在运行alpha前,请确保postgreSQL已正常启动。可通过docker或可执行文件的方式来启动alpha。
通过docker运行:
docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
通过可执行文件运行:
java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar 1、postgresql java -D"spring.profiles.active=prd" -D"spring.datasource.url=jdbc:postgresql://localhost:5432/saga?useSSL=false" -D"spring.datasource.username=root" -D"spring.datasource.password=root" -jar alpha-server-0.5.0-exec.jar 2、mysql支持 2.1 创建插件目录 2.2 java -D"spring.profiles.active=mysql" -D"loader.path=./plugins" -D"spring.datasource.url=jdbc:mysql://localhost:3306/saga?useSSL=false&serverTimezone=Asia/Shanghai" -D"spring.datasource.username=root" -D"spring.datasource.password=root" -D"spring.cloud.consul.host=http://127.0.0.1" -D"spring.cloud.consul.port=8500" -D"spring.cloud.consul.enabled=true" -D"alpha.server.port=8011" -D"server.port=8092" -jar alpha-server-0.5.0-exec.jar // 集群支持 -D"alpha.cluster.master.enabled=true"
注意: 请在执行命令前将${saga_version}
和${host_address}
更改为实际值。
注意: 默认情况下,8080端口用于处理omega处发起的gRPC的请求,而8090端口用于处理查询存储在alpha处的事件信息。
配置omega。在 application.yaml
添加下面的配置项:
spring: application: name: {application.name} alpha: cluster: address: {alpha.cluster.addresses}
然后就可以运行相关的微服务了,可通过访问http://${alpha-server:port}/saga/events 来获取所有的saga事件信息。
详情请参考启用 SSL文档.
支持Alpha启动时注册到发现服务,Omega通过发现服务获取Alpha的实例列表和gRPC地址
运行alpha
运行时增加 spring.cloud.consul.enabled=true
参数
java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false --spring.datasource.username=saga --spring.datasource.password=saga --spring.cloud.consul.enabled=true --spring.cloud.consul.host=${consul_host} --spring.cloud.consul.port=${consul_port} --spring.profiles.active=prd java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://localhost:5432/saga?useSSL=false --spring.datasource.username=root --spring.datasource.password=root --spring.cloud.consul.enabled=true --spring.cloud.consul.host=${consul_host} --spring.cloud.consul.port=${consul_port} --spring.profiles.active=prd
注意:${consul_host}
是 consul 地址, ${consul_port}
是 consul 端口
注意: 更多 Consul 参数请参考 Spring Cloud Consul 2.xSpring Cloud Consul 1.x
验证是否注册成功
访问 Consul 的注册实例查询接口curl http://127.0.0.1:8500/v1/agent/services
可以看到如下注册信息,在你 Tags 中可以看到 Alpha 的 gRPC 访问地址已经注册
{ "servicecomb-alpha-server-0-0-0-0-8090": { "ID": "servicecomb-alpha-server-0-0-0-0-8090", "Service": "servicecomb-alpha-server", "Tags": [ "alpha-server-host=0.0.0.0", "alpha-server-port=8080", "secure=false" ], "Meta": {}, "Port": 8090, "Address": "10.50.7.14", "Weights": { "Passing": 1, "Warning": 1 }, "EnableTagOverride": false } }
注意: 默认情况下注册的服务名是servicecomb-alpha-server
,如果你需要自定义服务名可以在运行Alpha的时候通过命令行参数spring.application.name
配置
配置omega
在项目中引入依赖包 omega-spring-cloud-consul-starter
<dependency> <groupId>org.apache.servicecomb.pack</groupId> <artifactId>omega-spring-cloud-consul-starter</artifactId> <version>${pack.version}</version> </dependency>
在 application.yaml
添加下面的配置项:
spring: cloud: consul: discovery: register: false host: 127.0.0.1 port: 8500 alpha: cluster: register: type: consul
spring.cloud.consul.host
配置 Consul 注册中心的地址,spring.cloud.consul.port
配置 Consul 注册中心的端口,spring.cloud.consul.discovery.register=false
表示不注册自己到注册中心,更多 Consul 客户端配置可以参考Spring Cloud Consul 2.xSpring Cloud Consul 1.x
alpha.cluster.register.type=consul
配置Omega获取Alpha的方式是通过 Consul 的注册中心
spring boot 版本兼容
如果你的项目使用的不是spring boot 2.1.1版本,那么请参照此列表增加兼容的spring-cloud-starter-consul-discovery版本
spring boot | spring-cloud-starter-consul-discovery |
---|---|
2.1.x.RELEASE | 2.1.1.RELEASE |
2.0.x.RELEASE | 2.0.2.RELEASE |
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-consul-discovery</artifactId> <version>2.0.2.RELEASE</version> </dependency> </dependencies> </dependencyManagement>
注意: 如果你在启动Alpha的时候通过命令行参数spring.application.name
自定义了服务名,那么你需要在Omega中通过参数alpha.cluster.serviceId
指定这个服务名
编译 eureka 的版本
使用 -Pspring-cloud-eureka
参数编译支持 eureka 的版本
git clone https://github.com/apache/servicecomb-pack.git cd servicecomb-pack mvn clean install -DskipTests=true -Pspring-cloud-eureka
运行alpha
运行时增加 eureka.client.enabled=true
参数
java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false --spring.datasource.username=saga --spring.datasource.password=saga --eureka.client.enabled=true --eureka.client.service-url.defaultZone=http://127.0.0.1:8761/eureka \ --spring.profiles.active=prd
注意: 更多 eureka 参数请参考 Spring Cloud Netflix 2.xSpring Cloud Netflix 1.x
验证是否注册成功
访问Eureka的注册实例查询接口curl http://127.0.0.1:8761/eureka/apps/
可以看到如下注册信息,在你metadata中可以看到Alpha的gRPC访问地址<servicecomb-alpha-server>0.0.0.0:8080</servicecomb-alpha-server>
已经注册
<applications> <versions__delta>1</versions__delta> <apps__hashcode>UP_1_</apps__hashcode> <application> <name>SERVICECOMB-ALPHA-SERVER</name> <instance> <instanceId>0.0.0.0::servicecomb-alpha-server:8090</instanceId> <hostName>0.0.0.0</hostName> <app>SERVICECOMB-ALPHA-SERVER</app> <ipAddr>0.0.0.0</ipAddr> <status>UP</status> ... <metadata> <management.port>8090</management.port> <servicecomb-alpha-server>0.0.0.0:8080</servicecomb-alpha-server> </metadata> ... </instance> </application> </applications>
注意: 默认情况下注册的服务名是SERVICECOMB-ALPHA-SERVER
,如果你需要自定义服务名可以在运行Alpha的时候通过命令行参数spring.application.name
配置
配置omega
在项目中引入依赖包 omega-spring-cloud-eureka-starter
<dependency> <groupId>org.apache.servicecomb.pack</groupId> <artifactId>omega-spring-cloud-eureka-starter</artifactId> <version>${pack.version}</version> </dependency>
在 application.yaml
添加下面的配置项:
eureka: client: service-url: defaultZone: http://127.0.0.1:8761/eureka alpha: cluster: register: type: eureka
eureka.client.service-url.defaultZone
配置Eureka注册中心的地址,更多Eureka客户端配置可以参考Spring Cloud Netflix 2.x 或 Spring Cloud Netflix 1.x
alpha.cluster.register.type=eureka
配置Omega获取Alpha的方式是通过Eureka的注册中心
spring boot 版本兼容
如果你的项目使用的不是spring boot 2.1.1版本,那么请参照此列表增加兼容的spring-cloud-starter-consul-discovery版本
spring boot | spring-cloud-starter-netflix-eureka-client |
---|---|
2.1.x.RELEASE | 2.1.1.RELEASE |
2.0.x.RELEASE | 2.0.3.RELEASE |
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> <version>2.0.3.RELEASE</version> </dependency> </dependencies> </dependencyManagement>
注意: 如果你在启动Alpha的时候通过命令行参数spring.application.name
自定义了服务名,那么你需要在Omega中通过参数alpha.cluster.serviceId
指定这个服务名
运行alpha
运行时增加 spring.cloud.zookeeper.enabled=true
参数
java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false --spring.datasource.username=saga --spring.datasource.password=saga --spring.cloud.zookeeper.enabled=true --spring.cloud.zookeeper.connectString=${zookeeper_host}:${zookeeper_port} --spring.profiles.active=prd
注意:${zookeeper_host}
是 zookeeper 地址, ${zookeeper_port}
是 zookeeper 端口
注意: 更多 Zookeeper 参数请参考 Spring Cloud Zookeeper 2.xSpring Cloud Zookeeper 1.x
验证是否注册成功
访问Zookeeper的实例, 在znode /services/servicecomb-alapha-server 下,查看服务注册znode, 在注册的znode中,存在类似以下值
{ "name": "servicecomb-alpha-server", "id": "9b2223ae-50e6-49a6-9f3b-87a1ff06a016", "address": "arch-office", "port": 8090, "sslPort": null, "payload": { "@class": "org.springframework.cloud.zookeeper.discovery.ZookeeperInstance", "id": "servicecomb-alpha-server-1", "name": "servicecomb-alpha-server", "metadata": { "servicecomb-alpha-server": "arch-office:8080" } }, "registrationTimeUTC": 1558000134185, "serviceType": "DYNAMIC", "uriSpec": { "parts": [ { "value": "scheme", "variable": true }, { "value": "://", "variable": false }, { "value": "address", "variable": true }, { "value": ":", "variable": false }, { "value": "port", "variable": true } ] } }
注意: 默认情况下注册的服务名是servicecomb-alpha-server
,如果你需要自定义服务名可以在运行Alpha的时候通过命令行参数spring.application.name
配置
配置omega
在项目中引入依赖包 omega-spring-cloud-zookeeper-starter
<dependency> <groupId>org.apache.servicecomb.pack</groupId> <artifactId>omega-spring-cloud-zookeeper-starter</artifactId> <version>${pack.version}</version> </dependency>
在 application.yaml
添加下面的配置项:
spring: cloud: zookeeper: enabled: true connectString: 127.0.0.1:2181 alpha: cluster: register: type: zookeeper
spring.cloud.zookeeper.connectString
配置 Zookeeper 注册中心的地址,更多zookeeper客户端配置可以参考Spring Cloud Zookeeper 2.xSpring Cloud Zookeeper 1.x
alpha.cluster.register.type=zookeeper
配置Omega获取Alpha的方式是通过 Zookeeper 的注册中心
spring boot 版本兼容
如果你的项目使用的不是spring boot 2.1.1版本,那么请参照此列表增加兼容的spring-cloud-starter-zookeeper-discovery版本
spring boot | spring-cloud-starter-zookeeper-discovery |
---|---|
2.1.x.RELEASE | 2.1.1.RELEASE |
1.5.17.RELEASE | 1.2.2.RELEASE |
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-zookeeper-discovery</artifactId> <version>2.1.1.RELEASE</version> </dependency> </dependencies> </dependencyManagement>
注意: 如果你在启动Alpha的时候通过命令行参数spring.application.name
自定义了服务名,那么你需要在Omega中通过参数alpha.cluster.serviceId
指定这个服务名
运行alpha
运行时增加 nacos.client.enabled=true
参数
java -jar alpha-server-${saga_version}-exec.jar \ --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false --spring.datasource.username=saga --spring.datasource.password=saga --spring.cloud.nacos.discovery.enabled=true --spring.cloud.nacos.discovery.serverAddr=${nacos_host}:${nacos_port} --nacos.client.enabled=true --spring.profiles.active=prd
注意:${nacos_host}
是 nacos 地址, ${nacos_port}
是 nacos 端口
注意: 更多 Nacos 参数请参考 Spring Cloud Nacos Discovery
验证是否注册成功
访问Nacos的实例, 通过nacos 提供的openapicurl -X GET ‘http://127.0.0.1:8848/nacos/v1/ns/instance/list?serviceName=servicecomb-alpha-server‘
可以看到如下服务注册信息,在metadata 中可以发现gRPC的地址已经被注册
{ "metadata": {}, "dom": "servicecomb-alpha-server", "cacheMillis": 3000, "useSpecifiedURL": false, "hosts": [ { "valid": true, "marked": false, "metadata": { "preserved.register.source": "SPRING_CLOUD", "servicecomb-alpha-server": "192.168.2.28:8080" }, "instanceId": "192.168.2.28#8090#DEFAULT#DEFAULT_GROUP@@servicecomb-alpha-server", "port": 8090, "healthy": true, "ip": "192.168.2.28", "clusterName": "DEFAULT", "weight": 1, "ephemeral": true, "serviceName": "servicecomb-alpha-server", "enabled": true } ], "name": "DEFAULT_GROUP@@servicecomb-alpha-server", "checksum": "d9e8deefd1c4f198980f4443d7c1b1fd", "lastRefTime": 1562567653565, "env": "", "clusters": "" }
注意: 默认情况下注册的服务名是servicecomb-alpha-server
,如果你需要自定义服务名可以在运行Alpha的时候通过命令行参数spring.application.name
配置
配置omega
在项目中引入依赖包 omega-spring-cloud-nacos-starter
<dependency> <groupId>org.apache.servicecomb.pack</groupId> <artifactId>omega-spring-cloud-nacos-starter</artifactId> <version>${pack.version}</version> </dependency>
在 application.yaml
添加下面的配置项:
spring: cloud: nacos: discovery: enabled: true serverAddr: 127.0.0.1:8848 alpha: cluster: register: type: nacos
spring.cloud.nacos.discovery.serverAddr
配置 Nacos 注册中心的地址,更多Nacos 参数请参考 Spring Cloud Nacos Discovery
alpha.cluster.register.type=nacos
配置Omega获取Alpha的方式是通过 Nacos 的注册中心
spring boot 版本兼容
如果你的项目使用的不是spring boot 2.1.1版本,那么请参照此列表增加兼容的spring-cloud-starter-alibaba-nacos-discovery版本
spring boot | spring-cloud-starter-alibaba-nacos-discovery |
---|---|
2.1.x.RELEASE | 0.2.2.RELEASE |
1.5.17.RELEASE | 0.1.2.RELEASE |
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> <version>0.2.2.RELEASE</version> </dependency> </dependencies> </dependencyManagement>
注意: 如果你在启动Alpha的时候通过命令行参数spring.application.name
自定义了服务名,那么你需要在Omega中通过参数alpha.cluster.serviceId
指定这个服务名
Alpha 可以通过部署多实例的方式保证高可用,使用 alpha.cluster.master.enabled=true
参数开启集群支持
标签:迁移 instance image pps rop oid 进入 exp mapping
原文地址:https://www.cnblogs.com/qingyunye/p/12941546.html