Groovy: what’s the purpose of “def” in “def x = 0”?

by

It’s syntactic sugar for basic scripts. Omitting the “def” keyword puts the variable in the bindings for the current script and groovy treats it (mostly) like a globally scoped variable:

x = 1
assert x == 1
assert this.binding.getVariable("x") == 1

Using the def keyword instead does not put the variable in the scripts bindings:

def y = 2

assert y == 2

try {
    this.binding.getVariable("y") 
} catch (groovy.lang.MissingPropertyException e) {
    println "error caught"
}

Prints: “error caught”

Using the def keyword in larger programs is important as it helps define the scope in which the variable can be found and can help preserve encapsulation.

If you define a method in your script, it won’t have access to the variables that are created with “def” in the body of the main script as they aren’t in scope:

 x = 1
 def y = 2


public bar() {
    assert x == 1

    try {
        assert y == 2
    } catch (groovy.lang.MissingPropertyException e) {
        println "error caught"
    }
}

bar()

prints “error caught”

The “y” variable isn’t in scope inside the function. “x” is in scope as groovy will check the bindings of the current script for the variable. As I said earlier, this is simply syntactic sugar to make quick and dirty scripts quicker to type out (often one liners).

Good practice in larger scripts is to always use the “def” keyword so you don’t run into strange scoping issues or interfere with variables you don’t intend to.

More Related Contents:

  1. Split a string in groovy
  2. How do I get the output of a shell command executed using into a variable from Jenkinsfile (groovy)?
  3. Groovy executing shell commands
  4. Understanding the groovy syntax in a gradle task definition
  5. Including a groovy script in another groovy
  6. Creating a Jenkins environment variable using Groovy
  7. Can you break from a Groovy “each” closure?
  8. How do I create and access the global variables in Groovy?
  9. What the difference in applying gradle plugin
  10. Load script from groovy script
  11. Get values from properties file using Groovy
  12. Converting a string to int in Groovy
  13. How can I use the Jenkins Copy Artifacts Plugin from within the pipelines (jenkinsfile)?
  14. groovy execute with parameters containing spaces
  15. Reading file from Workspace in Jenkins with Groovy script
  16. Groovy different results on using equals() and == on a GStringImpl
  17. Recommended way to stop a Gradle build
  18. Difference between Groovy Binary and Source release?
  19. How to retrieve Jenkins build parameters using the Groovy API?
  20. What is the native keyword in Java for?
  21. Is there an ANSI SQL alternative to the MYSQL LIMIT keyword?
  22. Difference between “this” and”super” keywords in Java
  23. How do I use a keyword as a variable name?
  24. What is the equivalent of the C# ‘var’ keyword in Java?
  25. How to read a properties files and use the values in project Gradle script?
  26. How do I simply parse a date without a year specified?
  27. object to deserialize has a C# keyword
  28. Cannot define variable in pipeline stage
  29. how to parse json using groovy
  30. Integration Test with Spring Boot and Spock

Leave a Comment