Frontend-Projekt an thymeroot:1.1.0 angepasst
[website] / dist / blog / article.html
1 <!DOCTYPE html>
2 <html
3     xmlns=""
4     xmlns:layout=""
5     layout:decorator="/templates/layout"
6     th:with="uri='/blog/article.html'"
7     >
8   <head>
9     <title>juplo - blog - Combining jetty-maven-plugin and wro4j-maven-plugin for Dynamic Reloading of LESS-Resources</title>
10     <!--/*-->
11     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
12     <link rel="stylesheet" type="text/css" href="../css/base.css"/>
13     <link rel="stylesheet" type="text/css" href="../css/screen.css" media="screen"/>
14     <link rel="stylesheet" type="text/css" href="../css/print.css" media="print"/>
15     <!--*/-->
16   </head>
17   <body thymeproxy:variables="MERGE:/blog.json">
18     <article class="main" layout:fragment="maincontent">
19       <article id="post-140" class="post-140 post type-post status-publish format-standard hentry category-jetty category-less category-maven category-wro4j">
20         <div class="entry-header">
21           <h1 class="entry-title">Combining jetty-maven-plugin and wro4j-maven-plugin for Dynamic Reloading of LESS-Resources</h1>
22           <div class="entry-meta">
23             Posted on <a href="" title="12:58" rel="bookmark"><time class="entry-date" datetime="2013-12-06T12:58:17+00:00">December 6, 2013</time></a><span class="byline"> by <span class="author vcard"><a class="url fn n" href="" title="View all posts by Kai Moritz" rel="author">Kai Moritz</a></span></span>
24           </div><!-- .entry-meta -->
25         </div><!-- .entry-header -->
26         <div class="entry-content">
27           <p>Ever searched for a simple configuration, that lets you use your <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="See the documentation for mor information">jetty-maven-plugin</a> as you are used to, while working with <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="See LESS CSS documentation for mor informations">LESS</a> to simplify your stylesheets?</p>
28           <p>You cannot do both, use the <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="More about the client-side usage of LESS">Client-side mode</a> of LESS to ease development and use the <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="Homepage of the official LESS CSS maven plugin">lesscss-maven-plugin</a> to automatically compile the LESS-sources into CSS for production. That does not work, because your stylesheets must be linked in different ways if you are switching between the client-side mode &#8211; which is best for development &#8211; and the pre-compiled mode &#8211; which is best for production. For the client-side mode you need something like:</p>
29           <pre class="prettyprint linenums">
30   <code class="html">
31   &lt;link rel="stylesheet" type="text/css" href="styles.css" /&gt;
32   &lt;script src="less.js" type="text/javascript"&gt;&lt;/script&gt;
33   </code>
34           </pre>
35           <p>While, for the pre-compiled mode, you want to link to your stylesheets as usual, with:</p>
36           <pre class="prettyprint linenums">
37   <code class="html">
38   &lt;link rel="stylesheet" type="text/css" href="styles.css" /&gt;
39   </code>
40           </pre>
41           <p>While looking for a solution to this dilemma, I stumbled accross <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="See the documentation of ths wounderfull tool">wro4j</a>. Originally intended, to speed up page-delivery by combining and minimizing multiple resources into one through the use of a servlet-filter, this tool also comes with a maven-plugin, that let you do the same offline, while compiling your webapp.</p>
42           <p>The idea is, to use the <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="See the documentation of hte wro4j-maven-plugin">wro4j-maven-plugin</a> to compile and combine your LESS-sources into CSS for production and to use the <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="See how to configure the filter">wro4j filter</a>, to dynamically deliver the compiled CSS while developing. This way, you do not have to alter your HTML-code, when switching between development and production, because you always link to the CSS-files.</p>
43           <p>So, lets get dirty!</p>
44           <h2>Step 1: Configure wro4j</h2>
45           <p>First, we configure <strong>wro4j</strong>, like as we want to use it to speed up our page. The details are explained and linked on wro4j&#8217;s <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="Visit the Getting-Started-Page">Getting-Started-Page</a>. In short, we just need two files: <strong>wro.xml</strong> and <strong></strong>.</p>
46           <h3>wro.xml</h3>
47           <p>wro.xml tells wro4j, which resources should be combined and how the result should be named. I am using the following configuration to generate all LESS-Sources beneath <code>base/</code> into one CSS-file called <code>base.css</code>:</p>
48           <pre class="prettyprint linenums">
49   <code class="xml">
50   &lt;groups xmlns=""&gt;
51     &lt;group name="base"&gt;
52       &lt;css&gt;/css/base/*.css&lt;/css&gt;
53     &lt;/group&gt;
54   </code>
55           </pre>
56           <p>wro4j looks for <code>/css/base/*.css</code> inside the root of the web-context, which is equal to <code>src/main/webapp</code> in a normal maven-project. There are <a href="" onclick="javascript:_gaq.push(['_trackEvent','outbound-article','']);" title="See the resource locator documentation of wro4j for more details">other ways to specifie the resources</a>, which enable you to store them elswhere. But this approach works best for our goal, because the path is understandable for both: the wro4j servlet-filter, we are configuring now for our development-environment, and the wro4j-maven-plugin, that we will configure later for build-time compilation.</p>
57           <h3></h3>
58           <p> in short tells wro4j, how or if it should convert the combined sources and how it should behave. I am using the following configuration to tell wro4j, that it should convert <code>*.css</code>-sources into CSS and do that on <em>every request</em>:</p>
59           <pre class="prettyprint linenums">
60   <code class="properties">
61   preProcessors=less4j
62   disableCache=true
63   </code>
64           </pre>
65           <p>You can do a lot more here. There are countless <a href="" onclick="javascript:_gaq.push(['_trackEvent', 'outbound-article', '']);" title="See all configuration options">configuration options</a> to fine-tune the behaviour of wro4j. The <code>disableCache=true</code> is crucial, because we would not see the changes take effect when developing with <strong>jetty-maven-plugin</strong> later on. You can also do much more with your resources here, for example <a href="" onclick="javascript:_gaq.push(['_trackEvent', 'outbound-article', '']);" title="See all available processors">minimizing</a>. But for our goal, we are now only intrested in the compilation of our LESS-sources.</p>
66           <h2>Step 2: Configure the wro4j servlet-filter</h2>
67           <p>Configuring the filter in the <strong>web.xml</strong> is easy. It is explained in wro4j&#8217;s <a href="" onclick="javascript:_gaq.push(['_trackEvent', 'outbound-article', '']);" title="See the installation instructions for the wro4j servlet-filter">installation-insctuctions</a>. But the trick is, that we do not want to configure that filter for the production-version of our webapp, because we want to compile the resources offline, when the webapp is build. To acchieve this, we can use the <code>&lt;overrideDescriptor&gt;</code>-Parameter of the <a href="" onclick="javascript:_gaq.push(['_trackEvent', 'outbound-article', '']);" title="Read more about the configuration of the jetty-maven-plugin">jetty-maven-plugin</a>.</p>
68           <h2>&lt;overrideDescriptor&gt;</h2>
69           <p>This parameter lets you specify additional configuration options for the web.xml of your webapp. I am using the following configuration for my jetty-maven-plugin:</p>
70           <pre class="prettyprint linenums">
71   <code class="xml">
72   &lt;plugin&gt;
73     &lt;groupId&gt;org.eclipse.jetty&lt;/groupId&gt;
74     &lt;artifactId&gt;jetty-maven-plugin&lt;/artifactId&gt;
75     &lt;configuration&gt;
76       &lt;webApp&gt;
77         &lt;overrideDescriptor&gt;${project.basedir}/src/test/resources/jetty-web.xml&lt;/overrideDescriptor&gt;
78       &lt;/webApp&gt;
79     &lt;/configuration&gt;
80     &lt;dependencies&gt;
81       &lt;dependency&gt;
82         &lt;groupId&gt;ro.isdc.wro4j&lt;/groupId&gt;
83         &lt;artifactId&gt;wro4j-core&lt;/artifactId&gt;
84         &lt;version&gt;${wro4j.version}&lt;/version&gt;
85       &lt;/dependency&gt;
86       &lt;dependency&gt;
87         &lt;groupId&gt;ro.isdc.wro4j&lt;/groupId&gt;
88         &lt;artifactId&gt;wro4j-extensions&lt;/artifactId&gt;
89         &lt;version&gt;${wro4j.version}&lt;/version&gt;
90         &lt;exclusions&gt;
91           &lt;exclusion&gt;
92               &lt;groupId&gt;javax.servlet&lt;/groupId&gt;
93               &lt;artifactId&gt;servlet-api&lt;/artifactId&gt;
94           &lt;/exclusion&gt;
95           &lt;exclusion&gt;
96               &lt;groupId&gt;org.apache.commons&lt;/groupId&gt;
97               &lt;artifactId&gt;commons-lang3&lt;/artifactId&gt;
98           &lt;/exclusion&gt;
99           &lt;exclusion&gt;
100               &lt;groupId&gt;commons-io&lt;/groupId&gt;
101               &lt;artifactId&gt;commons-io&lt;/artifactId&gt;
102           &lt;/exclusion&gt;
103           &lt;exclusion&gt;
104               &lt;groupId&gt;commons-pool&lt;/groupId&gt;
105               &lt;artifactId&gt;commons-pool&lt;/artifactId&gt;
106           &lt;/exclusion&gt;
107           &lt;exclusion&gt;
108               &lt;groupId&gt;org.springframework&lt;/groupId&gt;
109               &lt;artifactId&gt;spring-web&lt;/artifactId&gt;
110           &lt;/exclusion&gt;
111           &lt;exclusion&gt;
112               &lt;groupId&gt;;/groupId&gt;
113               &lt;artifactId&gt;gson&lt;/artifactId&gt;
114           &lt;/exclusion&gt;
115           &lt;exclusion&gt;
116               &lt;groupId&gt;;/groupId&gt;
117               &lt;artifactId&gt;closure-compiler&lt;/artifactId&gt;
118           &lt;/exclusion&gt;
119           &lt;exclusion&gt;
120               &lt;groupId&gt;com.github.lltyk&lt;/groupId&gt;
121               &lt;artifactId&gt;dojo-shrinksafe&lt;/artifactId&gt;
122           &lt;/exclusion&gt;
123           &lt;exclusion&gt;
124               &lt;groupId&gt;org.jruby&lt;/groupId&gt;
125               &lt;artifactId&gt;jruby-core&lt;/artifactId&gt;
126           &lt;/exclusion&gt;
127           &lt;exclusion&gt;
128             &lt;groupId&gt;org.jruby&lt;/groupId&gt;
129             &lt;artifactId&gt;jruby-stdlib&lt;/artifactId&gt;
130           &lt;/exclusion&gt;
131           &lt;exclusion&gt;
132               &lt;groupId&gt;org.jruby&lt;/groupId&gt;
133               &lt;artifactId&gt;jruby-stdlib&lt;/artifactId&gt;
134           &lt;/exclusion&gt;
135           &lt;exclusion&gt;
136               &lt;groupId&gt;me.n4u.sass&lt;/groupId&gt;
137               &lt;artifactId&gt;sass-gems&lt;/artifactId&gt;
138           &lt;/exclusion&gt;
139           &lt;exclusion&gt;
140               &lt;groupId&gt;;/groupId&gt;
141               &lt;artifactId&gt;bourbon-gem-jar&lt;/artifactId&gt;
142           &lt;/exclusion&gt;
143           &lt;exclusion&gt;
144               &lt;groupId&gt;org.codehaus.gmaven.runtime&lt;/groupId&gt;
145               &lt;artifactId&gt;gmaven-runtime-1.7&lt;/artifactId&gt;
146           &lt;/exclusion&gt;
147           &lt;exclusion&gt;
148               &lt;groupId&gt;org.webjars&lt;/groupId&gt;
149               &lt;artifactId&gt;jshint&lt;/artifactId&gt;
150           &lt;/exclusion&gt;
151           &lt;exclusion&gt;
152               &lt;groupId&gt;org.webjars&lt;/groupId&gt;
153               &lt;artifactId&gt;less&lt;/artifactId&gt;
154           &lt;/exclusion&gt;
155           &lt;exclusion&gt;
156               &lt;groupId&gt;org.webjars&lt;/groupId&gt;
157               &lt;artifactId&gt;emberjs&lt;/artifactId&gt;
158           &lt;/exclusion&gt;
159           &lt;exclusion&gt;
160               &lt;groupId&gt;org.webjars&lt;/groupId&gt;
161               &lt;artifactId&gt;handlebars&lt;/artifactId&gt;
162           &lt;/exclusion&gt;
163           &lt;exclusion&gt;
164               &lt;groupId&gt;org.webjars&lt;/groupId&gt;
165               &lt;artifactId&gt;coffee-script&lt;/artifactId&gt;
166           &lt;/exclusion&gt;
167           &lt;exclusion&gt;
168               &lt;groupId&gt;org.webjars&lt;/groupId&gt;
169               &lt;artifactId&gt;jslint&lt;/artifactId&gt;
170           &lt;/exclusion&gt;
171           &lt;exclusion&gt;
172               &lt;groupId&gt;org.webjars&lt;/groupId&gt;
173               &lt;artifactId&gt;json2&lt;/artifactId&gt;
174           &lt;/exclusion&gt;
175           &lt;exclusion&gt;
176               &lt;groupId&gt;org.webjars&lt;/groupId&gt;
177               &lt;artifactId&gt;jquery&lt;/artifactId&gt;
178           &lt;/exclusion&gt;
179         &lt;/exclusions&gt;
180       &lt;/dependency&gt;
181     &lt;/dependencies&gt;
182   &lt;/plugin&gt;
183   </code>
184           </pre>
185           <p>The dependencies to <strong>wro4j-core</strong> and <strong>wro4j-extensions</strong> are needed by jetty, to be able to enable the filter defined below. Unfortunatly, one of the transitive dependencies of <code>wro4j-extensions</code> triggers an uggly error when running the jetty-maven-plugin. Therefore, all unneeded dependencies of <code>wro4j-extensions</code> are excluded, as a workaround for this error/bug.</p>
186           <h2>jetty-web.xml</h2>
187           <p>And my jetty-web.xml looks like this:</p>
188           <pre class="prettyprint linenums">
189   <code class="xml">
190   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
191   &lt;web-app xmlns=""
192     xmlns:xsi=""
193     xsi:schemaLocation=""
194     version="2.5"&gt;
195     &lt;filter&gt;
196       &lt;filter-name&gt;wro&lt;/filter-name&gt;
197       &lt;filter-class&gt;ro.isdc.wro.http.WroFilter&lt;/filter-class&gt;
198     &lt;/filter&gt;
199     &lt;filter-mapping&gt;
200       &lt;filter-name&gt;wro&lt;/filter-name&gt;
201       &lt;url-pattern&gt;*.css&lt;/url-pattern&gt;
202     &lt;/filter-mapping&gt;
203   &lt;/web-app&gt;
204   </code>
205           </pre>
206           <p>The filter processes any URI&#8217;s that end with <code>.css</code>. This way, the wro4j servlet-filter makes <code>base.css</code> available under any path, because for exampl <code>/base.css</code>, <code>/css/base.css</code> and <code>/foo/bar/base.css</code> all end with <code>.css</code>.</p>
207           <p>This is all, that is needed to develop with dynamically reloadable compiled LESS-resources. Just fire up your browser and browse to <code>/what/you/like/base.css</code>. (But do not forget to put some LESS-files in <code>src/main/webapp/css/base/</code> first!)</p>
208           <h2>Step 3: Install wro4j-maven-plugin</h2>
209           <p>All that is left over to configure now, is the build-process. If you would build and deploy your webapp now, the CSS-file <code>base.css</code> would not be generated and the link to your stylesheet, that already works in our jetty-maven-plugin environment would point to a 404. Hence, we need to set up the <strong>wro4j-maven-plugin</strong>. I am using this configuration:</p>
210           <pre class="prettyprint linenums">
211   <code class="xml">
212   &lt;plugin&gt;
213     &lt;groupId&gt;ro.isdc.wro4j&lt;/groupId&gt;
214     &lt;artifactId&gt;wro4j-maven-plugin&lt;/artifactId&gt;
215     &lt;version&gt;${wro4j.version}&lt;/version&gt;
216     &lt;configuration&gt;
217       &lt;wroManagerFactory&gt;ro.isdc.wro.maven.plugin.manager.factory.ConfigurableWroManagerFactory&lt;/wroManagerFactory&gt;
218       &lt;cssDestinationFolder&gt;${}/${}/css/&lt;/cssDestinationFolder&gt;
219     &lt;/configuration&gt;
220     &lt;executions&gt;
221       &lt;execution&gt;
222         &lt;phase&gt;package&lt;/phase&gt;
223         &lt;goals&gt;
224           &lt;goal&gt;run&lt;/goal&gt;
225         &lt;/goals&gt;
226       &lt;/execution&gt;
227     &lt;/executions&gt;
228   &lt;/plugin&gt;
229   </code>
230           </pre>
231           <p>I connected the <code>run</code>-goal with the <code>package</code>-phase, because the statically compiled CSS-file is needed only in the final war. The <code>ConfigurableWroManagerFactory</code> tells wro4j, that it should look up further configuration options in our <code></code>-file, where we tell wro4j, that it should compile our LESS-resources. The <code>&lt;cssDestinationFolder&gt;</code>-tag tells wro4j, where it should put the generated CSS-file. You can adjust that to suite your needs.</p>
232           <p>That&#8217;s it: now the same CSS-file, which is created on the fly by the wro4j servlet-filter when using <code>mvn jetty:run</code> and, thus, enables dynamic reloading of our LESS-resources, is generated during the build-process by the wro4j-maven-plugin.</p>
233           <h2>Cleanup and further considerations</h2>
234           <h3>lesscss-maven-plugin</h3>
235           <p>If you already compile your LESS-resources with the lesscss-maven-plugin, you can stick with it and skip step 3. But I strongly recommend giving wro4j-maven-plugin a try, because it is a much more powerfull tool, that can speed up your final webapp even more.</p>
236           <h3>Clean up your mess </h3>
237           <p>With a configuration like the above one, your LESS-resources and wro4j-configuration-files will be packed into your production-war. That might be confusing later, because neither wro4j nor LESS is used in the final war. You can add the following to your <code>pom.xml</code> to exclude these files from your war for the sake of clarity:</p>
238           <pre class="prettyprint linenums">
239   <code class="xml">
240   &lt;plugin&gt;
241     &lt;artifactId&gt;maven-war-plugin&lt;/artifactId&gt;
242     &lt;configuration&gt;
243       &lt;warSourceExcludes&gt;
244         WEB-INF/wro.*,
245         less/**
246       &lt;/warSourceExcludes&gt;
247     &lt;/configuration&gt;
248   &lt;/plugin&gt;
249   </code>
250           </pre>
251           <h3>What&#8217;s next?</h3>
252           <p>We only scrached the surface, of what can be done with wro4j. Based on this configuration, you can easily enable additional features to fine-tune your final build for maximum speed. You really should take a look at the <a href="" onclick="javascript:_gaq.push(['_trackEvent', 'outbound-article', '']);" title="Available Processors">list of available Processors</a>!</p>
253         </div><!-- .entry-content -->
254         <footer class="entry-meta">
255           This entry was posted in <a href="" title="View all posts in Jetty" rel="category tag">Jetty</a>, <a href="" title="View all posts in less" rel="category tag">less</a>, <a href="" title="View all posts in Maven" rel="category tag">Maven</a>, <a href="" title="View all posts in wro4j" rel="category tag">wro4j</a>. Bookmark the <a href="" title="Permalink to Combining jetty-maven-plugin and wro4j-maven-plugin for Dynamic Reloading of LESS-Resources" rel="bookmark">permalink</a>. 
256         </footer><!-- .entry-meta -->
257       </article><!-- #post-140 -->
258       <!-- You can start editing here. -->
259       <!-- If comments are open, but there are no comments. -->
260       <div id="respond">
261         <h3>Leave a Reply</h3>
262         <div id="cancel-comment-reply">
263           <small><a rel="nofollow" id="cancel-comment-reply-link" href="/combining-jetty-maven-plugin-and-wro4j-maven-plugin-for-dynamic-reloading-of-less-resources/#respond" style="display:none;">Click here to cancel reply.</a></small>
264         </div>
265         <form action="" method="post" id="commentform">
266           <p>Logged in as <a href="">Kai Moritz</a>. <a href=";;_wpnonce=09e5cb501d" title="Log out of this account">Log out &raquo;</a></p>
267           <!--<p><small><strong>XHTML:</strong> You can use these tags: <code>&lt;a href=&quot;&quot; title=&quot;&quot;&gt; &lt;abbr title=&quot;&quot;&gt; &lt;acronym title=&quot;&quot;&gt; &lt;b&gt; &lt;blockquote cite=&quot;&quot;&gt; &lt;cite&gt; &lt;code&gt; &lt;del datetime=&quot;&quot;&gt; &lt;em&gt; &lt;i&gt; &lt;q cite=&quot;&quot;&gt; &lt;strike&gt; &lt;strong&gt; </code></small></p>-->
268           <p><textarea name="comment" id="comment" cols="58" rows="10" tabindex="4"></textarea></p>
269           <p><input name="submit" type="submit" id="submit" tabindex="5" value="Submit Comment" />
270             <input type='hidden' name='comment_post_ID' value='140' id='comment_post_ID' />
271             <input type='hidden' name='comment_parent' id='comment_parent' value='0' />
272           </p>
273           <input type="hidden" id="_wp_unfiltered_html_comment_disabled" name="_wp_unfiltered_html_comment_disabled" value="2096655c89" /><script>(function() {
274       if (window === window.parent) {
275         document.getElementById('_wp_unfiltered_html_comment_disabled').name = '_wp_unfiltered_html_comment';
276       }
277     })();</script>
278           <p style="display: none;"><input type="hidden" id="akismet_comment_nonce" name="akismet_comment_nonce" value="f31e001227" /></p>
279         </form>
280       </div>
281     </article>
282     <aside layout:fragment="marginalcontent">
283       <div id="secondary" class="widget-area" role="complementary">
284         <aside id="archives" class="widget">
285           <h1 class="widget-title">Archives</h1>
286           <ul>
287             <li><a href='' title='October 2013'>October 2013</a></li>
288             <li><a href='' title='August 2013'>August 2013</a></li>
289             <li><a href='' title='January 2013'>January 2013</a></li>
290             <li><a href='' title='November 2012'>November 2012</a></li>
291           </ul>
292         </aside>
293         <aside id="categories" class="widget">
294           <h1 class="widget-title">Most Used Categories</h1>
295           <ul>
296             <li class="cat-item cat-item-4"><a href="" title="View all posts filed under Java">Java</a> (6)</li>
297             <li class="cat-item cat-item-6"><a href="" title="View all posts filed under Hibernate">Hibernate</a> (5)</li>
298             <li class="cat-item cat-item-8"><a href="" title="View all posts filed under Maven">Maven</a> (5)</li>
299             <li class="cat-item cat-item-9"><a href="" title="View all posts filed under JPA">JPA</a> (1)</li>
300             <li class="cat-item cat-item-10"><a href="" title="View all posts filed under appengine">appengine</a> (1)</li>
301             <li class="cat-item cat-item-11"><a href="" title="View all posts filed under oauth2">oauth2</a> (1)</li>
302           </ul>
303         </aside>
304         <aside id="search" class="widget widget_search">
305           <h1 class="widget-title">Search</h1>
306           <form role="search" method="get" id="searchform" class="searchform" action="">
307             <div>
308               <label class="screen-reader-text" for="s">Search for:</label>
309               <input type="text" value="" name="s" id="s" />
310               <input type="submit" id="searchsubmit" value="Search" />
311             </div>
312           </form>
313         </aside>
314       </div><!-- #secondary .widget-area -->
315       <div id="tertiary" class="widget-area" role="supplementary">
316       </div><!-- #tertiary .widget-area -->
317     </aside>
318   </body>
319 </html>