コードの互換性と進化の両立

互換性とコード進化の両立
川口耕介 CloudBees, Inc.
kk@kohsuke.org / @kohsukekawa

©2013 CloudBees, Inc. All Rights Reserved

1

分散・独立・並行開発


2

http://commons.wikimedia.org/wiki/File:Close_up_of_Hand_Cut_Jigsaw_Puzzle.JPG

3

実行時結合

4

共通ライブラリ

ウェブアプリX

モジュールA

モジュールB

ライブラリ v1.0

ライブラリ v2.0


5


6

© いまいまさのぶ

7

プラグイン機構
プラグイン

プラグイン

コア

プラグイン

プラグイン

様々なクラス


…

80+のライブラリ

8

拡張ポイント
• コア

interface Animal {
void bark();
}

• プラグイン
@Extension
class Dog implements Animal {
void bark() { print(“ワン!”); }
}

9

プラグインはコアをガンガン使う

Project p = …;
Future<Build> f = p.scheduleBuild();
Build b = f.get();


10

この苦しみから解脱する方法はないかと
• お釈迦様の絵
• 徐々に蓄積してきたノウハウ・ツールを大公
開


11


mage © http://sfcitizen.com/blog/wp-content/uploads/2011/11/6302790910_c4eb865892_o-copy.jpg

12

フィールドの隠蔽

class Point {
int x,y;
}

class Point {
int getX();
int getY();
void setX(int);
void setY(int);
}


13

インターフェース？抽象クラス？

interface Animal {
void bark();
}

abstract class Animal {
public abstract
void bark();
}


14


interface Animal {
void bark();
void bark(int times);
}


15


public abstract void bark();
public void bark(int times) {
for (int i=0; i<times; i++)
bark();
}
}


16

ピンポンパターン

@deprecated
public void bark() {
bark(1);
}
public void bark(int times) {
for (int i=0; i<times; i++)
bark();
}
}


17

コンストラクタの肥大化
• 外部コードによる
サブクラス化を許可
したい
• GitSCMの例

public GitSCM(
String scmName,
List<UserRemoteConfig> userRemoteConfigs,
List<BranchSpec> branches,
UserMergeOptions userMergeOptions,
Boolean doGenerateSubmoduleConfigurations,
Collection<SubmoduleConfig> submoduleCfg,
boolean clean,
boolean wipeOutWorkspace,
BuildChooser buildChooser, GitRepositoryBrowser browser,
String gitTool,
boolean authorOrCommitter,
String relativeTargetDir,
String reference,
String excludedRegions,
String excludedUsers,
String localBranch,
boolean disableSubmodules,
boolean recursiveSubmodules,
boolean pruneBranches,
boolean remotePoll,
String gitConfigName,
String gitConfigEmail,
boolean skipTag,
String includedRegions,
boolean ignoreNotifyCommit,
boolean useShallowClone) {


18

我慢してセッター
class Foo {
void initXYZ(int x, int y, int z) { … }
void initABC(String a, String b, String c) { … }
}


19

コンフィグパターン
class FooConfig {
int x,y,z;
String a,b,c;
}

abstract class Foo {
Foo(FooConfig config) {
…
}
}


20



21

パッケージ越しにアクセスするた
めにpublicなんだけど、
外部からは使わせたくない


22

互換性用に@deprecatedとした
コードを次のステップに進めたい


23

だをつ修ア俺
しく飾ク俺
てる子セ
！道をス
具

© 小学館


24

http://kohsuke.org/access-modifier/
• 独自のアクセスチェッカを定義する
class 俺俺アクセス extends AccessRestriction
{
public void instantiated(loc,target,listener) {
listener.onError(null,loc,
target+“インスタンス生成は禁止”);
}
}
• サブタイプ、読み、書き、呼び出しなど６種
類

25

http://kohsuke.org/access-modifier/
• 通常のアクセス修飾子と共に使う
@Restricted(俺俺アクセス.class)
public class Foo {
public String value;
}
• Mavenプラグインがクラスファイルを検査


26


27

バイナリ互換性を活用
interface Animal {
void bark();
}
class Dog implements Animal {
void bark() { print(“ワン”); }
}

Animal a = new Dog();
a.bark();

28

バイナリ互換性を活用
interface Animal {
void bark(int n);
}
1. new Dog()でInstantiationError
class Dog implements Animal{
2. Dog→Animalのキャストで
ClassCastException
void bark() { print(“ワン”); }
3. a.bark(3)でAbstractMethodError
}
4. その他

Animal a = new Dog();
a.bark(3);

29

try {
a.bark(3);
} catch (AbstractMethodError e) {
// 互換性モード
…
}


30

ジェネリクス
class Foo {
List<Object> getChildren() { … }
}

class Foo {
List<String> getChildren() { … }
}


31

ジェネリクス
class Foo<T extends X> implements Future<T> {
T get() { … }
}

class Foo<T extends Y> implements Future<T> {
T get() { … }
}
class Y extends X { … }

32

ジェネリクス型変更のルール
• メソッド・フィールドのErasureが変わって
いなければOK
– T<X,Y,…>
→
T
– T extends X →
X
–…

• 検査してくれるツールをいつかは書きたい


33

根底のルール
foo/Foo.class
invokevirtual
org.example.Bar#method1(java.lang.String,int,int)boolean
…

org/example/Bar.class

メソッド method1 (java.lang.String,int,int):boolean


34

参照解決のルール
• メソッドへの参照
– クラス名：
– メソッド名：
– 戻り値型：
– パラメータ型：

java.lang.String
indexOf
int
java.lang.String,int

• 関連事項
– アクセス修飾子
– 例外


35

コード進化のパターン
class Foo {
X get() { … }
}

class Foo {
Y get() { … }
}
class Y extends X { … }

36

コード進化のパターン
class Foo {
X get() { … }
}

class Foo {
Y get() { … }
X get() { … }
}

37

Bridge Method Injectorプロジェクト bit.ly/b-mi
class Foo {
@WithBridgeMethods(X.class)
Y get() { … }
}

class Foo {
Y get() { … }
X get() { Y y=get(); return y; }
}

38

応用
class Foo {
@WithBridgeMethods(value=X.class,
castRequired=true)
Object get() { … }
}
class Foo {
Object get() { … }
X get() { Object o=get(); return (X)o; }
}

39

自分はルールを守っていても
モジュールB

ライブラリ 1.0

モジュールA

ライブラリ 2.0


40

シェーディング / パッケージ・リネーミング
package org.jenkinsci.foo;
import org.acme.A;
import org.acme.B;
class Foo {
private List<A> a = …;
void bar() { new B().b(); }
}

41

package org.jenkinsci.foo;
import hidden.org.acme.A;
import hidden.org.acme.B;
class Foo {
private List<A> a = …;
void bar() { new B().b(); }
}

42

• 事後に
– maven-shade-plugin

• 事前に
– 予めリネームしたやつをjarにパッケージしてお
く


43

うまくいかない場合もある
• 文字列操作でパッケージ名をいじっている
• META-INF/…
• モジュールの公開APIから参照されている


44



45

ありがちなパターン
class Foo {
static final Foo INSTANCE = new Foo();
…
}
class Bar {
void bar() {
doSomethingWith(Foo.INSTANCE);
}
}

46

逆立ちしたって無理！
class Foo {
static Foo getInstance() { … }
}

class Bar {
void bar() {
}
}


47


48

書き換え方
class Foo {
@AdaptField(name=“INSTANCE”)
}

Barのロード時に
書き換え

class Bar {
void bar() {
}
}

49

Bytecode Compatibility Transformer bit.ly/b-c-t
class Foo {
@AdaptField(name=“INSTANCE”)
}
foo.jar

Foo.class

変換
定義


50

Bytecode Compatibility Transformer bit.ly/b-c-t
• 実行時
– 変換定義 → byte[] transform(byte[] classFile)

独自class loader

foo.jar

bar.jar

変換
定義


51

思わぬ落とし穴が！


52

思わぬ落とし穴
class Foo {
static Foo INSTANCE;
}
class Bar extends Foo {
void m() {
System.out.println(INSTANCE);
}
Bar#INSTANCE
}

53

プログラム変換の利点
• 思い切った書き換え
• 予期しない変更に対応


54

プログラム変換の欠点
• 独自のクラスローダが必要


55

http://commons.wikimedia.org/wiki/File:Light_Bulb.jpg

56

一分で学ぶInvokedynamic
• Java7の新しい機能
• 実行時リンク
• 静的リンクと同じ速度
void foo() {
＋リンカの為の追
int x = 5;
加情報
String y = “hello”;
Object o = intとstringからObjectを返す何か(x,y)
return o;
}
＋リンカの名前

57

http://no-more-tears.kohsuke.org/

class Foo {
void foo() {
Project p = new Project();
Future<Build> f = p.scheduleBuild();
Build b = f.get();
…
}
}


58

ビルド時にinvokedynamicに置き換え
new Project()

class Foo {
Project.scheduleBuild()
void foo() {
Project p = [void→Project](this);
Future<Build> f = [Project→Future] (p);
Build b = [Future → Build](f);
…
Future.get()
}
}


59

実行時に適宜書き換え

class Foo {
void foo() {
Project p = Project.create();
Future<Build> f = p.scheduleBuild(0);
Build b = f.value;
…
}
}


60

まとめ

互換性とコードの進化は両立できる


61

コードの互換性と進化の両立

More Related Content

コードの互換性と進化の両立

Editor's Notes