<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by linzichao on Medium]]></title>
        <description><![CDATA[Stories by linzichao on Medium]]></description>
        <link>https://medium.com/@joy10393?source=rss-12ceec2b28bd------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/2*I0DtVyeWdswomhCC1zM9JA.jpeg</url>
            <title>Stories by linzichao on Medium</title>
            <link>https://medium.com/@joy10393?source=rss-12ceec2b28bd------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Sun, 22 Nov 2026 22:46:39 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@joy10393/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[Method Resolution Order of Groovy Closures]]></title>
            <link>https://joy10393.medium.com/method-resolution-order-of-groovy-closures-1e63fcb628c1?source=rss-12ceec2b28bd------2</link>
            <guid isPermaLink="false">https://medium.com/p/1e63fcb628c1</guid>
            <category><![CDATA[groovy]]></category>
            <category><![CDATA[closure]]></category>
            <category><![CDATA[domain-specific-languages]]></category>
            <dc:creator><![CDATA[linzichao]]></dc:creator>
            <pubDate>Sat, 26 Jun 2021 14:26:30 GMT</pubDate>
            <atom:updated>2021-06-27T11:38:19.215Z</atom:updated>
            <content:encoded><![CDATA[<p>Groovy Closure and Domain-Specific Language</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*0BrHTWBBMW_jlk37iuQ0NA.png" /><figcaption>Apache Groovy</figcaption></figure><h3>1. Intro</h3><p>因為工作的關係接觸到Jenkins的<a href="https://www.jenkins.io/doc/book/pipeline-as-code/">Pipeline as Code</a>， 我們利用Groovy Scripts就可以產生相應的Jenkins jobs並帶入config，scripts又通通到git進行版控，讓管理上相對容易，誰搞壞了也可以迅速找到兇手。</p><p>一切看似美好…直到我們遇到與stackoverflow非常相似的問題：</p><p><a href="https://stackoverflow.com/questions/30037433/groovy-script-context-and-method-resolution/">Groovy Script Context and Method Resolution</a></p><p>事主在呼叫views時，帶了一個closure物件做為參數，也就是views的大括號範圍，這個closure又呼叫了build_pipelines.each，要對build_pipelines進行迭代，預期產生的架構應該如下：</p><pre>root<br>└── nestedView<br>    └── views<br>        ├── buildPipelineView1<br>        │   └── selectedJob1<br>        ├── buildPipelineView2<br>        │   └── selectedJob2<br>        └── buildPipelineView3<br>            └── selectedJob3</pre><p>但實際上是這樣：</p><pre>root<br>├── nestedView<br>│   └── views<br>│<br>├── buildPipelineView1<br>│   └── selectedJob1<br>├── buildPipelineView2<br>│   └── selectedJob2<br>└── buildPipelineView3<br>    └── selectedJob3</pre><p>這也讓我開始懷疑幾種可能：</p><ul><li>Jenkins的<a href="https://github.com/jenkinsci/job-dsl-plugin">job-dsl-plugin</a>有bug嗎?</li><li>Groovy本身定義就不夠完備?</li></ul><h3>2. job-dsl-plugin &amp; Delegation strategy</h3><p>回到stackoverflow，事主有提到如果把each拿掉，整段程式碼就能符合他的預期，因此我的首要方向是往<a href="https://github.com/jenkinsci/job-dsl-plugin">job-dsl-plugin</a>下手：</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/6f0f4ff31ccefe8c770b59820eff3e0a/href">https://medium.com/media/6f0f4ff31ccefe8c770b59820eff3e0a/href</a></iframe><p>views在第18行new一個NestedViewsContext物件，並在第19行利用 ContextHelper對closure的delegate設為18行宣告的NestedViewsContext物件，resolveStrategy設為Closure.DELEGATE_FIRST</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/7af628569940d9376c2238f1985035e7/href">https://medium.com/media/7af628569940d9376c2238f1985035e7/href</a></iframe><p>這又衍生了幾個問題…<br>delegate是什麼?? resolveStrategy是什麼??</p><p><a href="https://groovy-lang.org/closures.html#_delegation_strategy">Closures</a></p><p>從Groovy document可以看到，一個closure物件具有三個things：</p><ul><li>this：定義這個closure並且離它最近的class</li><li>owner：定義這個closure並且離它最近的object，可以是class或是closure</li><li>delegate：可以是任意一個third party object或closure，讓使用者有彈性去自由assign，default value是owner</li></ul><p>那resolveStrategy則是影響當closure呼叫自身沒有定義的變數或函式時，access的策略為何，有以下幾種模式：</p><ul><li>Closure.OWNER_FIRST：預設模式，如果closure呼叫的變數或函式存在於owner，就進行呼叫，如果沒有就往delegate尋找</li><li>Closure.DELEGATE_FIRST：與OWNER_FIRST剛好相反，如果closure呼叫的變數或函式存在於delegate，就進行呼叫，如果沒有就往owner尋找</li><li>Closure.OWNER_ONLY：如同字面上意思，只會尋找owner</li><li>Closure.DELEGATE_ONLY：如上，只會尋找delegate</li><li>Closure.TO_SELF：提供開發者可以自定義resolveStrategy的模式，預設只會找Closure Class</li></ul><p>實際來寫一段玩玩看：</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/436e4f48fc5f4960399153859f058754/href">https://medium.com/media/436e4f48fc5f4960399153859f058754/href</a></iframe><p>運行的結果是：</p><pre>OuterClass$InnerClass@3b582111<br>OuterClass$InnerClass@3b582111<br>InnerClass test<br>OuterClass$InnerClass$_closure1@30272916<br>MyClass1@5bb3d42d<br>MyClass1 test</pre><p>cl這個closure物件的owner與delegate都為InnerClass，使用預設的resolveStrategy，所以呼叫到InnerClass的test</p><p>cl2的owner是definition外離它最近的物件，就是cl，delegate則被我們改為cl的參數，為myclass1；resolveStrategy則設為DELEGATE_FIRST，所以呼叫myclass1的test</p><p>現在回到事主的程式碼，似乎有些端倪了</p><pre>nestedView(&quot;JS Pipelines&quot;) {<br>  views {<br><strong>     // closures delegate under this scope has been changed</strong><br>     build_pipelines.each { <br>      def build_pipeline = it<br><strong>      // closures delegate under this scope keep default</strong><br>      buildPipelineView(build_pipeline.build_name + &quot; JS Pipeline&quot;)         <br>      { <br>        selectedJob(build_pipeline.start_job)<br>      }<br>     }<br>  }<br>}</pre><p>因為多一層build_pipelines.each，導致views沒有把buildPipelineView的delegate改為NestedViewsContext物件，resolveStrategy也繼續保持預設OWNER_FIRST，所以buildPipelineView往owner尋找，那buildPipelineView的owner又是build_pipelines.each</p><p>然後build_pipelines.each的owner是views，delegate被改為NestedViewsContext物件，resolveStrategy為DELEGATE_FIRST，所以又會優先找NestedViewsContext的函式</p><p>等等…這樣buildPipelineView根本不會因為each的存在有所影響才對啊…</p><h3>3. Lexical Scope</h3><p>我們把程式碼做一些調整，把buildPipelineView改用listView，因為jobs跟views有異曲同工之妙，可以幫助我們驗證一些事實</p><pre>nestedView(&quot;JS Pipelines&quot;) {<br>  views {<br>     build_pipelines.each { <br>      def build_pipeline = it<br>      listView(build_pipeline.build_name + &quot; JS Pipeline&quot;){<br>         jobs {<br>           build_jobs.each { j -&gt;<br>             name(j)<br>           }<br>         }<br>      }<br>     }<br>  }<br>}</pre><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/a0e8e9154797a1e4edc95c6b184289cf/href">https://medium.com/media/a0e8e9154797a1e4edc95c6b184289cf/href</a></iframe><p>可以觀察到第22行jobs也如同views一樣把自身的jobsClosure參數，利用 ContextHelper把jobsClosure的delegate設為jobsContext物件，resolveStrategy設為Closure.DELEGATE_FIRST</p><p>我們又在jobs裡多一層build_jobs.each，可以預期name跟listView會有相同行為(一起往上一層移動)，不過事與願違…</p><pre>root<br>├── nestedView<br>│   └── views<br>│<br>├── listView1<br>│   └── jobs <br>│       ├── name1 <br>│       ├── name2<br>│       └── name3<br>├── listView2<br>│   └── jobs <br>│       ├── name1 <br>│       ├── name2<br>│       └── name3<br>└── listView3<br>    └── jobs <br>        ├── name1 <br>        ├── name2<br>        └── name3</pre><p>很明顯name 有很順利地解析jobsContext物件並於巢狀架構中依附於jobs之下</p><p>這也代表剛剛整段的推論是正確的，實際上內層closure是可以access外層closure的變數與函式</p><blockquote>因為多一層build_pipelines.each，導致views沒有把buildPipelineView的delegate改為NestedViewsContext物件，resolveStrategy也繼續保持預設OWNER_FIRST，所以buildPipelineView往owner尋找，那buildPipelineView的owner又是build_pipelines.each</blockquote><blockquote>然後build_pipelines.each的owner是views，delegate被改為NestedViewsContext物件，resolveStrategy為DELEGATE_FIRST，所以又會優先找NestedViewsContext的函式</blockquote><blockquote>等等…這樣buildPipelineView根本不會因為each的存在有所影響才對啊…</blockquote><p>Groovy document也很明確地指出，this與owner先天就已經存在於closure的lexical scope</p><blockquote>The delegate of a closure can be accessed by using the delegate property or calling the getDelegate method. It is a powerful concept for building domain specific languages in Groovy. While <a href="https://groovy-lang.org/closures.html#this">closure-this</a> and <a href="https://groovy-lang.org/closures.html#owner">closure-owner</a> refer to the lexical scope of a closure, the delegate is a user defined object that a closure will use. By default, the delegate is set to owner</blockquote><p>那為什麼buildPipelineView沒有被正確地解析?</p><h3>4. JobParent</h3><p>如果從問題的另外一個面向思考，如果buildPipelineView沒有被正確地解析，那它是被解析成什麼了?</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/8b419eac447cf4f9957b310c95dac3fc/href">https://medium.com/media/8b419eac447cf4f9957b310c95dac3fc/href</a></iframe><p>從plugin的進入點可以知道是被解析成<a href="https://github.com/jenkinsci/job-dsl-plugin/blob/master/job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/JobParent.groovy">JobParent</a>，確實JobParent的class中有包含buildPipelineView與listView，從<a href="https://github.com/jenkinsci/job-dsl-plugin/blob/b3bd3488f6c7389be8df0c7e473d0144c364a6ad/job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/AbstractDslScriptLoader.groovy">AbstractDslScriptLoader</a>也大概可以推測JobParent被設為scriptBaseClass，但這件事情的意義為何呢?</p><blockquote>JobParent會是整段script所有closure的this</blockquote><p>所以OWNER_FIRST反而會先從this開始找起!?</p><h3>5. OWNER_FIRST == THIS_FIRST ?</h3><p>我們再來實驗看看：</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/4c7a03ebf1152a03add6061479fe7065/href">https://medium.com/media/4c7a03ebf1152a03add6061479fe7065/href</a></iframe><p>運行的結果是：</p><pre>OuterClass$InnerClass@2237bada<br>MyClass1@77e2a6e2<br>MyClass1 test<br>OuterClass$InnerClass$_closure1@4e7095ac<br>OuterClass$InnerClass$_closure1@4e7095ac<br>InnerClass test</pre><p>這次cl的owner仍為InnerClass，不過delegate改為MyClass1，使用DELEGATE_FIRST的resolveStrategy，所以呼叫到MyClass1的test</p><p>cl2的owner還是cl，delegate不變動所以同為cl，resolveStrategy則保留預設值，所以呼叫InnerClass!?!?</p><p>InnerClass是cl2的this，難道說OWNER_FIRST不是真的OWNER_FIRST，反而是THIS_FIRST?</p><p>那現在我們從Groovy 3.0.8的compiler下手：</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/bdc950cb9057995e47a8010dd01f5cec/href">https://medium.com/media/bdc950cb9057995e47a8010dd01f5cec/href</a></iframe><p>從第32行開始的default，我們可以發現OWNER_FIRST真的不是從owner開始找起，而是從this開始逐層找回來</p><h3>6. Miscellaneous</h3><p>其實Groovy的JIRA和stackoverflow上也有許多相關的討論：</p><ul><li><a href="https://issues.apache.org/jira/browse/GROOVY-7232">Delegation inconsistent between methods and properties in nested closures</a></li><li><a href="https://stackoverflow.com/questions/27627463/nested-closure-resolution-different-between-methods-and-properties">Nested closure resolution different between methods and properties?</a></li><li><a href="https://stackoverflow.com/questions/58336094/groovy-resolvestrategy-in-nested-closure">Groovy resolveStrategy in nested closure</a></li></ul><p>那這個問題在Groovy中有沒有被修正呢?</p><p>答案是肯定的，在Groovy 4.0.0-alpha-1中的<a href="https://github.com/apache/groovy/blob/d7684d101d64ca6da28fdb8069ea92475d011168/src/main/java/org/codehaus/groovy/runtime/metaclass/ClosureMetaClass.java">ClosureMetaClass.java</a> 已經被修正了，收工！</p><h3>7. Reference</h3><ul><li><a href="https://groovy-lang.org/index.html">Groovy</a></li><li><a href="https://github.com/jenkinsci/job-dsl-plugin">jenkinsci/job-dsl-plugin</a></li><li><a href="https://github.com/apache/groovy">apache/groovy</a></li></ul><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=1e63fcb628c1" width="1" height="1" alt="">]]></content:encoded>
        </item>
    </channel>
</rss>