剪贴板工具类 - ClipboardUtil

简介

ClipboardUtil 是 Hutool 提供的一个操作剪贴板的工具类，用于简化与系统剪贴板的交互操作。虽然剪贴板操作的使用场景相对局限，但在某些场景下，它能提供很大的便利性，比如自动化测试、批量复制粘贴等。

1. 获取系统剪贴板

ClipboardUtil 提供了 getClipboard 方法，用于获取系统的剪贴板对象。通过该对象，开发者可以进行剪贴板内容的读取和写入操作。

import cn.hutool.core.swing.ClipboardUtil;

import java.awt.datatransfer.Clipboard;

public class ClipboardUtilExample {
    public static void main(String[] args) {
        // 获取系统剪贴板对象
        Clipboard clipboard = ClipboardUtil.getClipboard();

        // 输出剪贴板对象信息
        System.out.println("系统剪贴板: " + clipboard);
    }
}

• getClipboard()：获取系统剪贴板对象。

  • 返回值：系统的 Clipboard 对象。

  作用： 通过系统剪贴板对象进行更高级的剪贴板操作。

  实际开发场景： 在需要自定义剪贴板操作时，可以先获取系统剪贴板对象，再根据需要进行操作。

2. 设置内容到剪贴板

ClipboardUtil 提供了 set 方法，用于将指定内容设置到剪贴板中。此方法支持设置文本、图片等不同类型的内容。

import cn.hutool.core.swing.ClipboardUtil;

public class ClipboardUtilExample {
    public static void main(String[] args) {
        // 设置文本内容到剪贴板
        String text = "Hello, Hutool!";
        ClipboardUtil.set(text);

        System.out.println("文本内容已复制到剪贴板: " + text);
    }
}

• set(Object content)：将指定内容设置到剪贴板中。

  • content：要设置到剪贴板的内容，可以是 String、Image 等类型。
  • 返回值：无。

  作用： 快速将内容复制到系统剪贴板中，便于用户进行粘贴操作。

  实际开发场景： 在自动化操作或批量处理场景中，可以将生成的内容自动复制到剪贴板，供用户使用。

3. 获取剪贴板内容

ClipboardUtil 提供了 get 方法，用于从剪贴板中获取内容。根据剪贴板中的内容类型，可能返回文本、图片等不同类型的数据。

import cn.hutool.core.swing.ClipboardUtil;

public class ClipboardUtilExample {
    public static void main(String[] args) {
        // 获取剪贴板中的文本内容
        String text = ClipboardUtil.getStr();

        System.out.println("从剪贴板获取的文本内容: " + text);
    }
}

• get()：从剪贴板获取内容。

  • 返回值：剪贴板中的内容，根据内容类型返回相应的对象。

  作用： 读取系统剪贴板中的内容，便于进一步处理或显示。

  实际开发场景： 在自动化测试或文本处理场景中，可以从剪贴板中获取内容并进行验证或处理。

4. 设置文本到剪贴板

ClipboardUtil 提供了 setStr 方法，用于将字符串文本设置到剪贴板中。

import cn.hutool.core.swing.ClipboardUtil;

public class ClipboardUtilExample {
    public static void main(String[] args) {
        // 将字符串设置到剪贴板
        String text = "Hutool is great!";
        ClipboardUtil.setStr(text);

        System.out.println("字符串已复制到剪贴板: " + text);
    }
}

• setStr(String text)：将字符串设置到剪贴板中。

  • text：要设置的字符串内容。
  • 返回值：无。

  作用： 方便地将文本内容复制到剪贴板中。

  实际开发场景： 在需要将特定字符串内容快速复制到剪贴板供用户粘贴使用时，可以使用此方法。

5. 获取剪贴板中的文本内容

ClipboardUtil 提供了 getStr 方法，用于从剪贴板中获取文本内容。

import cn.hutool.core.swing.ClipboardUtil;

public class ClipboardUtilExample {
    public static void main(String[] args) {
        // 从剪贴板获取文本内容
        String text = ClipboardUtil.getStr();

        System.out.println("从剪贴板获取的文本内容: " + text);
    }
}

• getStr()：从剪贴板中获取字符串内容。

  • 返回值：剪贴板中的字符串内容。

  作用： 从剪贴板中读取文本内容，便于后续操作。

  实际开发场景： 在文本处理或数据验证场景中，获取剪贴板中的文本内容进行进一步操作。

6. 设置图片到剪贴板

ClipboardUtil 提供了 setImage 方法，用于将图片设置到剪贴板中。

import cn.hutool.core.swing.ClipboardUtil;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;

public class ClipboardUtilExample {
    public static void main(String[] args) throws IOException {
        // 从文件读取图片
        BufferedImage image = ImageIO.read(new File("example.jpg"));

        // 将图片设置到剪贴板
        ClipboardUtil.setImage(image);

        System.out.println("图片已复制到剪贴板。");
    }
}

• setImage(Image image)：将图片设置到剪贴板中。

  • image：要设置的图片对象。
  • 返回值：无。

  作用： 方便地将图片内容复制到剪贴板中，供用户粘贴使用。

  实际开发场景： 在图片处理或自动化生成图片后，直接将图片复制到剪贴板供用户粘贴使用。

7. 获取剪贴板中的图片内容

ClipboardUtil 提供了 getImage 方法，用于从剪贴板中获取图片内容。

import cn.hutool.core.swing.ClipboardUtil;

import java.awt.Image;

public class ClipboardUtilExample {
    public static void main(String[] args) {
        // 从剪贴板获取图片内容
        Image image = ClipboardUtil.getImage();

        if (image != null) {
            System.out.println("从剪贴板获取的图片对象: " + image);
        } else {
            System.out.println("剪贴板中没有图片。");
        }
    }
}

• getImage()：从剪贴板中获取图片内容。

  • 返回值：剪贴板中的图片对象，如果没有图片则返回 null。

  作用： 从剪贴板中读取图片内容，便于后续处理或显示。

  实际开发场景： 在图片处理场景中，从剪贴板中获取用户复制的图片并进行编辑或保存。

---

总结

ClipboardUtil 工具类在处理剪贴板操作方面提供了便捷且强大的工具方法。它适用于各种需要与剪贴板交互的场景，帮助开发者更高效地进行内容复制和粘贴，提高开发效率。