├── modules ├── extra │ └── demo │ │ ├── src │ │ ├── main │ │ │ ├── resources │ │ │ │ └── .keep │ │ │ └── java │ │ │ │ └── com │ │ │ │ └── example │ │ │ │ └── extra │ │ │ │ └── demo │ │ │ │ └── ExtraDemo.java │ │ └── test │ │ │ ├── resources │ │ │ └── .keep │ │ │ └── java │ │ │ └── com │ │ │ └── example │ │ │ └── extra │ │ │ └── demo │ │ │ └── ExtraDemoTest.java │ │ └── build.gradle ├── core │ └── business │ │ ├── src │ │ ├── main │ │ │ ├── resources │ │ │ │ └── .keep │ │ │ └── java │ │ │ │ └── com │ │ │ │ └── example │ │ │ │ └── core │ │ │ │ └── business │ │ │ │ └── Business.java │ │ └── test │ │ │ ├── resources │ │ │ └── .keep │ │ │ └── java │ │ │ └── com │ │ │ └── example │ │ │ └── core │ │ │ └── business │ │ │ └── BusinessTest.java │ │ └── build.gradle ├── shared │ └── utils │ │ ├── src │ │ ├── main │ │ │ ├── resources │ │ │ │ └── .keep │ │ │ └── java │ │ │ │ └── com │ │ │ │ └── example │ │ │ │ └── shared │ │ │ │ └── utils │ │ │ │ └── HelloUtils.java │ │ └── test │ │ │ ├── resources │ │ │ └── .keep │ │ │ └── java │ │ │ └── com │ │ │ └── example │ │ │ └── shared │ │ │ └── utils │ │ │ └── HelloUtilsTest.java │ │ └── build.gradle └── application │ ├── src │ ├── main │ │ ├── resources │ │ │ └── config │ │ │ │ ├── application.yml │ │ │ │ ├── application-run-dev.yml │ │ │ │ └── application-run-prod.yml │ │ └── java │ │ │ └── com │ │ │ └── example │ │ │ └── DemoApplication.java │ └── test │ │ └── java │ │ └── com │ │ └── example │ │ └── DemoApplicationTests.java │ └── build.gradle ├── gradle.properties ├── static └── snapshort.png ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── settings.gradle ├── .run └── application-bootJar.run.xml ├── LICENSE ├── gradlew.bat ├── .gitignore ├── readme.md └── gradlew /modules/extra/demo/src/main/resources/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /modules/extra/demo/src/test/resources/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /modules/core/business/src/main/resources/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /modules/core/business/src/test/resources/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /modules/shared/utils/src/main/resources/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /modules/shared/utils/src/test/resources/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | group=com.example 2 | version=2.0.0 3 | -------------------------------------------------------------------------------- /modules/shared/utils/build.gradle: -------------------------------------------------------------------------------- 1 | 2 | dependencies { 3 | } 4 | -------------------------------------------------------------------------------- /modules/application/src/main/resources/config/application.yml: -------------------------------------------------------------------------------- 1 | # 通用配置内容 2 | -------------------------------------------------------------------------------- /modules/application/src/main/resources/config/application-run-dev.yml: -------------------------------------------------------------------------------- 1 | # 开发环境 profile：run-dev 2 | -------------------------------------------------------------------------------- /modules/application/src/main/resources/config/application-run-prod.yml: -------------------------------------------------------------------------------- 1 | # 生产环境 profile：run-prod 2 | -------------------------------------------------------------------------------- /static/snapshort.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/someok/gradle-multi-project-example/HEAD/static/snapshort.png -------------------------------------------------------------------------------- /modules/extra/demo/build.gradle: -------------------------------------------------------------------------------- 1 | 2 | dependencies { 3 | implementation project(':modules:shared:utils') 4 | } 5 | -------------------------------------------------------------------------------- /modules/core/business/build.gradle: -------------------------------------------------------------------------------- 1 | 2 | dependencies { 3 | implementation project(':modules:shared:utils') 4 | } 5 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/someok/gradle-multi-project-example/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /modules/extra/demo/src/main/java/com/example/extra/demo/ExtraDemo.java: -------------------------------------------------------------------------------- 1 | package com.example.extra.demo; 2 | 3 | /** 4 | * @author wjx 5 | * @version 1.0.0 6 | */ 7 | public class ExtraDemo { 8 | public static void demo() { 9 | System.out.println("this is demo"); 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /modules/shared/utils/src/test/java/com/example/shared/utils/HelloUtilsTest.java: -------------------------------------------------------------------------------- 1 | package com.example.shared.utils; 2 | 3 | import org.junit.jupiter.api.Test; 4 | 5 | /** 6 | * @author wjx 7 | * @version 1.0.0 8 | */ 9 | class HelloUtilsTest { 10 | 11 | @Test 12 | void test1() { 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /modules/application/src/test/java/com/example/DemoApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.example; 2 | 3 | import org.junit.jupiter.api.Test; 4 | import org.springframework.boot.test.context.SpringBootTest; 5 | 6 | @SpringBootTest 7 | class DemoApplicationTests { 8 | 9 | @Test 10 | void contextLoads() { 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /modules/core/business/src/main/java/com/example/core/business/Business.java: -------------------------------------------------------------------------------- 1 | package com.example.core.business; 2 | 3 | /** 4 | * @author wjx 5 | * @version 1.0.0 6 | */ 7 | public class Business { 8 | private Business() { 9 | } 10 | 11 | public static void hello() { 12 | System.out.println("this is business"); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /modules/shared/utils/src/main/java/com/example/shared/utils/HelloUtils.java: -------------------------------------------------------------------------------- 1 | package com.example.shared.utils; 2 | 3 | /** 4 | * @author wjx 5 | * @version 1.0.0 6 | */ 7 | public class HelloUtils { 8 | private HelloUtils() { 9 | } 10 | 11 | public static void test() { 12 | System.out.println("this is utils"); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /modules/extra/demo/src/test/java/com/example/extra/demo/ExtraDemoTest.java: -------------------------------------------------------------------------------- 1 | package com.example.extra.demo; 2 | 3 | import org.junit.jupiter.api.Test; 4 | 5 | import static org.junit.jupiter.api.Assertions.*; 6 | 7 | /** 8 | * @author wjx 9 | * @version 1.0.0 10 | */ 11 | class ExtraDemoTest { 12 | 13 | @Test 14 | void demo() { 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /modules/core/business/src/test/java/com/example/core/business/BusinessTest.java: -------------------------------------------------------------------------------- 1 | package com.example.core.business; 2 | 3 | import org.junit.jupiter.api.Test; 4 | 5 | import static org.junit.jupiter.api.Assertions.*; 6 | 7 | /** 8 | * @author wjx 9 | * @version 1.0.0 10 | */ 11 | class BusinessTest { 12 | 13 | @Test 14 | void hello() { 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /modules/application/src/main/java/com/example/DemoApplication.java: -------------------------------------------------------------------------------- 1 | package com.example; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class DemoApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(DemoApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'gradle-multi-project-example' 2 | 3 | include 'modules:application' 4 | 5 | file("${rootDir}/modules/shared").eachDirMatch(~/.*/) { 6 | include "modules:shared:${it.name}" 7 | } 8 | 9 | file("${rootDir}/modules/core").eachDirMatch(~/.*/) { 10 | include "modules:core:${it.name}" 11 | } 12 | 13 | file("${rootDir}/modules/extra").eachDirMatch(~/.*/) { 14 | include "modules:extra:${it.name}" 15 | } 16 | -------------------------------------------------------------------------------- /modules/application/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.gorylenko.gradle-git-properties' 2 | 3 | springBoot { 4 | // 生成 build info: /BOOT-INF/classes/META-INF/build-info.properties 5 | buildInfo() 6 | } 7 | 8 | tasks.register("increaseVersionBuildNumber") { 9 | doLast { 10 | // 在打 war 包的时候增加个当前时间戳的编译版本号 11 | println '=================================================' 12 | def buildNumber = new Date().format("yyyyMMddHHmm") 13 | // buildNumberIncrease([project: project, numFilename: 'build_number.data']) 14 | version += '.' + buildNumber 15 | println ">> new version: ${version}" 16 | println ">> jar: ${archivesBaseName}-${version}.jar" 17 | println '=================================================' 18 | } 19 | } 20 | 21 | bootJar { 22 | dependsOn increaseVersionBuildNumber 23 | } 24 | 25 | dependencies { 26 | implementation project(':modules:shared:utils') 27 | implementation project(':modules:core:business') 28 | implementation project(':modules:extra:demo') 29 | } 30 | -------------------------------------------------------------------------------- /.run/application-bootJar.run.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 16 | 18 | true 19 | true 20 | false 21 | false 22 | 23 | 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 JX Wang 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 48 | echo. 49 | echo Please set the JAVA_HOME variable in your environment to match the 50 | echo location of your Java installation. 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 62 | echo. 63 | echo Please set the JAVA_HOME variable in your environment to match the 64 | echo location of your Java installation. 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.gitignore.io/api/macos,windows,intellij+iml,gradle,node,eclipse 3 | 4 | ### app ### 5 | 6 | 7 | ### Eclipse ### 8 | 9 | .metadata 10 | bin/ 11 | tmp/ 12 | *.tmp 13 | *.bak 14 | *.swp 15 | *~.nib 16 | local.properties 17 | .settings/ 18 | .loadpath 19 | .recommenders 20 | 21 | # Eclipse Core 22 | .project 23 | 24 | # External tool builders 25 | .externalToolBuilders/ 26 | 27 | # Locally stored "Eclipse launch configurations" 28 | *.launch 29 | 30 | # PyDev specific (Python IDE for Eclipse) 31 | *.pydevproject 32 | 33 | # CDT-specific (C/C++ Development Tooling) 34 | .cproject 35 | 36 | # JDT-specific (Eclipse Java Development Tools) 37 | .classpath 38 | 39 | # Java annotation processor (APT) 40 | .factorypath 41 | 42 | # PDT-specific (PHP Development Tools) 43 | .buildpath 44 | 45 | # sbteclipse plugin 46 | .target 47 | 48 | # Tern plugin 49 | .tern-project 50 | 51 | # TeXlipse plugin 52 | .texlipse 53 | 54 | # STS (Spring Tool Suite) 55 | .springBeans 56 | 57 | # Code Recommenders 58 | .recommenders/ 59 | 60 | ### Intellij+iml ### 61 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm 62 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 63 | 64 | .idea/ 65 | 66 | ## File-based project format: 67 | *.iws 68 | 69 | ## Plugin-specific files: 70 | 71 | # IntelliJ 72 | out/ 73 | 74 | # mpeltonen/sbt-idea plugin 75 | .idea_modules/ 76 | 77 | # JIRA plugin 78 | atlassian-ide-plugin.xml 79 | 80 | # Crashlytics plugin (for Android Studio and IntelliJ) 81 | com_crashlytics_export_strings.xml 82 | crashlytics.properties 83 | crashlytics-build.properties 84 | fabric.properties 85 | 86 | ### Intellij+iml Patch ### 87 | # Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023 88 | 89 | *.iml 90 | modules.xml 91 | .idea/misc.xml 92 | *.ipr 93 | 94 | ### macOS ### 95 | *.DS_Store 96 | .AppleDouble 97 | .LSOverride 98 | 99 | # Icon must end with two \r 100 | Icon 101 | 102 | 103 | # Thumbnails 104 | ._* 105 | 106 | # Files that might appear in the root of a volume 107 | .DocumentRevisions-V100 108 | .fseventsd 109 | .Spotlight-V100 110 | .TemporaryItems 111 | .Trashes 112 | .VolumeIcon.icns 113 | .com.apple.timemachine.donotpresent 114 | 115 | # Directories potentially created on remote AFP share 116 | .AppleDB 117 | .AppleDesktop 118 | Network Trash Folder 119 | Temporary Items 120 | .apdisk 121 | 122 | ### Node ### 123 | # Logs 124 | logs 125 | *.log 126 | npm-debug.log* 127 | yarn-debug.log* 128 | yarn-error.log* 129 | 130 | # Runtime data 131 | pids 132 | *.pid 133 | *.seed 134 | *.pid.lock 135 | 136 | # Directory for instrumented libs generated by jscoverage/JSCover 137 | lib-cov 138 | 139 | # Coverage directory used by tools like istanbul 140 | coverage 141 | 142 | # nyc test coverage 143 | .nyc_output 144 | 145 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 146 | .grunt 147 | 148 | # Bower dependency directory (https://bower.io/) 149 | bower_components 150 | 151 | # node-waf configuration 152 | .lock-wscript 153 | 154 | # Dependency directories 155 | node_modules/ 156 | jspm_packages/ 157 | 158 | # Typescript v1 declaration files 159 | typings/ 160 | 161 | # Optional npm cache directory 162 | .npm 163 | 164 | # Optional eslint cache 165 | .eslintcache 166 | 167 | # Optional REPL history 168 | .node_repl_history 169 | 170 | # Output of 'npm pack' 171 | *.tgz 172 | 173 | # Yarn Integrity file 174 | .yarn-integrity 175 | 176 | # dotenv environment variables file 177 | .env 178 | 179 | 180 | ### Windows ### 181 | # Windows thumbnail cache files 182 | Thumbs.db 183 | ehthumbs.db 184 | ehthumbs_vista.db 185 | 186 | # Folder config file 187 | Desktop.ini 188 | 189 | # Recycle Bin used on file shares 190 | $RECYCLE.BIN/ 191 | 192 | # Windows Installer files 193 | *.cab 194 | *.msi 195 | *.msm 196 | *.msp 197 | 198 | # Windows shortcuts 199 | *.lnk 200 | 201 | ### Gradle ### 202 | .gradle 203 | build/ 204 | 205 | # Ignore Gradle GUI config 206 | gradle-app.setting 207 | 208 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 209 | !gradle-wrapper.jar 210 | 211 | # Cache of project 212 | .gradletasknamecache 213 | 214 | # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 215 | # gradle/wrapper/gradle-wrapper.properties 216 | 217 | # End of https://www.gitignore.io/api/macos,windows,intellij+iml,gradle,node,eclipse 218 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # Gradle 多项目管理示例 2 | 3 | ## v2.0 说明 4 | 5 | - 项目结构调整，将子项目迁移到 `modules` 下，取消了 projects 目录 6 | - 增加了 `build-ext.gradle` 和 `build-lib.gradle` 两个文件，用于存放一些通用的配置 7 | - 增加了 `gradle.properties` 文件，用于存放一些通用的配置 8 | - 增加了 `settings.gradle` 文件，用于存放项目的配置 9 | - `modules:application` 作为项目的启动目录，`modules:core` 作为业务模块，`modules:shared` 作为工具模块，`modules:extra` 作为可选模块 10 | 11 | ### 目录结构 12 | ```Bash 13 | ./ 14 | ├── LICENSE 15 | ├── build-ext.gradle: ext 中定义的一些常用方法 16 | ├── build-lib.gradle: 依赖组件配置 17 | ├── build.gradle: 顶级配置 18 | ├── gradle.properties: group、version 等配置 19 | ├── modules: 项目模块 20 | │   ├── application: spring boot application 21 | │   ├── core: 业务模块 22 | │   ├── extra: 可选模块 23 | │   └── shared: 工具模块 24 | └── settings.gradle: 可以在此处修改项目名 25 | ``` 26 | 27 | ---- 28 | 29 | ## v1.0 说明 30 | 31 | 这个项目用于学习研究 Gradle 的一个测试用例，扔掉也可惜，所以修改了一下放在这儿，如果能对别人有所帮助的话也算是好事一件。 32 | 33 | ### 为什么用 Gradle 34 | 35 | 主要还是审美需求。 36 | 37 | 之前一直用 Ant 来写很多 task 做项目管理，配合 ivy 做依赖管理，不过当项目增多之后这玩意开始力不从心了，多项目采用 Ant 来搞的话有点自虐。 38 | 39 | 本来打算用 Maven 的，功能确实很强，不过它的依赖管理的写法一直让我有点犯恶心，ivy里面一行语句，丫得三行，看着蛮屏幕的 xml 标签绝对不是什么很愉快的经历。对这东西我这几年基本上是几用几抛。 40 | 41 | 于是只有 Gradle 这个选择了。 42 | 43 | ### 主要需求 44 | 45 | 上面说了，采用这东西其实最主要的还是做**多项目管理**和**jar包依赖管理**，显然这工具在这两方面做的还不赖。 46 | 47 | 至于其它的一些修改、删除之类的小活就按需添加吧。 48 | 49 | ### 目录结构说明 50 | 51 | #### 顶级目录 52 | 53 | 放置了一堆 Gradle 的配置文件以及 wrapper 等，为了审美的需要，没把各个子项目放置到这个目录下，专门开辟了个 projects 目录用来存放所有项目。 54 | 55 | > 新版本中取消了 projects 目录，将子项目都提升到了根下，当然，原来的配置方式也可以。 56 | 57 | #### projects 目录 58 | 59 | 实际项目存放的地点。 60 | 61 | > 可选项，也可以直接将所有子项目放在根目录下，这也是推荐用法。 62 | 63 | 每个项目都包含了两个子目录：doc、source，前者用来放置文档，后者为源码。 64 | 65 | 这些项目也可能是来自不同的仓库，例如 git、subversion 等，不同的项目组可能会下载不同的项目于依赖模块，这时候只需要配置一下顶级目录中的 settings.gradle，管理好 include 即可。 66 | 67 | ### Idea IDE 支持 68 | 69 | 增加了 Idea 支持，子项目为 Idea 中的 module。并且可以在 module 中忽略某些子项目，例如根项目、projects 等。 70 | 71 | ![Idea 抓图](static/snapshort.png) 72 | 73 | ### 内置插件 74 | 75 | #### Gradle 自带插件 76 | 77 | - 所有子项目 78 | - **eclipse**： 用于生成 eclipse 配置 79 | - **Idea**: 支持 Idea 直接打开项目 80 | - **java** 81 | - Web 子项目（新增 Task） 82 | 83 | > 打 war 包的时候版本号做了一些处理，增加了编译数字，例如：project-web.1.1.0.1234.war. 84 | 85 | - **snapshot**： 用于打 war 包，注意：这儿做了一些处理，war默认打的包带有 SNAPSHOT 后缀 86 | - **release**: 如果想打发布版的 war 包，可采用 gradle release，打开 project-web 的 build.gradle 看看就知道怎么回事了 87 | 88 | ---------- 89 | 90 | ### 一些小技巧 91 | 92 | #### jar 包定义外移 93 | 94 | 这个是在查找某个问题的时候在一个国外网站（具体哪个忘记了，查的太多也找不到了）发现的。就是将所有的 jar 的定义放置到了 dependencyDefinitions.gradle 中，然后在顶级目录的 build.gradle 中引入： 95 | 96 | > apply from: 'dependencyDefinitions.gradle' 97 | 98 | 该文件内容为： 99 | 
100 |  ext.versions = [
101 |      spring: '3.2.5.RELEASE',
102 |      security: '3.1.4.RELEASE',
103 |      jackson: '1.9.13',
104 |      logback: '1.0.13',
105 |      slf4j: '1.7.5',
106 |      httpclient: '4.3.1',
107 |  ]
108 | 
109 | 
110 | ext.libraries = [
111 | 	"servlet-api": "javax.servlet:servlet-api:2.5",
112 | 	"jsp-api": "javax.servlet:jsp-api:2.0",
113 | 
114 | 	"ebean": "org.avaje.ebeanorm:avaje-ebeanorm:3.2.4",
115 | 	"persistence-api": "javax.persistence:persistence-api:1.0",
116 | 
117 | 	"aspectjweaver": "org.aspectj:aspectjweaver:1.7.4",
118 | 	...
119 | ]
120 |
121 | 122 | 在各个子项目的 build.gradle 中就只需要写 libraries.'ebean' 即可，而不需要把这些jar 散落的到处都是。 123 | 124 | 将来升级的时候也方便。 125 | 126 | #### 善用 gradle dependencies 127 | 128 | 这个命令可以很方便地检查 jar 的依赖情况，显示的是简单的树形结构，因为在命令行下会显示太多行，所以可以将其输出到一个文本中再看： 129 | > gradle dependencies > depend.log 130 | 131 | 通过这个命令我极大简化了我的 ext.libraries 定义，那些自动会依赖的 jar 包就不需要再写了。 132 | 133 | #### java 编译时候报编码错误 134 | 135 | 这是个经典的问题，当然，用了IDE 之后已经见不到此问题，所以在 gradle 编译的时候再次发现此问题的时候都有点故人复见的感觉了。 136 | 137 | 想当年初学 java 的时候采用命令行编译的诸位应该都会有这个感觉吧。 138 | 139 | 解决办法很简单，增加一行设置即可： 140 | > [compileJava, compileTestJava]\*.options*.encoding = 'UTF-8' 141 | 142 | #### 不要定义 group，除非你知道自己在做什么 143 | 144 | 好吧，其实我到现在还不大清楚 group 的意思是啥，之前我以为跟 "group 'org.avaje.ebeanorm' module: 'avaje-ebeanorm'" 的 group 一样，于是就在 build.gradle 中定义 group someok.common 145 | 146 | 结果在项目编译的时候遇到大量错误，经过艰苦的 debug （可以试试 --debug 就知道为什么说艰苦了）和 dependencies 检测才发现问题可能出在了 group 定义上了，删掉后一切方才圆满。 147 | 148 | #### 忽略掉 .gradle 目录 149 | 150 | 在顶级目录下有个 .gradle 文件夹，这个是 gradle 自动生成的，可以在 git 的 .gitignore 文件中增加一条忽略掉： 151 | > .gradle/ 152 | 153 | #### Maven 库中没有的 jar 该怎么管理？ 154 | 155 | 这种情况不多见，但绝对存在。 156 | 157 | 我的办法是在顶级目录增加一个 libs 文件夹，这个文件夹里面的 jar 是对所有项目都起作用的。 158 | 159 | 如果是某个项目自用的，则可以在该项目的 source 下面创建个 libs，具体实现是在顶级目录下的 build.gradle 中： 160 | 
161 | ext.jarTree = fileTree(dir: 'libs', include: '**/*.jar')
162 | ext.rootProjectLibs = new File(rootProject.rootDir, 'libs').getAbsolutePath()
163 | ext.jarTree += fileTree(dir: rootProjectLibs, include: '**/*.jar')
164 | 
165 | compile jarTree
166 |
167 | 168 | #### 开发环境、生产环境设置 169 | 170 | Gradle 有几种办法可以用来管理这些设置，例如将配置文件按环境写在 build 文件的不同块中。 171 | 172 | 不过我的办法是分目录： 173 | 174 | - resources： 通用配置放在这儿 175 | - resources-dev： 开发环境配置 176 | - resources-prod： 生产环境配置 177 | 178 | 在用 gradle eclipse 命令生成 IDE 配置的时候，会默认将前两个目录包含在 eclipse 中，只有通过 gradle release 生成 war 包的时候才会忽略 dev，使用 prod。 179 | 180 | #### 打包命令 181 | 182 | 上面已经说过，打 war 包时候有两种方式： 183 | 184 | - gradle war： 这个是用来打测试的 war 包，文件后缀增加 **SNAPSHOT**，采用的是 resources-dev。 185 | - gradle release： 这个才是用来打生产用的 war 包，采用的是 resources-prod。 186 | 187 | 这是我个人喜好的用法，当然也可以按照自己的喜好来处理了。 188 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | --------------------------------------------------------------------------------