失敗から学ぶAPI設計 #ccc_h4 #jjug #jjug_ccc JJUG CCC 2013 Spring
- 11. YusukeYamamoto Twitter4Jは •イイライブラリ • 多くのユーザーが使っている • コミュニティが活発 • 拡張しやすい • 使いやすい
- 12. YusukeYamamoto Twitter4Jは •イイライブラリ • 多くのユーザーが使っている • コミュニティが活発 • 拡張しやすい • 使いやすい API・設計
- 13. YusukeYamamoto APIとは • Application Programming Interface •何らかの機能を呼び出す口
- 16. YusukeYamamoto Twitter4J実装の変遷 • バージョン1.0 • Twitter APIのXMLのエンドポイント利用 • バージョン2.0 • OAuthサポート • domオブジェクトを保持しなくなった
- 17. YusukeYamamoto Twitter4J実装の変遷 • バージョン2.1 • 非推奨クラス、メソッドをバッサリ • Factoryの導入 • バージョン2.2 • Basic認証廃止 • ライセンスをBSDからASLに変更
- 18. YusukeYamamoto Twitter4J実装の変遷 • バージョン3.0 • Twitter API 1.1対応
- 27. YusukeYamamoto シンプル・YAGNI •Twitter4Jの拡張ポイント • HTTP認証 • 非同期ディスパッチャ • ロガー • HTTPクライアント
- 28. YusukeYamamoto シンプル・YAGNI •Twitter4Jの拡張ポイント • HTTP認証 • 非同期ディスパッチャ • ロガー • HTTPクライアント ほとんどのデベロッパは拡張しない
- 31. YusukeYamamoto デザインパターンを適用しない Twitter twitter = new Twitter(); List<Status> statuses = twitter.getPublicTimeline(); for(Status status : statuses){ System.out.println(status.getText()); } 多くのプログラマはFactoryとかわからない まずはコンクリートコンストラクタで。
- 41. YusukeYamamoto Twitter4Jの成長 •Twitter APIの成長 •Twitter4Jの成長 • 膨らむクラス数 • 膨らむメソッド数 • 膨らむアクセサ数
- 47. YusukeYamamoto 互換性のために大事なこと • 直列化形式の互換性を保つ Java Object Serialization Specification Versioning of Serializable Objects 5.6.1 Incompatible Changes 5.6.2 Compatible Changes http://docs.oracle.com/javase/7/docs/platform/serialization/spec/version.html#6678 • 現在の所テストケースはなく「気をつける」だけ で互換性を保っている
- 49. YusukeYamamoto 互換性を維持できた例 •User.java • ユーザー情報 •UserWithStatus.java • ユーザー情報+α Extended user information with status User information
- 50. YusukeYamamoto 互換性を維持できた例 class User{} class UserWithStatus extends User{ getFriendsCount();getFollowersCount(); } バージョン1.0
- 51. YusukeYamamoto 互換性を維持できた例 class User{ getFriendsCount();getFollowersCount(); } /** @deprecated */ class UserWithStatus extends User{ } バージョン1.0.4 getterを上位クラスに移動
- 52. YusukeYamamoto 互換性を維持できた例 class User{ getFriendsCount();getFollowersCount(); } /** @deprecated */ class UserWithStatus extends User{ } バージョン1.0.4 UserWithStatusは非推奨、コンパイラが警告
- 53. YusukeYamamoto 互換性を維持できた例 class User{ getFriendsCount();getFollowersCount(); } /** @deprecated */ class UserWithStatus extends User{ } バージョン2.0 UserWithStatusを廃止、コンパイラがエラーを出す
- 56. YusukeYamamoto パッケージ分けの失敗 •パッケージ分け • twitter4j.* • twitter4j.api.* • twitter4j.auth.* • twitter4j.management.* • twitter4j.internal.*
- 57. YusukeYamamoto パッケージ分けの失敗 •パッケージ分けしすぎると • クラスが見つけられない • 特に貧弱なエディタを使っている場合 • blogのコード例をコピペしても動かない • import部分の記載がないことが多い • JavaDocの読み方がわからないプログラマは非常に多い
- 59. YusukeYamamoto 解決策 • コードの見通しの問題であればパッケー ジ分けしない • かわりにソースディレクトリを分ける • クラス可視性はpackage privateで
- 61. YusukeYamamoto API設計の失敗 Twitter twitter = new Twitter();
- 62. YusukeYamamoto API設計の失敗 •コンクリートコンストラクタ •ユーザーにはわかりやすい •が、モックテストしづらい Twitter twitter = new Twitter();
- 63. YusukeYamamoto API設計の失敗 • Twitterをクラスからインターフェースへ • Factoryを導入 • Twitterインターフェースを実装したモックを作れる Twitter twitter = new TwitterFactory().getInstance();
- 64. YusukeYamamoto API設計の失敗 • やはりFactoryパターンは難しい • Singletonを返すstaticメソッドを導入 • あまり知られていない、使われていない Twitter twitter = TwitterFactory.getSingleton();