项目需要对接业主自己的中台文档,目前只需要在线预览,
fileid 后端调用中台预览接口时所传的id,中台回调的时候会传回来,需要保存到数据库或者缓存
流程:
前端调用后端的在线预览接口 → 后端请求中台在线预览接口 → 中台调用后端回调接口(根据参数中的文件下载获取文件,所以回调中的这个文件地址是需要点击即可下载的地址)
在线预览接口根据文档提供的参数来请求地址,同时需要将文件存和对应id存起来,方便中台回调的时候获取到这个文件。
前端调用后端在线预览→后端请求中台预览接口返回预览参数→中台通过文件
1、准备文档
2、准备对接工具类
签名工具、文件后缀转换type工具、前对对接后端参数实体类、后端回调反参实体类
package org.jeecg.modules.wps.utils;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
/**
* @Description:
* @Auther: YY
* @Data:2024/12/31 13:45:35
*/
public class HMacUtils {
public static String HMACSHA256(String data, String key) throws Exception {
Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key = new SecretKeySpec(key.getBytes("UTF-8"), "HmacSHA256");
sha256_HMAC.init(secret_key);
byte[] array = sha256_HMAC.doFinal(data.getBytes("UTF-8"));
StringBuilder sb = new StringBuilder();
for (byte item : array) {
sb.append(Integer.toHexString((item & 0xFF) | 0x100).substring(1, 3));
}
return sb.toString();
}
/**
* 利用java原生的摘要实现SHA256加密
* @param str 加密后的报文
* @return
*/
public static String getSHA256StrJava(byte[] str){
MessageDigest messageDigest;
String encodeStr = "";
try {
messageDigest = MessageDigest.getInstance("SHA-256");
messageDigest.update(str);
encodeStr = byte2Hex(messageDigest.digest());
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
}
return encodeStr;
}
/**
* 将byte转为16进制
* @param bytes
* @return
*/
private static String byte2Hex(byte[] bytes){
StringBuffer stringBuffer = new StringBuffer();
String temp = null;
for (int i=0;i<bytes.length;i++){
temp = Integer.toHexString(bytes[i] & 0xFF);
if (temp.length()==1){
//1得到一位的进行补0操作
stringBuffer.append("0");
}
stringBuffer.append(temp);
}
return stringBuffer.toString();
}
}
package org.jeecg.modules.wps.utils;
/**
* @Description:
* @Auther: YY
* @Data:2025/1/3 10:10:30
*/
public class StrUtils {
public static String fileToType(String path){
int lastIndex = path.lastIndexOf('.');
if (lastIndex != -1) {
// 截取文件扩展名
String fileExtension = path.substring(lastIndex + 1);
switch (fileExtension){
case "doc":
case "dot":
case "wps":
case "wpt":
case "docx":
case "dotx":
case "docm":
case "dotm":
case "rtf":
case "txt":
case "mht":
case "mhtml":
case "htm":
case "html":
case "uot3":
return "w";
case "xls":
case "xlt":
case "et":
case "xlsx":
case "xltx":
case "csv":
case "xlsm":
case "xltm":
case "ett":
return "s";
case "ppt":
case "pptx":
case "pptm":
case "ppsx":
case "ppsm":
case "pps":
case "potx":
case "potm":
case "dpt":
case "dps":
case "pot":
return "p";
case "pdf":
case "ofd":
return "f";
}
}
return "x";
}
}
package org.jeecg.modules.wps.model;
import lombok.Data;
/**
* @Description:
* @Auther: YY
* @Data:2024/12/31 15:04:53
*/
@Data
public class PreviewParam {
private String fileName;
private String filePath;
private String userId;
private String realname;
}
package org.jeecg.modules.wps.model;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;
import org.jeecgframework.poi.excel.annotation.Excel;
import java.io.Serializable;
import java.util.Date;
/**
* @Description: wps_file_model
* @Author: jeecg-boot
* @Date: 2025-01-02
* @Version: V1.0
*/
@Data
@TableName("wps_file_model")
@Accessors(chain = true)
@EqualsAndHashCode(callSuper = false)
@ApiModel(value="wps_file_model对象", description="wps_file_model")
public class WpsFileModel implements Serializable {
private static final long serialVersionUID = 1L;
/**id*/
@TableId(type = IdType.ASSIGN_ID)
@ApiModelProperty(value = "id")
private String id;
/**文件名*/
@Excel(name = "文件名", width = 15)
@ApiModelProperty(value = "文件名")
private String name;
/**版本号*/
@Excel(name = "版本号", width = 15)
@ApiModelProperty(value = "版本号")
private Integer version;
/**文件大小*/
@Excel(name = "文件大小", width = 15)
@ApiModelProperty(value = "文件大小")
private Integer size;
/**创建人ID*/
@Excel(name = "创建人ID", width = 15)
@ApiModelProperty(value = "创建人ID")
private String creator;
/**修改人ID*/
@Excel(name = "修改人ID", width = 15)
@ApiModelProperty(value = "修改人ID")
private String modifier;
/**minio文件地址*/
@Excel(name = "minio文件地址", width = 15)
@ApiModelProperty(value = "minio文件地址")
private String downloadurl;
/**文件地址*/
@Excel(name = "文件地址", width = 15)
@ApiModelProperty(value = "文件地址")
private String filePath;
/**用户ID*/
@Excel(name = "用户ID", width = 15)
@ApiModelProperty(value = "用户ID")
private String userId;
/**用户名称*/
@Excel(name = "用户名称", width = 15)
@ApiModelProperty(value = "用户名称")
private String username;
/**用户权限*/
@Excel(name = "用户权限", width = 15)
@ApiModelProperty(value = "用户权限")
private String permission;
/**用户图象*/
@Excel(name = "用户图象", width = 15)
@ApiModelProperty(value = "用户图象")
private String avatarurl;
/**创建时间*/
@Excel(name = "创建时间", width = 15)
@ApiModelProperty(value = "创建时间")
private Date createTime;
/**修改时间*/
@Excel(name = "修改时间", width = 15)
@ApiModelProperty(value = "修改时间")
private Date modifyTime;
/**普通预览模式下可限制预览页数*/
@Excel(name = "普通预览模式下可限制预览页数", width = 15)
@ApiModelProperty(value = "普通预览模式下可限制预览页数")
private int previewPages;
}
3、编写前端调用在线预览接口、中台调用后端回调接口(无token拦截)
package org.jeecg.modules.wps;
import cn.hutool.core.util.StrUtil;
import cn.hutool.http.HttpUtil;
import com.alibaba.fastjson.JSONException;
import com.alibaba.fastjson.JSONObject;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.IdWorker;
import com.mchange.v2.log.log4j.Log4jMLog;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import org.jeecg.common.api.vo.Result;
import org.jeecg.common.util.MinioUtil;
import org.jeecg.modules.wps.model.PreviewParam;
import org.jeecg.modules.wps.model.WpsFileModel;
import org.jeecg.modules.wps.service.IWpsFileModelService;
import org.jeecg.modules.wps.utils.HMacUtils;
import org.jeecg.modules.wps.utils.StrUtils;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.net.URL;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.*;
/**
* @Description:
* @Auther: YY
* @Data:2024/12/31 10:38:19
*/
@RestController
public class WpsController {
@Resource
private IWpsFileModelService wpsFileModelService;
private final String host = "http://部署的中台ip/open";
private final String accessKey = "ak";
private final String secretKey = "sk";
@RequestMapping(value="/v1/3rd/file/info", method = RequestMethod.GET)
@ResponseBody
@ApiModelProperty("WPS回调")
public Object fileInfo(HttpServletRequest request) throws Exception {
String fileid = request.getHeader("X-Weboffice-File-Id");
JSONObject jsonObject = new JSONObject();
JSONObject file = new JSONObject();
JSONObject user = new JSONObject();
try {
//根据id获取文件信息
WpsFileModel fileModel = wpsFileModelService.getById(fileid);
if(fileModel != null) {
//解析文件地址 转为 minio地址
String filePath = new URL(fileModel.getFilePath()).getPath();
int firstIndex = filePath.indexOf("/");
int secondeIndex = filePath.indexOf("/",firstIndex+1);
String bucketName = filePath.substring(firstIndex+1,secondeIndex);
String objectName = filePath.substring(secondeIndex+1);
String url = MinioUtil.getUrl(bucketName, objectName, 60);
Long size = MinioUtil.getFileSize(bucketName, objectName, 60);
// TODO: 文件信息
file.put("id", fileid); //文件id,字符串长度不超过64位
file.put("name", fileModel.getName()); //文件名必须带后缀
file.put("version", fileModel.getVersion()); //文档版本号,从1开始累加,位数小于11
file.put("size", size); //文档大小,单位为字节;此处需传文件真实大小,否则会出现异常
file.put("creator", fileModel.getCreator()); //创建者id,字符串长度不超过32位。与user里的id一致。
file.put("create_time", fileModel.getCreateTime().getTime() / 1000); //创建时间,时间戳,单位为秒。
file.put("modifier", fileModel.getModifier()); //修改者id,字符串长度不超过32位
file.put("modify_time", fileModel.getModifyTime().getTime() / 1000); //最近修改时间,时间戳,单位为秒。
file.put("download_url", url); //文档下载地址
file.put("preview_pages", fileModel.getPreviewPages()); //普通预览模式下可限制预览页数(不超过5000)
jsonObject.put("file", file);
// TODO: 用户信息
user.put("id", fileModel.getUserId()); //用户id,长度不超过32位,与creator、modifier一致
user.put("name", fileModel.getUsername()); //用户名称
user.put("permission", fileModel.getPermission()); //用户操作权限,预览固定为read
jsonObject.put("user", user);
}
} catch (JSONException e) {
e.printStackTrace();
}
Log4jMLog.info("WPS回调结果:" + jsonObject.toString());
return jsonObject.toString();
}
@RequestMapping(value = "/onlinePreview", method = RequestMethod.GET)
@ResponseBody
@ApiModelProperty("在线预览")
public Result onlineEditing(@RequestBody PreviewParam param) throws Exception {
//根据前端传的地址,保存再数据库
if(StrUtil.isBlank(param.getFilePath())){
return Result.error("文件地址为空,请检查!!!");
}
//根据地址和用户id查询文件是否存在
LambdaQueryWrapper<WpsFileModel> fileModelLambdaQueryWrapper = new LambdaQueryWrapper<>();
fileModelLambdaQueryWrapper.eq(WpsFileModel::getUserId,param.getUserId());
fileModelLambdaQueryWrapper.eq(WpsFileModel::getFilePath,param.getFilePath());
fileModelLambdaQueryWrapper.orderByDesc(WpsFileModel::getCreateTime);
fileModelLambdaQueryWrapper.last("limit 1");
WpsFileModel wpsFileModel = wpsFileModelService.getOne(fileModelLambdaQueryWrapper);
if(wpsFileModel == null){
//如果为空 创建一个文件 存储
wpsFileModel = new WpsFileModel();
wpsFileModel.setId(IdWorker.get32UUID());
wpsFileModel.setName(param.getFileName());
wpsFileModel.setFilePath(param.getFilePath());
wpsFileModel.setUserId(param.getUserId());
wpsFileModel.setUsername(param.getRealname());
wpsFileModel.setCreator(param.getUserId());
wpsFileModel.setModifier(param.getUserId());
wpsFileModel.setPermission("read");
wpsFileModel.setCreateTime(new Date());
wpsFileModel.setModifyTime(new Date());
wpsFileModel.setPreviewPages(0);
wpsFileModelService.save(wpsFileModel);
}else {
wpsFileModel.setPermission("read");
wpsFileModel.setModifyTime(new Date());
wpsFileModelService.updateById(wpsFileModel);
}
//查看文件类型 找到文件地址后缀
String type = StrUtils.fileToType(param.getFilePath());
//wps预览地址
StringBuilder builder = new StringBuilder();
String url = builder.append("/api/preview/v1/files/")
.append(wpsFileModel.getId()).append("/link")
.append("?")
.append("type=" + type)
.toString();
//时间
DateFormat dateFormat = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss 'GMT'", Locale.US);
dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
String date = dateFormat.format(new Date());
//请求类型
String contentType = "application/json";
byte[] body = new byte[]{};
String sha256body;
//body为空则为空,否则返回sha256(body)
if (body.length > 0) {
sha256body = HMacUtils.getSHA256StrJava(body);
} else {
sha256body = "";
}
//签名
String signature = HMacUtils.HMACSHA256("WPS-4" + "GET" + url
+ "application/json" + date + sha256body,secretKey);
Log4jMLog.info("签名:" + signature);
//请求头部
Map<String, String> headers = new HashMap<>();
headers.put("Wps-Docs-Authorization", String.format("WPS-4 %s:%s",accessKey, signature));
headers.put("Content-Type", contentType);
headers.put("Wps-Docs-Date", date);
Log4jMLog.info("请求地址:" + host.concat(url));
Log4jMLog.info("请求头部:" + headers.toString());
String result = HttpUtil.createGet(host.concat(url)).addHeaders(headers).execute().body();
Log4jMLog.info("返回结果:" + result);
JSONObject resultObj = JSONObject.parseObject(result);
return Result.ok(resultObj);
}
}