(Quick Reference)

The Grails Framework

Authors: The Apache Grails Team

Version: 7.1.1

Table of Contents

1.1What's new in Grails 7?

1.1.1Updated Dependencies

2Getting Started

2.1Installation Requirements

2.2Downloading and Installing

2.3Creating an Application

2.4Creating a Simple Web Application with Grails

2.5Using Interactive Mode

2.6Getting Set Up in an IDE

2.7Grails Directory Structure and Convention over Configuration

2.8Running and Debugging an Application

2.9Testing an Application

2.10Deploying an Application

2.11Supported Jakarta EE Containers

2.12Creating Artefacts

2.13Generating an Application

2.14Development Reloading

3Upgrading from the previous versions

3.1Upgrading from Grails 7.0 to Grails 7.1

3.2Upgrading from Grails 6 to Grails 7.0

3.3Upgrading from Grails 5 to Grails 6

3.4Upgrading from Grails 4 to Grails 5

3.5Upgrading from Grails 3.3.x to Grails 4

4.1Configuration Types

4.1.1YML Configuration

4.1.2External Configuration

4.1.3Built-in Properties

4.1.4Logging

4.1.4.1Logger Names

4.1.4.2Masking Request Parameters From Stacktrace Logs

4.1.4.3External Configuration File

4.1.6Configuring an HTTP proxy

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.6Dependency Resolution

5The Command Line

5.1Interactive Mode

5.2Creating Custom Scripts

5.3Creating Custom Commands

5.4Creating a Grails Project

5.5Re-using Grails scripts

5.6Building with Gradle

5.6.1Defining Dependencies with Gradle

5.6.2Working with Gradle Tasks

5.6.3Grails plugins for Gradle

6Application Profiles

6.1Standard Profiles

6.1.1Web Profile

6.1.2REST API Profile

6.1.3Plugin Profile

6.1.4Web Plugin Profile

6.1.5REST API Plugin Profile

6.1.6Profile Profile

6.2Creating Profiles

6.3Profile Inheritance

6.4Publishing Profiles

6.5Understanding Profiles

6.6Creating Profile Commands

6.7Creating Profile Features

7Object Relational Mapping (GORM)

7.1Quick Start Guide

7.1.1Basic CRUD

7.2Further Reading on GORM

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.6Responding with JSON

8.1.7More on JSONBuilder

8.1.8Responding with XML

8.1.9Uploading Files

8.1.10Command Objects

8.1.11Handling Duplicate Form Submissions

8.1.12Simple Type Converters

8.1.13Declarative 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

8.2.4.1Content Blocks

8.2.5Static Resources

8.2.6Making Changes to a Deployed Application

8.2.7Tag Libraries

8.2.7.1Variables and Scopes

8.2.7.2Simple Tags

8.2.7.3Logical Tags

8.2.7.4Iterative Tags

8.2.7.5Tag Namespaces

8.2.7.6Using JSP Tag Libraries

8.2.7.7Tag return value

8.3Fields Plugin

8.3.1Installation

8.3.3Customizing Field Rendering

8.3.4Embedded Properties

8.3.5Themes

8.3.6Including Templates in Plugins

8.3.7Performance

8.3.8Scaffolding

8.4JSON Views

8.4.1Installation

8.4.2Templates

8.4.3Rendering Domain Classes

8.4.4JSON View API

8.4.5Model Naming

8.4.6Content Negotiation

8.4.7HAL Support

8.4.8JSON API Support

8.4.9The JsonTemplateEngine

8.4.10Static Compilation

8.4.11Testing

8.4.12Plugin Support

8.4.13Configuration

8.4.14Custom Converters

8.4.15IntelliJ Support

8.4.16Debugging Views

8.5Markup Views

8.5.1Installation

8.5.2Markup View API

8.5.3Configuration

8.6URL Mappings

8.6.1Mapping to Controllers and Actions

8.6.2Mapping to REST resources

8.6.3Redirects In URL Mappings

8.6.4Embedded Variables

8.6.5Mapping to Views

8.6.6Mapping to Response Codes

8.6.7Mapping to HTTP methods

8.6.8Mapping Wildcards

8.6.9Automatic Link Re-Writing

8.6.10Applying Constraints

8.6.11Named URL Mappings

8.6.12Customizing URL Formats

8.6.13Namespaced Controllers

8.8Interceptors

8.8.1Defining Interceptors

8.8.2Matching Requests with Interceptors

8.8.3Ordering Interceptor Execution

8.9Content Negotiation

9.1Traits Provided by Grails

9.1.1WebAttributes Trait Example

10.1Domain classes as REST resources

10.2Mapping to REST resources

10.3Linking to REST resources from GSP pages

10.4Versioning REST resources

10.5Implementing REST controllers

10.5.1Extending the RestfulController super class

10.5.2Implementing REST Controllers Step by Step

10.5.3Generating a REST controller using scaffolding

10.6Calling REST Services with HttpClient

10.7The REST Profile

10.8JSON Views

10.8.1Getting Started

10.8.2Creating JSON Views

10.8.3JSON View Templates

10.8.4Rendering Domain Classes with JSON Views

10.8.5JSON Views by Convention

10.9Customizing Response Rendering

10.9.1Customizing the Default Renderers

10.9.2Implementing a Custom Renderer

10.9.3Using GSP to Customize Rendering

10.10Hypermedia as the Engine of Application State

10.10.1HAL Support

10.10.2Atom Support

10.10.3Vnd.Error Support

10.11Customizing Binding of Resources

10.12RSS and Atom

11Asynchronous Programming

11.1Promises

11.2.1Event Publishing

11.2.2Subscribing to Events

11.2.3Reactor Spring Annotations

11.2.4Events from GORM

11.2.5Events from Spring

11.2.6Configure the Default Event Bus

11.3Asynchronous GORM

11.4RxJava Support

11.4.1Server Sent Events

11.4.2RxGORM

11.5Asynchronous Request Handling

11.6Servlet 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 and Multi-DataSources

13.1.2Transactions 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.1Generating Tests

15.2Running Tests

15.2.1With Grails CLI

15.2.2With Gradle

15.3Unit Testing

15.3.1Installation

15.3.2Upgrading From The Mixin Framework

15.3.3Unit Testing Controllers

15.3.4Unit Testing Domain Classes

15.3.5Unit Testing Services

15.3.6Unit Testing Tag Libraries

15.3.7Unit Testing Interceptors

15.3.8Unit Testing Url Mappings

15.3.9Annotations

15.3.10Useful Properties

15.4Integration Testing

15.5Functional Testing

15.6Custom Test Phases

16Building a Successful Application

16.1Code Analysis and Styling for Groovy

17Internationalization

17.1Understanding Message Bundles

17.2Changing Locales

17.3Reading Messages

17.4Scaffolding and i18n

18.1Securing Against Attacks

18.2Cross Site Scripting (XSS) Prevention

18.3Encoding and Decoding Objects

18.4Authentication

18.5Security Plugins

18.5.1Spring Security

19.1Creating and Installing Plugins

19.2Plugin Repositories

19.3Providing Basic Artefacts

19.4Evaluating Conventions

19.5Hooking into Runtime Configuration

19.6Adding Methods at Compile Time

19.7Adding Dynamic Methods at Runtime

19.8Participating in Auto Reload Events

19.9Understanding Plugin Load Order

19.10The Artefact API

19.10.1Asking About Available Artefacts

19.10.2Adding Your Own Artefact Types

20Grails and Spring

20.1Configuring Additional Beans

20.2Runtime Spring with the Beans DSL

20.3The BeanBuilder DSL Explained

20.4Property Placeholder Configuration

20.5Property Override Configuration

20.6Spring Boot Actuators

22.1.1Configuration

22.1.2Cache Annotations

22.1.2.1Unit Testing

22.1.3The CacheManager

22.2Caching Tags

22.3The Cache Admin Service

22.3.1Clearing Caches

22.4Implementation Details

23.1Standalone

23.2Container Deployment (e.g. Tomcat)

23.3Deployment Configuration Tasks

24Contributing to Grails

Quick Reference (hide)