メインコンテンツへスキップ
見出し画像

Riderを使ってみる

    もともとWeb制作をしていたこともあり、普段からコードエディターには
    VSCodeを使っていました。

    VSCodeは軽量で扱いやすく、拡張機能も豊富です。UnityやPythonで何かを作るときも、これまでそのままVSCodeを使ってきました。現状でも特に大きく困ることはなく、十分に開発できていました。

    そんな中、Unity開発ではRiderという便利なIDEがあるらしいと知りました。コードの補完やエラーの検出、Unityとの連携などが強く、より効率的に開発できるそうです。

    そこで今回は、実際にRiderを触ってみて、VSCodeとの違いや使いやすさを体感してみます。

    Riderは有料のソフトですが、学生であれば無料で利用できます。JetBrainsのEducational Packに申し込むことで、Riderだけでなく、IntelliJ IDEAやPyCharmなど、ほかのJetBrains製IDEも使えるようになります。

    画像
    利用できるIDE

    Riderを初めて起動すると、テーマやキーマップ、プラグインなどの初期設定を選択する画面が表示されました。

    キーマップは、普段使っているVSCodeに近い操作へ変更することもできるようです。新しいIDEでも、これまでの操作感をある程度引き継げるのはありがたいですね。

    画像
    テーマの選択
    画像
    キーマップの選択

    プラグインについては、まずは標準の状態を試してみたかったため、今回は何も追加せずに進めました。

    画像
    プラグインの選択

    実際にRiderを開いてみると、全体的にモダンなUIで、かなりおしゃれな印象で、開発に必要な機能が最初からまとまっているように見えます。

    画像
    Rider

    Riderの利点を整理

    ここからは、Riderを使って実際にC#のスクリプトを書いて色々と見てみます。

    その前に、VS Codeと比較したときのRiderの良いところを整理してみます。

    • Unity・C#・.NET向けに最適化されており、細かい設定をしなくても使いやすい

    • コード補完の精度が高く、文脈に合わせた候補を表示してくれる

    • コードを書いている途中で、エラーや警告を細かく検出してくれる

    • パフォーマンス上の問題につながりそうなコードも検出してくれる

    • クラス名、メソッド名、変数名などを、プロジェクト全体で安全に変更できる

    • 処理の切り出しやコード整理など、リファクタリング機能が豊富

    • Awake、Start、Updateなど、Unityのライフサイクルを理解した補完や解析ができる

    • SerializeField、Prefab、Sceneなど、Unity特有の要素も考慮して解析してくれる

    • 定義元、参照先、継承関係などへすぐに移動できる

    • デバッグ機能が充実しており、変数やオブジェクトの状態を確認しやすい

    • Gitとの連携が強く、変更履歴や差分を確認しやすい

    • テストの実行や管理機能が最初から組み込まれている

    • プロジェクト全体をインデックス化するため、大規模なプロジェクトでも検索や解析が速い

    ここまで挙げた機能の一部は、拡張機能を追加することでVS Codeでも利用できそうです。

    しかし、RiderにはC#や.NET、Unityに特化したIDEならではの機能や、最初から開発環境がまとまっているという良さがありそうです。

    実際にRiderでゲームを作ってみる

    ここからは、Riderを使って実際にC#のコードを書きながら、先ほど挙げた機能がどのように役立つのかを確認していきます。

    今回は、プレイヤーを操作してフィールド上のアイテムを集める、簡単なゲームを作って、コード補完やエラー検出、リファクタリング、デバッグなど、Riderの機能を実際の開発の中で試してみます。

    UnityプロジェクトをRiderで開く

    まずは、Unity側からRiderを外部スクリプトエディターとして設定します。設定画面は、Unity上部のメニューからEdit → Preferences → External Toolsの順番で開きます。

    画像

    外部スクリプトエディターにRiderを指定したら、Unity上でC#スクリプトPlayerMove.csを作成し、ダブルクリックして開きます。

    Riderが起動すると、Unityプロジェクト内のコードやアセットが自動で読み込まれました。Unityとの接続やプロジェクトの設定も自動で行われており、特に細かい設定をしなくても正しく認識されているようです。

    画像
    画面下には、プロジェクトのインデックスを作成している進行状況が表示されました。インデックスがあると、コードの検索や定義元への移動などをすばやく行えるようになるらしいです。

    Riderはプロジェクト全体を解析し、クラスやメソッドがどこから参照されているのかを把握するようで、初回起動時は少し時間がかかるようです。今回のほとんど空のプロジェクトでは3秒程度で完了しました。

    PlayerMove.csを書いてコード補完を試す

    最初に、プレイヤーを移動させるスクリプトを書いてみます。

    //PlayerMove.cs
    using UnityEngine;
    using UnityEngine.InputSystem;
    
    [RequireComponent(typeof(Rigidbody))]
    public class PlayerMove : MonoBehaviour
    {
        [SerializeField]
        private float moveSpeed = 5f;
        
        [SerializeField]
        private InputActionReference moveAction;
    
        private Rigidbody _playerRigidbody;
        private Vector3 _moveDirection;
    
        private void Awake()
        {
            _playerRigidbody = GetComponent<Rigidbody>();
        }
    
        private void Update()
        {
            ReadInput();
        }
    
        private void FixedUpdate()
        {
            MovePlayer();
        }
    
        private void ReadInput()
        {
            Vector2 input = moveAction.action.ReadValue<Vector2>();
    
            _moveDirection = new Vector3(
                input.x,
                0f,
                input.y
            ).normalized;
        }
        
        private void MovePlayer()
        {
            Vector3 nextPosition =
                _playerRigidbody.position +
                _moveDirection * (moveSpeed * Time.fixedDeltaTime);
    
            _playerRigidbody.MovePosition(nextPosition);
        }
        
        private void OnTriggerEnter(Collider other)
        {
            if (!other.TryGetComponent(out Collectible collectible))
            {
                return;
            }
    
            collectible.Collect();
        }
    }

    コードを書き始めると、変数名やメソッド名、UnityのAPIなどがすぐに候補として表示されました。

    最初はGitHub CopilotなどのAIが補完しているのかと思いましたが、RiderにはIDE自体が持っているコード補完機能があり、インターネット接続を切った状態でも候補が表示されているため、基本的な補完はローカルで動作しているようです(すごい)。

    画像
    [Rと入力すると、RequireComponentなどの候補が表示される
    画像
    prと入力すると、privateなどの候補が表示される

    他にも、transformやTime.deltaTime、Input.GetAxisも途中まで入力すると候補が表示されたり、自分で作成したmoveSpeedのような変数も、現在のコードに合わせて候補に表示されました。

    画像

    単純に入力した文字に一致する候補を出すだけでなく、現在書いているクラスや処理の内容を考慮して候補を表示しているように感じました。かなり自然に補完されるため、本当にAIを使っていないのかと思うほどでした。

    地味に感動したのが、コードの括弧や改行を自動で整えてくれるところです。
    これまではVSCodeで{ }を入力したあと、自分で改行やインデントを調整することがありました。Riderでは、波括弧の中で改行すると、自動的に適切な位置へカーソルが移動し、インデントも整えてくれます。

    画像

    コードを書きながら細かく見た目を修正しなくても、自然に読みやすい形へ整えてくれるのはとても便利。

    VSCodeでもフォーマッターやC#向け拡張機能を設定すれば同様のことはできそうですが、Riderでは最初から自然に動作している点が使いやすいと感じました。

    わざと間違えて静的解析を試す

    次に、コードへ意図的に問題を入れて、Riderがどのように指摘してくれるのか確認します。

    存在しない変数名を書く

    定義されていない変数名を入力すると、該当箇所に赤い波線が表示され、シンボルを解決できませんという内容のエラーが表示されました。

    画像

    型の異なる値を代入する

    整数型の変数へ文字列を代入するなど、型の異なる値を設定すると、赤い波線が表示されました。

    画像

    使用していない変数を作る

    変数を作成したまま一度も使わない場合は、黄色の表示で警告されました。

    赤色はそのままではコンパイルできないエラー、黄色はコンパイル自体はできるものの、確認した方がよい問題として区別されているようです。

    画像

    常に同じ結果になる条件式を書く

    条件が必ずtrueになるような処理を書いた場合も、Riderが指摘してくれました。コード自体は動く場合でも、意味のない条件分岐や意図しない処理になっている可能性を事前に確認できます。

    画像

    Update内に負荷のかかりそうな処理を書く

    Unityでは、Updateが基本的に毎フレーム呼び出されます。

    その中に毎回実行する必要のない検索処理などを書くと、パフォーマンス上の問題につながることがあります。RiderはUnityの仕組みを理解しているため、Update内に負荷の高い処理を書くと警告を表示してくれました。

    一般的なC#の文法だけでなく、Unityでどのように実行されるかまで考慮して解析してくれるのは、Riderすごいとなりました。

    画像

    エラーや警告だけでなく、推奨される変数名の候補、より読みやすい書き方も提案や、乗算する値の順番についてまで提案してくれる場面もありました。

    画像
    コードが間違っているかどうかだけでなく、より分かりやすく、効率的に書くための改善案まで表示してくれる。

    コンパイルする前に問題を発見できるため、Unityへ戻ってからConsoleに表示されたエラーを確認し、再びコードエディターへ戻る回数を減らせそうです。

    アイテム取得処理でコードナビゲーションを試す

    次に、プレイヤーがアイテムへ触れたときの処理を作ります。

    //Collectible.cs
    using UnityEngine;
    
    public class Collectible : MonoBehaviour
    {
        [SerializeField]
        private int scoreValue = 1;
    
        [SerializeField]
        private float rotationSpeed = 90f;
    
        private bool isCollected;
    
        private void Update()
        {
            transform.Rotate(
                Vector3.up,
                rotationSpeed * Time.deltaTime
            );
        }
    
        public void Collect()
        {
            if (isCollected)
            {
                return;
            }
    
            isCollected = true;
    
            GameManager.Instance.AddScore(scoreValue);
    
            Destroy(gameObject);
        }
    }
    //GameManager.cs
    using TMPro;
    using UnityEngine;
    
    public class GameManager : MonoBehaviour
    {
        public static GameManager Instance { get; private set; }
    
        [SerializeField]
        private int targetScore = 5;
    
        [SerializeField]
        private TMP_Text scoreText;
    
        [SerializeField]
        private TMP_Text clearText;
    
        private int collectedItemCount;
        private bool isGameClear;
    
        private void Awake()
        {
            if (Instance != null && Instance != this)
            {
                Destroy(gameObject);
                return;
            }
    
            Instance = this;
        }
    
        private void Start()
        {
            clearText.gameObject.SetActive(false);
    
            UpdateScoreText();
        }
    
        public void AddScore(int amount)
        {
            if (isGameClear)
            {
                return;
            }
    
            collectedItemCount += amount;
    
            UpdateScoreText();
            CheckGameClear();
        }
    
        private void UpdateScoreText()
        {
            scoreText.text =
                $"Items: {collectedItemCount} / {targetScore}";
        }
    
        private void CheckGameClear()
        {
            if (collectedItemCount < targetScore)
            {
                return;
            }
    
            isGameClear = true;
            clearText.gameObject.SetActive(true);
            clearText.text = "Game Clear!";
        }
    }

    ファイルが増えてきたところで、Riderのコードナビゲーションを試します。

    クラスやメソッドの定義元へ移動する

    画像

    そのクラスが使用されている場所を一覧表示する

    画像

    コード量が増えたときに目的の処理を探しやすくなりとても便利です。

    名前変更でリファクタリングを試す

    次に、Riderの名前変更リファクタリングを試します。

    変数名やメソッド名、クラス名は、ゲームを作っている途中で変更したくなることがあります。ただし、名前だけを直接書き換えると、その変数やメソッドを使用しているほかの場所では古い名前が残ってしまい、エラーの原因になります。

    Riderの名前変更リファクタリングを使うと、プロジェクト内の参照箇所もまとめて安全に変更できるようなのでやってみます。

    変数名を変更する

    まずは、PlayerMoveクラスで使用しているmoveSpeedという変数を、speedへ変更してみます。

    画像

    この変数は、MovePlayer()の中でも使用しています。
    変数の宣言部分だけを直接speedへ書き換えると、MovePlayer()内にはmoveSpeedという古い名前が残ります。

    そのため、Rider上では変数を見つけられず、赤く表示されました。

    画像

    ここで、変数名を変更するときに表示される名前の変更リファクタリングを適用を選択します。
    すると、変数の宣言部分だけでなく、MovePlayer()で使用していた箇所も自動的にspeedへ変更されました。

    画像

    自分で使用箇所を探して修正しなくても、参照している場所をまとめて変更することができました。

    メソッド名を変更する

    次に、メソッド名を変更してみます。
    PlayerMoveクラスのOnTriggerEnter()では、取得したCollectibleに対して、次のようにCollect()を呼び出しています。

    画像

    今度はCollectibleクラスへ移動し、Collect()というメソッド名をCollectBox()へ変更します。メソッド名を変更すると、Riderから名前変更リファクタリングの適用を提案されました。

    画像

    これを適用すると、Collectibleクラス側のメソッド名だけでなく、PlayerMoveクラスから呼び出していた箇所も自動的に変更されました。

    画像

    別のファイルから呼び出しているメソッドでも、参照関係を把握してまとめて変更してくれるようです。
    プロジェクトが大きくなり、同じメソッドが複数の場所から呼び出されるようになるほど便利になりそうです。

    クラス名とファイル名を変更する

    同様に、クラス名の変更にもリファクタリングを利用できます。

    画像

    Riderの名前変更リファクタリングを適用すると、そのクラスをほかのスクリプトから参照している場合は、参照先の型名も自動的に更新されます。

    画像
    適用後

    Git連携を確認する

    RiderにはGitとの連携機能も組み込まれており、IDE上からGitリポジトリの作成やGitHubへの共有ができるようです。

    画像

    今回は、まずRiderからGitHubアカウントとの連携を行いました。

    画像

    連携後にプロジェクトの共有機能を使用すると、GitHub上にリポジトリが自動で作成され、現在のUnityプロジェクトを公開できました。

    コマンドを入力したり、ブラウザから先にリポジトリを作成したりしなくても、Rider上から一連の操作を進められるのは便利です。

    コミット履歴やブランチを確認するGitの画面については見当たらず、Rider内でのGit管理には少し慣れが必要そうでした。

    実際に使って感じたこと

    Riderを実際に使ってみて、特に便利だと感じたのは、コード補完、参照先までまとめて変更できるリファクタリング、そしてコードを書いている段階で問題を見つけてくれるエラー検知です。

    Unityとの接続もほぼ自動で、細かい設定をせずに使い始められました。プロジェクトが大きくなるほど、Riderの補完や解析機能による恩恵はさらに大きくなりそうです。

    Git連携やデバッグ機能については、、今後別のnoteに分けて、詳しく調べながら実際に試してみようと思います。


    あなたへのおすすめ