GlassFish 4で実質的なデプロイメントデスクリプタを生成

アノテーションを利用してJava EEの開発をしていると、時々デプロイメントデスクリプタを参照して、アプリ全体の整合性を確認したくなる。 GlassFish 4では、システムプロパティwriteout.xmltrueに設定してアプリをデプロイすることで、ディレクト[DOMAIN_HOME]/generated/xml/[アプリ名]に実質的(‘Effective’)なデプロイメントデスクリプタが生成される。 イメージ的には、mvn help:effective-pomのような感じ。

システムプロパティの設定コマンドは以下。

$ asadmin create-system-properties writeout.xml=true

設定後、GlassFishの再起動を忘れずに。

参考

ディスクの空き容量を確認するときに実行するコマンド

ディスクの空き容量の確認

$ df -h
Filesystem      Size  Used Avail Use% Mounted on
udev            3.9G     0  3.9G   0% /dev
tmpfs           799M  9.2M  790M   2% /run
/dev/vda1        91G   21G   66G  24% /
tmpfs           3.9G  204K  3.9G   1% /dev/shm
tmpfs           5.0M  4.0K  5.0M   1% /run/lock
tmpfs           3.9G     0  3.9G   0% /sys/fs/cgroup
tmpfs           799M     0  799M   0% /run/user/121
tmpfs           799M   44K  799M   1% /run/user/1000

ディレクトリごとの消費量を確認

$ sudo du -h --max-depth 1
4.0K    ./mnt
4.0K    ./media
15M     ./etc
0       ./sys
9.2M    ./run
3.6G    ./usr
0       ./proc
4.0K    ./cdrom
1.2G    ./opt
13M     ./bin
204K    ./dev
56M     ./boot
415M    ./lib
4.0K    ./lib64
60K     ./root
4.0K    ./snap
7.4G    ./home
13M     ./sbin
7.5G    ./var
16K     ./lost+found
4.0K    ./srv
2.1M    ./tmp
21G     .

消費量順にソートして表示する場合は以下。

$ sudo du --max-depth 1 | sort -k1,1 -n -r
21039864    .
7805728 ./var
7772140 ./home
3716428 ./usr
1212280 ./opt
424092  ./lib
57224   ./boot
14428   ./etc
12988   ./bin
12704   ./sbin
9400    ./run
2136    ./tmp
212     ./dev
60      ./root
16      ./lost+found
4       ./srv
4       ./snap
4       ./mnt
4       ./media
4       ./lib64
4       ./cdrom
0       ./sys
0       ./proc

Javaのクラスローダの階層を表示する

はじめに

以下のようなクラスローダの階層を出力するクラスを作成した。 クラスパスも表示しているが、動的に変わったり、クラスローダの実装によっては取得不可能だったりするので、参考程度。 Java9には未対応。 JigsawやBuiltinClassLoaderを理解して作りなおす必要がある。

bootstrap class loader {id=0}
    /opt/java/jdk1.8.0_131/jre/lib/endorsed
    /opt/java/jdk1.8.0_131/jre/lib/resources.jar
    /opt/java/jdk1.8.0_131/jre/lib/rt.jar
    /opt/java/jdk1.8.0_131/jre/lib/sunrsasign.jar
    /opt/java/jdk1.8.0_131/jre/lib/jsse.jar
    /opt/java/jdk1.8.0_131/jre/lib/jce.jar
    /opt/java/jdk1.8.0_131/jre/lib/charsets.jar
    /opt/java/jdk1.8.0_131/jre/lib/jfr.jar
    /opt/java/jdk1.8.0_131/jre/classes
sun.misc.Launcher$ExtClassLoader {id=405662939}
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/sunpkcs11.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/nashorn.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/jaccess.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/sunec.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/zipfs.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/dnsns.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/localedata.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/sunjce_provider.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/jfxrt.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/cldrdata.jar
sun.misc.Launcher$AppClassLoader {context-class-loader=true, id=1252169911, system-class-loader=true}
    file:/path/to/classes

ソースコード

package redj.classloader;

import java.io.ByteArrayOutputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.io.Writer;
import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.stream.Collectors;

public class ClassLoaders {

    private static final Handler[] HANDLERS = {
        new BootstrapClassLoaderHandler(),
        new URLClassLoaderHandler(),
        new UnknownHandler()
    };

    public static String getDump(ClassLoader classLoader) {
        ByteArrayOutputStream out = new ByteArrayOutputStream();
        dump(classLoader, out);

        return out.toString();
    }

    public static void dump(ClassLoader classLoader) {
        dump(classLoader, System.out);
    }

    public static void dump(ClassLoader classLoader, OutputStream out) {
        PrintWriter writer = new PrintWriter(out, true);
        try {
            dump(classLoader, writer);
        } finally {
            writer.flush();
        }
    }

    public static void dump(ClassLoader classLoader, PrintWriter writer) {
        for (Handler handler : HANDLERS) {
            if (handler.accept(classLoader)) {
                handler.handle(classLoader, writer);
                break;
            }
        }
    }

    public interface Handler {

        public boolean accept(ClassLoader classLoader);

        public default void handle(ClassLoader classLoader, PrintWriter writer) {
            // delegate to parent class loader
            delegateToParent(classLoader, writer);

            // print class loader name and attributes
            SortedMap attributes = getAttributes(classLoader);
            writer.println(getClassLoaderName(classLoader) + (!attributes.isEmpty() ? " " + attributes : ""));

            // print classpath
            for (String path : getClasspath(classLoader)) {
                writer.println("    " + path);
            }
        }

        public default void delegateToParent(ClassLoader classLoader, PrintWriter writer) {
            dump(classLoader.getParent(), writer);
        }

        public default String getClassLoaderName(ClassLoader classLoader) {
            return classLoader.getClass().getName();
        }

        public default SortedMap getAttributes(ClassLoader classLoader) {
            SortedMap<String, String> result = new TreeMap<>();

            result.put("id", "" + System.identityHashCode(classLoader));

            if (classLoader == ClassLoader.getSystemClassLoader()) {
                result.put("system-class-loader", "true");
            }

            if (classLoader == Thread.currentThread().getContextClassLoader()) {
                result.put("context-class-loader", "true");
            }

            return result;
        }

        public List<String> getClasspath(ClassLoader classLoader);
    }

    private static class UnknownHandler implements Handler {

        @Override
        public boolean accept(ClassLoader classLoader) {
            return true;
        }

        @Override
        public List<String> getClasspath(ClassLoader classLoader) {
            return Collections.EMPTY_LIST;
        }
    }

    private static class BootstrapClassLoaderHandler implements Handler {

        @Override
        public boolean accept(ClassLoader classLoader) {
            return classLoader == null;
        }

        @Override
        public void delegateToParent(ClassLoader classLoader, PrintWriter writer) {
        }

        @Override
        public String getClassLoaderName(ClassLoader classLoader) {
            return "bootstrap class loader";
        }

        @Override
        public List<String> getClasspath(ClassLoader classLoader) {
            List<String> result = new ArrayList<>();

            result.addAll(splitClassPath(System.getProperty("java.endorsed.dirs")));
            result.addAll(splitClassPath(System.getProperty("sun.boot.class.path")));

            return result;
        }

        private List<String> splitClassPath(String classpath) {
            List<String> result = Collections.EMPTY_LIST;;

            if (classpath != null) {
                result = Arrays.asList(classpath.split(System.getProperty("path.separator")));
            }

            return result;
        }
    }

    private static class URLClassLoaderHandler implements Handler {

        @Override
        public boolean accept(ClassLoader classLoader) {
            return classLoader instanceof URLClassLoader;
        }

        @Override
        public List<String> getClasspath(ClassLoader classLoader) {
            return Arrays
                    .stream(((URLClassLoader) classLoader).getURLs())
                    .map((url) -> url.toExternalForm())
                    .collect(Collectors.toList());
        }
    }
}

Apache TomcatにデプロイしたWebアプリのクラスローダの表示例

ここでは、Apache Tomcat 8.5.15に対して2つのWebアプリtest-webapp-1.warとtest-webapp-2.warをデプロイし、それぞれのアプリからのクラスローダのダンプを出力する。 Webアプリにはそれぞれ以下のようなServletを準備しておき、そのServletにアクセスすることでダンプを出力する。

package redj.classloader;

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet(urlPatterns = "/dump/*")
public class DumpServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setContentType("text/plain");
        ClassLoaders.dump(getClass().getClassLoader(), response.getWriter());
    }
}

test-webapp-1.warにアクセスした結果、出力されたダンプは以下。

$ curl http://localhost:8080/test-webapp-1/dump
bootstrap class loader {id=0}
    /opt/java/jdk1.8.0_131/jre/lib/endorsed
    /opt/java/jdk1.8.0_131/jre/lib/resources.jar
    ...
sun.misc.Launcher$ExtClassLoader {id=159259014}
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/sunpkcs11.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/nashorn.jar
    ...
sun.misc.Launcher$AppClassLoader {id=1442407170, system-class-loader=true}
    file:/opt/apache-tomcat-8.5.15/bin/bootstrap.jar
    file:/opt/apache-tomcat-8.5.15/bin/tomcat-juli.jar
java.net.URLClassLoader {id=142257191}
    file:/opt/apache-tomcat-8.5.15/lib/
    file:/opt/apache-tomcat-8.5.15/lib/tomcat-jdbc.jar
    ...
org.apache.catalina.loader.ParallelWebappClassLoader {context-class-loader=true, id=819380823}
    file:/opt/apache-tomcat-8.5.15/webapps/test-webapp-1/WEB-INF/classes/

test-webapp-2.warにアクセスした結果、出力されたダンプは以下。

$ curl http://localhost:8080/test-webapp-2/dump
bootstrap class loader {id=0}
    /opt/java/jdk1.8.0_131/jre/lib/endorsed
    /opt/java/jdk1.8.0_131/jre/lib/resources.jar
    ...
sun.misc.Launcher$ExtClassLoader {id=159259014}
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/sunpkcs11.jar
    file:/opt/java/jdk1.8.0_131/jre/lib/ext/nashorn.jar
    ...
sun.misc.Launcher$AppClassLoader {id=1442407170, system-class-loader=true}
    file:/opt/apache-tomcat-8.5.15/bin/bootstrap.jar
    file:/opt/apache-tomcat-8.5.15/bin/tomcat-juli.jar
java.net.URLClassLoader {id=142257191}
    file:/opt/apache-tomcat-8.5.15/lib/
    file:/opt/apache-tomcat-8.5.15/lib/tomcat-jdbc.jar
    ...
org.apache.catalina.loader.ParallelWebappClassLoader {context-class-loader=true, id=1256777078}
    file:/opt/apache-tomcat-8.5.15/webapps/test-webapp-2/WEB-INF/classes/

クラスローダのidより、以下のようなツリー構造であることが分かる。

bootstrap class loader {id=0}
`-- ExtClassLoader {id=159259014}
    `-- AppClassLoader {id=1442407170}
        `-- URLClassLoader {id=142257191}
            |-- ParallelWebappClassLoader {id=819380823}  // test-webapp-1
            `-- ParallelWebappClassLoader {id=1256777078} // test-webapp-2

またParallelWebappClassLoaderはそれぞれcontext-class-loader=trueとマークされており、すなわちコンテキストクラスローダは以下のように設定されていることが分かる。

Webアプリ コンテキストクラスローダ
test-webapp-1 ParallelWebappClassLoader {id=819380823}
test-webapp-2 ParallelWebappClassLoader {id=1256777078}

Maven + JUnitのテンプレート

はじめに

MavenのプロジェクトでJUnitを利用するときに、毎回同じようなpom.xmlとテストコードを書いている。 なので、テンプレートとしてサンプルコードを書き残しておく。 このサンプルコードでは、割り算の処理をテストしている。

ディレクトリ構成

$ tree
.
|-- pom.xml
`-- src
    |-- main
    |   `-- java
    |       `-- redj
    |           `-- junit
    |               `-- Calc.java
    `-- test
        `-- java
            `-- redj
                `-- junit
                    `-- CalcTest.java

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>redj-junit</groupId>
    <artifactId>test-template</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>
    
    <properties>
        <!-- configurations -->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        
        <!-- dependency versions -->
        <junit.version>4.12</junit.version>
        <hamcrest.version>1.3</hamcrest.version>
    </properties>
        
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
        
        <dependency>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-library</artifactId>
            <version>${hamcrest.version}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

Calc.java

テスト対象のクラスで、割り算を行うクラス。 バグを表現するため、わざと絶対値をとってから割っている。

package redj.junit;

public class Calc {

    public static int divide(int x, int y) {
        return x / Math.abs(y); // BUG: This line should be "return x / y;"
    }
}

CalcTest.java

package redj.junit;

import java.util.ArrayList;
import java.util.List;
import static org.hamcrest.core.Is.*;
import static org.junit.Assert.*;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.experimental.runners.Enclosed;
import org.junit.rules.ExpectedException;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameter;
import org.junit.runners.Parameterized.Parameters;

@RunWith(Enclosed.class)
public class CalcTest {

    @RunWith(Parameterized.class)
    public static class DevideTest {

        @Parameters
        public static Iterable<Fixture> data() {
            List<Fixture> fixtures = new ArrayList<>();

            fixtures.add(new Fixture(4, 2, 2, null));
            fixtures.add(new Fixture(4, 0, 0, ArithmeticException.class));
            fixtures.add(new Fixture(4, -2, -2, null));

            return fixtures;
        }

        @Parameter
        public Fixture fixture;

        @Rule
        public ExpectedException expectedException = ExpectedException.none();

        @Before
        public void setUp() {
            if (fixture.exceptionClass != null) {
                expectedException.expect(fixture.exceptionClass);
            }
        }

        @Test
        public void test() {
            int actual = Calc.divide(fixture.x, fixture.y);

            assertThat(actual, is(fixture.expected));
        }

        public static class Fixture {

            public final int x;

            public final int y;

            public final int expected;

            public final Class<? extends Throwable> exceptionClass;

            public Fixture(int x, int y, int expected, Class<? extends Throwable> exceptionClass) {
                this.x = x;
                this.y = y;
                this.expected = expected;
                this.exceptionClass = exceptionClass;
            }
        }
    }
}

実行結果

$ mvn clean install
(略)
-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running redj.junit.CalcTest
Tests run: 3, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 0.224 sec <<< FAILURE!
test[2](redj.junit.CalcTest$DevideTest)  Time elapsed: 0.012 sec  <<< FAILURE!
java.lang.AssertionError: 
Expected: is <-2>
     but: was <2>
    at org.hamcrest.MatcherAssert.assertThat(MatcherAssert.java:20)
    at org.junit.Assert.assertThat(Assert.java:956)
    at org.junit.Assert.assertThat(Assert.java:923)
    at redj.junit.CalcTest$DevideTest.test(CalcTest.java:51)
(略)

Results :

Failed tests:   test[2](redj.junit.CalcTest$DevideTest): (..)

Tests run: 3, Failures: 1, Errors: 0, Skipped: 0
(略)

Ubuntuで、ローカルにある.debのインストール方法

はじめに

gdebiを使うと依存関係にある.debも自動でダウンロードしてくれるので便利。 dpkgは自動でダウンロードはしてくれない。

実行方法

gdebiをインストール。

$ sudo apt-get install gdebi

インストールしたい.debを引数にして、gdebiを実行。

$ sudo gdebi foo.deb

Mavenの各種ディレクトリに対応するプロパティの一覧

はじめに

Mavenで提供されているプロパティの名前を調べ直すことが度々あるので、調べた内容をメモしておく。 「使えるプロパティのリストはこれですよ」ときちんと書いてある公式ドキュメントは、あるような、ないような。。。 まぁ、Mavenがプロパティの塊で、なおかつモジュールも細分化されているから、統合的なドキュメントが書きにくいのは分からなくもない。

ひとまず、よく利用するものだけまとめておく。

各種ディレクトリに対応するプロパティの一覧

プロパティ デフォルト値 対応するpom.xmlの要素の位置(XPath)
project.basedir (プロジェクトのディレクトリへのフルパス) (なし)
project.build.directory ${project.basedir}/target /project/build/directory
project.build.outputDirectory ${project.basedir}/target/classes /project/build/outputDirectory
project.build.testOutputDirectory ${project.basedir}/target/test-classes /project/build/testOutputDirectory
project.build.sourceDirectory ${project.basedir}/src/main/java /project/build/sourceDirectory
project.build.scriptSourceDirectory ${project.basedir}/src/main/scripts /project/build/scriptSourceDirectory
project.build.testSourceDirectory ${project.basedir}/src/test/java /project/build/testSourceDirectory

TODO

ディレクトリ ${project.basedir}/src/main/resources に対応するプロパティの型はStringかFileの配列だったかも。 今後必要ならば、上記の表に型の情報を追加して、プロパティの一覧を増やす。

参考

viでたまに利用するコマンド

たまに必要になって毎回調べ直すので、メモしておく。

行番号の表示

カーソルモードで以下のコマンドを実行。

:set number

実行前の例は以下。

#include <stdio.h>

main( )
{
    printf("hello, world\n");
}

実行後の例は以下。

      1 #include <stdio.h>
      2 
      3 main( )
      4 {
      5     printf("hello, world\n");
      6 }