【初めてのJava】Intellijでとりあえず動くものを作る

概要

Java初心者が、Intellijでプログラムを作って、パッケージ化して、とりあえず動くものを作るまでの手順です。

今回はキータのトップページのtitleの内容を取得するだけのプログラムを作ります。
Javaの勉強というより、Javaの開発の流れを知るためのtutorial的なものです。

環境

• macOS Sierra 10.12.6
• jdk-9.0.1_osx-x64_bin.dmg
• Apache Maven 3.5.2
  • maven-assembly-plugin 3.1.0
  • Jsoup 1.10.2
• IntelliJ IDEA Community Version: 2017.3.2

jdkとIntellijは上記リンクからダウンロードして、インストールしておいてください。

プロジェクトの作成

Intellijを起動したら、 Create New Project をクリック

Maven を選択して Next をクリック

以下の値を入力して Next をクリック

項目	値
GroupId	jp.sample
ArtifactId	sample-artifact
Version	デフォルト

Project nameと、Projectのファイルを設置する場所を入力して Finish をクリック

以下のような画面が表示されたら成功です。

pom.xmlを作成

プロジェクト管理のためのファイル。
RailsでいうGemfileみたいなものかな？

以下の内容で作成します。

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>jp.sample</groupId>
    <artifactId>sample-artifact</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>1.6</maven.compiler.source>
        <maven.compiler.target>1.6</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.jsoup</groupId>
            <artifactId>jsoup</artifactId>
            <version>1.10.2</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>RELEASE</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <finalName>sample-${project.version}</finalName>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <mainClass>jp.sample.Main</mainClass>
                        </manifest>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

pom.xmlに追記したら、
右下に、 Maven projects need to be imported と表示された場合は、 Enable Auto-Import をクリック

各設定の説明

dependencies

依存ライブラリの設定。
今回は以下のライブラリを利用します。

ライブラリ名	用途
Jsoup	スクレイピング用
junit	テスト用

properties

build時の以下のエラー回避のために記述する。

[ERROR] Source option 1.5 is no longer supported. Use 1.6 or later.
[ERROR] Target option 1.5 is no longer supported. Use 1.6 or later.

maven-assembly-plugin

依存関係を全て含めたパッケージを作成するためのプラグイン。
archive -> manifestに、Main-Classを指定する。
これにより、Manifest.MFは不要となる。

<archive>
    <manifest>
        <mainClass>jp.sample.Main</mainClass>
    </manifest>
</archive>

プログラムの作成

スクレイピングをするプログラムを作成します。

まず、Java Classを作成します。

Main という名前のクラスを作成します。

作成されたらMain.javaに以下を記述します。

Main.java

package jp.sample;

import java.io.IOException;

public class Main {
    public static void main(String[] args) throws IOException {
        final ScrapeService scrapeService = new ScrapeService();
        System.out.println(scrapeService.getTitle());
    }
}

同じ要領で、ScrapeService.javaを作成します。
キータのtitleを取得するプログラムです。

ScrapeService.java

package jp.sample;

import org.jsoup.Jsoup;
import org.jsoup.nodes.Document;
import org.jsoup.select.Elements;
import java.io.IOException;

public class ScrapeService {
    private String url = "https://qiita.com/";

    public String getTitle() throws IOException {
        Document document = Jsoup.connect(url).get();
        Elements title = document.select("title");
        return title.text();
    }
}

Main.javaを開き、 public class Main { の左の再生ボタンをクリックして、 Run 'Main.main()' をクリックして、プログラムを実行させてみましょう。

すると、下のデバッガに、以下のような結果が表示されます。
キータのtitleが表示されれば成功です。

テストコードの作成

次に、テストコードを作成します。

ScrapeService.javaを開いて、クラス名の ScrapeService にカーソルが当たっている状態で、 Alt + Enter を押します。

すると、以下の画像のように、 Create Test という選択肢が表示されるのでクリックします。

今回は、JUnit4を使います。 FIX というボタンが表示されている場合はクリックしてください。
Generate test methods for: の下にテスト可能なmethod一覧があるので、チェックしたら、OKをクリックします。

すると、以下のように、テストコードファイルが作成されます。

そうしたら、以下のように編集してください。

LoginServiceTest.java

package jp.sample;

import org.junit.Test;
import java.io.IOException;
import static org.junit.Assert.assertEquals;

public class ScrapeServiceTest {

    @Test
    public void getTitle() throws IOException {
        final ScrapeService scrapeService = new ScrapeService();
        assertEquals("Qiita - A technical knowledge sharing platform for programmers.", scrapeService.getTitle());
    }
}

public class LoginServiceTest { の左の再生ボタンをクリックして、 Run 'Main.main()' をクリックして、テストを実行させます。

以下のように、デバッガに表示されれば、テスト成功です。

build

ビルドをして、パッケージ化します。
ここから先は、Intellijではなく、コマンドラインで操作します。

pom.xmlがあるsampleartifact/ディレクトリに移動して、以下のコマンドを実行します。

$ mvn package

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running jp.sample.ScrapeServiceTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.786 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ sample-artifact ---
[INFO] Building jar: /Users/username/IdeaProjects/sampleartifact/target/sample-artifact-1.0-SNAPSHOT.jar
[INFO]
[INFO] --- maven-assembly-plugin:3.1.0:single (make-assembly) @ sample-artifact ---
[INFO] Building jar: /Users/username/IdeaProjects/sampleartifact/target/sample-1.0-SNAPSHOT-jar-with-dependencies.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6.910 s
[INFO] Finished at: 2017-12-28T18:10:59+09:00
[INFO] Final Memory: 20M/67M
[INFO] ------------------------------------------------------------------------

生成されたjarファイルを実行

sampleartifact/targetに、 sample-1.0-SNAPSHOT-jar-with-dependencies.jar というjarファイルが生成されているので、実行してみます。

$ java -jar sample-1.0-SNAPSHOT-jar-with-dependencies.jar
Qiita - A technical knowledge sharing platform for programmers.

このようにキータのタイトルが表示されれば成功です！

mvn install

mvn install をすると、 target の下だけでなく、 ~/.m2/ の下のLocal repositoryにもファイルが生成されます。

$ mvn install

$ ls -1 -a ~/.m2/repository/jp/sample/sample-artifact/1.0-SNAPSHOT/
.
..
_remote.repositories
maven-metadata-local.xml
sample-artifact-1.0-SNAPSHOT-jar-with-dependencies.jar
sample-artifact-1.0-SNAPSHOT.jar
sample-artifact-1.0-SNAPSHOT.pom

targetディレクトリを削除する

以下のコマンドで削除できます。
targetを一度空にしてからbuildしなおすときに使います。

$ mvn clean

関連

• MacでIntelliJ IDEAのDocker Pluginを使う設定手順

参考

• http://yuu.1000quu.com/use_maven_in_eclipse
• https://qiita.com/takahiroSakamoto/items/c2b269c07e15a04f5861
• https://qiita.com/opengl-8080/items/d4864bbc335d1e99a2d7
• Let's Enjoy PhantomJS
• MavenでMANIFEST.MFを取り込む。
• Mavenビルド
• mavenコマンドの使い方（主にgoal）について調べたのでメモ
• Mavenの使い方
• Maven で依存 JAR ライブラリを target/dependency にコピー
• [Maven]mvnコマンドの備忘録