各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からBacklog データ のデータアクセスオブジェクトを作成
JDBI でBacklog のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるBacklog 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Backlog は、Java アプリケーションとリアルタイムBacklog のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Backlog のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するBacklog のデータ の読み書きのためのコードの作成について説明します。
Backlog Issues Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyIssuesDAO {
//insert new data into Backlog
@SqlUpdate("INSERT INTO Issues (Id, ProjectID) values (:id, :projectID)")
void insert(@Bind("id") String id, @Bind("projectID") String projectID);
//request specific data from Backlog (String type is used for simplicity)
@SqlQuery("SELECT ProjectID FROM Issues WHERE Id = :id")
String findProjectIDById(@Bind("id") String id);
/*
* close with no args is used to close the connection
*/
void close();
}
Backlog への接続を開く
必要な接続プロパティを収集し、Backlog に接続するための適切なJDBC URL を作成します。
Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。
API キー認証
ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：
- Backlog の個人設定ページを開きます。
- 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
- ApiKey にAPI キーを指定します。
- URL はBacklog のテナントURL から取得できます。
OAuth 認証
ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。ビルトイン接続文字列デザイナー
JDBC URL の構成については、Backlog JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.backlog.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Backlog の接続文字列は、通常次のようになります。
jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;");
MyIssuesDAO dao = dbi.open(MyIssuesDAO.class);
//do stuff with the DAO
dao.close();
Backlog データ について
Backlog への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Backlog のIssues エンティティからデータを取得できます。
//disply the result of our 'find' method
String projectID = dao.findProjectIDById("1");
System.out.println(projectID);
Backlog データ の書き方
以前定義した方法を使用すれば、Backlog にデータを書き込むことも簡単になります。
//add a new entry to the Issues entity
dao.insert(newId, newProjectID);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Backlog と統合することで、SQL Object API for Backlog を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムBacklog を操作しましょう。
関連コンテンツ
