new site style

en/groovy.html

@@ -32,6 +32,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
 <script src="_static/center_page.js"></script>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/github.min.css">
  
 
 
@@ -169,7 +170,7 @@
 <div class="section" id="limitations">
 <span id="limitations"></span><h2>Limitations<a class="headerlink" href="#limitations" title="Permalink to this headline">¶</a></h2>
 <ol class="simple">
-<li>Prohibit from alternating the original logic. Like <code class="docutils literal notranslate"><span class="pre">watch</span></code> command, The major purpose of scripting is monitoring and observing.</li>
+<li>Prohibit from alternating the original logic. Like <tt class="docutils literal">watch</tt> command, The major purpose of scripting is monitoring and observing.</li>
 <li>Only allow to monitor at the stages of before/success/exception/finish on one method.</li>
 </ol>
 </div>
@@ -204,151 +205,151 @@
 <td align="left">enable regex match, the default is wildcard match</td>
 </tr>
 </tbody>
-</table><p>Note: the third parameter <code class="docutils literal notranslate"><span class="pre">script-filepath</span></code> must be the absolute path of the groovy script, for example <code class="docutils literal notranslate"><span class="pre">/tmp/test.groovy</span></code>. It is not recommended to use relative path, e.g. <code class="docutils literal notranslate"><span class="pre">./test.groovy</span></code>.</p>
+</table><p>Note: the third parameter <tt class="docutils literal">script-filepath</tt> must be the absolute path of the groovy script, for example <tt class="docutils literal">/tmp/test.groovy</tt>. It is not recommended to use relative path, e.g. <tt class="docutils literal">./test.groovy</tt>.</p>
 </div>
 <div class="section" id="explanation-on-the-important-callbacks">
 <span id="explanation-on-the-important-callbacks"></span><h2>Explanation on the important callbacks<a class="headerlink" href="#explanation-on-the-important-callbacks" title="Permalink to this headline">¶</a></h2>
-<div class="highlight-java notranslate"><div class="highlight"><pre><span></span><span class="cm">/**</span>
-<span class="cm"> * Listeners for script to enhance the class</span>
-<span class="cm"> */</span>
-<span class="kd">interface</span> <span class="nc">ScriptListener</span> <span class="o">{</span>
+<div class="highlight-java notranslate"><div class="highlight hljs"><pre class="java">/**
+ * Listeners for script to enhance the class
+ */
+interface ScriptListener {
 
-    <span class="cm">/**</span>
-<span class="cm">     * When the script is created</span>
-<span class="cm">     *</span>
-<span class="cm">     * @param output Output</span>
-<span class="cm">     */</span>
-    <span class="kt">void</span> <span class="nf">create</span><span class="o">(</span><span class="n">Output</span> <span class="n">output</span><span class="o">);</span>
+    /**
+     * When the script is created
+     *
+     * @param output Output
+     */
+    void create(Output output);
 
-    <span class="cm">/**</span>
-<span class="cm">     * When the script is destroyed</span>
-<span class="cm">     *</span>
-<span class="cm">     * @param output Output</span>
-<span class="cm">     */</span>
-    <span class="kt">void</span> <span class="nf">destroy</span><span class="o">(</span><span class="n">Output</span> <span class="n">output</span><span class="o">);</span>
+    /**
+     * When the script is destroyed
+     *
+     * @param output Output
+     */
+    void destroy(Output output);
 
-    <span class="cm">/**</span>
-<span class="cm">     * Before the method executes</span>
-<span class="cm">     *</span>
-<span class="cm">     * @param output Output</span>
-<span class="cm">     * @param advice Advice</span>
-<span class="cm">     */</span>
-    <span class="kt">void</span> <span class="nf">before</span><span class="o">(</span><span class="n">Output</span> <span class="n">output</span><span class="o">,</span> <span class="n">Advice</span> <span class="n">advice</span><span class="o">);</span>
+    /**
+     * Before the method executes
+     *
+     * @param output Output
+     * @param advice Advice
+     */
+    void before(Output output, Advice advice);
 
-    <span class="cm">/**</span>
-<span class="cm">     * After the method returns</span>
-<span class="cm">     *</span>
-<span class="cm">     * @param output Output</span>
-<span class="cm">     * @param advice Advice</span>
-<span class="cm">     */</span>
-    <span class="kt">void</span> <span class="nf">afterReturning</span><span class="o">(</span><span class="n">Output</span> <span class="n">output</span><span class="o">,</span> <span class="n">Advice</span> <span class="n">advice</span><span class="o">);</span>
+    /**
+     * After the method returns
+     *
+     * @param output Output
+     * @param advice Advice
+     */
+    void afterReturning(Output output, Advice advice);
 
-    <span class="cm">/**</span>
-<span class="cm">     * After the method throws exceptions</span>
-<span class="cm">     *</span>
-<span class="cm">     * @param output Output</span>
-<span class="cm">     * @param advice Advice</span>
-<span class="cm">     */</span>
-    <span class="kt">void</span> <span class="nf">afterThrowing</span><span class="o">(</span><span class="n">Output</span> <span class="n">output</span><span class="o">,</span> <span class="n">Advice</span> <span class="n">advice</span><span class="o">);</span>
+    /**
+     * After the method throws exceptions
+     *
+     * @param output Output
+     * @param advice Advice
+     */
+    void afterThrowing(Output output, Advice advice);
 
-<span class="o">}</span>
+}
 </pre></div>
 </div>
 </div>
 <div class="section" id="advice-parameter">
-<span id="advice-parameter"></span><h2><code class="docutils literal notranslate"><span class="pre">Advice</span></code> parameter<a class="headerlink" href="#advice-parameter" title="Permalink to this headline">¶</a></h2>
-<p><code class="docutils literal notranslate"><span class="pre">Advice</span></code> contains all information necessary for notification. Refer to <a class="reference internal" href="advice-class.html"><span class="doc">expression core parameters</span></a> for more details.</p>
+<span id="advice-parameter"></span><h2><tt class="docutils literal">Advice</tt> parameter<a class="headerlink" href="#advice-parameter" title="Permalink to this headline">¶</a></h2>
+<p><tt class="docutils literal">Advice</tt> contains all information necessary for notification. Refer to <a class="reference internal" href="advice-class.html"><span class="doc">expression core parameters</span></a> for more details.</p>
 </div>
 <div class="section" id="output-parameter">
-<span id="output-parameter"></span><h2><code class="docutils literal notranslate"><span class="pre">Output</span></code> parameter<a class="headerlink" href="#output-parameter" title="Permalink to this headline">¶</a></h2>
-<p>There are three methods in <code class="docutils literal notranslate"><span class="pre">Output</span></code>, used for outputting the corresponding text.</p>
-<div class="highlight-java notranslate"><div class="highlight"><pre><span></span><span class="cm">/**</span>
-<span class="cm"> * Output</span>
-<span class="cm"> */</span>
-<span class="kd">interface</span> <span class="nc">Output</span> <span class="o">{</span>
+<span id="output-parameter"></span><h2><tt class="docutils literal">Output</tt> parameter<a class="headerlink" href="#output-parameter" title="Permalink to this headline">¶</a></h2>
+<p>There are three methods in <tt class="docutils literal">Output</tt>, used for outputting the corresponding text.</p>
+<div class="highlight-java notranslate"><div class="highlight hljs"><pre class="java">/**
+ * Output
+ */
+interface Output {
 
-    <span class="cm">/**</span>
-<span class="cm">     * Output text without line break</span>
-<span class="cm">     *</span>
-<span class="cm">     * @param string Text to output</span>
-<span class="cm">     * @return this</span>
-<span class="cm">     */</span>
-    <span class="n">Output</span> <span class="nf">print</span><span class="o">(</span><span class="n">String</span> <span class="n">string</span><span class="o">);</span>
+    /**
+     * Output text without line break
+     *
+     * @param string Text to output
+     * @return this
+     */
+    Output print(String string);
 
-    <span class="cm">/**</span>
-<span class="cm">     * Output text with line break</span>
-<span class="cm">     *</span>
-<span class="cm">     * @param string Text to output</span>
-<span class="cm">     * @return this</span>
-<span class="cm">     */</span>
-    <span class="n">Output</span> <span class="nf">println</span><span class="o">(</span><span class="n">String</span> <span class="n">string</span><span class="o">);</span>
+    /**
+     * Output text with line break
+     *
+     * @param string Text to output
+     * @return this
+     */
+    Output println(String string);
 
-    <span class="cm">/**</span>
-<span class="cm">     * Finish outputting from the script</span>
-<span class="cm">     *</span>
-<span class="cm">     * @return this</span>
-<span class="cm">     */</span>
-    <span class="n">Output</span> <span class="nf">finish</span><span class="o">();</span>
+    /**
+     * Finish outputting from the script
+     *
+     * @return this
+     */
+    Output finish();
 
-<span class="o">}</span>
+}
 </pre></div>
 </div>
 </div>
 <div class="section" id="a-groovy-sample-script-to-output-logs">
 <span id="a-groovy-sample-script-to-output-logs"></span><h2>A groovy sample script to output logs<a class="headerlink" href="#a-groovy-sample-script-to-output-logs" title="Permalink to this headline">¶</a></h2>
-<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">com.taobao.arthas.core.command.ScriptSupportCommand</span>
-<span class="kn">import</span> <span class="nn">com.taobao.arthas.core.util.Advice</span>
+<div class="highlight-groovy notranslate"><div class="highlight hljs"><pre class="groovy">import com.taobao.arthas.core.command.ScriptSupportCommand
+import com.taobao.arthas.core.util.Advice
 
-<span class="kn">import</span> <span class="nn">static</span> <span class="n">java</span><span class="o">.</span><span class="na">lang</span><span class="o">.</span><span class="na">String</span><span class="o">.</span><span class="na">format</span>
+import static java.lang.String.format
 
-<span class="cm">/**</span>
-<span class="cm"> * Output method logs</span>
-<span class="cm"> */</span>
-<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Logger</span> <span class="kd">implements</span> <span class="n">ScriptSupportCommand</span><span class="o">.</span><span class="na">ScriptListener</span> <span class="o">{</span>
+/**
+ * Output method logs
+ */
+public class Logger implements ScriptSupportCommand.ScriptListener {
 
-    <span class="nd">@Override</span>
-    <span class="kt">void</span> <span class="nf">create</span><span class="o">(</span><span class="n">ScriptSupportCommand</span><span class="o">.</span><span class="na">Output</span> <span class="n">output</span><span class="o">)</span> <span class="o">{</span>
-        <span class="n">output</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s2">&quot;script create.&quot;</span><span class="o">);</span>
-    <span class="o">}</span>
+    @Override
+    void create(ScriptSupportCommand.Output output) {
+        output.println(&quot;script create.&quot;);
+    }
 
-    <span class="nd">@Override</span>
-    <span class="kt">void</span> <span class="nf">destroy</span><span class="o">(</span><span class="n">ScriptSupportCommand</span><span class="o">.</span><span class="na">Output</span> <span class="n">output</span><span class="o">)</span> <span class="o">{</span>
-        <span class="n">output</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s2">&quot;script destroy.&quot;</span><span class="o">);</span>
-    <span class="o">}</span>
+    @Override
+    void destroy(ScriptSupportCommand.Output output) {
+        output.println(&quot;script destroy.&quot;);
+    }
 
-    <span class="nd">@Override</span>
-    <span class="kt">void</span> <span class="nf">before</span><span class="o">(</span><span class="n">ScriptSupportCommand</span><span class="o">.</span><span class="na">Output</span> <span class="n">output</span><span class="o">,</span> <span class="n">Advice</span> <span class="n">advice</span><span class="o">)</span> <span class="o">{</span>
-        <span class="n">output</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">format</span><span class="o">(</span><span class="s2">&quot;before:class=%s;method=%s;paramslen=%d;%s;&quot;</span><span class="o">,</span>
-                <span class="n">advice</span><span class="o">.</span><span class="na">getClazz</span><span class="o">().</span><span class="na">getSimpleName</span><span class="o">(),</span>
-                <span class="n">advice</span><span class="o">.</span><span class="na">getMethod</span><span class="o">().</span><span class="na">getName</span><span class="o">(),</span>
-                <span class="n">advice</span><span class="o">.</span><span class="na">getParams</span><span class="o">().</span><span class="na">length</span><span class="o">,</span> <span class="n">advice</span><span class="o">.</span><span class="na">getParams</span><span class="o">()))</span>
-    <span class="o">}</span>
+    @Override
+    void before(ScriptSupportCommand.Output output, Advice advice) {
+        output.println(format(&quot;before:class=%s;method=%s;paramslen=%d;%s;&quot;,
+                advice.getClazz().getSimpleName(),
+                advice.getMethod().getName(),
+                advice.getParams().length, advice.getParams()))
+    }
 
-    <span class="nd">@Override</span>
-    <span class="kt">void</span> <span class="nf">afterReturning</span><span class="o">(</span><span class="n">ScriptSupportCommand</span><span class="o">.</span><span class="na">Output</span> <span class="n">output</span><span class="o">,</span> <span class="n">Advice</span> <span class="n">advice</span><span class="o">)</span> <span class="o">{</span>
-        <span class="n">output</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">format</span><span class="o">(</span><span class="s2">&quot;returning:class=%s;method=%s;&quot;</span><span class="o">,</span>
-                <span class="n">advice</span><span class="o">.</span><span class="na">getClazz</span><span class="o">().</span><span class="na">getSimpleName</span><span class="o">(),</span>
-                <span class="n">advice</span><span class="o">.</span><span class="na">getMethod</span><span class="o">().</span><span class="na">getName</span><span class="o">()))</span>
-    <span class="o">}</span>
+    @Override
+    void afterReturning(ScriptSupportCommand.Output output, Advice advice) {
+        output.println(format(&quot;returning:class=%s;method=%s;&quot;,
+                advice.getClazz().getSimpleName(),
+                advice.getMethod().getName()))
+    }
 
-    <span class="nd">@Override</span>
-    <span class="kt">void</span> <span class="nf">afterThrowing</span><span class="o">(</span><span class="n">ScriptSupportCommand</span><span class="o">.</span><span class="na">Output</span> <span class="n">output</span><span class="o">,</span> <span class="n">Advice</span> <span class="n">advice</span><span class="o">)</span> <span class="o">{</span>
-        <span class="n">output</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">format</span><span class="o">(</span><span class="s2">&quot;throwing:class=%s;method=%s;&quot;</span><span class="o">,</span>
-                <span class="n">advice</span><span class="o">.</span><span class="na">getClazz</span><span class="o">().</span><span class="na">getSimpleName</span><span class="o">(),</span>
-                <span class="n">advice</span><span class="o">.</span><span class="na">getMethod</span><span class="o">().</span><span class="na">getName</span><span class="o">()))</span>
-    <span class="o">}</span>
-<span class="o">}</span>
+    @Override
+    void afterThrowing(ScriptSupportCommand.Output output, Advice advice) {
+        output.println(format(&quot;throwing:class=%s;method=%s;&quot;,
+                advice.getClazz().getSimpleName(),
+                advice.getMethod().getName()))
+    }
+}
 </pre></div>
 </div>
 <p>Run the script like this:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ groovy com.alibaba.sample.petstore.dal.dao.ProductDao getProductById /Users/zhuyong/middleware/arthas/scripts/Logger.groovy -S
+<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ groovy com.alibaba.sample.petstore.dal.dao.ProductDao getProductById /Users/zhuyong/middleware/arthas/scripts/Logger.groovy -S
 script create.
 Press Ctrl+C to abort.
-Affect<span class="o">(</span>class-cnt:1 , method-cnt:1<span class="o">)</span> cost in <span class="m">102</span> ms.
-before:class<span class="o">=</span>IbatisProductDao<span class="p">;</span><span class="nv">method</span><span class="o">=</span>getProductById<span class="p">;</span><span class="nv">paramslen</span><span class="o">=</span><span class="m">1</span><span class="p">;</span><span class="o">[</span>Ljava.lang.Object<span class="p">;</span>@45df64fc<span class="p">;</span>
-returning:class<span class="o">=</span>IbatisProductDao<span class="p">;</span><span class="nv">method</span><span class="o">=</span>getProductById<span class="p">;</span>
-before:class<span class="o">=</span>IbatisProductDao<span class="p">;</span><span class="nv">method</span><span class="o">=</span>getProductById<span class="p">;</span><span class="nv">paramslen</span><span class="o">=</span><span class="m">1</span><span class="p">;</span><span class="o">[</span>Ljava.lang.Object<span class="p">;</span>@5b0e2d00<span class="p">;</span>
-returning:class<span class="o">=</span>IbatisProductDao<span class="p">;</span><span class="nv">method</span><span class="o">=</span>getProductById<span class="p">;</span>
+Affect(class-cnt:1 , method-cnt:1) cost in 102 ms.
+before:class=IbatisProductDao;method=getProductById;paramslen=1;[Ljava.lang.Object;@45df64fc;
+returning:class=IbatisProductDao;method=getProductById;
+before:class=IbatisProductDao;method=getProductById;paramslen=1;[Ljava.lang.Object;@5b0e2d00;
+returning:class=IbatisProductDao;method=getProductById;
 </pre></div>
 </div>
 </div>
@@ -417,6 +418,15 @@ returning:class<span class="o">=</span>IbatisProductDao<span class="p">;</span><
 
 <script type="text/javascript" src="_static/add_badges.js"></script>
 
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlightjs-line-numbers.js/2.5.0/highlightjs-line-numbers.min.js"></script>
+<script>
+  document.querySelectorAll('div.hljs > pre').forEach(function(block) {
+    hljs.highlightBlock(block);
+    hljs.lineNumbersBlock(block);
+  });
+</script>
+
 <script>
   var _hmt = _hmt || [];
   (function() {