(Quick Reference)

The Grails Framework - Reference Documentation

Authors: Graeme Rocher, Peter Ledbrook, Marc Palmer, Jeff Brown, Luke Daley, Burt Beckwith, Lari Hotari

Version: 3.0.12

Table of Contents

1.1What's new in Grails 3.0?

1.1.1Core Features

1.1.2Web Features

1.1.3Development Environment Features

1.1.4Testing Features

2Getting Started

2.1Installation Requirements

2.2Downloading and Installing

2.3Creating an Application

2.4A Hello World Example

2.5Using Interactive Mode

2.6Getting Set Up in an IDE

2.7Convention over Configuration

2.8Running an Application

2.9Testing an Application

2.10Deploying an Application

2.11Supported Java EE Containers

2.12Creating Artefacts

2.13Generating an Application

3Upgrading from Grails 2.x

3.1Upgrading Plugins

3.2Upgrading Applications

4.1Basic Configuration

4.1.1Options for the yml format Config

4.1.2Built in options

4.1.3Logging

4.2The Application Class

4.2.1Executing the Application Class

4.2.2Customizing the Application Class

4.2.3The Application LifeCycle

4.3Environments

4.4The DataSource

4.4.1DataSources and Environments

4.4.2Automatic Database Migration

4.4.3Transaction-aware DataSource Proxy

4.4.4Database Console

4.4.5Multiple Datasources

4.5Versioning

4.6Project Documentation

4.7Dependency Resolution

5The Command Line

5.1Interactive Mode

5.2The Command Line and Profiles

5.3Creating Custom Scripts

5.4Re-using Grails scripts

5.5Building with Gradle

5.5.1Defining Dependencies with Gradle

5.5.2Working with Gradle Tasks

5.5.3Grails plugins for Gradle

6Object Relational Mapping (GORM)

6.1Quick Start Guide

6.1.1Basic CRUD

6.2Domain Modelling in GORM

6.2.1Association in GORM

6.2.1.1Many-to-one and one-to-one

6.2.1.2One-to-many

6.2.1.3Many-to-many

6.2.1.4Basic Collection Types

6.2.2Composition in GORM

6.2.3Inheritance in GORM

6.2.4Sets, Lists and Maps

6.3Persistence Basics

6.3.1Saving and Updating

6.3.2Deleting Objects

6.3.3Understanding Cascading Updates and Deletes

6.3.4Eager and Lazy Fetching

6.3.5Pessimistic and Optimistic Locking

6.3.6Modification Checking

6.4Querying with GORM

6.4.1Dynamic Finders

6.4.2Where Queries

6.4.3Criteria

6.4.4Detached Criteria

6.4.5Hibernate Query Language (HQL)

6.5Advanced GORM Features

6.5.1Events and Auto Timestamping

6.5.2Custom ORM Mapping

6.5.2.1Table and Column Names

6.5.2.2Caching Strategy

6.5.2.3Inheritance Strategies

6.5.2.4Custom Database Identity

6.5.2.5Composite Primary Keys

6.5.2.6Database Indices

6.5.2.7Optimistic Locking and Versioning

6.5.2.8Eager and Lazy Fetching

6.5.2.9Custom Cascade Behaviour

6.5.2.10Custom Hibernate Types

6.5.2.11Derived Properties

6.5.2.12Custom Naming Strategy

6.5.3Default Sort Order

6.6Programmatic Transactions

6.7GORM and Constraints

7.1Controllers

7.1.1Understanding Controllers and Actions

7.1.2Controllers and Scopes

7.1.3Models and Views

7.1.4Redirects and Chaining

7.1.5Data Binding

7.1.6XML and JSON Responses

7.1.7More on JSONBuilder

7.1.8Uploading Files

7.1.9Command Objects

7.1.10Handling Duplicate Form Submissions

7.1.11Simple Type Converters

7.1.12Declarative Controller Exception Handling

7.2Groovy Server Pages

7.2.1GSP Basics

7.2.1.1Variables and Scopes

7.2.1.2Logic and Iteration

7.2.1.3Page Directives

7.2.1.4Expressions

7.2.2GSP Tags

7.2.2.1Variables and Scopes

7.2.2.2Logic and Iteration

7.2.2.3Search and Filtering

7.2.2.4Links and Resources

7.2.2.5Forms and Fields

7.2.2.6Tags as Method Calls

7.2.3Views and Templates

7.2.4Layouts with Sitemesh

7.2.5Static Resources

7.2.6Sitemesh Content Blocks

7.2.7Making Changes to a Deployed Application

7.2.8GSP Debugging

7.3Tag Libraries

7.3.1Variables and Scopes

7.3.2Simple Tags

7.3.3Logical Tags

7.3.4Iterative Tags

7.3.5Tag Namespaces

7.3.6Using JSP Tag Libraries

7.3.7Tag return value

7.4URL Mappings

7.4.1Mapping to Controllers and Actions

7.4.2Mapping to REST resources

7.4.3Redirects In URL Mappings

7.4.4Embedded Variables

7.4.5Mapping to Views

7.4.6Mapping to Response Codes

7.4.7Mapping to HTTP methods

7.4.8Mapping Wildcards

7.4.9Automatic Link Re-Writing

7.4.10Applying Constraints

7.4.11Named URL Mappings

7.4.12Customizing URL Formats

7.4.13Namespaced Controllers

7.5Interceptors

7.5.1Defining Interceptors

7.5.2Matching Requests with Inteceptors

7.5.3Ordering Interceptor Execution

7.6Content Negotiation

8.1Traits Provided by Grails

8.1.1WebAttributes Trait Example

9.1.1Domain classes as REST resources

9.1.2Mapping to REST resources

9.1.3Linking to REST resources

9.1.4Versioning REST resources

9.1.5Implementing REST controllers

9.1.5.1Extending the RestfulController super class

9.1.5.2Implementing REST Controllers Step by Step

9.1.5.3Generating a REST controller using scaffolding

9.1.6Customizing Response Rendering

9.1.6.1Customizing the Default Renderers

9.1.6.2Registering Custom Objects Marshallers

9.1.6.3Using Named Configurations for Object Marshallers

9.1.6.4Implementing the ObjectMarshaller Interface

9.1.6.5Implementing a Custom Renderer

9.1.6.6Using GSP to Customize Rendering

9.1.7Hypermedia as the Engine of Application State

9.1.7.1HAL Support

9.1.7.2Atom Support

9.1.7.3Vnd.Error Support

9.1.8Customizing Binding of Resources

9.3RSS and Atom

10Asynchronous Programming

10.1Promises

10.2.1Consuming Events

10.2.2Event Notification

10.2.3Reactor Spring Annotations

10.2.4Events from GORM

10.2.5Events from Spring

10.3Asynchronous GORM

10.4Asynchronous Request Handling

10.5Servlet 3.0 Async

11.1Declaring Constraints

11.2Validating Constraints

11.3Sharing Constraints Between Classes

11.4Validation on the Client

11.5Validation and Internationalization

11.6Applying Validation to Other Classes

12The Service Layer

12.1Declarative Transactions

12.1.1Transactions Rollback and the Session

12.2Scoped Services

12.3Dependency Injection and Services

12.4Using Services from Java

13Static Type Checking And Compilation

13.1The GrailsCompileStatic Annotation

13.2The GrailsTypeChecked Annotation

14.1Unit Testing

14.1.1Unit Testing Controllers

14.1.2Unit Testing Tag Libraries

14.1.3Unit Testing Domains

14.1.4Unit Testing Filters

14.1.5Unit Testing URL Mappings

14.1.6Mocking Collaborators

14.1.7Mocking Codecs

14.1.8Unit Test Metaprogramming

14.2Integration Testing

14.3Functional Testing

15Internationalization

15.1Understanding Message Bundles

15.2Changing Locales

15.3Reading Messages

15.4Scaffolding and i18n

16.1Securing Against Attacks

16.2Cross Site Scripting (XSS) Prevention

16.3Encoding and Decoding Objects

16.4Authentication

16.5Security Plugins

16.5.1Spring Security

16.5.2Shiro

17.1Creating and Installing Plugins

17.2Plugin Repositories

17.3Providing Basic Artefacts

17.4Evaluating Conventions

17.5Hooking into Runtime Configuration

17.6Adding Methods at Compile Time

17.7Adding Dynamic Methods at Runtime

17.8Participating in Auto Reload Events

17.9Understanding Plugin Load Order

17.10The Artefact API

17.10.1Asking About Available Artefacts

17.10.2Adding Your Own Artefact Types

18Grails and Spring

18.1The Underpinnings of Grails

18.2Configuring Additional Beans

18.3Runtime Spring with the Beans DSL

18.4The BeanBuilder DSL Explained

18.5Property Placeholder Configuration

18.6Property Override Configuration

19Grails and Hibernate

19.1Using Hibernate XML Mapping Files

19.2Mapping with Hibernate Annotations

19.3Adding Constraints

22Contributing to Grails

22.1Report Issues in Github's issue tracker

22.2Build From Source and Run Tests

22.3Submit Patches to Grails Core

22.4Submit Patches to Grails Documentation

Quick Reference (hide)