VSCodeとは？Salesforce開発におけるVisual Studio Codeをご紹介

VSCodeとは？

「VSCode」とは、「Visual Studio Code」の略で、エディタと呼ばれるツールです。 SEがプログラミングを行う上で必要となる便利な機能が数多く実装されています。Salesforce以外のシステム開発の現場で頻繁に利用されている開発ツールの一つです。ソフトウェア開発の現場ではVisual Studio Codeはよく「VSCode（読み方はブイエスコード）」と呼ばれていて、オープンソース（GitHubでソースコードが公開されている）かつフリーで誰でも利用できます。 VSCodeには、 ・WindowsでもMacでもLinuxでも使用可能 ・Java、JavaScript、C#、C++、PHP、Python、Goなど数多くの言語に対応 ・プラグインを利用することでプロジェクトに合わせた拡張が可能 などシステム開発の現場で重宝される数多くの特徴があります。Salesforce開発の現場でもApexのコーディングやメタデータの編集などのためよく利用されています。

Visual Studio Codeのメリット

Salesforce開発の現場でVSCodeを利用するメリットとしては、「開発効率が上がること」、「ソースコードの品質を高められること」など一般的な理由に加え、「Salesforce開発向けの拡張パックが用意されている」ということも挙げられます。 例えば、VSCodeではSalesforceの開発でよく利用する機能のほとんどがショートカットキーで実行可能なので、使いこなすことができれば素早く作業をこなしていくことができます。また、自分の仕事に合わせてショートカットキーの登録も可能なので、仮にプロジェクト特有の少し複雑な作業があったとしても効率化できるでしょう。 そして、Apex（Salesforceの開発で使うプログラミング言語）のソースコードの品質を高めることも可能です。ソースコードを視覚的に見やすくする機能（クラス、変数、予約語などを一目で把握できるように色分けする）や、テスト用の拡張機能（テストスイートの実行など）、フォーマット機能（自動で、インデントを入れる、不要なスペースを削除する、改行を追加する、など）と品質担保に必要な機能が実装されています。 さらに、開発向けの拡張パック（Salesforce Extension Pack）が用意されています。そのため誰でも容易に開発環境を構築することができます。

Salesforce開発向けにインストール・設定しよう！

ここではSalesforce開発向けのVSCodeの設定方法に関して解説します。 まず、公式サイトからVSCodeをインストールします。 次に、「Salesforce CLI」というコマンドラインをインストールしましょう。Salesforceのスクラッチ組織の作成やコマンドラインの実行などが可能になります。具体的には、開発環境やテスト環境の構築や、テストスイートの実行などが可能となります。Salesforceはローカルで動くものではないため、Salesforceの開発を行う上で必須のツールと言えます。 そして最後に、VSCodeのプラグインの「Salesforce Extension Pack」をインストールしましょう。このプラグインにはSalesforce開発に必要となる以下のものが全て含まれています。 ・Apex ・Salesforce CLI Integration ・Apex interactive Debugger ・Apex Replay Debugger ・Visualforce ・Aura Components ・Lightning Web Component

スクラッチ組織に接続方法

スクラッチ組織とは、Salesforceの機能を動かすことができる環境のことです。開発作業、新機能のテスト、自動テストの実行などで利用します。スクラッチ環境は本番環境の設定などを元にして作成することが可能です（必要になる度に最初から環境設定などを行うことは基本的にはありません）。 スクラッチ組織にはVSCodeから接続することが可能です。 まずは作業用のプロジェクトを作成します。VSCodeのコマンドパレットで「SFDX: Create Project with Manifest」を選択しプロジェクト名を入力してプロジェクトを作成します。 そして組織への認証を行います。「sfdx-project.json」を開いてログインURLを設定します。コマンドパレットを開き「SFDC: Authorize an Org」を選択しAliasを入力します。 するとブラウザが表示されSalesforceのログイン画面が表示されるので、ユーザー名とパスワードを入力します。これで認証は完了です。認証に成功すると「SFDX: Authorize an Org successfully ran」と表示されます。

Salesforce開発におけるGitの紹介

Salesforce開発のプロジェクトは他のSEと共同で作業を進めることがほとんどです（開発者が一人しかいないことはまずありません）。そのため、作業効率化などの目的でGitのような共同での開発作業を効率化するツールが使われることが多くなります。そして、VSCodeには「Git SCM」という拡張機能が標準で備わっており、使用を開始する上で必要になる設定などは特にありません。 Gitとはソースコードなどの分散型のバージョン管理システムです。ソースコードの編集の履歴管理などを行うことができます。 Gitは利用することで主に複数人でのソフトウェア開発の効率を上げることができるため、システム開発の現場で採用されていることが多いです。例えば、同じファイルを複数人で同時に編集している場合、誤って上書きで他人の修正を消してしまう可能性が出てきます。また、機能の実装後テストをした結果不具合が起きてしまったため、ソースコードを元の状態に戻す必要が出てくることはよくあります。 そのような問題は、Gitを利用することで解決できます。他人と自分の修正履歴を見ながら必要な部分だけを更新することも可能ですし、ソースコードを元に戻すことも容易に行えます。

Gitを使用する上での留意点

Gitの利用は難しくはありませんが、以下の言葉は最低限知っておくといいでしょう。 1.リポジトリ ファイルなどが保管されている場所のことです。 2.リモートリポジトリ サーバー側にあるリポジトリです。通常は複数人で共有して使います。 3.ローカルリポジトリ ローカルPCに作成されたリポジトリです。ソースコードを修正する場合、まずこのリポジトリ内のファイルを修正します。 4.コミット ローカルリポジトリにソースコードの修正などを反映することを指します。コミットを行うとその修正内容は履歴として管理されます。 5.プッシュ ローカルリポジトリで行った修正をリモートリポジトリに反映します。プッシュを行うことで、他の開発者に自身の修正を共有できます。 6.プル 他の開発者がリモートリポジトリに反映した修正を自身のローカルリポジトリ反映します。リモートリポジトリのファイルに置き換えられるわけではなく、差分のみ反映されます。

VSCodeでのSalesforce機能のデバックの概要

VSCodeでは「Apexデバッガ」という機能を使ってデバッグを行うことができます。 Apexクラスなどにブレークポイントを張りそこで処理中の変数の値や型を確認することが可能です。 ステップオーバー（現在の処理を実行し次の処理に移る操作）、ステップイン（現在実行中のステップのメソッド中の処理に進む操作）、ステップアウト（現在のメソッドから抜ける操作）もできるので、プログラムの中の細かい処理も確認することができます。

VSCodeを使用してみよう！

今回の記事ではVSCodeを利用したSalesforce開発について紹介しました。 VSCodeは非常に多機能であり、使うことで開発作業を圧倒的に効率化することができます。 ここで紹介している機能以外にも便利な拡張機能が数多くあります。プロジェクトで開発作業を進める上で課題が出てきたりした場合は、それを解決できる機能がすでに拡張機能として実装されている可能性もあるので調べてみるといいでしょう。]]>