热门标签 | HotTags
当前位置:  开发笔记 > 运维 > 正文

详解如何通过tomcat的ManagerServlet远程部署项目

这篇文章主要介绍了详解如何通过tomcat的ManagerServlet远程部署项目,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

介绍

之前在邮政实习时,leader让我阅读tomcat的源代码,尝试自己实现远程部署项目的功能,于是便有了这此实践。
在Tomact中有一个Manager应用程序,它是用来管理已经部署的web应用程序,在这个应用程序中,ManagerServlet是他的主servlet,通过它我们可以获取tomcat的部分指标,远程管理web应用程序,不过这个功能会受到web应用程序部署中安全约束的保护。

当你请求ManagerServlet时,它会检查getPathInfo()返回的值以及相关的查询参数,以确定被请求的操作。它支持以下操作和参数(从servlet路径开始): 

请求路径 描述
/deploy?cOnfig={config-url} 根据指定的path部署并启动一个新的web应用程序(详见源码)
/deploy?cOnfig={config-url}&war={war-url}/ 根据指定的pat部署并启动一个新的web应用程序(详见源码)
/deploy?path=/xxx&war={war-url} 根据指定的path部署并启动一个新的web应用程序(详见源码)
/list 列出所有web应用程序的上下文路径。格式为path:status:sessions(活动会话数)
/reload?path=/xxx 根据指定path重新加载web应用
/resources?type=xxxx 枚举可用的全局JNDI资源,可以限制指定的java类名
/serverinfo 显示系统信息和JVM信息
/sessions 此方法已过期
/expire?path=/xxx 列出path路径下的web应用的session空闲时间信息
/expire?path=/xxx&idle=mm Expire sessions for the context path /xxx which were idle for at least mm minutes.
/sslConnectorCiphers 显示当前connector配置的SSL/TLS密码的诊断信息
/start?path=/xx 根据指定path启动web应用程序
/stop?path=/xxx 根据指定path关闭web应用程序
/threaddump Write a JVM thread dump
/undeploy?path=/xxx 关闭并删除指定path的Web应用程序,然后删除底层WAR文件或文档基目录。

我们可以通过ManagerServlet中getPathInfo()提供的操作,将自己的项目远程部署到服务器上,下面将贴出我的实践代码,在实践它之前你只需要引入httpclient包和commons包。

封装统一的远程请求管理类

封装此类用于方便client请求ManagerServlet:

import java.io.File;
import java.net.URL;
import java.net.URLEncoder;

import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.http.Header;
import org.apache.http.HttpHost;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.Credentials;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.AuthCache;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.client.protocol.ClientContext;
import org.apache.http.impl.auth.BasicScheme;
import org.apache.http.impl.client.BasicAuthCache;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.conn.PoolingClientConnectionManager;
import org.apache.http.protocol.BasicHttpContext;

public class TomcatManager {
  private static final String MANAGER_CHARSET = "UTF-8";
  private String username;
  private URL url;
  private String password;
  private String charset;
  private boolean verbose;
  private DefaultHttpClient httpClient;
  private BasicHttpContext localContext;

  /** constructor */
  public TomcatManager(URL url, String username) {
    this(url, username, "");
  }
  public TomcatManager(URL url, String username, String password) {
    this(url, username, password, "ISO-8859-1");
  }
  public TomcatManager(URL url, String username, String password, String charset) {
    this(url, username, password, charset, true);
  }
  public TomcatManager(URL url, String username, String password, String charset, boolean verbose) {
    this.url = url;
    this.username = username;
    this.password = password;
    this.charset = charset;
    this.verbose = verbose;
    
    // 创建网络请求相关的配置
    PoolingClientConnectionManager poolingClientCOnnectionManager= new PoolingClientConnectionManager();
    poolingClientConnectionManager.setMaxTotal(5);
    this.httpClient = new DefaultHttpClient(poolingClientConnectionManager);

    if (StringUtils.isNotEmpty(username)) {
      Credentials creds = new UsernamePasswordCredentials(username, password);

      String host = url.getHost();
      int port = url.getPort() > -1 ? url.getPort() : AuthScope.ANY_PORT;
      httpClient.getCredentialsProvider().setCredentials(new AuthScope(host, port), creds);

      AuthCache authCache = new BasicAuthCache();
      BasicScheme basicAuth = new BasicScheme();
      HttpHost targetHost = new HttpHost(url.getHost(), url.getPort(), url.getProtocol());
      authCache.put(targetHost, basicAuth);

      localCOntext= new BasicHttpContext();
      localContext.setAttribute(ClientContext.AUTH_CACHE, authCache);
    }
  }

  /** 根据指定的path部署并启动一个新的应用程序 */
  public TomcatManagerResponse deploy(String path, File war, boolean update) throws Exception {
    StringBuilder buffer = new StringBuilder("/deploy");
    buffer.append("?path=").append(URLEncoder.encode(path, charset));
    if (war != null) {
      buffer.append("&war=").append(URLEncoder.encode(war.toString(), charset));
    }
    if (update) {
      buffer.append("&update=true");
    }
    return invoke(buffer.toString());
  }

  /** 获取所有已部署的web应用程序的上下文路径。格式为path:status:sessions(活动会话数) */
  public TomcatManagerResponse list() throws Exception {
    StringBuilder buffer = new StringBuilder("/list");
    return invoke(buffer.toString());
  }

  /** 获取系统信息和JVM信息 */
  public TomcatManagerResponse serverinfo() throws Exception {
    StringBuilder buffer = new StringBuilder("/serverinfo");
    return invoke(buffer.toString());
  }

  /** 真正发送请求的方法 */
  private TomcatManagerResponse invoke(String path) throws Exception {
    HttpRequestBase httpRequestBase = new HttpGet(url + path);
    HttpResponse respOnse= httpClient.execute(httpRequestBase, localContext);

    int statusCode = response.getStatusLine().getStatusCode();
    switch (statusCode) {
      case HttpStatus.SC_OK: // 200
      case HttpStatus.SC_CREATED: // 201
      case HttpStatus.SC_ACCEPTED: // 202
        break;
      case HttpStatus.SC_MOVED_PERMANENTLY: // 301
      case HttpStatus.SC_MOVED_TEMPORARILY: // 302
      case HttpStatus.SC_SEE_OTHER: // 303
      String redirectUrl = getRedirectUrl(response);
      this.url = new URL(redirectUrl);
      return invoke(path);
    }

    return new TomcatManagerResponse().setStatusCode(response.getStatusLine().getStatusCode())
        .setReasonPhrase(response.getStatusLine().getReasonPhrase())
        .setHttpResponseBody(IOUtils.toString(response.getEntity().getContent()));
  }
  
  /** 提取重定向URL */
  protected String getRedirectUrl(HttpResponse response) {
    Header locatiOnHeader= response.getFirstHeader("Location");
    String locatiOnField= locationHeader.getValue();
    // is it a relative Location or a full ?
    return locationField.startsWith("http") ? locationField : url.toString() + '/' + locationField;
  }
}

封装响应结果集

@Data
public class TomcatManagerResponse {
  private int statusCode;
  private String reasonPhrase;
  private String httpResponseBody;
}

测试远程部署

在测试之前请先在配置文件放通下面用户权限:








下面是测试成功远程部署war包的代码:

import static org.testng.AssertJUnit.assertEquals;
import java.io.File;
import java.net.URL;
import org.testng.annotations.Test;

public class TestTomcatManager {

  @Test
  public void testDeploy() throws Exception {
    TomcatManager tm = new TomcatManager(new URL("http://localhost:8080/manager/text"), "sqdyy", "123456");
    File war = new File("E:\\tomcat\\simple-war-project-1.0-SNAPSHOT.war");
    TomcatManagerResponse respOnse= tm.deploy("/simple-war-project-1.0-SNAPSHOT", war, true);
    System.out.println(response.getHttpResponseBody());
    assertEquals(200, response.getStatusCode());
    
    // output:
    // OK - Deployed application at context path /simple-war-project-1.0-SNAPSHOT
  }

  @Test
  public void testList() throws Exception {
    TomcatManager tm = new TomcatManager(new URL("http://localhost:8080/manager/text"), "sqdyy", "123456");
    TomcatManagerResponse respOnse= tm.list();
    System.out.println(response.getHttpResponseBody());
    assertEquals(200, response.getStatusCode());
    
    // output:
    // OK - Listed applications for virtual host localhost
    // /:running:0:ROOT
    // /simple-war-project-1.0-SNAPSHOT:running:0:simple-war-project-1.0-SNAPSHOT
    // /examples:running:0:examples
    // /host-manager:running:0:host-manager
    // /manager:running:0:manager
    // /docs:running:0:docs
  }

  @Test
  public void testServerinfo() throws Exception {
    TomcatManager tm = new TomcatManager(new URL("http://localhost:8080/manager/text"), "sqdyy", "123456");
    TomcatManagerResponse respOnse= tm.serverinfo();
    System.out.println(response.getHttpResponseBody());
    assertEquals(200, response.getStatusCode());
    
    // output:
    // OK - Server info
    // Tomcat Version: Apache Tomcat/7.0.82
    // OS Name: Windows 10
    // OS Version: 10.0
    // OS Architecture: amd64
    // JVM Version: 1.8.0_144-b01
    // JVM Vendor: Oracle Corporation
  }
}

参考资料

ManagerServlet 源码地址

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


推荐阅读
  • 这是原文链接:sendingformdata许多情况下,我们使用表单发送数据到服务器。服务器处理数据并返回响应给用户。这看起来很简单,但是 ... [详细]
  • 如何在服务器主机上实现文件共享的方法和工具
    本文介绍了在服务器主机上实现文件共享的方法和工具,包括Linux主机和Windows主机的文件传输方式,Web运维和FTP/SFTP客户端运维两种方式,以及使用WinSCP工具将文件上传至Linux云服务器的操作方法。此外,还介绍了在迁移过程中需要安装迁移Agent并输入目的端服务器所在华为云的AK/SK,以及主机迁移服务会收集的源端服务器信息。 ... [详细]
  • Skywalking系列博客1安装单机版 Skywalking的快速安装方法
    本文介绍了如何快速安装单机版的Skywalking,包括下载、环境需求和端口检查等步骤。同时提供了百度盘下载地址和查询端口是否被占用的命令。 ... [详细]
  • 本文介绍了在开发Android新闻App时,搭建本地服务器的步骤。通过使用XAMPP软件,可以一键式搭建起开发环境,包括Apache、MySQL、PHP、PERL。在本地服务器上新建数据库和表,并设置相应的属性。最后,给出了创建new表的SQL语句。这个教程适合初学者参考。 ... [详细]
  • Centos7.6安装Gitlab教程及注意事项
    本文介绍了在Centos7.6系统下安装Gitlab的详细教程,并提供了一些注意事项。教程包括查看系统版本、安装必要的软件包、配置防火墙等步骤。同时,还强调了使用阿里云服务器时的特殊配置需求,以及建议至少4GB的可用RAM来运行GitLab。 ... [详细]
  • 本文介绍了在Hibernate配置lazy=false时无法加载数据的问题,通过采用OpenSessionInView模式和修改数据库服务器版本解决了该问题。详细描述了问题的出现和解决过程,包括运行环境和数据库的配置信息。 ... [详细]
  • 禁止程序接收鼠标事件的工具_VNC Viewer for Mac(远程桌面工具)免费版
    VNCViewerforMac是一款运行在Mac平台上的远程桌面工具,vncviewermac版可以帮助您使用Mac的键盘和鼠标来控制远程计算机,操作简 ... [详细]
  • 本文介绍了Web学习历程记录中关于Tomcat的基本概念和配置。首先解释了Web静态Web资源和动态Web资源的概念,以及C/S架构和B/S架构的区别。然后介绍了常见的Web服务器,包括Weblogic、WebSphere和Tomcat。接着详细讲解了Tomcat的虚拟主机、web应用和虚拟路径映射的概念和配置过程。最后简要介绍了http协议的作用。本文内容详实,适合初学者了解Tomcat的基础知识。 ... [详细]
  • 本文介绍了关于apache、phpmyadmin、mysql、php、emacs、path等知识点,以及如何搭建php环境。文章提供了详细的安装步骤和所需软件列表,希望能帮助读者解决与LAMP相关的技术问题。 ... [详细]
  • 如何提高PHP编程技能及推荐高级教程
    本文介绍了如何提高PHP编程技能的方法,推荐了一些高级教程。学习任何一种编程语言都需要长期的坚持和不懈的努力,本文提醒读者要有足够的耐心和时间投入。通过实践操作学习,可以更好地理解和掌握PHP语言的特异性,特别是单引号和双引号的用法。同时,本文也指出了只走马观花看整体而不深入学习的学习方式无法真正掌握这门语言,建议读者要从整体来考虑局部,培养大局观。最后,本文提醒读者完成一个像模像样的网站需要付出更多的努力和实践。 ... [详细]
  • Servlet多用户登录时HttpSession会话信息覆盖问题的解决方案
    本文讨论了在Servlet多用户登录时可能出现的HttpSession会话信息覆盖问题,并提供了解决方案。通过分析JSESSIONID的作用机制和编码方式,我们可以得出每个HttpSession对象都是通过客户端发送的唯一JSESSIONID来识别的,因此无需担心会话信息被覆盖的问题。需要注意的是,本文讨论的是多个客户端级别上的多用户登录,而非同一个浏览器级别上的多用户登录。 ... [详细]
  • Windows下配置PHP5.6的方法及注意事项
    本文介绍了在Windows系统下配置PHP5.6的步骤及注意事项,包括下载PHP5.6、解压并配置IIS、添加模块映射、测试等。同时提供了一些常见问题的解决方法,如下载缺失的msvcr110.dll文件等。通过本文的指导,读者可以轻松地在Windows系统下配置PHP5.6,并解决一些常见的配置问题。 ... [详细]
  • 图解redis的持久化存储机制RDB和AOF的原理和优缺点
    本文通过图解的方式介绍了redis的持久化存储机制RDB和AOF的原理和优缺点。RDB是将redis内存中的数据保存为快照文件,恢复速度较快但不支持拉链式快照。AOF是将操作日志保存到磁盘,实时存储数据但恢复速度较慢。文章详细分析了两种机制的优缺点,帮助读者更好地理解redis的持久化存储策略。 ... [详细]
  • Java String与StringBuffer的区别及其应用场景
    本文主要介绍了Java中String和StringBuffer的区别,String是不可变的,而StringBuffer是可变的。StringBuffer在进行字符串处理时不生成新的对象,内存使用上要优于String类。因此,在需要频繁对字符串进行修改的情况下,使用StringBuffer更加适合。同时,文章还介绍了String和StringBuffer的应用场景。 ... [详细]
  • 一句话解决高并发的核心原则
    本文介绍了解决高并发的核心原则,即将用户访问请求尽量往前推,避免访问CDN、静态服务器、动态服务器、数据库和存储,从而实现高性能、高并发、高可扩展的网站架构。同时提到了Google的成功案例,以及适用于千万级别PV站和亿级PV网站的架构层次。 ... [详细]
author-avatar
行者05965
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有