详细了解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"，在弹出框中配置相关参数即可。