/note/tech

AIが生成したコードは読むべきか?抽象化設計とコードの品質保証

要約:

■ 1. 背景: AI製コードを読むべきか

  • AI駆動開発の拡大:
    • AIは短時間でコードを実装するため、人間のレビューが追いつかない
    • AI駆動開発において人間がボトルネックになりつつある
  • ネット上の対立する意見:
    • 読んで理解しないと責任を取れず、デバッグもできないという意見
    • 品質保証の仕組みを作り、読まなくて済むようにするという意見
  • 基本的な立場:
    • コードを全く読まなくてよいわけではない
    • 一方で、適切に設計すれば読む必要性や労力を低減できる
  • リーディングコストを下げる重要な設計:
    • 契約による設計
    • 副作用のない関数
    • 抽象化

■ 2. AIコードを読むべきとされる理由

  • 主な理由:
    • 責任所在、すなわち問題発生時の判断責任
    • もっともらしいが、よく見ると問題のあるコード
    • 脆弱性
    • 動作するが非機能要件を満たしていないコード
    • 古い書き方やチーム方針に合わないコード
    • 期待する正しい結果が得られるか分からないコード
  • 本テーマの対象:
    • 期待する正しい結果が得られるか分からないコードを扱う
    • 正しい結果を得るための設計をしているか、AIにどう指示しているかが問われる

■ 3. 契約による設計

  • 概要:
    • バートランド・メイヤーが考案した設計手法
    • コードの正確性向上に寄与する
  • 3つの条件:
    • 事前条件: メソッド実行前に満たすべき条件
    • 事後条件: メソッド実行後に満たすべき条件
    • 不変条件: インスタンスの生存中、メソッド実行前後で常に満たすべき条件
  • 呼び出し側とメソッド本体の二者間の不安:
    • 呼び出し側は、呼び出した結果がどうなるか分からず不安を抱える
    • メソッド本体は、不正値を渡されると正しく動作できなくなる不安を抱える
  • 契約としての約束:
    • 呼び出し側が事前条件を満たせば、メソッド本体は約束した条件を満たす結果を返す
    • 正しい動作を保証するための条件を双方で約束する
  • BMI計算メソッドの例:
    • 事前条件は身長が0より大きく3m以下、体重が0より大きく700kg以下であること
    • 事後条件は戻り値が体重kg÷(身長m×身長m)であること
    • 事前条件を満たさない引数には例外を投げる形で実装する
  • 不変条件の例:
    • 注文数クラスQuantityの不変条件は「注文数は1個以上20個以下」
    • コンストラクタで範囲外の値を例外として弾く
    • インスタンス変数に関与する条件として設計する
  • 契約による設計の効果:
    • 事前条件と事後条件の設計により、メソッド実行後の正しい結果を保証できる
    • 不変条件の設計により、不正値を防止できる
  • AIへの指示:
    • AIは契約による設計を知っている
    • 契約による設計を指示すれば、正しい動作が保証されたコードをAIに書かせられる

■ 4. テストコードの基準としての契約

  • 3条件はブラックボックステストの基準になる:
    • BMIの例では、体重の事前条件に対して境界値テストを実装できる
  • AIに指示する手順:
    • (1) 契約による設計の3条件を設計する
    • (2) 3条件に基づきテストコードを実装する
    • (3) テストをパスするようにプロダクションコードを実装する
  • 手順の効果:
    • ほぼ100%と言ってよいほど間違えようのないコードをAIに書かせられる

■ 5. 副作用のない関数

  • 正しい結果の保証を困難にする構造:
    • ホテル宿泊料金のサービス料を返すメソッドcalculateServiceChargeの例
    • サービス料計算以外に、消費税計算と宿泊料金への加算もしている
    • 参照型引数、つまり外部の状態を変更している
  • 副作用とは:
    • 関数が引数を受け取り戻り値を返す以外に、外部の状態を変更すること
    • 副作用のある関数は実行結果の予測を困難にする
  • 外部の状態変更の例:
    • インスタンス変数、グローバル変数、参照型引数の変更
    • DBやファイル読み書きなどのI/O操作
  • クラス仕様とクラス実装:
    • クラス仕様は外部から見たクラスの振る舞いであり、契約による設計で設計したものはクラス仕様
    • クラス実装はクラス内部のソースコードで、クラス仕様を具体化したもの
    • 実装から見ると仕様は抽象的な存在
  • 副作用がもたらす問題:
    • 事前条件や事後条件が暗黙的になり、クラス仕様の一部が暗黙化する
    • サービス料の例では、消費税を計算して加算する事後条件が暗黙的になっていた
    • メソッドのシグニチャだけでは何が起こるか分からなくなる
    • 挙動を正確に知るには、メソッド内部の具体コードを読まなければならない
  • 純粋関数としての設計:
    • サービス料計算は料金×0.15を返すだけの、副作用のない純粋関数にする
    • DBへのI/Oなど、副作用を完全になくすことはできない
    • 副作用を隔離した上で、可能な限り純粋関数を設計することが重要
    • immutableなオブジェクトの設計も同様に重要

■ 6. 抽象化

  • 抽象化前の問題:
    • スマホ料金計算コードでは、通話料金計算が他の計算ロジックと混在している
    • 通話料金をどこで計算しているかが分かりにくい
  • 通話料金のクラス化:
    • CallChargeクラスを作り、コンストラクタで0円以上という不変条件を守る
    • ファクトリメソッドcreateで通話時間から料金を計算する
    • 呼び出し側はCallCharge.createを呼ぶだけになり、計算箇所が分かりやすくなる
  • プログラムの抽象化とは:
    • 呼び出し側に通話料金計算の具体処理がなく、抽象的存在を呼び出すだけの状態
    • 具体データや具体処理を抽象的に扱えるようにすること
  • 抽象化の2種類:
    • 制御抽象化: 条件分岐、ループ、サブルーチンなどで制御を構造化する手法であり、関数も一種
    • データ抽象化: データ構造と操作方法をまとめて型として定義する手法であり、クラスや構造体も一種
  • 中身を気にせず使える:
    • 標準ライブラリやフレームワークは抽象化の産物
    • Math.sqrtなどの数学関数は、誰も内部の具体コードを気にせず使っている
    • 仕様さえ分かれば中身を気にせず使える

■ 7. 信頼できるコードとしてのAIコード

  • 中身を気にせず使えることの意味:
    • 仕様通りに動作するはずだと信頼していること
    • 信頼しているからこそ、内部の具体コードを読みに行かずに済む
  • 問題の言い換え:
    • 正しい結果が得られるか分からないAIコードとは、中身を気にしなければならない信頼できないコード
    • 信頼できるコードをAIに実装させるべき
  • 信頼できるコードをAIに実装させる方法:
    • 契約による設計に基づいてクラスの仕様を設計する
    • 副作用を隔離し、その上で副作用のない純粋関数を作る
    • 契約による設計に基づくテストコードで、クラス仕様をカバーする
  • 実践による効果:
    • 自身も上記をAIに指示し、信頼できるコードを実装させている
    • それによりコードリーディングの必要性や労力を低減させている

■ 8. AI時代でも基本が重要

  • 解説した概念の登場時期:
    • 契約による設計は1986年
    • 関数の副作用と純粋関数は1960〜1970年代
    • 制御抽象化は1950〜1960年代、データ抽象化は1970年代
  • どれもAI時代の概念ではない:
    • いずれも大昔に提唱された概念
    • AI時代においても基本しか勝たない
  • 注力すべきこと:
    • AIツールの使い方を覚えるのはほどほどにする
    • 増幅元である人間の能力を高めることに集中すべき