如何使用Java Commons-Imaging/Sanselan读写JPEG图片标签？

我帮你梳理下用Commons-Imaging（Sanselan的继任者）处理JPEG图片标签时可能踩的坑，以及正确的实现步骤——你贴的代码片段只到初始化部分，大概率是后续的元数据读取、标签添加和写入环节没做对，导致没效果。

先确认依赖（重要！） #

Sanselan已经被Apache Commons-Imaging替代，建议直接使用Commons-Imaging的最新稳定版本，Maven依赖如下：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-imaging</artifactId>
    <version>1.0-alpha3</version> <!-- 可替换为官网最新稳定版 -->
</dependency>

你的代码可能缺失的关键步骤 #

1. 正确读取原有元数据（避免覆盖原有标签） #

如果直接新建空的TiffOutputSet，会丢失图片原有的所有EXIF标签，正确做法是先读取原有元数据，再基于它修改：

try (FileInputStream fis = new FileInputStream(file)) {
    ImageParser parser = Imaging.getImageParserBySuffix("jpg");
    metadata = parser.getMetadata(fis, file.length());
    if (metadata instanceof JpegImageMetadata) {
        jpegMetadata = (JpegImageMetadata) metadata;
        exif = jpegMetadata.getExif();
        // 有原有EXIF则复用，无则新建空集合
        outputSet = exif != null ? exif.getOutputSet() : new TiffOutputSet();
    }
} catch (Exception e) {
    e.printStackTrace();
}

2. 正确添加ImageHistory标签 #

ImageHistory对应的EXIF标签ID是0x927C，属于ExifIFD目录，需要先获取该目录再添加标签：

// 获取或创建ExifIFD目录
TiffOutputDirectory exifDirectory = outputSet.getOrCreateExifDirectory();
// 添加自定义的ImageHistory内容
String historyText = "2024-05-20：通过Commons-Imaging添加修改记录";
exifDirectory.add(TiffTagConstants.TIFF_TAG_IMAGE_HISTORY, historyText);

3. 用库提供的方法写入元数据 #

不要自己手动操作文件流，使用Commons-Imaging的writeMetadata方法才能正确将标签嵌入JPEG：

dst = new File("output_tagged.jpg");
try (FileOutputStream fos = new FileOutputStream(dst)) {
    JpegImageParser jpegParser = new JpegImageParser();
    jpegParser.writeMetadata(file, fos, outputSet);
} catch (Exception e) {
    e.printStackTrace();
}

完整可运行示例代码 #

import org.apache.commons.imaging.ImageParser;
import org.apache.commons.imaging.Imaging;
import org.apache.commons.imaging.formats.jpeg.JpegImageMetadata;
import org.apache.commons.imaging.formats.jpeg.JpegImageParser;
import org.apache.commons.imaging.formats.tiff.TiffImageMetadata;
import org.apache.commons.imaging.formats.tiff.constants.TiffTagConstants;
import org.apache.commons.imaging.formats.tiff.write.TiffOutputDirectory;
import org.apache.commons.imaging.formats.tiff.write.TiffOutputSet;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

public class JpegTagEditor {
    public static void addImageHistoryTag(File file) {
        File outputFile = new File(file.getParent(), "tagged_" + file.getName());
        TiffOutputSet outputSet = null;

        try (InputStream inputStream = new FileInputStream(file)) {
            // 读取图片原有元数据
            ImageParser parser = Imaging.getImageParserBySuffix("jpg");
            var metadata = parser.getMetadata(inputStream, file.length());
            
            if (metadata instanceof JpegImageMetadata jpegMetadata) {
                TiffImageMetadata exifMetadata = jpegMetadata.getExif();
                // 基于原有EXIF创建输出集合，无则新建
                outputSet = exifMetadata != null ? exifMetadata.getOutputSet() : new TiffOutputSet();
            } else {
                // 图片无元数据时新建空集合
                outputSet = new TiffOutputSet();
            }

            // 添加ImageHistory标签
            TiffOutputDirectory exifDir = outputSet.getOrCreateExifDirectory();
            String historyContent = "图片修改记录：2024-05-20 使用Commons-Imaging添加标签";
            exifDir.add(TiffTagConstants.TIFF_TAG_IMAGE_HISTORY, historyContent);

            // 写入修改后的元数据到新文件
            try (OutputStream outputStream = new FileOutputStream(outputFile)) {
                JpegImageParser jpegParser = new JpegImageParser();
                jpegParser.writeMetadata(file, outputStream, outputSet);
            }

            System.out.println("标签添加成功，输出文件路径：" + outputFile.getAbsolutePath());

        } catch (Exception e) {
            System.err.println("处理JPEG标签时发生错误：");
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        addImageHistoryTag(new File("your_input.jpg"));
    }
}

常见问题排查 #

如果运行后还是没效果，检查这几点：

• 依赖版本是否正确：避免使用旧版Sanselan，优先用Commons-Imaging最新版
• 图片是否支持EXIF：有些压缩后的JPEG可能不含EXIF区域，此时新建的标签会被正确添加，但需要用专业工具（比如ExifTool）查看
• 是否覆盖了原有元数据：确保是基于原有元数据修改，而不是新建空集合直接写入
• 异常是否被吞掉：检查控制台的异常输出，看是否有文件权限、图片损坏等问题

内容的提问来源于stack exchange，提问作者Karmel Zaidan