LiteFlow LiteFlow
💒首页
  • v2.13.2(当前版本)
  • What's New

    • 🌈What' s New In LiteFlow v2.13.2?
  • 历史版本

    • v2.12.X
    • v2.11.X
    • v2.10.X
    • v2.9.X
    • v2.8.X
  • 升级指南

    • 🌈2.13.0升级指南
    • 2.12.4升级指南
    • 2.12.0升级指南
    • 升级到2.9.3说明
    • 升级到2.9.X说明
    • 升级到2.8.X说明
    • 升级到2.7.X说明
👑LF CLUB社区
  • 常见问题
  • 专题解释

    • 如何理解上下文这个概念?
    • Slot是一个什么样的概念,在框架中起到什么样的作用?
💖赞助
🧩插件
🔥PPT
  • 项目介绍
  • 项目成员
  • 更新记录
  • 参与开发
👥加入群聊
🧤谁在使用
  • Gitee (opens new window)
  • GitCode (opens new window)
  • Github (opens new window)

广告采用随机轮播方式显示 ❤️成为赞助商
💒首页
  • v2.13.2(当前版本)
  • What's New

    • 🌈What' s New In LiteFlow v2.13.2?
  • 历史版本

    • v2.12.X
    • v2.11.X
    • v2.10.X
    • v2.9.X
    • v2.8.X
  • 升级指南

    • 🌈2.13.0升级指南
    • 2.12.4升级指南
    • 2.12.0升级指南
    • 升级到2.9.3说明
    • 升级到2.9.X说明
    • 升级到2.8.X说明
    • 升级到2.7.X说明
👑LF CLUB社区
  • 常见问题
  • 专题解释

    • 如何理解上下文这个概念?
    • Slot是一个什么样的概念,在框架中起到什么样的作用?
💖赞助
🧩插件
🔥PPT
  • 项目介绍
  • 项目成员
  • 更新记录
  • 参与开发
👥加入群聊
🧤谁在使用
  • Gitee (opens new window)
  • GitCode (opens new window)
  • Github (opens new window)
  • 🍤LiteFlow简介
  • 🍓项目特性
  • 🧁环境支持

  • 🍟快速开始(Hello world)

  • 🍢配置项

  • 🗂规则文件

  • 🔗常规组件

  • 🧩EL规则的写法

  • 🌮数据上下文

  • 🛩执行器

  • 🍋脚本组件

  • 🍇声明式组件

    • 🥭什么叫声明式组件
    • 🧅类级别式声明
      • 普通组件的声明
      • 选择组件的声明
      • 条件组件的声明
      • 数值循环组件的声明
      • 条件循环组件的声明
      • 退出循环组件的声明
      • 注意点
    • 🥥方法级别式声明
  • 🎲用代码动态构造规则

  • 🎨高级特性

  • ⛱测试用例以及示例

  • 🪂性能表现
  • v2.11.X文档
  • 🍇声明式组件
铂赛东
2022-10-05
目录

🧅类级别式声明

类级别式声明主要用处就是通过注解形式让普通的java bean变成LiteFlow的组件。无需通过继承类或者实现接口的方式。

由于LiteFlow的组件常规方式下需要继承类来定义,使得你无法再继承自己业务的类了。这个特性可以解决这个问题。但是和常规组件一样,需要一个类对应一个组件。

# 普通组件的声明

你可以如下去进行一个普通组件的声明:

@LiteflowComponent("a")
@LiteflowCmpDefine
public class ACmp{
  
	@LiteflowMethod(LiteFlowMethodEnum.PROCESS)
	public void processAcmp(NodeComponent bindCmp) {
		System.out.println("ACmp executed!");
	}

	@LiteflowMethod(LiteFlowMethodEnum.IS_ACCESS)
	public boolean isAcmpAccess(NodeComponent bindCmp){
		return true;
	}

	@LiteflowMethod(LiteFlowMethodEnum.BEFORE_PROCESS)
	public void beforeAcmp(NodeComponent bindCmp){
		System.out.println("before A");
	}

	@LiteflowMethod(LiteFlowMethodEnum.AFTER_PROCESS)
	public void afterAcmp(NodeComponent bindCmp){
		System.out.println("after A");
	}

	@LiteflowMethod(LiteFlowMethodEnum.ON_SUCCESS)
	public void onAcmpSuccess(NodeComponent bindCmp){
		System.out.println("Acmp success");
	}

	@LiteflowMethod(LiteFlowMethodEnum.ON_ERROR)
	public void onAcmpError(NodeComponent bindCmp, Exception e){
		System.out.println("Acmp error");
	}
	
	@LiteflowMethod(LiteFlowMethodEnum.IS_END)
	public boolean isAcmpEnd(NodeComponent bindCmp) {
		return false;
	}
    
    @LiteflowMethod(value = LiteFlowMethodEnum.ROLLBACK)
    public void rollbackA(NodeComponent bindCmp) throws Exception {
        System.out.println("ACmp rollback!");
    }
}

使用者无需继承NodeComponent了,在你定义的类上,只要类上加上LiteflowCmpDefine注解,相应的方法上加上LiteflowMethod注解,即可完成对任意自定义类的组件化工作。

其中LiteFlowMethod的作用是把你自己的定义的方法映射成组件的方法。除了有示例上的值外,还有其他的映射方法。具体可以看下普通组件章节。

注意点1

关于参数的参数,这里需要注意的是,方法上参数必须传入NodeComponent bindCmp这个参数,而且必须是第一个参数。

比如原先的process(),那么在声明式里就是yourMethodName(NodeComponent bindCmp)。

如果是原先的onError(Exception e),那么在声明式里就是yourMethodName(NodeComponent bindCmp, Exception e)。

规律很明显,就是原先的参数保留,在第一个位置插入NodeComponent对象,代替原先的this。

以前获取上下文Bean是用this关键字,现在只需从bindCmp中获取就可以了。

方法的名称可以定义成你想要的任何方式。这个并无限制。

注意点2

自己定义方法时,返回值要和常规组件里的对应方法返回值一致。比如普通组件的process方法是不返回的,比如IF组件的processIf方法是返回布尔值的。

如果写错,也会发生一点异常,可能会增加你的排查时间。

# 选择组件的声明

声明选择组件在类和方法上都需要加上NodeTypeEnum.SWITCH参数。

@Component("e")
@LiteflowCmpDefine(NodeTypeEnum.SWITCH)
public class ECmp{

    @LiteflowMethod(value = LiteFlowMethodEnum.PROCESS_SWITCH, nodeType = NodeTypeEnum.SWITCH)
    public String processSwitch(NodeComponent bindCmp) throws Exception {
        System.out.println("Ecomp executed!");
        return "g";
    }
}

# 条件组件的声明

声明选择组件在类和方法上都需要加上NodeTypeEnum.IF参数。

@Component("x")
@LiteflowCmpDefine(NodeTypeEnum.IF)
public class XCmp{

	@LiteflowMethod(value = LiteFlowMethodEnum.IF, nodeType = NodeTypeEnum.IF)
	public boolean processIf(NodeComponent bindCmp) throws Exception {
		//do your biz
		return true;
	}
}

# 数值循环组件的声明

声明选择组件在类和方法上都需要加上NodeTypeEnum.FOR参数。

@Component("x")
@LiteflowCmpDefine(NodeTypeEnum.FOR)
public class XCmp{

	@LiteflowMethod(value = LiteFlowMethodEnum.PROCESS_FOR, nodeType = NodeTypeEnum.FOR)
	public int processFor(NodeComponent bindCmp) throws Exception {
		//do your biz
		return 10;
	}
}

# 条件循环组件的声明

声明选择组件在类和方法上都需要加上NodeTypeEnum.WHILE参数。

@Component("x")
@LiteflowCmpDefine(NodeTypeEnum.WHILE)
public class XCmp{

	@LiteflowMethod(value = LiteFlowMethodEnum.PROCESS_WHILE, nodeType = NodeTypeEnum.WHILE)
	public boolean processWhile(NodeComponent bindCmp) throws Exception {
		//get your while flag
		boolean flag = xxxxxx;
		return flag;
	}
}

# 退出循环组件的声明

声明选择组件在类和方法上都需要加上NodeTypeEnum.BREAK参数。

@Component("x")
@LiteflowCmpDefine(NodeTypeEnum.BREAK)
public class XCmp{

	@LiteflowMethod(value = LiteFlowMethodEnum.PROCESS_BREAK, nodeType = NodeTypeEnum.BREAK)
	public boolean processBreak(NodeComponent bindCmp) throws Exception {
		//get your break flag
		boolean flag = xxxxxx;
		return flag;
	}
}

# 注意点

提示

对于类里的其他方法,也都和processXxx一样的方式去声明。

帮助我们改善此文档 (opens new window)
上次更新: 2024/04/09, 18:39:17
🥭什么叫声明式组件
🥥方法级别式声明

← 🥭什么叫声明式组件 🥥方法级别式声明→

Theme by Vdoing | Copyright © 2020-2025 铂赛东 | MIT License
沪ICP备18012955号-2
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式