2019.01.17

Visual Studio CodeでSalesforceの開発環境を構築する(winter '19)

  • このエントリーをはてなブックマークに追加
  • follow us in feedly
gettyimages (9544)

みなさん、おはようございます。
昨年末に Trailhead サブアカウントのランクが Ranger になったエンジニアの高橋です。

今回は、リリースノート(winter 19)にありました「VS Code 向け Salesforce 拡張機能: 任意の組織での開発およびライブデバッグシミュレーション、新しい Apex テストビュー」の中の「Visual Studio Code での任意の組織に対する開発」について本記事で触りたいと思います。
注意:執筆当時時点(2018年12月末)では機能はプレビュー版とのこと。あくまでも評価目的の使用であり、本番での使用で一切の責任を取れないことが記載されています。

開発環境を構築するにあたり、接続先の組織は developer edition を使用しています。
それでは早速開発環境を構築していきます。

必要なツールのインストール

開発環境を構築する上で必要なツールをインストールしていきます。 (インストール済みであれば飛ばしてください)
  • Visual Studio Code
  • Java 8 Platform, Standard Edition Development Kit
  • Salesforce CLI (バージョン 44.0 以上が必要)
  • Visual Studio Code プラグイン「Salesforce Extension Pack」
  • Visual Studio Code をインストールする

    まずはインストーラを取得します。インストーラは Microsoft社の公式ページ(https://code.visualstudio.com/) からダウンロードして下さい。
    インストーラをダウンロードしたら、起動しインストールを進めていきます。
    ※. インストールの手順はこの記事では割愛します。インストーラのガイドに沿って進めてください。

    Java 8 Platform, Standard Edition Development Kit をインストールする

    Visual Studio Code プラグイン「Salesforce Extension Pack」のいくつかの機能で Java8 が必要とのことでインストールします。こちらもインストーラを取得します。
    インストーラは Oracle社の公式ページ(https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) からダウンロードして下さい。インストーラをダウンロードしたら、起動しインストールを進めていきます。
    ※. こちらもインストールの手順は割愛します。インストーラのガイドに沿って進めて下さい。

    Salesforce CLI をインストールする

    salesforce 公式ページ(https://developer.salesforce.com/ja/tools/sfdxcli) からインストーラを取得します。ページに遷移すると、使用 OS に合わせたダウンロードリンクが表示されています。

    salesforce CLI

    windows からのアクセスだと 初期表示で windows 用のダウンロードリンクが表示されます。
    インストーラをダウンロードします。
    ※. 「Download for Windows 64」の場合、インストーラ名は「sfdx-windows-amd64.exe」
    ダウンロードが終わったらインストーラを起動しインストールを進めます。

    インストーラ起動後のコンポーネント選択

    初回表示のまま全て選択します。

    インストール先の選択

    インストール中

    インストール完了!

    インストールが完了したら、Salesforce CLI のインストールおよびプラグインバージョンを確認します。
    windows であればコマンドプロンプトを起動し、次のコマンドを実行してバージョンを確認します。
    sfdx --version
    Salesforce CLI バージョン確認

    Salesforce CLI バージョン確認 実行結果

    パス上のマシン名は黒塗りしています。
    次は、Salesforce CLI プラグインバージョン です。
    表示される一覧の中に salesforcedx XX.XX.XX が表示され、1つめの XX が 44 以上であることを確認します。
    sfdx plugins --core
    
    Salesforce CLI プラグインバージョン確認

    Salesforce CLI プラグインバージョン確認 実行結果

    パス上のマシン名は黒塗りしています。

    Visual Studio Code プラグイン(Salesforce Extension Pack)をインストールする

    Visual Studio Code を起動した後、拡張機能を開きます。
    検索テキストボックスに「Salesforce Extension Pack」と入力し赤枠のプラグインを探します。

    プラグイン「Salesforce Extension Pack」

    見つけたら「Install」ボタンをクリックしインストールを進めます。

    「Salesforce Extension Pack」インストール後

    インストールが完了したら「Reload」ボタンをクリックします。
    Reload 後、追加したプラグインリストを見ると「Salesforce Extension Pack」以外にも追加されていることが分かります。

    「Salesforce Extension Pack」Reload 後

    発行者名が salesforce でないプラグインは 筆者が事前にインストールしていたプラグインです。
    以上で必要なインストール作業は終了です。

    開発環境を構築する

    インストール作業が完了しましたので、次にローカルPC にて開発するための環境を構築します。

    ローカルPCにて作業用プロジェクトを作成する

    コマンドパレットを開き、テキストボックスに「Create Project」と入力し「SFDX: Create Project with Manifest」を選択します。

    選択後、作業用プロジェクトの名前を入力します。

    本記事では「SampleProject」と入力します。
    名前を入力後、プロジェクトを作成するフォルダ選択ダイアログが表示されます。

    フォルダ選択

    本記事では画像の箇所(D:/workspace)に作成しました。
    フォルダ選択後、プロジェクト作成処理が行われます。
    作成処理後は下記のフォルダ構成になります。

    処理直後の作業用プロジェクトの構成

    salesforce組織の認証を行う

    次は salesforce 組織の認証を行います。
    本記事では developer 組織に接続するので不要ですが、
    sandbox組織に接続する場合は sfdx-project.json を開いてログインURL の値を更新します。

    ログインURL の変更

    sandbox なら「https://test.salesforce.com」に変更します。
    コマンドパレットを開き、テキストボックスに「Auth」と入力し「SFDX: Authorize an Org」を選択します。

    先に作業用プロジェクトを用意しないと、赤枠の選択肢は出てきません。
    次に、接続する組織をローカルPC で管理するための alias 名を入力します。

    alias名入力

    キャプチャでは表示されていませんが、「SampleProject」と入力しました。
    alias 名入力後、salesforce の認証が始まります。
    普段使用しているブラウザにてログインURL の画面に遷移するので、ユーザ名とパスワードを入力して認証を行います。
    認証に成功すると Visual Studio Code のコンソールに下記メッセージが表示されます。

    認証成功時のコンソール表示

    ユーザ名は黒塗りしています。

    接続先の組織からソースを取得する(retrive)

    このセクションでは、package.xml に定義したソースを全て取得する方法と特定のソースのみの2つを紹介します。

    まず、package.xml に定義したソースを全て取得する場合です。
    Visual Studio Code の Explorer 上にある「package.xml」を右クリックし、コンテキストメニューを表示します。
    コンテキストメニューから「SFDX: Retrieve Source in Manifest from Org」を選択します。

    package.xml 上でコンテキストメニュー表示

    赤枠を選択します。
    取得に成功するとコンソールに下記のメッセージが表示されます。

    キャプチャでは最初だけしか映っていませんが、実際はいろいろ出力されています。
    特定のソースのみを取得する場合は、取得したいソースおよびフォルダに対して右クリックし、コンテキストメニューを表示します。
    コンテキストメニューから「SFDX: Retrieve Source from Org」を選択します。

    特定のソースの取得

    画像は「AccountHandler.cls」に対するコンテキストメニューです。
    こちらも取得に成功するとコンソールに下記のメッセージが表示されます。

    ちなみに、Explorer 上の何もないところで右クリックしても、同じコンテキストメニューが表示されます。ここで「SFDX: Retrieve Source from Org」を選択すると取得処理がはじまるのですがコンソールに下記のエラーが表示されることに注意して下さい。

    Explorer 上の何もないところでのコンテキストメニュー表示

    取得エラーのコンソール表示

    package.xml に記載されたソースが全て取得できるものと思っていましたが違うようです。

    ソースをリリースする(deploy)

    ローカルPC で編集したファイルを接続先の組織へリリースします。
    手順は取得時と同じでコンテキストメニューで選択する項目が違うのみです。
    ここでは特定のソースのみリリースする方法のみを記載します。
    リリースしたいソースおよびフォルダに対して右クリックしコンテキストメニューを表示します。
    コンテキストメニューから「SFDX: Deploy Source from Org」を選択します。

    特定ソースのリリース

    画像は「AccountHandler.cls」に対するコンテキストメニューです。
    リリースに成功すると、コンソールに下記のメッセージが表示されます。

    リリース成功時のコンソール出力

    JSON が出力されます。

    まとめ

    「Visual Studio Code で開発環境を構築する」いかがでしたでしょうか?
    ここから他のプラグインと上手く組み合わせることで、開発効率が飛躍的に上がるのではないでしょうか?
    正式リリースされるのが待ち遠しいですね。

    本記事が Force.com 開発の手助けとなれば幸いです。
    それでは良い Force.com 開発生活を~♪
    69 件
       
    • banner
    • banner

    関連する記事