対象： ・UnityからLambda経由でDynamoDBの値を参照している人 ・JsonUtilityをハックする使命感に駆られている人 便利なラッパーができました。 要望があれば公開します。

1. UnityのLambda APIを
DynamoDB APIっぽく使う
2017年3月17日
株式会社エクストーン 木野瀬友人

2. 2017年サーバーレスの時代へ
API Gateway
(インターフェース)
Lambda
(ロジック)
DynamoDB
(データ保存)

3. AWS Mobile SDK for Unityで豊富なサポート
前出のAPIGatewayはない

4. DynamoDBのAPIがモダンで便利
DynamoDB
(データ保存)
Cognito
(ユーザー認証) Context.LoadAsync<Book>(bookID, (result) => {
Debug.Log(result.Response.Title);
}, null);
DynamoDB APIが便利な理由その1
指定したクラスで受け取れる
Unity

5. DynamoDB APIが便利な理由その2
アノテーションで細かな振る舞いを指定できる
[DynamoDBTable("EXAMPLE_TABLE")] // テーブル名のマッピング
public class IntegrationExample{
[DynamoDBHashKey]
public string RoomId;
[DynamoDBRangeKey]
public string Created;
[DynamoDBProperty("Message")] // カラム名のマッピング
public string TextMessage;
[DynamoDBIgnore]
public bool SomeFlag; // DinamoDBIgnore属性は無視される
private int _counter; // privateフィールドは無視される
}

6. DynamoDB APIが便利な理由その3
Global Secondary Index / Local Secondary Indexに対応
[DynamoDBTable("EXAMPLE_TABLE")] // テーブル名のマッピング
public class IntegrationExample{
[DynamoDBHashKey]
public string RoomId;
[DynamoDBRangeKey]
public string Created;
[DynamoDBProperty("Message")] // カラム名のマッピング
public string TextMessage;
[DynamoDBIgnore]
public bool SomeFlag; // DinamoDBIgnore属性は無視される
private int _counter; // privateフィールドは無視される
[DynamoDBGlobalSecondaryIndexHashKey("GSI-Key-Name")]
public string UserId;
[DynamoDBGlobalSecondaryIndexRangeKey("GSI-Key-Name")]
public string SomeRange;
}
別条件での検索と
そのページめくりに使用

7. DynamoDB APIが便利な理由その4
独自のConverterを指定できる
[DynamoDBProperty(typeof(DimensionTypeConverter))]
public DimensionType Dimensions;
public class DimensionType {
public decimal Length;
public decimal Height;
public decimal Thickness;
}
// 寸法文字列 "8.5x11x.05" を DimensionType に変換
public class DimensionTypeConverter : IPropertyConverter {
public object FromEntry(DynamoDBEntry entry) {
Primitive primitive = entry as Primitive;
string[] data = ((string)(primitive.Value)).Split(new string[] { " x " }, StringSplitOptions.None);
if (data.Length != 3) throw new ArgumentOutOfRangeException();
DimensionType complexData = new DimensionType {
Length = Convert.ToDecimal(data[0]),
Height = Convert.ToDecimal(data[1]),
Thickness = Convert.ToDecimal(data[2])
};
return complexData;
}
}

8. DynamoDB APIが便利な理由その5
複雑なオブジェクトにも対応
[DynamoDBTable("IntegrationExample")]
public class IntegrationExample{
[DynamoDBProperty(typeof(ListOfDocumentTypeConverter))]
public List<Document> Books;
[DynamoDBProperty]
public Dictionary<string,string> EJDictionary;
}
// 参照方法
Debug.Log(result.Response.Books[0]["Author"]); // Yamada Taro
Debug.Log(result.Response.EJDictionary["apple"]); // ringo
DynamoDBのカラムの例
VBのVariant型のようなもの
Dictionaryに対応

9. 問題点：
✕ リクエスト(クエリ条件等)の指定はクライアント側からしかできない
✕ IAMの設定を間違えたら無関係のデータまで読めてしまう
レコードごとに権限管理できるのか？
できたとしても設定ミスを検知しにくい
IAMにプレイヤーごとの権限管理を求めるのは間違っている気がする
→熟練者のいない環境では怖くて使えない

10. 問題点：
✕ リクエスト(クエリ条件等)の指定はクライアント側からしかできない
✕ IAMの設定を間違えたら無関係のデータまで読めてしまう
レコードごとに権限管理できるのか？
できたとしても設定ミスを検知しにくい
IAMにプレイヤーごとの権限管理を求めるのは間違っている気がする
→熟練者のいない環境では怖くて使えない
orz

11. そこでLambdaをかます
Lambda
(ロジック)
DynamoDB
(データ保存)
Cognito
(ユーザー認証)
Unity
DynamoDBへの
アクセスを制御

12. そこでLambdaをかます
Lambda
(ロジック)
DynamoDB
(データ保存)
Cognito
(ユーザー認証)
戻り値がJSON
DynamoDB APIが使えない
Unity
DynamoDBへの
アクセスを制御

13. Lambdaでの実装例
// リクエストを生成
var request = new InvokeRequest(){
FunctionName = "getIntegrationExample",
Payload = "{"RoomId":"hoge"}",
InvocationType = InvocationType.RequestResponse
};
LambdaClient.InvokeAsync(request, (result) => {
// レスポンスをstringに変換
string json = Encoding.UTF8.GetString(result.Response.Payload.ToArray());
// 目的のオブジェクトに変換
var item = JsonUtility.FromJson<SomeApp.Model.IntegrationExample>(json);
Debug.Log(item.Message);
});
✕ アノテーション非対応
✕ GSI/LSI非対応
✕ Converter非対応
✕ Dictionaryに変換できない

14. Lambdaでの実装例
// リクエストを生成
var request = new InvokeRequest(){
FunctionName = "getIntegrationExample",
Payload = "{"RoomId":"hoge"}",
InvocationType = InvocationType.RequestResponse
};
LambdaClient.InvokeAsync(request, (result) => {
// レスポンスをstringに変換
string json = Encoding.UTF8.GetString(result.Response.Payload.ToArray());
// 目的のオブジェクトに変換
var item = JsonUtility.FromJson<SomeApp.Model.IntegrationExample>(json);
Debug.Log(item.Message);
});
✕ アノテーション非対応
✕ GSI/LSI非対応
✕ Converter非対応
✕ Dictionaryに変換できない
orz

15. 今回やったハック

16. SDKのソースを取得
Unityでビルド環境を構築

17. Lambda APIとDynamoDB APIの
つなぎ込みとデバッグ

18. 「DynamoDBのレスポンスが来た」とSDKを騙す
Lambda
(ロジック)
DynamoDB
(データ保存)
Cognito
(ユーザー認証)
レスポンスはDynamoDBとし
て処理する
Unity
DynamoDBへの
アクセスを制御リクエストはLambda

19. Lambda API DynamoDB API
PPAP（Pen-Pineapple-Apple-Pen Official）ペンパイナッポーアッポーペン／PIKOTARO(ピコ太郎)

20. Lambdaでの実装例
var request = new InvokeRequest(){
FunctionName = "getIntegrationExample",
Payload = "{"RoomId":"hoge"}",
InvocationType = InvocationType.RequestResponse
};
// 従来の方法(Json文字列で受け取る)
LambdaClient.InvokeAsync(request, (result) => {
sring json = Encoding.UTF8.GetString(result.Response.Payload.ToArray());
var item = JsonUtility.FromJson<SomeApp.Model.IntegrationExample>(json);
Debug.Log(item.Message);
});
// DynamoDBっぽく受け取る(AttributeValueで受け取る)
LambdaClient.GetItemAsync(request, (result) => {
Debug.Log(result.Response.Item["Message"].S);
});
// DynamoDBっぽく受け取る(Generic対応)
LambdaClient.GetItemAsync<SomeApp.Model.IntegrationExample> (request, (result) => {
Debug.Log(result.Response.item.Message);
});
◯ 指定したクラスで受け取り
◯ アノテーション対応
◯ GSI/LSI対応
◯ Converter対応
◯ 複雑なオブジェクトに変換可能
リクエストは
Lambda
レスポンスはDynamoDB

21. resultとは何か
var request = new InvokeRequest(){
FunctionName = "getIntegrationExample",
Payload = "{"RoomId":"hoge"}",
InvocationType = InvocationType.RequestResponse
};
// 従来の方法(Json文字列で受け取る)
LambdaClient.InvokeAsync(request, (result) => {
sring json = Encoding.UTF8.GetString(result.Response.Payload.ToArray());
var item = JsonUtility.FromJson<SomeApp.Model.IntegrationExample>(json);
Debug.Log(item.Message);
});
// DynamoDBっぽく受け取る(AttributeValueで受け取る)
LambdaClient.GetItemAsync(request, (result) => {
Debug.Log(result.Response.Item["Message"].S);
});
// DynamoDBっぽく受け取る(Generic対応)
LambdaClient.GetItemAsync<SomeApp.Model.IntegrationExample> (request, (result) => {
Debug.Log(result.Response.item.Message);
});
AmazonServiceResult<InvokeRequest,
LambdaGetItemResponse> result
AmazonServiceResult<InvokeRequest,
InvokeResponse> result
AmazonServiceResult<InvokeRequest,
LambdaGetItemResponse<SomeApp.Model.
IntegrationExample>> result

22. DynamoDB APIでできることがそのまま使える
DynamoDB
(データ保存)
Cognito
(ユーザー認証)
Context.GetItemAsync<Book>(request, (result) => {
Debug.Log(result.Response.Item.Title);
});
①指定したクラスで受け取れる
Unity
Lambda
(ロジック)

23. ②アノテーションで細かな振る舞いを指定できる
[DynamoDBTable("EXAMPLE_TABLE")] // テーブル名のマッピング
public class IntegrationExample{
[DynamoDBHashKey]
public string RoomId;
[DynamoDBRangeKey]
public string Created;
[DynamoDBProperty("Message")] // カラム名のマッピング
public string TextMessage;
[DynamoDBIgnore]
public bool SomeFlag; // DinamoDBIgnore属性は無視される
private int _counter; // privateフィールドは無視される
}

24. ③Global Secondary Index / Local Secondary Indexに対応
[DynamoDBTable("EXAMPLE_TABLE")] // テーブル名のマッピング
public class IntegrationExample{
[DynamoDBHashKey]
public string RoomId;
[DynamoDBRangeKey]
public string Created;
[DynamoDBProperty("Message")] // カラム名のマッピング
public string TextMessage;
[DynamoDBIgnore]
public bool SomeFlag; // DinamoDBIgnore属性は無視される
private int _counter; // privateフィールドは無視される
[DynamoDBGlobalSecondaryIndexHashKey("GSI-Key-Name")]
public string UserId;
[DynamoDBGlobalSecondaryIndexRangeKey("GSI-Key-Name")]
public string SomeRange;
}
別条件での検索と
そのページめくりに使用

25. ④独自のConverterを指定できる
[DynamoDBProperty(typeof(DimensionTypeConverter))]
public DimensionType Dimensions;
public class DimensionType {
public decimal Length;
public decimal Height;
public decimal Thickness;
}
// 寸法文字列 "8.5x11x.05" を DimensionType に変換
public class DimensionTypeConverter : IPropertyConverter {
public object FromEntry(DynamoDBEntry entry) {
Primitive primitive = entry as Primitive;
string[] data = ((string)(primitive.Value)).Split(new string[] { " x " }, StringSplitOptions.None);
if (data.Length != 3) throw new ArgumentOutOfRangeException();
DimensionType complexData = new DimensionType {
Length = Convert.ToDecimal(data[0]),
Height = Convert.ToDecimal(data[1]),
Thickness = Convert.ToDecimal(data[2])
};
return complexData;
}
}

26. ⑤複雑なオブジェクトにも対応
[DynamoDBTable("IntegrationExample")]
public class IntegrationExample{
[DynamoDBProperty(typeof(ListOfDocumentTypeConverter))]
public List<Document> Books;
[DynamoDBProperty]
public Dictionary<string,string> EJDictionary;
}
// 参照方法
Debug.Log(result.Response.Item.Books[0]["Author"]); // Yamada Taro
Debug.Log(result.Response.Item.EJDictionary["apple"]); // ringo
DynamoDBのカラムの例
VBのVariant型のようなもの
Dictionaryに対応

27. 今回のハックの構成図
Lambda
(ロジック)
DynamoDB
(データ保存)
Cognito
(ユーザー認証)
レスポンスは
DynamoDB
Unity
DynamoDBへの
アクセスを制御
リクエストはLambda
DynamoDB
(DescribeTable)
テーブルの
属性を取得

28. IAMの設定
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"cognito-sync:*",
"lambda:InvokeFunction"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"dynamodb:DescribeTable"
],
"Resource": [
"arn:aws:dynamodb:ap-northeast-1:764393641414:table/IntegrationExample"
]
}
]
}
DescribeTableを許可する
テーブルを追加
Lambdaの実行を許可
DynamoDBの
DescribeTableだけ許可

29. こうして世界は平和になった

30. 【おまけ】
通信失敗時のサポート

31. var request = new InvokeRequest(){
FunctionName = "getIntegrationExample",
Payload = "{"RoomId":"hoge"}",
InvocationType = InvocationType.RequestResponse
};
LambdaClient.GetItemAsync<SomeApp.Model.IntegrationExample> (request, callback);
var request = new ManagedInvokeRequest () { // クラスを変更
FunctionName = "getIntegrationExample",
Payload = "{"RoomId":"hoge"}",
InvocationType = InvocationType.RequestResponse,
Manage = this.Manage, // 追加。次のスライドで説明
MessageParentObject = this.MessageParentObject // 追加
};
LambdaClient.GetItemAsync<SomeApp.Model.IntegrationExample> (request, callback);
従来の実装方法
通信失敗時のサポートつき

32. protected void Manage(AmazonServiceResult<AmazonWebServiceRequest,AmazonWebServiceResponse> result,
AsyncOptions ao, Action<AmazonWebServiceRequest, AmazonWebServiceResponse, Exception, AsyncOptions>
callback){
var managedReq = result.Request as ManagedInvokeRequest;
if(result.Exception == null && !"Null".Equals((result.Response as IInvokeResponse).FunctionError)){
if (callback != null)
callback (result.Request, result.Response, result.Exception, ao);
}else{
if (managedReq.FailureDelegate != null)
managedReq.FailureDelegate ();
//エラーメッセージ表示
var dialogItem = new OkDialogItem{
ExplainText = "通信エラーが発生しました。",
OkText = "リトライ",
OkProcedure = delegate { managedReq.RetryDelegate(); } //リトライ
};
var dialog = OkDialog.InstantiateObject(dialogItem);
dialog.transform.SetParent(managedReq.MessageParentObject.transform, false);
dialog.Show();
}
}
エラーの判定メソッド、通信失敗時だけでなくメンテナンス時の判定もここに書ける
リトライにも対応
通信成功時
通信失敗時

33. 2017年サーバーレスの時代
Unityプロジェクトでも
快適な開発ライフを！