【JCEF】JS与JAVA进行交互

前言

之前介绍了JCEF的可用性，经过几天的摸索，有了一个初步的理解并尝试着运行测试案例

一：介绍

在传统的Web开发中，前后端连接通常是通过以下方式实现的：

HTTP请求： 前端通过HTTP请求向后端发送请求，后端处理请求并返回数据。这可以是常规的GET请求、POST请求等。前端通常使用JavaScript或其他前端框架来发起这些请求。

API（应用程序编程接口）： 后端提供一组API，这些API定义了前端可以调用的功能和数据。前端通过HTTP请求调用这些API来获取或发送数据。API可以返回数据，如JSON或XML格式的信息。

WebSocket： WebSocket是一种双向通信协议，允许前后端实时交换数据。与传统的HTTP请求不同，WebSocket连接保持打开状态，允许双方在任何时候都能发送和接收数据。

二：开始

JCEF（Java Chromium Embedded Framework）是一个将Chromium嵌入到Java应用程序中的框架，使您可以在Java应用程序中嵌入一个完整的浏览器引擎。JCEF提供了一种在Java应用程序中展示网页内容的方式，并且允许您在Java和JavaScript之间进行交互。下面是一个简单的示例，展示如何在JCEF中实现Java和JavaScript之间的交互：

首先，您需要设置JCEF的开发环境。这涉及到引入JCEF的库和配置，这里简单介绍一下步骤：

下载JCEF的库文件，并将它们添加到您的Java项目中。

配置JCEF的运行参数，主要是设置Chromium本地库的路径。

初始化JCEF框架，启动Chromium引擎。

创建JFrame或JPanel来嵌入JCEF组件，以展示网页内容。

以下是一个简化的示例，展示如何在JCEF中实现Java和JavaScript之间的交互：

import org.cef.CefApp;
import org.cef.CefClient;
import org.cef.CefSettings;
import org.cef.browser.CefBrowser;
import org.cef.handler.CefAppHandlerAdapter;
import org.cef.handler.CefLoadHandlerAdapter;
import org.cef.handler.CefMessageRouterHandlerAdapter;
import org.cef.handler.CefRequestHandlerAdapter;

import javax.swing.*;

public class JCEFExample {
    public static void main(String[] args) {
        CefApp.addAppHandler(new CefAppHandlerAdapter(args));
        CefSettings settings = new CefSettings();
        CefApp cefApp = CefApp.getInstance(args, settings);

        SwingUtilities.invokeLater(() -> {
            JFrame frame = new JFrame("JCEF Example");
            frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

            CefClient client = cefApp.createClient();
            CefBrowser browser = client.createBrowser("https://www.example.com", false, false);

            frame.getContentPane().add(browser.getUIComponent());

            frame.setSize(800, 600);
            frame.setVisible(true);
        });
    }
}

上述代码创建了一个简单的JCEF应用程序窗口，并在窗口中展示了一个网页。接下来，让我们看一下如何在JavaScript和Java之间进行交互。

在JCEF中，要实现JavaScript和Java之间的交互，您可以使用CefMessageRouter。

下面是一个简单的示例：

import org.cef.browser.CefBrowser;
import org.cef.callback.CefQueryCallback;
import org.cef.handler.CefMessageRouterHandlerAdapter;

public class JCEFMessageRouterHandler extends CefMessageRouterHandlerAdapter {
    @Override
    public boolean onQuery(CefBrowser browser, long queryId, String request, boolean persistent, CefQueryCallback callback) {
        if (request.equals("getJavaData")) {
            String javaData = "This data is from Java";
            callback.success(javaData);
            return true;
        }
        return false;
    }
}

在上述代码中，我们创建了一个CefMessageRouterHandlerAdapter的子类，重写了onQuery方法来处理来自JavaScript的查询。当JavaScript代码中调用cefQuery并传递"getJavaData"时，Java代码会返回一段数据。

然后，您需要在之前的示例中将这个JCEFMessageRouterHandler注册到CefMessageRouter中。这样，您就可以在JavaScript中使用cefQuery来与Java进行交互了。

JavaScript代码示例：

// 在JavaScript中调用Java方法并获取返回值
cefQuery({
    request: "getJavaData",
    onSuccess: function(response) {
        console.log("Data from Java: " + response);
    },
    onFailure: function(errorCode, errorMessage) {
        console.error("Java query failed: " + errorCode + " - " + errorMessage);
    }
});

总结

JCEF使得在Java应用程序中嵌入Chromium引擎成为可能，并且通过使用CefMessageRouter，您可以在Java和JavaScript之间实现双向的交互。请注意，实际开发中需要更多的配置和处理，这里只是一个简化的示例