应用接入指南

[TOC]

1. 导入模块接入流程

1.1 注册应用

• 登录政企通后台管理系统

>>系统地址<<

账户：super 密码：super

• 切换至政企通系统

• 新增应用配置

UFS配置中心 -> 应用配置

点击新增或者选择一个现有的应用配置点击克隆

• 填写应用信息

请保证填写的secKey唯一

• 添加(导入)模块配置

开发时填写本机地址，上线记得改成线上环境地址

请确保url能可以访问，且无任何权限认证

1.2 应用前端接入

• iframe接入(推荐)

iframe的url支持添加自定义参数，在UFS触发回调导入处理接口是会一并带上
还支持添加配置好的输入框的默认值，参数名称与‘输入框1Name’的配置项一样（如输入框1Name是title，则url后面加&title=titleDefValue）
输入框启用下拉框,示例：&title=SELECT@key1,value1,key2,value2,key3,value3

 <iframe id="ufsIframe"
          title="ufsIframe"
          src="https://ufs.eazytec-cloud.com/ufs/import/index?secKey=你配置的应用secKey&userId=用户ID&自定义参数1=自定义值1&输入框1Name=默认值"
          frameBorder="0"
          scrolling="no"·
          width="95%"
          height="300px"  />

• 弹框接入

window.open()...略

1.3 应用后端接入

• pom引入UFS依赖包

依赖包由jdk1.7编译

如果是非maven环境，请找我要完整的依赖包

   <dependency>
        <groupId>com.eazytec.middleware</groupId>
        <artifactId>ufs-core</artifactId>
        <version>1.1-SNAPSHOT</version>
    </dependency>

    <!--EFS 1.2以上版本 -->
     <dependency>
        <groupId>com.eazytec.efs</groupId>
        <artifactId>efs-sdk</artifactId>
        <version>1.2</version>
    </dependency>

• 编写导入处理接口

接口请求为Http POST,最好不配置mapping的method

导入过程为异步执行

userId,fileId,filePath,eventCode为固定的回调参数

返回统一为"success"

导入接口示例

    @RequestMapping(value = "/import"/*, method = RequestMethod.POST*/)
    @ResponseBody
    public String import(String userId,String fileId, String filePath, String eventCode, String 自定义参数1,String 输入框1Name){
        UfsOpenClient client = UfsOpenClient.init();
        String secKey = "ZQT-0002";
        client.asyncExecute(new UfsOpenClient.Handler() {
            @Override
            public OpenRequest execute() {
                OpenRequest request = null;
                try {
                    Long createTime = System.currentTimeMillis();
                    request = [你的导入逻辑]
                    LOGGER.info("接口处理时间: {}ms", System.currentTimeMillis() - createTime);

                } catch (Exception e) {
                    LOGGER.error("import error",e);
                    request = new OpenRequest();
                    request.setSuccess(false);
                    request.setMsg("服务器错误,error code:101");
                }
                request.setSecKey(secKey);
                request.setUserId(userId);
                request.setFileId(fileId);
                request.setEventCode(eventCode);
                return request;
            }
        });
        return "success";
    }

OpenRequest属性说明

你的导入逻辑

    public OpenRequest resolver(String filePath) throws Exception {
        OpenRequest openRequest = new OpenRequest();
        URL url = new URL(filePath);
        try (InputStream is = url.openStream()) {
            [获取导入文件并解析]
        }

        String resFileName = "导入结果.xlsx"; 
         [在本地生成导入结果文件]

        OpenRequest.UploadFile errorFile = openRequest.newFile();
        errorFile.setFileName(resFileName);
        errorFile.setFilePath(LOCAL_PATH + resFileName);
         openRequest.setSuccess(true);
        openRequest.setMsg("企业入园成功！");

        return openRequest;
    }

1.4 error code

1.5 开发环境联调

先在管理后台中配置测试用回调地址(如http://127.0.0.1/ufsImport/user)

后端导入处理接口必须支持HTTP GET(直接去除method的配置最好)

前端嵌入的iframe的src中增加参数 &ufsMode=test(如https://ufs.eazytec-cloud.com/ufs/import/index?secKey=ZQT-0001&ufsMode=test&userId=user123)

上传的文件名不得携带中文或特殊字符 否则会导致本地读取文件失败

上线后切记将ufsMode参数删除

若已接入spring security,务必将回调处理接口排除

  protected void configure(HttpSecurity http) throws Exception {
        http
                .authorizeRequests()
                .antMatchers("/ufs/import/**").permitAll();
  }