(クイックリファレンス)
6 Webレイヤ
Authors: Graeme Rocher, Peter Ledbrook, Marc Palmer, Jeff Brown, Luke Daley, Burt Beckwith ,
Japanese Translation: T.Yamamoto, Japanese Grails Doc Translating Team
このドキュメントの内容はスナップショットバージョンを元に意訳されているため、一部現行バージョンでは未対応の機能もあります。
Version: 2.1.0.BUILD-SNAPSHOT
6 Webレイヤ
6.1 コントローラ
A controller handles requests and creates or prepares the response. A controller can generate the response directly or delegate to a view. To create a controller, simply create a class whose name ends with Controller
in the grails-app/controllers
directory (in a subdirectory if it's in a package).
コントローラはリクエストを処理してレスポンスの準備・作成を行います。コントローラはレスポンスをビューに委譲したり、直接返す事ができます。単純に
grails-app/controlers
ディレクトリに、クラス名称の最後を
Controller
にしたクラスを作成することで、コントローラを追加できます。(パッケージに入れる場合は、パッケージ名のサブディレクトリに作成します。)
The default
URL Mapping configuration ensures that the first part of your controller name is mapped to a URI and each action defined within your controller maps to URIs within the controller name URI.
URL マッピングのデフォルト設定では、Controllerの前に付けた名称がベースのURIにマップされ、コントローラに定義したそれぞれのアクション名称がコントローラ名称と繫がれてURIをマップします。
6.1.1 コントローラとアクションの理解
コントローラを作成する
create-controllerまたは
generate-controllerコマンドでコントローラが作成できます。Grailsプロジェクトのルートで以下のようにコマンドを実行します。
grails create-controller book
The command will create a controller at the location grails-app/controllers/myapp/BookController.groovy
:
コマンドを実行すると
grails-app/controllers/myapp/BookController.groovy
にコントローラを生成します。
package myappclass BookController { def index() { }
}
where "myapp" will be the name of your application, the default package name if one isn't specified.
パッケージ名を指定しない場合は、"myapp"というアプリケーション名であれば、自動的にデフォルトパッケージとして生成されます。
BookController
by default maps to the /book URI (relative to your application root).
デフォルトでは、
BookController
は、URIが /bookとなります。(アプリケーションのコンテキストルートからの相対パス)
The create-controller
and generate-controller
commands are just for convenience and you can just as easily create controllers using your favorite text editor or IDE
create-controller
とgenerate-controller
コマンドは、簡単にコントローラを生成する便利なコマンドですが、IDEやテキストエディタの機能でクラスを作成してもかまいません。
create-controller
とgenerate-controller
コマンドは、簡単にコントローラを生成する便利なコマンドですが、IDEやテキストエディタの機能でクラスを作成してもかまいません。
アクションの作成
A controller can have multiple public action methods; each one maps to a URI:
コントローラは複数のアクションメソッドを持つことができます。それぞれURIにマップされます:
class BookController { def list() { // do controller logic
// create model return model
}
}
This example maps to the /book/list
URI by default thanks to the property being named list
.
この例では、アクションメソッド名が
list
なので、URIは
/book/list
にマップされます。
パブリックメソッドをアクションとする
In earlier versions of Grails actions were implemented with Closures. This is still supported, but the preferred approach is to use methods.
以前のバージョンまでは、アクションがクロージャで実装されてました。この方式はまだサポートされています。ただし今後のアクションの実装はメソッドを使用することを推奨します。
Leveraging methods instead of Closure properties has some advantages:
クロージャではなく、メソッドにすることによって以下の利点があります:
- Memory efficient
- Allow use of stateless controllers (
singleton
scope)
- You can override actions from subclasses and call the overridden superclass method with
super.actionName()
- Methods can be intercepted with standard proxying mechanisms, something that is complicated to do with Closures since they're fields.
- メモリ効率
- ステートレスコントローラの使用 (
シングルトンスコープ
指定)
- サブクラスでのアクションのオーバーライドが可能。スーパークラスのアクションメソッド呼び出しが可能。
super.actionName()
- クロージャはフィールドのため複雑だった、スタンダードなプロキシを使用したメソッドのインターセプトが可能。
If you prefer the Closure syntax or have older controller classes created in earlier versions of Grails and still want the advantages of using methods, you can set the grails.compile.artefacts.closures.convert
property to true in BuildConfig.groovy
:
クロージャを使用したい場合や、旧バージョンで作られたコントローラを使用しながら、メソッドの利点も欲しい場合は、
BuildConfig.groovy
に、
grails.compile.artefacts.closures.convert
を定義します:
grails.compile.artefacts.closures.convert = true
and a compile-time AST transformation will convert your Closures to methods in the generated bytecode.
この定義をすることで、AST変換を使用してクロージャをメソッドに変換したバイトコードを生成します。
If a controller class extends some other class which is not defined under the grails-app/controllers/
directory, methods inherited from that class are not converted to controller actions. If the intent is to expose those inherited methods as controller actions the methods may be overridden in the subclass and the subclass method may invoke the method in the super class.
デフォルトアクション
A controller has the concept of a default URI that maps to the root URI of the controller, for example /book
for BookController
. The action that is called when the default URI is requested is dictated by the following rules:
コントローラのルートURIににデフォルトURIをマップする概念をもっています。例として
BookController
の場合は
/book
になります。デフォルトURIが呼ばれたときに呼ばれるアクションは以下のルールになっています:
- If there is only one action, it's the default
- If you have an action named
index
, it's the default
- Alternatively you can set it explicitly with the
defaultAction
property:
- アクションが1つの場合は、それがデフォルトになります。
index
という名称のアクションがある場合は、それがデフォルトになります。
defaultAction
を定義して指定できます。
static defaultAction = "list"
6.1.2 コントローラとスコープ
使用可能なスコープ
Scopes are hash-like objects where you can store variables. The following scopes are available to controllers:
スコープは、変数を収納可能なハッシュのようなオブジェクトです。コントローラでは、次のスコープが使用可能です。
- servletContext - Also known as application scope, this scope lets you share state across the entire web application. The servletContext is an instance of ServletContext
- session - The session allows associating state with a given user and typically uses cookies to associate a session with a client. The session object is an instance of HttpSession
- request - The request object allows the storage of objects for the current request only. The request object is an instance of HttpServletRequest
- params - Mutable map of incoming request query string or POST parameters
- flash - See below
スコープへのアクセス
Scopes can be accessed using the variable names above in combination with Groovy's array index operator, even on classes provided by the Servlet API such as the
HttpServletRequest:
以下のようにスコープはGroovyの配列インデクスオペレータで、変数の名称を指定して参照することができます。
HttpServletRequestにあるような、Servlet APIの提供する変数に関しても同じようにアクセスできます
class BookController {
def find() {
def findBy = params["findBy"]
def appContext = request["foo"]
def loggedUser = session["logged_user"]
}
}
You can also access values within scopes using the de-reference operator, making the syntax even more clear:
フィールド参照オペレータを使用してスコープの変数を参照すれば、シンタックスもっと簡潔にすることもできます:
class BookController {
def find() {
def findBy = params.findBy
def appContext = request.foo
def loggedUser = session.logged_user
}
}
This is one of the ways that Grails unifies access to the different scopes.
これはGrailsでの、様々なスコープにアクセスする一例です。
フラッシュスコープを使用する
Grails supports the concept of
flash scope as a temporary store to make attributes available for this request and the next request only. Afterwards the attributes are cleared. This is useful for setting a message directly before redirecting, for example:
Grailsは、今回のリクエストと次のリクエストのみで値を一時的に保持する
flashスコープをサポートしています。保持された内容は自動的に削除されます。リダイレクト等を行う前にメッセージを残す時などに使用できます。以下が例です。
def delete() {
def b = Book.get(params.id)
if (!b) {
flash.message = "User not found for id ${params.id}"
redirect(action:list)
}
… // remaining code
}
When the list
action is requested, the message
value will be in scope and can be used to display an information message. It will be removed from the flash
scope after this second request.
この例では、
delete
アクションに対してリクエストをすると、リダイレクトされて
list
アクションが実行された際に、flashスコープの
message
に代入した内容がメッセージ表示等に使用可能になります。このリダイレクトされた
list
アクション(
delete
の次のアクション)の処理が終了したら、
flash
スコープの内容が削除されます。
Note that the attribute name can be anything you want, and the values are often strings used to display messages, but can be any object type.
メッセージ表示などで文字列型が頻繁に使用されますが、flashスコープに一時的に保持する値は、どのようなオブジェクトでもかまいません。
コントローラのスコープ設定
By default, a new controller instance is created for each request. In fact, because the controller is prototype
scoped, it is thread-safe since each request happens on its own thread.
デフォルトでは、コントローラはリクエスト毎にインスタンスが生成されます。コントローラのスコープは
prototype
になっているため、リクエストがそれぞれのスレッドを持っているので、スレッドセーフになります。
You can change this behaviour by placing a controller in a particular scope. The supported scopes are:
コントローラにスコープを指定することで振る舞いを変更できます。サポートされているスコープは:
prototype
(default) - A new controller will be created for each request (recommended for actions as Closure properties)
session
- One controller is created for the scope of a user session
singleton
- Only one instance of the controller ever exists (recommended for actions as methods)
prototype
(デフォルト) - リクエスト毎にコントローラが生成されます。(クロージャでアクションを推奨)
session
- ユーザのセッションを通して1個のコントローラが生成されます。
singleton
- 1個のコントローラのみが存在する状態です。(メソッドでのアクションをお勧めします)
To enable one of the scopes, add a static scope
property to your class with one of the valid scope values listed above, for example
スコープを定義するには、コントローラクラスに、static scope 変数で指定したいスコープを定義します。以下が例になります。
static scope = "singleton"
You can define the default strategy under in Config.groovy
with the grails.controllers.defaultScope
key, for example:
デフォルトスコープは、
Config.groovy
に
grails.controllers.defaultScope
を指定する事で変更できます。
grails.controllers.defaultScope = "singleton"
Use scoped controllers wisely. For instance, we don't recommend having any properties in a singleton-scoped controller since they will be shared for all requests. Setting a default scope other than prototype
may also lead to unexpected behaviors if you have controllers provided by installed plugins that expect that the scope is prototype
.
コントローラのスコープは使用状況を考えてお使いください。例えば、シングルトンのコントローラは、_全ての_リクエストで共有されるためプロパティを持つべきではありません。デフォルトで定義されているスコープのprototype
を変更することで、プラグインなどで提供されたコントローラがprotopype
を前提で実装されている場合があるので注意しましょう
6.1.3 モデルとビュー
モデルを返す
A model is a Map that the view uses when rendering. The keys within that Map correspond to variable names accessible by the view. There are a couple of ways to return a model. First, you can explicitly return a Map instance:
モデルはビューを描写する際に使用するMapインスタンスです。ビュー内でMapのキーに一致する変数名が使用できます。モデルを返すには、数種類の方法があります。先ずはじめにMapインスタンスを明示的に返す方法です。
def show() {
[book: Book.get(params.id)]
}
The above does
not reflect what you should use with the scaffolding views - see the
scaffolding section for more details.
上記の例はスカッフォルドのビューで使用する例ではありません。スカッフォルドに関しては、スカッフォルドのセクションを参照してください。
If no explicit model is returned the controller's properties will be used as the model, thus allowing you to write code like this:
以下の例のように、明示的にモデルを返さない場合は、コントローラのプロパティがモデルとして使用されます。
class BookController { List books
List authors def list() {
books = Book.list()
authors = Author.list()
}
}
This is possible due to the fact that controllers are prototype scoped. In other words a new controller is created for each request. Otherwise code such as the above would not be thread-safe, and all users would share the same data.
これはコントローラのスコープがprototype(リクエスト毎にコントローラが生成される)の場合に可能な方法です。他の場合はスレッドセーフではありません。
In the above example the books
and authors
properties will be available in the view.
上記の例では、 プロパティの
book
と
authors
がビューで参照できます。
A more advanced approach is to return an instance of the Spring
ModelAndView class:
上級者向けのアプローチとしては、Springの
ModelAndViewインスタンスを返す方法があります。
import org.springframework.web.servlet.ModelAndViewdef index() {
// get some books just for the index page, perhaps your favorites
def favoriteBooks = ... // forward to the list view to show them
return new ModelAndView("/book/list", [ bookList : favoriteBooks ])
}
One thing to bear in mind is that certain variable names can not be used in your model:
一つ覚えておいて欲しいのが、一定の変数名が、モデル使用できないという事です。
Currently, no error will be reported if you do use them, but this will hopefully change in a future version of Grails.
現状では使用したとしてもエラーが出ることはありませんが、将来的には変わるかもしれません。
ビューの選択
Selecting the View
In both of the previous two examples there was no code that specified which
view to render. So how does Grails know which one to pick? The answer lies in the conventions. Grails will look for a view at the location
grails-app/views/book/show.gsp
for this
list
action:
これまでの例ではビューがどのように設定されるのかを説明しませんでたが、Grailsではどのようにビューを選択しているのでしょうか?答えは慣習にあります。何も指定しなければ、以下のアクションでは、Grailsが自動的に、
grails-app/views/book/show.gsp
をビューとして使用します。
class BookController {
def show() {
[book: Book.get(params.id)]
}
}
To render a different view, use the
render method:
別のビューを描写する場合は、
renderメソッドで指定します。
def show() {
def map = [book: Book.get(params.id)]
render(view: "display", model: map)
}
In this case Grails will attempt to render a view at the location grails-app/views/book/display.gsp
. Notice that Grails automatically qualifies the view location with the book
directory of the grails-app/views
directory. This is convenient, but to access shared views you need instead you can use an absolute path instead of a relative one:
上記の例では、
grails-app/views/book/display.gsp
の描写を試みます。注目する場所はGrailsは自動的にコントローラが
book
であれば、
grails-app/views
ディレクトリの
book
ディレクトリを、指定しなくても取得する所です。これは便利なのですが、ビューを共有する場合は、パスを指定する必要があります。
def show() {
def map = [book: Book.get(params.id)]
render(view: "/shared/display", model: map)
}
In this case Grails will attempt to render a view at the location grails-app/views/shared/display.gsp
.
上記の例では、
grails-app/views/shared/display.gsp
の描写を試みます。
Grails also supports JSPs as views, so if a GSP isn't found in the expected location but a JSP is, it will be used instead.
Grailsでは、ビューにJSPもサポートしています。これによって、参照したパスにGSPが存在しない場合は、JSPが代わりに使用されます。
レスポンスの描写
Sometimes it's easier (for example with Ajax applications) to render snippets of text or code to the response directly from the controller. For this, the highly flexible render
method can be used:
直接文字列をコントローラからレスポンス(例としてAjaxアプリケーションなど)したい場合、とてもフレキシブルな
render
メソッドを使うと簡単にできます。
The above code writes the text "Hello World!" to the response. Other examples include:
上記の例ではレスポンスに"Hello World!"を返します。他の例として:
// マークアップを返す
render {
for (b in books) {
div(id: b.id, b.title)
}
}
// 指定したビューを描写
render(view: 'show')
// コレクションの中身をそれぞれ指定したテンプレートを適応して描写
render(template: 'book_template', collection: Book.list())
// 文字列を指定したエンコーディングとコンテントタイプで描写
render(text: "<xml>some xml</xml>", contentType: "text/xml", encoding: "UTF-8")
If you plan on using Groovy's MarkupBuilder
to generate HTML for use with the render
method be careful of naming clashes between HTML elements and Grails tags, for example:
render
メソッドでGroovyの
MarkupBuilder
を使用してHTMLを生成する場合は、HTMLエレメント名とGrailsタグとの名称衝突を気をつけましょう。(Grailsのタグはアクション内部でメソッドとして使用できるため)
import groovy.xml.MarkupBuilder
…
def login() {
def writer = new StringWriter()
def builder = new MarkupBuilder(writer)
builder.html {
head {
title 'Log in'
}
body {
h1 'Hello'
form {
}
}
} def html = writer.toString()
render html
}
This will actually
call the form tag (which will return some text that will be ignored by the
MarkupBuilder
). To correctly output a
<form>
element, use the following:
上記の例ではformの場所にform
タグが呼ばれてしまいます。これを回避して
<form>
タグを正常に生成するには、以下のように
builder.form
とします。
def login() {
// …
body {
h1 'Hello'
builder.form {
}
}
// …
}
6.1.4 リダイレクトとチェイン
リダイレクト
Redirects
Actions can be redirected using the
redirect controller method:
コントローラのメソッド、
redirectを使用して、アクションをリダイレクトすることができます:
class OverviewController { def login() {} def find() {
if (!session.user)
redirect(action: 'login')
return
}
…
}
}
redirectメソッドは内部的に
HttpServletResponseオブジェクトの
sendRedirect
メソッドを使用しています。
The redirect
method expects one of:
redirect
メソッドでは以下のいずれかのように使用します:
* Another closure within the same controller class:
*同じコントローラ内のアクションクロージャ(プロパティで)の指定:
// Call the login action within the same class
redirect(action: login)
* The name of an action (and controller name if the redirect isn't to an action in the current controller):
- アクション名称でのしていと、別のコントローラのアクションの場合はコントローラの指定:
// Also redirects to the index action in the home controller
redirect(controller: 'home', action: 'index')
* A URI for a resource relative the application context path:
- アプリケーションコンテキストパス内のリソースのURI:
// Redirect to an explicit URI
redirect(uri: "/login.html")
* Or a full URL:
// Redirect to a URL
redirect(url: "http://grails.org")
Parameters can optionally be passed from one action to the next using the params
argument of the method:
メソッドのparams引数をにパラメータを指定することで、アクションへのパラメータを渡せます:
redirect(action: 'myaction', params: [myparam: "myvalue"])
These parameters are made available through the
params dynamic property that accesses request parameters. If a parameter is specified with the same name as a request parameter, the request parameter is overridden and the controller parameter is used.
これらのパラメータは、アクセス時のリクエストパラメータの
paramsプロパティから参照できるようになります。もしリクエストと同じパラメータを指定した場合は、パラメータは上書きされます。
Since the params
object is a Map, you can use it to pass the current request parameters from one action to the next:
params
オブジェクトはMapなので、以下のように、そのまま全てのリクエストパラメータを次のアクションに渡すことができます:
redirect(action: "next", params: params)
Finally, you can also include a fragment in the target URI:
ターゲットURIに、フラグメントを含めることもできます:
redirect(controller: "test", action: "show", fragment: "profile")
which will (depending on the URL mappings) redirect to something like "/myapp/test/show#profile".
この例では(URLマッピング定義によりますが)、リダイレクトは"/myapp/test/show#profile"になります。
チェイニング
Chaining
Actions can also be chained. Chaining allows the model to be retained from one action to the next. For example calling the first
action in this action:
アクションのチェインが可能です。チェインではアクションからアクションへのモデル参照が可能です。以下の例でアクション
first
を呼び出します:
class ExampleChainController { def first() {
chain(action: second, model: [one: 1])
} def second () {
chain(action: third, model: [two: 2])
} def third() {
[three: 3])
}
}
results in the model:
結果モデルは以下のようになります:
[one: 1, two: 2, three: 3]
The model can be accessed in subsequent controller actions in the chain using the chainModel
map. This dynamic property only exists in actions following the call to the chain
method:
途中でコントローラアクションからモデルにアクセスするには、chainModelマップを使用します。この動的プロパティはchainメソッドから呼ばれた時のみに存在します。
class ChainController { def nextInChain() {
def model = chainModel.myModel
…
}
}
Like the redirect
method you can also pass parameters to the chain
method:
redirect
メソッドと同じように、
chain
メソッドにパラメータを渡すこともできます:
chain(action: "action1", model: [one: 1], params: [myparam: "param1"])
6.1.5 コントローラ・インターセプター
Often it is useful to intercept processing based on either request, session or application state. This can be achieved with action interceptors. There are currently two types of interceptors: before and after.
リクエスト、セッションまたはアプリケーションで処理のインターセプトができると、たいへん役に立ちます。これはアクションインターセプターで達成できます。現在2種類のインターセプターbeforeとafterがあります。
If your interceptor is likely to apply to more than one controller, you are almost certainly better off writing a
Filter. Filters can be applied to multiple controllers or URIs without the need to change the logic of each controller
複数のコントローラにインターセプターを反映させたい場合は、Filterを使用することをお勧めします。Filterは多数のコントローラまたはURIに、ロジックを追加すること無く反映できます。
ビフォア・インターセプション
Before Interception
The beforeInterceptor
intercepts processing before the action is executed. If it returns false
then the intercepted action will not be executed. The interceptor can be defined for all actions in a controller as follows:
beforeInterceptor
は、アクションが実行される前に処理の追加を行うことができます。
beforeInterceptor
で、
false
を返すとアクションは実行されません。コントローラ内の全てのアクションにインターセプターを定義するには以下のようにします。
def beforeInterceptor = {
println "Tracing action ${actionUri}"
}
The above is declared inside the body of the controller definition. It will be executed before all actions and does not interfere with processing. A common use case is very simplistic authentication:
上記はコントローラ内部に設定します。全てのアクションの前に実行され処理を干渉することはありません。
他によくある実装例としては簡単な認証などです:
def beforeInterceptor = [action: this.&auth, except: 'login']// defined with private scope, so it's not considered an action
private auth() {
if (!session.user) {
redirect(action: 'login')
return false
}
}def login() {
// display login page
}
The above code defines a method called auth
. A private method is used so that it is not exposed as an action to the outside world. The beforeInterceptor
then defines an interceptor that is used on all actions except the login action and it executes the auth
method. The auth
method is referenced using Groovy's method pointer syntax. Within the method it detects whether there is a user in the session, and if not it redirects to the login
action and returns false
, causing the intercepted action to not be processed.
上記の例では先ず、
auth
メソッドを定義します。外部にアクションとして認識されないように
private
メソッドにします。
今回は、アクション名が
login
以外の全てのアクションで実行されるように、実行するメソッドをaction:に指定し、除外するアクション'login'を except:に指定して、
beforeInterceptor
を定義します。
auth
メソッドはGroovyのメソッドポインターシンタックスで指定します。これで、
auth
の処理によって、sessionにuser変数が見つからなかった場合は'login'アクションへリダイレクトして
false
を返しアクションを実行しないインターセプターが行えます。
アフター・インターセプション
After Interception
Use the afterInterceptor
property to define an interceptor that is executed after an action:
afterInterceptor
は、アクションが実行される後に処理の追加を行うことができます:
def afterInterceptor = { model ->
println "Tracing action ${actionUri}"
}
The after interceptor takes the resulting model as an argument and can hence manipulate the model or response.
アフター・インターセプターでは、処理結果のモデルを引数として取得して、モデルやレスポンスを操作することができます。
An after interceptor may also modify the Spring MVC
ModelAndView object prior to rendering. In this case, the above example becomes:
描写直前のSpring MVCの
ModelAndViewも取得して変更することも可能です。以下のケースでは、前の例に追記すると:
def afterInterceptor = { model, modelAndView ->
println "Current view is ${modelAndView.viewName}"
if (model.someVar) modelAndView.viewName = "/mycontroller/someotherview"
println "View is now ${modelAndView.viewName}"
}
This allows the view to be changed based on the model returned by the current action. Note that the modelAndView
may be null
if the action being intercepted called redirect
or render
.
この例では返されたモデルの内容を元にビューを変更しています。インターセプトされた、アクションが
redirect
や
render
を呼び出している場合は、
modelANdView
は
null
になります。
インターセプションの条件指定
Interception Conditions
Rails users will be familiar with the authentication example and how the 'except' condition was used when executing the interceptor (interceptors are called 'filters' in Rails; this terminology conflicts with Servlet filter terminology in Java):
'excepr'条件は、Railsユーザにとってインターセプターを使う時はお馴染みだと思います。(Railsではインターセプターはフィルターと呼ばれています。Javaでは用語的にサーブレットフィルターと衝突するのでインターセプターとしています)
def beforeInterceptor = [action: this.&auth, except: 'login']
This executes the interceptor for all actions except the specified action. A list of actions can also be defined as follows:
上記の例では、exceptで指定したアクション以外でインターセプターを実行します。次のように、複数指定する場合はリストで指定します:
def beforeInterceptor = [action: this.&auth, except: ['login', 'register']]
The other supported condition is 'only', this executes the interceptor for only the specified action(s):
指定したアクションのみでインターセプターを実行する場合は、'only'を使用します:
def beforeInterceptor = [action: this.&auth, only: ['secure']]
6.1.6 データバインディング
Data binding is the act of "binding" incoming request parameters onto the properties of an object or an entire graph of objects. Data binding should deal with all necessary type conversion since request parameters, which are typically delivered by a form submission, are always strings whilst the properties of a Groovy or Java object may well not be.
データバインディングとは、受信したリクエストパラメータを、オブジェクトのプロパティまたオブジェクト構造へ結合させる機能です。データバインディングでは、フォームから送信された文字列のリクエストパラメータを、必要な型への変換を行います。
Grails uses
Spring's underlying data binding capability to perform data binding.
Grailsでは、
Springのデータバインディングを基礎にデータバインディングを行います。
モデルにリクエストデータをバインドする
Binding Request Data to the Model
There are two ways to bind request parameters onto the properties of a domain class. The first involves using a domain classes' Map constructor:
リクエストパラメータをドメインクラスのプロパティへバインドする2通りの方法があります。1つめはドメインクラスのMapを指定するコンストラクタを使用します。
def save() {
def b = new Book(params)
b.save()
}
The data binding happens within the code
new Book(params)
. By passing the
params object to the domain class constructor Grails automatically recognizes that you are trying to bind from request parameters. So if we had an incoming request like:
この例での、
new Book(params)
の部分でデータバインディングが実行されます。
paramsオブジェクトをドメインクラスのコンストラクタに渡すことで、Grailsが自動にリクエストパラメータを認識してバインドします。例えば以下の例のようなリクエストを受信したとします。
/book/save?title=The%20Stand&author=Stephen%20King
Then the
title
and
author
request parameters would automatically be set on the domain class. You can use the
properties property to perform data binding onto an existing instance:
リクエストパラメータの
title
と
author
が、自動的にドメインクラスへセットされます。もう一つの方法として、既存のドメインクラスインスタンスへデータバインディングを行う方法として、インスタンスの
propertiesプロパティにparamsをセットする方法があります。
def save() {
def b = Book.get(params.id)
b.properties = params
b.save()
}
This has the same effect as using the implicit constructor.
上記の例で先ほどのコンストラクタと同じ結果となります。
シングルエンデッド・アソシエーション(単一終端関連)のデータバインディング
Data binding and Single-ended Associations
If you have a one-to-one
or many-to-one
association you can use Grails' data binding capability to update these relationships too. For example if you have an incoming request such as:
one-to-one
または
many-to-one
などの関連も、Grailsデータバインディングの機能で更新可能です。例として次のようなリクエストを受信したとします:
Grails will automatically detect the .id
suffix on the request parameter and look up the Author
instance for the given id when doing data binding such as:
同じ方法で、Grailsがリクエストパラメータの
.id
接尾辞を自動認識して、与えられたidで該当する
Author
インスタンスを検索してデータバインディングを行います
An association property can be set to null
by passing the literal String
"null". For example:
次のように、関連のプロパティに文字列で"null"と指定することで
null
をセットする事ができます
/book/save?author.id=null
メニーエンデッド・アソシエーション(複数終端関連)のデータバインディング
Data Binding and Many-ended Associations
If you have a one-to-many or many-to-many association there are different techniques for data binding depending of the association type.
one-to-manyまたはmany-to-manyなどの関連には、それぞれの関連形式よって違ったデータバインディング方法があります。
If you have a Set
based association (the default for a hasMany
) then the simplest way to populate an association is to send a list of identifiers. For example consider the usage of <g:select>
below:
Set
ベースの関連(
hasMany
でのデフォルト)で、簡単に関連を設定するには、idのリストを送る方法が有ります。以下の例は
<g:select>
を使用した方法です:
<g:select name="books"
from="${Book.list()}"
size="5" multiple="yes" optionKey="id"
value="${author?.books}" />
This produces a select box that lets you select multiple values. In this case if you submit the form Grails will automatically use the identifiers from the select box to populate the books
association.
このタグでは複数選択のセレクトボックスが生成されます。この例でフォームを送信すると、Grailsが自動的にセレクトボックスで選択されたidを使用して、
books
の関連を設定します。
However, if you have a scenario where you want to update the properties of the associated objects the this technique won't work. Instead you use the subscript operator:
ただしこの方法は、関連オブジェクトのプロパティを更新する場合は使用できません。代わりに添字演算子を使用します:
<g:textField name="books[0].title" value="the Stand" />
<g:textField name="books[1].title" value="the Shining" />
However, with Set
based association it is critical that you render the mark-up in the same order that you plan to do the update in. This is because a Set
has no concept of order, so although we're referring to books0
and books1
it is not guaranteed that the order of the association will be correct on the server side unless you apply some explicit sorting yourself.
ただし、
Set
ベースの関連では、マークアップ(HTML)が描写された順序とは同じ順序で更新されない危険性あります。 これは
Set
には順序という概念がなく、
books[0]
や
books[1]
と指定したとしても、サーバサイドでの関連のソートを明快に指定しない限り、順序が保証されないことになるからです。
This is not a problem if you use List
based associations, since a List
has a defined order and an index you can refer to. This is also true of Map
based associations.
List
ベース関連の場合は、
List
の順序とインデックスを指定することができるので問題有りません。
Map
ベース関連も同じ事がいえます。
Note also that if the association you are binding to has a size of two and you refer to an element that is outside the size of association:
さらに注意するポイントとして、バインドする関連が2個の物に、それより多い数の場合は:
<g:textField name="books[0].title" value="the Stand" />
<g:textField name="books[1].title" value="the Shining" />
<g:textField name="books[2].title" value="Red Madder" />
Then Grails will automatically create a new instance for you at the defined position. If you "skipped" a few elements in the middle:
Grailsが新たにインスタンスを指定したポジションに生成します。途中のいくつかのエレメントを飛ばした数値を指定した場合は:
<g:textField name="books[0].title" value="the Stand" />
<g:textField name="books[1].title" value="the Shining" />
<g:textField name="books[5].title" value="Red Madder" />
Then Grails will automatically create instances in between. For example in the above case Grails will create 4 additional instances if the association being bound had a size of 2.
Grailsが間のインスタンスも自動的に生成します。上記のケースでは関連が2個の場合は、4個のインスタンスが追加されます。
You can bind existing instances of the associated type to a List
using the same .id
syntax as you would use with a single-ended association. For example:
既存のインスタンスを
List
関連でバインドするには、単一終端関連と同じように
.id
シンタックスを使用します。例として:
<g:select name="books[0].id" from="${bookList}"
value="${author?.books[0]?.id}" /><g:select name="books[1].id" from="${bookList}"
value="${author?.books[1]?.id}" /><g:select name="books[2].id" from="${bookList}"
value="${author?.books[2]?.id}" />
Would allow individual entries in the books List
to be selected separately.
この例では、別々に選択して、
books List
の特定の場所にエントリを可能にします。
Entries at particular indexes can be removed in the same way too. For example:
同じ方法で、個々のインデックスからエントリの削除も可能です:
<g:select name="books[0].id"
from="${Book.list()}"
value="${author?.books[0]?.id}"
noSelection="['null': '']"/>
Will render a select box that will remove the association at books0
if the empty option is chosen.
上記の例では、空のオプションを選択することで、
book[0]
の関連を削除します。
Binding to a Map
property works the same way except that the list index in the parameter name is replaced by the map key:
リストのインデックス数値をパラメータ名称にすることで、マップのキーとして認識されるので、
Map
のプロパティも同じ方法で動作します:
<g:select name="images[cover].id"
from="${Image.list()}"
value="${book?.images[cover]?.id}"
noSelection="['null': '']"/>
This would bind the selected image into the Map
property images
under a key of "cover"
.
この例では、Mapプロパティimagesのキー"cover"に対してバインドされます。
複数ドメインクラスでのデータバインディング
Data binding with Multiple domain classes
It is possible to bind data to multiple domain objects from the
params object.
paramsオブジェクトから、複数のドメインオブジェクトへのデータのバインドが可能です。
For example so you have an incoming request to:
例として以下のようなリクエストがあったとします:
/book/save?book.title=The%20Stand&author.name=Stephen%20King
You'll notice the difference with the above request is that each parameter has a prefix such as author.
or book.
which is used to isolate which parameters belong to which type. Grails' params
object is like a multi-dimensional hash and you can index into it to isolate only a subset of the parameters to bind.
上記のリクエストでは、それぞれのパラメータに
author.
また
book.
という接頭辞が付いていて、どちらの型(ドメインクラス)に属するかを区別しています。Grailsの
params
オブジェクトは多次元ハッシュのようになっており、それぞれバインドするためのパラメータサブセットとして区別されて索引されます。
def b = new Book(params.book)
Notice how we use the prefix before the first dot of the book.title
parameter to isolate only parameters below this level to bind. We could do the same with an Author
domain class:
上記のように接頭辞bookをparams指定することで、ドメインクラスBookに対して、
book.title
パラメータだけが区別されてバインドされます。ドメインクラス
Author
も同じように指定します。
def a = new Author(params.author)
データバインディングとアクション引数
Data Binding and Action Arguments
Controller action arguments are subject to request parameter data binding. There are 2 categories of controller action arguments. The first category is command objects. Complex types are treated as command objects. See the
Command Objects section of the user guide for details. The other category is basic object types. Supported types are the 8 primitives, their corresponding type wrappers and
java.lang.String. The default behavior is to map request parameters to action arguments by name:
class AccountingController { // accountNumber will be initialized with the value of params.accountNumber
// accountType will be initialized with params.accountType
def displayInvoice(String accountNumber, int accountType) {
// …
}
}
For primitive arguments and arguments which are instances of any of the primitive type wrapper classes a type conversion has to be carried out before the request parameter value can be bound to the action argument. The type conversion happens automatically. In a case like the example shown above, the
params.accountType
request parameter has to be converted to an
int
. If type conversion fails for any reason, the argument will have its default value per normal Java behavior (null for type wrapper references, false for booleans and zero for numbers) and a corresponding error will be added to the
errors
property of the defining controller.
/accounting/displayInvoice?accountNumber=B59786&accountType=bogusValue
Since "bogusValue" cannot be converted to type int, the value of accountType will be zero,
controller.errors.hasErrors()
will be true,
controller.errors.errorCount
will be equal to 1 and
controller.errors.getFieldError('accountType')
will contain the corresponding error.
If the argument name does not match the name of the request parameter then the
@grails.web.RequestParameter
annotation may be applied to an argument to express the name of the request parameter which should be bound to that argument:
import grails.web.RequestParameterclass AccountingController { // mainAccountNumber will be initialized with the value of params.accountNumber
// accountType will be initialized with params.accountType
def displayInvoice(@RequestParameter('accountNumber') String mainAccountNumber, int accountType) {
// …
}
}
型変換エラーとデータバインディング
Data binding and type conversion errors
Sometimes when performing data binding it is not possible to convert a particular String into a particular target type. This results in a type conversion error. Grails will retain type conversion errors inside the
errors property of a Grails domain class. For example:
時折データバインディングの際に、特有の文字列を特有の型に変換できない場合があります。この場合の結果は型変換エラーとなります。Grailsではドメインインスタンスの
errorsプロパティで型変換エラーを保持します。例えば:
class Book {
…
URL publisherURL
}
Here we have a domain class Book
that uses the java.net.URL
class to represent URLs. Given an incoming request such as:
ドメインクラス
Book
でURLを表すプロパティに
java.net.URL
クラスを使用したとします。次のようなリクエストを受信したとします:
/book/save?publisherURL=a-bad-url
it is not possible to bind the string a-bad-url
to the publisherURL
property as a type mismatch error occurs. You can check for these like this:
型違いエラーが起きるため、文字列
a-bad-url
を
publisherURL
にバインドすることはできません。次のようにしてエラーを確認します:
def b = new Book(params)if (b.hasErrors()) {
println "The value ${b.errors.getFieldError('publisherURL').rejectedValue}" +
" is not a valid URL!"
}
Although we have not yet covered error codes (for more information see the section on
Validation), for type conversion errors you would want a message from the
grails-app/i18n/messages.properties
file to use for the error. You can use a generic error message handler such as:
この章までは、まだエラーコードの説明していませんが(詳しくは
Validationを参照)、型変換エラーでは
grails-app/i18n/messages.properties
を使用してメッセージを返す事もあると思います。次のような一般的なメッセージハンドラーを使用することもできます
typeMismatch.java.net.URL=The field {0} is not a valid URL
Or a more specific one:
また、さらに対象を特定する場合は:
typeMismatch.Book.publisherURL=The publisher URL you specified is not a valid URL
データバインディングとセキュリティ考慮
Data Binding and Security concerns
When batch updating properties from request parameters you need to be careful not to allow clients to bind malicious data to domain classes and be persisted in the database. You can limit what properties are bound to a given domain class using the subscript operator:
リクエストパラメータからのバッチ更新をする際は、クライアントからの悪意のあるデータを、ドメインクラスやデータベースへの永続化に反映させないように注意が必要です。添字演算子を使用してドメインクラスにバインドするプロパティを制限することができます。
def p = Person.get(1)p.properties['firstName','lastName'] = params
In this case only the firstName
and lastName
properties will be bound.
上記の例では、
firstName
と
lastName
のみバインドされます。
Another way to do this is is to use
Command Objects as the target of data binding instead of domain classes. Alternatively there is also the flexible
bindData method.
他には、データバインディングのターゲットをドメインクラスではなく
コマンドオブジェクトを利用する方法があります。あるいは柔軟な
bindDataメソッドを使用します。
The bindData
method allows the same data binding capability, but to arbitrary objects:
bindData
メソッドは任意のオブジェクトにデータバインディングが可能です:
def p = new Person()
bindData(p, params)
The bindData
method also lets you exclude certain parameters that you don't want updated:
bindData
メソッドでは、更新しないパラメータを除外する事が可能です:
def p = new Person()
bindData(p, params, [exclude: 'dateOfBirth'])
Or include only certain properties:
または、指定したプロパティのみの更新も可能です:
def p = new Person()
bindData(p, params, [include: ['firstName', 'lastName]])
Note that if an empty List is provided as a value for the include
parameter then all fields will be subject to binding if they are not explicitly excluded.
6.1.7 XMLとJSONのレスポンス
renderメソッドでXMLを出力する
Using the render method to output XML
Grails supports a few different ways to produce XML and JSON responses. The first is the
render method.
GrailsにはXMLとJSONを生成する複数の方法があります。はじめに
renderメソッド。
The render
method can be passed a block of code to do mark-up building in XML:
render
メソッドに、マークアップビルダーのコードブロックを渡してXML生成:
def list() { def results = Book.list() render(contentType: "text/xml") {
books {
for (b in results) {
book(title: b.title)
}
}
}
}
The result of this code would be something like:
このコードの結果は以下のようになります:
<books>
<book title="The Stand" />
<book title="The Shining" />
</books>
Be careful to avoid naming conflicts when using mark-up building. For example this code would produce an error:
マークアップビルダーを使用する際は、変数名称の衝突を回避する必要があります。例として次のコードはエラーになります:
def list() { def books = Book.list() // naming conflict here render(contentType: "text/xml") {
books {
for (b in results) {
book(title: b.title)
}
}
}
}
This is because there is local variable books
which Groovy attempts to invoke as a method.
この例では、Groovyがローカル変数のbooksをメソッドとして実行してしまいます。
renderメソッドでJSONを出力する
Using the render method to output JSON
The render
method can also be used to output JSON:
JSONを出力する場合も
render
メソッドが使用できます:
def list() { def results = Book.list() render(contentType: "text/json") {
books = array {
for (b in results) {
book title: b.title
}
}
}
}
In this case the result would be something along the lines of:
このコードの結果は以下のようになります:
[
{title:"The Stand"},
{title:"The Shining"}
]
The same dangers with naming conflicts described above for XML also apply to JSON building.
JSONビルダーもXMLと同じく、変数名称の衝突を回避する必要があります。
自動XMLマーシャリング
Automatic XML Marshalling
Grails also supports automatic marshalling of
domain classes to XML using special converters.
Grailsでは
ドメインクラスから特別なコンバータを使用した自動マーシャリングをサポートしています。
To start off with, import the grails.converters
package into your controller:
使用するには、
grails.converters
パッケージをインポートする必要があります:
import grails.converters.*
Now you can use the following highly readable syntax to automatically convert domain classes to XML:
ドメインクラスをXMLに変換するのに、次のように見やすいシンタックスで記述できます:
render Book.list() as XML
The resulting output would look something like the following::
この例では次のような結果を出力します:
<?xml version="1.0" encoding="ISO-8859-1"?>
<list>
<book id="1">
<author>Stephen King</author>
<title>The Stand</title>
</book>
<book id="2">
<author>Stephen King</author>
<title>The Shining</title>
</book>
</list>
またconvertersを使用する別の方法としてGrailsの
codecsを使用することもできます。codecsでは、
encodeAsXMLと
encodeAsJSONメソッドを提供しています:
def xml = Book.list().encodeAsXML()
render xml
For more information on XML marshalling see the section on
REST
XMLマーシャリングの情報は
RESTのセクションも参照してください。
自動JSONマーシャリング
Automatic JSON Marshalling
Grails also supports automatic marshalling to JSON using the same mechanism. Simply substitute XML
with JSON
:
Grailsでは
XML
と同じ仕組みで、
JSON
の自動マーシャリングもサポートしています。単純に先の
XML
を
JSON
にするだけです
render Book.list() as JSON
The resulting output would look something like the following:
この例では次のような結果を出力します:
[
{"id":1,
"class":"Book",
"author":"Stephen King",
"title":"The Stand"},
{"id":2,
"class":"Book",
"author":"Stephen King",
"releaseDate":new Date(1194127343161),
"title":"The Shining"}
]
Again as an alternative you can use the encodeAsJSON
to achieve the same effect.
もちろん、
encodeAsJSON
も同じ結果になります。
6.1.8 JSONBuilder (JSONビルダー)
The previous section on on XML and JSON responses covered simplistic examples of rendering XML and JSON responses. Whilst the XML builder used by Grails is the standard
XmlSlurper found in Groovy, the JSON builder is a custom implementation specific to Grails.
前のセクション「 XMLとJSONレスポンス」で単純なXMLとJSONのを描写してレスポンスする例を紹介しました。Grailsで使用してるXMLビルダーがGroovyの標準的な
XmlSlurper に対して、JSONビルダーに関してはGrails特有の実装になっています。
JSONBuilderとGrailsのバージョン
JSONBuilder and Grails versions
JSONBuilder behaves different depending on the version of Grails you use. For version below 1.2 the deprecated
grails.web.JSONBuilder class is used. This section covers the usage of the Grails 1.2 JSONBuilder
JSONBuilderの振る舞いは使用するGrailsのバージョンに依存します。1.2以前では現在非推奨となる
grails.web.JSONBuilderが使用されます。このセクションでは、Grails 1.2のJSONBuilderの説明をします。
For backwards compatibility the old JSONBuilder
class is used with the render
method for older applications; to use the newer/better JSONBuilder
class set the following in Config.groovy
:
下位互換として、古いバージョンからメンテナンスしているアプリケーションのために、
render
メソッドで古い
JSONBuilder
を使用するようになっています。新しい良くなった
JSONBuilder
を使用するには
Config.groovy
に、次のような設定をします:
grails.json.legacy.builder = false
単純なオブジェクトを描写
Rendering Simple Objects
To render a simple JSON object just set properties within the context of the Closure:
単純なJSONオブジェクトを生成するには、クロージャの中にプロパティをセットするだけです:
render(contentType: "text/json") {
hello = "world"
}
The above will produce the JSON:
上記の例では、このような結果が得られます:
JSON配列描写
Rendering JSON Arrays
To render a list of objects simple assign a list:
オブジェクトのリストを描写するには、変数に配列を指定するだけです:
render(contentType: "text/json") {
categories = ['a', 'b', 'c']
}
This will produce:
この例では以下を生成:
{"categories":["a","b","c"]}
You can also render lists of complex objects, for example:
複雑なオブジェクトのリストも可能です。例として:
render(contentType: "text/json") {
categories = [ { a = "A" }, { b = "B" } ]
}
This will produce:
この例では以下を生成:
{"categories":[ {"a":"A"} , {"b":"B"}] }
Use the special element
method to return a list as the root:
element
メソッドを使用することで、リストをルートとして返す事ができます:
render(contentType: "text/json") {
element 1
element 2
element 3
}
The above code produces:
この例では以下を生成:
複雑なオブジェクトの描写
Rendering Complex Objects
Rendering complex objects can be done with Closures. For example:
より複雑なオブジェクトをクロージャで描写できます。例として:
render(contentType: "text/json") {
categories = ['a', 'b', 'c']
title = "Hello JSON"
information = {
pages = 10
}
}
The above will produce the JSON:
この例では次のようなJSONを生成します:
{"categories":["a","b","c"],"title":"Hello JSON","information":{"pages":10}}
複雑なオブジェクトの配列
Arrays of Complex Objects
As mentioned previously you can nest complex objects within arrays using Closures:
前述したように、クロージャを使用してオブジェクトを配列にネストすることも可能です:
render(contentType: "text/json") {
categories = [ { a = "A" }, { b = "B" } ]
}
You can use the array
method to build them up dynamically:
array
メソッドを使用して動的に生成する事もできます:
def results = Book.list()
render(contentType: "text/json") {
books = array {
for (b in results) {
book title: b.title
}
}
}
JSONBuilder APIに直接アクセスする
Direct JSONBuilder API Access
If you don't have access to the render
method, but still want to produce JSON you can use the API directly:
renderメソッドと関係の無い場所ではJSONを生成したい場合はAPIを直に使用できます:
def builder = new JSONBuilder()def result = builder.build {
categories = ['a', 'b', 'c']
title = "Hello JSON"
information = {
pages = 10
}
}// prints the JSON text
println result.toString()def sw = new StringWriter()
result.render sw
6.1.9 ファイルアップロード
プログラムによるファイルアップロード
Programmatic File Uploads
Grails supports file uploads using Spring's
MultipartHttpServletRequest interface. The first step for file uploading is to create a multipart form like this:
Grailsでは、Springの
MultipartHttpServletRequestインターフェイスを使用してファイルアップロードをサポートしています。ファイルアップロードを実装するには、先に次のようにフォームをマルチパートフォームにします:
Upload Form: <br />
<g:uploadForm action="upload">
<input type="file" name="myFile" />
<input type="submit" />
</g:uploadForm>
The uploadForm
tag conveniently adds the enctype="multipart/form-data"
attribute to the standard <g:form>
tag.
uploadForm
タグは、通常の
<g:form>
タグに、
enctype="multipart/form-data"
の属性を追加します。
There are then a number of ways to handle the file upload. One is to work with the Spring
MultipartFile instance directly:
アップロードされたファイルを処理するには複数の方法があります。そのうちの一つはSpringの
MultipartFileインスタンスを直接操作する方法です:
def upload() {
def f = request.getFile('myFile')
if (f.empty) {
flash.message = 'file cannot be empty'
render(view: 'uploadForm')
return
} f.transferTo(new File('/some/local/dir/myfile.txt'))
response.sendError(200, 'Done')
}
This is convenient for doing transfers to other destinations and manipulating the file directly as you can obtain an
InputStream
and so on with the
MultipartFile interface.
この
MultipartFileを使用すると、ファイルを別の場所に転送したり、
InputStream
を取得して直接ファイルを操作したりなど便利です。
データバインディング経由のファイルアップロード
File Uploads through Data Binding
File uploads can also be performed using data binding. Consider this Image
domain class:
データバインディングでファイルアップロードを処理する事ができます。
Image
というドメインクラスがあるとします:
class Image {
byte[] myFile static constraints = {
// Limit upload file size to 2MB
myFile maxSize: 1024 * 1024 * 2
}
}
If you create an image using the params
object in the constructor as in the example below, Grails will automatically bind the file's contents as a byte
to the myFile
property:
次の例のように、
params
をコンストラクタに渡してImageオブジェクトを生成すると、Grailsが自動的にファイルのコンテントを
myFile
プロパティに
byte[]
としてバインドします:
def img = new Image(params)
It's important that you set the
size or
maxSize constraints, otherwise your database may be created with a small column size that can't handle reasonably sized files. For example, both H2 and MySQL default to a blob size of 255 bytes for
byte
properties.
この場合、データベースカラムのサイズが小さいと処理できなくなるので、
sizeまたは
maxSizeの制約を指定しましょう。例としてH2とMySQLは、
byte[]
プロパティで指定した場合のblobのデフォルトサイズが255バイトになります。
It is also possible to set the contents of the file as a string by changing the type of the myFile
property on the image to a String type:
テキストファイルなどの場合は、
myFile
プロパティの型をString型にすることで文字列にすることも可能です:
class Image {
String myFile
}
6.1.10 コマンドオブジェクト
Grails controllers support the concept of command objects. A command object is similar to a form bean in a framework like Struts, and they are useful for populating a subset of the properties needed to update a domain class. Or where there is no domain class required for the interaction, but you need features such as
data binding and
validation.
Grailsのコマンドオブジェクトの設計概念をサポートしています。コマンドオブジェクトはStrutsでのフォームビーンと同じような物で、ドメインクラスで更新に必要なプロパティサブセットを収集するなどに使用すると便利です。または、
データバインディングと
バリデーションを必要として、ドメインクラスを必要としない作用に使用します。
コマンドオブジェクトの宣言
Declaring Command Objects
Command objects are typically declared in the same source file as a controller, directly below the controller class definition. For example:
コマンドオブジェクトは通常使用するコントローラと同じファイルに宣言します。例として:
class UserController {
…
}class LoginCommand {
String username
String password static constraints = {
username(blank: false, minSize: 6)
password(blank: false, minSize: 6)
}
}
この例では、
ドメインクラスと同じ
constraints(制約)も定義しています。
コマンドオブジェクトを使用する
Using Command Objects
To use command objects, controller actions may optionally specify any number of command object parameters. The parameter types must be supplied so that Grails knows what objects to create, populate and validate.
コマンドオブジェクトを使用する際に、コントローラアクションに複数のコマンドオブジェクトパラメータを明記することができます。Grailsにどのオブジェクトを使用して、収集、バリデートするかを知らせるために、パラメータの型は必ず指定しましょう。
Before the controller action is executed Grails will automatically create an instance of the command object class, populate its properties with by binding the request parameters, and validate the command object. For example:
コントローラアクションが実行される前に、Grailsがコマンドオブジェクトのインスタンスを生成して、リクエストパラメータをバインドして、必要なプロパティを収集しコマンドオブジェクトでバリデートします。例として:
class LoginController { def login = { LoginCommand cmd ->
if (cmd.hasErrors()) {
redirect(action: 'loginForm')
return
} // work with the command object data
}
}
When using methods instead of Closures for actions, you can specify command objects in arguments:
クロージャアクションでは無く、メソッドアクションの場合は引数として明記します:
class LoginController {
def login(LoginCommand cmd) {
if (cmd.hasErrors()) {
redirect(action: 'loginForm')
return
} // work with the command object data
}
}
コマンドオブジェクトと依存注入
Command Objects and Dependency Injection
Command objects can participate in dependency injection. This is useful if your command object has some custom validation logic uses Grails
services:
コマンドオブジェクトに依存注入をすることが可能です。Grailsの
サービスを使用したカスタムバリデーションなどを使用する際に便利です:
class LoginCommand { def loginService String username
String password static constraints = {
username validator: { val, obj ->
obj.loginService.canLogin(obj.username, obj.password)
}
}
}
In this example the command object interacts with the loginService
bean which is injected by name from the Spring ApplicationContext
.
この例では、
loginService
をSpringの
ApplicatinContext
から名前解決でコマンドオブジェクトに注入しています。
Grails has built-in support for handling duplicate form submissions using the "Synchronizer Token Pattern". To get started you define a token on the
form tag:
Grailsには、"同期トークンパターン"を使用した、フォーム二重送信ハンドリングをサポートしています。使用するには、先ずは
formタグにuseToken属性を指定します:
<g:form useToken="true" ...>
Then in your controller code you can use the
withForm method to handle valid and invalid requests:
そして、コントローラアクションで
withFormメソッドを利用して、リクエストの有効・無効それぞれのコードを記述します:
withForm {
// good request
}.invalidToken {
// bad request
}
If you only provide the
withForm method and not the chained
invalidToken
method then by default Grails will store the invalid token in a
flash.invalidToken
variable and redirect the request back to the original page. This can then be checked in the view:
withFormメソッドのみを提供して
invalidToken
にチェインしなかった場合は、デフォルトでGrailsが無効トークンを
flash.invalidToken
に保持して、元のページにリクエストをリダイレクトします。これによってビューで以下のように確認できます:
<g:if test="${flash.invalidToken}">
Don't click the button twice!
</g:if>
The
withForm tag makes use of the
session and hence requires session affinity or clustered sessions if used in a cluster.
withFormメソッドはセッション(session)を使用するので、セッションの類似性またはクラスタで使用する場合はクラスタ化されたセッションが必要です。
6.1.12 シンプルタイプコンバータ
型変換メソッド
Type Conversion Methods
If you prefer to avoid the overhead of
Data Binding and simply want to convert incoming parameters (typically Strings) into another more appropriate type the
params object has a number of convenience methods for each type:
データバインディングでのオーバーヘッドを避けたい場合や、受信したパラメータに対して、単純な型変換行いたい場合、
paramsオブジェクトには、型によって幾つかの便利なメソッドが有ります:
def total = params.int('total')
The above example uses the int
method, and there are also methods for boolean
, long
, char
, short
and so on. Each of these methods is null-safe and safe from any parsing errors, so you don't have to perform any additional checks on the parameters.
上記の例ではintメソッドを使用しています。ほかに、
boolean
,
long
,
char
,
short
等多数のメソッドがあります。これらのメソッドはnullセーフであり、パースエラーセーフなので、パラメータに対してのチェックを追加する必要がありません。
Each of the conversion methods allows a default value to be passed as an optional second argument. The default value will be returned if a corresponding entry cannot be found in the map or if an error occurs during the conversion. Example:
型変換メソッドの第二引数にデフォルト値を設定することができます。一致する入力が無い場合や、型変換でエラーが起きた場合に指定したデフォルト値が返されます:
def total = params.int('total', 42)
These same type conversion methods are also available on the attrs
parameter of GSP tags.
GSPタグの
attrs
パラメータでも、同じ仕組みの型変換機能が使用できます。
複数の同一名称パラメータのハンドリング
Handling Multi Parameters
A common use case is dealing with multiple request parameters of the same name. For example you could get a query string such as ?name=Bob&name=Judy
.
よくあるケースとして、リクエストパラメータ内の複数の同じ名称を扱う場合があります。クエリーの例として、
"?name=Bob&name=Judy"
等。
In this case dealing with one parameter and dealing with many has different semantics since Groovy's iteration mechanics for
String
iterate over each character. To avoid this problem the
params object provides a
list
method that always returns a list:
パラメータに1つのみしか無い場合にイテレートしてしまうと、
String
の文字列が1文字ずつ参照されてしまいます。この問題を避けるために、
paramsオブジェクトの
list
メソッドを使用することで毎回リストを返すことが可能です:
for (name in params.list('name')) {
println name
}
6.1.13 非同期リクエスト処理
Grails support asynchronous request processing as provided by the Servlet 3.0 specification. To enable the async features you need to set your servlet target version to 3.0 in BuildConfig.groovy:
Servlet 3.0での非同期リクエスト処理をサポートしています。有効にするには、BuildConfig.groovy サーブレットバージョン指定を3.0に変更します。
grails.servlet.version = "3.0"
With that done ensure you do a clean re-compile as some async features are enabled at compile time.
設定を変更したら、async機能がコンパイル時に有効にするために、クリーンしてリコンパイルしてください。
With a Servlet target version of 3.0 you can only deploy on Servlet 3.0 containers such as Tomcat 7 and above.
Servlet 3.0を指定した場合は、Servlet 3.0のみ対応でデプロイされるので、Servlet 3.0に対応したコンテナ(Tomcatの場合は7以上)で運用しましょう。
非同期描写
Asynchronous Rendering
You can render content (templates, binary data etc.) in an asynchronous manner by calling the startAsync
method which returns an instance of the Servlet 3.0 AsyncContext
. Once you have a reference to the AsyncContext
you can use Grails' regular render method to render content:
Servlet 3.0のAsyncContextインスタンスを返す
startAsync
メソッドを呼び出すことで、非同期でコンテンツが描写(テンプレート、バイナリー等)できます。
AsyncContext
の参照をするだけで、あとは通常のGrailsのrenderメソッドを使用してコンテンツを描写できます。
def index() {
def ctx = startAsync()
ctx.start {
new Book(title:"The Stand").save()
render template:"books", model:[books:Book.list()]
ctx.complete()
}
}
Note that you must call the complete()
method to terminate the connection.
コネクションを終了するには必ず
complete()
メソッドをコールしてください。
非同期リクエストの再開
Resuming an Async Request
You resume processing of an async request (for example to delegate to view rendering) by using the dispatch
method of the AsyncContext
class:
非同期リクエストを再開するには、
AsyncContext
クラスの
dispatch()
メソッドを使用します。
def index() {
def ctx = startAsync()
ctx.start {
// do working
…
// render view
ctx.dispatch()
}
}
6.2 Groovyサーバーページ
Groovy Servers Pages (or GSP for short) is Grails' view technology. It is designed to be familiar for users of technologies such as ASP and JSP, but to be far more flexible and intuitive.
Groovy Server Pages(GSPと略す)は、Grailsのビュー技術です。より柔軟で直感的であり、ASPやJSPのような技術に精通しているユーザ向けに設計されています。
GSPs live in the
grails-app/views
directory and are typically rendered automatically (by convention) or with the
render method such as:
GSPは、grails-app/viewsディレクトリに配置されていて、通常は自動的(慣習によって)または、以下のように
renderメソッドで描写します。
A GSP is typically a mix of mark-up and GSP tags which aid in view rendering.
GSPはマークアップとビュー描写を補助するGSPタグで内容が構成されています。
Although it is possible to have Groovy logic embedded in your GSP and doing this will be covered in this document, the practice is strongly discouraged. Mixing mark-up and code is a bad thing and most GSP pages contain no code and needn't do so.
GroovyロジックをGSPに埋め込むことも可能ですが推奨しません。マークアップとコードが混在するのは良いことではありません。ほとんどのGSPではコードを持つべきで無く、そうする必要がありません。
A GSP typically has a "model" which is a set of variables that are used for view rendering. The model is passed to the GSP view from a controller. For example consider the following controller action:
GSPは通常ビュー描写に使用される変数のセットなどの"モデル"を持っています。モデルはコントローラからGSPビューげ渡されます。例として次のコントローラアクションを見てみましょう。
def show() {
[book: Book.get(params.id)]
}
This action will look up a Book
instance and create a model that contains a key called book
. This key can then be referenced within the GSP view using the name book
:
このアクションは
Book
インスタンスを取り出して、
book
というキーでモデルを作成しています。GSPでは、このキー
book
が参照できます。
6.2.1 GSPの基本
In the next view sections we'll go through the basics of GSP and what is available to you. First off let's cover some basic syntax that users of JSP and ASP should be familiar with.
ここのセクションでは、GSPで何が可能かの基礎を見ていきましょう。先ずはじめにJSPやASPのユーザに親和性の高い基本的なシンタックスをカバーしていきます。
GSP supports the usage of <% %>
scriptlet blocks to embed Groovy code (again this is discouraged):
GSPは、Groovyを記述できる、スクリプトレットブロック
<% %>
をサポートしています。(しつこいですが推奨しません)
<html>
<body>
<% out << "Hello GSP!" %>
</body>
</html>
You can also use the <%= %>
syntax to output values:
もちろん
<%= %>
を使用して値を出力することもできます。
<html>
<body>
<%="Hello GSP!" %>
</body>
</html>
GSP also supports JSP-style server-side comments (which are not rendered in the HTML response) as the following example demonstrates:
次のようなJSPスタイルのサーバサイドコメント(HTMLに出力されない)もサポートされています。
<html>
<body>
<%-- This is my comment --%>
<%="Hello GSP!" %>
</body>
</html>
6.2.1.1 変数とスコープ
Within the <% %>
brackets you can declare variables:
<% %>
で変数を宣言できます。
and then access those variables later in the page:
宣言した変数はページ内でアクセスすることができます。
Within the scope of a GSP there are a number of pre-defined variables, including:
GSPには、初期定義されたスコープ変数がいくつか存在します。
6.2.1.2 ロジックとイテレーション
Using the <% %>
syntax you can embed loops and so on using this syntax:
以下のように
<% %>
シンタックスを使ってループなどを記述できます。
<html>
<body>
<% [1,2,3,4].each { num -> %>
<p><%="Hello ${num}!" %></p>
<%}%>
</body>
</html>
As well as logical branching:
また他に分岐も
<html>
<body>
<% if (params.hello == 'true')%>
<%="Hello!"%>
<% else %>
<%="Goodbye!"%>
</body>
</html>
6.2.1.3 ページディレクティブ
GSP also supports a few JSP-style page directives.
GSPはJSPのページディレクティブの一部をサポートしています。
The import directive lets you import classes into the page. However, it is rarely needed due to Groovy's default imports and
GSP Tags:
importディレクティブは、ページにクラスをインポートします。
<%@ page import="java.awt.*" %>
GSP also supports the contentType directive:
contentTypeディレクティブもサポートしています。
<%@ page contentType="text/json" %>
The contentType directive allows using GSP to render other formats.
contentTypeディレクティブはGSPを別のフォーマットを可能にします。
6.2.1.4 エクスプレッション
In GSP the <%= %>
syntax introduced earlier is rarely used due to the support for GSP expressions. A GSP expression is similar to a JSP EL expression or a Groovy GString and takes the form ${expr}
:
GSPでは、先に紹介した
<%= %>
シンタックスは滅多に使用しません。代わりに、JSPの式言語(JSP EL)と同じような機能をもつGSP(Groovy)表記または、
${expr}
のようなGroovyのGStringを使用します。
<html>
<body>
Hello ${params.name}
</body>
</html>
However, unlike JSP EL you can have any Groovy expression within the ${..}
block. Variables within the ${..}
block are not escaped by default, so any HTML in the variable's string is rendered directly to the page. To reduce the risk of Cross-site-scripting (XSS) attacks, you can enable automatic HTML escaping with the grails.views.default.codec
setting in grails-app/conf/Config.groovy
:
JSP式言語(JSP EL)と違い、Groovy表記は、
${…}
ブロックに記述します。
${…}
ブロックの変数はデフォルトではエスケープを行いません。したがって、HTML文字列が直接ページ内に描写されます。これによって起こりうる、XSS(クロスサイトスクリプティング)をリスクを軽減するには、
grails-app/conf/Config.groovy
に
grails.views.default.codec
を設定します。
grails.views.default.codec='html'
Other possible values are 'none' (for no default encoding) and 'base64'.
他に設定可能な値は'none'(何も設定しない)と'base64'になります。
Now that the less attractive JSP heritage has been set aside, the following sections cover GSP's built-in tags, which are the preferred way to define GSP pages.
魅力の低い遺産JSPはさておき、このセクションではGSPの組込タグを、GSPページでどのように活用すると良いか解説していきます。
The section on
Tag Libraries covers how to add your own custom tag libraries.
カスタムタグの追加などは、タグライブラリのセクションで解説します。
All built-in GSP tags start with the prefix g:
. Unlike JSP, you don't specify any tag library imports. If a tag starts with g:
it is automatically assumed to be a GSP tag. An example GSP tag would look like:
全ての組込GSPタグは接頭辞
g:
で始まるタグです。JSPと違いタグライブラリのインポートが必要有りません。
g:
接頭辞のタグは自動的にGSPタグとして用いられます。例としてGSPタグの見ためは次のようになります:
GSP tags can also have a body such as:
GSPタグの内容も記述できます:
<g:example>
Hello world
</g:example>
Expressions can be passed into GSP tag attributes, if an expression is not used it will be assumed to be a String value:
GSPのタグ属性にエクスプレッションを記述できます。エクスプレッションを使用しない場合は文字列として値が用いられます。:
<g:example attr="${new Date()}">
Hello world
</g:example>
Maps can also be passed into GSP tag attributes, which are often used for a named parameter style syntax:
GSPのタグ属性に、ひんぱんに使用する名前付きパラメータ構文として、Map型を記述できます:
<g:example attr="${new Date()}" attr2="[one:1, two:2, three:3]">
Hello world
</g:example>
Note that within the values of attributes you must use single quotes for Strings:
属性内での、Mapの文字列値はシングルクォートを使用してください:
<g:example attr="${new Date()}" attr2="[one:'one', two:'two']">
Hello world
</g:example>
With the basic syntax out the way, the next sections look at the tags that are built into Grails by default.
ここまでで基本構文は全てです。次のセクションではどのようなタグがGrailsにデフォルトで組み込まれているか見ていきましょう。
6.2.2.1 変数とスコープ
Variables can be defined within a GSP using the
set tag:
GSPでは変数を
setタグで定義することができます:
<g:set var="now" value="${new Date()}" />
Here we assign a variable called now
to the result of a GSP expression (which simply constructs a new java.util.Date
instance). You can also use the body of the <g:set>
tag to define a variable:
この例では変数
now
にGSP表記の結果を割り当てています(単純に
java.util.Date
のインスタンスを生成しただけです)。
<g:set>
タグのタグ内容に記述して定義することもできます。:
<g:set var="myHTML">
Some re-usable code on: ${new Date()}
</g:set>
Variables can also be placed in one of the following scopes:
変数は以下のいずれかのスコープに定義することができます:
page
- Scoped to the current page (default)
request
- Scoped to the current request
flash
- Placed within flash scope and hence available for the next request
session
- Scoped for the user session
application
- Application-wide scope.
page
- (デフォルト)現在のページ
request
- 現在のリクエスト
flash
- flashスコープに配置され、次のリクエストまで。
session
- ユーザのセッション
application
- アプリケーション全体
To specify the scope, use the scope
attribute:
スコープの定義は、
scope
属性に指定します:
<g:set var="now" value="${new Date()}" scope="request" />
6.2.2.2 ロジックとイテレーション
GSP also supports logical and iterative tags out of the box. For logic there are
if,
else and
elseif tags for use with branching:
GSPにはすぐに活用できるロジックタグとイテレーションタグがあります。ロジックタグは分岐に使用する
if,
else,
elseifです:
<g:if test="${session.role == 'admin'}">
<%-- show administrative functions --%>
</g:if>
<g:else>
<%-- show basic functions --%>
</g:else>
イテレーションには
eachタグと
whileタグを使用します:
<g:each in="${[1,2,3]}" var="num">
<p>Number ${num}</p>
</g:each><g:set var="num" value="${1}" />
<g:while test="${num < 5 }">
<p>Number ${num++}</p>
</g:while>
6.2.2.3 検索とフィルタリング
If you have collections of objects you often need to sort and filter them. Use the
findAll and
grep tags for these tasks:
オブジェクトのコレクションを扱う場合はソート、フィルタリングが必要になります。その場合は
findAllタグと
grepタグが活用できます:
Stephen King's Books:
<g:findAll in="${books}" expr="it.author == 'Stephen King'">
<p>Title: ${it.title}</p>
</g:findAll>
The
expr
attribute contains a Groovy expression that can be used as a filter. The
grep tag does a similar job, for example filtering by class:
フィルターとして使うGroovy式を
expr
属性に記述します。
grepタグも同じような動作をします。クラスでのフィルタリングを例とすると:
<g:grep in="${books}" filter="NonFictionBooks.class">
<p>Title: ${it.title}</p>
</g:grep>
Or using a regular expression:
正規表現を使用した例:
<g:grep in="${books.title}" filter="~/.*?Groovy.*?/">
<p>Title: ${it}</p>
</g:grep>
The above example is also interesting due to its usage of GPath. GPath is an XPath-like language in Groovy. The books
variable is a collection of Book
instances. Since each Book
has a title
, you can obtain a list of Book titles using the expression books.title
. Groovy will auto-magically iterate the collection, obtain each title, and return a new list!
上記の例ではGPathも使用方法も紹介されています。GPathはGroovyでのXpathのような言語です。変数
books
は
Book
インスタンスのコレクションです。全ての
Book
にプロパティ
title
が有る場合、
books.title
とすることで
Book
の
title
プロパティのリストを得られます。Groovyは自動的にコレクションを検索して全ての
title
を含んだリストを返してくれます。
6.2.2.4 リンクとリソース
GSP also features tags to help you manage linking to controllers and actions. The
link tag lets you specify controller and action name pairing and it will automatically work out the link based on the
URL Mappings, even if you change them! For example:
コントローラとアクションでのリンクを操作するGSPタグがあります。
linkタグはコントローラとアクション名を指定するだけで
URLマッピングをベースとしたリンクを自動的に生成します(
URLマッピングで変更をしても)。:
<g:link action="show" id="1">Book 1</g:link><g:link action="show" id="${currentBook.id}">${currentBook.name}</g:link><g:link controller="book">Book Home</g:link><g:link controller="book" action="list">Book List</g:link><g:link url="[action: 'list', controller: 'book']">Book List</g:link><g:link params="[sort: 'title', order: 'asc', author: currentBook.author]"
action="list">Book List</g:link>
フォームの基礎
Form Basics
GSP supports many different tags for working with HTML forms and fields, the most basic of which is the
form tag. This is a controller/action aware version of the regular HTML form tag. The
url
attribute lets you specify which controller and action to map to:
GSPではHTMLのフォームとフィールドに対応した様々なタグをサポートしています。フォーム・フィールドの基礎となるタグはformタグです。
formタグは、通常のHTML formタグが、コントローラ・アクションを意識してる版みたいな物です。次のように、
url
属性にマップでコントローラアクションを指定します:
<g:form name="myForm" url="[controller:'book',action:'list']">...</g:form>
In this case we create a form called myForm
that submits to the BookController
's list
action. Beyond that all of the usual HTML attributes apply.
この例では、
myForm
という名称で、
BookController
の
list
アクションへ送信するフォームを生成します。通常のHTML属性はそのまま使用できます。
フォームフィールド
Form Fields
In addition to easy construction of forms, GSP supports custom tags for dealing with different types of fields, including:
フォームを簡単に作成するために、GSPでは多数種類のフィールドタグをサポートしています:
- textField - For input fields of type 'text'
- passwordField - For input fields of type 'password'
- checkBox - For input fields of type 'checkbox'
- radio - For input fields of type 'radio'
- hiddenField - For input fields of type 'hidden'
- select - For dealing with HTML select boxes
Each of these allows GSP expressions for the value:
value属性の値にGSPエクスプレッションを使用できます:
<g:textField name="myField" value="${myValue}" />
そのほかに、これらのタグを拡張した、
radioGroup(
radioタグのセットを作成)タグや、
localeSelect、
currencySelect、
timeZoneSelect等、それぞれ、ロケール、通貨、タイムゾーンに対応したタグもあります。
マルチ送信ボタン
Multiple Submit Buttons
The age old problem of dealing with multiple submit buttons is also handled elegantly with Grails using the
actionSubmit tag. It is just like a regular submit, but lets you specify an alternative action to submit to:
Grailsでは、
actionSubmitタグを使用することで、マルチ送信ボタン対応は、すっきりと実装できます。単純な送信ボタンのように見えますが、action属性にアクションを指定すると、指定したアクションへフォームが送信されるようになります。
<g:actionSubmit value="Some update label" action="update" />
One major different between GSP tags and other tagging technologies is that GSP tags can be called as either regular tags or as method calls from
controllers,
tag libraries or GSP views.
GSPタグと他のタグ技術との大きな違いは、通常のタグとしての利用だけではなく、
コントローラ、
タグライブラリまたはGSPビューから、メソッドとして呼び出せるという点です。
GSPでタグをメソッドとして使用する
Tags as method calls from GSPs
Tags return their results as a String-like object (a StreamCharBuffer
which has all of the same methods as String) instead of writing directly to the response when called as methods. For example:
タグをメソッドとして使用すると、結果をレスポンスへ出力する代わりに、文字列のようなオブジェクトで返します(Stringと同じメソッドを持つ
StreamCharBuffer
)。:
Static Resource: ${createLinkTo(dir: "images", file: "logo.jpg")}
This is particularly useful for using a tag within an attribute:
タグの属性内に使用する際などに特に便利です:
<img src="${createLinkTo(dir: 'images', file: 'logo.jpg')}" />
In view technologies that don't support this feature you have to nest tags within tags, which becomes messy quickly and often has an adverse effect of WYSWIG tools such as Dreamweaver that attempt to render the mark-up as it is not well-formed:
以下の例のように、このような機能をもたないタグ技術は、タグをネストしないといけません。これだとすぐにコードは乱雑になり、Dreamweaver等のツールでの表示が正常になりません:
<img src="<g:createLinkTo dir="images" file="logo.jpg" />" />
コントローラとタグライブラリでタグをメソッドとして使用する
Tags as method calls from Controllers and Tag Libraries
You can also invoke tags from controllers and tag libraries. Tags within the default
g:
namespace can be invoked without the prefix and a
StreamCharBuffer
result is returned:
コントローラとタブライブラリ(実装側)で、タグを呼び出す事が可能です。デフォルトの
ネームスペースg:
を持つタグは、接頭辞無しで呼び出す事で、結果に
StreamCharBuffer
を返します:
def imageLocation = createLinkTo(dir:"images", file:"logo.jpg").toString()
Prefix the namespace to avoid naming conflicts:
名前の衝突を避けるために、ネームスペースを接頭辞とする場合は:
def imageLocation = g.createLinkTo(dir:"images", file:"logo.jpg").toString()
カスタムネームスペースを使用しているタグの場合は、
カスタムネームスペースを接頭辞として使います。
FCKエディタープラグインを例とすると:
def editor = fckeditor.editor(name: "text", width: "100%", height: "400")
6.2.3 ビューとテンプレート
Grails also has the concept of templates. These are useful for partitioning your views into maintainable chunks, and combined with
Layouts provide a highly re-usable mechanism for structured views.
Grailsもテンプレートの概念を持っています。ビューを管理しやすいかたまりに分類して
レイアウト機能で結合する際に活用できます。
テンプレートの基礎
Template Basics
Grails uses the convention of placing an underscore before the name of a view to identify it as a template. For example, you might have a template that renders Books located at grails-app/views/book/_bookTemplate.gsp
:
Grailsでは、アンダースコアがビュー名称の前にあるとテンプレートとして認識するルールがあります。例として、Bookコントローラからbookを描写するテンプレートは
grails-app/views/books/
に
_bookTemplate.gsp
として配置:
<div class="book" id="${book?.id}">
<div>Title: ${book?.title}</div>
<div>Author: ${book?.author?.name}</div>
</div>
Use the
render tag to render this template from one of the views in
grails-app/views/book
:
grails-app/views/book
の配置したビューで、テンプレートを使用するには、
renderタグを使います:
<g:render template="bookTemplate" model="[book: myBook]" />
Notice how we pass into a model to use using the model
attribute of the render
tag. If you have multiple Book
instances you can also render the template for each Book
using the render tag with a collection
attribute:
この例のrenderタグのmodel属性を使用してモデルをテンプレートに渡している部分に注目してください。もし複数の
Book
インスタンスを使用して、それぞれの
Book
をテンプレートで描写する場合は、以下のように
render
タグの
collection
属性にコレクションを指定します:
<g:render template="bookTemplate" var="book" collection="${bookList}" />
テンプレートの共有
Shared Templates
In the previous example we had a template that was specific to the BookController
and its views at grails-app/views/book
. However, you may want to share templates across your application.
前の例では
BookController
と
grails-app/views/book
階層以下のビューを対象に説明しました。テンプレートはアプリケーション全体を通して使用したいと思います。
In this case you can place them in the root views directory at grails-app/views or any subdirectory below that location, and then with the template attribute use an absolute location starting with /
instead of a relative location. For example if you had a template called grails-app/views/shared/_mySharedTemplate.gsp
, you would reference it as:
このケースでは、ビューのルートディレクトリである grails-app/views、あるいはルートディレクトのサブディレクトリにテンプレートファイルを配置して、template属性には、
/(スラッシュ)
から始まる grails-app/viewsからの絶対パスで指定します。例として、テンプレートファイルが、
grails-app/views/shared/_mySharedTemplate.gsp
だとした場合は次のように指定します:
<g:render template="/shared/mySharedTemplate" />
You can also use this technique to reference templates in any directory from any view or controller:
この方法では、どこにテンプレートが配置されていても、どのビューまたはコントローラからでもテンプレートが使用できます:
<g:render template="/book/bookTemplate" model="[book: myBook]" />
テンプレートネームスペース
The Template Namespace
Since templates are used so frequently there is template namespace, called tmpl
, available that makes using templates easier. Consider for example the following usage pattern:
テンプレートを多用する場合は、テンプレートを簡単に使用するための
tmpl
という名称の、テンプレートネームスペースが使用できます:
<g:render template="bookTemplate" model="[book:myBook]" />
This can be expressed with the
tmpl
namespace as follows:
上記の例を
tmpl
ネームスペースで記述すると以下のようになります:
<tmpl:bookTemplate book="${myBook}" />
コントローラとタグライブラリでのテンプレート
Templates in Controllers and Tag Libraries
You can also render templates from controllers using the
render controller method. This is useful for
Ajax applications where you generate small HTML or data responses to partially update the current page instead of performing new request:
コントローラの
renderメソッドを使用してコントローラでテンプレートを描写することもできます。
Ajaxアプリケーションのように、ページ内の一部をHTMLのパーツやデータをレスポンスして更新する場合に有用です:
def bookData() {
def b = Book.get(params.id)
render(template:"bookTemplate", model:[book:b])
}
The
render controller method writes directly to the response, which is the most common behaviour. To instead obtain the result of template as a String you can use the
render tag:
通常の振る舞いですが、コントローラの
renderメソッドは直接結果をレスポンス出力します。文字列としてテンプレートの結果を取得する場合は、
renderタグを使用できます。:
def bookData() {
def b = Book.get(params.id)
String content = g.render(template:"bookTemplate", model:[book:b])
render content
}
Notice the usage of the
g
namespace which tells Grails we want to use the
tag as method call instead of the
render method.
ネームスペース
g
を使用することで
タグをメソッドとして使用するのか、コントローラの
renderメソッドなのかを区別しています。
6.2.4 Sitemeshでレイアウト
レイアウトを作成する
Creating Layouts
Grails leverages
Sitemesh, a decorator engine, to support view layouts. Layouts are located in the
grails-app/views/layouts
directory. A typical layout can be seen below:
Grailsはデコレータエンジン
Sitemeshの力を借りてビューレイアウトをサポートしています。レイアウトは
grails-app/views/layouts
ディレクトリに配置します。標準的なレイアウトは以下のようになります:
<html>
<head>
<title><g:layoutTitle default="An example decorator" /></title>
<g:layoutHead />
</head>
<body onload="${pageProperty(name:'body.onload')}">
<div class="menu"></menu>
<div class="body">
<g:layoutBody />
</div>
</div>
</body>
</html>
鍵となるエレメントは、
layoutHead、
layoutTitle、
layoutBodyタグです:
layoutTitle
- outputs the target page's title
layoutHead
- outputs the target page's head tag contents
layoutBody
- outputs the target page's body tag contents
layoutTitle
- ページのタイトルを出力
layoutHead
- ページのheadタグコンテントを出力
layoutBody
- ページのbodyタグコンテントを出力
The previous example also demonstrates the
pageProperty tag which can be used to inspect and return aspects of the target page.
さらに前述した例では、指定した内容をターゲットページから精査して内容を返す
pagePropertyタグの紹介しています。
レイアウトを反映させる
Triggering Layouts
There are a few ways to trigger a layout. The simplest is to add a meta tag to the view:
レイアウトを反映させる幾つかの方法があります。簡単な方法は、ビューにmetaタグを追加するだけです:
<html>
<head>
<title>An Example Page</title>
<meta name="layout" content="main" />
</head>
<body>This is my content!</body>
</html>
In this case a layout called grails-app/views/layouts/main.gsp
will be used to layout the page. If we were to use the layout from the previous section the output would resemble this:
この例では、レイアウトの
grails-app/views/layouts/main.gsp
が呼び出されてページのレイアウトに使用されます。内容が先ほどのレイアウトの内奥であれば、以下のような出力が得られます:
<html>
<head>
<title>An Example Page</title>
</head>
<body onload="">
<div class="menu"></div>
<div class="body">
This is my content!
</div>
</body>
</html>
コントローラでレイアウトを指定
Specifying A Layout In A Controller
Another way to specify a layout is to specify the name of the layout by assigning a value to the "layout" property in a controller. For example, if you have a controller such as:
別の方法として、コントローラに"layout"プロパティの値としてレイアウトする事ができます。例として以下のようなコントローラがあるとしたら:
class BookController {
static layout = 'customer' def list() { … }
}
You can create a layout called grails-app/views/layouts/customer.gsp
which will be applied to all views that the BookController
delegates to. The value of the "layout" property may contain a directory structure relative to the grails-app/views/layouts/
directory. For example:
grails-app/views/layouts/customer.gspと
いうレイアウトファイルを作成すると、
BookController
に連動する全てのビューに反映します。
"layout"プロパティの値は
grails-app/views/layouts/
ディレクトリが含まれます。例として:
class BookController {
static layout = 'custom/customer' def list() { … }
}
Views rendered from that controller would be decorated with the
grails-app/views/layouts/custom/customer.gsp
template.
この例で、このコントローラのビューは、
grails-app/views/layouts/custom/customer.gsp
テンプレートでデコレートされます。
慣習によるレイアウト
Layout by Convention
Another way to associate layouts is to use "layout by convention". For example, if you have this controller:
"慣習によるレイアウト"によってレイアウトと連動することが可能です。例として、次のようなコントローラがあるとします:
class BookController {
def list() { … }
}
You can create a layout called grails-app/views/layouts/book.gsp
, which will be applied to all views that the BookController
delegates to.
BookController
のビューに反映されるレイアウト
grails-app/views/layouts/book.gsp
を作成できます。
Alternatively, you can create a layout called grails-app/views/layouts/book/list.gsp
which will only be applied to the list
action within the BookController
.
あるいは、
BookController
のアクション
list
のみに反映するレイアウト
grails-app/views/layouts/book/list.gsp
を作成できます。
If you have both the above mentioned layouts in place the layout specific to the action will take precedence when the list action is executed.
両方のレイアウトが存在する場合は、アクションに指定したレイアウトが優先されます。
If a layout may not be located using any of those conventions, the convention of last resort is to look for the application default layout which
is grails-app/views/layouts/application.gsp
. The name of the application default layout may be changed by defining a property
in grails-app/conf/Config.groovy
as follows:
もしこれらの慣習にあわせたレイアウトが存在しない場合は、最終的にデフォルトレイアウトの
grails-app/views/layouts/application.gsp
を探しに行きます。アプリケーションのデフォルトレイアウト名称は、次のプロパティを
grails-app/conf/Config.groovy
に定義することで変更が可能です。:
grails.sitemesh.default.layout = 'myLayoutName'
With that property in place, the application default layout will be grails-app/views/layouts/myLayoutName.gsp
.
この例でのアプリケーションのデフォルトレイアウトは
grails-app/views/layouts/myLayoutName.gsp
になります。
インラインレイアウト
Inline Layouts
Grails' also supports Sitemesh's concept of inline layouts with the
applyLayout tag. This can be used to apply a layout to a template, URL or arbitrary section of content. This lets you even further modularize your view structure by "decorating" your template includes.
Grailsでは、
applyLayoutタグを使用することでSitemeshのインラインレイアウトをサポートしています。インラインレイアウトでは、テンプレート、URL、任意のコンテントにレイアウトを使用することができます。
Some examples of usage can be seen below:
例としては以下のようになります:
<g:applyLayout name="myLayout" template="bookTemplate" collection="${books}" /><g:applyLayout name="myLayout" url="http://www.google.com" /><g:applyLayout name="myLayout">
The content to apply a layout to
</g:applyLayout>
サーバーサイドインクルード
Server-Side Includes
While the
applyLayout tag is useful for applying layouts to external content, if you simply want to include external content in the current page you use the
include tag:
applyLayoutタグは、外部コンテントに対してレイアウトを反映させるのに便利ですが、単純に外部コンテンツを現在のページに含みたい場合は
includeタグが使用できます。
<g:include controller="book" action="list" />
柔軟な対応をするために、
applyLayoutタグと
includeタグを一緒に利用できます:
<g:applyLayout name="myLayout">
<g:include controller="book" action="list" />
</g:applyLayout>
Finally, you can also call the
include tag from a controller or tag library as a method:
もちろん、
includeタグをメソッドとして、コントローラやタグライブラリで使用できます:
def content = include(controller:"book", action:"list")
The resulting content will be provided via the return value of the
include tag.
コンテントの結果は、
includeタグの返値で提供されます。
6.2.5 静的リソース
Grails 2.0 integrates with the
Resources plugin to provide sophisticated static resource management. This plugin is installed by default in new Grails applications.
2.0から、洗練された静的リソース管理を提供する
Resourcesプラグインを統合しています。このプラグインはデフォルトで新規Grailsアプリケーションにインストールされます。
The basic way to include a link to a static resource in your application is to use the
resource tag. This simple approach creates a URI pointing to the file.
静的リソースのリンクを含む場合、通常
resourceタグを使用します。これはURIでファイルを指定する簡単なアプローチになります。
However modern applications with dependencies on multiple JavaScript and CSS libraries and frameworks (as well as dependencies on multiple Grails plugins) require something more powerful.
しかし近頃のアプリケーションは、様々なJavaScriptやCSSライブラリやフレームワークに依存しており、もっとパワフルな方法が必要となります。
The issues that the Resources framework tackles are:
Resourceフレームワークの取り組んだ課題:
- Web application performance tuning is difficult
- Correct ordering of resources, and deferred inclusion of JavaScript
- Resources that depend on others that must be loaded first
- The need for a standard way to expose static resources in plugins and applications
- The need for an extensible processing chain to optimize resources
- Preventing multiple inclusion of the same resource
- Webアプリケーションのパフォーマンスチューニングが難しい
- リソースの配置順と、JavaScriptの遅延包括
- 先に読み込む必要のある依存関係のあるリソース
- プラグインやアプリケーションでの、静的リソースを表示する方法の標準化が必要
- リソースの最適化を行うための拡張可能な連鎖行程が必要
- 同じリソースの多重配置を防ぐ
The plugin achieves this by introducing new artefacts and processing the resources using the server's local file system.
プラグインでアーテファクトの提供と、サーバのローカルファイルシステムを使用して処理をすることで、これらを達成しています。
It adds artefacts for declaring resources, for declaring "mappers" that can process resources, and a servlet filter to serve processed resources.
プラグインは、リソースを宣言するためのアーテファクト、リソースを処理する"マッパー"、処理されたリソースを提供するサーブレットフィルタを追加します。
What you get is an incredibly advanced resource system that enables you to easily create highly optimized web applications that run the same in development and in production.
信じられないほど上級のリソースシステムが、簡単に高度に最適化されたWebアプリケーション作成をdevelpoment,productionモード共に可能とします。
The Resources plugin documentation provides a more detailed overview of the
concepts which will be beneficial when reading the following guide.
リソースプラグインの
ドキュメントでは、さらに詳細な内容を提供しています。
r:requireでリソースを制御する
Pulling in resources with r:require
To use resources, your GSP page must indicate which resource modules it requires. For example with the
jQuery plugin, which exposes a "jquery" resource module, to use jQuery in any page on your site you simply add:
リソースを使用するにはどのリソースモジュールが必要がGSPページで示す必要があります。例として、"jquery"リソースモジュールを提供している
jQueryプラグインを、サイトの全てのページで使用する場合は単に次のように追加するだけです:
<html>
<head>
<r:require module="jquery"/>
<r:layoutResources/>
</head>
<body>
…
<r:layoutResources/>
</body>
</html>
This will automatically include all resources needed for jQuery, including them at the correct locations in the page. By default the plugin sets the disposition to be "head", so they load early in the page.
これで自動的にjQueryで必要なリソースをページの正確な場所に配置します。デフォルトではプラグインが"head"に配置するので、ページの初めの方でロードされます。
You can call r:require
multiple times in a GSP page, and you use the "modules" attribute to provide a list of modules:
GSPページで
r:require
を複数回呼んでも構いません。そして"modules"属性を使用してモジュールを列挙することもできます:
<html>
<head>
<r:require modules="jquery, main, blueprint, charting"/>
<r:layoutResources/>
</head>
<body>
…
<r:layoutResources/>
</body>
</html>
The above may result in many JavaScript and CSS files being included, in the correct order, with some JavaScript files loading at the end of the body to improve the apparent page load time.
上記の結果は、多くのJavaScriptとCSSファイルが正確な順番に、そして一部のJavaScriptはページ読み込み時間を向上させるために、ページボディの最後にロードされるようにページに含まれます。
However you cannot use r:require in isolation - as per the examples you must have the <r:layoutResources/> tag to actually perform the render.
r:requireは単体で使用することはできません。例にあるように実際に描写を行う
<r:layoutResources/>
タグが必要になります。
r:layoutResourcesでリソースへのリンクを描写する
Rendering the links to resources with r:layoutResources
When you have declared the resource modules that your GSP page requires, the framework needs to render the links to those resources at the correct time.
GSPページに必要なリソースモジュールを宣言すると、フレームワークは正常なタイミングでリソースへのリンクを描写する必要があります。
To achieve this correctly, you must include the r:layoutResources tag twice in your page, or more commonly, in your GSP layout:
これを正常に行うには、r:layoutResourcesタグをページまたはGSPレイアウトの2ヶ所に配置します。:
<html>
<head>
<g:layoutTitle/>
<r:layoutResources/>
</head>
<body>
<g:layoutBody/>
<r:layoutResources/>
</body>
</html>
This represents the simplest Sitemesh layout you can have that supports Resources.
これはリソースフレームワークに対応した、いちばん単純なSitemeshレイアウトの例です。
The Resources framework has the concept of a "disposition" for every resource. This is an indication of where in the page the resource should be included.
リソースフレームワークには全てのリソースに"配置"の概念を持っています。ページのどの部分にリソースを含めるべきかを指示する物です。
The default disposition applied depends on the type of resource. All CSS must be rendered in <head> in HTML, so "head" is the default for all CSS, and will be rendered by the first r:layoutResources. Page load times are improved when JavaScript is loaded after the page content, so the default for JavaScript files is "defer", which means it is rendered when the second r:layoutResources is invoked.
基本的な配置はリソースの種類によって適用されます。全てのCSSはHTMLの<head>に描写されるべきです。したがって全てのCSSは、デフォルトで最初のr:layoutResourcesによって"head"に描写されます。JavaScriptはページコンテンツの最後に読み込ませてJavaScriptファイルの実行を遅らせることで("defer")、ページのロード時間が向上されます。したがって2つ目のr:layoutResourcesが実行された時に描写されます。
Note that both your GSP page and your Sitemesh layout (as well as any GSP template fragments) can call r:require to depend on resources. The only limitation is that you must call r:require before the r:layoutResources that should render it.
GSPページとSItemeshレイアウト両方で(もちろんGSPテンプレートでも)、リソースに依存するr:requireを呼び出す事ができます。唯一の制約として、内容を描写するr:layoutResourcesの前に必ずr:requireを呼び出す必要があります。
r:scriptでページ固有のJavaScriptコードを追加
Adding page-specific JavaScript code with r:script
Grails has the
javascript tag which is adapted to defer to Resources plugin if installed, but it is recommended that you call
r:script
directly when you need to include fragments of JavaScript code.
Grailsにはリソースプラグインがインストールされている場合には、リソースプラグインに従う
javascriptタグがありますが、JavaScriptコードを含みたい場合は、直接
r:script
を呼ぶことを推奨します。
This lets you write some "inline" JavaScript which is actually not rendered inline, but either in the <head> or at the end of the body, based on the disposition.
これはJavaScriptをインラインで記述できて描写はインラインでは無く、配置指定をした<head>またはボディの最後に描写されます。
Given a Sitemesh layout like this:
このようなSitemeshレイアウトがあるとします:
<html>
<head>
<g:layoutTitle/>
<r:layoutResources/>
</head>
<body>
<g:layoutBody/>
<r:layoutResources/>
</body>
</html>
...in your GSP you can inject some JavaScript code into the head or deferred regions of the page like this:
GSPではJavaScriptコードをヘッドまたページの最後の方に以下のように記述します:
<html>
<head>
<title>Testing r:script magic!</title>
</head>
<body>
<r:script disposition="head">
window.alert('This is at the end of <head>');
</r:script>
<r:script disposition="defer">
window.alert('This is at the end of the body, and the page has loaded.');
</r:script>
</body>
</html>
The default disposition is "defer", so the disposition in the latter r:script is purely included for demonstration.
disposition属性のデフォルトは"defer"になります。従って後者のr:scriptはここでの説明として定義しているだけです。
Note that such r:script code fragments always load after any modules that you have used, to ensure that any required libraries have loaded.
r:scripのコードブロックは、必要なライブラリがロードされているのを保証するために、常に指定したモジュールの後に読み込まれます。
r:imgで画像へのリンク
Linking to images with r:img
This tag is used to render <img>
markup, using the Resources framework to process the resource on the fly (if configured to do so - e.g. make it eternally cacheable).
このタグは、リソースフレームワークを使用してリソースを処理した、<img>タグを描写するのに使用します。(定義をした場合。e.g.画像キャッシュ等)
This includes any extra attributes on the <img>
tag if the resource has been previously declared in a module.
あらかじめリソースモジュール宣言されたタグの属性も
<img>
タグの属性に追加します。
With this mechanism you can specify the width, height and any other attributes in the resource declaration in the module, and they will be pulled in as necessary.
この仕組みでは、モジュールに宣言した、width,heightまたその他の属性をタグに取り込みます。
Example:
例として:
<html>
<head>
<title>Testing r:img</title>
</head>
<body>
<r:img uri="/images/logo.png"/>
</body>
</html>
Note that Grails has a built-in
g:img
tag as a shortcut for rendering
<img>
tags that refer to a static resource. The Grails
img tag is Resources-aware and will delegate to
r:img
if found. However it is recommended that you use
r:img
directly if using the Resources plugin.
Grailsには、
<img>
タグを描写する、リソース参照できる
g:img
タグが存在します。Grailsの
imgタグは、存在した場合リソースフレームワークが認識して
r:img
に委譲しますが、リソースプラグインを使用している場合は直接
r:img
を使用することを推奨します。
Alongside the regular Grails
resource tag attributes, this also supports the "uri" attribute for increased brevity.
通常のGrails
imgタグと一緒で、簡潔に記述できる"uri"属性にも対応しています。
詳細は
Resourcesプラグインのドキュメントを参照。
r:resource
This is equivalent to the Grails
resource tag, returning a link to the processed static resource. Grails' own
g:resource
tag delegates to this implementation if found, but if your code requires the Resources plugin, you should use
r:resource
directly.
これはGrails
resourceタグと同じで静的リソースへのリンクを処理して返します。Grailsの
g:resource
タグが有った場合はこのタグに委譲します。リソースプラグインを使用している場合は直接
r:resource
を使用しましょう。
Alongside the regular Grails
resource tag attributes, this also supports the "uri" attribute for increased brevity.
通常のGrails
resourceタグと一緒で、簡潔に記述できる"uri"属性にも対応しています。
詳細は
Resourcesプラグインのドキュメントを参照。
r:external
This is a resource-aware version of Grails
external tag which renders the HTML markup necessary to include an external file resource such as CSS, JS or a favicon.
Grailsでの
externalタグのリソースフレームワーク版です。CSS,JS,favicon等の外部リソースを含む為のHTMLマークアップを描写します。
詳細は
Resourcesプラグインのドキュメントを参照。
6.2.5.3 リソースの宣言
A DSL is provided for declaring resources and modules. This can go either in your Config.groovy
in the case of application-specific resources, or more commonly in a resources artefact in grails-app/conf
.
リソースとモジュールを宣言するためのDSLが提供されています。アプリケーション固有の場合は
Config.groovy
ファイルに記述、また通常はリソースアーテファクトとして
grails-app/conf
にファイルで配置します。
Note that you do not need to declare all your static resources, especially images. However you must to establish dependencies or other resources-specific attributes. Any resource that is not declared is called "ad-hoc" and will still be processed using defaults for that resource type.
特に画像に関しては、全ての静的リソースを宣言する必要はありませんが、依存関係またはリソース固有の属性を確立する必要があります。宣言されていないリソースは"ad-hoc"とよばれ、リソースの種類に対応した処理が行われます。
Consider this example resource configuration file, grails-app/conf/MyAppResources.groovy
:
次のようなリソース定義が
grails-app/conf/MyAppResources.groovy
ファイルで例として有るとします:
modules = {
core {
dependsOn 'jquery, utils' resource url: '/js/core.js', disposition: 'head'
resource url: '/js/ui.js'
resource url: '/css/main.css',
resource url: '/css/branding.css'
resource url: '/css/print.css', attrs: [media: 'print']
} utils {
dependsOn 'jquery' resource url: '/js/utils.js'
} forms {
dependsOn 'core,utils' resource url: '/css/forms.css'
resource url: '/js/forms.js'
}
}
This defines three resource modules; 'core', 'utils' and 'forms'. The resources in these modules will be automatically bundled out of the box according to the module name, resulting in fewer files. You can override this with
bundle:'someOtherName'
on each resource, or call
defaultBundle
on the module (see
resources plugin documentation).
ここでは'core','utils','forms'の3つのリソースモジュールを定義しています。このモジュールのリソースは、モジュール名に応じて、すぐに使えるように、より少ないファイルに自動的にバンドルされます。それぞれのリソースは
bundle:'someOtherName'
またはモジュールで
defaultBundle
を呼ぶことででオーバーライドできます。(
Resourcesプラグインドキュメントを参照)
It declares dependencies between them using dependsOn
, which controls the load order of the resources.
リソースの読み込み順を操作するために、それぞれの依存関係を
dependsOn
で宣言しています。
When you include an <r:require module="forms"/>
in your GSP, it will pull in all the resources from 'core' and 'utils' as well as 'jquery', all in the correct order.
GSPに
<r:require module="forms"/>
を含んだ場合、この例では'core','util'そして'jquery'のリソースを正常な順番で引っ張ります。
You'll also notice the disposition:'head'
on the core.js
file. This tells Resources that while it can defer all the other JS files to the end of the body, this one must go into the <head>
.
さらにcore.jsファイルの
disposition:'head'
に注目してください。その他全てのリソースはボディの最後に配置して、このファイルは必ず
<head>
に配置する指定をしています。
The CSS file for print styling adds custom attributes using the attrs
map option, and these are passed through to the r:external
tag when the engine renders the link to the resource, so you can customize the HTML attributes of the generated link.
プリント指定用のCSSでは、カスタム属性を
attrs
マップで追加しています。そしてこれらは
r:external
タグを通してリソースへのリンクを形成します。これによってリンクのHTML属性をカスタマイズすることができます。
There is no limit to the number of modules or xxxResources.groovy artefacts you can provide, and plugins can supply them to expose modules to applications, which is exactly how the jQuery plugin works.
モジュールやxxxResources.groovyアーテファクトには数量制限がありません。jQueryプラグインのようにプラグインでモジュールを提供することもできます。
To define modules like this in your application's Config.groovy, you simply assign the DSL closure to the grails.resources.modules
Config variable.
アプリケーションのConfig.groovyでモジュールを宣言する場合は、モジュールのDSLクロージャを
grails.resources.modules
に定義します。
リソースDSLの詳細は
Resourcesプラグインのドキュメントを参考にしてください。
6.2.5.4 プラグインリソースのオーバーライド
Because a resource module can define the bundle groupings and other attributes of resources, you may find that the settings provided are not correct for your application.
リソースモジュールにバンドルのグルーピングと他のリソース属性の宣言ができることで、提供されている設定が個々のアプリケーションで違う場合が有るのを認識します。
For example, you may wish to bundle jQuery and some other libraries all together in one file. There is a load-time and caching trade-off here, but often it is the case that you'd like to override some of these settings.
例として、jQueryと他のライブラリをまとめてバンドルするとします。これだとロード時間とキャッシングのトレードオフになりますが、しかし良くあるケースとしてこれらの設定をオーバーライドするとします。
To do this, the DSL supports an "overrides" clause, within which you can change the defaultBundle
setting for a module, or attributes of individual resources that have been declared with a unique id:
これには、モジュールまたは固有のリソース属性で変更可能な
defaultBundle
設定で定義した名称を指定する、DSLの"overrides"で対応しています。
modules = {
core {
dependsOn 'jquery, utils'
defaultBundle 'monolith' resource url: '/js/core.js', disposition: 'head'
resource url: '/js/ui.js'
resource url: '/css/main.css',
resource url: '/css/branding.css'
resource url: '/css/print.css', attrs: [media: 'print']
} utils {
dependsOn 'jquery'
defaultBundle 'monolith' resource url: '/js/utils.js'
} forms {
dependsOn 'core,utils'
defaultBundle 'monolith' resource url: '/css/forms.css'
resource url: '/js/forms.js'
} overrides {
jquery {
defaultBundle 'monolith'
}
}
}
This will put all code into a single bundle named 'monolith'. Note that this can still result in multiple files, as separate bundles are required for head and defer dispositions, and JavaScript and CSS files are bundled separately.
この設定で全てのコードが'monolith'という名称の一つのバンドルになります。この設定を行ってもそれぞれのバンドルとしてそれぞれのファイルで配置されます。
Note that overriding individual resources requires the original declaration to have included a unique id for the resource.
固有のリソースをオーバライドする場合は、もとの宣言がリソース毎にユニークIDで含まれている必要があります。
For full details of the resource DSL please see the
resources plugin documentation.
リソースDSLの詳細は
リソースプラグインのドキュメントを参考にしてください。
6.2.5.5 リソースの最適化
The Resources framework uses "mappers" to mutate the resources into the final format served to the user.
リソースフレームワークは"マッパー"を使用して、最終フォーマットへリソースを変化させてユーザへ配信します。
The resource mappers are applied to each static resource once, in a specific order. You can create your own resource mappers, and several plugins provide some already for zipping, caching and minifying.
リソースマッパーはそれぞれの静的リソースに一度だけ特定の順番で適用されます。幾つかのプラグインzipping, caching や minifyingのように独自のリソースマッパーを作成することが可能です。
Out of the box, the Resources plugin provides bundling of resources into fewer files, which is achieved with a few mappers that also perform CSS re-writing to handle when your CSS files are moved into a bundle.
すぐに使用できる仕組みとして、リソースをまとめて少なくするバンドルマッパーをResourcesプラグインで提供しています。
複数のリソースを少ないファイルにまとめる
Bundling multiple resources into fewer files
The 'bundle' mapper operates by default on any resource with a "bundle" defined - or inherited from a defaultBundle
clause on the module. Modules have an implicit default bundle name the same as the name of the module.
バンドルマッパーは、"bundle"が定義されたリソース、またはモジュールの
defaultBundle
に継承されたリソースに対してデフォルトで操作します。モジュールはモジュール名と同じ名称で、暗黙なデフォルトバンドル名を持っています。
Files of the same kind will be aggregated into this bundle file. Bundles operate across module boundaries:
同じ種類のファイルがこのバンドルに集計されます。バンドルはモジュールにわたって操作されます:
modules = {
core {
dependsOn 'jquery, utils'
defaultBundle 'common' resource url: '/js/core.js', disposition: 'head'
resource url: '/js/ui.js', bundle: 'ui'
resource url: '/css/main.css', bundle: 'theme'
resource url: '/css/branding.css'
resource url: '/css/print.css', attrs: [media: 'print']
} utils {
dependsOn 'jquery' resource url: '/js/utils.js', bundle: 'common'
} forms {
dependsOn 'core,utils' resource url: '/css/forms.css', bundle: 'ui'
resource url: '/js/forms.js', bundle: 'ui'
}
}
Here you see that resources are grouped into bundles; 'common', 'ui' and 'theme' - across module boundaries.
この例でモジュールにわたって、リソースは'common','ui','theme'のグループにまとめられます。
Note that auto-bundling by module does not occur if there is only one resource in the module.
もしモジュールにリソースが1つの場合は、自動バンドリング処理は行われません。
クライアントのブラウザでリソースを"永久的に"キャッシュさせる
Making resources cache "eternally" in the client browser
Caching resources "eternally" in the client is only viable if the resource has a unique name that changes whenever the contents change, and requires caching headers to be set on the response.
リソースを"永久的に"キャッシュさせるには、コンテンツが変わらない限り唯一のリソース名を持ち、キャッシングヘッダーがレスポンスにセットされている時のみです。
The
cached-resources plugin provides a mapper that achieves this by hashing your files and renaming them based on this hash. It also sets the caching headers on every response for those resources. To use, simply install the cached-resources plugin.
cached-resourcesプラグインでは、ファイルをハッシュ管理してハッシュ管理に基づいて名称を変更するマッパーを提供しています。さらにキャッシングヘッダーを全てのリソースのレスポンスにセットします。これを使用するには単にcached-resourcesをインストールするだけです。
Note that the caching headers can only be set if your resources are being served by your application. If you have another server serving the static content from your app (e.g. Apache HTTPD), configure it to send caching headers. Alternatively you can configure it to request and proxy the resources from your container.
キャッシングヘッダーはリソースがアプリケーションから配信されたときのみセットされます。もし別のサーバで静的コンテンツを配信している場合は(Apache HTTPD等で)、サーバでそれらのキャッシングヘッダーの定義を行ってください。あるいはリソースをアプリケーションコンテナーを介して配信するように設定も可能です。
リソース(Zip)圧縮
Zipping resources
Returning gzipped resources is another way to reduce page load times and reduce bandwidth.
ページロード時間と帯域を減らす別の方法として、gzipしたリソースを返すことができます。
The
zipped-resources plugin provides a mapper that automatically compresses your content, excluding by default already compressed formats such as gif, jpeg and png.
zipped-resourcesプラグインは、デフォルトで圧縮されている画像等を除いたコンテンツを自動的に圧縮するマッパーを提供しています。
Simply install the zipped-resources plugin and it works.
単にzipped-resourcesプラグインをインストールするだけで使用できます。
最小化(Minifying)
Minifying
There are a number of CSS and JavaScript minifiers available to obfuscate and reduce the size of your code. At the time of writing none are publicly released but releases are imminent.
最小化してコード内容をわかりにくくしたりサイズを縮小する幾つかのCSSとJavascript minifierが有ります。現段階ではプラグインの提供は無いですが近々リリースされると思います。
6.2.5.6 デバッグ
When your resources are being moved around, renamed and otherwise mutated, it can be hard to debug client-side issues. Modern browsers, especially Safari, Chrome and Firefox have excellent tools that let you view all the resources requested by a page, including the headers and other information about them.
リソースが、リソースフレームワークにより、動き回り、名称変更されたり、変更されるとクライアントサイドのデバッグが大変になります。最近のブラウザSafari,Chrome,Firefoxには、リクエストでのページの全てのリソースやヘッダーやその他の情報が閲覧できる優秀なツールがあります。
There are several debugging features built in to the Resources framework.
リソースフレームワークには、幾つかのデバッグ時に使用する機能を持ち合わせています。
X-Grails-Resources-Original-Srcヘッダー
X-Grails-Resources-Original-Src Header
Every resource served in development mode will have the X-Grails-Resources-Original-Src: header added, indicating the original source file(s) that make up the response.
開発(development)モードでのリソースには、レスポンスを構成した元のリソースファイルを示す、X-Grails-Resources-Original-Src:ヘッダーが追加されています。
デバッグフラグを追加
Adding the debug flag
If you add a query parameter _debugResources=y to your URL and request the page, Resources will bypass any processing so that you can see your original source files.
クエリパラメータ
_debugResources=y をURLに追加してページをリクエストすると、Resourcesプラグインはバイパスされて元のソースファイルを見ることができます。
This also adds a unique timestamp to all your resource URLs, to defeat any caching that browsers may use. This means that you should always see your very latest code when you reload the page.
さらにこの機能では、ユニークなタイムスタンプを全てのリソースに追加することでブラウザにキャッシュされるのを阻止します。したがってページをリロードするたびに最新のコードを参照することになります。
常にデバッグを有効にする
Turning on debug all the time
You can turn on the aforementioned debug mechanism without requiring a query parameter, but turning it on in Config.groovy:
前途したデバッグ機能をクエリパラメータ無しで有効にするには、以下のようにConfig.groovyで設定します:
grails.resources.debug = true
You can of course set this per-environment.
もちろんこの設定は環境ごとに定義できます。
6.2.5.7 リソース生成・変換処理を防ぐ
Sometimes you do not want a resource to be processed in a particular way, or even at all. Occasionally you may also want to disable all resource mapping.
特定のリソースだけ変換処理を行わない事もあります。時折リソースマッピングを無効にしたいこともあります。
個々のリソースの特定のマッパー処理を防ぐ
Preventing the application of a specific mapper to an individual resource
All resource declarations support a convention of noXXXX:true where XXXX is a mapper name.
全てのリソース宣言では、XXXXがマッパー名称とすると、noXXXX:trueのような規約に対応しています。
So for example to prevent the "hashandcache" mapper from being applied to a resource (which renames and moves it, potentially breaking relative links written in JavaScript code), you would do this:
例として、リソースに適用される"hashandcache"マッパーの処理を防ぐ場合は:
modules = {
forms {
resource url: '/css/forms.css', nohashandcache: true
resource url: '/js/forms.js', nohashandcache: true
}
}
特定のマッパーでの、パス、ファイルタイプの除外と包含
Excluding/including paths and file types from specific mappers
Mappers have includes/excludes Ant patterns to control whether they apply to a given resource. Mappers set sensible defaults for these based on their activity, for example the zipped-resources plugin's "zip" mapper is set to exclude images by default.
マッパーには、Antパターンで対象リソースを制御するincludes/excludes定義があります。各マッパーはそれぞれの動作に対応したふさわしいデフォルトをセットしています。例としてzipped-resourcesプラグインの"zip"マッパーはデフォルトで画像を除外する設定をしています。
You can configure this in your Config.groovy
using the mapper name e.g:
Config.groovy
にマッパー名で定義することができます:
// We wouldn't link to .exe files using Resources but for the sake of example:
grails.resources.zip.excludes = ['**/*.zip', '**/*.exe']// Perhaps for some reason we want to prevent bundling on "less" CSS files:
grails.resources.bundle.excludes = ['**/*.less']
There is also an "includes" inverse. Note that settings these replaces the default includes/excludes for that mapper - it is not additive.
逆の意味の"includes"も使用できます。設定をするとマッパーデフォルトのincludes/excludesを入れ換えるので注意が必要です。
"ad-hoc"(レガシー)リソースとして扱う物の操作
Controlling what is treated as an "ad-hoc" (legacy) resource
Ad-hoc resources are those undeclared, but linked to directly in your application without using the Grails or Resources linking tags (resource, img or external).
"ad-hoc"リソースは、宣言されずGrailsまたResourcesのリンク系タグを使用しないで、直接アプリケーションにリンクされているリソースです。
These may occur with some legacy plugins or code with hardcoded paths in.
古い方式のプラグインやパスがコードに埋め込まれている場合をさします。
There is a Config.groovy setting grails.resources.adhoc.patterns which defines a list of Servlet API compliant filter URI mappings, which the Resources filter will use to detect such "ad-hoc resource" requests.
サーブレットAPI準拠のフィルタURIマッピングのリストを定義して、どのリクエストを"ad-hoc"リソースとしてResourcesのフィルタが使用するか認識させるConfig.groovy用の設定
grails.resources.adhoc.patterns があります。
By default this is set to:
デフォルトでは次のようにセットされています:
grails.resources.adhoc.patterns = ['images/*', '*.js', '*.css']
6.2.5.8 リソース関連のプラグイン
At the time of writing, the following plugins include support for the Resources framework:
現時点でのリソースフレームワークに対応したプラグイン:
6.2.6 Sitemeshコンテントブロック
Although it is useful to decorate an entire page sometimes you may find the need to decorate independent sections of your site. To do this you can use content blocks. To get started, partition the page to be decorated using the <content>
tag:
サイト全体のページをデコレートするのに便利ですが、ページ内のブロック(パーツ)をデコレートする必要も有ると思います。この場合はコンテントブロックを使用します。コンテントブロックを使用するには
<content>
タグでページ内をブロック分割します。
<content tag="navbar">
… ここにナビゲーションバーコンテンツ…
</content><content tag="header">
… ここにヘッダーコンテンツ…
</content><content tag="footer">
… ここにフッターコンテンツ…
</content><content tag="body">
… ここにボディコンテンツ…
</content>
Then within the layout you can reference these components and apply individual layouts to each:
そしてレイアウト側には、それぞれのコンポーネントの参照を配置します:
<html>
<body>
<div id="header">
<g:applyLayout name="headerLayout">
<g:pageProperty name="page.header" />
</g:applyLayout>
</div>
<div id="nav">
<g:applyLayout name="navLayout">
<g:pageProperty name="page.navbar" />
</g:applyLayout>
</div>
<div id="body">
<g:applyLayout name="bodyLayout">
<g:pageProperty name="page.body" />
</g:applyLayout>
</div>
<div id="footer">
<g:applyLayout name="footerLayout">
<g:pageProperty name="page.footer" />
</g:applyLayout>
</div>
</body>
</html>
6.2.7 デプロイされたアプリケーションへの変更
One of the main issues with deploying a Grails application (or typically any servlet-based one) is that any change to the views requires that you redeploy your whole application. If all you want to do is fix a typo on a page, or change an image link, it can seem like a lot of unnecessary work. For such simple requirements, Grails does have a solution: the grails.gsp.view.dir
configuration setting.
Grailsアプリケーションをデプロイする際に起きる大きな問題の一つに(または他のサーブレットベースのアプリケーションも含む)、ビューを変更するたびにアプリケーション全体を再デプロイする必要がある事です。もし誤植や画像リンクの修正など有る場合は無駄な作業が発生します。そのような事を発生させないために、Grailsには、
grails.gsp.view.dir
定義という解決方法が存在します。
How does this work? The first step is to decide where the GSP files should go. Let's say we want to keep them unpacked in a /var/www/grails/my-app
directory. We add these two lines to grails-app/conf/Config.groovy
:
はじめに、何処にGSPを配置するかを決めましょう。
/var/www/grails/my-app
の階層はパックしないこととします。以下の2行を
grails-app/conf/Config.groovy
に追加します:
grails.gsp.enable.reload = true
grails.gsp.view.dir = "/var/www/grails/my-app/"
The first line tells Grails that modified GSP files should be reloaded at runtime. If you don't have this setting, you can make as many changes as you like but they won't be reflected in the running application until you restart. The second line tells Grails where to load the views and layouts from.
最初の行は変更されたGSPファイルはリロードするという指定です。この指定をしないと、GSPが更新されても再起動するまで反映されません。2行目は何処にあるビューとレイアウトをロードするかの指定です。
The trailing slash on the grails.gsp.view.dir
value is important! Without it, Grails will look for views in the parent directory.
grails.gsp.view.dir
の最後に付いているスラッシュは重要です。これが無いとGrailsが親ディレクトリにビューを探しに行きます。
Setting "grails.gsp.view.dir" is optional. If it's not specified, you can update files directly to the application server's deployed war directory. Depending on the application server, these files might get overwritten when the server is restarted. Most application servers support "exploded war deployment" which is recommended in this case.
"grails.gsp.view.dir"の設定は省略可能です。省略した場合はwarがデプロイされたディレクトリのファイルを変更できます。アプリケーションサーバによりますが、サーバのリスタート時にこれらのファイルは上書きされてしまいます。ホット再デプロイメントをサポートしたアプリケーションサーバの場合にのみ推奨します。
With those settings in place, all you need to do is copy the views from your web application to the external directory. On a Unix-like system, this would look something like this:
この場合に、サーバ内で設定をするには、Webアプリケーションのディレクトリから別のディレクトリへ全てのビューをコピーします。Unix系のシステムでは以下のように作業します:
mkdir -p /var/www/grails/my-app/grails-app/views
cp -R grails-app/views/* /var/www/grails/my-app/grails-app/views
The key point here is that you must retain the view directory structure, including the grails-app/views
bit. So you end up with the path /var/www/grails/my-app/grails-app/views/...
.
ポイントとなるのは、
grails-app/views
を含んだ全てのビューディレクトリ階層を持たなくてはならない所です。この場合だとパスは、
/var/www/grails/my-app/grails-app/views/...
となります。
One thing to bear in mind with this technique is that every time you modify a GSP, it uses up permgen space. So at some point you will eventually hit "out of permgen space" errors unless you restart the server. So this technique is not recommended for frequent or large changes to the views.
ひとつ気にかけてほしいのが、GSPを更新するたびに、permgenスペースを多く使用するという事です。それにより再起動するのと比べて、そのうち"out of permgen space"エラーが起こります。したがって、常に更新される物や、ビューへの大きな変更には推奨できません。
There are also some System properties to control GSP reloading:
GSPリロードをコントロールするシステムプロパティも提供しています:
Name | Description | Default |
---|
grails.gsp.enable.reload | altervative system property for enabling the GSP reload mode without changing Config.groovy | |
grails.gsp.reload.interval | interval between checking the lastmodified time of the gsp source file, unit is milliseconds | 5000 |
grails.gsp.reload.granularity | the number of milliseconds leeway to give before deciding a file is out of date. this is needed because different roundings usually cause a 1000ms difference in lastmodified times | 1000 |
名称 | 説明 | 既存値 |
---|
grails.gsp.enable.reload | Config.groovy変更せずにGSPリロードモードを許可にします。 | |
grails.gsp.reload.interval | gspソースファイルの更新を確認するインターバル。ミリ秒で指定。 | 5000 |
grails.gsp.reload.granularity | ファイルが更新されたかを判断する時間のゆとり。ミリ秒で指定。 | 1000 |
GSP reloading is supported for precompiled GSPs since Grails 1.3.5 .
プリコンパイルGSPに対してのGSPリロードはGrails 1.3.5からサポートされています。
6.2.8 GSPデバッグ
生成されたソースコードを表示する
Viewing the generated source code
- Adding "?showSource=true" or "&showSource=true" to the url shows the generated Groovy source code for the view instead of rendering it. It won't show the source code of included templates. This only works in development mode
- The saving of all generated source code can be activated by setting the property "grails.views.gsp.keepgenerateddir" (in Config.groovy) . It must point to a directory that exists and is writable.
- During "grails war" gsp pre-compilation, the generated source code is stored in grails.project.work.dir/gspcompile (usually in ~/.grails/(grails_version)/projects/(project name)/gspcompile).
- URLに、 "?showSource=true" または、"&showSource=true"を追加するとページ描写の代わりに、ビュー用に生成されたGroovyコードが参照できます。但し含んだテンプレートのコードは含まれません。開発モードのみで動作します。
- Config.groovyにプロパティ"grails.views.gsp.keepgenerateddir"を指定すると生成ファイルが指定された場所に保存されます。
- "grails war"でのgspプリコンパイル時に、生成されたソースコードがgrails.project.work.dir/gspcompileに保存されます。(通常は~/.grails/(grails_version)/projects/(project name)/gspcompileです。)
デバッガでGSPコードをデバッグ
Debugging GSP code with a debugger
使用されたテンプレートの情報を参照
Viewing information about templates used to render a single url
GSP templates are reused in large web applications by using the g:render
taglib. Several small templates can be used to render a single page.
It might be hard to find out what GSP template actually renders the html seen in the result.
The debug templates -feature adds html comments to the output. The comments contain debug information about gsp templates used to render the page.
規模の大きいなWebアプリケーションでは、
g:render
タグを使用してGSPテンプレートは再利用されます。幾つかの小さなテンプレートが1つのページで使われる事もあります。どの部分でGSPテンプレートが実際にHTMLを描写したか探すのは大変だと思います。テンプレートデバッグ機能ではhtmlコメントでGSPテンプレートのデバッグ情報を提供します。
Usage is simple: append "?debugTemplates" or "&debugTemplates" to the url and view the source of the result in your browser.
"debugTemplates" is restricted to development mode. It won't work in production.
使用方法は簡単、URLに"?debugTemplates" または "&debugTemplates"を追加して表示されたページのソースを参照します。"debugTemplates"は開発モードのみで動作します。
Here is an example of comments added by debugTemplates :
debugTemplatesでは以下のようなコメントが追記されます:
<!-- GSP #2 START template: /home/.../views/_carousel.gsp
precompiled: false lastmodified: … -->
.
.
.
<!-- GSP #2 END template: /home/.../views/_carousel.gsp
rendering time: 115 ms -->
Each comment block has a unique id so that you can find the start & end of each template call.
それぞれのコメントブロックには番号を持っていて、テンプレートの開始と終了を探し安くしてあります。
6.3 タグライブラリ
Like
Java Server Pages (JSP), GSP supports the concept of custom tag libraries. Unlike JSP, Grails' tag library mechanism is simple, elegant and completely reloadable at runtime.
Java Server Pages (JSP)のように、GSPでもカスタムタグライブラリをサポートしています。JSPと違いGrailsでのタグライブラリは単純簡潔です。
Quite simply, to create a tag library create a Groovy class that ends with the convention TagLib
and place it within the grails-app/taglib
directory:
タグライブラリを作成するには、
grails-app/taglib
ディレクトリに、名称の最後が
TagLib
となるGroovyクラスを作成します:
Now to create a tag create a Closure property that takes two arguments: the tag attributes and the body content:
タグライブラリクラスを作成したら、2つの引数(属性とタグ内容)を受け取るクロージャを追加してタグを作成します:
class SimpleTagLib {
def simple = { attrs, body -> }
}
The
attrs
argument is a Map of the attributes of the tag, whilst the
body
argument is a Closure that returns the body content when invoked:
引数
attrs
はタグ属性のMapです。引数
body
はタグ内容のコンテンツを呼び出すクロージャです:
class SimpleTagLib {
def emoticon = { attrs, body ->
out << body() << (attrs.happy == 'true' ? " :-)" : " :-(")
}
}
As demonstrated above there is an implicit out
variable that refers to the output Writer
which you can use to append content to the response. Then you can reference the tag inside your GSP; no imports are necessary:
上記の例では、レスポンスを出力する
Writer
を参照する変数
out
に対してコンテンツを追加しています。ここまで作成したら、以下のように、GSPの中でタグをそのまま参照します。importは必要ありません。:
<g:emoticon happy="true">Hi John</g:emoticon>
To help IDEs like SpringSource Tool Suite (STS) and others autocomplete tag attributes, you should add Javadoc comments to your tag closures with @attr
descriptions. Since taglibs use Groovy code it can be difficult to reliably detect all usable attributes.
タグリブはGroovyコードを使用しているため、タグで使用可能な属性全てを認識することは困難です。SpringSource Tool Suite (STS)等のIDEでの補完機能に対しての手助けとして、タグクロージャのJavadocコメント内に@attr
を含めましょう。For example:
例として:class SimpleTagLib { /**
* Renders the body with an emoticon.
*
* @attr happy whether to show a happy emoticon ('true') or
* a sad emoticon ('false')
*/
def emoticon = { attrs, body ->
out << body() << (attrs.happy == 'true' ? " :-)" : " :-(")
}
}
and any mandatory attributes should include the REQUIRED keyword, e.g.
必須条件の属性には、キーワードREQUIREDを指定します。class SimpleTagLib { /**
* Creates a new password field.
*
* @attr name REQUIRED the field name
* @attr value the field value
*/
def passwordField = { attrs ->
attrs.type = "password"
attrs.tagName = "passwordField"
fieldImpl(out, attrs)
}
}
6.3.1 変数とスコープ
Within the scope of a tag library there are a number of pre-defined variables including:
タグライブラリのスコープには、多数の前定義された変数があります:
actionName
- The currently executing action name
controllerName
- The currently executing controller name
flash
- The flash object
grailsApplication
- The GrailsApplication instance
out
- The response writer for writing to the output stream
pageScope
- A reference to the pageScope object used for GSP rendering (i.e. the binding)
params
- The params object for retrieving request parameters
pluginContextPath
- The context path to the plugin that contains the tag library
request
- The HttpServletRequest instance
response
- The HttpServletResponse instance
servletContext
- The javax.servlet.ServletContext instance
session
- The HttpSession instance
As demonstrated it the previous example it is easy to write simple tags that have no body and just output content. Another example is a dateFormat
style tag:
前の説明で、簡単にコンテンツを出力するタグは簡単に記述できると説明しました。他の例として
dateFormat
タグを紹介します:
def dateFormat = { attrs, body ->
out << new java.text.SimpleDateFormat(attrs.format).format(attrs.date)
}
The above uses Java's SimpleDateFormat
class to format a date and then write it to the response. The tag can then be used within a GSP as follows:
この例ではJavaの
SimpleDateFormat
クラスを使ってフォーマットした日付をレスポンスに出力します。このタグは、GSPで次のように使用します:
<g:dateFormat format="dd-MM-yyyy" date="${new Date()}" />
With simple tags sometimes you need to write HTML mark-up to the response. One approach would be to embed the content directly:
単純なタグでHTMLマークアップをレスポンスすることもあるでしょう。一つのアプローチとして直接コンテンツを埋め込む事ができます:
def formatBook = { attrs, body ->
out << "<div id="${attrs.book.id}">"
out << "Title : ${attrs.book.title}"
out << "</div>"
}
Although this approach may be tempting it is not very clean. A better approach would be to reuse the
render tag:
上記の方法はあまりきれいでは無いので、実際には、
renderタグを使用すると良いでしょう:
def formatBook = { attrs, body ->
out << render(template: "bookTemplate", model: [book: attrs.book])
}
And then have a separate GSP template that does the actual rendering.
このようにして、実際に描写されるGSPテンプレートと切り離せます.
You can also create logical tags where the body of the tag is only output once a set of conditions have been met. An example of this may be a set of security tags:
条件に合ったときのみにタグ内容を出力する制御タグを作成できます。セキュリティタグを例とします:
def isAdmin = { attrs, body ->
def user = attrs.user
if (user && checkUserPrivs(user)) {
out << body()
}
}
The tag above checks if the user is an administrator and only outputs the body content if he/she has the correct set of access privileges:
この例ではアクセスしたユーザをチェックして、管理者であった場合のみ内容を出力します:
<g:isAdmin user="${myUser}">
// some restricted content
</g:isAdmin>
Iterative tags are easy too, since you can invoke the body multiple times:
タグ内容を複数回実行するような、イテレートタグも簡単に作れます:
def repeat = { attrs, body ->
attrs.times?.toInteger()?.times { num ->
out << body(num)
}
}
In this example we check for a times
attribute and if it exists convert it to a number, then use Groovy's times
method to iterate the specified number of times:
この例では、属性
times
を有無や数値なのかを確認し、その数値でGroovyの
times
メソッドを実行して、与えられた数値の回数、実行内容を繰り返します:
<g:repeat times="3">
<p>Repeat this 3 times! Current repeat = ${it}</p>
</g:repeat>
Notice how in this example we use the implicit it
variable to refer to the current number. This works because when we invoked the body we passed in the current value inside the iteration:
ここでは、数値を参照した変数
it
の使い方を紹介しています。これはbody実行時にイテレーションの数値をbodyに渡すことで動作しています。:
That value is then passed as the default variable it
to the tag. However, if you have nested tags this can lead to conflicts, so you should should instead name the variables that the body uses:
この値はタグ内の変数
it
に渡されます。ただしタグをネストした場合は名称の衝突が起きるため違う名称を指定できるようにする必要があります。:
def repeat = { attrs, body ->
def var = attrs.var ?: "num"
attrs.times?.toInteger()?.times { num ->
out << body((var):num)
}
}
Here we check if there is a var
attribute and if there is use that as the name to pass into the body invocation on this line:
この例では、属性varが存在すれば、その値を名称として使用できるようにbodyに渡して実行します。
Note the usage of the parenthesis around the variable name. If you omit these Groovy assumes you are using a String key and not referring to the variable itself.
変数名パーレン使用時の注意点です。これを省略するとGroovyは文字列キーとして解釈してしまい変数として参照できません。
Now we can change the usage of the tag as follows:
これで、以下のようにタグで使用できます:
<g:repeat times="3" var="j">
<p>Repeat this 3 times! Current repeat = ${j}</p>
</g:repeat>
Notice how we use the var
attribute to define the name of the variable j
and then we are able to reference that variable within the body of the tag.
こうすることで、
var
属性に指定した変数名
j
をタグ内部で変数として参照することができます。
6.3.5 タグネームスペース
By default, tags are added to the default Grails namespace and are used with the g:
prefix in GSP pages. However, you can specify a different namespace by adding a static property to your TagLib
class:
デフォルトでのタグは、Grailsのデフォルトネームスペースに追加され、GSPでは
g:
接頭辞が使用できます。ネームスペースはstaticプロパティ
namespace
を
TagLib
クラスに追加する事で、独自に定義することが可能です。:
class SimpleTagLib {
static namespace = "my" def example = { attrs ->
…
}
}
Here we have specified a namespace
of my
and hence the tags in this tag lib must then be referenced from GSP pages like this:
この例では
namespace
を
my
と定義したので、このタグを参照するにはGSPページ内では以下のように参照できます:
<my:example name="..." />
where the prefix is the same as the value of the static namespace
property. Namespaces are particularly useful for plugins.
これ例で
namespace
プロパティに設定したものが接頭辞として使用しています。ネームスペースはプラグインでタグ提供を行う際に有用です。
Tags within namespaces can be invoked as methods using the namespace as a prefix to the method call:
ネームスペース付きタグのメソッドコール時はネームスペースを接頭辞として使用します:
out << my.example(name:"foo")
This works from GSP, controllers or tag libraries
GSP、コントローラ、タグライブラリで使用できます。
6.3.6 JSPタグライブラリの使用
In addition to the simplified tag library mechanism provided by GSP, you can also use JSP tags from GSP. To do so simply declare the JSP to use with the taglib
directive:
単純なタグライブラリ機能がGSPで提供されているのに加えて、GSPでは、JSPタグを使用することもできます。使用するには、
taglib
ディレクティブを定義します。
<%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %>
Then you can use it like any other tag:
他のタグと同じように使用できます:
<fmt:formatNumber value="${10}" pattern=".00"/>
With the added bonus that you can invoke JSP tags like methods:
さらに追加として、JSPタグをメソッドとして実行可能です:
${fmt.formatNumber(value:10, pattern:".00")}
6.3.7 タグの戻り値
Since Grails 1.2, a tag library call returns an instance of org.codehaus.groovy.grails.web.util.StreamCharBuffer
class by default.
This change improves performance by reducing object creation and optimizing buffering during request processing.
In earlier Grails versions, a java.lang.String
instance was returned.
Grails 1.2以降、タグライブラリを呼び出すと、デフォルトでは
org.codehaus.groovy.grails.web.util.StreamCharBuffer
クラスのインスタンスを返します。
この実装でリクエスト処理時のバッファリング最適化や、オブジェクト生成の減少によりパフォーマンスの向上が行われました。
それ以前のGrailsでは
java.lang.String
インスタンスを返します。
Tag libraries can also return direct object values to the caller since Grails 1.2..
Object returning tag names are listed in a static returnObjectForTags
property in the tag library class.
さらに、Grails 1.2からは、タグライブラリから直接オブジェクトを返す事が可能です。オブジェクトを返すタグを定義するにはstatic
returnObjectForTags
プロパティにタグ名称をリストします。
Example:
例:
class ObjectReturningTagLib {
static namespace = "cms"
static returnObjectForTags = ['content'] def content = { attrs, body ->
CmsContent.findByCode(attrs.code)?.content
}
}
6.4 URLマッピング
Throughout the documentation so far the convention used for URLs has been the default of /controller/action/id
. However, this convention is not hard wired into Grails and is in fact controlled by a URL Mappings class located at grails-app/conf/UrlMappings.groovy
.
ここまでのドキュメント内容では、URLのルールはデフォルトの
/controller/action/id
を使用しています。このルールはGrailsで必須になっているわけでは無く、
grails-app/conf/UrlMappings.groovy
に配置されているURLマッピングクラスでコントロールされています。
The UrlMappings
class contains a single property called mappings
that has been assigned a block of code:
URLMappings
クラスは、コードブロックが定義された
mappings
というプロパティを持っています。:
class UrlMappings {
static mappings = {
}
}
6.4.1 コントローラとアクションにマッピング
To create a simple mapping simply use a relative URL as the method name and specify named parameters for the controller and action to map to:
簡単なマッピングは、相対URLをメソッド名とするメソッドに、マップ対象のコントローラとアクション名称を、名前付きパラメータ引数として作成します:
"/product"(controller: "product", action: "list")
In this case we've mapped the URL /product
to the list
action of the ProductController
. Omit the action definition to map to the default action of the controller:
この例ではURL
/product
は、
ProductController
の
list
アクションにマップ定義したことになります。アクションを省略すると、コントローラのデフォルトアクションにマップ定義できます:
"/product"(controller: "product")
An alternative syntax is to assign the controller and action to use within a block passed to the method:
他のシンタックスとして、コントローラとアクションを指定したコードブロックをメソッドに渡すこともできます:
"/product" {
controller = "product"
action = "list"
}
Which syntax you use is largely dependent on personal preference. To rewrite one URI onto another explicit URI (rather than a controller/action pair) do something like this:
どちらのシンタックスを使用するかは個人の選択に依存します。(コントローラ・アクションを指定するのでは無く)URIを明示的なURIへ書き換えする場合は:
"/hello"(uri: "/hello.dispatch")
Rewriting specific URIs is often useful when integrating with other frameworks.
特定のURIへの書き換えは、他のフレームワークと統合する場合に便利です。
6.4.2 埋込変数
簡単な変数
Simple Variables
The previous section demonstrated how to map simple URLs with concrete "tokens". In URL mapping speak tokens are the sequence of characters between each slash, '/'. A concrete token is one which is well defined such as as /product
. However, in many circumstances you don't know what the value of a particular token will be until runtime. In this case you can use variable placeholders within the URL for example:
前セクションでは、具体トークンURLを簡単にマップする方法を紹介しました。URLマッピングでのトークンとは"/"スラッシュの間にある文字列の事を指します。具体トークンは
/product
のように適切に指定できますが、状況によっては、ランタイム時にしか一部のトークンが予測できない場合があります。その場合は以下の例のように変数を指定できます:
static mappings = {
"/product/$id"(controller: "product")
}
In this case by embedding a $id variable as the second token Grails will automatically map the second token into a parameter (available via the
params object) called
id
. For example given the URL
/product/MacBook
, the following code will render "MacBook" to the response:
この例では、2つめのトークンとして変数$idを埋め込むことで、Grailsが自動的に2つめのトークンを名称が
id
のパラメータとしてマップします(このパラメータは
paramsオブジェクトから取得できます)。例として、URL
/product/MacBook
へアクセスを行うと、次のコードでは、結果として"MacBook"をレスポンスします:
class ProductController {
def index() { render params.id }
}
You can of course construct more complex examples of mappings. For example the traditional blog URL format could be mapped as follows:
もっと複雑なマッピングも作成できます。例としてブログのようなURLフォーマットを次のようにしてマッピングできます:
static mappings = {
"/$blog/$year/$month/$day/$id"(controller: "blog", action: "show")
}
The above mapping would let you do things like:
このマッピングでは、以下のようなURLでアクセスを可能にします:
/graemerocher/2007/01/10/my_funky_blog_entry
The individual tokens in the URL would again be mapped into the
params object with values available for
year
,
month
,
day
,
id
and so on.
URLの個々のトークンは
paramsオブジェクトにマップされるため、変数
blog
,
year
,
month
,
day
,
id
として値を取得する事ができます。
動的なコントローラ名とアクション名
Dynamic Controller and Action Names
Variables can also be used to dynamically construct the controller and action name. In fact the default Grails URL mappings use this technique:
変数を使って動的にコントローラとアクション名を構成することができます。GrailsでのデフォルトURLマッピングはこの機能を使用しています:
static mappings = {
"/$controller/$action?/$id?"()
}
Here the name of the controller, action and id are implicitly obtained from the variables controller
, action
and id
embedded within the URL.
URLに指定された内容から、変数
controller
,
action
,
id
を取得して、コントローラ、アクション、idを確定します。
You can also resolve the controller name and action name to execute dynamically using a closure:
コントローラ名の解決を変数で行い、クロージャを実行して動的にアクション名を解決することもできます:
static mappings = {
"/$controller" {
action = { params.goHere }
}
}
省略可能な変数
Optional Variables
Another characteristic of the default mapping is the ability to append a ? at the end of a variable to make it an optional token. In a further example this technique could be applied to the blog URL mapping to have more flexible linking:
変数の最後に ? を付加することで、変数を省略可能にすることが可能です。この仕組みを使用して、前述した例のブログURLマッピングをもっと柔軟にしてみましょう:
static mappings = {
"/$blog/$year?/$month?/$day?/$id?"(controller:"blog", action:"show")
}
With this mapping all of these URLs would match with only the relevant parameters being populated in the
params object:
この設定で以下のURL全てマッチします、そしてそれぞれの関係のあるパラメータのみを
paramsオブジェクトに追加します:
/graemerocher/2007/01/10/my_funky_blog_entry
/graemerocher/2007/01/10
/graemerocher/2007/01
/graemerocher/2007
/graemerocher
任意変数
Arbitrary Variables
You can also pass arbitrary parameters from the URL mapping into the controller by just setting them in the block passed to the mapping:
URLマッピングからコントローラへ、コードブロック内で設定した任意のパラメータを渡すことが可能です:
"/holiday/win" {
id = "Marrakech"
year = 2007
}
This variables will be available within the
params object passed to the controller.
変数は
paramsオブジェクトから参照可能になります。
動的解決変数
Dynamically Resolved Variables
The hard coded arbitrary variables are useful, but sometimes you need to calculate the name of the variable based on runtime factors. This is also possible by assigning a block to the variable name:
任意の変数をURLマッピングに埋め込むのは便利ですが、時折状況に応じて変数の内容を演算したい場合があると思います。この場合コードブロックを変数に割り当てます。:
"/holiday/win" {
id = { params.id }
isEligible = { session.user != null } // must be logged in
}
In the above case the code within the blocks is resolved when the URL is actually matched and hence can be used in combination with all sorts of logic.
URLが実際にマッチした時にコードブロックのロジックが実行されて変数の内容が解決されます。
6.4.3 ビューへマッピング
You can resolve a URL to a view without a controller or action involved. For example to map the root URL /
to a GSP at the location grails-app/views/index.gsp
you could use:
コントローラまたはアクションを含まずにビューへURLをマップできます。例としてルートURL
/
を、
grails-app/views/index.gsp
にマッピングするには:
static mappings = {
"/"(view: "/index") // map the root URL
}
Alternatively if you need a view that is specific to a given controller you could use:
あるいは、特定のコントローラにあるビューを指定する場合は:
static mappings = {
"/help"(controller: "site", view: "help") // to a view for a controller
}
6.4.4 レスポンスコードへマッピング
Grails also lets you map HTTP response codes to controllers, actions or views. Just use a method name that matches the response code you are interested in:
GrailsではHTTPレスポンスコードをコントローラ、アクション、ビューにマッピングすることができます。使用したいレスポンスコードをメソッド名に指定するだけです:
static mappings = {
"403"(controller: "errors", action: "forbidden")
"404"(controller: "errors", action: "notFound")
"500"(controller: "errors", action: "serverError")
}
Or you can specify custom error pages:
カスタムエラーページを指定する場合は:
static mappings = {
"403"(view: "/errors/forbidden")
"404"(view: "/errors/notFound")
"500"(view: "/errors/serverError")
}
エラーハンドリング宣言
Declarative Error Handling
In addition you can configure handlers for individual exceptions:
特定の例外をのハンドラを定義することも可能です:
static mappings = {
"403"(view: "/errors/forbidden")
"404"(view: "/errors/notFound")
"500"(controller: "errors", action: "illegalArgument",
exception: IllegalArgumentException)
"500"(controller: "errors", action: "nullPointer",
exception: NullPointerException)
"500"(controller: "errors", action: "customException",
exception: MyException)
"500"(view: "/errors/serverError")
}
With this configuration, an IllegalArgumentException
will be handled by the illegalArgument
action in ErrorsController
, a NullPointerException
will be handled by the nullPointer
action, and a MyException
will be handled by the customException
action. Other exceptions will be handled by the catch-all rule and use the /errors/serverError
view.
この設定では、
IllegalArgumentException
は
ErrorsControlle
rの
illegalArgument
、
NullPointerException
は
nullPointer
アクション、
MyException
は
customException
アクションでそれぞれ処理されます。その他の例外がcatch-allルールでハンドルされビューに
/errors/serverError
を使用します。
You can access the exception from your custom error handing view or controller action using the request's exception
attribute like so:
カスタムエラーハンドリングで、ビューまたは、コントローラアクションから例外を参照するには、requestインスタンスの
exception
を使用します:
class ErrorController {
def handleError() {
def exception = request.exception
// perform desired processing to handle the exception
}
}
If your error-handling controller action throws an exception as well, you'll end up with a StackOverflowException
.
エラーハンドリング用のコントローラアクションが例外を出した場合は、最終的にStackOverflowException
になります。
6.4.5 HTTPメソッドへマッピング
URL mappings can also be configured to map based on the HTTP method (GET, POST, PUT or DELETE). This is very useful for RESTful APIs and for restricting mappings based on HTTP method.
URLマッピングでは、HTTPメソッド(GET, POST, PUT, DELETE)へのマップを定義することができます。HTTPメソッドをベースに制限したり、RESTful API等に便利です。
As an example the following mappings provide a RESTful API URL mappings for the ProductController
:
このマッピングの例では
ProductController
用にRESTful API URLマッピングを提供しています:
static mappings = {
"/product/$id"(controller:"product") {
action = [GET:"show", PUT:"update", DELETE:"delete", POST:"save"]
}
}
6.4.6 マッピングワイルドカード
Grails' URL mappings mechanism also supports wildcard mappings. For example consider the following mapping:
GrailsのURLマッピング機能ではワイルドカードもサポートしています。例として次ぎのマッピングに注目してください:
static mappings = {
"/images/*.jpg"(controller: "image")
}
This mapping will match all paths to images such as /image/logo.jpg
. Of course you can achieve the same effect with a variable:
このマッピングが
/image/logo.jpg
のような画像パスにマッチします。変数も使用可能です:
static mappings = {
"/images/$name.jpg"(controller: "image")
}
However, you can also use double wildcards to match more than one level below:
ダブルワイルドカード使用すると1レベル下の階層までマッチします:
static mappings = {
"/images/**.jpg"(controller: "image")
}
In this cases the mapping will match /image/logo.jpg
as well as /image/other/logo.jpg
. Even better you can use a double wildcard variable:
このマッピング例では、
/image/logo.jpg
や、
/image/other/logo.jpg
にマッチします。ダブルワイルドカード変数も使用できます:
static mappings = {
// will match /image/logo.jpg and /image/other/logo.jpg
"/images/$name**.jpg"(controller: "image")
}
In this case it will store the path matched by the wildcard inside a
name
parameter obtainable from the
params object:
この例では、
name
パラメータにマッチしたパスを
paramsオブジェクトから取得できます:
def name = params.name
println name // prints "logo" or "other/logo"
If you use wildcard URL mappings then you may want to exclude certain URIs from Grails' URL mapping process. To do this you can provide an excludes
setting inside the UrlMappings.groovy
class:
ワイルドカードURLマッピングを使用すると、一定のURIをURLマッピングでの除外も必要となります。
UrlMappings.groovy
クラスで、
excludes
を指定することで可能です:
class UrlMappings {
static excludes = ["/images/*", "/css/*"]
static mappings = {
…
}
}
In this case Grails won't attempt to match any URIs that start with /images
or /css
.
この例では、
/images
また
/css
で始まるURIはURLマッピングから除外されます.
6.4.7 自動リンクリライト
Another great feature of URL mappings is that they automatically customize the behaviour of the
link tag so that changing the mappings don't require you to go and change all of your links.
URLマッピングには、
linkタグの振る舞いを自動的にカスタマイズ するという優れた機能が存在します。その機能のおかげでURLマッピングを変更しても、その都度リンクを変更しなくても良くなります。
This is done through a URL re-writing technique that reverse engineers the links from the URL mappings. So given a mapping such as the blog one from an earlier section:
URLマッピングからリバースエンジニアリングによってURLをリライトするという仕組みで実装されています。前のセクションからのブログマッピングを例があるとします:
static mappings = {
"/$blog/$year?/$month?/$day?/$id?"(controller:"blog", action:"show")
}
If you use the link tag as follows:
以下のようにlinkタグを使用します:
<g:link controller="blog" action="show"
params="[blog:'fred', year:2007]">
My Blog
</g:link><g:link controller="blog" action="show"
params="[blog:'fred', year:2007, month:10]">
My Blog - October 2007 Posts
</g:link>
Grails will automatically re-write the URL in the correct format:
GrailsがURLを自動的にリライトします:
<a href="/fred/2007">My Blog</a>
<a href="/fred/2007/10">My Blog - October 2007 Posts</a>
6.4.8 制約の適用
URL Mappings also support Grails' unified
validation constraints mechanism, which lets you further "constrain" how a URL is matched. For example, if we revisit the blog sample code from earlier, the mapping currently looks like this:
URLマッピングでは、URLがマッチしてるか確認するために、
バリデーション制約が使用できます。例として、前と同じブログのサンプルを使用します:
static mappings = {
"/$blog/$year?/$month?/$day?/$id?"(controller:"blog", action:"show")
}
This allows URLs such as:
以下のURLを許可します:
/graemerocher/2007/01/10/my_funky_blog_entry
However, it would also allow:
もちろんこのままでは、以下のようなURLも許可します:
/graemerocher/not_a_year/not_a_month/not_a_day/my_funky_blog_entry
This is problematic as it forces you to do some clever parsing in the controller code. Luckily, URL Mappings can be constrained to further validate the URL tokens:
これが許可されるといたずらされる危険性があります。ここで!URLマッピングに制約を定義してURLトークンをバリデートします:
"/$blog/$year?/$month?/$day?/$id?" {
controller = "blog"
action = "show"
constraints {
year(matches:/\d{4}/)
month(matches:/\d{2}/)
day(matches:/\d{2}/)
}
}
In this case the constraints ensure that the year
, month
and day
parameters match a particular valid pattern thus relieving you of that burden later on.
この例では、
year
,
month
,
day
パラメータが特定のパターンにマッチするように制約を定義しています。
6.4.9 名前付きURLマッピング
URL Mappings also support named mappings, that is mappings which have a name associated with them. The name may be used to refer to a specific mapping when links are generated.
URLマッピングでは、名前で連携ができるように、名前付きマッピングに対応しています。
The syntax for defining a named mapping is as follows:
名前付きマッピングの定義は以下のようになります:
static mappings = {
name <mapping name>: <url pattern> {
// …
}
}
For example:
例として:
static mappings = {
name personList: "/showPeople" {
controller = 'person'
action = 'list'
}
name accountDetails: "/details/$acctNumber" {
controller = 'product'
action = 'accountDetails'
}
}
The mapping may be referenced in a link tag in a GSP.
次のように、GSPでlinkタグからマッピングを参照します:
<g:link mapping="personList">List People</g:link>
That would result in:
この結果は以下のようになります:
<a href="/showPeople">List People</a>
Parameters may be specified using the params attribute.
params属性でパラメータを定義することができます.
<g:link mapping="accountDetails" params="[acctNumber:'8675309']">
Show Account
</g:link>
That would result in:
この例の結果は:
<a href="/details/8675309">Show Account</a>
Alternatively you may reference a named mapping using the link namespace.
名前付きマッピングでは、linkタグの代わりに、linkネームスペースのタグが使用できます。
<link:personList>List People</link:personList>
That would result in:
この例の結果は:
<a href="/showPeople">List People</a>
The link namespace approach allows parameters to be specified as attributes.
linkネームスペースタグでは、パラメータを属性で指定できます。
<link:accountDetails acctNumber="8675309">Show Account</link:accountDetails>
That would result in:
この例の結果は:
<a href="/details/8675309">Show Account</a>
To specify attributes that should be applied to the generated href
, specify a Map
value to the attrs
attribute. These attributes will be applied directly to the href, not passed through to be used as request parameters.
属性に指定した全ての内容は生成された
href
に適用されてしまうので、他の属性は、
attrs
属性に
Map
で指定します。
<link:accountDetails attrs="[class: 'fancy']" acctNumber="8675309">
Show Account
</link:accountDetails>
That would result in:
この例の結果は:
<a href="/details/8675309" class="fancy">Show Account</a>
The default URL Mapping mechanism supports camel case names in the URLs. The default URL for accessing an action named addNumbers
in a controller named MathHelperController
would be something like /mathHelper/addNumbers
. Grails allows for the customization of this pattern and provides an implementation which replaces the camel case convention with a hyphenated convention that would support URLs like /math-helper/add-numbers
. To enable hyphenated URLs assign a value of "hyphenated" to the grails.web.url.converter
property in grails-app/conf/Config.groovy
.
URLでの
URLマッピングは、デフォルトでキャメルケースのURLになります。例えばコントローラ
MathHelperController
のアクション
addNumbers
の場合、デフォルトURLでのURLは、
/mathHelper/addNumbers
のようになります。Grailsでは、このパターンをカスタマイズして、
/math-helper/add-numbers
のようなハイフン形式にキャメルケース形式を入れ換える実装が可能です。ハイフンURLを可能にするには、
grails-app/conf/Config.groovy
の
grails.web.url.converter
を"hyphenated"にします。
// grails-app/conf/Config.groovygrails.web.url.converter = 'hyphenated'
Arbitrary strategies may be plugged in by providing a class which implements the
UrlConverter interface and adding an instance of that class to the Spring application context with the bean name of
grails.web.UrlConverter.BEAN_NAME
. If Grails finds a bean in the context with that name, it will be used as the default converter and there is no need to assign a value to the
grails.web.url.converter
config property.
任意の方法追加するには、インターフェイス
UrlConverterを実装したクラスを、ビーン名称
grails.web.UrlConverter.BEAN_NAME
で追加します。Grailsがそのビーン名称をコンテキストに有ることを認識した場合、指定したクラスの実装がデフォルトとなります。この場合は、
grails.web.url.converter
プロパティは必要有りません。
// src/groovy/com/myapplication/MyUrlConverterImpl.groovypackage com.myapplicationclass MyUrlConverterImpl implements grails.web.UrlConverter { String toUrlElement(String propertyOrClassName) {
// return some representation of a property or class name that should be used in URLs…
}
}
// src/groovy/com/myapplication/MyUrlConverterImpl.groovypackage com.myapplicationclass MyUrlConverterImpl implements grails.web.UrlConverter { String toUrlElement(String propertyOrClassName) {
// URLで描写するプロパティ名またはクラス名を返す
}
}
// grails-app/conf/spring/resources.groovybeans = {
"${grails.web.UrlConverter.BEAN_NAME}"(com.myapplication.MyUrlConverterImpl)
}
6.5 Webフロー
概要
Overview
Grails supports the creation of web flows built on the
Spring Web Flow project. A web flow is a conversation that spans multiple requests and retains state for the scope of the flow. A web flow also has a defined start and end state.
Grailsでは、
Spring Web Flow をベースにしたWebフローをサポートしています。Webフローとは、処理範囲での複数のリクエストと保有するステート間の対話です。Webフローでは明示された開始と終了ステートも持っています。
Web flows don't require an HTTP session, but instead store their state in a serialized form, which is then restored using a flow execution key that Grails passes around as a request parameter. This makes flows far more scalable than other forms of stateful application that use the HttpSession and its inherit memory and clustering concerns.
WebフローにはHTTP sessionは必要有りません。代わりに、リクエストパラメータでGrailsが持ち回る、フローエクスキュージョンキーを使用した連載形式でステートを保持しています。この方式はメモリ継承やクラスタリング問題のあるHttpSessionを使用したステートフルアプリケーションの形式よりもフローをスケーラブルにします。
Web flow is essentially an advanced state machine that manages the "flow" of execution from one state to the next. Since the state is managed for you, you don't have to be concerned with ensuring that users enter an action in the middle of some multi step flow, as web flow manages that for you. This makes web flow perfect for use cases such as shopping carts, hotel booking and any application that has multi page work flows.
Webフローは本質的には、"フロー"の実行のステートの流れを管理する上級ステートマシーンです。
ステートが管理されると、Webフローが管理してくれるので、ユーザがフロー途中のアクションから入ってくる場合どうするか等を気にしなくても良くなります。これによりショッピングカート、ホテル予約などの複数ページにまたがるワークフローを持つアプリケーションにWebフローがよく合うと言う事です。
From Grails 1.2 onwards Webflow is no longer in Grails core, so you must install the Webflow plugin to use this feature: grails install-plugin webflow
Grails 1.2からWebフローはGrailsのコア機能では無くなりました。この機能を使用するには、Webフロープラグインをインストールする必要があります: grails install-plugin webflow
フローの作成
Creating a Flow
To create a flow create a regular Grails controller and add an action that ends with the convention Flow
. For example:
フローを作成するには、名称が
Flow
で終わるアクションをGrailsの通常にコントローラに作成します。例として:
class BookController { def index() {
redirect(action: "shoppingCart")
} def shoppingCartFlow = {
…
}
}
Notice when redirecting or referring to the flow as an action we omit the Flow
suffix. In other words the name of the action of the above flow is shoppingCart
.
フローをアクションとしてリダイレクトまたは参照をするには、接尾辞の
Flow
を省略します。言い換えれば上記のフローのアクション名は
shoppingCart
となります。
6.5.1 開始と終了のステート
As mentioned before a flow has a defined start and end state. A start state is the state which is entered when a user first initiates a conversation (or flow). The start state of a Grails flow is the first method call that takes a block. For example:
前述したように、Webフローでは明示された開始と終了ステートも持っています。開始ステートは、ユーザが最初に対話(またはフロー)を開始するステートです。最初のブロックのメソッドコールがGrailsフローの開始ステートです:
class BookController {
…
def shoppingCartFlow ={
showCart {
on("checkout").to "enterPersonalDetails"
on("continueShopping").to "displayCatalogue"
}
…
displayCatalogue {
redirect(controller: "catalogue", action: "show")
}
displayInvoice()
}
}
Here the
showCart
node is the start state of the flow. Since the showCart state doesn't define an action or redirect it is assumed be a
view state that, by convention, refers to the view
grails-app/views/book/shoppingCart/showCart.gsp
.
この例でのフローの開始ステートは
showCart
ノードになります。showCartがアクションまたリダイレクトを定義していない場合は、慣習により
grails-app/views/book/shoppingCart/showCart.gsp
を参照して表示する
ビューステートとして見なされます。
Notice that unlike regular controller actions, the views are stored within a directory that matches the name of the flow: grails-app/views/book/shoppingCart
.
通常のコントローラアクションと違い、ビューファイルはフロー名称のディレクトリに配置された物にマッチします:
grails-app/views/book/shoppingCart
The shoppingCart
flow also has two possible end states. The first is displayCatalogue
which performs an external redirect to another controller and action, thus exiting the flow. The second is displayInvoice
which is an end state as it has no events at all and will simply render a view called grails-app/views/book/shoppingCart/displayInvoice.gsp
whilst ending the flow at the same time.
この
shoppingCart
フローには、2つの終了ステートがあります。一つ目のステートは、外部のコントローラアクションにリダイレクトしてフローから出る
displayCatalogue
。二つ目のステートは、何もイベント処理が無く単純に、ビューの
grails-app/views/book/shoppingCart/displayInvoice.gsp
を描写して同時にフローを終了する、
displayInvoice
です。
Once a flow has ended it can only be resumed from the start state, in this case showCart
, and not from any other state.
フローが終了したら、開始フローのみから再開できます。この例では
showCart
になります。
6.5.2 アクションステートとビューステート
ビューステート
View states
A view state is a one that doesn't define an action
or a redirect
. So for example this is a view state:
action
また
ridairect
を定義していないものがビューステートです。この例がビューステートになります:
enterPersonalDetails {
on("submit").to "enterShipping"
on("return").to "showCart"
}
It will look for a view called
grails-app/views/book/shoppingCart/enterPersonalDetails.gsp
by default. Note that the
enterPersonalDetails
state defines two events:
submit
and
return
. The view is responsible for
triggering these events. Use the
render
method to change the view to be rendered:
デフォルトでは、ビューファイル
grails-app/views/book/shoppingCart/enterPersonalDetails.gsp
を使用します。
enterPersonalDetails
ステートは、
submit
と
return
という2つのイベントを定義しています。これらのイベントはビューで
トリガーする必要があります。
render
メソッドを使用して描写するビューを変更することが可能です:
enterPersonalDetails {
render(view: "enterDetailsView")
on("submit").to "enterShipping"
on("return").to "showCart"
}
Now it will look for grails-app/views/book/shoppingCart/enterDetailsView.gsp
. Start the view
parameter with a / to use a shared view:
この例で
grails-app/views/book/shoppingCart/enterDetailsView.gsp
を参照するようになります。
view
のパラメータに / を使用して共有ビューを使用できます:
enterPersonalDetails {
render(view: "/shared/enterDetailsView")
on("submit").to "enterShipping"
on("return").to "showCart"
}
Now it will look for grails-app/views/shared/enterDetailsView.gsp
この例で
grails-app/views/shared/enterDetailsView.gsp
を参照するようになります。
アクションステート
Action States
An action state is a state that executes code but does not render a view. The result of the action is used to dictate flow transition. To create an action state you define an action to to be executed. This is done by calling the action
method and passing it a block of code to be executed:
アクションステートはコードを実行してビューを描写しないステートです。アクションの結果は指示されたフロートランジションで使用されます。
action
メソッドに実行したいコードブロックを渡してアクションステートを実装します:
listBooks {
action {
[bookList: Book.list()]
}
on("success").to "showCatalogue"
on(Exception).to "handleError"
}
As you can see an action looks very similar to a controller action and in fact you can reuse controller actions if you want. If the action successfully returns with no errors the
success
event will be triggered. In this case since we return a Map, which is regarded as the "model" and is automatically placed in
flow scope.
ご覧の通りアクションはコントローラアクションに似ています。もちろん必要であればコントローラアクションを再利用することもできます。アクションが正常に終了したら
success
イベントがトリガーされます。この例では、モデルと見なしたMapを返して自動的に
flowスコープに配置されます。
In addition, in the above example we also use an exception handler to deal with errors on the line:
加えて、上記の例では、エラーを取り扱う例外ハンドラも使用しています:
on(Exception).to "handleError"
This makes the flow transition to a state called handleError
in the case of an exception.
例外時に
handleError
というステートにフローが移行します。
You can write more complex actions that interact with the flow request context:
フローリクエストコンテキストとやりとりをする複雑なアクションを記述できます:
processPurchaseOrder {
action {
def a = flow.address
def p = flow.person
def pd = flow.paymentDetails
def cartItems = flow.cartItems
flow.clear() def o = new Order(person: p, shippingAddress: a, paymentDetails: pd)
o.invoiceNumber = new Random().nextInt(9999999)
for (item in cartItems) { o.addToItems item }
o.save()
[order: o]
}
on("error").to "confirmPurchase"
on(Exception).to "confirmPurchase"
on("success").to "displayInvoice"
}
Here is a more complex action that gathers all the information accumulated from the flow scope and creates an Order
object. It then returns the order as the model. The important thing to note here is the interaction with the request context and "flow scope".
この例では、アクションで、flowスコープから収集した情報から
Order
オブジェクトを生成しています。そして生成後オーダーをモデルで返しています。ここで重要なのはリクエストコンテキストと"flowスコープ"のやりとりです。
アクションのトランジション
Transition Actions
Another form of action is what is known as a
transition action. A transition action is executed directly prior to state transition once an
event has been triggered. A simple example of a transition action can be seen below:
他の形式のアクションとしてトランジションアクションがあります。トランジションアクションは、
イベントがトリガーされたら、トランジションステートで直接優先的に実行されます:
enterPersonalDetails {
on("submit") {
log.trace "Going to enter shipping"
}.to "enterShipping"
on("return").to "showCart"
}
Notice how we pass a block of the code to
submit
event that simply logs the transition. Transition states are very useful for
data binding and validation, which is covered in a later section.
この例では、
submit
イベントにコードブロックを渡してトランジションのログを実行しています。この後に解説をする、
データバインディングとバリデーションで、このトランジションステートが便利に活用できます。
6.5.3 フロー実行イベント
In order to transition execution of a flow from one state to the next you need some way of trigger an event that indicates what the flow should do next. Events can be triggered from either view states or action states.
ステートから次のステートへのフローでの
トランジション 実行ができると、次のフローの
イベントトリガー を指定する方法が必要になります。ビューステートまたはアクションステートからイベントをトリガーできます。
ビューステートからのイベントトリガー
Triggering Events from a View State
As discussed previously the start state of the flow in a previous code listing deals with two possible events. A checkout
event and a continueShopping
event:
前のコードの例と同じく、フローの開始ステートには2つのイベントを与えます。
checkout
イベントと
continueShopping
イベントです:
def shoppingCartFlow = {
showCart {
on("checkout").to "enterPersonalDetails"
on("continueShopping").to "displayCatalogue"
}
…
}
Since the
showCart
event is a view state it will render the view
grails-app/book/shoppingCart/showCart.gsp
. Within this view you need to have components that trigger flow execution. On a form this can be done use the
submitButton tag:
shopCart
イベントはビューステートなので、
grails-app/book/shoppingCart/showCart.gsp
を描写します。このビューの中に、フロートリガーを実行するコンポーネントを持つ必要があります。
submitButtonタグを使用したフォームを使います:
<g:form action="shoppingCart">
<g:submitButton name="continueShopping" value="Continue Shopping" />
<g:submitButton name="checkout" value="Checkout" />
</g:form>
The form must submit back to the
shoppingCart
flow. The name attribute of each
submitButton tag signals which event will be triggered. If you don't have a form you can also trigger an event with the
link tag as follows:
フォームは
shoppingCart
フローへ送信するようにします。それぞれの
submitButtonタグのname属性にトリガーするイベントを指定します。フォームを使用しない場合は、次のように
linkタグをイベントトリガーに使用できます:
<g:link action="shoppingCart" event="checkout" />
アクションからのイベントトリガー
Triggering Events from an Action
To trigger an event from an action
you invoke a method. For example there is the built in error()
and success()
methods. The example below triggers the error()
event on validation failure in a transition action:
アクションからイベントをトリガーするには、メソッドを実行します。組込の
error()
と
success()
メソッド(トランジションアクション)が有るのでそれを例に使用します。次の例では、トランジションアクションでバリデーションが失敗したら
error()
イベントをトリガーしています:
enterPersonalDetails {
on("submit") {
def p = new Person(params)
flow.person = p
if (!p.validate()) return error()
}.to "enterShipping"
on("return").to "showCart"
}
In this case because of the error the transition action will make the flow go back to the enterPersonalDetails
state.
このケースでは、errorトランジションアクションにより、フローは
enterPersonalDetails
ステートに戻ります。
With an action state you can also trigger events to redirect flow:
アクションステートでは、リダイレクトフローへイベントをトリガーできます:
shippingNeeded {
action {
if (params.shippingRequired) yes()
else no()
}
on("yes").to "enterShipping"
on("no").to "enterPayment"
}
6.5.4 フローのスコープ
スコープの基礎
Scope Basics
You'll notice from previous examples that we used a special object called flow
to store objects within "flow scope". Grails flows have five different scopes you can utilize:
先ほどの例で、"フロー範囲で有効な"オブジェクトを蓄積する、
flow
という特殊なオブジェクトを使用しました。Grailsフローでは5つのスコープが利用できます:
request
- Stores an object for the scope of the current request
flash
- Stores the object for the current and next request only
flow
- Stores objects for the scope of the flow, removing them when the flow reaches an end state
conversation
- Stores objects for the scope of the conversation including the root flow and nested subflows
session
- Stores objects in the user's session
- request - 現在のリクエスト範囲のオブジェクトを蓄積
- flash - 現在と次までが有効範囲のオブジェクトを蓄積
- flow - フロー範囲で有効なオブジェクトを蓄積。フローが終了ステートに到達したら削除されます。
- conversation - ルートフローやサブフローを含む範囲での対話でのオブジェクトを蓄積
- session - ユーザのセッションへオブジェクトを蓄積
Grails service classes can be automatically scoped to a web flow scope. See the documentation on
Services for more information.
Grailsサービスクラスは自動的にflowスコープになります。詳しくはサービスを参照してください。
Returning a model Map from an action will automatically result in the model being placed in flow scope. For example, using a transition action, you can place objects within flow
scope as follows:
アクションからモデルMapを返すと自動的に結果にあるモデルがflowスコープに配置されます。例としてトランジションアクションで次のように
flow
スコープにオブジェクトを配置できます:
enterPersonalDetails {
on("submit") {
[person: new Person(params)]
}.to "enterShipping"
on("return").to "showCart"
}
Be aware that a new request is always created for each state, so an object placed in request scope in an action state (for example) will not be available in a subsequent view state. Use one of the other scopes to pass objects from one state to another. Also note that Web Flow:
それぞれのステートごとに新しいrequestスコープができます、(例えば)アクションステートのrequestスコープに配置したオブジェクトは次のビューステートでは使用できません。他のステートにオブジェクトを渡す場合は別のスコープを使いましょう。さらにWebフローでは:
- Moves objects from flash scope to request scope upon transition between states;
- Merges objects from the flow and conversation scopes into the view model before rendering (so you shouldn't include a scope prefix when referencing these objects within a view, e.g. GSP pages).
- ステート間のトランジションでオブジェクトをflashスコープからrequestスコープへ移動します。
- 描写する前に、flowとconversationスコープのオブジェクトをビューモデルにマージします。(GSPページ等のビューでオブジェクトを参照する際はスコープ接頭辞を含まないでください)
フロースコープとシリアライズ
Flow Scopes and Serialization
When placing objects in
flash
,
flow
or
conversation
scope they must implement
java.io.Serializable
or an exception will be thrown. This has an impact on
domain classes in that domain classes are typically placed within a scope so that they can be rendered in a view. For example consider the following domain class:
flash
、
flow
また
conversation
スコープに配置するオブジェクトは、必ず
java.io.Serializable
を継承してください。継承しない場合は例外を投げます。
ドメインクラスは通常スコープに配置されビューの描写に使用するので影響を受けます。例として次のようなドメインクラスがあるとします:
class Book {
String title
}
To place an instance of the Book
class in a flow scope you will need to modify it as follows:
Book
のインスタンスをflowスコープで使用する場合は次のようにします:
class Book implements Serializable {
String title
}
This also impacts associations and closures you declare within a domain class. For example consider this:
ドメインクラスに関連するクラスやクロージャにも影響があります。次のようになっていたとします:
class Book implements Serializable {
String title
Author author
}
Here if the
Author
association is not
Serializable
you will also get an error. This also impacts closures used in
GORM events such as
onLoad
,
onSave
and so on. The following domain class will cause an error if an instance is placed in a flow scope:
関連する
Author
が
Serializable
では無い場合はエラーとなります。
onLoad
や
onSave
等の
GORMイベントのクロージャにも影響があります。次のドメインクラスをflowスコープに配置するとエラーとなります:
class Book implements Serializable { String title def onLoad = {
println "I'm loading"
}
}
The reason is that the assigned block on the onLoad
event cannot be serialized. To get around this you should declare all events as transient
:
理由はアサインされた
onLoad
イベントのブロックがシリアライズされないからです。これを対応させるにはイベントに
transient
を指定します:
class Book implements Serializable { String title transient onLoad = {
println "I'm loading"
}
}
or as methods:
またはメソッドにします:
class Book implements Serializable { String title def onLoad() {
println "I'm loading"
}
}
The flow scope contains a reference to the Hibernate session. As a result, any object loaded into the session through a GORM query will also be in the flow and will need to implement Serializable.If you don't want your domain class to be Serializable or stored in the flow, then you will need to evict the entity manually before the end of the state:flow.persistenceContext.evict(it)
6.5.5 データバインディングとバリデーション
In the section on
start and end states, the start state in the first example triggered a transition to the
enterPersonalDetails
state. This state renders a view and waits for the user to enter the required information:
開始と終了ステートのセクションの中で、最初の例の開始ステートは
enterPersonalDetails
ステートへトリガーしています。このステートはビューを描写して、ユーザが必要な情報をエントリーするのを待ちます:
enterPersonalDetails {
on("submit").to "enterShipping"
on("return").to "showCart"
}
The view contains a form with two submit buttons that either trigger the submit event or the return event:
ビューは、submitイベントまたはreturnイベントをトリガーする、2つの送信ボタンを持つフォームを持っています:
<g:form action="shoppingCart">
<g:submitButton name="submit" value="Continue"></g:submitButton>
<g:submitButton name="return" value="Back"></g:submitButton>
</g:form>
However, what about the capturing the information submitted by the form? To capture the form info we can use a flow transition action:
フォームから送信された情報を取り込むには、トランジションアクションを使用します:
enterPersonalDetails {
on("submit") {
flow.person = new Person(params)
!flow.person.validate() ? error() : success()
}.to "enterShipping"
on("return").to "showCart"
}
Notice how we perform data binding from request parameters and place the
Person
instance within
flow
scope. Also interesting is that we perform
validation and invoke the
error()
method if validation fails. This signals to the flow that the transition should halt and return to the
enterPersonalDetails
view so valid entries can be entered by the user, otherwise the transition should continue and go to the
enterShipping
state.
リクエストパラメータからデータバインディングを実行して、
flow
スコープの
Person
インスタンスに渡している部分を注目してください。さらに興味深い部分は、
バリデーションを実行して、失敗したら
error()
メソッドを実行している部分です。この結果を受け取るとトランジションは停止され
enterPersonalDetails
ビューへ戻りユーザが正当な内容をエントリできるようになります。あるいは内容が問題無ければ、トランジションが続行されて
enterShipping
ステートへ移動します。
Like regular actions, flow actions also support the notion of
Command Objects by defining the first argument of the closure:
通常のアクションと同じく、フローアクションでは、クロージャの最初の引数を定義することで、
コマンドオブジェクトにも対応できます:
enterPersonalDetails {
on("submit") { PersonDetailsCommand cmd ->
flow.personDetails = cmd
!flow.personDetails.validate() ? error() : success()
}.to "enterShipping"
on("return").to "showCart"
}
6.5.6 サブフローとの対話
Grails' Web Flow integration also supports subflows. A subflow is like a flow within a flow. For example take this search flow:
GrailsのWebフローはサブフローにも対応しています。サブフローはフォローの中にあるフローです。この検索フローを例とします:
def searchFlow = {
displaySearchForm {
on("submit").to "executeSearch"
}
executeSearch {
action {
[results:searchService.executeSearch(params.q)]
}
on("success").to "displayResults"
on("error").to "displaySearchForm"
}
displayResults {
on("searchDeeper").to "extendedSearch"
on("searchAgain").to "displaySearchForm"
}
extendedSearch {
// Extended search subflow
subflow(controller: "searchExtensions", action: "extendedSearch")
on("moreResults").to "displayMoreResults"
on("noResults").to "displayNoMoreResults"
}
displayMoreResults()
displayNoMoreResults()
}
It references a subflow in the extendedSearch
state. The controller parameter is optional if the subflow is defined in the same controller as the calling flow.
この例では
extendedSearch
ステートで中にサブフローを参照しています。サブフローが同じコントローラで呼ばれる場合は、コントローラを指定するパラメータは省略可能です。
Prior to 1.3.5, the previous subflow call would look like subflow(extendedSearchFlow)
, with the requirement that the name of the subflow state be the same as the called subflow (minus Flow
). This way of calling a subflow is deprecated and only supported for backward compatibility.
1.3.5以前、サブフローは、subflow(extendedSearchFlow)
のように呼び出しました。この方法は非推奨となっており、下位互換のために対応はしています。
The subflow is another flow entirely:
サブフローは完全に別のフローです:
def extendedSearchFlow = {
startExtendedSearch {
on("findMore").to "searchMore"
on("searchAgain").to "noResults"
}
searchMore {
action {
def results = searchService.deepSearch(ctx.conversation.query)
if (!results) return error()
conversation.extendedResults = results
}
on("success").to "moreResults"
on("error").to "noResults"
}
moreResults()
noResults()
}
Notice how it places the extendedResults
in conversation scope. This scope differs to flow scope as it lets you share state that spans the whole conversation not just the flow. Also notice that the end state (either moreResults
or noResults
of the subflow triggers the events in the main flow:
conversationスコープの
extendedResults
の位置に注目してください。このスコープはflowスコープと違い、flowの間だけで無く、全ての対話にかけてステートを共有できます。さらに終了ステートに注目してください。サブフローはサブフロー内とメインフローのイベントをトリガーできます:
extendedSearch {
// Extended search subflow
subflow(controller: "searchExtensions", action: "extendedSearch")
on("moreResults").to "displayMoreResults"
on("noResults").to "displayNoMoreResults"
}
6.6 フィルタ
Although Grails
controllers support fine grained interceptors, these are only really useful when applied to a few controllers and become difficult to manage with larger applications. Filters on the other hand can be applied across a whole group of controllers, a URI space or to a specific action. Filters are far easier to plugin and maintain completely separately to your main controller logic and are useful for all sorts of cross cutting concerns such as security, logging, and so on.
Grailsの
コントローラにはインターセプター機能に対応しています。これらは、少ないコントローラに対しては有用ですが、大きなアプリケーションだと管理が大変になります。その一方フィルタを使用すると、多くのコントローラ、URIスペースや指定したアクションに対して適用できます。フィルタはプラグインにすることも簡単で、コントローラロジックとも切り離されており、セキュリティ、ロギングなどの全体にわたる物として便利です。
6.6.1 フィルタの適用
To create a filter create a class that ends with the convention Filters
in the grails-app/conf
directory. Within this class define a code block called filters
that contains the filter definitions:
フィルタを作成するには、
grails-app/conf
ディレクトリに、名称が
Filters
で終わるクラスを作成します。このクラスにはフィルタを記述する、
filters
というコードブロックを定義します:
class ExampleFilters {
def filters = {
// your filters here
}
}
Each filter you define within the filters
block has a name and a scope. The name is the method name and the scope is defined using named arguments. For example to define a filter that applies to all controllers and all actions you can use wildcards:
filters
ブロックに定義する各フィルタには、範囲と名称を持たせます。名称はメソッド名で、範囲は引数で定義します。例として、ワイルドカードを使用した全コントローラ・アクションに適用されるフィルタを定義します:
sampleFilter(controller:'*', action:'*') {
// interceptor definitions
}
The scope of the filter can be one of the following things:
フィルタの範囲は次のように指定できます:
- A controller and/or action name pairing with optional wildcards
- A URI, with Ant path matching syntax
- 省略可能なワイルドカードを使用した、コントローラ名と(または)アクション名の組み合わせ。
- Antパスマッチング書式のURI指定。
Filter rule attributes:
フィルタルール属性:
controller
- controller matching pattern, by default * is replaced with .* and a regex is compiled
controllerExclude
- controller exclusion pattern, by default * is replaced with .* and a regex is compiled
action
- action matching pattern, by default * is replaced with .* and a regex is compiled
actionExclude
- action exclusion pattern, by default * is replaced with .* and a regex is compiled
regex
(true
/false
) - use regex syntax (don't replace '*' with '.*')
uri
- a uri to match, expressed with as Ant style path (e.g. /book/**)
uriExclude
- a uri pattern to exclude, expressed with as Ant style path (e.g. /book/**)
find
(true
/false
) - rule matches with partial match (see java.util.regex.Matcher.find()
)
invert
(true
/false
) - invert the rule (NOT rule)
controller
- コントローラ対象のパターンマッチング, 既存値 * で正規表現コンパイル時には .*に置換されます。
controllerExclude
- 除外するコントローラのパターン, 既存値 * で正規表現コンパイル時には .*に置換されます。
action
- アクション対象のパターンマッチング, 既存値 * で正規表現コンパイル時には .*に置換されます。
actionExclude
- 除外するアクションのパターン, 既存値 * で正規表現コンパイル時には .*に置換されます。
regex (true/false)
- 正規表現の使用 ('*' を '.*'に置換しない指定)
uri
- URIマッチ, Antスタイルパス (e.g. /book/**)
uriExclude
- 除外するURIパターン, Antスタイルパス (e.g. /book/**)
find (true/false)
- 部分マッチ (java.util.regex.Matcher.find()
を参照)
invert (true/false)
- ルールを逆にする
Some examples of filters include:
フィルタの例:
- All controllers and actions
all(controller: '*', action: '*') {}
- Only for the
BookController
justBook(controller: 'book', action: '*') {}
- All controllers except the
BookController
notBook(controller: 'book', invert: true) {}
- All actions containing 'save' in the action name
saveInActionName(action: '*save*', find: true) {}
- All actions starting with the letter 'b' except for actions beginning with the phrase 'bad*'
- "bad*"を除外した、'b'で始まるアクション全て
actionBeginningWithBButNotBad(action: 'b*', actionExclude: 'bad*', find: true) {}
someURIs(uri: '/book/**') {}
In addition, the order in which you define the filters within the
filters
code block dictates the order in which they are executed. To control the order of execution between
Filters
classes, you can use the
dependsOn
property discussed in
filter dependencies section.
filters
コードブロックに定義した順序でフィルタは実行されます。
Filters
クラス間での実行を制御するには、
フィルタ依存セクションで記載されている
dependsOn
プロパティが使用できます。
Note: When exclude patterns are used they take precedence over the matching patterns. For example, if action is 'b*' and actionExclude is 'bad*' then actions like 'best' and 'bien' will have that filter applied but actions like 'bad' and 'badlands' will not.
注意:除外パターンが使用された場合は除外マッチングパターンが優先されます。例として、アクションが'b*' で、actionExcludeが'bad*'の場合、'best','bien'等のアクションは適用されますが、'bad','badland'は適用されません。
6.6.2 フィルタの種類
Within the body of the filter you can then define one or several of the following interceptor types for the filter:
フィルタの中に、幾つかのインターセプタを定義することができます。
before
- Executed before the action. Return false
to indicate that the response has been handled that that all future filters and the action should not execute
after
- Executed after an action. Takes a first argument as the view model to allow modification of the model before rendering the view
afterView
- Executed after view rendering. Takes an Exception as an argument which will be non-null
if an exception occurs during processing. Note: this Closure is called before the layout is applied.
before
- アクションの前に実行されます。false
を返す事で、その後に実行されるフィルタとアクションは実行されません。
after
- アクションの後に実行されます。最初の引数に、ビュー描写前に変更可能なビューモデルが渡されます。
afterView
- ビュー描写後に実行されます。実行時に例外が発生した場合はnon-null
なExceptionが引数として渡されます。このクロージャはレイアウトが適用される前に実行されます。
For example to fulfill the common simplistic authentication use case you could define a filter as follows:
シンプルな認証の仕組みとしてフィルタを定義する例です:
class SecurityFilters {
def filters = {
loginCheck(controller: '*', action: '*') {
before = {
if (!session.user && !actionName.equals('login')) {
redirect(action: 'login')
return false
}
}
}
}
}
Here the loginCheck
filter uses a before
interceptor to execute a block of code that checks if a user is in the session and if not redirects to the login action. Note how returning false ensure that the action itself is not executed.
この
loginCheck
フィルタは、
before
インターセプタのコードブロックを実行することで、ユーザがセッションに無い場合はloginアクションへリダイレクトしています。falseを返す事で対象のアクション自身が実行されないようにします。
Here's a more involved example that demonstrates all three filter types:
import java.util.concurrent.atomic.AtomicLongclass LoggingFilters { private static final AtomicLong REQUEST_NUMBER_COUNTER = new AtomicLong()
private static final String START_TIME_ATTRIBUTE = 'Controller__START_TIME__'
private static final String REQUEST_NUMBER_ATTRIBUTE = 'Controller__REQUEST_NUMBER__' def filters = { logFilter(controller: '*', action: '*') { before = {
if (!log.debugEnabled) return true long start = System.currentTimeMillis()
long currentRequestNumber = REQUEST_NUMBER_COUNTER.incrementAndGet() request[START_TIME_ATTRIBUTE] = start
request[REQUEST_NUMBER_ATTRIBUTE] = currentRequestNumber log.debug "preHandle request #$currentRequestNumber : " +
"'$request.servletPath'/'$request.forwardURI', " +
"from $request.remoteHost ($request.remoteAddr) " +
" at ${new Date()}, Ajax: $request.xhr, controller: $controllerName, " +
"action: $actionName, params: ${new TreeMap(params)}" return true
} after = { Map model -> if (!log.debugEnabled) return true long start = request[START_TIME_ATTRIBUTE]
long end = System.currentTimeMillis()
long requestNumber = request[REQUEST_NUMBER_ATTRIBUTE] def msg = "postHandle request #$requestNumber: end ${new Date()}, " +
"controller total time ${end - start}ms"
if (log.traceEnabled) {
log.trace msg + "; model: $model"
}
else {
log.debug msg
}
} afterView = { Exception e -> if (!log.debugEnabled) return true long start = request[START_TIME_ATTRIBUTE]
long end = System.currentTimeMillis()
long requestNumber = request[REQUEST_NUMBER_ATTRIBUTE] def msg = "afterCompletion request #$requestNumber: " +
"end ${new Date()}, total time ${end - start}ms"
if (e) {
log.debug "$msg \n\texception: $e.message", e
}
else {
log.debug msg
}
}
}
}
}
In this logging example we just log various request information, but note that the
model
map in the
after
filter is mutable. If you need to add or remove items from the model map you can do that in the
after
filter.
6.6.3 変数とスコープ
フィルタでは、
コントローラや
タグライブラリで利用できる共通のプロパティとアプリケーションコンテキストを参照できます:
However, filters only support a subset of the methods available to controllers and tag libraries. These include:
フィルタではコントローラやタグライブラリで使用できる一部のメソッドが使用できます:
- redirect - For redirects to other controllers and actions
- render - For rendering custom responses
6.6.4 フィルタ依存関係
In a Filters
class, you can specify any other Filters
classes that should first be executed using the dependsOn
property. This is used when a Filters
class depends on the behavior of another Filters
class (e.g. setting up the environment, modifying the request/session, etc.) and is defined as an array of Filters
classes.
Filters
クラスでは、
dependsOn
プロパティに他の
Filters
クラスを定義して先に実行させることが可能です。この機能は
Filters
クラスが他の
Filters
クラスの振る舞いに依存する場合等に使用します。
Take the following example Filters
classes:
Filters
クラスの例を見ていきましょう:
class MyFilters {
def dependsOn = [MyOtherFilters] def filters = {
checkAwesome(uri: "/*") {
before = {
if (request.isAwesome) { // do something awesome }
}
} checkAwesome2(uri: "/*") {
before = {
if (request.isAwesome) { // do something else awesome }
}
}
}
}
class MyOtherFilters {
def filters = {
makeAwesome(uri: "/*") {
before = {
request.isAwesome = true
}
}
doNothing(uri: "/*") {
before = {
// do nothing
}
}
}
}
MyFilters specifically dependsOn
MyOtherFilters. This will cause all the filters in MyOtherFilters whose scope matches the current request to be executed before those in MyFilters. For a request of "/test", which will match the scope of every filter in the example, the execution order would be as follows:
MyFiltersには、
dependsOn
にMyOtherFiltersを指定しています。これにより、リクエストがフィルタ範囲にマッチしたMyOtherFiltersのフィルタがMyFiltersの前に実行されます。この例では"/test"とリクエストした場合全てのフィルタにマッチします。フィルタ実行順は次のようになります:
- MyOtherFilters - makeAwesome
- MyOtherFilters - doNothing
- MyFilters - checkAwesome
- MyFilters - checkAwesome2
The filters within the MyOtherFilters class are processed in order first, followed by the filters in the MyFilters class. Execution order between Filters
classes are enabled and the execution order of filters within each Filters
class are preserved.
MyOtherFiltersクラスのフィルタが先に実行されて、MyFiltersクラスのフィルタへと続きます。
Filters
クラスの実行順が可能になり、各
Filters
クラスのフィルタ実行順も保っています。
If any cyclical dependencies are detected, the filters with cyclical dependencies will be added to the end of the filter chain and processing will continue. Information about any cyclical dependencies that are detected will be written to the logs. Ensure that your root logging level is set to at least WARN or configure an appender for the Grails Filters Plugin (org.codehaus.groovy.grails.plugins.web.filters.FiltersGrailsPlugin
) when debugging filter dependency issues.
循環依存関係を検出したら、循環依存関係のあるフィルタをフィルタチェインの最後に追加して処理を続行します。その後、循環依存関係を検出した事をログへ出力します。ログを出力するには、ルートロガーレベルがWARNに設定されFilers用のログ定義をする必要があります。
6.7 Ajax
Ajax is the driving force behind the shift to richer web applications. These types of applications in general are better suited to agile, dynamic frameworks written in languages like
Groovy and
Ruby Grails provides support for building Ajax applications through its Ajax tag library. For a full list of these see the Tag Library Reference.
AjaxはリッチWebアプリケーションでは欠かせない物となっています。この手のアプリケーションには通常、GroovyやRuby等で実装されたアジャイル、ダイナミックフレームワークがお似合いです。GrailsではAjaxアプリケーションを構築をサポートするためのAjaxタグライブラリを提供しています。Ajaxタグライブラリのリストはタグリファレンスを参照してください。
6.7.1 Ajax対応
Grailsはデフォルトで
jQuery を使用しています。他のライブラリ、
Prototype、
Dojo、
Yahoo UI、
Google Web Toolkit等もプラグインで提供しています。
This section covers Grails' support for Ajax in general. To get started, add this line to the <head>
tag of your page:
このセクションでは全般的なAjax対応の説明をします。先ずはじめに、ページの
<head>
タグ内に以下を追加します:
<g:javascript library="jquery" />
You can replace jQuery
with any other library supplied by a plugin you have installed. This works because of Grails' support for adaptive tag libraries. Thanks to Grails' plugin system there is support for a number of different Ajax libraries including (but not limited to):
プラグインで提供された他のライブラリを使用する際は、
jquery
の部分を入れ換えます。これはGrailsの適用性のあるタグライブラリで可能にしています。Grailsのプラグインには、次の様々なAjaxライブラリが存在します(これは一部です):
- jQuery
- Prototype
- Dojo
- YUI
- MooTools
6.7.1.1 リモートリンク
Remote content can be loaded in a number of ways, the most commons way is through the
remoteLink tag. This tag allows the creation of HTML anchor tags that perform an asynchronous request and optionally set the response in an element. The simplest way to create a remote link is as follows:
多くの方法でリモートコンテントをロードすることが可能ですが、一般的な方法として
remoteLinkタグを使用します。
このタグは、非同期リクエストと結果をエレメントにセット(省略可能)するHTMLアンカータグを生成します。リモートリンクタグを作成する簡単な例は次のようになります:
<g:remoteLink action="delete" id="1">Delete Book</g:remoteLink>
The above link sends an asynchronous request to the delete
action of the current controller with an id of 1
.
上記の例で生成されたタグは、id:1をリクエストパラメータとして
delete
アクションに非同期リクエストを送信します。
6.7.1.2 コンテンツの更新
This is great, but usually you provide feedback to the user about what happened:
先ほどの例で非同期送信を行いましたが、通常ユーザへ何が行われたかのフィードバックを提供する必要があります:
def delete() {
def b = Book.get(params.id)
b.delete()
render "Book ${b.id} was deleted"
}
GSP code:
GSPコード:
<div id="message"></div>
<g:remoteLink action="delete" id="1" update="message">
Delete Book
</g:remoteLink>
The above example will call the action and set the contents of the message
div
to the response in this case "Book 1 was deleted"
. This is done by the update
attribute on the tag, which can also take a Map to indicate what should be updated on failure:
この例では対象のアクションをコールしてレスポンスを
messege
のidをもった
div
エレメントの内容を
"Book 1 was deleted"
に更新します。この更新動作は、タグの
update
属性で対象を指定しています。さらにMapを使用して更新失敗時の表示先も指定できます:
<div id="message"></div>
<div id="error"></div>
<g:remoteLink update="[success: 'message', failure: 'error']"
action="delete" id="1">
Delete Book
</g:remoteLink>
Here the error
div will be updated if the request failed.
この例ではリクエストに失敗すると、
error
のIDをもつdivタグ内が更新されます。
An HTML form can also be submitted asynchronously in one of two ways. Firstly using the
formRemote tag which expects similar attributes to those for the
remoteLink tag:
HTMLフォームを非同期で送信することができます。
remoteLinkタグと同じような属性を使用できる
formRemoteタグを使用する例です:
<g:formRemote url="[controller: 'book', action: 'delete']"
update="[success: 'message', failure: 'error']">
<input type="hidden" name="id" value="1" />
<input type="submit" value="Delete Book!" />
</g:formRemote >
Or alternatively you can use the
submitToRemote tag to create a submit button. This allows some buttons to submit remotely and some not depending on the action:
他の方法として、
submitToRemoteタグを使用して送信ボタンを作成します。このボタンで非同期送信ボタンを可能として、アクションに依存させなくできます:
<form action="delete">
<input type="hidden" name="id" value="1" />
<g:submitToRemote action="delete"
update="[success: 'message', failure: 'error']" />
</form>
6.7.1.4 Ajaxイベント
Specific JavaScript can be called if certain events occur, all the events start with the "on" prefix and let you give feedback to the user where appropriate, or take other action:
指定したJavaScriptを、イベントが発生した際にコールすることができます。全てのイベントは接頭辞"on"で指定します:
<g:remoteLink action="show"
id="1"
update="success"
onLoading="showProgress()"
onComplete="hideProgress()">Show Book 1</g:remoteLink>
The above code will execute the "showProgress()" function which may show a progress bar or whatever is appropriate. Other events include:
上記のコードでは、実行されると、ロード時に指定した"showProgress()"ファンクションがプログレスバーを表示する等ファンクションの実装に対応した動作を行います。他に以下のイベントが使用可能です:
onSuccess
- The JavaScript function to call if successful
onFailure
- The JavaScript function to call if the call failed
on_ERROR_CODE
- The JavaScript function to call to handle specified error codes (eg on404="alert('not found!')")
onUninitialized
- The JavaScript function to call the a Ajax engine failed to initialise
onLoading
- The JavaScript function to call when the remote function is loading the response
onLoaded
- The JavaScript function to call when the remote function is completed loading the response
onComplete
- The JavaScript function to call when the remote function is complete, including any updates
onSuccess
- 成功した時に呼び出すJavaScriptファンクション
onFailure
- 失敗した時に呼び出すJavaScriptファンクション
on_ERROR_CODE
- 指定したエラーコードを取得したら呼び出すJavaScriptファンクション (eg on404="alert('not found!')")
onUninitialized
- Ajaxエンジンの初期化に失敗したときに呼び出すJavaScriptファンクション
onLoading
- レスポンスを読み込み中に呼び出すJavaScriptファンクション
onLoaded
- レスポンスの読み込み完了時に呼び出すJavaScriptファンクション
onComplete
- リモートファンクションが完全に完了(更新を含む)したら呼び出すJavaScriptファンクション
If you need a reference to the XmlHttpRequest
object you can use the implicit event parameter e
to obtain it:
XmlHttpRequest
オブジェクトを参照する場合は、以下のように、
e
等のイベントパラメータ使用して取得します:
<g:javascript>
function fireMe(e) {
alert("XmlHttpRequest = " + e)
}
}
</g:javascript>
<g:remoteLink action="example"
update="success"
onSuccess="fireMe(e)">Ajax Link</g:remoteLink>
6.7.2 Prototypeを使用したAjax
Grails features an external plugin to add
Prototype support to Grails. To install the plugin type the following command from the root of your project in a terminal window:
Prototype はプラグインで対応しています。インストールするにはプロジェクトのルートで次のコマンドをターミナルで実行します:
grails install-plugin prototype
This will download the current supported version of the Prototype plugin and install it into your Grails project. With that done you can add the following reference to the top of your page:
このコマンドでPrototypeプラグインがダウンロードされプロジェクトにインストールされます。そして次のようにページのトップに記述します:
<g:javascript library="prototype" />
If you require
Scriptaculous too you can do the following instead:
Scriptaculous も必要であれば、代わりに次のように指定します:
<g:javascript library="scriptaculous" />
この定義で他の
remoteLink,
formRemoteや
submitToRemote等のGrailsタグを使用できます。
6.7.3 Dojoを使用したAjax
Grails features an external plugin to add
Dojo support to Grails. To install the plugin type the following command from the root of your project in a terminal window:
Dojo はプラグインで対応しています。インストールするにはプロジェクトのルートで次のコマンドをターミナルで実行します:
grails install-plugin dojo
This will download the current supported version of Dojo and install it into your Grails project. With that done you can add the following reference to the top of your page:
このコマンドでDojoプラグインがダウンロードされプロジェクトにインストールされます。そして次のようにページのトップに記述します:
<g:javascript library="dojo" />
この定義で他の
remoteLink,
formRemoteや
submitToRemote等のGrailsタグを使用できます。
6.7.4 GWTを使用したAjax
Google Web Toolkit をプラグインでサポートしています。詳しくは
ドキュメントを参照してください。
6.7.5 Ajax使用時のサーバサイド
There are a number of different ways to implement Ajax which are typically broken down into:
Ajaxを実装するには幾つかの方法があります。通常次のように分類できます:
- Content Centric Ajax - Where you just use the HTML result of a remote call to update the page
- Data Centric Ajax - Where you actually send an XML or JSON response from the server and programmatically update the page
- Script Centric Ajax - Where the server sends down a stream of JavaScript to be evaluated on the fly
- コンテント中心なAjax - リモートコールの結果HTMLページを更新する。
- データ中心なAjax - XMLまたはJSONをサーバから送信してページをプログラムで更新する。
- スクリプトを使用したAjax - サーバからJavascriptを送信して実行させる。
Most of the examples in the
Ajax section cover Content Centric Ajax where you are updating the page, but you may also want to use Data Centric or Script Centric. This guide covers the different styles of Ajax.
Ajaxセクションでの例のほとんどは、ページの更新を行うコンテント中心なAjaxを説明しました。データ中心やスクリプトを使用したAjaxも使用すると思います。このガイドでは他のスタイル尾Ajaxを解説します。
コンテント中心のAjax
Content Centric Ajax
Just to re-cap, content centric Ajax involves sending some HTML back from the server and is typically done by rendering a template with the
render method:
同じ説明になりますが、コンテント中心のAjaxでの要件はHTMLをサーバから返す事です。通常この場合はテンプレートを
renderメソッドで描写して実装します:
def showBook() {
def b = Book.get(params.id) render(template: "bookTemplate", model: [book: b])
}
Calling this on the client involves using the
remoteLink tag:
これをクライアント側で
remoteLinkタグを使用して呼び出します:
<g:remoteLink action="showBook" id="${book.id}"
update="book${book.id}">Update Book</g:remoteLink><div id="book${book.id}">
</div>
JSONを使用したデータ中心のAjax
Data Centric Ajax with JSON
Data Centric Ajax typically involves evaluating the response on the client and updating programmatically. For a JSON response with Grails you would typically use Grails'
JSON marshalling capability:
データ中心のAjaxでは、クライアントがレスポンスで取得した内容を評価してプログラムで更新をします。GrailsではJSONのレスポンスを返すには
JSONマーシャリングを使用します:
import grails.converters.JSONdef showBook() {
def b = Book.get(params.id) render b as JSON
}
And then on the client parse the incoming JSON request using an Ajax event handler:
クライアント側で取得したJSONをAjaxイベントハンドラを使って処理します:
<g:javascript>
function updateBook(e) {
var book = eval("("+e.responseText+")") // evaluate the JSON
$("book" + book.id + "_title").innerHTML = book.title
}
<g:javascript>
<g:remoteLink action="test" update="foo" onSuccess="updateBook(e)">
Update Book
</g:remoteLink>
<g:set var="bookId">book${book.id}</g:set>
<div id="${bookId}">
<div id="${bookId}_title">The Stand</div>
</div>
XMLを使用したデータ中心のAjax
Data Centric Ajax with XML
On the server side using XML is equally simple:
サーバサイドでXMLをえお扱うのも簡単です:
import grails.converters.XMLdef showBook() {
def b = Book.get(params.id) render b as XML
}
However, since DOM is involved the client gets more complicated:
しかしクライアント側でのDOM操作は複雑になります:
<g:javascript>
function updateBook(e) {
var xml = e.responseXML
var id = xml.getElementsByTagName("book").getAttribute("id")
$("book" + id + "_title") = xml.getElementsByTagName("title")[0].textContent
}
<g:javascript>
<g:remoteLink action="test" update="foo" onSuccess="updateBook(e)">
Update Book
</g:remoteLink>
<g:set var="bookId">book${book.id}</g:set>
<div id="${bookId}">
<div id="${bookId}_title">The Stand</div>
</div>
スクリプトを使用したAjax
Script Centric Ajax with JavaScript
Script centric Ajax involves actually sending JavaScript back that gets evaluated on the client. An example of this can be seen below:
スクリプトを使用したAjaxは、Javascriptを返してクライアント側で動作(評価)させます。以下が例になります:
def showBook() {
def b = Book.get(params.id) response.contentType = "text/javascript"
String title = b.title.encodeAsJavascript()
render "$('book${b.id}_title')='${title}'"
}
The important thing to remember is to set the contentType
to text/javascript
. If you use Prototype on the client the returned JavaScript will automatically be evaluated due to this contentType
setting.
重要な部分として
contentType
を
text/javascript
にすることを思えて起きましょう。Prototypeを使用した場合はこの
contentType
で自動的にJavaScriptを評価します。
Obviously in this case it is critical that you have an agreed client-side API as you don't want changes on the client breaking the server. This is one of the reasons Rails has something like RJS. Although Grails does not currently have a feature such as RJS there is a
Dynamic JavaScript Plugin that offers similar capabilities.
当然このケースでは、クライアントがサーバを壊す事が無いと認めたクライアントサイトAPIでは無いと危険です。これがRailsではRJSを持っている理由です。Grailsには、RJSに相当する仕組みは存在しませんが、同じような内容の仕組みが
Dynamic JavaScriptプラグインで提供されています。
AjaxとAjaxでない両方へのレスポンス
Responding to both Ajax and non-Ajax requests
It's straightforward to have the same Grails controller action handle both Ajax and non-Ajax requests. Grails adds the isXhr()
method to HttpServletRequest
which can be used to identify Ajax requests. For example you could render a page fragment using a template for Ajax requests or the full page for regular HTTP requests:
AjaxとAjaxではないリクエストを同じコントローラアクションで処理ができます。Grailsでは、Ajaxリクエスト判別用に、
HttpServletRequest
に
isXhr()
メソッドを追加しています。例として、Ajaxリクエストの場合はテンプレートでページの一部を描写し、それ以外は全ページ描写を行う場合:
def listBooks() {
def books = Book.list(params)
if (request.xhr) {
render template: "bookTable", model: [books: books]
} else {
render view: "list", model: [books: books]
}
}
6.8 コンテントネゴシエーション
Grails has built in support for
Content negotiation using either the HTTP
Accept
header, an explicit format request parameter or the extension of a mapped URI.
Grailsには、明示的なフォーマットに対するリクエストのHTTP
Accept
ヘッダーまたはマップされたURIの拡張子での
コンテントネゴシエーションに対応しています。
Mimeタイプの定義
Configuring Mime Types
Before you can start dealing with content negotiation you need to tell Grails what content types you wish to support. By default Grails comes configured with a number of different content types within grails-app/conf/Config.groovy
using the grails.mime.types
setting:
コンテントネゴシエーションの処理を行うには、どのコンテントタイプをサポートするかをGrailsに教える必要があります。
grails-app/conf/Config.groovy
の
grails.mime.types
設定に幾つかのコンテントタイプがデフォルトで定義されています:
grails.mime.types = [ xml: ['text/xml', 'application/xml'],
text: 'text-plain',
js: 'text/javascript',
rss: 'application/rss+xml',
atom: 'application/atom+xml',
css: 'text/css',
csv: 'text/csv',
all: '*/*',
json: 'text/json',
html: ['text/html','application/xhtml+xml']
]
The above bit of configuration allows Grails to detect to format of a request containing either the 'text/xml' or 'application/xml' media types as simply 'xml'. You can add your own types by simply adding new entries into the map.
この設定の一部を説明すると、'text/xml'または'application/xml'を含むリクエストは単純にコンテントタイプ'xml'としてGrailsが検出するのを可能にします。独自のタイプを追加するには単純にマップにタイプを追加するだけです。
Acceptヘッダーを使用したコンテントネゴシエーション
Content Negotiation using the Accept header
Every incoming HTTP request has a special
Accept header that defines what media types (or mime types) a client can "accept". In older browsers this is typically:
全てのHTTPリクエストは、クライアントが受け入れ可能な、メディア(mimeタイプ)を定義した、
Acceptヘッダーを持っています。古いブラウザの場合は通常以下のようになります:
Which simply means anything. However, on newer browser something all together more useful is sent such as (an example of a Firefox Accept
header):
これは単純に何でも可能という意味です。最新のブラウザではもっと便利になっており次のような内容を送信します(FireFoxの
Accept
ヘッダーを例として):
text/xml, application/xml, application/xhtml+xml, text/html;q=0.9,
text/plain;q=0.8, image/png, */*;q=0.5
Grails parses this incoming format and adds a
property
to the
response object that outlines the preferred response format. For the above example the following assertion would pass:
Grailsではこの入ってきたフォーマットをパースして、レスポンスフォーマットを選択するための
property
を
responseオブジェクトに追加します。上記の例では以下のアサーションが通ります:
assert 'html' == response.format
Why? The text/html
media type has the highest "quality" rating of 0.9, therefore is the highest priority. If you have an older browser as mentioned previously the result is slightly different:
何故でしょう? メディアタイプ
text/html
は、レートでは0.9という高い"特質"を持っているので、優先度が高いからです。先の例で紹介した古いブラウザの場合は少し違います:
assert 'all' == response.format
In this case 'all' possible formats are accepted by the client. To deal with different kinds of requests from
Controllers you can use the
withFormat method that acts as kind of a switch statement:
このケースの'all'はどのクライアントでも受け入れられます。様々な種類のリクエストを
コントローラで分別するには、switch文のように動作する
withFormatメソッドを使用します:
import grails.converters.XMLclass BookController { def list() {
def books = Book.list()
withFormat {
html bookList: books
js { render "alert('hello')" }
xml { render books as XML }
}
}
}
If the preferred format is html
then Grails will execute the html()
call only. This causes Grails to look for a view called either grails-app/views/books/list.html.gsp
or grails-app/views/books/list.gsp
. If the format is xml
then the closure will be invoked and an XML response rendered.
優先されたフォーマットが
html
の場合Grailsはhtml()のみを実行します。この場合Grailsは、
grails-app/views/books/list.html.gsp
また
grails-app/views/books/list.gsp
のどちらかのビューを探しに行きます。
How do we handle the "all" format? Simply order the content-types within your withFormat
block so that whichever one you want executed comes first. So in the above example, "all" will trigger the html
handler.
ではどのようにフォーマットの"all"を判別するのでしょう?単純に
withFormat
ブロックのコンテントタイプの順番を指定して一番最初に実行される物を決めます。上記の例では、"all"を受け取った場合は、
html
ハンドラを実行します。
When using
withFormat make sure it is the last call in your controller action as the return value of the
withFormat
method is used by the action to dictate what happens next.
withFormatを使用する場合は、withFormat
での返値がコントローラアクションで最終の返値となります。
リクエストフォーマット vs レスポンスフォーマット
Request format vs. Response format
As of Grails 2.0, there is a separate notion of the request format and the response format. The request format is dictated by the CONTENT_TYPE
header and is typically used to detect if the incoming request can be parsed into XML or JSON, whilst the response format uses the file extension, format parameter or ACCEPT header to attempt to deliver an appropriate response to the client.
Grails 2.0からの対応で、リクエストフォーマットとレスポンスフォーマットでは分離して認識するようになりました。リクエストフォーマットは、
CONTENT_TYPE
ヘッダの指定で入ってくるリクエストを認識してXMLまたJSON等に分類します。レスポンスフォーマットでは、ファイル拡張子、フォーマットパラメータまたはACCEPTヘッダを認識して適したレスポンスをクライアントに返します。
The
withFormat available on controllers deals specifically with the response format. If you wish to add logic that deals with the request format then you can do so using a separate
withFormat
method available on the request:
コントローラでの
withFormatはレスポンスフォーマット専用となります。リクエストフォーマットでロジックを記述する場合は、requestオブジェクトの
withFormat
メソッドを使用します:
request.withFormat {
xml {
// read XML
}
json {
// read JSON
}
}
リクエストパラメータformatでのコンテントネゴシエーション
Content Negotiation with the format Request Parameter
If fiddling with request headers if not your favorite activity you can override the format used by specifying a format
request parameter:
リクエストヘッダを参照した方法を行いたく無い場合は、フォーマットを指定するために、リクエストパラメータの
format
が使用できます:
You can also define this parameter in the
URL Mappings definition:
このパラメータは
URLマッピングでも定義できます:
"/book/list"(controller:"book", action:"list") {
format = "xml"
}
URI拡張子でのコンテントネゴシエーション
Content Negotiation with URI Extensions
Grails also supports content negotiation using URI extensions. For example given the following URI:
URI拡張子でのコンテントネゴシエーションにも対応しています。例として次のようなURIがあるとします:
Grails will remove the extension and map it to /book/list
instead whilst simultaneously setting the content format to xml
based on this extension. This behaviour is enabled by default, so if you wish to turn it off, you must set the grails.mime.file.extensions
property in grails-app/conf/Config.groovy
to false
:
Grailsが拡張子を外して、
xml
としてフォーマットをセットして
/book/list
にマップします。この振る舞いはデフォルトで使用可能です。この機能を外したい場合は
grails-app/conf/Config.groovy
の
grails.mime.file.extensions
プロパティを
false
に指定します:
grails.mime.file.extensions = false
コンテントネゴシエーションをテスト
Testing Content Negotiation
To test content negotiation in a unit or integration test (see the section on
Testing) you can either manipulate the incoming request headers:
Unitテストまたは統合テスト(
テストのセクションを参照)でコンテントネゴシエーションをテストする際に、入ってくるリクエストヘッダを操作することができます:
void testJavascriptOutput() {
def controller = new TestController()
controller.request.addHeader "Accept",
"text/javascript, text/html, application/xml, text/xml, */*" controller.testAction()
assertEquals "alert('hello')", controller.response.contentAsString
}
Or you can set the format parameter to achieve a similar effect:
または、formatパラメータをセットすることが可能です:
void testJavascriptOutput() {
def controller = new TestController()
controller.params.format = 'js' controller.testAction()
assertEquals "alert('hello')", controller.response.contentAsString
}