Pull request #69: REPORT-113769 修改WebService程序数据集帮助文档中的示例代码

Merge in PG/plugin-report-doc-demo from ~ROGER.CHEN/plugin-report-doc-demo:release/10.0 to release/10.0

* commit '4c97624bdcd15c897c2348173b0d33a156f39d5d':
  修复代码问题
  REPORT-113769 修改WebService程序数据集帮助文档中的示例代码

src/main/java/com/fr/data/WebServiceTableData.java

@@ -1,38 +1,87 @@
 package com.fr.data;
 
-import javax.xml.namespace.QName;
+import com.fr.general.data.TableDataException;
+import com.fr.log.FineLoggerFactory;
+import com.fr.stable.ParameterProvider;
 import org.apache.axis.client.Call;
 import org.apache.axis.client.Service;
-import com.fr.data.AbstractTableData;
-import com.fr.general.data.TableDataException;
 
-public class WebServiceTableData extends AbstractTableData{
-    private String[][] data;
+import javax.xml.namespace.QName;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * WebService程序数据集
+ *
+ * @author Roger
+ * @since 11.0
+ * Created on 2024/1/8
+ */
+public class WebServiceTableData extends SimpleTableData {
 
-    public WebServiceTableData() {
-        this.data = this.createData();
-    }
+    private static final int COLUMN_COUNT = 10;
 
-    //获取列数
-    public int getColumnCount() throws TableDataException {
-        return data[0].length;
+    /**
+     * 初始化列名数组
+     *
+     * @return {col1,col2,col3...}
+     * @throws TableDataException
+     */
+    @Override
+    public String[] initColumnNames() {
+        String[] columnNames = new String[COLUMN_COUNT];
+        for (int i = 0; i < COLUMN_COUNT; i++) {
+            columnNames[i] = "column#" + i;
         }
-
-    //获取列的名称为数组中第一行的值
-    public String getColumnName(int columnIndex) throws TableDataException {
-        return data[0][columnIndex];
+        return columnNames;
     }
 
-    //获取行数为数据的长度-1
-    public int getRowCount() throws TableDataException {
-        return data.length - 1;
+    /**
+     * 加载数据
+     *
+     * @return 行列数据
+     */
+    @Override
+    public List<Object[]> loadData() {
+        String tableName = ((ParameterProvider) (parameters.get().toArray())[0]).getValue().toString();
+        FineLoggerFactory.getLogger().info("Query SQL of ParamTableDataDemo: {}", tableName);
+
+        // 保存得到的结果集
+        ArrayList<Object[]> valueList = new ArrayList();
+
+        try {
+            // 调用 Web 服务获取数据
+            String[][] data = createData();
+
+            // 如果数据为空，直接返回空列表
+            if (data == null || data.length == 0) {
+                return valueList;
             }
 
-    //获取值
-    public Object getValueAt(int rowIndex, int columnIndex) {
-        return data[rowIndex + 1][columnIndex];
+            // 获得总列数
+            int colNum = data[0].length;
+
+            // 用对象保存数据
+            Object[] objArray = null;
+            for (int rowIndex = 1; rowIndex < data.length; rowIndex++) {
+                objArray = new Object[colNum];
+                for (int i = 0; i < colNum; i++) {
+                    objArray[i] = data[rowIndex][i];
+                }
+                // 在valueList中加入这一行数据
+                valueList.add(objArray);
+            }
+        } catch (Exception e) {
+            FineLoggerFactory.getLogger().error(e.getMessage(), e);
+        }
+        return valueList;
     }
 
+    /**
+     * 调用 Web 服务获取数据
+     *
+     * @return
+     */
     public String[][] createData() {
         try {
             String endpoint = "http://localhost:8080/axis/TestWS2TDClient.jws";

src/main/java/com/fr/function/ReportCheck.java

@@ -1,23 +1,35 @@
+// 自定义函数实现表间校验  
 package com.fr.function;
 
 import com.fr.base.ResultFormula;
+import com.fr.base.operator.common.CommonOperator;
+import com.fr.chart.activator.ChartBaseActivator;
+import com.fr.config.activator.BaseDBActivator;
+import com.fr.config.activator.ConfigurationActivator;
+import com.fr.env.operator.CommonOperatorImpl;
 import com.fr.io.TemplateWorkBookIO;
 import com.fr.json.JSONArray;
 import com.fr.json.JSONObject;
 import com.fr.main.impl.WorkBook;
 import com.fr.main.workbook.ResultWorkBook;
+import com.fr.module.Module;
+import com.fr.module.tool.ActivatorToolBox;
+import com.fr.report.ReportActivator;
+import com.fr.report.RestrictionActivator;
 import com.fr.report.cell.CellElement;
+import com.fr.report.module.ReportBaseActivator;
 import com.fr.report.report.ResultReport;
 import com.fr.script.AbstractFunction;
 import com.fr.stable.WriteActor;
+import com.fr.store.StateServiceActivator;
+import com.fr.workspace.simple.SimpleWork;
 import com.fr.write.cal.WB;
 
 import java.util.HashMap;
-import java.util.Map;
 
 public class ReportCheck extends AbstractFunction {
+    private static HashMap wMap = new HashMap();
 
-    private static final Map<String, TpObj> wMap = new HashMap<>();
     public Object run(Object[] args) {
         // 获取公式中的参数  
         String cptname = args[0].toString(); // 获取报表名称  
@@ -25,7 +37,18 @@ public class ReportCheck extends AbstractFunction {
         int rownumber = Integer.parseInt(args[3].toString()); // 所取单元格所在行  
         // 定义返回的值  
         Object returnValue = null;
-
+        // 定义报表运行环境,用于执行报表
+        Module module = ActivatorToolBox.simpleLink(new BaseDBActivator(),
+                new ConfigurationActivator(),
+                new StateServiceActivator(),
+                new ReportBaseActivator(),
+                new RestrictionActivator(),
+                new ReportActivator(),
+                new ChartBaseActivator());
+        SimpleWork.supply(CommonOperator.class, new CommonOperatorImpl());
+        String envpath= "//Applications//FineReport10_325//webapps//webroot//WEB-INF"; //工程路径
+        SimpleWork.checkIn(envpath);
+        module.start();
         try {
             ResultWorkBook rworkbook = null;
             // 读取模板
@@ -33,23 +56,25 @@ public class ReportCheck extends AbstractFunction {
                     .readTemplateWorkBook(cptname);
             // 获取需要传递给报表的参数名与参数值，格式如[{"name":para1name,"value":para1value},{"name":para2name,"value":para2value},......]  
             JSONArray parasArray = new JSONArray(args[1].toString());
-            // 需要判断是否是8秒内执行过的
-
-            TpObj tempWObj = wMap.get(cptname + parasArray);
+            // 需要判断是否是5秒内执行过的  
+            // 取出保存的resultworkbook;  
+            Object tempWObj = wMap.get(cptname + parasArray.toString());
             if (tempWObj != null) {
+                // 取出hashmap里面保存的TpObj;  
+                TpObj curTpObj = (TpObj) tempWObj;
 
-                if ((System.currentTimeMillis() - tempWObj.getExeTime()) < 8000) {
-                    rworkbook = tempWObj.getRworkbook();
+                if ((System.currentTimeMillis() - curTpObj.getExeTime()) < 8000) {
+                    rworkbook = curTpObj.getRworkbook();
                 } else {
-                    wMap.remove(cptname + parasArray);
+                    wMap.remove(cptname + parasArray.toString());
                 }
             }
             // 如果没有设置，需要生成  
             if (rworkbook == null) {
-                JSONObject jo;
+                JSONObject jo = new JSONObject();
                 // 定义报表执行时使用的paraMap,保存参数名与值  
-                Map parameterMap = new HashMap<>();
-                if (!parasArray.isEmpty()) {
+                java.util.Map parameterMap = new java.util.HashMap();
+                if (parasArray.length() > 0) {
                     for (int i = 0; i < parasArray.length(); i++) {
                         jo = parasArray.getJSONObject(i);
                         parameterMap.put(jo.get("name"), jo.get("value"));
@@ -58,7 +83,7 @@ public class ReportCheck extends AbstractFunction {
                 // 执行报表  
                 rworkbook = workbook.execute(parameterMap, new WriteActor());
                 // 保存下来  
-                wMap.put(cptname + parasArray, new TpObj(rworkbook,
+                wMap.put(cptname + parasArray.toString(), new TpObj(rworkbook,
                         System.currentTimeMillis()));
             }
             // 获取报表结果中对应Cell的值  
@@ -73,24 +98,31 @@ public class ReportCheck extends AbstractFunction {
         }
         return returnValue;
     }
-    static class TpObj {
+
+    class TpObj {
         private ResultWorkBook rworkbook = null;
         private long exeTime = System.currentTimeMillis();
+
         public TpObj(ResultWorkBook rworkbook, long exeTime) {
             this.setRworkbook(rworkbook);
             this.setExeTime(exeTime);
         }
+
         public ResultWorkBook getRworkbook() {
             return rworkbook;
         }
+
         public void setRworkbook(ResultWorkBook rworkbook) {
             this.rworkbook = rworkbook;
         }
+
         public long getExeTime() {
             return exeTime;
         }
+
         public void setExeTime(long exeTime) {
             this.exeTime = exeTime;
         }
     }
+
 }

src/main/java/com/fr/io/ExportApi.java

@@ -18,12 +18,11 @@ import com.fr.io.exporter.TextExporter;
 import com.fr.io.exporter.WordExporter;
 import com.fr.io.exporter.excel.stream.StreamExcel2007Exporter;
 import com.fr.main.impl.WorkBook;
+import com.fr.module.ModuleRole;
 import com.fr.module.tool.ActivatorToolBox;
 import com.fr.report.ReportActivator;
 import com.fr.report.RestrictionActivator;
 import com.fr.report.module.ReportBaseActivator;
-import com.fr.report.write.WriteActivator;
-import com.fr.scheduler.SchedulerActivator;
 import com.fr.stable.WriteActor;
 import com.fr.store.StateServiceActivator;
 import com.fr.workspace.simple.SimpleWork;
@@ -32,32 +31,39 @@ import java.io.FileOutputStream;
 import java.util.HashMap;
 import java.util.Map;
 
-
 public class ExportApi {
 
     public static void main(String[] args) {
-
+        /**
+         * 以下这段if判断仅在main函数测试时使用，
+         * 实际生产环境中一般使用web容器，集成帆软后帆软服务会自动启动，不再需要下面的if判断，直接写导出的业务逻辑即可。
+         * web集成注意事项：
+         * 1、集成环境需要依赖【当前使用jdk对应版本的】tools.jar，一般从jdk中直接复制即可;
+         * 2、帆软服务自动启动成功后，使用的工作目录自动识别为集成应用下的WEB-INF目录，所以需要把下面代码中envpath指向的工作目录拷贝到集成环境下web应用的WEB-INF目录
+         *   （正式发布时需要拷贝生产环境的帆软WEB-INF，如果有的话），这样才能沿用原先帆软的配置及模板。如果是集群环境，会自动使用文件服务器的模板。本地测试时envpath需要指向【单机非集群】的帆软工程
+         * 3、可以访问集成环境的地址： ip:port/应用名/decision 。如果能成功访问且不需要初始化配置则代表帆软服务启动成功
+         */
+        if (!ModuleRole.Root.isPresent()) {
             /**定义报表运行环境,用于执行报表*/
-        com.fr.module.Module module = ActivatorToolBox.simpleLink(new BaseDBActivator(),
+            com.fr.module.Module module = ActivatorToolBox.simpleLink(
+                    new BaseDBActivator(),
                     new ConfigurationActivator(),
                     new ResourceRepositoryActivator(),
                     new StandaloneModeActivator(),
                     new ModuleHealActivator(),
                     //2020.4.26jar包之前的版本，替换成StateServerActivator()
                     new StateServiceActivator(),
-                new SchedulerActivator(),
                     new ReportBaseActivator(),
                     new RestrictionActivator(),
                     new ReportActivator(),
-                new WriteActivator(),
                     new ChartBaseActivator());
             SimpleWork.supply(CommonOperator.class, new CommonOperatorImpl());
             //定义工程路径
-        String envpath = "D:\\javatools\\FineReport_10.0\\webapps\\webroot\\WEB-INF\\";
+            String envpath = "D:\\FineReport_11.0\\webapps\\webroot\\WEB-INF\\";
             SimpleWork.checkIn(envpath);
             I18nResource.getInstance();
             module.start();
-
+        }
         /**输出模板*/
         try {
             // 定义输出的模板路径，以reportlets为根目录
@@ -121,11 +127,8 @@ public class ExportApi {
             ImageExport.export(outputStream, workbook.execute(parameterMap, new WriteActor()));
 
             outputStream.close();
-            module.stop();
         } catch (Exception e) {
             e.printStackTrace();
-        } finally {
-            SimpleWork.checkOut();
         }
     }
 

src/main/java/com/fr/io/ExportApi_frm.java

@@ -13,13 +13,11 @@ import com.fr.io.exporter.ImageExporter;
 import com.fr.io.exporter.PDFExporter;
 import com.fr.io.exporter.excel.stream.StreamExcel2007Exporter;
 import com.fr.main.workbook.ResultWorkBook;
-import com.fr.module.Module;
+import com.fr.module.ModuleRole;
 import com.fr.module.tool.ActivatorToolBox;
 import com.fr.report.ReportActivator;
 import com.fr.report.RestrictionActivator;
 import com.fr.report.module.ReportBaseActivator;
-import com.fr.report.write.WriteActivator;
-import com.fr.scheduler.SchedulerActivator;
 import com.fr.store.StateServiceActivator;
 import com.fr.workspace.simple.SimpleWork;
 
@@ -27,25 +25,38 @@ import java.io.File;
 import java.io.FileOutputStream;
 
 public class ExportApi_frm {
+
     public static void main(String[] args) {
-        // 定义报表运行环境,用于执行报表
-        Module module = ActivatorToolBox.simpleLink(new BaseDBActivator(),
+        /**
+         * 以下这段if判断仅在main函数测试时使用，
+         * 实际生产环境中一般使用web容器，集成帆软后帆软服务会自动启动，不再需要下面的if判断，直接写导出的业务逻辑即可。
+         * web集成注意事项：
+         * 1、集成环境需要依赖【当前使用jdk对应版本的】tools.jar，一般从jdk中直接复制即可;
+         * 2、帆软服务自动启动成功后，使用的工作目录自动识别为集成应用下的WEB-INF目录，所以需要把下面代码中envpath指向的工作目录拷贝到集成环境下web应用的WEB-INF目录
+         *   （正式发布时需要拷贝生产环境的帆软WEB-INF，如果有的话），这样才能沿用原先帆软的配置及模板。如果是集群环境，会自动使用文件服务器的模板。本地测试时envpath需要指向【单机非集群】的帆软工程
+         * 3、可以访问集成环境的地址： ip:port/应用名/decision 。如果能成功访问且不需要初始化配置则代表帆软服务启动成功
+         */
+        if (!ModuleRole.Root.isPresent()) {
+            /**定义报表运行环境,用于执行报表*/
+            com.fr.module.Module module = ActivatorToolBox.simpleLink(
+                    new BaseDBActivator(),
                     new ConfigurationActivator(),
                     new ResourceRepositoryActivator(),
                     new StandaloneModeActivator(),
                     new ModuleHealActivator(),
+                    //2020.4.26jar包之前的版本，替换成StateServerActivator()
                     new StateServiceActivator(),
-                new SchedulerActivator(),
                     new ReportBaseActivator(),
                     new RestrictionActivator(),
                     new ReportActivator(),
-                new WriteActivator(),
                     new ChartBaseActivator());
             SimpleWork.supply(CommonOperator.class, new CommonOperatorImpl());
-        String envpath = "C:\\Users\\hipsh\\Desktop\\apache-tomcat-8.5.38-10.0\\webapps\\webroot\\WEB-INF\\";//工程路径
+            //定义工程路径
+            String envpath = "D:\\FineReport_11.0\\webapps\\webroot\\WEB-INF\\";
             SimpleWork.checkIn(envpath);
             I18nResource.getInstance();
             module.start();
+        }
         try {
   
             java.util.Map parameterMap = new java.util.HashMap();
@@ -66,11 +77,8 @@ public class ExportApi_frm {
             ImageExporter ImageExport = new ImageExporter();
             ImageExport.export(outputStream, re);
             outputStream.close();
-            module.stop();
         } catch (Exception e) {
             e.printStackTrace();
-        } finally {
-            SimpleWork.checkOut();
         }
     }
 }