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程序数据集帮助文档中的示例代码

plugin.xml

@@ -4,13 +4,12 @@
     <name><![CDATA[文档demo代码集成]]></name>
     <active>yes</active>
     <hidden>no</hidden>
-    <version>1.1.2</version>
+    <version>1.1.1</version>
     <env-version>10.0~</env-version>
     <jartime>2018-08-02</jartime>
     <vendor>finereport</vendor>
     <description><![CDATA[集成帮助文档中的demo代码]]></description>
     <change-notes><![CDATA[
-        [2023-11-28] 插件适配11<br>
         [2018-01-25] 发布。<br>
         [2018-08-02] 插件适配10
         ]]></change-notes>

pom.xml

@@ -3,10 +3,10 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.fr.plugin</groupId>
     <artifactId>starter</artifactId>
-    <version>11.0</version>
+    <version>10.0</version>
     <packaging>pom</packaging>
     <properties>
-        <common-version>11.0-RELEASE-SNAPSHOT</common-version>
+        <common-version>10.0-RELEASE-SNAPSHOT</common-version>
         <web-inf-bucket>${project.basedir}/webroot/WEB-INF</web-inf-bucket>
     </properties>
     <dependencies>
@@ -28,12 +28,6 @@
             <version>${common-version}</version>
             <scope>compile</scope>
         </dependency>
-        <dependency>
-            <groupId>com.fr.cbb</groupId>
-            <artifactId>fine-cbb</artifactId>
-            <version>${common-version}</version>
-            <scope>compile</scope>
-        </dependency>
         <dependency>
             <groupId>com.fr.webui</groupId>
             <artifactId>fine-webui</artifactId>

readme.md

@@ -19,7 +19,8 @@
 ## 修改依赖的jar版本
 只需要更改pom.xml中的common-version属性即可。
 
-| common-version        | 含义          |
-|-----------------------|-------------|
-| 11.0-RELEASE-SNAPSHOT | 11.0的测试版本快照 |
-| 11.0-PERSIST-SNAPSHOT | 11.0的正式版本快照 |
+|common-version|含义|
+|--------------|----|
+|10.0-RELEASE-SNAPSHOT|10.0的测试版本快照|
+|10.0-SNAPSHOT|10.0的正式版本快照|
+|10.0|10.0的正式版本|

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

@@ -10,8 +10,17 @@ 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 {
 
+    private static final int COLUMN_COUNT = 10;
+
     /**
      * 初始化列名数组
      *
@@ -20,8 +29,8 @@ public class WebServiceTableData extends SimpleTableData {
      */
     @Override
     public String[] initColumnNames() {
-        String[] columnNames = new String[10];
-        for (int i = 0; i < 10; i++) {
+        String[] columnNames = new String[COLUMN_COUNT];
+        for (int i = 0; i < COLUMN_COUNT; i++) {
             columnNames[i] = "column#" + i;
         }
         return columnNames;
@@ -35,7 +44,7 @@ public class WebServiceTableData extends SimpleTableData {
     @Override
     public List<Object[]> loadData() {
         String tableName = ((ParameterProvider) (parameters.get().toArray())[0]).getValue().toString();
-        FineLoggerFactory.getLogger().info("Query SQL of ParamTableDataDemo: \n" + tableName);
+        FineLoggerFactory.getLogger().info("Query SQL of ParamTableDataDemo: {}", tableName);
 
         // 保存得到的结果集
         ArrayList<Object[]> valueList = new ArrayList();
@@ -68,6 +77,11 @@ public class WebServiceTableData extends SimpleTableData {
         return valueList;
     }
 
+    /**
+     * 调用 Web 服务获取数据
+     *
+     * @return
+     */
     public String[][] createData() {
         try {
             String endpoint = "http://localhost:8080/axis/TestWS2TDClient.jws";

src/main/java/com/fr/demo/SimpleReportletDemoFrm.java

@@ -1,15 +1,16 @@
 package com.fr.demo;
 
+import java.util.Map;
+import javax.servlet.http.HttpServletRequest;
 
-import com.fr.form.main.DashboardTemplate;
 import com.fr.form.main.Form;
 import com.fr.form.main.FormIO;
 import com.fr.log.FineLoggerFactory;
 import com.fr.web.weblet.Formlet;
-import java.util.Map;
-import javax.servlet.http.HttpServletRequest;
+
 
 public class SimpleReportletDemoFrm extends Formlet {
+
     @Override
     public void setParameterMap(Map arg0) {
         // TODO Auto-generated method stub
@@ -17,20 +18,17 @@ public class SimpleReportletDemoFrm extends Formlet {
     }
 
     @Override
-    protected DashboardTemplate createDashboard(HttpServletRequest req) throws Exception {
+    protected Form createForm(HttpServletRequest request) throws Exception {
         Form form = null;
         //模板的相对路径
         String tplPath = "//doc//frm//决策报表入门.frm";
         this.setTplPath(tplPath);
-
         try {
             form = FormIO.readForm(tplPath);
         } catch (Exception e) {
             FineLoggerFactory.getLogger().error(e.getMessage(), e);
         }
-
         return form;
     }
 
-
 }

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) {
-
-        /**定义报表运行环境,用于执行报表*/
-        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\\";
-        SimpleWork.checkIn(envpath);
-        I18nResource.getInstance();
-        module.start();
-
+        /**
+         * 以下这段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 ReportBaseActivator(),
+                    new RestrictionActivator(),
+                    new ReportActivator(),
+                    new ChartBaseActivator());
+            SimpleWork.supply(CommonOperator.class, new CommonOperatorImpl());
+            //定义工程路径
+            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(),
-                new ConfigurationActivator(),
-                new ResourceRepositoryActivator(),
-                new StandaloneModeActivator(),
-                new ModuleHealActivator(),
-                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\\";//工程路径
-        SimpleWork.checkIn(envpath);
-        I18nResource.getInstance();
-        module.start();
+        /**
+         * 以下这段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 ReportBaseActivator(),
+                    new RestrictionActivator(),
+                    new ReportActivator(),
+                    new ChartBaseActivator());
+            SimpleWork.supply(CommonOperator.class, new CommonOperatorImpl());
+            //定义工程路径
+            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();
         }
     }
 }