基于 groovy 实现的公式库
<dependency>
<groupId>tk.fishfish</groupId>
<artifactId>formula</artifactId>
<version>最新版本</version>
</dependency>
公式名(参数)
比如:
ECHO(大侠王波波)
支持公式嵌套:
公式名1(公式名2(参数), 参数)
比如:
ECHO(UUID())
- 创建 Formula 对象 formula
- 运行 formula.run("script")
下面是例子:
package tk.fishfish.formula;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
/**
* 公式测试
*
* @author 奔波儿灞
* @since 1.0
*/
public class FormulaTest {
private Formula formula;
@Before
public void setup() {
formula = new Formula();
}
@Test
public void lower() {
Object result = formula.run("LOWER(ABC)");
Assert.assertEquals("abc", result);
}
}
这里只是抛砖引玉,实现了如下文本公式:
- UUID() 返回uuid
- LOWER(xxx) 转小写
- UPPER(xxx) 转大写
这里未实现丰富文本、时间、数学、逻辑等公式,只是提供一个扩展机制,方便大家定制自己的公式库。
-
继承 Plugin 接口
package tk.fishfish.formula.plugin; import tk.fishfish.formula.annotation.FormulaMapping; /** * 自定义公式 * * @author 奔波儿灞 * @since 1.0 */ public class CustomPlugin implements Plugin { /** * 实现自己的公式 * * @param name 参数 * @return 结果 */ @FormulaMapping("ECHO") public String echo(String name) { return "echo: " + name; } }
-
自定义方法,增加 @FormulaMapping 注解 映射公式名称
-
安装插件类,FormulaScript.installPlugin(CustomPlugin.class)
package tk.fishfish.formula; import org.junit.Assert; import org.junit.Before; import org.junit.Test; import tk.fishfish.formula.plugin.CustomPlugin; import tk.fishfish.formula.script.FormulaScript; import java.math.BigDecimal; /** * 公式测试 * * @author 奔波儿灞 * @since 1.0 */ public class FormulaTest { private Formula formula; @BeforeClass public static void init() { // 安装自己的公式插件 FormulaScript.installPlugin(CustomPlugin.class); } @Before public void setup() { formula = new Formula(); } @Test public void plugin() { Object result = formula.run("ECHO(xxx)"); System.out.println(result); } }
注意:
- 先安装自己的公式,再创建 Formula 对象
- 公式名全局不可重复
除了可以手动 FormulaScript.installPlugin(CustomPlugin.class) 安装自定义公式以外,还能通过 SPI 注册。
在 src/main/resources/META-INF/services 目录下创建名称为 tk.fishfish.formula.plugin.Plugin 的文件,里面是实现类的全类名:
# custom plugin
tk.fishfish.formula.plugin.CustomPlugin
此时,会自动通过 SPI 机制发现实现类,自动安装,实现解偶。
大部分情况下,业务定制的公式都会含有变量,比如:
公式名(变量)
一般地,都会在运行时,替换变量。
package tk.fishfish.formula;
import groovy.lang.Binding;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import tk.fishfish.formula.plugin.CustomPlugin;
import tk.fishfish.formula.script.FormulaScript;
/**
* 公式测试
*
* @author 奔波儿灞
* @since 1.0
*/
public class FormulaTest {
private Formula formula;
@Before
public void setup() {
formula = new Formula();
}
@Test
public void variable() {
Binding binding = new Binding();
binding.setVariable("xxx", "ABC");
// 传入 Binding 上下文
Object result = formula.run("LOWER(xxx)", binding);
Assert.assertEquals("abc", result);
}
}
更有甚者,存在依赖关系,比如:
- 值 A 的公式为:
公式1(xxx)
- 值 B 的公式为:
公式2(A)
,注意 B 依赖 A 的结果
此时,就存在依赖关系了,即 B 依赖 A
显然,我们可以将依赖关系可转化为 DAG(有向无环图)计算。
例如:
- field1 存在 3 条记录,值分别为 1,3,5
- field2 值为 ABC
- field3 为 LOWER('#{field2}') 即将 field2 的值转小写
- field4 为 SUM('#{field1}') 即将 field1 的值做聚合求和
package tk.fishfish.formula;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import tk.fishfish.formula.dag.FormulaData;
import tk.fishfish.formula.plugin.CustomPlugin;
import tk.fishfish.formula.script.FormulaScript;
import java.util.ArrayList;
import java.util.List;
/**
* 公式DAG测试
*
* @author 奔波儿灞
* @since 1.0.0
*/
public class DagFormulaEngineTest {
private static final Logger LOG = LoggerFactory.getLogger(FormulaTest.class);
private DagFormulaEngine engine;
@BeforeClass
public static void init() {
// 安装自己的公式插件
FormulaScript.installPlugin(CustomPlugin.class);
}
@Before
public void setup() {
engine = new DagFormulaEngine(new Formula());
}
@Test
public void run() {
// 批量计算的公式、数据
List<FormulaData> formulaDataList = new ArrayList<FormulaData>() {{
add(new FormulaData("field1", 0, null, 1));
add(new FormulaData("field1", 1, null, 3));
add(new FormulaData("field1", 2, null, 5));
add(new FormulaData("field2", -1, null, "ABC"));
add(new FormulaData("field3", -1, "LOWER('#{field2}')", null));
add(new FormulaData("field4", -1, "SUM('#{field1}')", 0));
}};
// 计算
engine.run(formulaDataList);
// 结果
formulaDataList.forEach(formulaData ->
LOG.info("name: {}, formula: {}, value: {}",
formulaData.getName(), formulaData.getFormula(), formulaData.getValue())
);
}
}
大家可采用 groovy-sql 或者 JdbcTemplate 实现即可。
可直接执行 java 代码块。
package tk.fishfish.formula;
import groovy.lang.Binding;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Date;
/**
* 公式测试
*
* @author 奔波儿灞
* @since 1.0
*/
public class FormulaTest {
private static final Logger LOG = LoggerFactory.getLogger(FormulaTest.class);
private Formula formula;
@Before
public void setup() {
formula = new Formula();
}
@Test
public void runJava() {
Binding binding = new Binding();
binding.setVariable("value", new Date());
Object result = formula.runJava("import java.text.SimpleDateFormat;\n" +
"SimpleDateFormat format = new SimpleDateFormat(\"yyyy年MM月dd日\");\n" +
// 这里通过上下文传入value为当前时间,代码块中可直接使用
// 最后一行的结果做为返回值
"format.format(value);", binding);
LOG.info("result: {}", result);
}
}
其中:
- 通过上下文传入变量,代码块中可直接使用
- 最后一行的结果做为返回值