SpringBoot 集成Guacamole客户端

---

---

1. 前言

本文将指导你如何在Springboot中集成guacamole客户端。

2. 安装guacamole服务端

2.1. docker方式安装guacamole服务端

首先是下载镜像，Guacamole数据库可以选择mysql或 PostgreSQL

# 拉取guacd服务端
docker pull guacamole/guacd

3. 启动guacamole服务端

# 启动guacamole服务端
docker run --name guacd -d -p 4822:4822 guacamole/guacd

4. 整合springboot

4.1. 引入pom文件

pom.xml文件增加如下代码

<!-- Main Guacamole library -->
<dependency>
    <groupId>org.apache.guacamole</groupId>
    <artifactId>guacamole-common</artifactId>
    <version>1.4.0</version>
</dependency>

4.2. 创建Guacamole对象

创建Guacamole对象用于参数接收传递，代码如下所示。

package com.jc.pp.cmp.bean;
 
/**
 * guacamole实体类
 * @author Administrator
 */
public class Guacamole {
 
    /**
     * guacamole服务端地址
     */
    private String host;
 
    /**
     * guacamole服务端端口号
     */
    private Integer port;
 
    public String getHost() {
        return host;
    }
 
    public void setHost(String host) {
        this.host = host;
    }
 
    public Integer getPort() {
        return port;
    }
 
    public void setPort(Integer port) {
        this.port = port;
    }
}

4.3. 配置yml文件

在application.yml文件中增加如下配置。

# guacamole配置信息
guacamole_server_host: 172.16.31.11
guacamole_server_port: 4822

4.4. 编写websocket通信类

创建WebSocketTunnel类放在合适的位置，代码如下所示

package com.jc.pp.cmp.config;
 
import com.jc.pp.cmp.bean.Guacamole;
import com.jc.pp.cmp.exception.ServiceException;
import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.net.GuacamoleSocket;
import org.apache.guacamole.net.GuacamoleTunnel;
import org.apache.guacamole.net.InetGuacamoleSocket;
import org.apache.guacamole.net.SimpleGuacamoleTunnel;
import org.apache.guacamole.protocol.ConfiguredGuacamoleSocket;
import org.apache.guacamole.protocol.GuacamoleConfiguration;
import org.apache.guacamole.websocket.GuacamoleWebSocketTunnelEndpoint;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PropertiesLoaderUtils;
import org.springframework.stereotype.Component;
 
import javax.websocket.EndpointConfig;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.Properties;
 
/**
 * @author Chenym
 * @Date 2022/11/25
 **/
@ServerEndpoint(value = "/ws", subprotocols = "guacamole")
@Component
public class WebSocketTunnel extends GuacamoleWebSocketTunnelEndpoint {
 
    private static final Logger logger = LoggerFactory.getLogger(WebSocketTunnel.class);
 
    /**
     *返回给定会话的新隧道。如何创建此隧道
     *或检索到的是依赖于实现的。
     *
     *@param session 与活动WebSocket关联的会话连接。
     *@param endpointConfig 为处理这个单一的连接而创建的端点。
     *@return 连接的隧道，如果不存在此类隧道，则为null。
     *@throws GuacamoleException 如果在检索或者如果对隧道的访问被拒绝。
     */
    @Override
    protected GuacamoleTunnel createTunnel(Session session, EndpointConfig endpointConfig) throws GuacamoleException {
        Map<String, List<String>> map = session.getRequestParameterMap();
        logger.info("sessionMap:{}", map);
        // 获取url的值
        // 可添加下方代码接收参数
        // 通过前端Vue或者其他前端语言请求后端时动态添加参数可使得下方远程windows服务地址动态注入
        Guacamole guacamole = getGuacamole();
        GuacamoleConfiguration configuration = new GuacamoleConfiguration();
        configuration.setProtocol("vnc");
        // 远程windows服务的地址
        configuration.setParameter("hostname", String.valueOf(map.get("nodeIp").get(0)));
        configuration.setParameter("port", String.valueOf(map.get("nodePort").get(0)));
        configuration.setParameter("ignore-cert", "true");
        GuacamoleSocket socket = new ConfiguredGuacamoleSocket(
                new InetGuacamoleSocket(guacamole.getHost(), guacamole.getPort()),
                configuration
        );
        return new SimpleGuacamoleTunnel(socket);
    }
 
    private Guacamole getGuacamole() {
        Guacamole guacamole = new Guacamole();
        try {
            Resource resource = new ClassPathResource("application.yml");
            Properties properties;
            properties = PropertiesLoaderUtils.loadProperties(resource);
            guacamole.setHost(properties.getProperty("guacamole_server_host"));
            guacamole.setPort(Integer.parseInt(properties.getProperty("guacamole_server_port")));
 
        } catch (IOException e) {
            throw new ServiceException("guacamole配置读取异常");
        }
        return guacamole;
    }
 
}

以上代码配置成功以后，就可以通过前端调用@ServerEndpoint注解value中配置的地址来连接guacamole服务端了。