方磊
63bf89f824
|
4 years ago | |
|---|---|---|
| docs | ||
| gradle/wrapper | ||
| src | 4 years ago | |
| .gitignore | ||
| build.gradle | 5 years ago | |
| gradlew | ||
| gradlew.bat | ||
| readme.md | 4 years ago | |
| settings.gradle | ||
readme.md
帆软插件开发工具套件
作用简介
该套件在帆软工程类基础上做了二次封装，仅暴露接口，可以更好的兼容不同版本的非开放API。
比如，要获取报表的会话信息，以前需要调用方法
import com.fr.web.core.SessionPoolManager;
import org.jetbrains.annotations.NotNull;
SessionPoolManager#getSessionIDInfor(@NotNull String sessionID, Class<T> clazz);
但可能随着版本的变更，SessionPoolManager变更了一个名字，比如由SessionPoolManager改成了NewSessionPoolManager， 那么所有调用了该API的插件都无法使用，必须要重新修改插件中的该处代码并更新插件才行。
而如果采用可开发工具套件中的方法，则始终都是调用
import com.fanruan.api.session.SessionKit;
import org.jetbrains.annotations.NotNull;
SessionKit#getSession(@NotNull String sessionID);
仅仅只需要更新最新版本的开发套件工具包即可让老插件自然适配。
提交新API要求
-
所有的API方法的返回值和参数，仅允许使用JDK自带的类、接口类型、枚举类型、插件抽象类、注解或者使用了@Open标记的对象类型。
-
所有的API方法均需要有单元测试覆盖。
-
所有的API方法均需要有javadoc文档说明。
开放类列表见：非FineKit开放类
约定俗成的规范
开发接口文档
使用方法
生成运行时依赖jar包
先使用gradle打包，执行下面的命令（跳过单元测试）
gradle build -x test
会在target目录下获得一个形如finekit-10.0-20190815.jar名字jar包，直接作为插件依赖jar包即可。
生成javadoc文档
执行maven命令
gradle javadoc
即可在target/javadocs目录下获取到javadoc文档。
如何判断插件中调用的API需要增加到FineKit中
最简单的原则：
1、插件只使用了JDK自带的类、插件接口（包括抽象类）、枚举、以及使用了@Open注解标记的类；
2、插件只使用了包名前缀为com.fr.third的类；
3、插件只使用了包名前缀为com.fanruan.api之外的类；
如果违背了上述三个原则，则需要考虑将使用类加入FineKit中。
如何提交新的API
1、先访问https://code.fanruan.com并注册一个自己的账号；
2、然后将https://code.fanruan.com/fanruan/finekit fork到自己账户下；
3、克隆FineKit代码到本地，新增相关的API代码，并提交到自己的仓库；
4、提交Pull Request到FineKit主仓库，等待审核通过被合并即可。