1.はじめに
どうも、ARIの名古屋支社に勤務している愛知県民です♪
(/・ω・)/
先日Salesforceにて、Apexクラスを作成しようとしたのですが、
Salesforceの仕様で、いきなり本番環境にApexクラスを作ることはできず、
Sandboxで作成・テストをし、本番環境へアップロードすることが必要でした。
前回の記事ではSandboxの作成方法について記載したので、
今回はSandboxから本番環境にApexクラスをアップロードする手順を記事にしたいと思います。
この記事がSalesforceについて勉強中の方の参考になれば幸いです♪
(*^^)v
2.用語の説明
2.1.Sandboxとは
Sandboxとは本番環境にアップロードするApexクラスやApexトリガを作成・テストするための環境のことです。
ちなみに、外部サービス(AWSのLambda等)との連携を試すことはできないため、
外部サービスの代わりにレスポンスを返すMockというコンポーネントを使用してテストをします。
(この辺りについてもいつか、記事投稿したいと考えてます・・・)
2.2.Apexとは
Apexとは、JavaベースのSalesforce独自のプログラム言語です。
Salesforce内のオブジェクトの検索や作成をするメソッド等が提供されており、
それらを組み合わせて処理を記述することができます。
Apexクラスとは、オブジェクト指向におけるクラスと同様のものとなります。
3.前提条件
以下に前提条件を示します。
- Sandboxが作成済であること
4.概要
今回は例として「HelloWorld!」をログに出力するApexクラスをSandboxから本番環境へアップロードしたいと思います。
SandboxにてApexクラスを作成し、ApexクラスをテストするためのApexクラスを作成し、テストを実施し、本番環境へアップロードします。
5.本番環境での事前設定
まず初めに、Sandboxから本番環境へApexクラスをアップロードするための設定をします。
5.1.本番環境にログインします。
※ログインする環境を間違えないようにしてください
5.2.画面右上の歯車を選択し、「設定」を選択します。
5.3.検索欄に「リリース」を入力し、「リリース設定」を選択します。
5.4.この後、作業をするSandboxの左側にある「編集」を選択します。
5.5.アップロード認証方向の「変更着信を許可」にチェックを入れ、「保存」を選択します。
6.Sandboxでの作業
Sandboxでは以下の4つの作業を実施します。
- Apexクラスの作成
- テスト用Apexクラスの作成
- テストの実施
- 本番環境へアップロードのリクエストを送信
6.1.Apexクラスの作成
まずは、Apexクラスの作成およびテストを実施します。
6.1.1.Sandboxにログインします。
※ログインする環境を間違えないようにしてください
6.1.2.画面右上の歯車を選択し、「設定」を選択します。
6.1.3.検索欄に「apex」を入力し、「Apexクラス」を選択します。
6.1.4.「新規」を選択します。
6.1.5.Apexのコードを書き、「Save」を選択します。
今回は例として以下のコードを使用しました。
global class HelloWorld {
public String helloworld() {
return 'HelloWorld!';
}
}
6.2.テスト用Apexクラスの作成
6.2.1.Apexクラスの画面にて、再度「新規」を選択します。
6.2.2.Apexのコードを書き、「Save」を選択します。
今回は例として以下のコードを使用しました。
@isTest
private class HelloWorldTest {
@isTest static void hello() {
HelloWorld hello_world = new HelloWorld();
String result = hello_world.helloworld();
System.debug('結果=' + result);
}
}
6.3.テストの実施
6.3.1.Apexクラスの画面にて、「開発者コンソール」を選択します。
6.3.2.「Test」を選択し、「New Run」を選択します。
6.3.3.実行するテストを選択し、「Run」を選択します。
6.3.4.開発者コンソール下部にテスト結果が表示されることを確認し、行のどこかをダブルクリックします。
6.3.5.ログを確認します。
例で赤枠になっている行は「HelloWorldTest」クラスの「System.debug('結果=' + result);」に対応しており、
プログラムが問題なく動いたことが確認できます。
6.3.6.Apexクラスのページに戻り、コードカバー率が75%以上であることを確認します。
コードカバー率が75%未満の場合は本番環境にアップロードする時にエラーになります。
コードカバー率が75%未満の時は以下を確認してください
if文を入れている場合 → 各分岐に流れるようにテストが実行できているか
try-catch分を入れている場合 → エラーが起きる場合のテストが実行できているか
6.4.本番環境へアップロードのリクエストを送信
6.4.1.設定の検索欄に「送信」を入力し、「送信変更セット」を選択します。
6.4.2.「新規」を選択します。
6.4.3.「名前」と「説明」を入力し、「保存」を選択します。
どちらの項目も入力する内容は任意です。
6.4.4.変更セットコンポーネントの部分にある「追加」を選択します。
6.4.5.以下を選択し、「変更セットに追加」を選択します。
項目 | 設定内容 |
---|---|
コンポーネントの種類 | Apexクラス |
チェックボックス | 本番環境にアップロードするApexクラスを選択 |
6.4.6.「アップロード」を選択します。
6.4.7.本番環境にチェックをし、「アップロード」を選択します。
7.本番環境での作業
最後に、本番環境で以下の作業を実施します。
- Apexクラスをリリース
7.1.Apexクラスをリリース
7.1.1.本番環境にログインします。
※ログインする環境を間違えないようにしてください
7.1.2.設定の検索欄に「受信」を入力し、「受信変更セット」を選択します。
7.1.3.手順6.4.3.で入力した「名前」の左にある「リリース」を選択します。
7.1.4.「リリース」を選択します。
7.1.5.「リリース状況」を選択します。
7.1.6.リリース状況を確認します。
7.1.7.画面に「成功したリリース」と表示されることを確認します。
7.1.8.最後に、Apexクラスの画面を開き、本番環境にアップロードされていることを確認します。
8.おわりに
ここまで読んで下さり、ありがとうございます!!!
(^^)
Apexクラスをアップロードする際にはテスト用クラスの作成が必要なことや、
コードカバー率が75%以上必要なことが学びになりました。
次はCTIフローか、VisualforceからApexクラスを呼び出す方法について書く・・・かもしれません。
(:3_ヽ)_