{"id":25520,"date":"2015-07-27T15:00:17","date_gmt":"2015-07-27T12:00:17","guid":{"rendered":"http:\/\/examples.javacodegeeks.com\/?p=25520"},"modified":"2019-04-03T14:00:28","modified_gmt":"2019-04-03T11:00:28","slug":"gradle-wrapper-example","status":"publish","type":"post","link":"https:\/\/examples.javacodegeeks.com\/java-development\/core-java\/gradle\/gradle-wrapper-example\/","title":{"rendered":"Gradle Wrapper Example"},"content":{"rendered":"

In this example, we will understand how Gradle can be used to build projects even if the developer machine doesn’t have Gradle installed, by using Gradle Wrapper. This is a best practice to unify the Gradle version used by the entire development team.<\/p>\n

1. What’s Gradle Wrapper?<\/h2>\n

Gradle Wrapper is a type batch or shell script that downloads and automatically configures Gradle to execute tasks. Imagine that you want to run a Gradle build, well you need to download and install Gradle in your computer, so this concept allows is to distribute our project and build configurations with no need to have Gradle installed.\n<\/p>\n

2. What we need to start?<\/h2>\n

This is a simple example, really you only need Gradle to start and to create the base wrapper to distribute to all others, but to make more readable will use Eclipse. So<\/p>\n

    \n
  1. As IDE: Eclipse Luna 4.4<\/li>\n
  2. Eclipse Gradle Plugin<\/li>\n
  3. Java JDK 1.7<\/li>\n
  4. Gradle 2.3 or higher<\/li>\n<\/ol>\n

    3. Environment Configuration<\/h2>\n

    Please set your Gradle environment variables and install the Gradle plugin on your IDE. To avoid to be boilerplate visit this previous posts that show how to configure your Gradle Environment. Gradle Hello World Tutorial<\/a><\/p>\n

    4. Creating Wrapper Script<\/h2>\n

    In Eclipse, Create a new Gradle Project and then edit gradle build script.

    <\/div> <\/div><\/p>\n

    \"Gradle<\/a>
    Gradle Wrapper Project<\/figcaption><\/figure><\/p>\n

    Then, in the build.gradle<\/code> script we must add a task of type org.gradle.api.tasks.wrapper.Wrapper<\/code> to customize the configuration of the default Wrapper<\/code> task.<\/p>\n

    task createGradleWrapper(type: Wrapper) {\n\tgradleVersion = '2.3'\n\tscriptFile = 'GradleJ' \/\/define a new name for gradle\n\tjarFile = 'gradle-bin.jar' \/\/jar with files to download and invoke Gradle\n\tdistributionUrl = 'https:\/\/services.gradle.org\/distributions\/gradle-2.3-bin.zip'\n}\n<\/pre>\n
    Then, we can execute this task to generate the wrapper files. Execute gradle createGradleWrapper<\/code> or gradle cGW<\/code> in abbreviated form on Windows command shell. This is the output:<\/p>\n
    C:\\Users\\Andres\\workspaceLuna\\GradlWrapperExample>gradle cGW\n:GradlWrapperExample:createGradleWrapper UP-TO-DATE\n\nBUILD SUCCESSFUL\n\nTotal time: 1.044 secs\nC:\\Users\\Andres\\workspaceLuna\\GradlWrapperExample>\n<\/pre>\n
    5. Using Gradle Wrapper<\/h2>\n
    Then, after the execution of the task, two files are generated: gradlej<\/code> and gradlej.bat<\/code> in the root of the project (so refresh it to see them), that contain all the logic and configurations to run Gradle.[ulp id=’1om4ygalA6VlPl7R’]<\/p>\n
    This new files are part of the project, so is a good practice add these files to the version control, to able team people that checkout project and build the scripts with gradle and gradlew by default if you don’t customize the name) instead of theirs Gradle version.<\/p>\n
    So, to test Gradle Wrapper we add this simple task and we run with gradlej<\/code> instead of gradle<\/code> command.<\/p>\n
    task helloWrapper << {\n\tprintln 'Welcome to JCG Gradle Wrapper Tutorial'\n}\n<\/pre>\n
    Execute this command gradlej helloWrapper<\/code> or gradlej hW<\/code> in abbreviated form on Windows command shell. This is the output:<\/p>\n
    C:\\Users\\Andres\\workspaceLuna\\GradlWrapperExample>gradlej hW\n:GradlWrapperExample:helloWrapper\nWelcome to JCG Gradle Wrapper Tutorial\n\nBUILD SUCCESSFUL\n\nTotal time: 1.445 secs\nC:\\Users\\Andres\\workspaceLuna\\GradlWrapperExample>\n<\/pre>\n
    This is how we can use Gradle wrapper to build projects even if other developers don’t have Gradle installed.<\/p>\n
    6. Key Points<\/h2>\n
    \n
    Tips<\/strong><\/p>\n