基於 groovy 實現公式庫

• 2020 年 5 月 12 日
• 筆記
• Groovy

formula

基於 groovy 實現的公式庫

項目地址

Github

語法

公式名(參數)

比如：

ECHO(大俠王波波)

支援公式嵌套：

公式名1(公式名2(參數), 參數)

比如：

ECHO(UUID())

快速開始

1. 創建 Formula 對象 formula
2. 運行 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 對象
• 公式名全局不可重複

SPI擴展

除了可以手動 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（有向無環圖）計算。

該部分程式碼暫不開源。

資料庫公式

這個也是業務必備，這裡仍不開源。

大家可採用 groovy-sql 或者 JdbcTemplate 實現即可。