Java语言为excel添加水印,使用原生POI, (XSSFWorkbook, XSSFSheet), 真正背景图水印效果,非普通图片张贴

前言

首先致敬以下我参考的博客 https://www.jianshu.com/p/4332f5feab2e
最近接到一个所谓给导出文件excel加水印的需求,但是一番搜索百度之后意识到一个现实:excel没有水印的概念,强行要加水印的话只能是给文件加图片,但是加图片有两种:

  • 往表格里贴透明图片,这个很智障,会严重干扰正常阅读和操作
  • 设置文件背景图;
    接下来就比较明了了,其实就是给excel加一个背景图,但是问题就麻烦在java中基本没有这么干过的,可用方案很少,有spire公司提供的方案,但是这是一个授权付费方案,团队应该是不愿为这个小需求付钱的。最终还是考虑使用poi原生支持
    但是poi原生也只能是XSSFWorkbook这种实现能够支持,如果项目是用别的实现生成excel的话,需要改写组装excel文件内容这部分代码,使用xssfworkbook, xssfsheet。
  • 具体的背景图添加也有两种方案(不同的poi版本依赖有些区别),说到这里,贴一下用到的两组不同依赖。
  •  
     	org.apache.poi
     	poi
     	3.8
     
     
     	org.apache.poi
     	poi-ooxml
     	3.8
     
     
         org.apache.poi
         ooxml-schemas
         1.0
     
    

这种方式对应的背景图加载方法为

	public static void setWaterMarkToExcel2(XSSFWorkbook workbook, BufferedImage bfi) throws Exception {
		ByteArrayOutputStream byteArrayOut = new ByteArrayOutputStream();
		ImageIO.write(bfi, "png", byteArrayOut);
		int pictureIdx = workbook.addPicture(byteArrayOut.toByteArray(), Workbook.PICTURE_TYPE_PNG);
		//add relation from sheet to the picture data
		POIXMLDocumentPart poixmlDocumentPart = workbook.getAllPictures().get(pictureIdx);
		for (int i = 0; i < workbook.getNumberOfSheets(); i++) {
			XSSFSheet xssfSheet = workbook.getSheetAt(i);
			PackagePartName ppn = poixmlDocumentPart.getPackagePart().getPartName();
			String relType = XSSFRelation.IMAGES.getRelation();
			PackageRelationship pr = xssfSheet.getPackagePart().addRelationship(ppn, TargetMode.INTERNAL, relType, null);
			xssfSheet.getCTWorksheet().addNewPicture().setId(pr.getId());
		}
	}

对应的背景图BufferedImage生成方法也贴一下

public static BufferedImage createWatermarkImage(WaterMarkContent watermark) {
        if (watermark == null) {
            watermark = new WaterMarkContent();
            watermark.setEnable(true);
//            watermark.setText("userName");
            watermark.setText("内部资料");
            watermark.setColor("#C5CBCF");
            watermark.setDateFormat("yyyy-MM-dd HH:mm");
        }
        String[] textArray = watermark.getText().split("\n");
        Font font = new Font("microsoft-yahei", Font.PLAIN, 20);
        Integer width = 300;
        Integer height = 100;

        BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
        // 背景透明 开始
        Graphics2D g = image.createGraphics();
        image = g.getDeviceConfiguration().createCompatibleImage(width, height, Transparency.TRANSLUCENT);
        g.dispose();
        // 背景透明 结束
        g = image.createGraphics();
        g.setColor(new Color(Integer.parseInt(watermark.getColor().substring(1), 16)));// 设定画笔颜色
        g.setFont(font);// 设置画笔字体
        g.shear(0.1, -0.26);// 设定倾斜度

//        设置字体平滑
        g.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);

        int y = 50;
        for (int i = 0; i < textArray.length; i++) {
            g.drawString(textArray[i], 0, y);// 画出字符串
            y = y + font.getSize();
        }
        g.drawString(DateUtils.currentStringDate(), 0, y);// 画出字符串

        g.dispose();// 释放画笔
        return image;

    }

WaterMarkContent 就是一个普通的实体类,放了几个字段,自行根据需要处理就好

  • 第二种依赖导入为
  •  
     	org.apache.poi
     	ooxml-schemas
     	1.4
     
    

我分析可能是ooxml-schemas版本差异,用这个版本的话要使用另外一种方式

    public static void setWaterMarkToExcel2(XSSFWorkbook workbook, XSSFSheet sheet, BufferedImage bfi) throws Exception {
        ByteArrayOutputStream byteArrayOut = new ByteArrayOutputStream();
        ImageIO.write(bfi, "png", byteArrayOut);
        int pictureIdx = workbook.addPicture(byteArrayOut.toByteArray(), Workbook.PICTURE_TYPE_PNG);
        //add relation from sheet to the picture data

        String rID = sheet.addRelation(null, XSSFRelation.IMAGE_PNG, workbook.getAllPictures().get(pictureIdx))
                .getRelationship().getId();
        //set background picture to sheet
        sheet.getCTWorksheet().addNewPicture().setId(rID);
    }

可能出现的异常:
java.lang.NoClassDefFoundError: org/openxmlformats/schemas/spreadsheetml/x2006/main/CTWorkbook$Factoryat
这种情况可能是ooxml-schemas依赖版本的问题,我碰到时是从1.4换成1.0就好了,对了我的jdk版本是1.7,也有小伙伴碰到了采用更换jdk版本到1.8也能解决好像。
就写到这里吧,这个需求感觉没有多少实际需求,excel水印,呵呵,还是叫excel文件添加背景图吧

你可能感兴趣的:(java,poi)