Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

poi-tl:重构附件渲染策略以便后面可以支持更多类型附件 #929

Merged
merged 3 commits into from
Jan 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,48 +15,25 @@
*/
package com.deepoove.poi.data;

import java.io.File;
import java.io.InputStream;

import com.deepoove.poi.util.ByteUtils;

/**
* attachment file:docx or xlsx
*
* attachment file
*
* @author Sayi
*/
public class AttachmentRenderData implements RenderData {
public abstract class AttachmentRenderData implements RenderData {

private static final long serialVersionUID = 1L;

private byte[] attachment;
private AttachmentType fileType;
private PictureRenderData icon;

AttachmentRenderData() {
}

public AttachmentRenderData(File attachmentFile) {
this(ByteUtils.getLocalByteArray(attachmentFile));
}

public AttachmentRenderData(InputStream inputStream) {
this(ByteUtils.toByteArray(inputStream));
}

public AttachmentRenderData(byte[] input) {
this.attachment = input;
}

public byte[] getAttachment() {
return attachment;
}

public void setAttachment(byte[] attachment) {
this.attachment = attachment;
}
public abstract byte[] readAttachmentData();

public AttachmentType getFileType() {
if (null != fileType) {
return fileType;
}
setFileType(detectFileType());
return fileType;
}

Expand All @@ -72,4 +49,16 @@ public void setIcon(PictureRenderData icon) {
this.icon = icon;
}

protected String getFileSrc() {
return null;
}

protected AttachmentType detectFileType() {
AttachmentType type = AttachmentType.suggestFileType(getFileSrc());
if (null == type) {
type = AttachmentType.suggestFileType(readAttachmentData());
}
return type;
}

}
73 changes: 72 additions & 1 deletion poi-tl/src/main/java/com/deepoove/poi/data/AttachmentType.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,80 @@
*/
package com.deepoove.poi.data;

import static com.deepoove.poi.util.ByteUtils.startsWith;

/**
* @author Sayi
*/
public enum AttachmentType {
DOCX, XLSX;
DOCX(
new String[]{"504B0304", "DOCF11E0"},
"Word.Document.12",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document",
new String[]{".docx", ".doc"},
"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAAXNSR0IArs4c6QAABv5JREFUeF7tWwtQVFUY/i7vl5KVqfnAGHWXx6KA7ydkCSoiaIsgoYapoDA2YySBguazTGc0hEghEwUfmKhJYFmIjzE1lRFIMHzjIwSZTDNl9zTnLnu5S9I+WOAC+8/s7L3nnnvO/3/nP99/XpdBM4uTNLmXHJAYARJiBAkIJAD744QQJu+3vXM9m0M1pqkqsZcm21oCEtZYI0iIwlAxgFfV1dnqABBLkyXGyhYF4wAiFwOMSJ2hDT0XLABK9wUDJwYQKYwk1FC1raoNGC0OAOu+jNyZwFjEgIgIw4ga26qCBUAkTRGZQCaSM0TclK0qWAAcA5KJNsq1kbzXAZwt3jMvgGmnANS2I/lckAAMcnwdC6RuTepss5Z/R8uvEiwA2+J9mgyAs8V3UAsADAAIkQNoFzB4QHvvAoMdu+mNA+ZL3VXKEjwH6M1yAC/qTgYAWkMU0Oc4gHoBXwTvAYYoYAiDbWgcQN3Z1sYc1pamsLKgPxOU3a5G3q839En2DZalcxSwsTSDjZUp6L+1lRkKSu+rVNK9cwesjfTESzYWrIH0F5+cj6xjpSr5/D1EWBk+hkt7UP0EgTFZuFv5l7ABKNo9l1Ow9GYV/KMyVRQe7doLSdHeKmmphwqwfscvKmmR0wYibErdzO5EwS3MW/19sxhPK9HZA76O88FgJ0X4ePqsBt6Ru1BR/YRTPHRSfyx6d4iKIfkXbiJ8bY5K2qeRb8JnZB8uLeXARWxIP/O/AAgiCoRPdUNEwEBOUTp9pPFTKavCPeDn0U/FkPKKR5iwcDdqZHIuPWOlH1z6vsbdR206iuyTZcIHwF3cFduX+3KK0v6d+dNl7n7PGn842Xf+jyEBH3+LoqsP2HQLMxOcSpkJczNj9v7ZcxmmLt6Hq+XVwgeAkhpVXikpBwuwYaeif1MCzN44DSbGRvj7nxpYmptw+WIT8zgi7NOjEw6sl3LPzpfcQ0jcQbX9X98rQjqPBAvS32eNpPLjmWtYuP4H9ppPgBdK7sNV1IUzik+EHu522PyRF/csPbcIq1JPqgVAnxl0JkGqxJbYCRju0oPVhx8JQn37Y1GwggB35hQi2NuZ05lPhCETnBE9czj3LC45H/t43UifhjZUVqMAmOM3AB8EDWbLppHAPSSVveYze0xiHmZOlEBk9wr7jBLhuIgM9npF2BhM8azbIZsWsx+FZRVq7a7vsmpfUJOh/uqSxpMhDzc7bF5c58JvR2TgTsUjZK17B317vcxW6/dhJguAP89Q30V7UXb7IfhEea28Gn5RmSoRQptWaywI/Pc1BsCuqy1LdkqJWJeL0htVOJIQxCZRAhw4IxVBXk5YEjqCyxe18SiyT5WBzyGHjl9BdMLPGtkhiHGAUtPzabO5MPbF7nMouVmJhCiFV1B3pm5N4zyN90rZknURadmXkP9VCJe29ptTSMsubH0AJEWPx2jXnqziuaevsh5Ah7dUsvJKEZuUB2tLM5zcGgJTE0W8p0S4/fAlbF0ykTN41vJDOFt8V2MABLMmSEmQkiEVGgmu3amG11B79p6O+2nYo7JzxWQM6KcIh5QI03OKEBUylL1/+OdTjF+4C4+ePNMIAH1malQUoIpMHtMPq+d7sDrRSHCv8jF6d7Nl72evOIzTheXsdcx7IxDs7cTpfjD/CnxH92Xvj1+8hbA1zTcB4gPYaADq929l4ZQAPcN2cK0qHeuAZXNHcXVfvl4JcW9FaEzadx4Je85p3LBUacF0gQ5WZjiaGMwuaPBFSYDKNDdRV6R9Ujd3IARgak8gLfgsV6sFEEFFAWrgtvhJGFRvo0JJgEoA6NwhZ1MgOlqbqwBFCMHY+em4X/VYKw8Q1NZY/JxRCHjLQcUAPgEqH6Qu9cEQZ9Ul6Eu//4HA2CyNjacZBecBMyZKsHjGMBUj6MIHDXd8iQ0dgeledURIn2UcKcbKlBNaA6DVC2oy6zwUVpY7yrUnhjl3h20HC1BOoHwQ92U+G+74EjjOEUtnj1RJW5J0DPvzSvRpj1ZlNToKaFMbfxLT0dqMBav+Iqk25ekjb7MCoA+FlRxg2Bpr7+cDBBUG9eXampYjmDVBTRUWcr5WSYL6BLRVAiCYNUF9toQ2ZQluKKyN8vrIawDAcEKkDZ0Q0aVLGLpAMx2XJ0CFIE+L6+I1urxDQBLbMQDy5XI58hgXaYqoxui5mCGMiABiwkDEEPYDR8XmXwtIi382J5me2EkmN3VmiFxECBTgMISCUnfYpwmBaXEAGrJNMiXRXmZqKgGROzGgHiMXK/6h2CnRkwgWgBfZ5yhdZiZHd4kRiIQwxIUBHOj3hwR4Q1c8WhUADRnpHLSli0xGOGBAGPrxND0tYaMOmDYBQIPdaGqyWGai+JqcIcQF7Cf0jGK3tVaaE4B/Ac9myWiNuu1sAAAAAElFTkSuQmCC"),
XLSX(
new String[]{"504B0304", "DOCF11E0"},
"Excel.Sheet.12",
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
new String[]{".xlsx", ".xls"},
"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAAXNSR0IArs4c6QAABXFJREFUeF7tW3tQVFUc/u7dxQU1bPJZoBLQDIWwV0EqnRo0iLKEQEbyQVpjCgnGkDkRwWypNWpOBiNPS0GzUEHy1eAjBcEnfzQp5oROWWg6IiEUk+De25xloL3cu487tevZ7v7+2/O49/d953e/3zlnz2GgcmNowx9qCJ/wvaHxvLP8umcERBoiPdvQwTFGgeMFhmNY6CGAA+DppfEYdtpwusMZJDiFgDBD2IjuuzzHsqyeFwSOIUAZTLAE0KUJ4Aycn5HX6hme5xgGnADTqPopGU2XIUCfow/mGU3viPaOqh7ASCVg5dpSR0BgXqBu8M1hHCMInMAwHCAQoGRkvf4tWOoICMqKGD7Io4eMqt4EtleYQhwBlBoN4HK4yUawWQwEDmAediZYuXf5hPrka7Wabkf5cRco/Ca++jJ5vikLEAJ4sGcc9UKlz/XV+4LVsEq7KWq/76VqFgwE1RLA8GzE3llVZ90EqPUTcEeA+xNwa4BbBKnNAiey6zBEN0SU12dWx/f/nhOUhLlBL9ud99+tz8G5VvEWA9Ui6CaAtghInbZENtwECCg6WmIxFCP8JyNs/CTZ+sKjxRb7URcBAaP8UZW2U+Jwj7EH4e8/YRFI+euboR8bKqr/804XlpSl4lyL5W0/6gggCFYlfICZ3AsSsBsO5mFzfZmkPCr4GaxPWispzz9SgE21n1kVMGcshhSLoE6rw5ncExLHr9++gZj1MyTlX6Zsw2MPPSoqP/tTIxaXpYLnedcjgHhMtCBl2mKJ82sOrMP2U1/1l88Kj0du7HuSdqnlaThx6aTN9EVlBPR53ZBdi6G6oSIQTVcvYG5xcn+Z3OhvaSjHJzWf2gRPGpSmFMFrkHi3jeTyPiPzgJARFjeVpdF4seK/mwcQHSB6MNBW7MhCzfmDSAxPQE5stqi6vasdcXkJaO+6bRcBVIqguecVqV8g6MEgEZi6H48jfVsG5JS/jxy70AOgnoCJ4zhsWSRV8jlF80HC39zqmxuwdOsye7Gb2lFPAHHy46Q1iA6OEgHb1Vhl+gTM7cUNcfi1reX/R8DI+0bg8Ns1VoEVHytFwbdFisCTxjHTn4VWqxX1M1/MKBHAvoc4ZDGUEZ2OV59aKAvwZmcrotbFKAZPOlCdBs0RLX8uE8lT5lkESTThwrUfFJPgEgQEjgpAZdoOq+AIeEKCUnOJT2Db4jKE+IonIycvn8KTAeLF0co9q0HEUYlRnwXkprpXbv2Csvpy5MZJp8DT10bj1h9tdnNANQFjho1BzVv7JWCI2lc27sb2lHKM9h4tSY8kEuw1qglYGW9A7MSZIizX2n/D7II56PyrE4uefg3pUUslWN/Ymo6GZulqUo4UagkgEx8yARpoGw7lYfPx3j0BDavB18uqMPYBX1EzIojzSxbAyBttBgKViyFvL28Q4Rs/fJwIwM+tV0wLHXMjqZGkyIGWf3gjNtV9bpMAKtNgZkwGFkz9Z8nbh8KSyu9O3wn/kf4SsPOKX8H5q01WSaCOgKmPTEFBcr7E6eYbl5C4MUkWzIzQ5/FR4ipJ3aGmI1hescJ1CPDQeKBkYSEmjZ8ocfrN7Zk4drHWIhi5uQJpvHLPh9jVWGmxH1UiaGlLnHhvbWub1D/uHyFLHKnb+91+tPwuv0qkigCbiuWABm4CaPtnyAGDbPWRqo8A6tKgsyPATYATzgkq/mvMmVHgjgB3BDj+qKz7E1D7OcF98dWmY8L9Z4WpOi4f7LOa9dDccZTwCsbu0gOzD1zvJ8D8Raq8MGGL6cD0QN3g+1VyZcYWGeb1qrk0pYQU7h3OzzhIJdfm7CVGVRcn7SXFzxDp6d3TwTGsCq7O2ksKaaeay9NKSHFk278BpaKbbiHMt1QAAAAASUVORK5CYII="),
;

private final String[] fileMagics;
private final String programId;
private final String contentType;
private final String[] extensions;
private final String icon;

AttachmentType(String[] fileMagics, String programId, String contentType, String[] extensions, String icon) {
this.fileMagics = fileMagics;
this.programId = programId;
this.contentType = contentType;
this.extensions = extensions;
this.icon = icon;
}

public String programId() {
return programId;
}

public String contentType() {
return contentType;
}

public String[] extensions() {
return extensions;
}

public String ext() {
return extensions[0];
}

public String icon() {
return icon;
}

public static AttachmentType suggestFileType(byte[] bytes) {
for (AttachmentType type : values()) {
for (String magic : type.fileMagics) {
if (startsWith(bytes, magic.getBytes())) {
return type;
}
}
}
return null;
}

public static AttachmentType suggestFileType(String fileLocation) {
if (null == fileLocation) return null;
for (AttachmentType type : values()) {
for (String extension : type.extensions) {
if (fileLocation.endsWith(extension)) {
return type;
}
}
}
return null;
}
}
42 changes: 34 additions & 8 deletions poi-tl/src/main/java/com/deepoove/poi/data/Attachments.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/
package com.deepoove.poi.data;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

Expand All @@ -29,16 +28,36 @@

/**
* Factory method to create {@link AttachmentRenderData}
*
*
* @author Sayi
*
*/
public class Attachments {
private Attachments() {
}

public static AttachmentBuilder ofLocal(String src, AttachmentType fileType) {
return ofBytes(ByteUtils.getLocalByteArray(new File(src)), fileType);
public static AttachmentBuilder of(String src) {
if (src.startsWith("http")) {
return Attachments.ofUrl(src);
} else {
return Attachments.ofLocal(src);
}
}

public static AttachmentBuilder ofLocal(String path) {
return ofLocal(path, null);
}

public static AttachmentBuilder ofLocal(String path, AttachmentType fileType) {
return new AttachmentBuilder(new FileAttachmentRenderData(path, fileType));
}

public static AttachmentBuilder ofUrl(String url) {
return ofUrl(url, null);
}

public static AttachmentBuilder ofUrl(String url, AttachmentType fileType) {
return new AttachmentBuilder(new UrlAttachmentRenderData(url, fileType));
}

public static AttachmentBuilder ofWord(XWPFDocument src) {
Expand Down Expand Up @@ -69,8 +88,16 @@ public static AttachmentBuilder ofStream(InputStream inputStream, AttachmentType
return ofBytes(ByteUtils.toByteArray(inputStream), fileType);
}

public static AttachmentBuilder ofStream(InputStream inputStream) {
return ofBytes(ByteUtils.toByteArray(inputStream));
}

public static AttachmentBuilder ofBytes(byte[] bytes, AttachmentType fileType) {
return new AttachmentBuilder(bytes, fileType);
return new AttachmentBuilder(new ByteArrayAttachmentRenderData(bytes, fileType));
}

public static AttachmentBuilder ofBytes(byte[] bytes) {
return ofBytes(bytes, null);
}

/**
Expand All @@ -81,9 +108,8 @@ public static class AttachmentBuilder implements RenderDataBuilder<AttachmentRen

AttachmentRenderData data;

private AttachmentBuilder(byte[] bytes, AttachmentType fileType) {
data = new AttachmentRenderData(bytes);
data.setFileType(fileType);
private AttachmentBuilder(AttachmentRenderData data) {
this.data = data;
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*
* Copyright 2014-2021 Sayi
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.deepoove.poi.data;

public class ByteArrayAttachmentRenderData extends AttachmentRenderData {

private static final long serialVersionUID = 1L;

private byte[] bytes;

public ByteArrayAttachmentRenderData(byte[] bytes) {
this(bytes, null);
}

public ByteArrayAttachmentRenderData(byte[] bytes, AttachmentType fileType) {
this.bytes = bytes;
this.setFileType(fileType);
}

@Override
public byte[] readAttachmentData() {
return bytes;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
* Copyright 2014-2021 Sayi
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.deepoove.poi.data;

import java.io.File;

import com.deepoove.poi.util.ByteUtils;

public class FileAttachmentRenderData extends AttachmentRenderData {

private static final long serialVersionUID = 1L;

private String path;

public FileAttachmentRenderData(String path) {
this(path, null);
}

public FileAttachmentRenderData(String path, AttachmentType fileType) {
this.path = path;
this.setFileType(fileType);
}

@Override
protected String getFileSrc() {
return path;
}

@Override
public byte[] readAttachmentData() {
return ByteUtils.getLocalByteArray(new File(path));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* Copyright 2014-2021 Sayi
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.deepoove.poi.data;

import com.deepoove.poi.util.ByteUtils;

public class UrlAttachmentRenderData extends AttachmentRenderData {

private static final long serialVersionUID = 1L;

private String url;

public UrlAttachmentRenderData(String url) {
this(url, null);
}

public UrlAttachmentRenderData(String url, AttachmentType fileType) {
this.url = url;
this.setFileType(fileType);
}

@Override
protected String getFileSrc() {
return url;
}

@Override
public byte[] readAttachmentData() {
return ByteUtils.getUrlByteArray(url);
}
}
Loading