詳細了解ideaartifacts

一、創建artifact

Ideaartifacts是一個Idea項目的模塊，並且在任何時候都可以被轉換成jar或war文件，然後就可以部署到其他機器上了。創建artifact可以有多種方式，比如右擊項目選擇”Open Module Settings”，然後選擇”Artifacts”選項卡，在這裡可以新增、編輯和刪除artifact。在編輯artifact時候可以選擇output路徑以及包含哪些目錄、文件或者library。另外可以添加directory、jar或者webarchive。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.0.2</version>
            <configuration>
                <archive>
                    <index>true</index>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <mainClass>com.example.Main</mainClass>
                    </manifest>
                    <manifestEntries>
                        <key>Extra-Value</key>
                        <value>Extra-Value-Added</value>
                    </manifestEntries>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

二、編輯artifact

編輯artifact方式多種多樣，比如可以右擊項目選擇”Open Module Settings”，然後選擇”Artifacts”選項卡，找到對應的artifact進行編輯，還可以在項目結構中找到META-INF/Intellij IDEA Artifacts/xxx.xml進行編輯。在編輯artifact時候可以指定文件輸出路徑，還可以對指定的文件進行”Include”或者”Exclude”。一般來說，在”Output Layout”中可以看到自動生成的artifact路徑以及文件，也可以手動添加或者修改需要的文件、library等。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>3.1.0</version>
            <configuration>
                <appendAssemblyId>false</appendAssemblyId>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
        </plugin>
    </plugins>
</build>

三、定義artifact

定義artifact有以下幾種方式：

• 通過IDEA圖形界面
• 通過maven配置文件
• 通過gradle配置文件

1、通過IDEA圖形界面：
在菜單欄中選擇”File”->”Project Structure”，然後選擇”Facets”選項卡，選擇You Web項目，點擊”Add”，在”Add Library”中可以選擇需要的庫文件，選擇完畢後可以在”Artifacts”選項卡中看到我們選擇的jar文件，此時再次選擇”Add”，選擇”From Module Dependency”，這就完成了artifact的定義。

2、通過maven配置文件：
在pom.xml中增加artifacts相關配置，使用maven-assembly-plugin和maven-jar-plugin插件即可完成artifact定義和構建。下面是一個例子，會將主要代碼和依賴打包到一個jar文件中。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>2.5.5</version>
            <executions>
                <execution>
                    <id>assembly</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                    <configuration>
                        <finalName>artifactName</finalName>
                        <appendAssemblyId>false</appendAssemblyId>
                        <descriptorRefs>
                            <descriptorRef>jar-with-dependencies</descriptorRef>
                        </descriptorRefs>
                        <archive>
                            <manifest>
                                <mainClass>com.example.Main</mainClass>
                            </manifest>
                        </archive>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.5</version>
            <configuration>
                <archive>
                    <index>true</index>
                    <manifest>
                        <mainClass>com.example.Main</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

3、通過gradle配置文件：
在build.gradle中增加artifacts相關配置，使用gradle-assembly-plugin和gradle-jar-plugin插件即可完成artifact的定義和構建。

plugins {
    <code>java
    id 'com.github.johnrengelman.shadow' version '2.0.4'
    
    //以下配置為部署到tomcat需要的插件，如果沒有可以不加
    id 'war'
    id 'org.akhikhl.gretty' version '2.0.0'
}
shadowJar {
    baseName = 'myapi'
    classifier = null
    version = null

    manifest {
        attributes 'Main-Class': 'com.example.Main',
        'Class-Path': configurations.runtime.files.collect { '/usr/lib/' + it.getName() }.join(' ')
    }

    dependencies {
        //thin-jar可以過濾掉一些不需要的依賴，默認會把所有依賴都打包到一個jar中
        //現在只是單純的添加示例，因此下面這段代碼是不完整的，不能直接套用
        compile('com.github.saiprasadkrishnamurthy:thin-jar:1.1') {
            exclude group: 'org.slf4j', module: 'slf4j-log4j12'
        }
    }

    relocate ('com.google.common', 'org.shadow.evermind.com.google.common') {
        exclude 'META-INF/**'
    }
}

四、使用artifact

通過以上步驟已經完成artifact的構建或者定義，下面我們需要學習如何使用artifact。使用artifact有以下幾種方式：

• 在Idea項目的模塊中使用
• 在maven項目中使用
• 在gradle項目中使用

1、在Idea項目的模塊中使用：
選擇”File”->”Project Structure”，然後選擇”Libraries”選項卡，在這裡選擇”New Project Library”並且選擇”Java”，這樣我們就可以添加一個新的library添加artifact了。

2、在maven項目中使用：
在pom.xml中加入以下配置：

<dependencies>
    <dependency>
        <groupId>groupId</groupId>
        <artifactId>artifactId</artifactId>
        <version>version</version>
        <scope>provided</scope>
        <type>war</type>
    </dependency>
</dependencies>

3、在gradle項目中使用：
在build.gradle中加入以下配置：

repositories {
    flatDir { dirs '/path/to/lib/dir' }
}

// 方式2，在gradle中使用mavenCentral()
dependencies {
    implementation 'groupId:artifactId:version'
}

五、其他相關操作

1、創建src/main下的目錄
在menu中選擇”File”->”New”->”Directory”，然後在彈出框的右側選項卡中選擇”Mark Directory as”->”Sources Root”，這樣我們就可以在新建的目錄下放入java源文件了。

2、在main函數中引用resource資源文件
在main函數中加載resource資源文件時候，需要使用以下方法：

public static void main(String[] args) {
    String s = Main.class.getClassLoader().getResource("file.txt").getFile();
    System.out.println(s);
}

3、忽略不必要的warning
在文件名上增加以下注解即可：

@SuppressWarnings("all")
public class MyClass {
    //...
}

4、項目切換成maven的方式
在menu中選擇”File”->”New”->”Project”，然後選擇”Java”->”Maven”，在彈出框中配置相關參數即可。