(Quick Reference)

The Grails Framework - Reference Documentation

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

Version: 3.1.10

Table of Contents

1.1What's new in Grails 3.1?

1.1.1Improvements to Grails 3 Profiles

1.1.2REST API and AngularJS Profiles

1.1.3GORM 5 Suite

1.1.4Plugin Publishing Plugins

1.2What's new in Grails 3.0?

1.2.1Core Features

1.2.2Web Features

1.2.3Development Environment Features

1.2.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 and Debugging an Application

2.9Testing an Application

2.10Deploying an Application

2.11Supported Java EE Containers

2.12Creating Artefacts

2.13Generating an Application

3Upgrading from previous versions of Grails

3.1Upgrading from Grails 3.0

3.2Upgrading from Grails 2.x

3.2.1Upgrading Plugins

3.2.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.2Creating Custom Scripts

5.3Re-using Grails scripts

5.4Building with Gradle

5.4.1Defining Dependencies with Gradle

5.4.2Working with Gradle Tasks

5.4.3Grails plugins for Gradle

6Application Profiles

6.1Creating Profiles

6.2Profile Inheritance

6.3Publishing Profiles

6.4Understanding Profiles

6.5Creating Profile Commands

6.6Creating Profile Features

7Object Relational Mapping (GORM)

7.1Quick Start Guide

7.1.1Basic CRUD

7.2Domain Modelling in GORM

7.2.1Association in GORM

7.2.1.1Many-to-one and one-to-one

7.2.1.2One-to-many

7.2.1.3Many-to-many

7.2.1.4Basic Collection Types

7.2.2Composition in GORM

7.2.3Inheritance in GORM

7.2.4Sets, Lists and Maps

7.3Persistence Basics

7.3.1Saving and Updating

7.3.2Deleting Objects

7.3.3Understanding Cascading Updates and Deletes

7.3.4Eager and Lazy Fetching

7.3.5Pessimistic and Optimistic Locking

7.3.6Modification Checking

7.4Querying with GORM

7.4.1Dynamic Finders

7.4.2Where Queries

7.4.3Criteria

7.4.4Detached Criteria

7.4.5Hibernate Query Language (HQL)

7.5Advanced GORM Features

7.5.1Events and Auto Timestamping

7.5.2Custom ORM Mapping

7.5.2.1Table and Column Names

7.5.2.2Caching Strategy

7.5.2.3Inheritance Strategies

7.5.2.4Custom Database Identity

7.5.2.5Composite Primary Keys

7.5.2.6Database Indices

7.5.2.7Optimistic Locking and Versioning

7.5.2.8Eager and Lazy Fetching

7.5.2.9Custom Cascade Behaviour

7.5.2.10Custom Hibernate Types

7.5.2.11Derived Properties

7.5.2.12Custom Naming Strategy

7.5.3Default Sort Order

7.6Programmatic Transactions

7.7GORM and Constraints

8.1Controllers

8.1.1Understanding Controllers and Actions

8.1.2Controllers and Scopes

8.1.3Models and Views

8.1.4Redirects and Chaining

8.1.5Data Binding

8.1.6XML and JSON Responses

8.1.7More on JSONBuilder

8.1.8Uploading Files

8.1.9Command Objects

8.1.10Handling Duplicate Form Submissions

8.1.11Simple Type Converters

8.1.12Declarative Controller Exception Handling

8.2Groovy Server Pages

8.2.1GSP Basics

8.2.1.1Variables and Scopes

8.2.1.2Logic and Iteration

8.2.1.3Page Directives

8.2.1.4Expressions

8.2.2GSP Tags

8.2.2.1Variables and Scopes

8.2.2.2Logic and Iteration

8.2.2.3Search and Filtering

8.2.2.4Links and Resources

8.2.2.5Forms and Fields

8.2.2.6Tags as Method Calls

8.2.3Views and Templates

8.2.4Layouts with Sitemesh

8.2.5Static Resources

8.2.6Sitemesh Content Blocks

8.2.7Making Changes to a Deployed Application

8.2.8GSP Debugging

8.3Tag Libraries

8.3.1Variables and Scopes

8.3.2Simple Tags

8.3.3Logical Tags

8.3.4Iterative Tags

8.3.5Tag Namespaces

8.3.6Using JSP Tag Libraries

8.3.7Tag return value

8.4URL Mappings

8.4.1Mapping to Controllers and Actions

8.4.2Mapping to REST resources

8.4.3Redirects In URL Mappings

8.4.4Embedded Variables

8.4.5Mapping to Views

8.4.6Mapping to Response Codes

8.4.7Mapping to HTTP methods

8.4.8Mapping Wildcards

8.4.9Automatic Link Re-Writing

8.4.10Applying Constraints

8.4.11Named URL Mappings

8.4.12Customizing URL Formats

8.4.13Namespaced Controllers

8.5Interceptors

8.5.1Defining Interceptors

8.5.2Matching Requests with Inteceptors

8.5.3Ordering Interceptor Execution

8.6Content Negotiation

9.1Traits Provided by Grails

9.1.1WebAttributes Trait Example

10.1.1Domain classes as REST resources

10.1.2Mapping to REST resources

10.1.3Linking to REST resources from GSP pages

10.1.4Versioning REST resources

10.1.5Implementing REST controllers

10.1.5.1Extending the RestfulController super class

10.1.5.2Implementing REST Controllers Step by Step

10.1.5.3Generating a REST controller using scaffolding

10.1.6The REST Profile

10.1.7The Angular Profile

10.1.8JSON Views

10.1.8.1Getting Started

10.1.8.2Creating JSON Views

10.1.8.3JSON View Templates

10.1.8.4Rendering Domain Classes with JSON Views

10.1.8.5JSON Views by Convention

10.1.9Customizing Response Rendering

10.1.9.1Customizing the Default Renderers

10.1.9.2Implementing a Custom Renderer

10.1.9.3Using GSP to Customize Rendering

10.1.10Hypermedia as the Engine of Application State

10.1.10.1HAL Support

10.1.10.2Atom Support

10.1.10.3Vnd.Error Support

10.1.11Customizing Binding of Resources

10.2RSS and Atom

11Asynchronous Programming

11.1Promises

11.2.1Consuming Events

11.2.2Event Notification

11.2.3Reactor Spring Annotations

11.2.4Events from GORM

11.2.5Events from Spring

11.3Asynchronous GORM

11.4Asynchronous Request Handling

11.5Servlet 3.0 Async

12.1Declaring Constraints

12.2Validating Constraints

12.3Sharing Constraints Between Classes

12.4Validation on the Client

12.5Validation and Internationalization

12.6Applying Validation to Other Classes

13The Service Layer

13.1Declarative Transactions

13.1.1Transactions Rollback and the Session

13.2Scoped Services

13.3Dependency Injection and Services

14Static Type Checking And Compilation

14.1The GrailsCompileStatic Annotation

14.2The GrailsTypeChecked Annotation

15.1Unit Testing

15.1.1Unit Testing Controllers

15.1.2Unit Testing Tag Libraries

15.1.3Unit Testing Domains

15.1.4Unit Testing Filters

15.1.5Unit Testing URL Mappings

15.1.6Mocking Collaborators

15.1.7Mocking Codecs

15.1.8Unit Test Metaprogramming

15.2Integration Testing

15.3Functional Testing

16Internationalization

16.1Understanding Message Bundles

16.2Changing Locales

16.3Reading Messages

16.4Scaffolding and i18n

17.1Securing Against Attacks

17.2Cross Site Scripting (XSS) Prevention

17.3Encoding and Decoding Objects

17.4Authentication

17.5Security Plugins

17.5.1Spring Security

17.5.2Shiro

18.1Creating and Installing Plugins

18.2Plugin Repositories

18.3Providing Basic Artefacts

18.4Evaluating Conventions

18.5Hooking into Runtime Configuration

18.6Adding Methods at Compile Time

18.7Adding Dynamic Methods at Runtime

18.8Participating in Auto Reload Events

18.9Understanding Plugin Load Order

18.10The Artefact API

18.10.1Asking About Available Artefacts

18.10.2Adding Your Own Artefact Types

19Grails and Spring

19.1The Underpinnings of Grails

19.2Configuring Additional Beans

19.3Runtime Spring with the Beans DSL

19.4The BeanBuilder DSL Explained

19.5Property Placeholder Configuration

19.6Property Override Configuration

20Grails and Hibernate

20.1Using Hibernate XML Mapping Files

20.2Mapping with Hibernate Annotations

20.3Adding Constraints

22.1Standalone

22.2Container Deployment (e.g. Tomcat)

22.3Deployment Configuration Tasks

23Contributing to Grails

23.1Report Issues in Github's issue tracker

23.2Build From Source and Run Tests

23.3Submit Patches to Grails Core

23.4Submit Patches to Grails Documentation

Quick Reference (hide)