Add another java source directory to gradle script

Question

I hava an example java project package

package com.example.testing;

with such file tree

app
|
  src->com->example->testing->Main.java

and a gradle script:

apply plugin: 'java'
apply plugin: 'application'

sourceSets {
    main {
        java {
            srcDirs 'src'
        }
    }


}

sourceSets.main.output.classesDir = file("classes")
mainClassName = 'com.example.testing.Main'

defaultTasks 'compileJava', 'run'

Now I want to add some module to this project and my folders will be something like this

app
|
  src1->com->example->testing->Main.java

  src2->com->another_example->another_testing->Library.java

How do I add new source code to gradle script?

Why don't you respect the standard gradle/Maven conventions? Everything would work fine automatically, without needing to configure all the paths. — JB Nizet, Jun 26 '15 at 16:35
I for instance would like to have a separate directory for generated sources. — Florian F, Oct 09 '18 at 14:38

score 63 · Accepted Answer · edited Feb 03 '22 at 17:11

63

I agree with @JB Nizet about respecting standard conventions. If you still insist on being an Anarchist though:

You already have src declared in your sourceset, why not add src1 and src2 as well? You can add them to the same sourceset, or define a sourceset per module if you want.

sourceSets {
    main {
        java {
            srcDirs 'src'
            srcDirs 'src1'
            srcDirs 'src2'
        }
    }
 }

To reference files outside the project, see this answer.

edited Feb 03 '22 at 17:11

Dave Jarvis

30,436
41
178
315

answered Jun 26 '15 at 17:32

RaGe

22,696
11
72
104

18

While I agree with wanting to use standard conventions, this one tip was useful when dealing with "generated" sources, which wind up wherever the generator tool feel like tossing them... so, thanks! – Marco Massenzio May 25 '17 at 20:52

koppor · Answer 2 · 2020-06-19T14:35:14.077

The question is about "Adding"; the question of the text is describing a more concrete scenario. If one just wants to add an existing directory, this is the way to add:

sourceSets.main.java.srcDirs += ['src/gen/java']

An example full build.gradle is as follows:

apply plugin: 'java'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.squareup:javapoet:1.12.1'
}

sourceSets.main.java.srcDirs += ['src/gen/java']

JavaPoet s a Java API for generating .java source files. It is just used as example library for the build.gradle file.

score 17 · Answer 3 · answered Apr 25 '18 at 06:41

17

I have a slightly different approach with a Gradle 4.6:

sourceSets {
    main {
        java {
            srcDir 'src/main/java'
            srcDir 'build/swagger-code-dummy/src/main/java'
        }
    }
}

as you can see, I had to specify the directories with the "/main/java" subdirectories as well, otherwise gradle/intellij was not setting the right path.

Maybe this helps someone else too :)

answered Apr 25 '18 at 06:41

gabowsky

572
4
13

This is also helpful if your project involves multiple languages, such as Python or Bash, and you need those directories to be treated like source roots also. – Jonathan E. Landrum Sep 25 '19 at 13:13
When do you do this? Before or after generating the code? And do you need to add the dependencies? – arc1880 Aug 21 '23 at 01:04

score 13 · Answer 4 · edited Feb 03 '20 at 07:25

13

A slightly different solution:

sourceSets.main.java.srcDirs = ['build/jasper', 'src/main/java']

edited Feb 03 '20 at 07:25

Nolequen

3,032
6
36
55

answered Sep 20 '18 at 05:18

Fresh Codemonger

1,125
1
10
20

I am using VSCode and gradle and adding a similar line in build.gradle solved the problem. – Panagiotis Piperopoulos Aug 22 '23 at 19:56

Add another java source directory to gradle script

4 Answers4

Linked