こわくないソースコードリーディング生活 / JJUG CCC 2019 Fall

1 こわくないソースコードリーディング生活 JJUG CCC 2019 Fall #ccc_c5 Acroquest Technology株式会社
進藤遼 (@shindo_ryo) Copyright © Acroquest Technology Co., Ltd. All rights reserved.

自己紹介 • 進藤遼 • Acroquest Technology株式会社 • 日本Springユーザ会スタッフ
• Twitter: @shindo_ryo • Spring / JUnit 5 / Microservices • 最近はエンプラ系システムでアーキテクチャ設計やったり Goで分散トレーシングやったり。 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 2

Acroquestのミッション・ビジョン Copyright © Acroquest Technology Co., Ltd. All rights reserved.
3 テクノロジストチームとしてビジネスの革新的価値創出に挑戦するビジョン Acroquestの創り出す技術で地球を感動で進化させるミッション

Copyright © Acroquest Technology Co., Ltd. All rights reserved. 5
Q.

他人が書いたコード読んだことがある人？

OSSライブラリのコード読んだことがある人？

Webフレームワークのコード読んだことがある人？はじめに

9 https://github.blog/2018-11-08-100m-repos/ 増え続けるOSSリポジトリ

GitHubは優れたコードが集まる宝石箱

いまどきこれらのOSSのコードを読めないエンジニアがいるんですか？

はい、僕です

OSSのソースコードを読むのはハードルが高い …ホントに？

OSSのソースコードを読むのはハードルが高い高い気がする

読み方を知ればソースコードリーディングはこわくない

一歩ずつ、コードを読めるようになればいい

はじめに • このセッションの対象者 ➢ OSSのソースコードを読んだことが無い ➢ 読んだことはあるがいまいち理解できない • このセッションの目的 ➢
ソースコードを読むことへのハードルを下げる ➢ ソースコードを効率的に学べるようになる Copyright © Acroquest Technology Co., Ltd. All rights reserved. 17

アジェンダ • STEP 1: ソースコードを開こう！ • STEP 2: ライブラリのコードを読もう！ •
STEP 3: 構造を読み解こう！ • Appendix: ソースコードリーディングは心がジーンとする Copyright © Acroquest Technology Co., Ltd. All rights reserved. 18

STEP 1 ライブラリのコードを読もう！ Copyright © Acroquest Technology Co., Ltd. All
rights reserved. 19

STEP 1: ソースコードを開こう！ • 例えばこんなコードがあったりする・・・ Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 20 if (StringUtils.isEmpty("")) { System.out.println("JJUG CCC 2019 Fall"); } Apache Commons の org.apache.commons.lang3.StringUtils

そもそもコード読むのに何を使ってますか？ 0. はじめに

STEP 1: ソースコードを開こう！ • ソースコードを読む手段 ① IDE ←オススメ – Eclipse
/ IntelliJ IDEA / NetBeans … お好きなもので – マウスオーバーで変数や引数の型を確認したり、 Ctrl + 左クリックで型ジャンプができる ② GitHub – ソースコードを取得する必要がないので手軽 – 複数のファイルの行ったり来たりしようとすると、途端に辛くなる（特にパッケージ階層をまたがると辛い） ③ テキストエディタ – 止めはしない。 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 22

STEP 1: ソースコードを開こう！ • ソースコードを取得する方法 ① Maven or Gradleで *-sources.jar
をDL – IDEだとクリックだけで簡単にダウンロードできる – 使っているバージョンと正確に一致したソースコードを確認できる – 自分が書いたコードからライブラリのコードに直接ジャンプできる ② git clone – ソースコードだけでなく、READMEやテストコードも取れる – 大きなリポジトリは大体git cloneで取ってきてます – 別バージョンのソースコードを取ってこないように注意 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 23

STEP 1: ソースコードを開こう！ • 再掲 Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 24 if (StringUtils.isEmpty("")) { System.out.println("JJUG CCC 2019 Fall"); } Apache Commons の org.apache.commons.lang3.StringUtils

STEP 1: ソースコードを開こう！ Copyright © Acroquest Technology Co., Ltd. All
rights reserved. 25 Q. このメソッドの中身はどうなっているでしょうか？

rights reserved. 26 public static boolean isEmpty(final CharSequence cs) { return cs == null || cs.length() == 0; } A.

rights reserved. 27 public static boolean isEmpty(final CharSequence cs) { return cs == null || cs.length() == 0; } 引数のcsがnull またはcsの長さが0

rights reserved. 28 こんな簡単なコードから始めるの？って思いました？

rights reserved. 29 ここから始めます

STEP 1: ソースコードを開こう！ • ライブラリのソースコードを読むことはハードル高くない ➢ 大部分のコードは、１行１行は難しいこと書いてない ➢ Javaの文法と基本的なAPIを抑えていれば、Apache Commons
程度であれば大体読める ➢ きちんとしたライブラリであればJavadocに仕様はちゃんと書いてある Copyright © Acroquest Technology Co., Ltd. All rights reserved. 30

STEP 1: ソースコードを開こう！ • なぜソースコードリーディングを難しく感じるのか • 多重知能理論 • 言語的知能 •
論理数学的知能 • 音楽的知能 • 身体運動的知能 • 空間的知能 • 対人的知能 • 内省的知能 • 博物的知能 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 31 http://www.nichinoken.co.jp/np5/nnk/multiple_intelligences/mi/mi.html

STEP 1: ソースコードを開こう！ • ソースコードリーディングは知識・論理・読解の複合スキル • 知識・・・ CS、Web、API、etc… •
論理・・・ロジック、アルゴリズムの理解 • 読解・・・文法の適用、文脈を理解して適度に必要のない情報を無視する (英語力も？) Copyright © Acroquest Technology Co., Ltd. All rights reserved. 32 知識論理読解ソースコードリーディング

rights reserved. 33 ソースコードリーディング＝スキル

rights reserved. 34 スキルはトレーニングによって身に付く

STEP 1: ソースコードを開こう！ • トレーニングの成果は負荷(質)と量によって決まる • 簡単なコードだけを大量に読んでも負荷がかからない • 難しすぎるコードも、全く理解できなければ負荷にならない Copyright
© Acroquest Technology Co., Ltd. All rights reserved. 35

rights reserved. 36 最初は誰でもつまづく

rights reserved. 37 知らなかったことを知る読めなかったものが読めるようになる

rights reserved. 38 それが成長

STEP 2 ライブラリのコードを読もう！ Copyright © Acroquest Technology Co., Ltd. All
rights reserved. 39

STEP 2: ライブラリのコードを読もう！ • コードを読む上で大事なこと 1. 目的、目標を設定する (重要) ➢ これがないと読むべきところ、読み飛ばして良いところの区別がつかない
2. 深く掘り下げすぎない ➢ 記憶はスタック構造。詳細を見すぎると全体像を見失う 3. クラスの使い方を把握する ➢ Hello worldで良いので、どんな機能か、呼び出し元はどう書くかを調べる 4. 名前に注意する ➢ クラス名・変数名・メソッド名の意味を理解することで仕様を理解する Copyright © Acroquest Technology Co., Ltd. All rights reserved. 40

STEP 2: ライブラリのコードを読もう！ • Commons DBUtils • 軽量なRDBアクセスライブラリ • 生JDBCドライバを使ったコードに比べて
簡潔に記述することができる • QueryRunnerクラスのquery(), insert(), update() といったメソッドを呼び出し、ResultSetHandlerインタフェース（とその実装クラス）を使って結果を特定の型にマッピングする。 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 41

STEP 2: ライブラリのコードを読もう！ • 読むのは以下のコード Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 42 DataSource ds = … QueryRunner queryRunner = new QueryRunner(ds); List<User> result = queryRunner.query( "SELECT * FROM users;", new BeanListHandler<>(User.class)); RDBへの接続を作るファクトリ。大抵の場合コネクションプール。 usersテーブルからデータを取得して、各レコードをUser型に変換したリストを作成する。

STEP 2: ライブラリのコードを読もう！ • 目標を設定する ✓ QueryRunnerがJDBCとどう連携しているかを理解する ✓ コネクションをいつ取得して、いつクローズしているかを確認する ✓
usersテーブルの”first_name“をUserクラスの”firstName”にマッピングできるかどうかを調べる Copyright © Acroquest Technology Co., Ltd. All rights reserved. 43 これを目標にしてソースコードの読解を進める

STEP 2: ライブラリのコードを読もう！ Copyright © Acroquest Technology Co., Ltd. All
rights reserved. 46 ＿人人人人＿＞無視＜￣Y^Y^Y^￣

STEP 2: ライブラリのコードを読もう！ • コードは読み飛ばしていい • 最初から細かいところまで全部読んで、記憶のスタックを使い果たすくらいなら、目標と関係ないところは読み飛ばしたほうがマシ • コードリーディングは、コードの意図や構造を理解する営み。
一字一句音読するものではない。 • 「全部読め」派も特に否定はしないです Copyright © Acroquest Technology Co., Ltd. All rights reserved. 47

Ltd. All rights reserved. 49 stmt = this.prepareStatement(conn, sql); this.fillStatement(stmt, params); rs = this.wrap(stmt.executeQuery()); result = rsh.handle(rs); PreparedStatementの作成 SQSにクエリパラメータをセットクエリを実行 <T> 型 ResultSetを <T>型の変数に変換

STEP 2: ライブラリのコードを読もう！ • BeanListHandler Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 51 public class BeanListHandler<T> implements ResultSetHandler<List<T>> { private final Class<? extends T> type; private final RowProcessor convert; public BeanListHandler(Class<? extends T> type) { this(type, ArrayHandler.ROW_PROCESSOR); } @Override public List<T> handle(ResultSet rs) throws SQLException { return this.convert.toBeanList(rs, type); } Bean変換は convert が行っている。 convertの中身は BasicRowProcessor

STEP 2: ライブラリのコードを読もう！ • BeanProcessor Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 52 public <T> List<T> toBeanList(ResultSet rs, Class<? extends T> type) throws SQLException { List<T> results = new ArrayList<T>(); if (!rs.next()) { return results; } PropertyDescriptor[] props = this.propertyDescriptors(type); ResultSetMetaData rsmd = rs.getMetaData(); int[] columnToProperty = this.mapColumnsToProperties(rsmd, props); do { results.add(this.createBean(rs, type, props, columnToProperty)); } while (rs.next()); return results; } BasicRowProcessorのtoBeanList(rs, type)は BeanProcessorに処理を移譲するだけ PropertyDescriptorはBeanのプロパティをgetter/setter経由でアクセスするためのクラス

STEP 2: ライブラリのコードを読もう！ • BeanProcessor Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 53 public <T> List<T> toBeanList(ResultSet rs, Class<? extends T> type) throws SQLException { List<T> results = new ArrayList<T>(); if (!rs.next()) { return results; } PropertyDescriptor[] props = this.propertyDescriptors(type); ResultSetMetaData rsmd = rs.getMetaData(); int[] columnToProperty = this.mapColumnsToProperties(rsmd, props); do { results.add(this.createBean(rs, type, props, columnToProperty)); } while (rs.next()); return results; } BasicBeanProcessorのtoBeanList(rs, type)は BeanProcessorに処理を移譲するだけ結果セットのカラム名を取得するここが怪しい

STEP 2: ライブラリのコードを読もう！ • BeanProcessor#mapColumnsToProperties(…) ➢ JavaDocも読んで見る ◆ 戻り値の配列 (int配列)
の位置はカラム番号を表します。各位置に格納されてる値は、そのカラム名に対応したBeanプロパティの PropertyDescriptor[]の位置を表します。カラムに対応するBean プロパティが存在しない場合は、その位置には PROPERTY_NOT_FOUND (-1) がセットされます。 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 55 戻り値のint配列に値がセットされているところを見れば、対応付けの方法がわかりそう

STEP 2: ライブラリのコードを読もう！ • 結論 ➢ 元のコードでは、“first_name”を”firstName”にマッピングしてくれない。 ➢ BeanProcessorのcolumnToPropertyOverrides
で”first_name”と”firstName”の対応を指定すればマッピングできそう。 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 59 Commons DBUtils完全にマスターした

STEP 3 構造を読み解こう！ Copyright © Acroquest Technology Co., Ltd. All
rights reserved. 60

STEP 3: 構造を読み解こう！ Copyright © Acroquest Technology Co., Ltd. All
rights reserved. 61 Webフレームワークのソースコード、読みたくなりません？読みたいですよね？

rights reserved. 62 でもJavaのWebフレームワークって大体10KL以上で読むの辛いし多機能すぎるし・・・

rights reserved. 63 そこでですよ

STEP 3: 構造を読み解こう！ • Javalin • シンプル・軽量なWebフレームワーク • Jettyを内包しており、single jarで動作する
• WebSocket, バリデーション、Server-Sent Eventsなど基本的な機能は一通りそろっている • JavaだけでなくKotlinも混ざっているけどキニシナイ！ Copyright © Acroquest Technology Co., Ltd. All rights reserved. 64

STEP 3: 構造を読み解こう！ • Java Servlet (Jakarta Servlet) • JavaでWebアプリケーションをつくるための仕様
(と作成されたプログラム) • HttpServletクラスを継承し、doGet/doPost/doPut/… メソッドに HTTPリクエストを受け付けた際の処理を書く • Servletを動作させるにはサーブレットコンテナ(Tomcat, Jetty, etc…)が必要 • Jetty • サーブレットコンテナの一種 • Tomcatに比べてサイズが小さく起動が早い Copyright © Acroquest Technology Co., Ltd. All rights reserved. 65

STEP 3: 構造を読み解こう！ • コードを読む上で大事なこと (再掲) 1. 目的、目標を設定する ➢ これがないと読むべきところ、読み飛ばして良いところの区別がつかない
2. 深く掘り下げすぎない ➢ 記憶はスタック構造。詳細を見すぎると全体像を見失う 3. クラスの使い方を把握する ➢ Hello worldで良いので、どんな機能か、呼び出し元はどう書くかを調べる 4. 名前に注意する ➢ クラス名・変数名・メソッド名の意味を理解することで仕様を理解する Copyright © Acroquest Technology Co., Ltd. All rights reserved. 66

STEP 3: 構造を読み解こう！ • コードを読む上で大事なこと② 1. 型を強く意識する ➢ 各クラス・インタフェースの役割を把握することで、クラス間の関係が非常に理解しやすくなる
2. メモする ➢ 大きなコードを読むときに現在位置を把握しておく 3. ドキュメント、Javadocをよく読む ➢ 仕様だけでなく実装の解説も書いてあったりする Copyright © Acroquest Technology Co., Ltd. All rights reserved. 67

STEP 3: 構造を読み解こう！ • JavalinでシンプルなWebアプリケーション Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 68 Javalin.create() .get("/hello", ctx -> ctx.result("Hello, World!")) .start(); たった３行でWebアプリケーションの起動ができる

STEP 3: 構造を読み解こう！ • まずはJavadocを読む Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 69 Javalin.create() .get("/hello", ctx -> ctx.result("Hello, World!")) .start(); Javalinインスタンスの生成 /hello にハンドラを登録サーバーの起動

STEP 3: 構造を読み解こう！ • 上から順に読み進めていく Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 70 Javalin.create() .get("/hello", ctx -> ctx.result("Hello, World!")) .start(); まずは全体像の理解から進める。 ※各メソッドで深追いしすぎないように注意

STEP 3: 構造を読み解こう！ • Javalin#create() Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 71 public static Javalin create() { return create(JavalinConfig.noopConfig); } public static Javalin create(Consumer<JavalinConfig> config) { Javalin app = new Javalin(); JavalinConfig.applyUserConfig(app, app.config, config); if (app.config.logIfServerNotStarted) { Util.logIfServerNotStarted(app.server); } return app; }

STEP 3: 構造を読み解こう！ • Javalin コンストラクタ Copyright © Acroquest Technology
Co., Ltd. All rights reserved. 72 protected JavalinServer server; protected JavalinWsServlet wsServlet; protected JavalinServlet servlet = new JavalinServlet(config); protected Javalin() { this.server = new JavalinServer(config); this.wsServlet = new JavalinWsServlet(config); } サーバーっぽい何か Servletっぽい何か WebSocketっぽいので一旦無視

STEP 3: 構造を読み解こう！ • Javalin#get(…) Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 74 public Javalin get(@NotNull String path, @NotNull Handler handler) { return addHandler(HandlerType.GET, path, handler); } public Javalin addHandler(@NotNull HandlerType handlerType, @NotNull String path, @NotNull Handler handler, @NotNull Set<Role> roles) { servlet.addHandler(handlerType, path, handler, roles); eventManager.fireHandlerAddedEvent( new HandlerMetaInfo(handlerType, Util.prefixContextPath(servlet.getConfig().contextPath, path), handler, roles)); return this; } ラムダ式はHandler型のインスタンスになる JavalinServlet#addHandlerに移譲イベントハンドラに発火とりあえず無視

STEP 3: 構造を読み解こう！ • もう一段深く読み込む ✓ JavalinServlet#addHandler(…)を呼び出したあと、ハンドラはどんなデータ構造で保持されている？ ✓ HTTPリクエストが来たとき、ハンドラはどうやって呼び出されている？

rights reserved. 80 ※ちなみにここからKotlinのコードが混ざり始めます僕も文法ちゃんと覚えてないからヘーキヘーキ

STEP 3: 構造を読み解こう！ • JavalinServlet.kt Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 81 fun addHandler(handlerType: HandlerType, path: String, handler: Handler, roles: Set<Role>) { val shouldWrap = handlerType.isHttpMethod() && !roles.contains(CoreRoles.NO_WRAP) val protectedHandler = if (shouldWrap) Handler { ctx -> config.inner.accessManager.manage(handler, ctx, roles) } else handler matcher.add(HandlerEntry(handlerType, path, protectedHandler, handler)) } 1, 2行目はアクセス制御 PathMatcher HandlerEntryはpathとhandler をセットにしたクラス

STEP 3: 構造を読み解こう！ • PathMatcher.kt Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 82 fun add(entry: HandlerEntry) { if (entry.type.isHttpMethod() && handlerEntries[entry.type]!!.find { it.type == entry.type && it.path == entry.path } != null) { throw IllegalArgumentException("Handler with type='${entry.type}’ and path='${entry.path}' already exists.") } handlerEntries[entry.type]!!.add(entry) } 同じパスに対して複数のハンドラが登録されたら例外を投げる private val handlerEntries = HandlerType.values().associateTo( EnumMap<HandlerType, ArrayList<HandlerEntry>>(HandlerType::class.java)) { it to arrayListOf() }

STEP 3: 構造を読み解こう！ • handlerEntriesのデータ構造 handlerEntries: GET: [{path: ”/hello”, handler:
…}, {path: “/bye”, handler: …}], POST: [{path: “/echo”, handler: …}], PUT: … … Copyright © Acroquest Technology Co., Ltd. All rights reserved. 83 HTTPメソッド + αがkey List<HandlerEntry>がvalue

STEP 3: 構造を読み解こう！ • もう一段深く読み込む ✓ JavalinServlet#addHandler(…)を呼び出したあと、ハンドラはどんなデータ構造で保持されている？ ➢ ハンドラのリストが、HandlerTypeをキーとしたMapの
Valueに格納されている ✓ HTTPリクエストが来たとき、ハンドラはどうやって呼び出されている？ Copyright © Acroquest Technology Co., Ltd. All rights reserved. 84

STEP 3: 構造を読み解こう！ • JavalinServer.kt Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 87 ServletContextHandlerはServletHandlerや SessionHandlerなどを集約したJettyのクラス ServletContextHandlerの匿名クラス “/*” で全てのパスに対して、 JavalinServletを登録している

Ltd. All rights reserved. 90 fun tryBeforeAndEndpointHandlers() = tryWithExceptionMapper { (中略) matcher.findEntries(type, requestUri).firstOrNull()?.let { entry -> entry.handler.handle( ContextUtil.update(ctx, entry, requestUri)) return@tryWithExceptionMapper // return after first match } serviceメソッドから抜粋

Ltd. All rights reserved. 91 fun tryBeforeAndEndpointHandlers() = tryWithExceptionMapper { (中略) matcher.findEntries(type, requestUri).firstOrNull()?.let { entry -> entry.handler.handle( ContextUtil.update(ctx, entry, requestUri)) return@tryWithExceptionMapper // return after first match } PathMatcher handlerEntriesを保持

Ltd. All rights reserved. 92 fun tryBeforeAndEndpointHandlers() = tryWithExceptionMapper { (中略) matcher.findEntries(type, requestUri).firstOrNull()?.let { entry -> entry.handler.handle( ContextUtil.update(ctx, entry, requestUri)) return@tryWithExceptionMapper // return after first match } Type (HTTPメソッド) とURLにマッチするHandlerEntryを探索 fun findEntries(handlerType: HandlerType, requestUri: String) = handlerEntries[handlerType]!!.filter { he -> match(he, requestUri) } 線形に探索している

Ltd. All rights reserved. 93 fun tryBeforeAndEndpointHandlers() = tryWithExceptionMapper { (中略) matcher.findEntries(type, requestUri).firstOrNull()?.let { entry -> entry.handler.handle( ContextUtil.update(ctx, entry, requestUri)) return@tryWithExceptionMapper // return after first match } Handlerの実行

余談 • Sourcetrail • Coati Softwareが開発するコードエクスプローラ • 数日前にオープンソース化された •
クラスの依存関係、呼び出し階層などをグラフィカルに表示できる • これを使うとコード読むのが捗るかも？ Copyright © Acroquest Technology Co., Ltd. All rights reserved. 98 https://www.sourcetrail.com/

102 コードをたくさん読むことで良いコードの審美眼を鍛える

103 良いコードを書くには良いコードを読むことが早道

こわくないソースコードリーディング生活 / JJUG CCC 2019 Fall

こわくないソースコードリーディング生活 / JJUG CCC 2019 Fall

Transcript

More Decks by Ryo Shindo

Other Decks in Programming

Featured