日々常々

ふつうのプログラマがあたりまえにしたいこと。

コード、区分、フラグ、IDと名前。

システム開発ではよくコードや区分、フラグと呼ばれるものを扱います。

これらが混同していたり、曖昧になっていたりすることは多いので、その辺りを整理しておきます。 IDや名前なんかもこの文脈に登場するので、ついでに。

コード

コードはエンコード/デコードできるものです。 桁数ごとに意味があったり。 一定のルールで読み書きできるのがコードかなと思います。

区分

種類が固定されたコードを、特別に区分と呼ぶことにします。 値ごとに意味が決まるので、コードの一種としています。

どんな値が入りうるかわからないものは区分とは呼べません。 それは多分コードと呼んだ方がいいです。

フラグ

種類が2つ(on/offやtrue/false)に固定された区分、特別にフラグと呼ぶことにします。 3つ目が出てきたらフラグとは呼べません。 それは区分って呼んだ方がいいんだろうなと思います。

フラグと区分の関係を示したいのは、フラグはしばしば増えるからです。 削除フラグに入ってる9とか2とかのことです。君はもうフラグじゃない。

ID

IDはidentifier、識別子です。 大事なのは一意であることだけです。 値の体系は関係ありません。文字として読めなくてもIDはIDです。

体系の決まっているIDはコードの側面も持ちますが、だからと言ってIDはコードではありません。 こう言うのは「IDのコード体系」と捉えるのがいいかなと。

コードをそのままIDとして使うこともあります。 こう言う文脈ではコードとIDは混同されがちですし、その文脈に閉じれば、同じと看做しても問題ありません。 でも広い文脈ではコードとIDは異なります。

IDは識別する範囲内で一意であればいいので、区分はフラグもその範囲内では一意だとかなんとか言えます。それに意味はない気はしますが。

名前、番号

これらは機械ではなく人が主に使用します。 名前や番号自体に一意性はありません。読み書きのルールもあるようなないような感じです。

名前や番号として固有の値を付けられることもありますが、しばしばコードやIDがそのまま使われます。 「名前で一意になる」は名前がIDの側面を持っている状態です。 「シリアル番号から型番がわかる」は番号がコードの側面を持ち、そのコードの一部に区分が使用されている状態です。 こう言う時、名前や番号とそれらが混同されがちです。

番号は主に数値で構成され、順序性があったりします。 番号を名前として使用することはあるかもしれませんが、名前を番号としては使用しないでしょう。 番号は名前よりは一意性を持つ傾向にありますが、一意性はたいして重要じゃないこともあります。 番号に一意性が必要であれば、IDを番号に使用するのがいいかと。

大雑把な関係

こんな感じ。

f:id:irof:20211026180017p:plain

破線は「コードを名前として使ったりする」みたいな読み方で。

混同していて問題のないことも多いので、常に厳密に区別する必要はありません。迷った時の参考程度に。

ローカルクラスとしてrecordを使う

irof.hateblo.jp

こちらで書いた「Local record classes」を使う時の注意。

触ってると案外使う機会が出てきそうな感触があったので、気をつけるところを書いておきます。

ローカルクラス

そもそもローカルクラスってあまり使わないものなんで存在も認識されてなかったりします。メソッド内に書くクラスなんですが……

class Hoge {

    void fuga() {
        class Piyo { } // これ
    }
}

書いたら「こんなとこにクラス書けるの?」な反応もしばしば。 用途は特殊だし代替手段もあるので無理に使う必要性はないです。知らなくても生きてけるし、知ってたからと言って 知識マウントに使うにも微妙で 嬉しいことってそんなにない。 サンプルコード書く時にちょっと楽なくらいです。

ローカルレコードクラスの使い所

と言う感触だったんですが、これがStream APIに加えてrecordで若干変わりました。recordのネスト、ついでに他も でコンストラクタ全部出力するコードでも使ってます。

  • 名前付きのPair(やタプル)として作成できる
  • classだからメソッドも持たせられる

あたりが素敵です。 ローカルクラスでもできたんですけど、やろうとするとフィールドとコンストラクタを作らなきゃなので、メソッド内に書くには大袈裟でした。なのでまともにクラスを作るか、いろんなことに目を瞑って Object[] を使ってきました。record だとこの辺要らないので、メソッド内でもノイズがない手触りが良いです。

クラスを作りたくない理由は、そこまで広いコンテキストで使いたくないから。パッケージプライベートでも広いし、クラスにネストしたprivateクラスでもまだ広いかなって思うことがある。名前汚染みたいなことも気になっちゃう。 メソッドのローカルに閉じられると名前もメソッド内に特化したもので良くなるし、多少雑にやっても他を汚さないから取り扱い易いんです。

ローカルクラスとの違い

recordはクラスではあるんですが、classとイコールではないです。 特にrecordのネスト、ついでに他も で書いたstaticの扱い。 これがローカルの場合も入ってきます。

void method() {
    record LocalRecord() { }
    class LocalClass { }
}

コンパイルは通ります。同じように見えますが、LocalRecordstatic で、LocalClassは違います。 これが何を意味するかと言うと、「それぞれから外側にアクセスできるか」です。

void method() {
    var object = new Object();

    record LocalRecord() {
        void method() {
            object.toString();  // コンパイルエラー
        }
    }
    class LocalClass {
        void method() {
            object.toString();
        }
    }
}

これが本稿の主題です。ローカルクラスと同じ場所でローカルレコードクラスを使った場合、ローカルクラスと同等には使用できません。 「ローカルクラス」としてではなく「メソッド内に閉じたrecord」と認識する必要があります。

当然、メソッドの一時変数だけでなく、外側のクラスのインスタンスメンバにもrecordの内側からはアクセスできません。 recordで使用するものはレコードコンポーネントとして明示的に渡してあげる必要があります。

「ローカルレコードクラスでメソッドを使わなければ問題ない」ではありますが、メソッドを持てるのはただのデータ構造に対するせっかくのメリット。 取りまとめて名前までつけた情報の組み合わせには固有のメソッドがある。はず。たぶん。

もうちょい詳しく

エラーメッセージは Non-static variable 'object' cannot be referenced from a static context です。 static なんて書いてないけど、recordstatic context ということ。

この辺は javap で出てきたりします。以下は javap -v の抜粋。

SourceFile: "Sample.java"
NestMembers:
  Sample$1LocalClass
  Sample$1LocalRecord
InnerClasses:
  #20= #15;                               // LocalClass=class Sample$1LocalClass
  static final #21= #17;                  // LocalRecord=class Sample$1LocalRecord

同じように書いてるのに LocalRecord のほうは static final がついてます。

明示したい

「暗黙に任せずに明示したい」と思うかもしれませんが、以下はいずれもコンパイルエラーです。

void method() {
    static record LocalRecord() { }
    static class LocalClass { }
}

ローカルクラスにstaticはつけれないので、 static record は書けません。「デフォルトがどっち」とかではなく「強制的にこっち」なので明示云々じゃないんですね。

たぶんrecord はレコードコンポーネント以外を持たないのを優先したんでしょう。外側にアクセスするためには外側からインスタンスを受け取るようにコンストラクタを変えなきゃですし。 recordとしては正しいと思うけど、インナークラスとかに対する半端な知識があると混乱ポイントかなと思います。

蛇足: Stream APIのLambda内レコード

これってどうなんだ?と思いつつ。

Stream.of("abc", "defg")
        .map(s -> {
            record Pair(String value, int length) {}
            return new Pair(s, s.length());
        })
        .forEach(System.out::println);

StreamAPIの途中でrecordを宣言もできます。staticなんで後続処理にインスタンス渡してもインナークラスインスタンスを渡した時のようにメモリリークの原因にもならないはず。 後続処理(ここではforEachSystem.out::println)がPairコンパイルレベルで必要としなければ普通にPairとして動作します。

Pair を以下のように書けば、当然出力も変わります。

record Pair(String value, int length) {
    @Override
    public String toString() {
        return "きゃー";
    }
}

もちろんですが、Pair 独自のメソッドは後続ではコンパイルできません。

Stream.of("abc", "defg")
        .map(s -> {
            record Pair(String value, int length) {}
            return new Pair(s, s.length());
        })
        .map(Pair::value)  // コンパイルエラー
        .forEach(System.out::println);

record定義を前に出せば当然いけます。

record Pair(String value, int length) {}
Stream.of("abc", "defg")
        .map(s -> {
            return new Pair(s, s.length());
        })
        .map(Pair::value)
        .forEach(System.out::println);

けどこれは面白くない・・・あ、そうだ。java.util.functionのインタフェースを使おう。

Stream.of("abc", "defg")
        .map(s -> {
            record Pair(String value, int length) implements Supplier<String> {

                @Override
                public String get() { return "さぷらい"; }
            }
            return new Pair(s, s.length());
        })
        .map(Supplier::get)
        .forEach(System.out::println);

いけた。よし! toStringが呼べたからObjectとかの識別はできてたんだろけど、前段のPairSupplierってのをmapの時にわかるんですね。すごいなぁ。

……できるのは分かったけど、どう見てもわかりづらいし、お蔵入りかなー。

おまけ: ローカルenum

書けたのか……いやこれこそ書いてどうすんだ?

void method() {
    enum MyLocalEnum { HOO }
}

説明は省きますが、これもローカルレコードクラスと同じくstatic-contextになります。 「書いてどうすんだ?」とか書いたけど、ちょっと思いついてしまった。いつか試す。

recordのネスト、ついでに他も

record Outer(int a) {
    record Nest(int b) {
    }
}

こんなことしたらどうなるんだろうと気になりまして。

record が単にクラスのシンタックスシュガーであれば、NestはインナークラスになるのでOuterインスタンス変数、ここでは a にアクセスできるんですが、単なるネストクラスであればアクセスできません。 結論としてはNestからaにはアクセスできず、NestOuterインスタンスを持たない、staticが省略されていると言うことになります。

ネストだのインナーだのは 匿名クラスとかローカルクラスとか を参照ください。

確認はNestの方にメソッド生やしてOuterインスタンスメンバにアクセスしてみようとすればいいんですが、他にもNestjavapかリフレクションでコンストラクタやフィールドを見て、Outerがあるかどうかを見ればわかります。

そいや他でもどうなるんだろ?とこんなの書いて確認。

class OuterClass {
    class NestClass { }
    interface NestInterface { }
    enum NestEnum { }
    record NestRecord() { }
    static class StaticNestClass { }
    static interface StaticNestInterface { }
    static record StaticNestRecord() { }
    static enum StaticNestEnum { }
}

enum OuterEnum {
    CONSTANT;

    class NestClass { }
    interface NestInterface { }
    enum NestEnum { }
    record NestRecord() { }
    static class StaticNestClass { }
    static interface StaticNestInterface { }
    static record StaticNestRecord() { }
    static enum StaticNestEnum { }
}

public interface OuterInterface {
    class NestClass { }
    interface NestInterface { }
    enum NestEnum { }
    record NestRecord() { }
    static class StaticNestClass { }
    static interface StaticNestInterface { }
    static record StaticNestRecord() { }
    static enum StaticNestEnum { }
}

record OuterRecord(String s) {
    class NestClass { }
    interface NestInterface { }
    enum NestEnum { }
    record NestRecord() { }
    static class StaticNestClass { }
    static interface StaticNestInterface { }
    static record StaticNestRecord() { }
    static enum StaticNestEnum { }
}

で、全部のコンストラクタ舐めて出力。インタフェースはコンストラクタ無いから出ないけどね。

        String[] targets = {"Class", "Interface", "Enum", "Record"};

        record OuterAndNest(String outer, String nest) {
            Class<?> nestClass() {
                try {
                    return Class.forName(nest);
                } catch (ClassNotFoundException e) {
                    throw new RuntimeException(e);
                }
            }
        }
        Arrays.stream(targets)
                .map(outer -> "Outer" + outer)
                .peek(System.out::println)
                .flatMap(outer -> Stream.concat(
                        Arrays.stream(targets).map(nest -> new OuterAndNest(outer, outer + "$Nest" + nest)),
                        Arrays.stream(targets).map(nest -> new OuterAndNest(outer, outer + "$StaticNest" + nest))
                ))
                .forEach(e -> {
                    Class<?> nestClass = e.nestClass();
                    System.out.println("  " + nestClass);
                    Arrays.stream(nestClass.getDeclaredConstructors())
                            .forEach(constructor -> {
                                System.out.println("    " + constructor);
                            });
                });

結果。

OuterClass
  class OuterClass$NestClass
    OuterClass$NestClass(OuterClass)
  interface OuterClass$NestInterface
  class OuterClass$NestEnum
    private OuterClass$NestEnum(java.lang.String,int)
  class OuterClass$NestRecord
    OuterClass$NestRecord()
  class OuterClass$StaticNestClass
    OuterClass$StaticNestClass()
  interface OuterClass$StaticNestInterface
  class OuterClass$StaticNestEnum
    private OuterClass$StaticNestEnum(java.lang.String,int)
  class OuterClass$StaticNestRecord
    OuterClass$StaticNestRecord()
OuterInterface
  class OuterInterface$NestClass
    public OuterInterface$NestClass()
  interface OuterInterface$NestInterface
  class OuterInterface$NestEnum
    private OuterInterface$NestEnum(java.lang.String,int)
  class OuterInterface$NestRecord
    public OuterInterface$NestRecord()
  class OuterInterface$StaticNestClass
    public OuterInterface$StaticNestClass()
  interface OuterInterface$StaticNestInterface
  class OuterInterface$StaticNestEnum
    private OuterInterface$StaticNestEnum(java.lang.String,int)
  class OuterInterface$StaticNestRecord
    public OuterInterface$StaticNestRecord()
OuterEnum
  class OuterEnum$NestClass
    OuterEnum$NestClass(OuterEnum)
  interface OuterEnum$NestInterface
  class OuterEnum$NestEnum
    private OuterEnum$NestEnum(java.lang.String,int)
  class OuterEnum$NestRecord
    OuterEnum$NestRecord()
  class OuterEnum$StaticNestClass
    OuterEnum$StaticNestClass()
  interface OuterEnum$StaticNestInterface
  class OuterEnum$StaticNestEnum
    private OuterEnum$StaticNestEnum(java.lang.String,int)
  class OuterEnum$StaticNestRecord
    OuterEnum$StaticNestRecord()
OuterRecord
  class OuterRecord$NestClass
    OuterRecord$NestClass(OuterRecord)
  interface OuterRecord$NestInterface
  class OuterRecord$NestEnum
    private OuterRecord$NestEnum(java.lang.String,int)
  class OuterRecord$NestRecord
    OuterRecord$NestRecord()
  class OuterRecord$StaticNestClass
    OuterRecord$StaticNestClass()
  interface OuterRecord$StaticNestInterface
  class OuterRecord$StaticNestEnum
    private OuterRecord$StaticNestEnum(java.lang.String,int)
  class OuterRecord$StaticNestRecord
    OuterRecord$StaticNestRecord()

わかりづらいから flatMap の後で適当に filter しとく。

                .filter(e -> Arrays.stream(e.nestClass().getDeclaredConstructors())
                        .anyMatch(constructor -> Arrays.stream(constructor.getParameterTypes())
                                .anyMatch(parameterType -> parameterType.getName().equals(e.outer()))))

結果。

OuterClass
  class OuterClass$NestClass
    OuterClass$NestClass(OuterClass)
OuterInterface
OuterEnum
  class OuterEnum$NestClass
    OuterEnum$NestClass(OuterEnum)
OuterRecord
  class OuterRecord$NestClass
    OuterRecord$NestClass(OuterRecord)

エンクロージングクラスのインスタンスを受けるようにコンストラクタが弄られるのは class の時だけ、と言うことで。

きっかけ

f:id:irof:20211022234826p:plain

IntelliJ IDEAさんが警告してくれなかったのよね。StaticNestInterfaceStaticNestEnumstatic要らないって灰色で、NestClassstaticにできるよって黄色で。 「あってもなくても意味ないのなら灰色になるんじゃないかなぁ、出ないってことは違いあるのかなぁ」って思ったのだけど、黄色にもなってないので。

f:id:irof:20211022235224p:plain

ああ、一律あってもなくても意味ないのに灰色にしてるわけじゃなく、「enumの不要な修飾子」みたいな括りなのか。なるほど。

f:id:irof:20211022235501p:plain

なおinterfaceにネストした場合は全部のstaticが灰色になってくれます。これはinterfaceのメンバに対する不要な修飾子で引っかかってる模様。

満足。(言語仕様とか見に行く気力は残ってない)

IntelliJ IDEAさんは IDEA-266665 でfix済だった。 2021.3 になったら期待してる通りになりそう。