func-spring-boot-starter 匿名函數託管

2022 年 3 月 31 日
筆記
JAVA, spring, springboot, SpringMVC

func-spring-boot-starter 匿名函數託管

GitHub項目路徑:

//github.com/yiurhub/func-spring-boot-starter

Gitee項目路徑:

//gitee.com/yiur/func-spring-boot-starter

使用注意事項

推薦版本:

spring-boot-starter 2.6.x

設計原理

匿名函數特性

匿名函數鏈接配置

Yaml

func-link:
    # 默認代理模式
    singleton: true
    # 默認開啟lambda模式
    lambda: true
    # 默認的callback回調函數類
    call-back: org.func.spring.boot.component.callback.SimpleFuncCallback
    # logger 配置
    logger:
      # 默認false 不輸出日誌
      enable-log: false
      # 默認輸出日誌資訊 ${取當前匿名函數的公開資訊}
      message: "call method --> ${methodName}(${parameterSource})"
      # 日誌執行日誌格式化
      date-format: "yyyy-MM-dd HH:mm:ss"
      # 輸出日誌的文件名
      file-name: "simple"

JavaConfig

添加類註解@EnableFuncLambda

需要注入FuncLinkFactory工廠類，生產默認FuncLink鏈接類

添加鏈接的方法為setObject(key, Object) 鏈式編程 泛型約束 Lambda

key: {Spring Bean Name}😒{功能鏈接 | 插件}

object: ${功能鏈接類| 插件類}

FuncLink推薦Lambda操作

詳細內容請看項目:

//gitee.com/yiur/func-spring-boot-starter/tree/main/func-web-simple

@Configuration
@EnableFuncLambda("com.simple.web.lambda")
public class FuncLinkConfig {

    @Autowired
    public FuncLinkFactory funcLinkFactory;

    @Bean
    public FuncLink funcLink() {
        return funcLinkFactory.build()
                .<FuncLogger>setObject("logger:log", (set, log) -> "logger => ${methodName}\r\n");
    }

}

嚴格類型託管

開發推薦嚴格類型託管，有程式碼提示，開發效率更高，在Web項目中，可以託管整個Servcie層

配合Mybaits，Redis等框架一起使用

1、定義介面

用於SpringBoot自動注入funcLink代理的HttpLink類

public interface HttpLink {

    Object link();

}

2、代理類代理介面方法

@FuncBean(link = "funcLink Bean Name")

添加類註解@FuncBean聲明這是一個匿名函數代理類

添加方法註解@FuncLambda聲明這是一個代理方法

如果有參數請加上參數註解@FuncParameter("參數名")

@Component
@FuncBean
public class FuncLinkHosting implements HttpLink {

    @Override
    @FuncLambda(classFile = HttpLink.class)
    public Map<String, String> link() {
        Map<String, String> map = new HashMap<>(10);
        map.put("GitHub", "//github.com/yiurhub");
        map.put("Gitee", "//gitee.com/yiur");
        map.put("部落格", "//www.cnblogs.com/yiur-bgy");
        return map;
    }

}

鬆散類型託管

開發使用不推薦，後續2.x估計廢用，可讀性不高

1、定義介面

添加類註解@Component，用於SpringBoot自動注入funcLink代理的HttpLink類，SpringBoot插件提升

@Component
public interface HttpLink {

    Object link();

}

2、代理類代理介面方法

@FuncBean(link = “funcLink Bean Name”)

鬆散類型託管需要注意的事項:

代理方法返回值與介面不一樣，介面返回值必須得是Object

添加類註解@FuncBean聲明這是一個匿名函數代理類

添加方法註解@FuncLambda聲明這是一個代理方法

如果有參數請加上參數註解@FuncParameter("參數名")

@FuncBean
public class FuncLinkHosting {

    @FuncLambda(classFile = HttpLink.class)
    public Map<String, String> link() {
        Map<String, String> map = new HashMap<>(10);
        map.put("GitHub", "//github.com/yiurhub");
        map.put("Gitee", "//gitee.com/yiur");
        map.put("部落格", "//www.cnblogs.com/yiur-bgy");
        return map;
    }

}

@FuncLogger

添加方法註解@FuncLogger開啟方法執行完後的輸出日誌，優先順序比配置文件高

@FuncLogger參數
name: 生成的日誌文件名，默認為func-link

suffix: 生成的日誌文件後綴名，默認為log

path: 生成的日誌文件存放絕對路徑路徑，默認當前項目下的log文件夾下

@FuncBean
public class FuncLinkHosting implements HttpLink {

    @Override
    @FuncLogger
    @FuncLambda(classFile = HttpLink.class)
    public Map<String, String> link() {
        Map<String, String> map = new HashMap<>(10);
        map.put("GitHub", "//github.com/yiurhub");
        map.put("Gitee", "//gitee.com/yiur");
        map.put("部落格", "//www.cnblogs.com/yiur-bgy");
        return map;
    }

}

FuncLink 返回message

應用

Logger 日誌功能鏈接，根據執行方法綁定的Bean或者ref，執行此功能

在綁定的方法中執行完後，則會輸出日誌，獲取執行的方法資訊

鏈接

FuncLogger

功能鏈接為: “${Bean Name}:log”

程式碼

@Configuration
@EnableFuncLambda("com.simple.web.lambda")
public class FuncLinkConfig {

    @Autowired
    public FuncLinkFactory funcLinkFactory;

    @Bean
    public FuncLink funcLink() {
        return funcLinkFactory.build()
                .<FuncLogger>setObject("httpLink:log", (set, log) -> "logger => ${methodName}\r\n");
    }

}

@FuncCallback 註解實現

添加方法註解@FuncCallback綁定方法執行後的回調函數

成功執行回調: then(T result)

失敗執行回調: error(Throwable e)

public class DefaultCallback implements FuncCallback {

    @Override
    public Object then(Object data) { return data; }

    @Override
    public Object error(Throwable error) {
        return error.getMessage();
    }

}

@FuncBean
public class FuncLinkHosting implements HttpLink {

    @Override
    @FuncCallback(DefaultCallback.class)
    @FuncLambda(classFile = HttpLink.class)
    public Map<String, String> link() {
        Map<String, String> map = new HashMap<>(10);
        map.put("GitHub", "//github.com/yiurhub");
        map.put("Gitee", "//gitee.com/yiur");
        map.put("部落格", "//www.cnblogs.com/yiur-bgy");
        return map;
    }

}

FuncLink Callback 實現

應用

Callback 方法執行完回調功能鏈接，根據執行方法綁定的Bean或者ref，執行此功能

在Web項目Service層中返回方法執行的結果，能做到服務熔斷操作

鏈接

FuncCallback<T, R>約束參數值和返回值，執行優先順序: 1

功能鏈接為: “${Bean Name}:callback”

FuncCallbackThen<T, R>約束參數值和返回值，執行優先順序: 2

功能鏈接為: “${Bean Name}:callback-then”

FuncCallbackError<R>約束返回值，執行優先順序: 2

功能鏈接為: “${Bean Name}:callback-error”

程式碼

@Configuration
@EnableFuncLambda("com.simple.web.lambda")
public class FuncLinkConfig {

    @Autowired
    public FuncLinkFactory funcLinkFactory;

    @Bean("simple")
    public FuncLink funcLink() {
        return funcLinkFactory.build()
                // httpLink
                .<FuncCallback<Map<String, String>, Object>>setObject("httpLink:callback", new FuncCallback<Map<String, String>, Object>() {
                    @Override
                    public Object then(Map<String, String> result) {
                        return result;
                    }

                    @Override
                    public Object error(Throwable throwable) {
                        return throwable;
                    }
                })
                .<FuncCallbackThen<Map<String, String>, Object>>setObject("httpLink:callback-then", result -> result)
                .<FuncCallbackError<Object>>setObject("httpLink:callback-error", throwable -> throwable);
    }

}

FuncLink Life 實現

應用

Life 方法執行前後回調功能鏈接，根據執行方法綁定的Bean或者ref，執行此功能

方法執行前會先執行start方法，用來檢查參數

方法執行後會執行end方法，用來檢查返回值

鏈接

FuncLife<T, R>約束參數值和返回值，執行優先順序: 1

功能鏈接為: “${Bean Name}:life”

FuncLifeStart約束參數值和返回值，執行優先順序: 2

功能鏈接為: “${Bean Name}:life-start”

FuncLifeEnd<T, R>約束返回值，執行優先順序: 2

功能鏈接為: “${Bean Name}:life-end”

程式碼

@Configuration
@EnableFuncLambda("com.simple.web.lambda")
public class FuncLinkConfig {

    @Autowired
    public FuncLinkFactory funcLinkFactory;

    @Bean("simple")
    public FuncLink funcLink() {
        return funcLinkFactory.build()
                // httpLink
                .<FuncLife<Object, Object>>setObject("httpLink:life", new FuncLife<Object, Object>() {
                    @Override
                    public Map<String, Object> start(Map<String, Object> args) {
                        return args;
                    }

                    @Override
                    public Object end(Object result) {
                        return result;
                    }
                })
                .<FuncLifeStart>setObject("httpLink:life-start", args -> args)
                .<FuncLifeEnd<Object, Object>>setObject("httpLink:life-end", result -> result);
    }

}

1.1.3.RELEASE 更新

func-spring-boot-starter-1.1.2.RELEASE 依賴

<!--func-->
<dependency>
    <groupId>io.github.yiurhub</groupId>
    <artifactId>func-spring-boot-starter</artifactId>
    <version>1.1.3.RELEASE</version>
</dependency>

添加匿名函數鏈接自定義實現功能

AbstractFuncLifePlugin

public class SimpleLifePlugin extends AbstractFuncLifePlugin {

    public SimpleLifePlugin() {
    }

    public SimpleLifePlugin(String beanName, String[] refs, FuncLink funcLink, FuncCallbackPlugin funcCallbackPlugin) {
        super(beanName, refs, funcLink, funcCallbackPlugin);
    }
    
}

AbstractFuncCallbackPlugin

public class SimpleCallbackPlugin extends AbstractFuncCallbackPlugin {

    public SimpleCallbackPlugin() {
    }

    public SimpleCallbackPlugin(String beanName, String[] refs, FuncLink funcLink, FuncProperties funcProperties, FuncLoggerPlugin funcLoggerPlugin) {
        super(beanName, refs, funcLink, funcProperties, funcLoggerPlugin);
    }
    
}

AbstractFuncLoggerPlugin

public class SimpleLoggerPlugin extends AbstractFuncLoggerPlugin {

    public SimpleLoggerPlugin() {
    }

    public SimpleLoggerPlugin(String beanName, String[] refs, FuncLink funcLink, FuncProperties funcProperties) {
        super(beanName, refs, funcLink, funcProperties);
    }
    
}

FuncLink 使用

@Configuration
@EnableFuncLambda("com.simple.web.lambda")
public class FuncLinkConfig {

    @Autowired
    public FuncLinkFactory funcLinkFactory;

    @Bean("simple")
    public FuncLink funcLink() {
        return funcLinkFactory.build()
                // httpLink
                .setObject("httpLink:FuncLifePlugin", SimpleLifePlugin.class)
                .setObject("httpLink:FuncCallbackPlugin", SimpleCallbackPlugin.class)
                .setObject("httpLink:FuncLoggerPlugin", SimpleLoggerPlugin.class)
    }

}

API更改

註解更改

@FuncConfiguration 改為 @FuncBean

@EnableLog 改為 @FuncLogger

CallbackClass 改為 @FuncCallback

Tags: JAVA spring springboot SpringMVC