失敗から学ぶAPI設計  #ccc_h4 #jjug #jjug_ccc JJUG CCC 2013 Spring
Upcoming SlideShare
Loading in...5
×
 

失敗から学ぶAPI設計 #ccc_h4 #jjug #jjug_ccc JJUG CCC 2013 Spring

on

  • 12,747 views

 

Statistics

Views

Total Views
12,747
Views on SlideShare
10,950
Embed Views
1,797

Actions

Likes
66
Downloads
68
Comments
0

20 Embeds 1,797

http://samuraism.jp 679
http://defenceless.org 227
https://twitter.com 224
http://mike-neck.github.io 224
http://taityo-diary.hatenablog.jp 223
http://makopi23.blog.fc2.com 154
http://maitani.personal.development.shinobi.vpn 18
http://admin.blog.fc2.com 12
http://cockerels11.rssing.com 9
http://s.deeeki.com 9
http://translate.googleusercontent.com 3
http://cloud.feedly.com 3
http://cockerels11.nazata.com 2
http://freerss.net 2
http://tweetedtimes.com 2
http://webcache.googleusercontent.com 2
http://localhost 1
https://www.google.co.jp 1
http://www.feedspot.com 1
https://web.tweetdeck.com 1
More...

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

CC Attribution License

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

失敗から学ぶAPI設計  #ccc_h4 #jjug #jjug_ccc JJUG CCC 2013 Spring 失敗から学ぶAPI設計 #ccc_h4 #jjug #jjug_ccc JJUG CCC 2013 Spring Presentation Transcript

  • YusukeYamamoto失敗から学ぶAPI設計山本 裕介@yusuke #ccc_h4
  • YusukeYamamoto前回までのあらすじ
  • YusukeYamamoto前回までのあらすじNo GGRKS!使ってもらうためにはどんな汚いことでもする対象プラットフォームを増やす外部ライブラリ非依存
  • YusukeYamamoto•Twitter APIのJavaラッパ•開発は2007年5月∼
  • YusukeYamamotoTwitter4Jは•再利用されているライブラリhttps://wiki.fitbit.com/display/API/API+Java+Client
  • YusukeYamamotoTwitter4Jは•再利用されているライブラリhttp://code.google.com/p/weibo4j/
  • YusukeYamamotoTwitter4Jは•再利用されているライブラリhttp://facebook4j.org
  • YusukeYamamotoTwitter4Jは•イイライブラリ
  • YusukeYamamotoTwitter4Jは•イイライブラリとは
  • YusukeYamamotoTwitter4Jは•イイライブラリとは• 優れたコストパフォーマンス• 機能が豊富• 品質が高い
  • YusukeYamamotoTwitter4Jは•イイライブラリ• 多くのユーザーが使っている• コミュニティが活発• 拡張しやすい• 使いやすい
  • YusukeYamamotoTwitter4Jは•イイライブラリ• 多くのユーザーが使っている• コミュニティが活発• 拡張しやすい• 使いやすい API・設計
  • YusukeYamamotoAPIとは• Application Programming Interface•何らかの機能を呼び出す口
  • YusukeYamamotoTwitter4JのAPIは•Twitter APIの射影
  • YusukeYamamotoTwitter4JのAPIは•Twitter APIの射影•現在のところ対象外• キャッシング・永続化• フレームワーク的なこと
  • YusukeYamamotoTwitter4J実装の変遷• バージョン1.0• Twitter APIのXMLのエンドポイント利用• バージョン2.0• OAuthサポート• domオブジェクトを保持しなくなった
  • YusukeYamamotoTwitter4J実装の変遷• バージョン2.1• 非推奨クラス、メソッドをバッサリ• Factoryの導入• バージョン2.2• Basic認証廃止• ライセンスをBSDからASLに変更
  • YusukeYamamotoTwitter4J実装の変遷• バージョン3.0• Twitter API 1.1対応
  • YusukeYamamotoTwitter4Jの開発指針
  • YusukeYamamotoシンプルに
  • YusukeYamamotoシンプルにYAGNI
  • YusukeYamamotoシンプル・YAGNI•クラス数は極力少なく
  • YusukeYamamotoシンプル・YAGNI•クラス数は極力少なく•インターフェースは(なるべく)使わない!
  • YusukeYamamotoシンプル・YAGNI•拡張ポイントはなるべく少なく
  • YusukeYamamoto(なるべく)immutableに
  • YusukeYamamotoTwitter4Jの拡張ポイント•クラス継承はさせない• 基本finalにして継承を防ぐ• 副作用を生まずに継承を許す設計はすごく難しい•strategyパターンとか言語道断(一部除く)
  • YusukeYamamotoシンプル・YAGNI•Twitter4Jの拡張ポイント• HTTP認証• 非同期ディスパッチャ• ロガー• HTTPクライアント
  • YusukeYamamotoシンプル・YAGNI•Twitter4Jの拡張ポイント• HTTP認証• 非同期ディスパッチャ• ロガー• HTTPクライアントほとんどのデベロッパは拡張しない
  • YusukeYamamotoデザインパターンを適用
  • YusukeYamamotoデザインパターンを適用しない
  • YusukeYamamotoデザインパターンを適用しないTwitter twitter = new Twitter();List<Status> statuses= twitter.getPublicTimeline();for(Status status : statuses){System.out.println(status.getText());}多くのプログラマはFactoryとかわからないまずはコンクリートコンストラクタで。
  • YusukeYamamotoIDEの補完を活かせるように
  • YusukeYamamotoIDEの補完を活かせるようにhttp://www.youtube.com/watch?v=Nk9CUxEuUww補完の例
  • YusukeYamamotoIDEの補完を活かせるように•なるべく同一パッケージに•一般的過ぎるクラス名にしない
  • YusukeYamamotoIDEの補完が活きすぎないように• 使うべきでないクラス名を異様にする•z_T4JInternal******
  • YusukeYamamotoTwitter4Jの成長
  • YusukeYamamotoシンプルなTwitter4J32 KB
  • YusukeYamamotoシンプルだったTwitter4J5.1 MB32 KB
  • YusukeYamamoto互換性維持の苦労
  • YusukeYamamoto互換性維持の苦労•APIが増える•レスポンススキーマが変わる•ステータスコードが変わる•いつの間にか要素が増えてる•認証方式が変わる•エンドポイントURLが変わる...
  • YusukeYamamotoTwitter4Jの成長•Twitter APIの成長•Twitter4Jの成長• 膨らむクラス数• 膨らむメソッド数• 膨らむアクセサ数
  • YusukeYamamotoTwitter4Jの成長•至上命題互換性の維持
  • YusukeYamamoto互換性のために大事なこと•クラス名を変えない
  • YusukeYamamoto互換性のために大事なこと•メソッド名を変えない
  • YusukeYamamoto互換性のために大事なこと•挙動を変えない
  • YusukeYamamoto互換性のために大事なこと•直列化形式の互換性を保つ
  • YusukeYamamoto互換性のために大事なこと• 直列化形式の互換性を保つJava Object Serialization SpecificationVersioning of Serializable Objects5.6.1 Incompatible Changes5.6.2 Compatible Changeshttp://docs.oracle.com/javase/7/docs/platform/serialization/spec/version.html#6678• 現在の所テストケースはなく「気をつける」だけで互換性を保っている
  • YusukeYamamoto互換性のために大事なこと• 非互換はコンパイラに検出させる
  • YusukeYamamoto互換性を維持できた例•User.java• ユーザー情報•UserWithStatus.java• ユーザー情報+αExtended user information with statusUser information
  • YusukeYamamoto互換性を維持できた例class User{}class UserWithStatus extends User{getFriendsCount();getFollowersCount();}バージョン1.0
  • YusukeYamamoto互換性を維持できた例class User{getFriendsCount();getFollowersCount();}/** @deprecated */class UserWithStatus extends User{}バージョン1.0.4getterを上位クラスに移動
  • YusukeYamamoto互換性を維持できた例class User{getFriendsCount();getFollowersCount();}/** @deprecated */class UserWithStatus extends User{}バージョン1.0.4UserWithStatusは非推奨、コンパイラが警告
  • YusukeYamamoto互換性を維持できた例class User{getFriendsCount();getFollowersCount();}/** @deprecated */class UserWithStatus extends User{}バージョン2.0UserWithStatusを廃止、コンパイラがエラーを出す
  • YusukeYamamotoTwitter4Jの失敗
  • YusukeYamamotoTwitter4Jの失敗•パッケージ分けの失敗•API設計の失敗
  • YusukeYamamotoパッケージ分けの失敗•パッケージ分け• twitter4j.*• twitter4j.api.*• twitter4j.auth.*• twitter4j.management.*• twitter4j.internal.*
  • YusukeYamamotoパッケージ分けの失敗•パッケージ分けしすぎると• クラスが見つけられない• 特に貧弱なエディタを使っている場合• blogのコード例をコピペしても動かない• import部分の記載がないことが多い• JavaDocの読み方がわからないプログラマは非常に多い
  • YusukeYamamotoパッケージ分けの失敗•下手にパッケージ分けすると• 言語使用上仕方なくpublicなクラスが使われてしまうこのパッケージはあのパッケージに対してのみ公開、とかできるといいが少なくともJavaではできない。
  • YusukeYamamoto解決策• コードの見通しの問題であればパッケージ分けしない• かわりにソースディレクトリを分ける• クラス可視性はpackage privateで
  • YusukeYamamotomavenでソースディレクトリの分ける設定<plugin><groupId>org.codehaus.mojo</groupId><artifactId>build-helper-maven-plugin</artifactId><executions><execution><id>add-source</id><phase>generate-sources</phase><goals><goal>add-source</goal></goals><configuration><sources><source>internal-json</source><source>internal-async</source></sources></configuration></execution></executions></plugin>
  • YusukeYamamotoAPI設計の失敗Twitter twitter = new Twitter();
  • YusukeYamamotoAPI設計の失敗•コンクリートコンストラクタ•ユーザーにはわかりやすい•が、モックテストしづらいTwitter twitter = new Twitter();
  • YusukeYamamotoAPI設計の失敗• Twitterをクラスからインターフェースへ• Factoryを導入• Twitterインターフェースを実装したモックを作れるTwitter twitter= new TwitterFactory().getInstance();
  • YusukeYamamotoAPI設計の失敗• やはりFactoryパターンは難しい• Singletonを返すstaticメソッドを導入• あまり知られていない、使われていないTwitter twitter= TwitterFactory.getSingleton();
  • YusukeYamamoto参考図書•Effective Java
  • YusukeYamamoto参考図書•Practical API Design
  • YusukeYamamoto#ccc_h4 #q?