Browse Source

统一命名规范

pull/1/head
richie 5 years ago
parent
commit
cabbc96078
  1. 9
      readme.md
  2. 2
      src/main/java/com/fanruan/api/data/TableDataKit.java
  3. 29
      src/main/java/com/fanruan/api/env/EnvKit.java
  4. 2
      src/main/java/com/fanruan/api/session/SessionKit.java
  5. 2
      src/test/java/com/fanruan/api/session/SessionFactoryTest.java

9
readme.md

@ -6,6 +6,7 @@
比如,要获取报表的会话信息,以前需要调用方法
```java
import com.fr.web.core.SessionPoolManager;
import org.jetbrains.annotations.NotNull;
SessionPoolManager#getSessionIDInfor(@NotNull String sessionID, Class<T> clazz);
```
@ -14,13 +15,17 @@ SessionPoolManager#getSessionIDInfor(@NotNull String sessionID, Class<T> clazz);
而如果采用可开发工具套件中的方法,则始终都是调用
```java
import com.fanruan.api.session.SessionFactory;
import com.fanruan.api.session.SessionKit;
import org.jetbrains.annotations.NotNull;
SessionFactory#getSession(@NotNull String sessionID);
SessionKit#getSession(@NotNull String sessionID);
```
仅仅只需要更新最新版本的开发套件工具包即可让老插件自然适配。
## 提交新API要求
* 所有的API方法的返回值和参数,仅允许使用基本类型或者接口类型。
* 所有的API方法均需要有单元测试覆盖。
* 所有的API方法均需要有javadoc文档说明。

2
src/main/java/com/fanruan/api/data/TableDataFactory.java → src/main/java/com/fanruan/api/data/TableDataKit.java

@ -13,7 +13,7 @@ import org.jetbrains.annotations.NotNull;
* Created by richie on 2019-08-09
* 数据集获取工具类
*/
public class TableDataFactory {
public class TableDataKit {
/**
* 根据名字获取数据集

29
src/main/java/com/fanruan/api/env/EnvKit.java vendored

@ -0,0 +1,29 @@
package com.fanruan.api.env;
import com.fr.workspace.WorkContext;
import com.fr.workspace.Workspace;
import com.fr.workspace.resource.WorkResource;
/**
* @author richie
* @version 10.0
* Created by richie on 2019-08-09
*/
public class EnvKit {
/**
* 获取当前的工作目录
* @return 工作目录
*/
public static Workspace getCurrent() {
return WorkContext.getCurrent();
}
/**
* 获取当前工作目录的资源读写对象
* @return 资源读写对象
*/
public static WorkResource getWorkResource() {
return WorkContext.getWorkResource();
}
}

2
src/main/java/com/fanruan/api/session/SessionFactory.java → src/main/java/com/fanruan/api/session/SessionKit.java

@ -9,7 +9,7 @@ import org.jetbrains.annotations.NotNull;
* @version 10.0
* Created by richie on 2019-08-09
*/
public class SessionFactory {
public class SessionKit {
/**
* 根据sessionID信息返回会话对象

2
src/test/java/com/fanruan/api/session/SessionFactoryTest.java

@ -13,6 +13,6 @@ public class SessionFactoryTest extends Prepare {
@Test
public void getSession() throws Exception {
Assert.assertNull(SessionFactory.getSession("abc"));
Assert.assertNull(SessionKit.getSession("abc"));
}
}
Loading…
Cancel
Save