良いコードを書く技術という本が手元に来たので読んでみました。

最初にザックリと眺めた書いてある内容

変数名とかは適切なものを付ける
変数のスコープは短くする
メソッドの処理単位には気を付ける
- メソッド抽出とクラス分割
よく使うメソッドはまとめる
データの構造を意識する
テストコードを書く
抽象化
- 配列やリストにまとめて処理する
- 同じような構造を持ったオブジェクトが並んでいる場合、同じインターフェースにしてまとめることができる
メタプログラミングについて
フレームワークを作ってみる

サンプルコードもあるので理解しやすいと思います

とりあえず自分の興味のある所を優先的に読んでみました

コードの分割

まず最初に気になったのがDocumentBuilderFactoryです（これ知らなかったです）

サンプルを書いてみました。

public void sample() throws ParserConfigurationException, TransformerException {
        // Documentオブジェクトの準備
        
        // Domオブジェクトツリーを生成するパーサーを取得するAPI
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        // DomDocumentインスタンスを取得するためのAPI
        DocumentBuilder builder = factory.newDocumentBuilder();
        // Documentはドキュメントツリーのルート
        Document doc = builder.newDocument();

        Element rootNode = doc.createElement("data");
        doc.appendChild(rootNode);

        int rowIndex = 1;
        Element userNode = doc.createElement("user");
        userNode.setAttribute("id",String.valueOf(rowIndex++));
        userNode.setTextContent("御坂美琴");

        rootNode.appendChild(userNode);

        Element adminNode = doc.createElement("admin");
        adminNode.setAttribute("id",String.valueOf(rowIndex++));
        adminNode.setTextContent("管理者");

        rootNode.appendChild(adminNode);

        // DocumentオブジェクトをXML文字列へ変換
        TransformerFactory transFactory = TransformerFactory.newInstance();
        Transformer transformer = transFactory.newTransformer();
        DOMSource source = new DOMSource(doc);

        StreamResult result = new StreamResult(new StringWriter());
        transformer.transform(source, result);

        System.out.println(result.getWriter().toString());
    }

&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;no&quot;?&gt;&lt;data&gt;&lt;user id=&quot;1&quot;&gt;御坂美琴&lt;/user&gt;&lt;admin id=&quot;2&quot;&gt;管理者&lt;/admin&gt;&lt;/data&gt;

上記のようにxml形式で出力ができました。そして以下のようにコードの分割を行いました。

public void sample() throws ParserConfigurationException, TransformerException {
        XmlBuilder builder = new XmlBuilder("御坂美琴","管理者");
        // 子ノードも格納されたrootNodeを取得する
        Document doc = builder.buildDocument();
        //　出力処理
        writeDocument(doc);
    }

    private static class XmlBuilder {
        private int rowIndex = 1;
        private final String userName;
        private final String adminName;
        public XmlBuilder(String userName, String adminName){
            this.userName = userName;
            this.adminName = adminName;
        }

        // Documentオブジェクトを取得します
        private Document newDocument() throws ParserConfigurationException {
            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
            DocumentBuilder builder = factory.newDocumentBuilder();
            return builder.newDocument();
        }

        private Document buildDocument() throws ParserConfigurationException {
            Document doc = newDocument();
            Element rootNode = doc.createElement("root");
            doc.appendChild(rootNode);
            rootNode.appendChild(createUserNode(doc));
            rootNode.appendChild(createAdminNode(doc));
            return doc;
        }
        // ユーザーを作成する処理
        private Element createUserNode(Document doc){
            Element userNode = doc.createElement("user");
            userNode.setAttribute("id", String.valueOf(this.rowIndex++));
            userNode.setTextContent(this.userName);
            return userNode;
        }
        // 管理者を作成する処理
        private Element createAdminNode(Document doc){
            Element adminNode = doc.createElement("admin");
            adminNode.setAttribute("id",String.valueOf(this.rowIndex++));
            adminNode.setTextContent(this.adminName);
            return adminNode;
        }

    }

    //出力処理はそのままメソッド抽出した
    private void writeDocument(Document doc) throws TransformerException {
        TransformerFactory transFactory = TransformerFactory.newInstance();
        Transformer transformer = transFactory.newTransformer();
        DOMSource source = new DOMSource(doc);
        StreamResult result = new StreamResult(new StringWriter());
        transformer.transform(source, result);
        System.out.println(result.getWriter().toString());
    }

大きく以下の処理に分かれています

xmlの作成
- XmlBuilderクラスの作成インクリメントしていたローカル変数をインスタンス変数にするユーザー、管理者の作成はメソッド化する
  - インクリメントしていたローカル変数をインスタンス変数にする
  - ユーザー、管理者の作成はメソッド化する
xmlの出力

抽象化

Viewにフォルダ事のファイル一覧とサイズを表示するサンプル。ループで処理できるように抽象化（ここでは共通部分の抜き出し）を行う

べた書きで以下を行っていた

フォルダ事のファイル配列を取得する
それぞれのサイズを算出する
Viewに渡す

以下にリファクタリング

ファイルリストを管理する(ImageFiles)クラスを作成
- ファイル配列
- 合計サイズ
- パス
クラスを生成関数を作成する
ファイル配列から合計サイズを算出するメソッドをUtileクラスに作成する
処理
- Listとしてリストで管理する
- フォルダの数だけループImageFIlesを生成する関数を呼び出してリストに突っ込む
- Viewに渡す
  - ImageFIlesを生成する関数を呼び出してリストに突っ込む

おそらくこの章のサンプルだけで以下ができている

コードの分割
コードの集約
データの構造化

この手の方法は意識しないで作っている場合のほうが多いと思います。みんなオブジェクト指向言語を学ぶと、クラスやインターフェースを使うようになるので、この例はそれだけで自然と解決されるような気もします。

メタプログラミング

人狼では毛嫌いされるメタです。

メタプログラミングとは

プログラムを生み出すプログラム
- コードの自動生成自動生成されたコードはエラーが基本的にはない
  - 自動生成されたコードはエラーが基本的にはない
DSL
- ドメイン特化言語外部DSLxmlなどの設定ファイルを読み込み内部DSLrailsのルーティングのようなホスト言語のみで実現するDSL
  - 外部DSLxmlなどの設定ファイルを読み込み
  - 内部DSLrailsのルーティングのようなホスト言語のみで実現するDSL
  - xmlなどの設定ファイルを読み込み
  - railsのルーティングのようなホスト言語のみで実現するDSL

下記いい例だと思います

リンク

本の例では電文データのパースをやっています。

例えば電文データの構造というのはどんなデータがやってくるのかによって変化します。この変化に対応するということは、電文データの仕様定義の変更に対応するということです。

この電文データ仕様定義を外部から設定して処理が実行されるようにすれば良い。外部からデータ仕様定義を設定するということは、メインの処理を書かなくてもプログラムが書かれたかのように動作するということ

電文データ解析
- define(Field)
- define(Field)
- define(Field)
Field
- 名前
- 文字数
- 変換ルール

電文データはdefineしてしまえばいくらでも変更可能になる。

フレームワーク

フレームワークに使われていると危険らしい
フレームワークを使わずにゼロから作ることも重要らしい

フレームワークを作ろうという企画。ただサーブレットでってのが正直あんまり知らないので、整理してから再度読んでみることにします。

追記：記事書きました

リンク

基本的には全てのリクエストを受け付けるクラスを作って、URLに応じて処理を振り分けることをしているぽいです。

昔の記憶なので曖昧ですがドットインストールというサイトでも似たようなことを学べたかと思います

https://dotinstall.com/lessons/sns_php_v3

(久しぶりにこのサイト見たらコンテンツが増えててすごいサイトになってますね。またプレミアム会員になってみようかな。私は回し者ではありませんのでご安心ください)