2018/08/17

Java 11 + JAXBのちょっとしたピットフォール

このエントリーをはてなブックマークに追加

前回はJigsawでSerciveLoaderクラスを使用した時の挙動について紹介しました。

今回はその続きのようなもの。

Java SE 11からJAXBが外されてしまうのは、このブログでも何度も書いてます。

なので、JAXBを使うのであれば、GitHubのJAXBのページからダウンロードするか、MavenのCentral Repositoryを使うことになります。

JAXBは5つのJARファイルから構成されています。

APIはjaxb-api.jar、ランタイムがjaxb-impl.jarとjaxb-core.jarです。他の2つはXMLスキーマとJavaのクラスの変換を行うツールxjcとjxcのJARファイルです。

xjcなどを使わないのであれば、jaxb-api.jar、jaxb-impl.jar、jaxb-core.jarの3つだけを使用します。

また、JAXBはJavaBeans Activation Framework (JAF)も使用するので、こちらもダウンロードしておきます。ただ、GitHubのJAFのプロジェクトではJARファイルの配布はしていないので、Maven Central RepositryにあるJAFを利用します。

 

ここでは、簡単なサンプルとして、次に示すJAXBDemoクラスを作りました。

package net.javainthebox;

import java.io.File;
import javax.xml.bind.JAXB;
import javax.xml.bind.JAXBException;

import net.javainthebox.xml.Name;

public class JAXBDemo {
    public static void main(String... args) throws JAXBException {
        File file = new File("name.xml");
        Name sakuraba = JAXB.unmarshal(file, Name.class);

        System.out.println(sakuraba.getFirst() + " " + sakuraba.getLast());
    }
}

name.xmlファイルを読み込んでNameオブジェクトに変換するプログラムです。

Nameクラスはfirstとlastという2つの文字列のフィールドを持っているクラスです。

module-info.javaを次に示します。

module net.javainthebox.xml {
    requires java.xml.bind;
    opens net.javainthebox.xml;
}

requires文で指定しているjava.xml.bindモジュールがjaxb-api.jarファイルです。

opensでnet.javainthebox.xmlパッケージを指定しているのは、JAXBがリフレクションでNameクラスにアクセスするためです。

次にjava.xml.bindモジュールの依存性を調べてみましょう。これにはjarコマンドの--describe-module (もしくは省略形の-d) オプションで調べることができます。

C:\jaxb\mod>jar -d -f jaxb-api-2.3.0.jar
java.xml.bind jar:file:///C:/jaxb/mod/jaxb-api-2.3.0.jar/!module-info.class
exports javax.xml.bind
exports javax.xml.bind.annotation
exports javax.xml.bind.annotation.adapters
exports javax.xml.bind.attachment
exports javax.xml.bind.helpers
exports javax.xml.bind.util
requires java.activation transitive
requires java.base mandated
requires java.desktop
requires java.logging
requires java.xml transitive
uses javax.xml.bind.JAXBContextFactory

一番上の行がモジュール名とモジュラーJARファイルの場所を示しています。

はじめのrequires文で指定しているjava.activationがJAFのモジュールです。

ただし、JAFのjavax.activation-api-1.2.0.jarファイルはAUTOMATIC-MODULE-NAMEは記載されているものの、モジュールにはなっていません。このため、自動モジュールとして扱います。

他のrequires文はJava SEの標準なので、特に何もしなくても大丈夫です。

最後のuses文が前回も登場したServiceLoaderクラスを使用したSPIでロードするインタフェースです。そして、この実装クラスがあるのが、jaxb-impl.jarファイルです。(本当に使用するインタフェースと実装クラスは違うようなのですが、ここでは深入りしません)

jaxb-impl.jarファイルはモジュラーJARではないので、前回説明したようにクラスパスでもモジュールパスで指定してもどちらでも大丈夫です。

まずクラスパスで指定して実行してみましょう。

ここではmodディレクトリにnet.javainthebox.xmlモジュールのjaxbdemo.jarファイル、java.xml.bindモジュールのjaxb-api.jarファイル、JAFのjavax.activation-api-1.2.0.jarファイルを配置してあります。

クラスパスで指定するjaxb-impl.jarファイルとjaxb-core.jarファイルはlibファイルに置きます。

C:\jaxb>java -p mod -cp lib\jaxb-impl.jar;lib\jaxb-core.jar -m net.javainthebox.xml/net.javainthebox.JAXBDemo
WARNING: An illegal reflective access operation has occurred
WARNING: Illegal reflective access by com.sun.xml.bind.v2.runtime.reflect.opt.Injector (file:/C:/home/yuichi/Web/java/diary/material/201808/20180817jaxb/lib/jaxb-impl.jar) to method java.lang.ClassLoader.defineClass(java.lang.String,byte[],int,int)
WARNING: Please consider reporting this to the maintainers of com.sun.xml.bind.v2.runtime.reflect.opt.Injector
WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
WARNING: All illegal access operations will be denied in a future release
Yuichi Sakuraba

C:\jaxb>

実行することができました。

警告が出ているのはJAXBが内部でsun.misc.Unsafeクラスを使用しているためです。

次にモジュールパスで指定して、実行してみます。

jaxb-impl.jarファイルはmodディレクトリに移動してあります。

C:\jaxb>java -p mod -cp lib\jaxb-core.jar -m net.javainthebox.xml/net.javainthebox.JAXBDemo
Exception in thread "main" java.lang.NoClassDefFoundError: com/sun/xml/bind/v2/model/annotation/AnnotationReader
        at java.base/java.lang.ClassLoader.defineClass1(Native Method)
        at java.base/java.lang.ClassLoader.defineClass(ClassLoader.java:1016)
        at java.base/java.lang.ClassLoader.defineClass(ClassLoader.java:1095)
        at java.base/java.security.SecureClassLoader.defineClass(SecureClassLoader.java:206)
        at java.base/jdk.internal.loader.BuiltinClassLoader.defineClass(BuiltinClassLoader.java:760)
        at java.base/jdk.internal.loader.BuiltinClassLoader.findClassInModuleOrNull(BuiltinClassLoader.java:681)
        at java.base/jdk.internal.loader.BuiltinClassLoader.loadClassOrNull(BuiltinClassLoader.java:606)
        at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:580)
        at java.base/jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:178)
        at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:521)
        at java.base/java.lang.Class.getDeclaredMethods0(Native Method)
        at java.base/java.lang.Class.privateGetDeclaredMethods(Class.java:3167)
        at java.base/java.lang.Class.getMethodsRecursive(Class.java:3308)
        at java.base/java.lang.Class.getMethod0(Class.java:3294)
        at java.base/java.lang.Class.getMethod(Class.java:2107)
        at java.xml.bind/javax.xml.bind.ContextFinder.newInstance(ContextFinder.java:295)
        at java.xml.bind/javax.xml.bind.ContextFinder.newInstance(ContextFinder.java:286)
        at java.xml.bind/javax.xml.bind.ContextFinder.find(ContextFinder.java:409)
        at java.xml.bind/javax.xml.bind.JAXBContext.newInstance(JAXBContext.java:721)
        at java.xml.bind/javax.xml.bind.JAXBContext.newInstance(JAXBContext.java:662)
        at java.xml.bind/javax.xml.bind.JAXB$Cache.<init>(JAXB.java:127)
        at java.xml.bind/javax.xml.bind.JAXB.getContext(JAXB.java:154)
        at java.xml.bind/javax.xml.bind.JAXB.unmarshal(JAXB.java:168)
        at net.javainthebox.xml/net.javainthebox.JAXBDemo.main(JAXBDemo.java:12)
Caused by: java.lang.ClassNotFoundException: com.sun.xml.bind.v2.model.annotation.AnnotationReader
        at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:582)
        at java.base/jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:178)
        at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:521)
        ... 24 more

C:\jaxb>

AnnotationReaderクラスがないという例外が発生してしまいました!

なぜ、クラスパスだと正常に実行できて、モジュールパスだと実行できないのでしょう?

 

答えはjaxb-impl.jarファイルをモジュールとして扱うか、普通のJARファイル(無名モジュール)として扱うかというところにあります。

ここでロードできないcom.sun.xml.bind.v2.model.annotation.AnnotationReaderクラスはjaxb-core.jarファイルに含まれています。

一方、jaxb-impl.jarファイルにもcom.sun.xml.bind.v2.model.annotationパッケージが含まれているのです。

Project Jigsawでは同じパッケージを複数のモジュールで定義することはできません。1つのパッケージは1つのモジュールで定義します。

jaxb-impl.jarファイルをモジュールパスに配置してしまうと自動モジュールとして扱うので、このパッケージに関する制限に引っかかってしまうのです。このため、jaxb-core.jarファイルのクラスはロードされなかったのです。

しかし、クラスパスで指定すればモジュールではないので、パッケージが複数のJARファイルに分かれていても問題ないわけです。

JAXBがjaxb-impl.jarファイルとjaxb-core.jarファイルに分かれていなければ、なんの問題もないのですが...

既存のライブラリでも同じように同じパッケージを複数のJARファイルに含んでいる場合があるかもしれません。クラスをロードできるはずなのに、ClassNotFoundException例外が発生するような場合は、パッケージが複数のJARに分かれている可能性が高いですね。

こういう問題は、ライブラリがちゃんとメンテされていれば、時間が解決してくれるとは思います。

それにしても、こういうことがあるので、ライブラリはともかく、アプリケーションであれば今すぐモジュール化する必要はないのではないでしょうか。

2018/08/14

Project Jigsawのちょっとしたクイズ

このエントリーをはてなブックマークに追加

前回のエントリーでも触れましたけど、Jigsawのモジュールには通常のモジュールと自動モジュール (Automatic Module)、無名モジュール (Unnamed Module)の3種類あります。

自動モジュールと無名モジュールはモジュールとは名前がついてますけど、普通のJARファイルと変わりません。

自動モジュールはモジュールパスで指定し、無名モジュールは従来通りクラスパスで指定します。

通常のモジュールがアクセスできるのは、通常のモジュールか自動モジュールだけ。無名モジュールにはアクセスできません。無名モジュールにアクセスできるのは、自動モジュールです。

 

ところで、みなさんはjava.util.ServiceLoaderクラスをご存知でしょうか。

ServiceLoaderクラスを使うと、指定したインタフェースの実装クラスを実行時にロードすることができます。いわゆるSPIを実現するためのクラスです。

もちろん、JigsawでもServiceLoaderクラスをサポートしてますが、従来の方法とは実装クラスの指定方法が変わっています。

今までは、インタフェースの実装クラスを提供する場合、JARファイルのMETA-INF/servicesディレクトリにインタフェースと同名のファイルを作成し、ファイルには実装クラス名を記述します。

たとえば、インタフェースがnet.javainthebox.hello.Helloインタフェースで、SPIで提供する実装クラスがnet.javainthebox.hello.impl.HelloImplクラスだったとします。

この場合、META-INF/services/net.javainthebox.hello.Helloファイルを作成します。そして、net.javainthebox.hello.Helloファイルにはnet.javainthebox.hello.impl.HelloImplとだけ記述しておきます。

これでServiceLoaderは、クラスパスにあるJARファイルを調べて、Helloインタフェースの実装クラスをロードすることができました。

 

実装クラスをモジュールで提供する場合、インタフェースと同名のファイルを作成するのではなく、module-info.javaに記述します。

先ほどの例であれば、module-info.javaには次のように記述します。

module net.javainthebox.helloimpl {
    requires net.javainthebox.hello;
    
    provides net.javainthebox.hello.Hello with net.javainthebox.hello.impl.HelloImpl;
}

provides文でインタフェースと実装クラスを記述するわけです。

ただし、後方互換性のためにmodule-info.javaに記述するだけでなく、META-INF/servicesディレクトリにインタフェースと同名のファイルを置いておいた方がいいと思います。

モジュールがこの実装クラスを使いたい場合、はmodule-info.javaにuses文でインタフェースを指定します。

たとえば、次のように記述します。

module net.javainthebox.helloclient {
    requires net.javainthebox.hello;
 
    // SPIで使用するインタフェース
    uses net.javainthebox.hello.Hello;
}

ServiceLoaderクラスの使い方はまったく同じで、Helloインタフェースの実装クラスを探してロードすることができます。

 

ここでクイズです。

インタフェースは通常のモジュールで定義されています。インタフェースを使用するクライアントもモジュールです。

しかし、実装クラスがモジュールでない場合、ようするにMETA-INF/servicesディレクトリを使ったJARファイルの場合、どうすれば実装クラスを読み込むことができるでしょうか。

選択肢は4つ。

  1. 実装クラスがモジュールでないので、読み込めない
  2. モジュールパスで指定したディレクトリに実装クラスのJARファイルを配置して、自動モジュールとして読み込む
  3. クラスパスで指定して、無名モジュールとして読み込む
  4. モジュールパスでもクラスパスでも、どちらでもOK

 

正解は.....

 

選択肢4のモジュールパスでもクラスパスでもOKです。

通常のモジュールからのアクセスなので、モジュールパスに配置して自動モジュールとして扱わなくてはいけないように思えるかもしれません。でも、クラスパスでもOKなんです。

通常のモジュールが無名モジュールにアクセスできるという稀有な例なのでした。

 

いちおう、コードと実行例を示しておきます。

SPIで使用するHelloインタフェースはこんな感じ。

package net.javainthebox.hello;

public interface Hello {
    public void hello();
}

module-info.javaは次の通り。

module net.javainthebox.hello {
    exports net.javainthebox.hello;
}

実装クラスのHelloImplクラス。

package net.javainthebox.hello.impl;

import net.javainthebox.hello.Hello;

public class HelloImpl implements Hello {
    public void hello() {
        System.out.println("Hello, World!");
    }
}

HelloImplクラスを含んだJARファイルは、前述のようにMETA-INF/services/net.javainthebox.hello.Helloファイルを作成して、net.javainthebox.hello.impl.HelloImplと記述してあります。

さて、クライアントは。

package net.javainthebox.helloclient;

import java.util.ServiceLoader;
import net.javainthebox.hello.Hello;

public class HelloClient {
    public static void main(String... args) {
        ServiceLoader<Hello> loader = ServiceLoader.load(Hello.class);

        for (Hello hello: loader) {
            hello.hello();
        }
    }
}

クライアントのmodule-info.javaは上の方に書いてありますね。

ビルドはやってもらうということで、実行してみます。

modディレクトリをモジュールパス、libディレクトリをクラスパス用に使用するとしましょう。

まずは、自動モジュールとして実行してみます。

C:\serviceclient>dir mod
 ドライブ C のボリューム ラベルがありません。
 ボリューム シリアル番号は 4A4B-822F です

 C:\serviceclient\mod のディレクトリ

2018/08/14  21:58    <DIR>          .
2018/08/14  21:58    <DIR>          ..
2018/08/12  14:36             1,235 hello-api.jar
2018/08/12  20:01             1,603 hello-client.jar
2018/08/12  19:36             1,607 hello-impl.jar
               3 個のファイル               4,445 バイト
               2 個のディレクトリ  163,930,116,096 バイトの空き領域

C:\serviceclient>java -p mod -m net.javainthebox.helloclient/net.javainthebox.helloclient.HelloClient
Hello, World!

C:\serviceclient>

Hello, World!が表示されました。

次に、実装クラスのJARファイルをlibディレクトリに移動させて、クラスパスで指定してみましょう。

C:\serviceclient>mv mod\hello-impl.jar lib

C:\serviceclient>java -p mod -cp lib\hello-impl.jar -m net.javainthebox.helloclient/net.javainthebox.helloclient.HelloClient
Hello, World!

C:\serviceclient>

クラスパスで指定しても、ちゃんと実行できています。

というわけで、ちょっとしたJigsawのクイズでした。

2018/07/23

事例から学ぶ、Java SE 11移行 その2
-モジュールアプリケーションの場合-

このエントリーをはてなブックマークに追加

前回の続き。

もし、どうしてもモジュールアプリケーションにしたいという場合を考えてみます。

普通のアプリケーションであれば、そんなに急いでモジュール化する必要は私はないと思っています。ただし、ライブラリを開発している場合は、なるべく早くモジュールに対応してほしいです。

前回のサンプルはライブラリではないのですが、モジュール化する場合もあるでしょうし、とりあえずやってみましょう。

前回のサンプルはJersey + Grizzly の単純なアプリケーションでした。

このサンプルは 2 つのクラスから構成されています。リソースを表すMyResouceクラスと、アプリケーションの起動クラスとなるMainクラスです。いずれもcom.exampleパッケージにあります。

MyResourceクラスはこちら。

package com.example;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

/**
 * Root resource (exposed at "myresource" path)
 */
@Path("myresource")
public class MyResource {

    /**
     * Method handling HTTP GET requests. The returned object will be sent
     * to the client as "text/plain" media type.
     *
     * @return String that will be returned as a text/plain response.
     */
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String getIt() {
        return "Got it!";
    }
}

Mainクラスはこちらです。

package com.example;

import org.glassfish.grizzly.http.server.HttpServer;
import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
import org.glassfish.jersey.server.ResourceConfig;

import java.io.IOException;
import java.net.URI;

/**
 * Main class.
 *
 */
public class Main {
    // Base URI the Grizzly HTTP server will listen on
    public static final String BASE_URI = "http://localhost:8080/myapp/";

    /**
     * Starts Grizzly HTTP server exposing JAX-RS resources defined in this application.
     * @return Grizzly HTTP server.
     */
    public static HttpServer startServer() {
        // create a resource config that scans for JAX-RS resources and providers
        // in com.example package
        final ResourceConfig rc = new ResourceConfig().packages("com.example");

        // create and start a new instance of grizzly http server
        // exposing the Jersey application at BASE_URI
        return GrizzlyHttpServerFactory.createHttpServer(URI.create(BASE_URI), rc);
    }

    /**
     * Main method.
     * @param args
     * @throws IOException
     */
    public static void main(String[] args) throws IOException {
        final HttpServer server = startServer();
        System.out.println(String.format("Jersey app started with WADL available at "
                + "%sapplication.wadl\nHit enter to stop it...", BASE_URI));
        System.in.read();
        server.stop();
    }
}

pom.xmlも示しておきます。

<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/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>simple-service</artifactId>
    <packaging>jar</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>simple-service</name>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.glassfish.jersey</groupId>
                <artifactId>jersey-bom</artifactId>
                <version>${jersey.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>org.glassfish.jersey.containers</groupId>
            <artifactId>jersey-container-grizzly2-http</artifactId>
        </dependency>
        <dependency>
            <groupId>org.glassfish.jersey.inject</groupId>
            <artifactId>jersey-hk2</artifactId>
        </dependency>

        <dependency>
            <groupId>javax.xml.bind</groupId>
            <artifactId>jaxb-api</artifactId>
            <version>2.3.0</version>
        </dependency>      
        <dependency>
            <groupId>com.sun.xml.bind</groupId>
            <artifactId>jaxb-impl</artifactId>
            <version>2.3.0.1</version>
        </dependency>
        <dependency>
            <groupId>javax.activation</groupId>
            <artifactId>javax.activation-api</artifactId>
            <version>1.2.0</version>
        </dependency>

        <!-- uncomment this to get JSON support:
         <dependency>
            <groupId>org.glassfish.jersey.media</groupId>
            <artifactId>jersey-media-json-binding</artifactId>
        </dependency>
        -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.9</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <inherited>true</inherited>
                <configuration>
                    <source>11</source>
                    <target>11</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>1.6.0</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>java</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <mainClass>com.example.Main</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <properties>
        <jersey.version>2.27</jersey.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
</project>

 

依存性を調べる

アプリケーションをモジュール化する場合、必須なのがモジュールを定義するmodule-info.javaの作成です。

基本的には、module-info.javaには使用するモジュールと、公開するパッケージを記述します。

しかし、どのモジュールを使っているかなんて、よく分からないですよね。そういう時に使用するのが、jdepsコマンドです。

では、さっそくjdepsコマンドを使ってみましょう。

jdepsはJARファイルもしくはクラスファイルを引数にして実行します。サンプルのJARファイルはMavenではtargetディレクトリに作成されるので、そこで実行させてみました。

C:\jersey-sample\simple-service\target>jdeps -s simple-service-1.0-SNAPSHOT.jar
simple-service-1.0-SNAPSHOT.jar -> java.base
simple-service-1.0-SNAPSHOT.jar -> 見つかりません

C:\jersey-sample\simple-service\target>

上記の例で使用している-sオプションはサマリー表示を行うためです。

この結果、java.baseモジュールを使っていることは分かります。java.baseモジュールはJavaの基本となるモジュールでjava.langパッケージなどが含まれています。

しかし、その他のモジュールは「見つかりません」と表示されてしまいます。

これはモジュールパスもしくはクラスパスが設定されていないためです。

しかし、Mavenを使っていると、他に使用しているライブラリはローカルレポジトリにあるため、クラスパスを設定するにもちょっとめんどうです。そこで、MavenのDependency Pluginを使用して、使用しているJARファイルを一か所にコピーしてしまいましょう。

pom.xmlの<plugins>要素に以下の記述を付けくわえます。

            <plugin>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <phase>install</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${project.build.directory}/lib</outputDirectory>
                            <includeScope>runtime</includeScope>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

これでtargetディレクトリにlibディレクトリを作成し、使用しているJARファイルをコピーします。

このlibディレクトリ配下のJARファイルをクラスパスに追加して、jdepsを実行してみます。

C:\jersey-sample\simple-service\target>mvn clean install
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.example:simple-service >---------------------
[INFO] Building simple-service 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]--------------------------------- 
   <<省略>>

C:\jersey-sample\simple-service\target>cd target
C:\jersey-sample\simple-service\target>jdeps -s -cp lib\* simple-service-1.0-SNAPSHOT.jar
エラー: jaxb-api-2.3.0.jarはマルチリリースjarファイルですが--multi-releaseオプションが設定されていません

C:\jersey-sample\simple-service\target>

ところが、今度はエラーが出てしまいました。

ここで、表示されているマルチリリースJARというのは、Java SE 9で導入された機能で、1つのJARファイルに複数のJavaのバージョンに対応したクラスファイルをまとめることができます。

jdepsはマルチリリースJARファイルがあると、--muliti-releaseオプションを設定する必要があるのですが、これがまた問題なのです。実際にやってみましょう。

C:\jersey-sample\simple-service\target>jdeps -s --multi-release 11 -cp lib\* simple-service-1.0-SNAPSHOT.jar
エラー: simple-service-1.0-SNAPSHOT.jarはマルチリリースjarファイルではありませんが--multi-releaseオプションが設定されています

C:\jersey-sample\simple-service\target>

ここから分かるのは--multi-releaseオプションを設定するには、すべてのJARファイルがマルチリリースJARになっていないといけないということです。しかし、それはほぼ無理なのです。

マルチリリースJARに対するjdepsの対応は間違っていると思うのですが、どうにかならないですかねぇ。

しかたないので、jaxb-api-2.3.0.jarをlibディレクトリから移動させて、再びjdepsを実行しました。

C:\jersey-sample\simple-service\target>move lib\jaxb-api-2.3.0.jar .
        1 個のファイルを移動しました。

C:\jersey-sample\simple-service\target>jdeps -s -cp lib\* simple-service-1.0-SNAPSHOT.jar
simple-service-1.0-SNAPSHOT.jar -> lib\grizzly-http-server-2.4.0.jar
simple-service-1.0-SNAPSHOT.jar -> java.base
simple-service-1.0-SNAPSHOT.jar -> lib\javax.ws.rs-api-2.1.jar
simple-service-1.0-SNAPSHOT.jar -> lib\jersey-container-grizzly2-http-2.27.jar
simple-service-1.0-SNAPSHOT.jar -> lib\jersey-server-2.27.jar

C:\jersey-sample\simple-service\target>

やっと結果が表示されました。

java.baseモジュール以外に、4つのJARファイルを使用していることが分かります。実をいうと、これらの4つのJARファイルはモジュールにはなっていません。

しかし、モジュールアプリケーションが直接アクセスできるのは、モジュールだけです。こういう場合、通常のJARファイルをモジュールとして扱う自動モジュール( Automatic Module)という機能を使用します。

実際にそれを行うのは、もうちょっと後なので、ここではまずモジュールにすることを考えましょう。

module-info.javaの生成

java.baseモジュールはJavaアプリケーションには必ず必要なので、module-info.javaに記述しなくても大丈夫です。

なので、それ以外の4つのJARファイルをmodule-info.javaに記述します。でも、これはめんどうなので、jdepsコマンドにmodule-info.javaを作ってもらいましょう。

そのために使用するのが、--generate-module-infoオプションです。

ただし、--generate-module-infoオプションではクラスパスは使用できません。その理由は、先ほどと同じでモジュールはモジュールしかアクセスできないためです。なので、クラスパスではなく、モジュールパスを設定します。ここではlibディレクトリをモジュールパスとして設定します。自動モジュールの機能があるので、モジュールでないJARファイルであっても、これで大丈夫です。

でも、1つ問題があります。libディレクトリには2つのバージョンのjavax.injectが含まれているはずです。Dependency Pluginはpom.xmlの依存性を見ているだけなので、バージョン違いのJARファイルが含まれることがあるのはしかたありません。

しかし、現状のモジュールシステムはモジュールのバージョンを直接あつかうことができません(バージョンをつけることはできます)。そのため、モジュールパスに複数のバージョンのJARファイルを置くことはできないのです。

しかたないので、libディレクトリのjavax.injectの古い方を削除してから、jdepsを実行します。

下の例では複数のバージョンがあるため、jdepsがエラーを出しています。javax.injectを削除すれば、実行できます。

C:\jersey-sample\simple-service\target>jdeps --generate-module-info . --module-path lib simple-service-1.0-SNAPSHOT.jar
Exception in thread "main" java.lang.module.FindException: Two versions of module javax.inject found in lib (javax.inject-2.5.0-b42.jar and javax.inject-1.jar)
        at java.base/jdk.internal.module.ModulePath.scanDirectory(ModulePath.java:293)
        at java.base/jdk.internal.module.ModulePath.scan(ModulePath.java:231)
        at java.base/jdk.internal.module.ModulePath.scanNextEntry(ModulePath.java:189)
        at java.base/jdk.internal.module.ModulePath.findAll(ModulePath.java:165)
        at jdk.jdeps/com.sun.tools.jdeps.JdepsConfiguration$Builder.build(JdepsConfiguration.java:544)
        at jdk.jdeps/com.sun.tools.jdeps.JdepsTask.buildConfig(JdepsTask.java:589)
        at jdk.jdeps/com.sun.tools.jdeps.JdepsTask.run(JdepsTask.java:543)
        at jdk.jdeps/com.sun.tools.jdeps.JdepsTask.run(JdepsTask.java:519)
        at jdk.jdeps/com.sun.tools.jdeps.Main.main(Main.java:49)

C:\jersey-sample\simple-service\target>del lib\javax.inject-1.jar

C:\jersey-sample\simple-service\target>jdeps --generate-module-info . --module-path lib simple-service-1.0-SNAPSHOT.jar
writing to .\simple.service\module-info.java

C:\jersey-sample\simple-service\target>

なお、--generate-module-infoの引数はmodule-info.javaを出力するディレクトリです。ここではカレントディレクトリを指定しています。

jdeps指定したディレクトリにJARファイルに対応したディレクトリを作成して、そこにmodule-info.javaを生成します。ここではsimple-service-1.0-SNAPSHOT.javaファイルなので、バージョンを取り除いて、ハイフンをピリオドに置き換えたsimple.serviceをディレクトリ名にしています。

では、作成されたmodule-info.javaを見てみましょう。

module simple.service {
    requires jersey.container.grizzly2.http;
    requires jersey.server;

    requires transitive grizzly.http.server;
    requires transitive java.ws.rs;

    exports com.example;

}

はじめの行のmoduleキーワードの後に記述してあるのがモジュール名です。

生成したモジュール名は、jdepsが作成したディレクトリ名と同じです。つまり、JARファイル名から作成したことが分かります。これは自動モジュールのモジュール名を決めるときと同じルールで行っています。

通常、モジュール名はパッケージ名と同様に、ドメインの逆順を使用して決めます。ここではサンプルなので、このままにしておきましょう。

requires文にモジュール名を指定します。

先ほどの4つのJARファイルに対応するのが、この4行のrequires文です。

ここでも、JARファイル名からバージョン名を取り除いて、ハイフンをピリオドに置き換えたものがモジュール名として使用されています。ところが、java.ws.rsだけはJARファイル名とは異なります。

これは、JARファイルのMANIFEST.MFファイルの中にモジュール名を指定しているためです。

javax.ws.rs-api-2.1.jarのMANIFEST.MFファイルは以下のようになっています。

Manifest-Version: 1.0
Automatic-Module-Name: java.ws.rs
Bnd-LastModified: 1501859871759
Build-Id: 08/04/2017 05:17 PM
  <<以下、省略>>

この中の、Automatic-Module-Nameで指定しているjava.ws.rsがモジュール名になります。

こんなのを1つ1つ調べていくのは大変なので、jdepsコマンドで作ってもらうのが手っ取り早いですね。

さて、module-info.javaのrequires文には、transitiveがついているもののと、ついていないものがあります。

transitiveはこのモジュールが使用しているモジュールであり、かつこのモジュールがそれを外部に対して公開しているモジュールです。

たとえば、grizzly.http.serverがtransitiveになっているのはMainクラスのstartServerメソッドの戻り値の方がorg.glassfish.grizzly.http.server.HttpServerクラスだからです。

jdepsコマンドはこのようにクラスの内部までチェックしてtransitiveかどうかを決めています。

ところが、startServerメソッドはmainメソッドで使われるだけなので、実際にはtransitiveである必要はありません。

まぁ、jdepsもそこまでは調べてくれないということですね。

module-info.javaの最後のexports文はsimple.serviceモジュールで公開するパッケージを指定します。このサンプルは1つのパッケージしか使用していないので、それが表示されているだけです。

しかし、複数のパッケージがあれば、それがずらずらとexports文で記述されてしまうので、ほんとうに公開したいパッケージだけを残して、あとは削除しておきましょう。

さて、生成されたmodule-info.javaは、src/main/javaディレクトリにコピーしておきましょう。つまり、module-info.javaはデフォルトパッケージの位置に配置します。

これで、simple-serviceサンプルはモジュールアプリケーションになります。

では、コンパイルしてみましょう。

C:\jersey-sample\simple-service>mvn clean compile
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.example:simple-service >---------------------
[INFO] Building simple-service 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ simple-service ---
[INFO] Deleting C:\Users\yuichi\Desktop\jersey\simple-service\target
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ simple-service ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory C:\Users\yuichi\Desktop\jersey\simple-service\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.7.0:compile (default-compile) @ simple-service ---
[WARNING] ********************************************************************************************************************
[WARNING] * Required filename-based automodules detected. Please don't publish this project to a public artifact repository! *
[WARNING] ********************************************************************************************************************
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 3 source files to C:\Users\yuichi\Desktop\jersey\simple-service\target\classes
[INFO] /C:/Users/yuichi/Desktop/jersey/simple-service/src/main/java/com/example/Main.java: C:\Users\yuichi\Desktop\jersey\simple-service\src\main\java\com\example\Main.javaは推奨されないAPIを使用またはオーバーライドしています。
[INFO] /C:/Users/yuichi/Desktop/jersey/simple-service/src/main/java/com/example/Main.java: 詳細は、-Xlint:deprecationオプションを指定して再コンパイルしてください。
[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR :
[INFO] -------------------------------------------------------------
[ERROR] /C:/Users/yuichi/Desktop/jersey/simple-service/src/main/java/com/example/Main.java:[25,55] org.glassfish.jersey.ExtendedConfigにアクセスできません
  org.glassfish.jersey.ExtendedConfigのクラス・ファイルが見つかりません
[INFO] 1 error
[INFO] -------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3.897 s
[INFO] Finished at: 2018-07-21T21:45:47+09:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.7.0:compile (default-compile) on project simple-service: Compilation failure
[ERROR] /C:/Users/yuichi/Desktop/jersey/simple-service/src/main/java/com/example/Main.java:[25,55] org.glassfish.jersey.ExtendedConfigにアクセスできません
[ERROR]   org.glassfish.jersey.ExtendedConfigのクラス・ファイルが見つかりません
[ERROR]
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

C:\jersey-sample\simple-service>

クラスが見つからないと、エラーになってしまいました。

ここで見つからないといわれているorg.glassfish.jersey.ExtendedConfigインタフェースは、Mainクラスで使用してるorg.glassfish.jersey.server.ResourceConfigクラスが実装しているインタフェースです。

そして、ExtendedConfigインタフェースはjersey-server-2.27.jarファイルではなく、jersey-common-2.27.jarに含まれているのです。

このことから分かるように、jdepsの--generate-module-infoオプションで作成されるmodule-info.javaは完璧なものではありません。

あくまでも、ひな型としてあつかい、必要に応じて編集しなくてはなりません。

特にリフレクションに関しては、jdepsは無力です。リフレクションを使用している場合は、自分で依存性を記述してください。

ここでは、jersey.commonのrequires文を追加します。

module simple.service {
    requires jersey.container.grizzly2.http;
    requires jersey.server;
    requires jersey.common;

    requires transitive grizzly.http.server;
    requires transitive java.ws.rs;

    exports com.example;

}

これでコンパイルはできるはずです。

ただし、テストは通りません。これはCompiler Pluginのバグで3.7.1で直るということなのですが、テストできないのは困ります。

これについては、ワークアラウンドがあって、pom.xmlのコンパイルのオプションで<source>と<target>を共に9にすれば、テストが通ります。

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <inherited>true</inherited>
                <configuration>
                    <source>9</source>
                    <target>9</target>
                </configuration>
            </plugin>

とはいうものの、せっかくJava 11を使っているのに、9にするのは何か負けているような気がして、個人的にはイヤw

実行

コンパイルできたので、実行してみましょう。

C:\jersey-sample\simple-service>mvn exec:java
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.example:simple-service >---------------------
[INFO] Building simple-service 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- exec-maven-plugin:1.6.0:java (default-cli) @ simple-service ---
7月 22, 2018 11:46:46 午前 org.glassfish.grizzly.http.server.NetworkListener start
情報: Started listener bound to [localhost:8080]
7月 22, 2018 11:46:46 午前 org.glassfish.grizzly.http.server.HttpServer start
情報: [HttpServer] Started.
Jersey app started with WADL available at http://localhost:8080/myapp/application.wadl
Hit enter to stop it...

あっさりと実行できてしまいました。http://localhost:8080/myapp/myresource にアクセスすれば、"Got it!" と表示されるはずです。

ところで、このサンプルで実行のために使用しているExec Maven Pluginでは、ゴールとしてexec:javaとexec:execが定義されています。

exec:javaがMavenと同じVMで実行され、exec:execは異なるVMで実行されるという違いがあります。

どうやら、現状のExec Maven Pluginのexec:javaの場合、モジュールであってもモジュールのロードではなく、単なるクラスロードが使われているようです。このため、特に設定をしなくても実行ができてしまったのです。

しかし、これではモジュールとしての動作の確認ができないので、exec:execで実行できるようにしてみます。

そのためには、pom.xmlの編集が必要です。

現在のpom.xmlのExec Maven Pluginの設定は次のようになっています。

            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>1.6.0</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>java</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <mainClass>com.example.Main</mainClass>
                </configuration>
            </plugin>

これを次のように変更します。

            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>1.6.0</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>exec</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <executable>java</executable>
                    <arguments>
                        <argument>-p</argument> <modulepath />
                        <argument>-cp</argument> <classpath />
                        <argument>-m</argument>
                            <argument>simple.service/com.example.Main</argument>
                    </arguments>
                </configuration>
            </plugin>

変更したのは<configuration>要素です。

残念ながら、現バージョンのExec Maven Pluginではモジュールを使用するには、javaコマンドの引数を<argument>要素で指定する必要があるのです。

-pオプションは、--module-pathオプションの省略形で、モジュールパスを指定するオプションです。

ただし、クラスパスと同様に、モジュールパスでも<modulepath />要素を使用すれば、実際にモジュールパスを指定する必要はありません。これだけでも、ちょっと楽ができる感じですね。

メインクラスを指定するのは-mオプションです。-mオプションは--moduleオプションの省略形で、モジュールをロードする基点となるモジュールとメインクラスを指定します。

先ほどは、exec:javaで実行しましたが、今回はexec:execです。

C:\jersey-sample\simple-service>mvn exec:exec
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.example:simple-service >---------------------
[INFO] Building simple-service 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- exec-maven-plugin:1.6.0:java (default-cli) @ simple-service ---
7月 22, 2018 13:23:06 午前 org.glassfish.grizzly.http.server.NetworkListener start
情報: Started listener bound to [localhost:8080]
7月 22, 2018 13:23:06 午前 org.glassfish.grizzly.http.server.HttpServer start
情報: [HttpServer] Started.
Jersey app started with WADL available at http://localhost:8080/myapp/application.wadl
Hit enter to stop it...

同じように実行することができたはずです。

単体で実行

ここまではMavenを使ってコンパイル、実行を行ってきました。

しかし、アプリケーションを配布することを考えると、ずっとMavenに頼っているわけにはいきません。

というわけで、単体で実行できるようにしてみましょう。

まずは、Mavenでinstallまで行って、サンプルのJARファイルを作成しておきます。

C:\jersey-sample\simple-service>mvn clean install -Dmaven.test.skip=true
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.example:simple-service >---------------------
[INFO] Building simple-service 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
  <<以下、省略>>

前述したように、sourceとtargetが11のままだとテストが通りません。そこで、ここではテストをスキップさせています。

これで、targetディレクトリにsimple-service-1.0-SNAPSHOT.jarファイルができているはずです。

また、Maven Dependency Pluginによってlibディレクトリには依存性のあるJARファイルがコピーされています。

ここまでモジュールと自動モジュール、モジュールではないJARファイルの3種類が出てきていましたが、それを一度整理しましょう。

  • モジュール: module-info.javaでモジュール名、依存性、公開範囲が定義されたモジュール
  • 自動モジュール (Automatic Module): モジュールの定義はないが、自動的にモジュールに格上げされたJARファイル
  • 無名モジュール (Unnamed Module): モジュールではないJARファイル

自動モジュールは自動的に格上げされたため、すべてのパッケージが外部に公開されています。自動モジュールのモジュール名は前述したようにMANIFEST.MFのAutomatic-Module-Nameで定義された名前が使用されます。Automatic-Module-Nameがない場合はJARファイル名から自動的に作られます。

モジュールと自動モジュールはモジュールパスで指定したディレクトリに配置します。

無名モジュールは、モジュールという名前がついていますが、単なるJARファイルです。もちろん、すべてのパッケージが公開されています。無名モジュールは、今まで同様にクラスパスで指定します。

ここで、重要なのは通常のモジュールはモジュールもしくは自動モジュールにしかアクセスできません。アクセスできるのは、module-info.javaのrequires文に記述したモジュール(自動モジュールを含む)だけです。

つまり、モジュールは無名モジュールにはアクセスできないのです。無名モジュールにアクセスできるのは、自動モジュールだけです。

ただし、例外もあります。これについては、別エントリーで触れたいと思います。

さて、ここではルートとなるモジュールがsimple-service-1.0-SNAPSHOT.jarファイルで、このモジュールは前述したように5つの自動モジュールに依存しています。

つまり、この6個のJARファイルをモジュールパスで指定するディレクトリに配置します。そして、それ以外のJARファイルをクラスパスで指定します。

ここでは、modsディレクトリを作成して、そこに6個のJARファイルを移動させてみます。

C:\jersey-sample\simple-service\target>dir mods /B
grizzly-http-server-2.4.0.jar
javax.ws.rs-api-2.1.jar
jersey-common-2.27.jar
jersey-container-grizzly2-http-2.27.jar
jersey-server-2.27.jar
simple-service-1.0-SNAPSHOT.jar

C:\jersey-sample\simple-service\target>

では、実行してみましょう。

C:\jersey-sample\simple-service\target>java -p mods -cp lib\* -m simple.service/com.example.Main
7月 22, 2018 8:57:34 午後 org.glassfish.grizzly.http.server.NetworkListener start
情報: Started listener bound to [localhost:8080]
7月 22, 2018 8:57:34 午後 org.glassfish.grizzly.http.server.HttpServer start
情報: [HttpServer] Started.
Jersey app started with WADL available at http://localhost:8080/myapp/application.wadl
Hit enter to stop it...

今までと同じように実行することができました。

まとめ

さて、サンプルアプリケーションをモジュール化して、単体で実行できるところまでやってみました。正直な話、かなりめんどくさいです。

新規に作成するアプリケーションであればさほどではないかもしれませんが、既存のアプリケーションをモジュール化するのはかなりタフなことになるのではないでしょうか。

ここまでの手段をまとめてみました。

  • 依存性を調べるにはjdepsコマンドを使用する
  • マルチリリースJARには気をつける
  • module-info.javaのひな型はjdepsコマンドで生成させる
  • 必要に応じて、生成したmodule-info.javaを編集する
  • Mavenで実行する場合、ゴールがexec:javaであればメインクラスだけの指定でOK
  • ゴールがexec:execの場合、モジュールパス、クラスパス、ルートモジュールとメインクラスを指定する
  • Mavenを使用せずに実行する場合、モジュールと自動モジュールをモジュールパス、その他をクラスパスで指定する

やっぱり、たいへんですね。