jenkins插件远程调试

末蓝、 2022-10-13 00:29 1阅读 0赞

# jenkins插件开发 #

### 文章目录 ###

*  jenkins插件开发
 *   *  资料
     *  语法
     *  调试（以idea为例）
     *  终极插件法

## 资料 ##

*  开发者文档，[this][]
 *  官方helloworld文档，[this][this 1]
 *  jenkins代码中文介绍,[this][this 2]
 *  jenkins中文社区,[this][this 3]

## 语法 ##

*  这些内容在开发者文档中都是有的，不过在我用的过程中经常被用到，所以单独拿出来，方便以后浏览
 *  关于初始化
    
     *  `Extension`
        
        > 此注解的类会自动new一个实例
     *  `Initializer`
        
        > 此注解用来标记方法。当方法被此注解标记后，就会在你规定的一个时刻调用。默认是InitMilestone.STARTED，最迟在InitMilestone.COMPLETED之前。具体的调用时刻在运行时决定。

## 调试（以idea为例） ##

*  本地调试
    
     *  在本地调试时最简单的就是直接用maven插件的hpi:run就行了，但是如果像指定一些参数比如port和ip之类的可以这样填
     *      hpi:run -Djetty.port=8090 -Djetty.host=172.20.117.999 -f pom.xml
 *  远程调试
    
     *  war版本的远程调试的方式跟普通的java进程相同，此处不再赘述
     *  msi版
        
         *  我用jenkins是从官网下载的msi安装版，这一版的好处是会在安装时自动设置好服务，当然你依然可以只下载war，然后`java -jar jenkins.war`的方式启动
            
            > 下载地址
            > 
            > https://mirrors.tuna.tsinghua.edu.cn/jenkins/windows-stable/2.289.2/jenkins.msi
         *  我的安装路径是`F:\servertool\jenkins` 安装完成后把服务里的jenkins关掉，用自己的信息来配置jenkins的一些参数
         *  `F:\servertool\jenkins\jenkins.xml`这个文件中可以指定jenkins的home目录和一些启动参数。我额外添加了远程调试的参数。**注意**这里的5005是idea的默认远程调试端口，这个端口值没什么特殊要求，只要跟idea的设置一样就行了。**建议**在第一次配置和启动jenkins的时候可以先去掉。等设置好jenkins并安装好自己的插件以后再加入这部分。
            
                -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=172.20.117.999:5005
         *  这是我的jenkins.xml文件设置。如你所见这里可以指定jenkins的所有参数，比如端口、地址、home、等等。具体的可以通过`java -jar jenkins.war --help`来查看
            
                <service>
                  <id>jenkins</id>
                  <name>Jenkins</name>
                  <description>This service runs Jenkins automation server.</description>
                  <env name="JENKINS_HOME" value="F:\servertool\jenkins\war"/>
                  
                  <executable>D:\env\jdk11.0.11_9\bin\java.exe</executable>
                  <arguments>-Xrs -Xmx256m -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=172.20.117.999:5005 -jar "F:\servertool\jenkins\jenkins.war" --httpPort=8080 --webroot="%JENKINS_HOME%"</arguments>
                  
                  <logmode>rotate</logmode>
                
                  <onfailure action="restart"/>
                  
                  
                  <extensions>
                    
                    <extension enabled="true" className="winsw.Plugins.RunawayProcessKiller.RunawayProcessKillerExtension" id="killOnStartup">
                      <pidfile>%JENKINS_HOME%\jenkins.pid</pidfile>
                      <stopTimeout>10000</stopTimeout>
                      <stopParentFirst>false</stopParentFirst>
                    </extension>
                  </extensions>
                  
                  
                  
                </service>
         *  设置好上面的所有内容后**记得重启**jenkins服务。我是通过任务管理器来重启的。然后用idea打开你的插件代码打，`Edit Configurations -> + ->Remote JVM Debug`。**注意**这里的host和port一定要和jenkins.xml中的一致。还有这里idea提示说的参数是`-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005`。它这里是有问题的，jdk11已经不允许`address=*:5005`这种写法了，必须指定ip地址。也有可能是我的知识有误。然后就可以开始调试啦啦啦啦啦啦啦\_

## 终极插件法 ##

*  如果你（没错正是在下）懒得了解jenkins的条条框框，想要绝对的自由方式来开发jenkins插件，那么你可以写一个filter，将所有的http请求拦截，然后自己处理。以下是filter的例子。这个插件可以在安装时就初始化此过滤器，因此你可以不重启jenkins。
    
        package io.jenkins.plugins.god;
        
        import hudson.Extension;
        import hudson.init.InitMilestone;
        import hudson.init.Initializer;
        import hudson.util.PluginServletFilter;
        import org.jenkinsci.Symbol;
        import org.kohsuke.accmod.Restricted;
        import org.kohsuke.accmod.restrictions.NoExternalUse;
        
        import javax.servlet.Filter;
        import javax.servlet.FilterChain;
        import javax.servlet.FilterConfig;
        import javax.servlet.ServletException;
        import javax.servlet.ServletRequest;
        import javax.servlet.ServletResponse;
        import java.io.Serializable;
        
        @Extension
        @Restricted(NoExternalUse.class)
        @Symbol("godFilter")
        public class GodFilter implements Filter, Serializable {
            public GodFilter() {
            }
        
            @Initializer(after = InitMilestone.PLUGINS_STARTED)
            public void init() {
                try {
                    PluginServletFilter.addFilter(this);
                } catch (ServletException e) {
                    e.printStackTrace();
                }
            }
        
            @Override
            public void init(FilterConfig filterConfig) throws ServletException {
            }
        
            @Override
            public void doFilter(ServletRequest req, ServletResponse res, FilterChain filterChain) {
                // do somthing
            }
        
            @Override
            public void destroy() {
            }
        }

[this]: https://www.jenkins.io/doc/developer/
[this 1]: https://wiki.jenkins.io/display/JENKINS/Plugin+tutorial
[this 2]: https://www.jenkins.io/zh/doc/developer/architecture/web/
[this 3]: https://jenkins-zh.cn/