1 Star 1 Fork 0

Yiur / func-spring-boot-starter

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

func-spring-boot-starter 匿名函数托管

GitHub项目路径:

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

Gitee项目路径:

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

使用注意事项

推荐版本:

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

设计原理

image-20220331141812337

匿名函数特性

匿名函数链接配置

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操作

详细内容请看项目:

https://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", "https://github.com/yiurhub");
        map.put("Gitee", "https://gitee.com/yiur");
        map.put("博客", "https://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")

松散类型托管需要注意的事项:

  1. 代理方法返回值与接口不一样,接口返回值必须得是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", "https://github.com/yiurhub");
        map.put("Gitee", "https://gitee.com/yiur");
        map.put("博客", "https://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", "https://github.com/yiurhub");
        map.put("Gitee", "https://gitee.com/yiur");
        map.put("博客", "https://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", "https://github.com/yiurhub");
        map.put("Gitee", "https://gitee.com/yiur");
        map.put("博客", "https://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

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

匿名函数托管 匿名函数链接 服务熔断 基与SpringBoot2.6.x 展开 收起
Java
MulanPSL-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/yiur/func-spring-boot-starter.git
git@gitee.com:yiur/func-spring-boot-starter.git
yiur
func-spring-boot-starter
func-spring-boot-starter
main

搜索帮助