Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
title訳注

以下はGroovy 1.6時点の情報です。1.7での変更点についてはGroovy 1.7のリリースノートを参照してください。

Excerpt
hiddentrue

Grape (The Groovy Adaptable Packaging Engine or Groovy Advanced Packaging Engine) is the infrastructure enabling the grab() calls in Groovy, a set of classes leveraging Ivy to allow for a repository driven module system for Groovy. This allows a developer to write a script with an essentially arbitrary library requirement, and ship just the script. Grape will, at runtime, download as needed and link the named libraries and all dependencies forming a transitive closure when the script is run from existing repositories such as Ibiblio, Codehaus, and java.net.


Grape (The Groovy Adaptable Packaging Engine または Groovy Advanced Packaging Engine) は、Groovyでgrab()呼び出しを可能にする基盤であり、Groovyのリポジトリベースのモジュールシステムを実現するためのIvyを活用した一連のクラスです。これによって、開発者が何らかのライブラリを必須とするスクリプトを書いても、そのスクリプトのみをリリースすることが可能になります。スクリプトが、IbiblioやCodehaus、java.netのような既存のリポジトリに基づいて実行されるとき、Grapeは(実行時に)必要に応じて指定されたライブラリやそのすべての依存物をダウンロードし、リンクします。

Table of Contents
maxLevel2

基本

Excerpt
hiddentrue

Grape follows the Ivy conventions for module version identification, with naming change.


Grapeは、モジュールのバージョン識別に関しては(用語の変更はありますが)、Ivyのやり方に従っています。

Excerpt
hiddentrue
  • group - Which module group the module comes from. Translates directly to a Maven groupId or an Ivy Organization. Any group matching /groovy[x][\..*]^/ is reserved and may have special meaning to the groovy endorsed modules.
  • module - The name of the module to load. Translated directly to a Maven artifactId or an Ivy artifact.
  • version - The version of the module to use. Either a literal version '1.1-RC3' or an Ivy Range '[2.2.1,)' meaning 2.2.1 or any greater version).
  • group - モジュールが所属するモジュールグループ。MavenのgroupIdやIvyのOrganizationに相当。/groovy[x][\..*]^/ にマッチするグループは予約されていて、Groovyの標準モジュールとして特別な意味を持つ場合がある。
  • module - ロードするモジュールの名前。MavenのartifactIdやIvyのartifactに相当。
  • version - 利用するモジュールのバージョン。'1.1-RC3' のようなリテラルバージョンかIvyの範囲。例えば '[2.2.1,)' はバージョン2.2.1以降の意味。
Excerpt
hiddentrue

The downloaded modules will be stored according to Ivy's standard mechanism with a cache root of ~/.groovy/grape


ダウンロードされたモジュールは、キャッシュルート ~/.groovy/grape の下に、Ivyの標準メカニズムに従って保存されます。

使用方法

アノテーション

Excerpt
hiddentrue

One or more groovy.lang.Grab annotations can be added at any place that annotations are accepted to tell the compiler that this code relies on the specific library. This will have the effect of adding the library to the classloader of the groovy compiler. This annotation is detected and evaluated before any other resolution of classes in the script, so imported classes can be properly resolved by a @Grab annotation.


アノテーションが許されている場所であればどこでも、いくつでもgroovy.lang.Grabアノテーションを付けて、そのコードが特定のライブラリに依存していることをコンパイラに知らせることができます。これは、Groovyコンパイラのクラスローダにそのライブラリを追加する効果があります。このアノテーションは、スクリプト内の他のあらゆるクラス解決に先だって検出・評価されるので、@Grabアノテーションによって取り込まれたクラスも適切に解決されます。

Code Block
import com.jidesoft.swing.JideSplitButton
@Grab(group='com.jidesoft', module='jide-oss', version='[2.2.1,2.3.0)')
public class TestClassAnnotation {
    public static String testMethod () {
        return JideSplitButton.class.name
    }
}
Excerpt
hiddentrue

An appropriate grab(...) call will be added to the static initializer of the class of the containing class (or script class in the case of an annotated script element).


対象クラス(スクリプト要素へのアノテーションの場合はScriptクラス)のstaticイニシャライザに、適切な grab(...) 呼び出しが追加されます。

複数のGrapeアノテーション

Excerpt
hiddentrue

In order to use a Grape annotation multiple times you must use the Grapes annotation, e.g.:


複数のGrapeアノテーションを使うためには、Grapesアノテーションを使う必要があります。例:

Code Block
@Grapes(
    @Grab(group='commons-primitives', module='commons-primitives', version='1.0'),
    @Grab(group='org.ccil.cowan.tagsoup', module='tagsoup', version='0.9.7'))
class Example {
// ...
}
Excerpt
hiddentrue

Otherwise you'll encounter the following error:


こうしないと、次のエラーが発生してしまうでしょう:

...

Excerpt
hiddentrue

* Multiple calls to grab in the same context with the same parameters should be idempotent. However, if the same code is called with a different ClassLoader context then resolution may be re-run.


* 同じコンテキスト、同じパラメータで何回grabを呼び出しても効果は同じになります。ただし、同じコードでも異なるクラスローダコンテキストで呼び出せば、再度依存性の解決が実行されます。
Excerpt
hiddentrue
  • grab is disabled by default. Starting calling Grape.initGrape() will enable grab. Any calls to grab before initGrape() is called will be ignored. Hence Grape managed classloading is opt in only. Multiple calls ti Grape.initGrape() after the first successful call are ignored.
  • If the args map passed into the grab call has an attribute noExceptions that evaluates true no exceptions will be thrown.
  • grab requires that a RootLoader or GroovyClassLoader be specified or be in the ClassLoader chain of the calling class. By default failure to have such a ClassLoader available will result in module resolution and an exception being thrown (if initGrape()has been called).
    • The ClassLoader passed in via the classLoader: argument and it's parent classloaders.
    • The ClassLoader of the object passed in as the referenceObject: argument, and it's parent classloaders.
    • The ClassLoader of the class issuing the call to grab

...

Excerpt
hiddentrue

There are two principal variants of grab, one with a single Map and one with an arguments Map and multiple dependencies map. A call to the single map grab is the same as calling grab with the same map passed in twice, so grab arguments and dependencies can be mixed in the same map, and grab can be called as a single method with named parameters.


grab には二つの主要なバリエーションがあります。単一のMapをとるものと、引数Mapおよび複数の依存先Mapをとるものです。一つのマップをとるgrabの呼び出しは、同じマップを二回渡してgrabを呼ぶのと同じことです。grabの引数と依存先は一つのマップに合成されるので、名前付きパラメータをとる単一のメソッドとしてgrabを呼び出すことも可能です。
Excerpt
hiddentrue

There are synonyms for these parameters. Submitting more than one is a runtime exception.


これらのパラメータには別名も用意されています。複数種を使うと実行時例外になります。

...

Excerpt
hiddentrue

If you need to change the directory grape uses for downloading libraries you can specify the grape.root system property to change the default (which is ~/.groovy/grape)


grapeがライブラリのダウンロードに使うディレクトリを変更する必要がある場合、grape.rootシステムプロパティを指定して、デフォルト値(~/.groovy/grape)を変えることができます。

Code Block

groovy -Dgrape.root=/repo/grape yourscript.groovy

...

Excerpt
hiddentrue

Launching a Jetty server to server Groovy templates:


Groovyテンプレートが使えるJettyサーバの起動:

Code Block
import @Grapes([
    @Grab(group='org.mortbayeclipse.jetty.Server
import org.mortbay.jetty.servlet.*
import groovy.servlet.*

@Grab(group = 'org.mortbay.jettyaggregate', module='jetty-server', version='8.1.7.v20120910'),
    @Grab(group='org.eclipse.jetty.aggregate', module = 'jetty-embeddedservlet', version='8.1.7.v20120910'),
    @Grab(group='javax.servlet', module='6.1javax.servlet-api', version='3.0.1')])

import org.eclipse.jetty.server.Server
import org.eclipse.jetty.servlet.*
import groovy.servlet.*

def runServer(duration) {
    def server = new Server(8080)
    def context = new ContextServletContextHandler(server, "/", ContextServletContextHandler.SESSIONS);
    context.resourceBase = "."
    context.addServlet(TemplateServlet, "*.gsp")
    server.start()
    sleep duration
    server.stop()
}

runServer(10000)

Excerpt
hiddentrue

Grape will download Jetty and its dependencies on first launch of this script, and cache them. We're creating a new Jetty Server on port 8080, then expose Groovy's TemplateServlet at the root of the context — Groovy comes with its own powerful template engine mechanism. We start the server and let it run for a certain duration. Each time someone will hit http://localhost:8080/somepage.gsp, it will display the somepage.gsp template to the user — those template pages should be situated in the same directory as this server script.


このスクリプトの最初の起動時に、GrapeはJettyとそれが依存するモジュールをダウンロードし、キャッシュします。新しいJetty Serverをポート8080で生成し、コンテキストのルートでGroovyのTemplateServletを使えるようにします(Groovyには強力なテンプレートエンジンメカニズムが備わっています)。そしてサーバを起動し、一定時間実行させます。誰かがhttp://localhost:8080/somepage.gspにアクセスするたびに、ユーザにはsomepage.gspテンプレートが表示されるでしょう。このテンプレートページはサーバスクリプトと同じディレクトリに置く必要があります。

関連情報:

Using Hibernate with Groovy
http://stackoverflow.com/questions/192432/getting-groovys-grape-going