2LCN模式 · SpringCloud微服务实战

导航

本节代码地址

GitHub:https://github.com/xuyisu/fw-spring-cloud/tree/master/fw-cloud-transaction/fw-cloud-transaction-lcn/fw-cloud-transaction-lcn-lcn
GitHub:https://github.com/xuyisu/fw-spring-cloud/tree/master/fw-cloud-transaction/fw-cloud-transaction-lcn/fw-cloud-transaction-lcn-txmanager

1. 原理介绍:

LCN模式是通过代理Connection的方式实现对本地事务的操作，然后在由TxManager统一协调控制事务。当本地事务提交回滚或者关闭连接时将会执行假操作，该代理的连接将由LCN连接池管理。

2. 模式特点:

该模式对代码的嵌入性为低。
该模式仅限于本地存在连接对象且可通过连接对象控制事务的模块。
该模式下的事务提交与回滚是由本地事务方控制，对于数据一致性上有较高的保障。
该模式缺陷在于代理的连接需要随事务发起方一共释放连接，增加了连接占用的时间。

3. 环境准备

中间件	版本
MySQL（可以参照容器化章节）	5.7+
Redis（可以参照容器化章节）	4.0+

3.1 数据库准备

新建fw-txmanager数据库，并且执行以下脚本创建异常表，表名不能变。

CREATE TABLE `t_tx_exception` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `group_id` varchar(64) DEFAULT NULL,
  `unit_id` varchar(32) DEFAULT NULL,
  `mod_id` varchar(128) DEFAULT NULL,
  `transaction_state` tinyint(4) DEFAULT NULL,
  `registrar` tinyint(4) DEFAULT NULL,
  `remark` varchar(4096) DEFAULT NULL,
  `ex_state` tinyint(4) DEFAULT NULL COMMENT '0 未解决 1已解决',
  `create_time` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='tx-manager异常表'

4. TxManager 搭建

LCN模式的控制是有TxManager同意控制事务，因此首先需要将TxManager搭建起来。

4.1 新建模块

新建 fw-cloud-transaction-lcn-txmanager 用来构建TxManager

4.2 maven 配置

这里我们需要引入txlcn-tm的包，因为在主项目种控制了依赖版本，因此这里不用输入版本号，实际版本号是5.0.2.RELEASE

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- tx-lcn manager依赖 -->
    <dependency>
        <groupId>com.codingapi.txlcn</groupId>
        <artifactId>txlcn-tm</artifactId>
    </dependency>
</dependencies>

4.3 应用配置

我们这里需要配置TxManager的数据库地址，配置TxManager 的Redis 信息，因为TX-LCN非常依赖Redis，因此生产建议配置Redis Cluster。
除了以上两个至关重要的配置，我们还可以设置TxManager 的登录密码，Socket 端口，日志记录等。

spring.application.name=TransactionManager
server.port=7970
#datasource
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://${dbIp}:3306/fw_txmanager?useUnicode=true&characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2b8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.hikari.connection-timeout=20000
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.max-lifetime=1200000
spring.datasource.hikari.minimum-idle=5
spring.datasource.hikari.maximum-pool-size=12
spring.datasource.hikari.idle-timeout=300000

# 数据库方言
hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect


# 第一次运行可以设置为: create, 为TM创建持久化数据库表
#spring.jpa.hibernate.ddl-auto=validate

#redis
spring.redis.database=0
spring.redis.host= ${redisIp}
spring.redis.port= 6379
spring.redis.password= 123456
#tx-lcn
# TM监听Socket端口. 默认为 ${server.port} - 100
tx-lcn.manager.port=8888
# TM后台登陆密码，默认值为codingapi
tx-lcn.manager.admin-key=123456

# TM监听IP. 默认为 127.0.0.1
tx-lcn.manager.host=127.0.0.1

# 心跳检测时间(ms). 默认为 300000
tx-lcn.manager.heart-time=300000

# 分布式事务执行总时间(ms). 默认为36000
tx-lcn.manager.dtx-time=8000

# 参数延迟删除时间单位ms  默认为dtx-time值
tx-lcn.message.netty.attr-delay-time=${tx-lcn.manager.dtx-time}

# 事务处理并发等级. 默认为机器逻辑核心数5倍
tx-lcn.manager.concurrent-level=160

# 分布式事务锁超时时间 默认为-1，当-1时会用tx-lcn.manager.dtx-time的时间
tx-lcn.manager.dtx-lock-time=${tx-lcn.manager.dtx-time}

# 雪花算法的sequence位长度，默认为12位.
tx-lcn.manager.seq-len=12

# 异常回调开关。开启时请制定ex-url
tx-lcn.manager.ex-url-enabled=false

# 事务异常通知（任何http协议地址。未指定协议时，为TM提供内置功能接口）。默认是邮件通知
tx-lcn.manager.ex-url=/provider/email-to

4.4 配置启动类

需要在启动类上加上@EnableTransactionManagerServer注解，表示开启TxManager

@SpringBootApplication
@EnableTransactionManagerServer
public class FwTxManagerApplication {
    public static void main(String[] args) {
        SpringApplication.run(FwTxManagerApplication.class, args);
    }
}

4.5 项目启动

浏览器输入http://localhost:7970/

密码就是我们在配置文件中设置的tx-lcn.manager.admin-key

4.6 后台使用说明

4.6.1 首页信息

主要是TxManager的配置信息

4.6.2 异常记录

事务ID：事务组标示

事务单元ID：参与事务单元标示

TxClient标示：模块标示

异常情况：【未知】【TxManager通知事务】【TxClient查询事务状态】【事务发起方通知事务组】, 这几种异常情况

异常状态：解决和未解决。对于系统未作出补偿的异常记录，需要系统管理员【操作】查看当场信息，做出手动补偿

时间：发生时间

操作：查看异常时信息

4.6.3 系统日志

日志分类-TAG:
- transaction: TxClient下达命令记录
- manager: TxManager执行协调记录
日志内容:
- create group: TxClient创建事务组命令到达TxManager
- start join group: TxClient 开始加入事务组
- over join group： TxClient 成功加事务组
- notify group 1： TxManager通知TxClient提交本第事务（0回滚）
- notify unit exception： TxManager通知事务单元失败（此处会记录异常信息）
- notify group over：通知事务组结束（对于个别不能通知到的单元，会记下异常记录，不影响其它通知，异常的等待补偿）

5. 新建LCN 模块

本模块中我们将新建两个模块，我们将模拟电商购物环节中的下单->发货的过程，两个服务通过Feign进行远程调用。两个模块的名称分别为fw-cloud-transaction-lcn-lcn-order和fw-cloud-transaction-lcn-lcn-send

5.1 maven 依赖

两个模块所使用的依赖也是相同的，这里可以看到，我们依赖了上面封装的fw-cloud-transaction-base-dao，不需要再自己写基本的mapper等，因为是基于Eureka 服务发现和Feign 远程调用的，因此引入了响应的包。其中最重要的就是引入txlcn-tc，txlcn-txmsg-netty包，否者不能实现和TxManager的通信及事务控制。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- base-dao -->
    <dependency>
        <groupId>com.yisu.cloud</groupId>
        <artifactId>fw-cloud-transaction-base-dao</artifactId>
        <version>${version}</version>
    </dependency>
    <!-- TC依赖 -->
    <dependency>
        <groupId>com.codingapi.txlcn</groupId>
        <artifactId>txlcn-tc</artifactId>
    </dependency>
    <!-- TC和TM通信依赖于Netty -->
    <dependency>
        <groupId>com.codingapi.txlcn</groupId>
        <artifactId>txlcn-txmsg-netty</artifactId>
    </dependency>
    <!--服务发现-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!--feign-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
    <!-- 数据连接池-->
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
        <version>${HikariCP.version}</version>
    </dependency>
</dependencies>

并在MySql中新建fw_transaction库,并执行以下脚本，供fw-cloud-transaction-lcn-lcn-order和fw-cloud-transaction-lcn-lcn-send使用

CREATE TABLE `fw_trade_log` (
  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键id',
  `status` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT '订单状态 1.待支付 2.待发货 3.待收货 4.订单完成 5.订单关闭',
  `status_dsc` varchar(100) CHARACTER SET utf8 DEFAULT '' COMMENT '状态描述',
  `product_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '商品id',
  `product_name` varchar(100) NOT NULL DEFAULT '' COMMENT '商品名称',
  `user_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '用户id',
  `order_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '订单id',
  `order_amount` decimal(10,2) NOT NULL DEFAULT '0.00' COMMENT '订单总额',
  `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '创建时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='订单表'

5.2 fw-cloud-transaction-lcn-lcn-order模块

5.2.1 订单接口创建

再订单模块中创建一个订单接口，并在接口中设置支付成功的方法


public interface OrderService{

    
    void saveAndPayOrder(String productName);

}

5.2.2 订单接口实现

订单在支付成功以后会远程调用发货服务进行发货，需要在Service 上加上@LcnTransaction，开启LCN模式的分布式事务控制，并且设置订单的状态为待支付


@Service
@Slf4j
public class OrderServiceImpl implements OrderService {

    @Autowired
    private FwTradeLogService fwTradeLogService;

    @Autowired
    private RemoteSendServiceFeign remoteSendServiceFeign;

    @LcnTransaction
    @Override
    public void saveAndPayOrder(String productName) {

        FwTradeLog fwTradeLog =new FwTradeLog(StatusEnum.TWO);
        fwTradeLog.setProductId(System.currentTimeMillis());
        fwTradeLog.setProductName(productName);
        fwTradeLogService.save(fwTradeLog);
        log.info("[订单状态{}]=>{},当前商品id=>{},商品名称=>{}",fwTradeLog.getOrderId(), StatusEnum.TWO.getDesc(),fwTradeLog.getProductId(),fwTradeLog.getProductName());

        remoteSendServiceFeign.sendOrder(fwTradeLog);

    }

}

5.2.3 Feign 接口配置

这里我们配置远程调用的服务名称是fw-transaction-lcn-send，并且设置了fallback，并且指定了远程调用的方法是sendOrder。

@FeignClient(value = "fw-transaction-lcn-send", fallbackFactory = RemoteSendServiceFallback.class)
public interface RemoteSendServiceFeign {

    @PostMapping("send")
    void sendOrder(@RequestBody  FwTradeLog tradeLog);
}

5.2.4 Fallback 接口配置

在fallback输出异常日志

@Component
@Slf4j
public class RemoteSendServiceFallback implements FallbackFactory<RemoteSendServiceFeign> {

    @Override
    public RemoteSendServiceFeign create(Throwable throwable) {

        return tradeLog -> log.error("远程调用失败",throwable);
    }
}

5.2.5 Controller 控制层

配置订单服务对外的接口，方便演示


@RestController
public class OrderController {

    @Autowired
    private OrderService orderService;

    
    @GetMapping("saveOrder")
    public FwResult saveOrder(String productName){
         orderService.saveAndPayOrder(productName);
         return FwResult.ok();
    }


}

5.2.6 启动类配置

这里需要加上@EnableDistributedTransaction开启分布式的调用，加上@EnableFeignClients开启Feign的远程调用，加上@EnableDiscoveryClient开启服务的注册和发现。

@EnableDistributedTransaction
@SpringBootApplication
@EnableFeignClients
@EnableDiscoveryClient
public class FwTransactionLcnOrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(FwTransactionLcnOrderApplication.class, args);
    }


}

5.2.7 应用配置

配置中需要配置数据库和Redis的基本信息，以及TxManager的连接信息，并且设置了Eureka的连接信息和开启Feign的远程调用

server:
  port: 9002
spring:
  application:
    name: fw-transaction-lcn-order
  #数据库配置  start
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    url: jdbc:mysql://${dbIp}:3306/fw_transaction?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true&useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
    hikari:
      connection-timeout: 20000
      auto-commit: true
      max-lifetime: 1200000
      minimum-idle: 5
      maximum-pool-size: 12
      idle-timeout: 300000
  redis:
    port: 6379
    host: ${redisIp}
    database: 0
    password: 123456
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
tx-lcn:
  client:
    manager-address: 127.0.0.1:8888
  logger:
    enabled: true
feign:
  hystrix:
    enabled: true
hystrix:
  shareSecurityContext: true #设置为true，这样做会自动配置Hystrix并发策略插件挂钩，将SecurityContext从主线程传输到Hystrix命令使用的线程

5.3 fw-cloud-transaction-lcn-lcn-send模块

5.3.1 发货接口创建

配置发货接口，并且创建发货的方法


public interface SendService {

    
    void sendOrder(FwTradeLog fwTradeLog);

}

5.3.2 发货接口实现

这里在实现方法上加上@LcnTransaction，并且设置订单的状态为待收货


@Service
@Slf4j
public class SendServiceImpl implements SendService {

    @Autowired
    private FwTradeLogService fwTradeLogService;

    @LcnTransaction
    @Override
    public void sendOrder(FwTradeLog fwTradeLog) {
        fwTradeLog.setStatus(StatusEnum.THREE.getValue());
        fwTradeLog.setStatusDsc(StatusEnum.THREE.getDesc());
        fwTradeLogService.save(fwTradeLog);
        log.info("[订单状态{}]=>{},当前商品id=>{},商品名称=>{}",fwTradeLog.getOrderId(), StatusEnum.THREE.getDesc(),fwTradeLog.getProductId(),fwTradeLog.getProductName());
    }
}

5.3.3 发货控制层实现

提供给订单模块调用的接口，注意方法名和请求方式要保持一致


@RestController
public class SendController {

    @Autowired
    private SendService sendService;

    
    @PostMapping("send")
    public void sendOrder(@RequestBody FwTradeLog tradeLog) {
         sendService.sendOrder(tradeLog);
    }
}

5.3.4 启动类

需要加上@EnableDistributedTransaction注解开启分布式事务，加上@EnableDiscoveryClient注解开启服务的注册与发现


@EnableDistributedTransaction
@SpringBootApplication
@EnableDiscoveryClient
public class FwTransactionLcnSendApplication {
    public static void main(String[] args) {
        SpringApplication.run(FwTransactionLcnSendApplication.class, args);
    }


}

5.3.5 应用配置