Skip to content

Latest commit

 

History

History
179 lines (176 loc) · 8.48 KB

README.md

File metadata and controls

179 lines (176 loc) · 8.48 KB
Raw

stun4j-stf-spring-boot-starter使用说明

1. 快速开始

使用@EnableStf注解

在使用@SpringBootApplication注解的地方，使用@EnableStf注解，如下：

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

通过自动装配的StfTxnOps，在业务代码中使用 柔性事务

@Service
public class BizService {
  @Autowired
  private StfTxnOps txnOps;
  //略...
  public OutObj step(ParamObj param) {
    //略...
    return txnOps.executeWithFinalResult(() -> new OutObj(param), out -> st -> {
      //(如需修改out对象，尽可能在当前闭包内完成)，略...
      //执行本地事务操作，略...
    });
  }
}

通过自动装配的StfExecutorService，在业务代码中使用 可靠的异步任务链

@Service
public class AppService {
  @Autowired
  private StfExecutorService stfExec;
  @Autowired
  private BizService svc;
  //略...
  public void startBiz(ParamObj startParam) {
    CompletableFuture.supplyAsync(() -> svc.step1(startParam), stfExec).thenApplyAsync(svc::step2, stfExec);
    
    //等价于如下代码：
    //stfExec.execute(() -> {
      //Step2Param step2Param = svc.step1(startParam);
      //stfExec.execute(() -> svc.step2(step2Param));
    //});    
  }
}

通过自动装配的StfDelayQueue，在业务代码中使用 延时队列

@Service
public class BizService {
  @Autowired
  private StfDelayQueue queue;
  
  //spring容器中taskObjId就是beanId
  //普通的POJO容器中，需以KV形式自行注册taskObjId和taskObj
  public Long delayRun(String taskObjId, String taskMethodName, int timeoutSeconds, int delaySeconds, Object... taskParams) {
    Long taskNo = queue.offer(taskObjId, taskMethodName, timeoutSeconds, delaySeconds, taskParams);
    return taskNo;
  }
}

2. application.yml配置详解

2.1 补偿式工作流 相关配置

stun4j:
  stf:
    conf-root-path: <如file:/apps/foo/stfs> #flow配置所处的根路径(可选,默认值: classpath:stfs)
    conf-full-load-order: <如[bizFoo-flow, bizBar-flow]> #flow配置的文件名和 左右或前后 顺序(可选,但一般都需要明确指定,除非你不关心配置间的父子关系,比如,对于具有相同oid的config-block,右侧/后面 文件会覆盖 左侧/前面 文件的定义)
    conf-exclude-filenames: <如[excludeFoo-flow, excludeBar-flow]> #需被排除、不会被加载的flow配置文件名(可选,如不指定,表示均需加载)

更多关于补偿式工作流的介绍可参考这篇

2.2 柔性事务 相关配置

stun4j:
  stf:
    transaction: #事务全局属性的相关配置(可选,如不出现,采用默认配置)
      isolation-level: default #隔离级别(可选,默认值:default,其它取值read-committed,repeatable-read)
      propagation: required #传播机制(可选,默认值:required,其它取值mandatory,nested,never,not-supported,requires-new,supports)

2.3 异步任务链线程池 相关配置

stun4j:
  stf:
    default-executor: #开放供业务使用的、默认的、全局任务执行线程池(可选,如不出现,采用默认配置)
      allow-core-thread-time-out: true #是否允许核心线程超时(可选,默认值:true)
      task-queue-size: 1024 #线程队列size(可选,默认值:1024)
      thread-keep-alive-time-seconds: 60 #线程的保活秒数(可选,默认值:60)
      thread-reject-policy: back-pressure #线程的拒绝策略(可选,默认值:back-pressure,其它取值drop-with-ex-throw,silent-drop,silent-drop-oldest)

2.4 延时队列 相关配置

stun4j:
  stf:
    delay-queue: #可选,如不出现,采用默认配置
      enabled: true #是否启用delay-queue(可选,默认值:true)

2.5 任务引擎 相关配置

2.5.1 核心协调者 相关配置

stun4j:
  stf:
    job: #可选(如不出现,采用默认配置)
      manager: #可选(如不出现,采用默认配置)
        scan-freq-secs: 3 #扫描频率秒数(可选,默认值:3)
        handle-batch-size: 0 #批处理任务数量(可选,默认值:0)

2.5.2 队列充填器 相关配置

stun4j:
  stf:
    job: #可选(如不出现,采用默认配置)
      loader: #可选(如不出现,采用默认配置)
        load-size: 300 #扫描加载任务数最大值的一个因子(可选,默认值:300)
        scan-freq-secs: 3 #扫描频率秒数(可选,默认值:3)

2.6 监控 相关配置

stun4j:
  stf:
    monitor: #可选(如不出现,采用默认配置)
      vm-res-check-enabled: true #是否开启资源检查(可选,默认值:true)
      consider-jvm-mem: false #资源检查是否考察jvm内存(可选,默认值:false)
      consider-sys-load: false #资源检查是否考察系统负载(可选,默认值:false)
      jvm-cpu: #可选(如不出现,采用默认配置)
        high-factor: 0.65f #高水位阈值(可选,默认值:0.65f,即65%)
      jvm-mem: #可选(如不出现,采用默认配置)
        high-factor: 0.85f #高水位阈值(可选,默认值:0.85f,即85%)
        include-non-heap: false #jvm内存检查是否考察non-heap(可选,默认值:false)
      sys-load: #可选(如不出现,采用默认配置)
        high-factor: 0.8f #高水位阈值(可选,默认值:0.8f,即80%)

2.7 运行模式 相关配置

stun4j:
  stf:
    run-mode: default #运行模式(可选,默认值:default,其它取值client)

2.8 数据源 相关配置

stun4j:
  stf:
    datasource-bean-name: dataSource #用户数据源在spring容器中的bean名称(可选,默认值:dataSource)
    core: #可选(如不出现,采用默认配置)
      datasource: #核心引擎的数据源配置(可选,默认和用户数据源沿用同一份)
        bean-name: dataSource #核心引擎数据源的bean名称(可选,默认和用户数据源沿用同一名称,即,默认使用同一数据源,注意,如不一致,事务将无法保证!!!)
    delay-queue: #可选(如不出现,采用默认配置)
      datasource: #延时队列的数据源配置(可选,默认和core沿用同一份)
        bean-name: dataSource #延时队列数据源的bean名称(可选,默认和core沿用同一名称,即,默认使用同一数据源,如改变名称,用户需自行创建对应的bean)
        auto-create-enabled: false #是否允许自动创建延时队列数据源并同时注册为bean(可选,默认值:false,只有为true,下述datasource的相关配置才实际生效)
        url: jdbc:mysql://localhost/test2
        username: root
        password: 1111
        hikari: #开箱支持hikari连接池配置(可选,和springboot中如何配置hikari完全一致,如不指定,则使用其它连接池或不使用任何连接池)
          maximum-pool-size: 15
          #hikari的其它配置项 略...
        druid: #开箱支持druid连接池配置(可选,和springboot中如何配置druid完全一致,如不指定,则使用其它连接池或不使用任何连接池)
          max-active: 20
          #druid的其它配置项 略...

2.9 存储格式 相关配置

stun4j:
  stf:
    core: #可选(如不出现,采用默认配置)
      body: #核心引擎运行时的body存储(可选,如不出现,采用默认配置)
        bytes-enabled: false #是否以二进制格式存储(可选,默认值:false)
        compress-algorithm: none #压缩存储使用的算法(可选,默认值:none,其它取值zstd,snappy 注意,启用任何非none的压缩算法,bytes-enabled将被强制设为true,该行为有别于一般的开关配置)
    delay-queue: #可选(如不出现,采用默认配置)
      body: #延时队列运行时的body存储(可选,如不出现,采用默认配置)
        bytes-enabled: false #是否以二进制格式存储(可选,默认值:false)
        compress-algorithm: none #压缩存储使用的算法(可选,默认值:none,其它取值zstd,snappy 注意,启用任何非none的压缩算法,bytes-enabled将被强制设为true,该行为有别于一般的开关配置)

2.10 GUID 相关配置

Stf及其集群的正确工作必须确保内置的GUID也是正确工作的，开箱即用的GUID策略是基于本地IP的，关于这块的详细介绍和讨论可从这个教程入手

< 回索引