在gradle中配置IDEA Plugin

默认情况下，一个gradle工程不能直接用IntelliJ IDEA打开，因为IntelliJ IDEA的工程需要一些特殊的配置文件。可以为gradle工程配置IDEA plugin，这个plugin将为gradle工程生成IntelliJ所需的配置文件【1】。

plugins {
    id 'idea'
}

group 'test-log4j2'
version '1.0-SNAPSHOT'

apply plugin: 'java'

sourceCompatibility = 1.5

repositories {
    mavenCentral()
}

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.11'
    compile group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.12.1'
    compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.12.1'
}

配置完idea plugin后，可以看到task列表中多了许多新的命令：

gradle idea
...
IDE tasks
---------
cleanIdea - Cleans IDEA project files (IML, IPR)
idea - Generates IDEA project files (IML, IPR, IWS)

这里主要介绍idea。查看文档发现它依赖于 ideaProject, ideaModule, ideaWorkspace，作用是为当前gradle工程生成所有的IDEA配置文件。

idea
Depends on: ideaProject, ideaModule, ideaWorkspace

Generates all IDEA configuration files

接下来，让我们尝试着运行idea，看看会发生什么事情：

gradle idea
Starting a Gradle Daemon, 1 busy Daemon could not be reused, use --status for details
:ideaModule
Download ${maven_repo}/org/apache/logging/log4j/log4j-api/2.12.1/log4j-api-2.12.1.pom
Download ${maven_repo}/org/apache/logging/log4j/log4j/2.12.1/log4j-2.12.1.pom
Download ${maven_repo}/org/apache/apache/21/apache-21.pom
Download ${maven_repo}/org/apache/logging/log4j/log4j-core/2.12.1/log4j-core-2.12.1.pom
Download ${maven_repo}/org/apache/logging/log4j/log4j-api/2.12.1/log4j-api-2.12.1.jar
Download ${maven_repo}/org/apache/logging/log4j/log4j-core/2.12.1/log4j-core-2.12.1.jar
Download ${maven_repo}/org/apache/logging/log4j/log4j-api/2.12.1/log4j-api-2.12.1-sources.jar
Download ${maven_repo}/org/apache/logging/log4j/log4j-core/2.12.1/log4j-core-2.12.1-sources.jar
:ideaProject
:ideaWorkspace
:idea

BUILD SUCCESSFUL

Total time: 35.673 secs

生成配置文件后，就可以直接在IntelliJ IDEA中打开工程

File - Open Project

并且，所有的外部依赖（相关的源文件和Javadoc文件）和工程依赖的包也被一并下载到本地并作为外部依赖集成进来。

gradle_idea_ext_dep.png

在运行gralde idea的时候，可能会遇到external libraries不能加入工程的情况，这时，可以尝试着删除本地gradle cache里的对应jar包，然后重新运行gradle idea。

rm -rf ~/.gradle/caches/modules-2/files-2.1/org.slf4j/

当然，如果你只想将外部依赖的jar包下载到本地，也可以用gradle自带的copy来实现类似的功能【2】：

task copyJars(type: Copy) {
  from configurations.runtime
  into 'lib' // 目标位置
}

【1】The IDEA Plugin
【2】org.gradle.api.tasks.Copy
【3】反对声音

在gradle中配置IDEA Plugin

推荐阅读更多精彩内容