springcloud整合分布式事务框架TX-LCN
作者小结:最近一直在搞分布式,整合分布式事务框架LCN遇到一大堆的坑,并且网上文档少之又少,费劲九牛二虎之力终于搞定,特此分享,希望对看到的朋友有所帮助!
搭建springcloud项目
开发环境:jdk1.8、idea2019.3、maven3.6.1 、mysql、redis
请先配置好开发环境
创建maven父工程,命名为 :spring-cloud-txlcn
创建成功,目录结构如下:
直接删掉src目录,因为是父子工程,该src没有什么作用,删掉后如下:
创建子工程,注册中心:命名为:txlcn-registry
创建成功后目录结构如下:
创建子工程 txlcn-base-a txlcn-base-b txlcn-tm
按照创建注册中心的方式创建如上几个子工程
创建成功的目录结构如下:
父工程配置
找到父工程下的pom,配置需要的依赖及其指定版本
依赖如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.it</groupId>
<artifactId>spring-cloud-txlcn</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>txlcn-registry</module>
<module>txlcn-base-a</module>
<module>txlcn-base-b</module>
<module>txlcn-tm</module>
</modules>
<!--springboot依赖-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.4.RELEASE</version>
<relativePath/>
</parent>
<!--jdk及其版本指定-->
<properties>
<!-- project -setting -->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-cloud.version>Hoxton.SR1</spring-cloud.version>
<codingapi.txlcn.version>5.0.2.RELEASE</codingapi.txlcn.version>
<mapper.starter.version>2.1.5</mapper.starter.version>
<mysql.version>5.1.48</mysql.version>
<pagehelper.starter.version>1.2.13</pagehelper.starter.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${
spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>${
mapper.starter.version}</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${
mysql.version}</version>
</dependency>
<!--txlcn 依赖-->
<dependency>
<groupId>com.codingapi.txlcn</groupId>
<artifactId>txlcn-tc</artifactId>
<version>${
codingapi.txlcn.version}</version>
</dependency>
<dependency>
<groupId>com.codingapi.txlcn</groupId>
<artifactId>txlcn-txmsg-netty</artifactId>
<version>${
codingapi.txlcn.version}</version>
</dependency>
<dependency>
<groupId>com.codingapi.txlcn</groupId>
<artifactId>txlcn-tm</artifactId>
<version>${
codingapi.txlcn.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
注册中心配置与启动
进入到子工程 txlcn-registry 中,为其pom添加依赖:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>spring-cloud-txlcn</artifactId>
<groupId>com.it</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.it</groupId>
<artifactId>txlcn-registry</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
</dependencies>
</project>
在其src/main/resources下创建application.yml配置文件:
server:
port: 8500
spring:
application:
name: txlcn-registry
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8500/eureka
fetch-registry: false #不拉取服务列表
register-with-eureka: false #不注册自己
在src/main/java 下创建启动类 RegistrtyApplication.java ,包目录为 com.it
内容如下:
package com.it;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
/**
* @program: spring-cloud-txlcn
* @description:
* @author: nike
* @create: 2020-04-16 16:42
*/
@SpringBootApplication
@EnableEurekaServer
public class RegistryApplication {
public static void main(String[] args) {
SpringApplication.run(RegistryApplication.class,args);
}
}
启动,访问测试:浏览器访问 http://localhost:8000
TXLCN分布式事务管理器配置与启动
mysql数据库执行sql语句:
CREATE DATABASE `tx-manager`;
USE `tx-manager`;
CREATE TABLE `t_tx_exception` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`group_id` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
`unit_id` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
`mod_id` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
`transaction_state` tinyint(4) NULL DEFAULT NULL,
`registrar` tinyint(4) NULL DEFAULT NULL,
`remark` varchar(4096) NULL DEFAULT NULL,
`ex_state` tinyint(4) NULL DEFAULT NULL COMMENT '0 未解决 1已解决',
`create_time` datetime(0) NULL DEFAULT NULL,
PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
确认本地redis已开启
进入子工程 txlcn-tm 中,为其pom添加依赖:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>spring-cloud-txlcn</artifactId>
<groupId>com.it</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.it</groupId>
<artifactId>txlcn-tm</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>com.codingapi.txlcn</groupId>
<artifactId>txlcn-tm</artifactId>
</dependency>
</dependencies>
</project>
在其src/main/resources添加配置文件application.properties,配置如下:
##################
# 这个是启动本服务的配置文件
# https://txlcn.org/zh-cn/docs/setting/manager.html 查看所有的个性化配置
#################
# 服务名称及其端口
spring.application.name=TransactionManager
server.port=7970
# 数据库配置
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/tx-manager?characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=
spring.jpa.database-platform=org.hibernate.dialect.MySQL5InnoDBDialect
spring.jpa.hibernate.ddl-auto=update
# 开启日志,默认为false
tx-lcn.logger.enabled=true
tx-lcn.logger.driver-class-name=${
spring.datasource.driver-class-name}
tx-lcn.logger.jdbc-url=${
spring.datasource.url}
tx-lcn.logger.username=${
spring.datasource.username}
tx-lcn.logger.password=${
spring.datasource.password}
# redis 的设置信息
spring.redis.host=127.0.0.1
spring.redis.port=6379
spring.redis.password=
在其src/main/java下创建启动类,TxlcnTmApplication.java ,包目录为 com.it
其内容为:
package com.it;
import com.codingapi.txlcn.tm.config.EnableTransactionManagerServer;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @program: spring-cloud-txlcn
* @description:
* @author: nike
* @create: 2020-04-16 16:53
*/
@SpringBootApplication
@EnableTransactionManagerServer
public class TxlcnTmApplication {
public static void main(String[] args) {
SpringApplication.run(TxlcnTmApplication.class,args);
}
}
启动测试,浏览器输入:http://localhost:7970
服务txlcn-base-a的配置与启动
删掉txlcn-base-a的src目录,在txlcn-base-a下创子工程,txlcn-base-a-interface 、 txlcn-base-a-service
为txlcn-base-a-service下的pom引入依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>txlcn-base-a</artifactId>
<groupId>com.it</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.it</groupId>
<artifactId>txlcn-base-a-service</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.10.2</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
<groupId>com.it</groupId>
<artifactId>txlcn-base-a-interface</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.codingapi.txlcn</groupId>
<artifactId>txlcn-tc</artifactId>
</dependency>
<dependency>
<groupId>com.codingapi.txlcn</groupId>
<artifactId>txlcn-txmsg-netty</artifactId>
</dependency>
</dependencies>
</project>
在其src/main/resources下创建application.yml配置文件
server:
port: 8001
spring:
application:
name: txlcn-base-a-service
datasource:
url: jdbc:mysql://localhost:3306/test_data
username: root
password:
driver-class-name: com.mysql.jdbc.Driver
main:
allow-bean-definition-overriding: true #开启覆盖相同的feign名称
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8000/eureka
instance:
prefer-ip-address: true
ip-address: 127.0.0.1
registry-fetch-interval-seconds: 5
mybatis:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
创建启动类 TxlcnBaseAServiceApplication.java,包路径为com.it
package com.it;
import com.codingapi.txlcn.tc.config.EnableDistributedTransaction;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
import tk.mybatis.spring.annotation.MapperScan;
/**
* @program: spring-cloud-txlcn
* @description:
* @author: nike
* @create: 2020-04-16 17:33
*/
@SpringBootApplication
@EnableFeignClients //springcloud feign调用
@EnableDiscoveryClient //springcloud服务发现
@MapperScan("com.it.mapper") //扫描mapper文件所在包
@EnableDistributedTransaction //开启LcnTransaction分布式事务框架
public class TxlcnBaseAServiceApplication {
public static void main(String[] args) {
SpringApplication.run(TxlcnBaseAServiceApplication.class,args);
}
}
创建相关包路径,mapper、service、controller、client
如下:
配置 txlcn-base-a-interface ,pom添加依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>txlcn-base-b</artifactId>
<groupId>com.it</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.it</groupId>
<artifactId>txlcn-base-b-interface</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-core</artifactId>
<version>1.1.5</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.10.2</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
</dependency>
</dependencies>
</project>
创建 pojo 、api 包
服务txlcn-base-b的配置与启动
与txlcn-base-a相同,不同的就是application.yml配置:
server:
port: 8002
spring:
application:
name: txlcn-base-a-service
datasource:
url: jdbc:mysql://localhost:3306/test_data
username: root
password:
driver-class-name: com.mysql.jdbc.Driver
main:
allow-bean-definition-overriding: true #开启覆盖相同的feign名称
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8000/eureka
instance:
prefer-ip-address: true
ip-address: 127.0.0.1
registry-fetch-interval-seconds: 5
mybatis:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
还有 txlcn-base-b-service 的pom依赖:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>txlcn-base-b</artifactId>
<groupId>com.it</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.it</groupId>
<artifactId>txlcn-base-b-service</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.10.2</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
<groupId>com.it</groupId>
<artifactId>txlcn-base-b-interface</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.codingapi.txlcn</groupId>
<artifactId>txlcn-tc</artifactId>
</dependency>
<dependency>
<groupId>com.codingapi.txlcn</groupId>
<artifactId>txlcn-txmsg-netty</artifactId>
</dependency>
</dependencies>
</project>
以及启动类:
@SpringBootApplication
@EnableFeignClients //springcloud feign调用
@EnableDiscoveryClient //springcloud服务发现
@MapperScan("com.it.mapper") //扫描mapper文件所在包
@EnableDistributedTransaction //开启LcnTransaction分布式事务框架
public class TxlcnBaseBServiceApplication {
public static void main(String[] args) {
SpringApplication.run(TxlcnBaseBServiceApplication.class,args);
}
}
完整如下:
分布式案例实现,服务A添加用户,同时调用服务B添加用户,A在调用B之后抛出异常
创建数据库及其表,配置的数据库是 test_data
CREATE DATABASE `test_data`;
USE `test_data`;
CREATE TABLE `tb_test` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`name` varchar(255) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
服务txlcn-base-b中创建实体
@Data
@Table(name = "tb_test")
public class TestPO {
@Id
@KeySql(useGeneratedKeys = true)
private Long id;
private String name;
}
创建mapper,
BaseMapper
@RegisterMapper
public interface BaseMapper<T, PK> extends Mapper<T>, IdListMapper<T, PK>, InsertListMapper<T> {
}
TestMapper
public interface TestMapper extends BaseMapper<TestPO,Long> {
}
创建service接口及其实现类
TestService
public interface TestService {
void insert(TestPO po);
}
TestServiceImpl
@Service
public class TestServiceImpl implements TestService {
@Autowired
private TestMapper testMapper;
@Override
public void insert(TestPO po) {
testMapper.insert(po);
}
}
创建controller
@RestController
@RequestMapping("/test")
public class TestController {
@Autowired
private TestService testService;
@GetMapping("/insert")
public String insert(String name){
TestPO po = new TestPO();
po.setName(name);
testService.insert(po);
return "success";
}
}
启动 txlcn-base-b-service 测试,访问:http://localhost:8002/test/insert?name=momo
查看数据库 :
则 txlcn-base-a 也如 txlcn-base-b 相同配置,并测试!
浏览器访问:http://localhost:8001/test/insert?name=nono
实现A调用B
txlcn-base-b api的包下添加访问接口
public interface TestApi {
@GetMapping("/test/insert")
String insert(@RequestParam("name") String name);
}
txlcn-base-a 继承 txlcn-base-b 的接口,在client包下创建接口继承txlcn-base-b的api接口,并使用fegin注解标注服务id
导入txlcn-base-b-interface的依赖
<dependency>
<groupId>com.it</groupId>
<artifactId>txlcn-base-b-interface</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
@FeignClient("txlcn-base-b-service")
public interface TestClient extends TestApi {
}
在A服务添加用户的同时,调用B服务添加用户,并且创建zero异常
@Service
public class TestServiceImpl implements TestService {
@Autowired
private TestMapper testMapper;
@Autowired
private TestClient testClient;
@Override
public void insert(TestPO po) {
testMapper.insert(po);
//client调用B服务
testClient.insert(po.getName()+"B");
int i = 100/0;
}
}
重启测试!
浏览器访问: http://localhost:8001/test/insert?name=baobao
可以看到,a服务抛出异常,但b服务仍然添加成功了!
现在我们添加上 分布式事务注解
a服务
@Service
public class TestServiceImpl implements TestService {
@Autowired
private TestMapper testMapper;
@Autowired
private TestClient testClient;
@Override
@Transactional
@LcnTransaction
public void insert(TestPO po) {
testMapper.insert(po);
//client调用B服务
testClient.insert(po.getName()+"B");
int i = 100/0;
}
}
b服务
@Service
public class TestServiceImpl implements TestService {
@Autowired
private TestMapper testMapper;
@Override
@Transactional
@LcnTransaction
public void insert(TestPO po) {
testMapper.insert(po);
}
}
继续访问测试: http://localhost:8001/test/insert?name=heihei
可以看到a服务、b服务都没有添加成功!
则分布式事务到此结束!